From 0d3a6e6d6235395e4cbd99fe4ff79d7ec72a6193 Mon Sep 17 00:00:00 2001 From: Auto Mation Date: Mon, 18 Sep 2023 13:15:31 +0000 Subject: [PATCH] Updated API from documentation release --- ...ndalonePriceRemoveStagedChangesAction.json | 3 - .../SubscriptionSqsDestination.json | 2 +- .../examples/standalone-price.example.json | 8 - api-specs/api/resources/me.raml | 38 ++ api-specs/api/ruleset.xml | 1 - .../business-unit/BusinessUnitStatus.raml | 1 - ...sinessUnitSetAddressCustomFieldAction.raml | 2 - ...usinessUnitSetAddressCustomTypeAction.raml | 4 +- .../BusinessUnitSetCustomFieldAction.raml | 4 +- .../BusinessUnitSetCustomTypeAction.raml | 2 - .../CartDiscountValueAbsoluteDraft.raml | 4 +- .../CartDiscountValueFixedDraft.raml | 4 +- api-specs/api/types/cart/Cart.raml | 1 + api-specs/api/types/cart/CartDraft.raml | 1 + .../cart/ExternalLineItemTotalPrice.raml | 2 + api-specs/api/types/cart/LineItemDraft.raml | 6 +- .../cart/MethodExternalTaxRateDraft.raml | 14 - .../ChannelSetAddressCustomTypeAction.raml | 2 +- .../CustomerSetAddressCustomFieldAction.raml | 2 - .../CustomerSetAddressCustomTypeAction.raml | 4 +- .../updates/CustomerSetCustomFieldAction.raml | 2 - .../updates/CustomerSetCustomTypeAction.raml | 2 - api-specs/api/types/me/MyCartDraft.raml | 1 + ...sinessUnitSetAddressCustomFieldAction.raml | 2 - ...usinessUnitSetAddressCustomTypeAction.raml | 4 +- .../MyBusinessUnitSetCustomFieldAction.raml | 2 - .../MyBusinessUnitSetCustomTypeAction.raml | 2 - .../MyCustomerSetCustomFieldAction.raml | 2 - .../MyCustomerSetCustomTypeAction.raml | 2 - ...essUnitAddressCustomFieldAddedMessage.raml | 16 - ...sUnitAddressCustomFieldChangedMessage.raml | 21 - ...sUnitAddressCustomFieldRemovedMessage.raml | 13 - ...ssUnitAddressCustomTypeRemovedMessage.raml | 13 - ...sinessUnitAddressCustomTypeSetMessage.raml | 16 - .../message/BusinessUnitCreatedMessage.raml | 1 + .../BusinessUnitCustomFieldAddedMessage.raml | 16 - ...BusinessUnitCustomFieldChangedMessage.raml | 21 - ...BusinessUnitCustomFieldRemovedMessage.raml | 13 - .../BusinessUnitCustomTypeRemovedMessage.raml | 13 - .../BusinessUnitCustomTypeSetMessage.raml | 16 - ...ustomerAddressCustomFieldAddedMessage.raml | 17 - ...tomerAddressCustomFieldChangedMessage.raml | 22 - ...tomerAddressCustomFieldRemovedMessage.raml | 13 - ...stomerAddressCustomTypeRemovedMessage.raml | 13 - .../CustomerAddressCustomTypeSetMessage.raml | 16 - .../CustomerCustomFieldAddedMessage.raml | 17 - .../CustomerCustomFieldChangedMessage.raml | 22 - .../CustomerCustomFieldRemovedMessage.raml | 13 - .../CustomerCustomTypeRemovedMessage.raml | 13 - .../message/CustomerCustomTypeSetMessage.raml | 16 - .../CustomerGroupCustomFieldAddedMessage.raml | 17 - ...ustomerGroupCustomFieldChangedMessage.raml | 21 - ...ustomerGroupCustomFieldRemovedMessage.raml | 13 - ...CustomerGroupCustomTypeRemovedMessage.raml | 13 - .../CustomerGroupCustomTypeSetMessage.raml | 16 - .../message/OrderCustomFieldAddedMessage.raml | 2 +- .../OrderCustomFieldChangedMessage.raml | 4 +- .../OrderCustomFieldRemovedMessage.raml | 2 +- .../OrderCustomTypeRemovedMessage.raml | 4 +- .../message/OrderCustomTypeSetMessage.raml | 4 +- .../QuoteRenegotiationRequestedMessage.raml | 13 - ...alonePriceStagedChangesRemovedMessage.raml | 13 - ...AddressCustomFieldAddedMessagePayload.raml | 16 - ...dressCustomFieldChangedMessagePayload.raml | 21 - ...dressCustomFieldRemovedMessagePayload.raml | 13 - ...ddressCustomTypeRemovedMessagePayload.raml | 13 - ...nitAddressCustomTypeSetMessagePayload.raml | 16 - .../BusinessUnitCreatedMessagePayload.raml | 1 + ...essUnitCustomFieldAddedMessagePayload.raml | 16 - ...sUnitCustomFieldChangedMessagePayload.raml | 21 - ...sUnitCustomFieldRemovedMessagePayload.raml | 13 - ...ssUnitCustomTypeRemovedMessagePayload.raml | 13 - ...sinessUnitCustomTypeSetMessagePayload.raml | 16 - ...AddressCustomFieldAddedMessagePayload.raml | 17 - ...dressCustomFieldChangedMessagePayload.raml | 22 - ...dressCustomFieldRemovedMessagePayload.raml | 13 - ...ddressCustomTypeRemovedMessagePayload.raml | 13 - ...merAddressCustomTypeSetMessagePayload.raml | 16 - ...ustomerCustomFieldAddedMessagePayload.raml | 17 - ...tomerCustomFieldChangedMessagePayload.raml | 22 - ...tomerCustomFieldRemovedMessagePayload.raml | 13 - ...stomerCustomTypeRemovedMessagePayload.raml | 13 - .../CustomerCustomTypeSetMessagePayload.raml | 16 - ...erGroupCustomFieldAddedMessagePayload.raml | 17 - ...GroupCustomFieldChangedMessagePayload.raml | 21 - ...GroupCustomFieldRemovedMessagePayload.raml | 13 - ...rGroupCustomTypeRemovedMessagePayload.raml | 13 - ...tomerGroupCustomTypeSetMessagePayload.raml | 16 - .../OrderCustomFieldAddedMessagePayload.raml | 2 +- ...OrderCustomFieldChangedMessagePayload.raml | 4 +- ...OrderCustomFieldRemovedMessagePayload.raml | 2 +- .../OrderCustomTypeRemovedMessagePayload.raml | 4 +- .../OrderCustomTypeSetMessagePayload.raml | 4 +- ...eRenegotiationRequestedMessagePayload.raml | 13 - ...iceStagedChangesRemovedMessagePayload.raml | 13 - api-specs/api/types/order/Order.raml | 1 + .../api/types/order/OrderImportDraft.raml | 1 + ...PaymentSetTransactionCustomTypeAction.raml | 2 +- .../ProductDiscountValueAbsoluteDraft.raml | 5 +- .../project/BusinessUnitConfiguration.raml | 1 - api-specs/api/types/project/Project.raml | 1 + .../api/types/quote-request/QuoteRequest.raml | 5 +- api-specs/api/types/quote/Quote.raml | 1 + api-specs/api/types/quote/QuoteState.raml | 3 + .../QuoteRequestQuoteRenegotiationAction.raml | 2 +- .../ShippingMethodSetCustomTypeAction.raml | 2 +- .../api/types/staged-quote/StagedQuote.raml | 1 + .../standalone-price/StagedPriceDraft.raml | 10 - .../StagedStandalonePrice.raml | 5 +- .../StandalonePriceDraft.raml | 4 - ...ndalonePriceRemoveStagedChangesAction.raml | 10 - api-specs/api/types/types.raml | 70 --- api-specs/connect/api.raml | 14 +- .../ConnectorConfigurationApplication.json | 1 - .../connector/ConnectorReportEntry.json | 5 - .../connect/examples/connector/Creator.json | 4 +- .../connect/examples/connector/draft.json | 5 +- .../connect/examples/connector/minimal.json | 6 +- .../connect/examples/connector/paged.json | 6 +- .../examples/connector/staged-paged.json | 8 +- .../connect/examples/connector/staged.json | 24 +- .../updates/ConnectorPublishAction.json | 4 - .../ConnectorSetCreatorLogoAction.json | 4 - ...ectorSetCreatorNoOfContributorsAction.json | 4 - ...nnectorSetCreatorNoOfDevelopersAction.json | 4 + .../ConnectorSetCreatorSupportUrlAction.json | 4 - .../ConnectorSetDocumentationUrlAction.json | 4 - .../ConnectorTriggerCertificationAction.json | 3 + .../deployment/DeploymentConnector.json | 5 +- .../deployment/DeploymentCreator.json | 7 - .../deployment/DeploymentDetailsBuild.json | 12 +- .../connect/examples/deployment/minimal.json | 18 +- .../connect/examples/deployment/paged.json | 18 +- .../connect/security-schemes/oauth2.raml | 4 +- api-specs/connect/types/annotations.raml | 3 - api-specs/connect/types/common.raml | 145 +----- .../types/connector/connector-draft.raml | 3 - .../types/connector/connector-staged.raml | 11 +- .../connect/types/connector/connector.raml | 6 - .../updates/connector-publish-action.raml | 12 - .../updates/connector-set-company-action.raml | 2 +- .../connector-set-creator-email-action.raml | 2 +- .../connector-set-creator-logo-action.raml | 12 - .../connector-set-creator-name-action.raml | 2 +- ...nector-set-creator-support-url-action.raml | 12 - .../connector-set-creator-title-action.raml | 2 +- .../connector-set-description-action.raml | 2 +- ...onnector-set-documentation-url-action.raml | 12 - .../connector-set-no-contributors-action.raml | 13 - .../connector-set-no-developers-action.raml | 12 + .../connector-set-repository-action.raml | 2 +- ...onnector-set-supported-regions-action.raml | 2 +- ...onnector-trigger-certification-action.raml | 10 + .../connect/types/deployment/deployment.raml | 5 +- .../updates/deployment-redeploy-action.raml | 4 - .../error/ConnectorAlreadyCertifiedError.raml | 4 +- .../ConnectorStagedInCertificationError.raml | 4 +- ...mentEntityApplicationDoNotBelongError.raml | 14 - ...loymentEntityApplicationRequiredError.raml | 14 - ...mentEntityMustIncludeApplicationError.raml | 14 - .../types/error/FieldValueNotFoundError.raml | 2 +- api-specs/connect/types/resource-types.raml | 10 +- api-specs/connect/types/types.raml | 10 +- api-specs/graphql/schema.sdl | 415 ++++-------------- api-specs/history/api.raml | 72 +-- api-specs/history/examples/ModifiedBy.json | 4 +- api-specs/history/examples/Record.json | 8 +- .../examples/RecordPagedQueryResponse.json | 10 +- api-specs/history/types/ModifiedBy.raml | 21 +- api-specs/history/types/Record.raml | 4 - .../types/change/AddAddressChange.raml | 3 - .../types/change/AddChannelRolesChange.raml | 4 +- .../change/AddLocalizedEnumValueChange.raml | 2 +- .../types/change/AddLocationChange.raml | 3 - .../types/change/AddPlainEnumValueChange.raml | 2 +- .../types/change/AddStateRolesChange.raml | 4 +- .../types/change/ChangeDescriptionChange.raml | 4 +- .../ChangeLocalizedDescriptionChange.raml | 4 +- .../change/ChangeLocalizedNameChange.raml | 4 - .../types/change/ChangeNameChange.raml | 8 - .../types/change/ChangeStateTypeChange.raml | 4 +- .../change/RemoveChannelRolesChange.raml | 4 +- .../types/change/RemoveLocationChange.raml | 3 - .../types/change/RemoveStateRolesChange.raml | 4 +- .../types/change/RemoveTaxRateChange.raml | 3 - .../types/change/SetChannelRolesChange.raml | 4 +- .../types/change/SetDescriptionChange.raml | 7 - .../change/SetLocalizedDescriptionChange.raml | 2 - .../types/change/SetStateRolesChange.raml | 4 +- .../history/types/common/ChannelRoleEnum.raml | 24 + api-specs/history/types/common/StateRole.raml | 8 - api-specs/history/types/types.raml | 8 +- api-specs/importapi/types/common.raml | 18 +- api-specs/importapi/types/custom-field.raml | 10 +- api-specs/importapi/types/import-summary.raml | 4 - 195 files changed, 383 insertions(+), 1940 deletions(-) delete mode 100644 api-specs/api/examples/StandalonePrice/StandalonePriceRemoveStagedChangesAction.json delete mode 100644 api-specs/api/types/cart/MethodExternalTaxRateDraft.raml delete mode 100644 api-specs/api/types/message/BusinessUnitAddressCustomFieldAddedMessage.raml delete mode 100644 api-specs/api/types/message/BusinessUnitAddressCustomFieldChangedMessage.raml delete mode 100644 api-specs/api/types/message/BusinessUnitAddressCustomFieldRemovedMessage.raml delete mode 100644 api-specs/api/types/message/BusinessUnitAddressCustomTypeRemovedMessage.raml delete mode 100644 api-specs/api/types/message/BusinessUnitAddressCustomTypeSetMessage.raml delete mode 100644 api-specs/api/types/message/BusinessUnitCustomFieldAddedMessage.raml delete mode 100644 api-specs/api/types/message/BusinessUnitCustomFieldChangedMessage.raml delete mode 100644 api-specs/api/types/message/BusinessUnitCustomFieldRemovedMessage.raml delete mode 100644 api-specs/api/types/message/BusinessUnitCustomTypeRemovedMessage.raml delete mode 100644 api-specs/api/types/message/BusinessUnitCustomTypeSetMessage.raml delete mode 100644 api-specs/api/types/message/CustomerAddressCustomFieldAddedMessage.raml delete mode 100644 api-specs/api/types/message/CustomerAddressCustomFieldChangedMessage.raml delete mode 100644 api-specs/api/types/message/CustomerAddressCustomFieldRemovedMessage.raml delete mode 100644 api-specs/api/types/message/CustomerAddressCustomTypeRemovedMessage.raml delete mode 100644 api-specs/api/types/message/CustomerAddressCustomTypeSetMessage.raml delete mode 100644 api-specs/api/types/message/CustomerCustomFieldAddedMessage.raml delete mode 100644 api-specs/api/types/message/CustomerCustomFieldChangedMessage.raml delete mode 100644 api-specs/api/types/message/CustomerCustomFieldRemovedMessage.raml delete mode 100644 api-specs/api/types/message/CustomerCustomTypeRemovedMessage.raml delete mode 100644 api-specs/api/types/message/CustomerCustomTypeSetMessage.raml delete mode 100644 api-specs/api/types/message/CustomerGroupCustomFieldAddedMessage.raml delete mode 100644 api-specs/api/types/message/CustomerGroupCustomFieldChangedMessage.raml delete mode 100644 api-specs/api/types/message/CustomerGroupCustomFieldRemovedMessage.raml delete mode 100644 api-specs/api/types/message/CustomerGroupCustomTypeRemovedMessage.raml delete mode 100644 api-specs/api/types/message/CustomerGroupCustomTypeSetMessage.raml delete mode 100644 api-specs/api/types/message/QuoteRenegotiationRequestedMessage.raml delete mode 100644 api-specs/api/types/message/StandalonePriceStagedChangesRemovedMessage.raml delete mode 100644 api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldAddedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldChangedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldRemovedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/BusinessUnitAddressCustomTypeRemovedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/BusinessUnitAddressCustomTypeSetMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/BusinessUnitCustomFieldAddedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/BusinessUnitCustomFieldChangedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/BusinessUnitCustomFieldRemovedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/BusinessUnitCustomTypeRemovedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/BusinessUnitCustomTypeSetMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/CustomerAddressCustomFieldAddedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/CustomerAddressCustomFieldChangedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/CustomerAddressCustomFieldRemovedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/CustomerAddressCustomTypeRemovedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/CustomerAddressCustomTypeSetMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/CustomerCustomFieldAddedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/CustomerCustomFieldChangedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/CustomerCustomFieldRemovedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/CustomerCustomTypeRemovedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/CustomerCustomTypeSetMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/CustomerGroupCustomFieldAddedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/CustomerGroupCustomFieldChangedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/CustomerGroupCustomFieldRemovedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/CustomerGroupCustomTypeRemovedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/CustomerGroupCustomTypeSetMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/QuoteRenegotiationRequestedMessagePayload.raml delete mode 100644 api-specs/api/types/message/payload/StandalonePriceStagedChangesRemovedMessagePayload.raml delete mode 100644 api-specs/api/types/standalone-price/StagedPriceDraft.raml delete mode 100644 api-specs/api/types/standalone-price/updates/StandalonePriceRemoveStagedChangesAction.raml delete mode 100644 api-specs/connect/examples/connector/ConnectorReportEntry.json delete mode 100644 api-specs/connect/examples/connector/updates/ConnectorPublishAction.json delete mode 100644 api-specs/connect/examples/connector/updates/ConnectorSetCreatorLogoAction.json delete mode 100644 api-specs/connect/examples/connector/updates/ConnectorSetCreatorNoOfContributorsAction.json create mode 100644 api-specs/connect/examples/connector/updates/ConnectorSetCreatorNoOfDevelopersAction.json delete mode 100644 api-specs/connect/examples/connector/updates/ConnectorSetCreatorSupportUrlAction.json delete mode 100644 api-specs/connect/examples/connector/updates/ConnectorSetDocumentationUrlAction.json create mode 100644 api-specs/connect/examples/connector/updates/ConnectorTriggerCertificationAction.json delete mode 100644 api-specs/connect/examples/deployment/DeploymentCreator.json delete mode 100644 api-specs/connect/types/connector/updates/connector-publish-action.raml delete mode 100644 api-specs/connect/types/connector/updates/connector-set-creator-logo-action.raml delete mode 100644 api-specs/connect/types/connector/updates/connector-set-creator-support-url-action.raml delete mode 100644 api-specs/connect/types/connector/updates/connector-set-documentation-url-action.raml delete mode 100644 api-specs/connect/types/connector/updates/connector-set-no-contributors-action.raml create mode 100644 api-specs/connect/types/connector/updates/connector-set-no-developers-action.raml create mode 100644 api-specs/connect/types/connector/updates/connector-trigger-certification-action.raml delete mode 100644 api-specs/connect/types/error/DeploymentEntityApplicationDoNotBelongError.raml delete mode 100644 api-specs/connect/types/error/DeploymentEntityApplicationRequiredError.raml delete mode 100644 api-specs/connect/types/error/DeploymentEntityMustIncludeApplicationError.raml create mode 100644 api-specs/history/types/common/ChannelRoleEnum.raml delete mode 100644 api-specs/history/types/common/StateRole.raml diff --git a/api-specs/api/examples/StandalonePrice/StandalonePriceRemoveStagedChangesAction.json b/api-specs/api/examples/StandalonePrice/StandalonePriceRemoveStagedChangesAction.json deleted file mode 100644 index d893c06fb..000000000 --- a/api-specs/api/examples/StandalonePrice/StandalonePriceRemoveStagedChangesAction.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "action": "removeStagedChanges" -} diff --git a/api-specs/api/examples/Subscription/SubscriptionSqsDestination.json b/api-specs/api/examples/Subscription/SubscriptionSqsDestination.json index e554773a7..2a797c36e 100644 --- a/api-specs/api/examples/Subscription/SubscriptionSqsDestination.json +++ b/api-specs/api/examples/Subscription/SubscriptionSqsDestination.json @@ -1,6 +1,6 @@ { "type": "SQS", - "queueUrl": "https://sqs..amazonaws.com//", + "queueUrl": "https://.amazonaws.com//", "accessKey": "", "accessSecret": "", "region": "", diff --git a/api-specs/api/examples/standalone-price.example.json b/api-specs/api/examples/standalone-price.example.json index e7237f8b4..4695f3ef7 100644 --- a/api-specs/api/examples/standalone-price.example.json +++ b/api-specs/api/examples/standalone-price.example.json @@ -8,14 +8,6 @@ "centAmount": 10000, "fractionDigits": 2 }, - "staged": { - "value": { - "type": "centPrecision", - "currencyCode": "EUR", - "centAmount": 20000, - "fractionDigits": 2 - } - }, "active": true, "createdAt": "2022-05-09T08:29:13.253Z", "lastModifiedAt": "2022-05-09T12:36:55.401Z" diff --git a/api-specs/api/resources/me.raml b/api-specs/api/resources/me.raml index d9d2bfb45..811f2c7d9 100644 --- a/api-specs/api/resources/me.raml +++ b/api-specs/api/resources/me.raml @@ -515,6 +515,44 @@ delete: body: application/json: example: !include ../examples/my-payment.example.json + /key={key}: + (methodName): withKey + type: + baseResource: + uriParameterName: key + resourceType: MyPayment + resourceUpdateType: MyPaymentUpdate + get: + displayName: Get my payment by key + securedBy: [oauth_2_0: { scopes: ['manage_my_payments:{projectKey}'] }] + responses: + 200: + body: + application/json: + example: !include ../examples/my-payment.example.json + post: + displayName: Update my payment by key + securedBy: [oauth_2_0: { scopes: ['manage_my_payments:{projectKey}'] }] + body: + application/json: + example: !include ../examples/my-payment-update.example.json + description: | + This endpoint can only update a Payment when it has no [Transactions](ctp:api:type:Transaction). + responses: + 200: + body: + application/json: + example: !include ../examples/my-payment.example.json + delete: + displayName: Delete my payment by key + securedBy: [oauth_2_0: { scopes: ['manage_my_payments:{projectKey}'] }] + description: | + This endpoint can only delete a Payment when it has no [Transactions](ctp:api:type:Transaction). + responses: + 200: + body: + application/json: + example: !include ../examples/my-payment.example.json /{ID}: (methodName): withId type: diff --git a/api-specs/api/ruleset.xml b/api-specs/api/ruleset.xml index 85457a6e7..b36fff091 100644 --- a/api-specs/api/ruleset.xml +++ b/api-specs/api/ruleset.xml @@ -59,7 +59,6 @@ - diff --git a/api-specs/api/types/business-unit/BusinessUnitStatus.raml b/api-specs/api/types/business-unit/BusinessUnitStatus.raml index fdc84e9b6..897ced4f8 100644 --- a/api-specs/api/types/business-unit/BusinessUnitStatus.raml +++ b/api-specs/api/types/business-unit/BusinessUnitStatus.raml @@ -13,5 +13,4 @@ enum: The Business Unit can be used in Carts, Orders, Quote Requests, and Quotes and can be edited. Inactive: | The Business Unit cannot be used in Carts, Orders, Quote Requests, and Quotes and can only be edited using the [general endpoint](ctp:api:endpoint:/{projectKey}/me/business-units:POST). - Status doesn't affect inheritance. Even if a parent unit is inactive, its children remain active and can inherit role assignments. default: Active diff --git a/api-specs/api/types/business-unit/updates/BusinessUnitSetAddressCustomFieldAction.raml b/api-specs/api/types/business-unit/updates/BusinessUnitSetAddressCustomFieldAction.raml index d9a7f7696..d8764409a 100644 --- a/api-specs/api/types/business-unit/updates/BusinessUnitSetAddressCustomFieldAction.raml +++ b/api-specs/api/types/business-unit/updates/BusinessUnitSetAddressCustomFieldAction.raml @@ -5,8 +5,6 @@ type: BusinessUnitUpdateAction displayName: BusinessUnitSetAddressCustomFieldAction discriminatorValue: setAddressCustomField example: !include ../../../examples/BusinessUnit/BusinessUnitSetAddressCustomFieldAction.json -description: | - Adding a Custom Field to an Address of a Business Unit generates the [BusinessUnitAddressCustomFieldAdded](ctp:api:type:BusinessUnitAddressCustomFieldAddedMessage) Message, removing one generates the [BusinessUnitAddressCustomFieldRemoved](ctp:api:type:BusinessUnitAddressCustomFieldRemovedMessage) Message, and updating an existing one generates the [BusinessUnitAddressCustomFieldChanged](ctp:api:type:BusinessUnitAddressCustomFieldChangedMessage) Message. properties: addressId: type: string diff --git a/api-specs/api/types/business-unit/updates/BusinessUnitSetAddressCustomTypeAction.raml b/api-specs/api/types/business-unit/updates/BusinessUnitSetAddressCustomTypeAction.raml index 98ec4b33d..22be2322c 100644 --- a/api-specs/api/types/business-unit/updates/BusinessUnitSetAddressCustomTypeAction.raml +++ b/api-specs/api/types/business-unit/updates/BusinessUnitSetAddressCustomTypeAction.raml @@ -1,12 +1,10 @@ #%RAML 1.0 DataType (package): BusinessUnit -(docs-uri): https://docs.commercetools.com/api/projects/business-units#set-custom-type-in-address +(docs-uri): https://docs.commercetools.com/api/projects/business-units#set-customtype-in-address type: BusinessUnitUpdateAction displayName: BusinessUnitSetAddressCustomTypeAction discriminatorValue: setAddressCustomType example: !include ../../../examples/BusinessUnit/BusinessUnitSetAddressCustomTypeAction.json -description: | - Adding or updating a Custom Type on an Address of a Business Unit generates the [BusinessUnitAddressCustomTypeSet](ctp:api:type:BusinessUnitAddressCustomTypeSetMessage) Message, and removing one generates the [BusinessUnitAddressCustomTypeRemoved](ctp:api:type:BusinessUnitAddressCustomTypeRemovedMessage) Message. properties: type?: type: TypeResourceIdentifier diff --git a/api-specs/api/types/business-unit/updates/BusinessUnitSetCustomFieldAction.raml b/api-specs/api/types/business-unit/updates/BusinessUnitSetCustomFieldAction.raml index 894462ed8..48b95763a 100644 --- a/api-specs/api/types/business-unit/updates/BusinessUnitSetCustomFieldAction.raml +++ b/api-specs/api/types/business-unit/updates/BusinessUnitSetCustomFieldAction.raml @@ -5,13 +5,11 @@ type: BusinessUnitUpdateAction displayName: BusinessUnitSetCustomFieldAction discriminatorValue: setCustomField example: !include ../../../examples/BusinessUnit/BusinessUnitSetCustomFieldAction.json -description: | - Adding a Custom Field to a Business Unit generates the [BusinessUnitCustomFieldAdded](ctp:api:type:BusinessUnitCustomFieldAddedMessage) Message, removing one generates the [BusinessUnitCustomFieldRemoved](ctp:api:type:BusinessUnitCustomFieldRemovedMessage) Message, and updating an existing one generates the [BusinessUnitCustomFieldChanged](ctp:api:type:BusinessUnitCustomFieldChangedMessage) Message. properties: name: type: string description: | - Name of the [Custom Field](/../api/projects/custom-fields) to add, update, or remove. + Name of the [Custom Field](/../api/projects/custom-fields). value?: type: CustomFieldValue description: | diff --git a/api-specs/api/types/business-unit/updates/BusinessUnitSetCustomTypeAction.raml b/api-specs/api/types/business-unit/updates/BusinessUnitSetCustomTypeAction.raml index 05dba3f24..8f14cefdd 100644 --- a/api-specs/api/types/business-unit/updates/BusinessUnitSetCustomTypeAction.raml +++ b/api-specs/api/types/business-unit/updates/BusinessUnitSetCustomTypeAction.raml @@ -5,8 +5,6 @@ type: BusinessUnitUpdateAction displayName: BusinessUnitSetCustomTypeAction discriminatorValue: setCustomType example: !include ../../../examples/BusinessUnit/BusinessUnitSetCustomTypeAction.json -description: | - Adding or updating a Custom Type on a Business Unit generates the [BusinessUnitCustomTypeSet](ctp:api:type:BusinessUnitCustomTypeSetMessage) Message, removing one generates the [BusinessUnitCustomTypeRemoved](ctp:api:type:BusinessUnitCustomTypeRemovedMessage) Message. properties: type?: type: TypeResourceIdentifier diff --git a/api-specs/api/types/cart-discount/CartDiscountValueAbsoluteDraft.raml b/api-specs/api/types/cart-discount/CartDiscountValueAbsoluteDraft.raml index cdddf23f2..71636aad8 100644 --- a/api-specs/api/types/cart-discount/CartDiscountValueAbsoluteDraft.raml +++ b/api-specs/api/types/cart-discount/CartDiscountValueAbsoluteDraft.raml @@ -8,6 +8,4 @@ properties: type: Money[] description: | Money values in different currencies. - An absolute Cart Discount will match a price only if the array contains a value with the same currency. For example, if it contains 10€ and 15$, the matching € price will be decreased by 10€ and the matching $ price will be decreased by 15$. If the array has multiple values of the same currency, the API returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. - - If the array is empty, the discount does not apply. + An absolute Cart Discount will only match a price if this array contains a value with the same currency. If it contains 10€ and 15$, the matching € price will be decreased by 10€ and the matching $ price will be decreased by 15$. diff --git a/api-specs/api/types/cart-discount/CartDiscountValueFixedDraft.raml b/api-specs/api/types/cart-discount/CartDiscountValueFixedDraft.raml index d7abab214..b28ff5696 100644 --- a/api-specs/api/types/cart-discount/CartDiscountValueFixedDraft.raml +++ b/api-specs/api/types/cart-discount/CartDiscountValueFixedDraft.raml @@ -10,6 +10,4 @@ properties: type: TypedMoneyDraft[] description: | Money values provided either in [cent precision](ctp:api:type:Money) or [high precision](ctp:api:type:HighPrecisionMoneyDraft) for different currencies. - A fixed Cart Discount will match a price only if the array contains a value with the same currency. For example, if it contains 10€ and 15$, the matching € price will be discounted by 10€ and the matching $ price will be discounted to 15$. If the array has multiple values of the same currency, the API returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. - - If the array is empty, the discount does not apply. + A fixed Cart Discount will only match a price if this array contains a value with the same currency. If it contains 10€ and 15$, the matching € price will be discounted by 10€ and the matching $ price will be discounted to 15$. diff --git a/api-specs/api/types/cart/Cart.raml b/api-specs/api/types/cart/Cart.raml index 90812b50b..eec5eeaee 100644 --- a/api-specs/api/types/cart/Cart.raml +++ b/api-specs/api/types/cart/Cart.raml @@ -40,6 +40,7 @@ properties: [Anonymous session](ctp:api:type:AnonymousSession) associated with the Cart. businessUnit?: type: BusinessUnitKeyReference + (beta): true description: | [Reference](ctp:api:type:Reference) to a Business Unit the Cart belongs to. store?: diff --git a/api-specs/api/types/cart/CartDraft.raml b/api-specs/api/types/cart/CartDraft.raml index 8b32fabd0..c3ac25b04 100644 --- a/api-specs/api/types/cart/CartDraft.raml +++ b/api-specs/api/types/cart/CartDraft.raml @@ -36,6 +36,7 @@ properties: [Anonymous session](ctp:api:type:AnonymousSession) associated with the Cart. businessUnit?: type: BusinessUnitResourceIdentifier + (beta): true description: | [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Business Unit the Cart should belong to. When the `customerId` of the Cart is also set, the [Customer](ctp:api:type:Customer) must be an [Associate](ctp:api:type:Associate) of the Business Unit. store?: diff --git a/api-specs/api/types/cart/ExternalLineItemTotalPrice.raml b/api-specs/api/types/cart/ExternalLineItemTotalPrice.raml index 0b1c911e5..4662499bf 100644 --- a/api-specs/api/types/cart/ExternalLineItemTotalPrice.raml +++ b/api-specs/api/types/cart/ExternalLineItemTotalPrice.raml @@ -8,6 +8,8 @@ properties: type: Money description: | Price of the Line Item. + + The value is selected from the Product Variant according to the [Product](ctp:api:type:Product) `priceMode`. totalPrice: type: Money description: | diff --git a/api-specs/api/types/cart/LineItemDraft.raml b/api-specs/api/types/cart/LineItemDraft.raml index 4ea96f64c..e2d650705 100644 --- a/api-specs/api/types/cart/LineItemDraft.raml +++ b/api-specs/api/types/cart/LineItemDraft.raml @@ -64,11 +64,7 @@ properties: externalTaxRate?: type: ExternalTaxRateDraft description: | - Sets the external Tax Rate for the Line Item, if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode). - perMethodExternalTaxRate?: - type: MethodExternalTaxRateDraft[] - description: | - Sets the external Tax Rates for individual Shipping Methods, if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode) and `Multiple` [ShippingMode](ctp:api:type:ShippingMode). + External Tax Rate for the Line Item if the Cart has the `External` [TaxMode](ctp:api:type:TaxMode). inventoryMode?: type: InventoryMode description: | diff --git a/api-specs/api/types/cart/MethodExternalTaxRateDraft.raml b/api-specs/api/types/cart/MethodExternalTaxRateDraft.raml deleted file mode 100644 index 1bd8902c5..000000000 --- a/api-specs/api/types/cart/MethodExternalTaxRateDraft.raml +++ /dev/null @@ -1,14 +0,0 @@ -#%RAML 1.0 DataType -(package): Cart -(docs-uri): https://docs.commercetools.com/api/projects/carts#methodexternaltaxratedraft -displayName: MethodExternalTaxRateDraft -type: object -properties: - shippingMethodKey: - type: string - description: | - User-defined unique identifier of the Shipping Method in a Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode). - taxRate?: - type: ExternalTaxRateDraft - description: | - External Tax Rate for the Shipping Method, if the Cart has `External` [TaxMode](ctp:api:type:TaxMode). diff --git a/api-specs/api/types/channel/updates/ChannelSetAddressCustomTypeAction.raml b/api-specs/api/types/channel/updates/ChannelSetAddressCustomTypeAction.raml index 015771847..873bc3cef 100644 --- a/api-specs/api/types/channel/updates/ChannelSetAddressCustomTypeAction.raml +++ b/api-specs/api/types/channel/updates/ChannelSetAddressCustomTypeAction.raml @@ -1,6 +1,6 @@ #%RAML 1.0 DataType (package): Channel -(docs-uri): https://docs.commercetools.com/api/projects/channels#set-custom-type-in-address +(docs-uri): https://docs.commercetools.com/api/projects/channels#set-customtype-in-address type: ChannelUpdateAction displayName: ChannelSetAddressCustomTypeAction discriminatorValue: setAddressCustomType diff --git a/api-specs/api/types/customer/updates/CustomerSetAddressCustomFieldAction.raml b/api-specs/api/types/customer/updates/CustomerSetAddressCustomFieldAction.raml index e5aea77d3..190c278ec 100644 --- a/api-specs/api/types/customer/updates/CustomerSetAddressCustomFieldAction.raml +++ b/api-specs/api/types/customer/updates/CustomerSetAddressCustomFieldAction.raml @@ -5,8 +5,6 @@ type: CustomerUpdateAction displayName: CustomerSetAddressCustomFieldAction discriminatorValue: setAddressCustomField example: !include ../../../examples/Customer/CustomerSetAddressCustomFieldAction.json -description: | - Adding a Custom Field to an Address of a Customer generates the [CustomerAddressCustomFieldAdded](ctp:api:type:CustomerAddressCustomFieldAddedMessage) Message, removing one generates the [CustomerAddressCustomFieldRemoved](ctp:api:type:CustomerAddressCustomFieldRemovedMessage) Message, and updating an existing one generates the [CustomerAddressCustomFieldChanged](ctp:api:type:CustomerAddressCustomFieldChangedMessage) Message. properties: addressId: type: string diff --git a/api-specs/api/types/customer/updates/CustomerSetAddressCustomTypeAction.raml b/api-specs/api/types/customer/updates/CustomerSetAddressCustomTypeAction.raml index 918b228a6..3e342dc19 100644 --- a/api-specs/api/types/customer/updates/CustomerSetAddressCustomTypeAction.raml +++ b/api-specs/api/types/customer/updates/CustomerSetAddressCustomTypeAction.raml @@ -1,12 +1,10 @@ #%RAML 1.0 DataType (package): Customer -(docs-uri): https://docs.commercetools.com/api/projects/customers#set-custom-type-in-address +(docs-uri): https://docs.commercetools.com/api/projects/customers#set-customtype-in-address type: CustomerUpdateAction displayName: CustomerSetAddressCustomTypeAction discriminatorValue: setAddressCustomType example: !include ../../../examples/Customer/CustomerSetAddressCustomTypeAction.json -description: | - Adding or updating a Custom Type on an Address of a Customer generates the [CustomerAddressCustomTypeSet](ctp:api:type:CustomerAddressCustomTypeSetMessage) Message, and removing one generates the [CustomerAddressCustomTypeRemoved](ctp:api:type:CustomerAddressCustomTypeRemovedMessage) Message. properties: addressId: type: string diff --git a/api-specs/api/types/customer/updates/CustomerSetCustomFieldAction.raml b/api-specs/api/types/customer/updates/CustomerSetCustomFieldAction.raml index 782148019..c4e650e20 100644 --- a/api-specs/api/types/customer/updates/CustomerSetCustomFieldAction.raml +++ b/api-specs/api/types/customer/updates/CustomerSetCustomFieldAction.raml @@ -5,8 +5,6 @@ type: CustomerUpdateAction displayName: CustomerSetCustomFieldAction discriminatorValue: setCustomField example: !include ../../../examples/Customer/CustomerSetCustomFieldAction.json -description: | - Adding a Custom Field to a Customer generates the [CustomerCustomFieldAdded](ctp:api:type:CustomerCustomFieldAddedMessage) Message, removing one generates the [CustomerCustomFieldRemoved](ctp:api:type:CustomerCustomFieldRemovedMessage) Message, and updating an existing one generates the [CustomerCustomFieldChanged](ctp:api:type:CustomerCustomFieldChangedMessage) Message. properties: name: type: string diff --git a/api-specs/api/types/customer/updates/CustomerSetCustomTypeAction.raml b/api-specs/api/types/customer/updates/CustomerSetCustomTypeAction.raml index 23006114a..b7fec5630 100644 --- a/api-specs/api/types/customer/updates/CustomerSetCustomTypeAction.raml +++ b/api-specs/api/types/customer/updates/CustomerSetCustomTypeAction.raml @@ -5,8 +5,6 @@ type: CustomerUpdateAction displayName: CustomerSetCustomTypeAction discriminatorValue: setCustomType example: !include ../../../examples/Customer/CustomerSetCustomTypeAction.json -description: | - Adding or updating a Custom Type on a Customer generates the [CustomerCustomTypeSet](ctp:api:type:CustomerCustomTypeSetMessage) Message, removing one generates the [CustomerCustomTypeRemoved](ctp:api:type:CustomerCustomTypeRemovedMessage) Message. properties: type?: type: TypeResourceIdentifier diff --git a/api-specs/api/types/me/MyCartDraft.raml b/api-specs/api/types/me/MyCartDraft.raml index 645c4204e..36f7d8288 100644 --- a/api-specs/api/types/me/MyCartDraft.raml +++ b/api-specs/api/types/me/MyCartDraft.raml @@ -19,6 +19,7 @@ properties: Email address of the Customer the Cart belongs to. businessUnit?: type: BusinessUnitResourceIdentifier + (beta): true description: | [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Business Unit the Cart should belong to. The [Customer](ctp:api:type:Customer) must be an [Associate](ctp:api:type:Associate) of the Business Unit. store?: diff --git a/api-specs/api/types/me/updates/MyBusinessUnitSetAddressCustomFieldAction.raml b/api-specs/api/types/me/updates/MyBusinessUnitSetAddressCustomFieldAction.raml index 44daedcb2..a374c2d48 100644 --- a/api-specs/api/types/me/updates/MyBusinessUnitSetAddressCustomFieldAction.raml +++ b/api-specs/api/types/me/updates/MyBusinessUnitSetAddressCustomFieldAction.raml @@ -5,8 +5,6 @@ type: MyBusinessUnitUpdateAction displayName: MyBusinessUnitSetAddressCustomFieldAction example: !include ../../../examples/BusinessUnit/BusinessUnitSetAddressCustomFieldAction.json discriminatorValue: setAddressCustomField -description: | - Adding a Custom Field to an Address of a Business Unit generates the [BusinessUnitAddressCustomFieldAdded](ctp:api:type:BusinessUnitAddressCustomFieldAddedMessage) Message, removing one generates the [BusinessUnitAddressCustomFieldRemoved](ctp:api:type:BusinessUnitAddressCustomFieldRemovedMessage) Message, and updating an existing one generates the [BusinessUnitAddressCustomFieldChanged](ctp:api:type:BusinessUnitAddressCustomFieldChangedMessage) Message. properties: addressId: type: string diff --git a/api-specs/api/types/me/updates/MyBusinessUnitSetAddressCustomTypeAction.raml b/api-specs/api/types/me/updates/MyBusinessUnitSetAddressCustomTypeAction.raml index 0a483ee9a..119a7cfed 100644 --- a/api-specs/api/types/me/updates/MyBusinessUnitSetAddressCustomTypeAction.raml +++ b/api-specs/api/types/me/updates/MyBusinessUnitSetAddressCustomTypeAction.raml @@ -1,12 +1,10 @@ #%RAML 1.0 DataType (package): Me -(docs-uri): https://docs.commercetools.com/api/projects/me-business-units#set-custom-type-in-address +(docs-uri): https://docs.commercetools.com/api/projects/me-business-units#set-customtype-in-address type: MyBusinessUnitUpdateAction displayName: MyBusinessUnitSetAddressCustomTypeAction example: !include ../../../examples/BusinessUnit/BusinessUnitSetAddressCustomTypeAction.json discriminatorValue: setAddressCustomType -description: | - Adding or updating a Custom Type to an Address of a Business Unit generates the [BusinessUnitAddressCustomTypeSet](ctp:api:type:BusinessUnitAddressCustomTypeSetMessage) Message, and removing one generates the [BusinessUnitAddressCustomTypeRemoved](ctp:api:type:BusinessUnitAddressCustomTypeRemovedMessage) Message. properties: type?: type: TypeResourceIdentifier diff --git a/api-specs/api/types/me/updates/MyBusinessUnitSetCustomFieldAction.raml b/api-specs/api/types/me/updates/MyBusinessUnitSetCustomFieldAction.raml index 639c92e15..809326417 100644 --- a/api-specs/api/types/me/updates/MyBusinessUnitSetCustomFieldAction.raml +++ b/api-specs/api/types/me/updates/MyBusinessUnitSetCustomFieldAction.raml @@ -5,8 +5,6 @@ type: MyBusinessUnitUpdateAction displayName: MyBusinessUnitSetCustomFieldAction example: !include ../../../examples/BusinessUnit/BusinessUnitSetCustomFieldAction.json discriminatorValue: setCustomField -description: | - Adding a Custom Field to a Business Unit generates the [BusinessUnitCustomFieldAdded](ctp:api:type:BusinessUnitCustomFieldAddedMessage) Message, removing one generates the [BusinessUnitCustomFieldRemoved](ctp:api:type:BusinessUnitCustomFieldRemovedMessage) Message, and updating an existing one generates the [BusinessUnitCustomFieldChanged](ctp:api:type:BusinessUnitCustomFieldChangedMessage) Message. properties: name: type: string diff --git a/api-specs/api/types/me/updates/MyBusinessUnitSetCustomTypeAction.raml b/api-specs/api/types/me/updates/MyBusinessUnitSetCustomTypeAction.raml index 69fce333b..37ea4a735 100644 --- a/api-specs/api/types/me/updates/MyBusinessUnitSetCustomTypeAction.raml +++ b/api-specs/api/types/me/updates/MyBusinessUnitSetCustomTypeAction.raml @@ -5,8 +5,6 @@ type: MyBusinessUnitUpdateAction displayName: MyBusinessUnitSetCustomTypeAction example: !include ../../../examples/BusinessUnit/BusinessUnitSetCustomTypeAction.json discriminatorValue: setCustomType -description: | - Adding or updating a Custom Type on a Business Unit generates the [BusinessUnitCustomTypeSet](ctp:api:type:BusinessUnitCustomTypeSetMessage) Message, removing one generates the [BusinessUnitCustomTypeRemoved](ctp:api:type:BusinessUnitCustomTypeRemovedMessage) Message. properties: type?: type: TypeResourceIdentifier diff --git a/api-specs/api/types/me/updates/MyCustomerSetCustomFieldAction.raml b/api-specs/api/types/me/updates/MyCustomerSetCustomFieldAction.raml index b6ef7b101..c01362300 100644 --- a/api-specs/api/types/me/updates/MyCustomerSetCustomFieldAction.raml +++ b/api-specs/api/types/me/updates/MyCustomerSetCustomFieldAction.raml @@ -5,8 +5,6 @@ type: MyCustomerUpdateAction displayName: MyCustomerSetCustomFieldAction example: !include ../../../examples/Customer/CustomerSetCustomFieldAction.json discriminatorValue: setCustomField -description: | - Adding a Custom Field to a Customer generates the [CustomerCustomFieldAdded](ctp:api:type:CustomerCustomFieldAddedMessage) Message, removing one generates the [CustomerCustomFieldRemoved](ctp:api:type:CustomerCustomFieldRemovedMessage) Message, and updating an existing one generates the [CustomerCustomFieldChanged](ctp:api:type:CustomerCustomFieldChangedMessage) Message. properties: name: type: string diff --git a/api-specs/api/types/me/updates/MyCustomerSetCustomTypeAction.raml b/api-specs/api/types/me/updates/MyCustomerSetCustomTypeAction.raml index dd709b928..2e9aec72e 100644 --- a/api-specs/api/types/me/updates/MyCustomerSetCustomTypeAction.raml +++ b/api-specs/api/types/me/updates/MyCustomerSetCustomTypeAction.raml @@ -5,8 +5,6 @@ type: MyCustomerUpdateAction displayName: MyCustomerSetCustomTypeAction example: !include ../../../examples/Customer/CustomerSetCustomTypeAction.json discriminatorValue: setCustomType -description: | - Adding or updating a Custom Type on a Customer generates the [CustomerCustomTypeSet](ctp:api:type:CustomerCustomTypeSetMessage) Message, removing one generates the [CustomerCustomTypeRemoved](ctp:api:type:CustomerCustomTypeRemovedMessage) Message. properties: type?: type: TypeResourceIdentifier diff --git a/api-specs/api/types/message/BusinessUnitAddressCustomFieldAddedMessage.raml b/api-specs/api/types/message/BusinessUnitAddressCustomFieldAddedMessage.raml deleted file mode 100644 index 2aab22491..000000000 --- a/api-specs/api/types/message/BusinessUnitAddressCustomFieldAddedMessage.raml +++ /dev/null @@ -1,16 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-field-added -type: Message -displayName: BusinessUnitAddressCustomFieldAddedMessage -discriminatorValue: BusinessUnitAddressCustomFieldAdded -description: | - Generated after adding a Custom Field to an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. If a Custom Field already exists with the same name, a [BusinessUnitAddressCustomFieldChanged](ctp:api:type:BusinessUnitAddressCustomFieldChangedMessage) Message is generated instead. -properties: - name: - type: string - description: | - Name of the Custom Field that was added. - value: - type: CustomFieldValue - description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/BusinessUnitAddressCustomFieldChangedMessage.raml b/api-specs/api/types/message/BusinessUnitAddressCustomFieldChangedMessage.raml deleted file mode 100644 index d57357476..000000000 --- a/api-specs/api/types/message/BusinessUnitAddressCustomFieldChangedMessage.raml +++ /dev/null @@ -1,21 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-field-changed -type: Message -displayName: BusinessUnitAddressCustomFieldChangedMessage -discriminatorValue: BusinessUnitAddressCustomFieldChanged -description: | - Generated after changing an existing Custom Field on an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that changed. - value: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. - oldValue?: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. diff --git a/api-specs/api/types/message/BusinessUnitAddressCustomFieldRemovedMessage.raml b/api-specs/api/types/message/BusinessUnitAddressCustomFieldRemovedMessage.raml deleted file mode 100644 index 71277b8c7..000000000 --- a/api-specs/api/types/message/BusinessUnitAddressCustomFieldRemovedMessage.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-field-removed -type: Message -displayName: BusinessUnitAddressCustomFieldRemovedMessage -discriminatorValue: BusinessUnitAddressCustomFieldRemoved -description: | - Generated after removing a Custom Field from an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that was removed. diff --git a/api-specs/api/types/message/BusinessUnitAddressCustomTypeRemovedMessage.raml b/api-specs/api/types/message/BusinessUnitAddressCustomTypeRemovedMessage.raml deleted file mode 100644 index 0683a46c7..000000000 --- a/api-specs/api/types/message/BusinessUnitAddressCustomTypeRemovedMessage.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-type-removed -type: Message -displayName: BusinessUnitAddressCustomTypeRemovedMessage -discriminatorValue: BusinessUnitAddressCustomTypeRemoved -description: | - Generated after removing a Custom Type from an address of a Business Unit using the [Set Custom Type in Address](ctp:api:type:BusinessUnitSetAddressCustomTypeAction) update action. -properties: - oldTypeId?: - type: string - description: | - `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/BusinessUnitAddressCustomTypeSetMessage.raml b/api-specs/api/types/message/BusinessUnitAddressCustomTypeSetMessage.raml deleted file mode 100644 index 350ecf23f..000000000 --- a/api-specs/api/types/message/BusinessUnitAddressCustomTypeSetMessage.raml +++ /dev/null @@ -1,16 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-type-set -type: Message -displayName: BusinessUnitAddressCustomTypeSetMessage -discriminatorValue: BusinessUnitAddressCustomTypeSet -description: | - Generated after adding a Custom Type to an address of a Business Unit using the [Set Custom Type in Address](ctp:api:type:BusinessUnitSetAddressCustomTypeAction) update action. -properties: - customFields: - type: CustomFields - description: The Custom Fields that were set. - oldTypeId?: - type: string - description: | - `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/BusinessUnitCreatedMessage.raml b/api-specs/api/types/message/BusinessUnitCreatedMessage.raml index ee80d6835..8f239d6e1 100644 --- a/api-specs/api/types/message/BusinessUnitCreatedMessage.raml +++ b/api-specs/api/types/message/BusinessUnitCreatedMessage.raml @@ -1,6 +1,7 @@ #%RAML 1.0 DataType (package): Message type: Message +(beta): true displayName: BusinessUnitCreatedMessage discriminatorValue: BusinessUnitCreated description: | diff --git a/api-specs/api/types/message/BusinessUnitCustomFieldAddedMessage.raml b/api-specs/api/types/message/BusinessUnitCustomFieldAddedMessage.raml deleted file mode 100644 index 22d05e4d5..000000000 --- a/api-specs/api/types/message/BusinessUnitCustomFieldAddedMessage.raml +++ /dev/null @@ -1,16 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-custom-field-added -type: Message -displayName: BusinessUnitCustomFieldAddedMessage -discriminatorValue: BusinessUnitCustomFieldAdded -description: | - Generated after adding a Custom Field to a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action. If a Custom Field already exists with the same name, a [BusinessUnitCustomFieldChanged](ctp:api:type:BusinessUnitCustomFieldChangedMessage) Message is generated instead. -properties: - name: - type: string - description: | - Name of the Custom Field that was added. - value: - type: CustomFieldValue - description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/BusinessUnitCustomFieldChangedMessage.raml b/api-specs/api/types/message/BusinessUnitCustomFieldChangedMessage.raml deleted file mode 100644 index 3245ea1c6..000000000 --- a/api-specs/api/types/message/BusinessUnitCustomFieldChangedMessage.raml +++ /dev/null @@ -1,21 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-custom-field-changed -type: Message -displayName: BusinessUnitCustomFieldChangedMessage -discriminatorValue: BusinessUnitCustomFieldChanged -description: | - Generated after changing an existing Custom Field on a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that changed. - value: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action. - oldValue?: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action. diff --git a/api-specs/api/types/message/BusinessUnitCustomFieldRemovedMessage.raml b/api-specs/api/types/message/BusinessUnitCustomFieldRemovedMessage.raml deleted file mode 100644 index cd7c1a2c0..000000000 --- a/api-specs/api/types/message/BusinessUnitCustomFieldRemovedMessage.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-custom-field-removed -type: Message -displayName: BusinessUnitCustomFieldRemovedMessage -discriminatorValue: BusinessUnitCustomFieldRemoved -description: | - Generated after removing a Custom Field from a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that was removed. diff --git a/api-specs/api/types/message/BusinessUnitCustomTypeRemovedMessage.raml b/api-specs/api/types/message/BusinessUnitCustomTypeRemovedMessage.raml deleted file mode 100644 index c3215032f..000000000 --- a/api-specs/api/types/message/BusinessUnitCustomTypeRemovedMessage.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-custom-type-removed -type: Message -displayName: BusinessUnitCustomTypeRemovedMessage -discriminatorValue: BusinessUnitCustomTypeRemoved -description: | - Generated after removing a Custom Type from a Business Unit using the [Set Custom Type](ctp:api:type:BusinessUnitSetCustomTypeAction) update action. -properties: - oldTypeId?: - type: string - description: | - `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/BusinessUnitCustomTypeSetMessage.raml b/api-specs/api/types/message/BusinessUnitCustomTypeSetMessage.raml deleted file mode 100644 index 07a04dc33..000000000 --- a/api-specs/api/types/message/BusinessUnitCustomTypeSetMessage.raml +++ /dev/null @@ -1,16 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-custom-type-set -type: Message -displayName: BusinessUnitCustomTypeSetMessage -discriminatorValue: BusinessUnitCustomTypeSet -description: | - Generated after adding a Custom Type to a Business Unit using the [Set Custom Type](ctp:api:type:BusinessUnitSetCustomTypeAction) update action. -properties: - customFields: - type: CustomFields - description: The Custom Fields that were set. - oldTypeId?: - type: string - description: | - `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/CustomerAddressCustomFieldAddedMessage.raml b/api-specs/api/types/message/CustomerAddressCustomFieldAddedMessage.raml deleted file mode 100644 index b61f8425b..000000000 --- a/api-specs/api/types/message/CustomerAddressCustomFieldAddedMessage.raml +++ /dev/null @@ -1,17 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-address-custom-field-added -type: Message -displayName: CustomerAddressCustomFieldAddedMessage -discriminatorValue: CustomerAddressCustomFieldAdded -description: | - Generated after adding a Custom Field to an Address of a Customer using the [Set CustomField in Address](ctp:api:type:CustomerSetAddressCustomFieldAction) update action. - If a Custom Field already exists with the same name, a [CustomerAddressCustomFieldChanged](ctp:api:type:CustomerAddressCustomFieldChangedMessage) Message is generated instead. -properties: - name: - type: string - description: | - Name of the Custom Field that was added. - value: - type: CustomFieldValue - description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/CustomerAddressCustomFieldChangedMessage.raml b/api-specs/api/types/message/CustomerAddressCustomFieldChangedMessage.raml deleted file mode 100644 index 93d241c44..000000000 --- a/api-specs/api/types/message/CustomerAddressCustomFieldChangedMessage.raml +++ /dev/null @@ -1,22 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-address-custom-field-changed -type: Message -displayName: CustomerAddressCustomFieldChangedMessage -discriminatorValue: CustomerAddressCustomFieldChanged -description: | - Generated after changing an existing Custom Field on an Address of a Customer using the [Set CustomField in Address](ctp:api:type:CustomerSetAddressCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that changed. - value: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:CustomerSetAddressCustomFieldAction) update action. - previousValue?: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:CustomerSetAddressCustomFieldAction) update action. - When there has not been a Custom Field with the `name` on the Customer Address before, a [Customer Address Custom Field Added](ctp:api:type:CustomerAddressCustomFieldAddedMessage) Message is generated instead. diff --git a/api-specs/api/types/message/CustomerAddressCustomFieldRemovedMessage.raml b/api-specs/api/types/message/CustomerAddressCustomFieldRemovedMessage.raml deleted file mode 100644 index 05b48911c..000000000 --- a/api-specs/api/types/message/CustomerAddressCustomFieldRemovedMessage.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-address-custom-field-removed -type: Message -displayName: CustomerAddressCustomFieldRemovedMessage -discriminatorValue: CustomerAddressCustomFieldRemoved -description: | - Generated after removing a Custom Field from an Address of a Customer using the [Set CustomField in Address](ctp:api:type:CustomerSetAddressCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that was removed. diff --git a/api-specs/api/types/message/CustomerAddressCustomTypeRemovedMessage.raml b/api-specs/api/types/message/CustomerAddressCustomTypeRemovedMessage.raml deleted file mode 100644 index 555631e1f..000000000 --- a/api-specs/api/types/message/CustomerAddressCustomTypeRemovedMessage.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-address-custom-type-removed -type: Message -displayName: CustomerAddressCustomTypeRemovedMessage -discriminatorValue: CustomerAddressCustomTypeRemoved -description: | - Generated after removing a Custom Type from an Address of a Customer using the [Set Custom Type in Address](ctp:api:type:CustomerSetAddressCustomTypeAction) update action. -properties: - previousTypeId?: - type: string - description: | - `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/CustomerAddressCustomTypeSetMessage.raml b/api-specs/api/types/message/CustomerAddressCustomTypeSetMessage.raml deleted file mode 100644 index 76ce4ea82..000000000 --- a/api-specs/api/types/message/CustomerAddressCustomTypeSetMessage.raml +++ /dev/null @@ -1,16 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-address-custom-type-set -type: Message -displayName: CustomerAddressCustomTypeSetMessage -discriminatorValue: CustomerAddressCustomTypeSet -description: | - Generated after adding a Custom Type to an Address of a Customer using the [Set Custom Type in Address](ctp:api:type:CustomerSetAddressCustomTypeAction) update action. -properties: - customFields: - type: CustomFields - description: The Custom Fields that have been set. - previousTypeId?: - type: string - description: | - `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/CustomerCustomFieldAddedMessage.raml b/api-specs/api/types/message/CustomerCustomFieldAddedMessage.raml deleted file mode 100644 index 59b8fa7da..000000000 --- a/api-specs/api/types/message/CustomerCustomFieldAddedMessage.raml +++ /dev/null @@ -1,17 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-custom-field-added -type: Message -displayName: CustomerCustomFieldAddedMessage -discriminatorValue: CustomerCustomFieldAdded -description: | - Generated after adding a Custom Field to a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. - If a Custom Field already exists with the same name, a [CustomerCustomFieldChanged](ctp:api:type:CustomerCustomFieldChangedMessage) Message is generated instead. -properties: - name: - type: string - description: | - Name of the Custom Field that was added. - value: - type: CustomFieldValue - description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/CustomerCustomFieldChangedMessage.raml b/api-specs/api/types/message/CustomerCustomFieldChangedMessage.raml deleted file mode 100644 index 2bf2370a7..000000000 --- a/api-specs/api/types/message/CustomerCustomFieldChangedMessage.raml +++ /dev/null @@ -1,22 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-custom-field-changed -type: Message -displayName: CustomerCustomFieldChangedMessage -discriminatorValue: CustomerCustomFieldChanged -description: | - Generated after changing an existing Custom Field on a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that changed. - value: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. - previousValue?: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. - When there has not been a Custom Field with the `name` on the Customer before, a [Customer Custom Field Added](ctp:api:type:CustomerCustomFieldAddedMessage) Message is generated instead. diff --git a/api-specs/api/types/message/CustomerCustomFieldRemovedMessage.raml b/api-specs/api/types/message/CustomerCustomFieldRemovedMessage.raml deleted file mode 100644 index 9c2e0a873..000000000 --- a/api-specs/api/types/message/CustomerCustomFieldRemovedMessage.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-custom-field-removed -type: Message -displayName: CustomerCustomFieldRemovedMessage -discriminatorValue: CustomerCustomFieldRemoved -description: | - Generated after removing a Custom Field from a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that was removed. diff --git a/api-specs/api/types/message/CustomerCustomTypeRemovedMessage.raml b/api-specs/api/types/message/CustomerCustomTypeRemovedMessage.raml deleted file mode 100644 index b4d100537..000000000 --- a/api-specs/api/types/message/CustomerCustomTypeRemovedMessage.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-custom-type-removed -type: Message -displayName: CustomerCustomTypeRemovedMessage -discriminatorValue: CustomerCustomTypeRemoved -description: | - Generated after removing a Custom Type from a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action with empty parameters. -properties: - previousTypeId?: - type: string - description: | - `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/CustomerCustomTypeSetMessage.raml b/api-specs/api/types/message/CustomerCustomTypeSetMessage.raml deleted file mode 100644 index 251c31d75..000000000 --- a/api-specs/api/types/message/CustomerCustomTypeSetMessage.raml +++ /dev/null @@ -1,16 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-custom-type-set -type: Message -displayName: CustomerCustomTypeSetMessage -discriminatorValue: CustomerCustomTypeSet -description: | - Generated after adding a Custom Type to a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action. -properties: - customFields: - type: CustomFields - description: The Custom Fields that have been set. - previousTypeId?: - type: string - description: | - `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/CustomerGroupCustomFieldAddedMessage.raml b/api-specs/api/types/message/CustomerGroupCustomFieldAddedMessage.raml deleted file mode 100644 index b49ce41d0..000000000 --- a/api-specs/api/types/message/CustomerGroupCustomFieldAddedMessage.raml +++ /dev/null @@ -1,17 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-field-added -type: Message -displayName: CustomerGroupCustomFieldAddedMessage -discriminatorValue: CustomerGroupCustomFieldAdded -description: | - Generated after adding a Custom Field to a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. - If a Custom Field already exists with the same name, a [CustomerGroupCustomFieldChanged](ctp:api:type:CustomerGroupCustomFieldChangedMessage) Message is generated instead. -properties: - name: - type: string - description: | - Name of the Custom Field that was added. - value: - type: CustomFieldValue - description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/CustomerGroupCustomFieldChangedMessage.raml b/api-specs/api/types/message/CustomerGroupCustomFieldChangedMessage.raml deleted file mode 100644 index 0c60d2bb8..000000000 --- a/api-specs/api/types/message/CustomerGroupCustomFieldChangedMessage.raml +++ /dev/null @@ -1,21 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-field-changed -type: Message -displayName: CustomerGroupCustomFieldChangedMessage -discriminatorValue: CustomerGroupCustomFieldChanged -description: | - Generated after changing an existing Custom Field on a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that changed. - value: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. - oldValue?: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. diff --git a/api-specs/api/types/message/CustomerGroupCustomFieldRemovedMessage.raml b/api-specs/api/types/message/CustomerGroupCustomFieldRemovedMessage.raml deleted file mode 100644 index 374cb3258..000000000 --- a/api-specs/api/types/message/CustomerGroupCustomFieldRemovedMessage.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-field-removed -type: Message -displayName: CustomerGroupCustomFieldRemovedMessage -discriminatorValue: CustomerGroupCustomFieldRemoved -description: | - Generated after removing a Custom Field from a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that was removed. diff --git a/api-specs/api/types/message/CustomerGroupCustomTypeRemovedMessage.raml b/api-specs/api/types/message/CustomerGroupCustomTypeRemovedMessage.raml deleted file mode 100644 index cd5d79ec2..000000000 --- a/api-specs/api/types/message/CustomerGroupCustomTypeRemovedMessage.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-type-removed -type: Message -displayName: CustomerGroupCustomTypeRemovedMessage -discriminatorValue: CustomerGroupCustomTypeRemoved -description: | - Generated after removing a Custom Type from a Customer Group using the [Set Custom Type](ctp:api:type:CustomerGroupSetCustomTypeAction) update action with empty parameters. -properties: - oldTypeId?: - type: string - description: | - `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/CustomerGroupCustomTypeSetMessage.raml b/api-specs/api/types/message/CustomerGroupCustomTypeSetMessage.raml deleted file mode 100644 index e66673fc5..000000000 --- a/api-specs/api/types/message/CustomerGroupCustomTypeSetMessage.raml +++ /dev/null @@ -1,16 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-type-set -type: Message -displayName: CustomerGroupCustomTypeSetMessage -discriminatorValue: CustomerGroupCustomTypeSet -description: | - Generated after adding a Custom Type to a Customer Group using the [Set Custom Type](ctp:api:type:CustomerGroupSetCustomTypeAction) update action. -properties: - customFields: - type: CustomFields - description: The Custom Fields that have been set. - oldTypeId?: - type: string - description: | - `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/OrderCustomFieldAddedMessage.raml b/api-specs/api/types/message/OrderCustomFieldAddedMessage.raml index e366b6ded..cf4123158 100644 --- a/api-specs/api/types/message/OrderCustomFieldAddedMessage.raml +++ b/api-specs/api/types/message/OrderCustomFieldAddedMessage.raml @@ -10,7 +10,7 @@ properties: name: type: string description: | - Name of the Custom Field that was added. + Name of the Custom Field that has been added. value: type: CustomFieldValue description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/OrderCustomFieldChangedMessage.raml b/api-specs/api/types/message/OrderCustomFieldChangedMessage.raml index f5f11be50..fa9c08e79 100644 --- a/api-specs/api/types/message/OrderCustomFieldChangedMessage.raml +++ b/api-specs/api/types/message/OrderCustomFieldChangedMessage.raml @@ -10,11 +10,11 @@ properties: name: type: string description: | - Name of the Custom Field that changed. + Name of the Custom Field that has been changed. value: type: CustomFieldValue description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction) update action. + [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set Custom Field](ctp:api:type:OrderSetCustomFieldAction) update action. previousValue?: type: CustomFieldValue description: | diff --git a/api-specs/api/types/message/OrderCustomFieldRemovedMessage.raml b/api-specs/api/types/message/OrderCustomFieldRemovedMessage.raml index 17bbfe66c..d1cad716b 100644 --- a/api-specs/api/types/message/OrderCustomFieldRemovedMessage.raml +++ b/api-specs/api/types/message/OrderCustomFieldRemovedMessage.raml @@ -10,4 +10,4 @@ properties: name: type: string description: | - Name of the Custom Field that was removed. + Name of the Custom Field that has been removed. diff --git a/api-specs/api/types/message/OrderCustomTypeRemovedMessage.raml b/api-specs/api/types/message/OrderCustomTypeRemovedMessage.raml index 197515d86..c4552b69f 100644 --- a/api-specs/api/types/message/OrderCustomTypeRemovedMessage.raml +++ b/api-specs/api/types/message/OrderCustomTypeRemovedMessage.raml @@ -10,4 +10,6 @@ properties: previousTypeId?: type: string description: | - `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. + `id` of the [Custom Type](ctp:api:type:Type) that has been removed. + + Absent when there has not been a Custom Type before. diff --git a/api-specs/api/types/message/OrderCustomTypeSetMessage.raml b/api-specs/api/types/message/OrderCustomTypeSetMessage.raml index acd09d3d0..c14f03fc7 100644 --- a/api-specs/api/types/message/OrderCustomTypeSetMessage.raml +++ b/api-specs/api/types/message/OrderCustomTypeSetMessage.raml @@ -13,4 +13,6 @@ properties: previousTypeId?: type: string description: | - `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. + `id` of the previous [Custom Type](ctp:api:type:Type). + + Absent when there has not been a Custom Type before. diff --git a/api-specs/api/types/message/QuoteRenegotiationRequestedMessage.raml b/api-specs/api/types/message/QuoteRenegotiationRequestedMessage.raml deleted file mode 100644 index e5f23e7eb..000000000 --- a/api-specs/api/types/message/QuoteRenegotiationRequestedMessage.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#quote-renegotiation-requested -type: Message -displayName: QuoteRenegotiationRequestedMessage -discriminatorValue: QuoteRenegotiationRequested -description: | - Generated after a successful [Request Quote Renegotiation](ctp:api:type:QuoteRequestQuoteRenegotiationAction) update action. -properties: - buyerComment?: - type: string - description: | - Message from the [Buyer](/api/quotes-overview#buyer) regarding the Quote renegotiation request. diff --git a/api-specs/api/types/message/StandalonePriceStagedChangesRemovedMessage.raml b/api-specs/api/types/message/StandalonePriceStagedChangesRemovedMessage.raml deleted file mode 100644 index 11b590882..000000000 --- a/api-specs/api/types/message/StandalonePriceStagedChangesRemovedMessage.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#standalone-price-staged-changes-removed -type: Message -displayName: StandalonePriceStagedChangesRemovedMessage -discriminatorValue: StandalonePriceStagedChangesRemoved -description: | - Generated after a successful [Remove Staged Changes](ctp:api:type:StandalonePriceRemoveStagedChangesAction) update action. -properties: - stagedChanges: - type: StagedStandalonePrice - description: | - Removed changes of the [StandalonePrice](ctp:api:type:StandalonePrice) after the [Remove Staged Changes](ctp:api:type:StandalonePriceRemoveStagedChangesAction) update action. diff --git a/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldAddedMessagePayload.raml b/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldAddedMessagePayload.raml deleted file mode 100644 index 1316a5a6d..000000000 --- a/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldAddedMessagePayload.raml +++ /dev/null @@ -1,16 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-field-added -type: MessagePayload -displayName: BusinessUnitAddressCustomFieldAddedMessagePayload -discriminatorValue: BusinessUnitAddressCustomFieldAdded -description: | - Generated after adding a Custom Field to an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. If a Custom Field already exists with the same name, a [BusinessUnitAddressCustomFieldChanged](ctp:api:type:BusinessUnitAddressCustomFieldChangedMessage) Message is generated instead. -properties: - name: - type: string - description: | - Name of the Custom Field that was added. - value: - type: CustomFieldValue - description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldChangedMessagePayload.raml b/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldChangedMessagePayload.raml deleted file mode 100644 index 2536e80d1..000000000 --- a/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldChangedMessagePayload.raml +++ /dev/null @@ -1,21 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-field-changed -type: MessagePayload -displayName: BusinessUnitAddressCustomFieldChangedMessagePayload -discriminatorValue: BusinessUnitAddressCustomFieldChanged -description: | - Generated after changing an existing Custom Field on an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that changed. - value: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. - oldValue?: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. diff --git a/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldRemovedMessagePayload.raml b/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldRemovedMessagePayload.raml deleted file mode 100644 index d2ef516ad..000000000 --- a/api-specs/api/types/message/payload/BusinessUnitAddressCustomFieldRemovedMessagePayload.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-field-removed -type: MessagePayload -displayName: BusinessUnitAddressCustomFieldRemovedMessagePayload -discriminatorValue: BusinessUnitAddressCustomFieldRemoved -description: | - Generated after removing a Custom Field from an address of a Business Unit using the [Set Address CustomField](ctp:api:type:BusinessUnitSetAddressCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that was removed. diff --git a/api-specs/api/types/message/payload/BusinessUnitAddressCustomTypeRemovedMessagePayload.raml b/api-specs/api/types/message/payload/BusinessUnitAddressCustomTypeRemovedMessagePayload.raml deleted file mode 100644 index 027fd1064..000000000 --- a/api-specs/api/types/message/payload/BusinessUnitAddressCustomTypeRemovedMessagePayload.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-type-removed -type: MessagePayload -displayName: BusinessUnitAddressCustomTypeRemovedMessagePayload -discriminatorValue: BusinessUnitAddressCustomTypeRemoved -description: | - Generated after removing a Custom Type from an address of a Business Unit using the [Set Custom Type in Address](ctp:api:type:BusinessUnitSetAddressCustomTypeAction) update action. -properties: - oldTypeId?: - type: string - description: | - `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/payload/BusinessUnitAddressCustomTypeSetMessagePayload.raml b/api-specs/api/types/message/payload/BusinessUnitAddressCustomTypeSetMessagePayload.raml deleted file mode 100644 index e11271a06..000000000 --- a/api-specs/api/types/message/payload/BusinessUnitAddressCustomTypeSetMessagePayload.raml +++ /dev/null @@ -1,16 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-address-custom-type-set -type: MessagePayload -displayName: BusinessUnitAddressCustomTypeSetMessagePayload -discriminatorValue: BusinessUnitAddressCustomTypeSet -description: | - Generated after adding a Custom Type to an address of a Business Unit using the [Set Custom Type in Address](ctp:api:type:BusinessUnitSetAddressCustomTypeAction) update action. -properties: - customFields: - type: CustomFields - description: The Custom Fields that were set. - oldTypeId?: - type: string - description: | - `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/payload/BusinessUnitCreatedMessagePayload.raml b/api-specs/api/types/message/payload/BusinessUnitCreatedMessagePayload.raml index e61a8aae7..72a08f099 100644 --- a/api-specs/api/types/message/payload/BusinessUnitCreatedMessagePayload.raml +++ b/api-specs/api/types/message/payload/BusinessUnitCreatedMessagePayload.raml @@ -1,6 +1,7 @@ #%RAML 1.0 DataType (package): Message type: MessagePayload +(beta): true displayName: BusinessUnitCreatedMessagePayload discriminatorValue: BusinessUnitCreated description: | diff --git a/api-specs/api/types/message/payload/BusinessUnitCustomFieldAddedMessagePayload.raml b/api-specs/api/types/message/payload/BusinessUnitCustomFieldAddedMessagePayload.raml deleted file mode 100644 index f38a1c36a..000000000 --- a/api-specs/api/types/message/payload/BusinessUnitCustomFieldAddedMessagePayload.raml +++ /dev/null @@ -1,16 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-custom-field-added -type: MessagePayload -displayName: BusinessUnitCustomFieldAddedMessagePayload -discriminatorValue: BusinessUnitCustomFieldAdded -description: | - Generated after adding a Custom Field to a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action. If a Custom Field already exists with the same name, a [BusinessUnitCustomFieldChanged](ctp:api:type:BusinessUnitCustomFieldChangedMessage) Message is generated instead. -properties: - name: - type: string - description: | - Name of the Custom Field that was added. - value: - type: CustomFieldValue - description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/payload/BusinessUnitCustomFieldChangedMessagePayload.raml b/api-specs/api/types/message/payload/BusinessUnitCustomFieldChangedMessagePayload.raml deleted file mode 100644 index f3965b79a..000000000 --- a/api-specs/api/types/message/payload/BusinessUnitCustomFieldChangedMessagePayload.raml +++ /dev/null @@ -1,21 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-custom-field-changed -type: MessagePayload -displayName: BusinessUnitCustomFieldChangedMessagePayload -discriminatorValue: BusinessUnitCustomFieldChanged -description: | - Generated after changing an existing Custom Field on a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that changed. - value: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action. - oldValue?: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action. diff --git a/api-specs/api/types/message/payload/BusinessUnitCustomFieldRemovedMessagePayload.raml b/api-specs/api/types/message/payload/BusinessUnitCustomFieldRemovedMessagePayload.raml deleted file mode 100644 index 60b06f1bf..000000000 --- a/api-specs/api/types/message/payload/BusinessUnitCustomFieldRemovedMessagePayload.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-custom-field-removed -type: MessagePayload -displayName: BusinessUnitCustomFieldRemovedMessagePayload -discriminatorValue: BusinessUnitCustomFieldRemoved -description: | - Generated after removing a Custom Field from a Business Unit using the [Set CustomField](ctp:api:type:BusinessUnitSetCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that was removed. diff --git a/api-specs/api/types/message/payload/BusinessUnitCustomTypeRemovedMessagePayload.raml b/api-specs/api/types/message/payload/BusinessUnitCustomTypeRemovedMessagePayload.raml deleted file mode 100644 index 4938e522f..000000000 --- a/api-specs/api/types/message/payload/BusinessUnitCustomTypeRemovedMessagePayload.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-custom-type-removed -type: MessagePayload -displayName: BusinessUnitCustomTypeRemovedMessagePayload -discriminatorValue: BusinessUnitCustomTypeRemoved -description: | - Generated after removing a Custom Type from a Business Unit using the [Set Custom Type](ctp:api:type:BusinessUnitSetCustomTypeAction) update action. -properties: - oldTypeId?: - type: string - description: | - `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/payload/BusinessUnitCustomTypeSetMessagePayload.raml b/api-specs/api/types/message/payload/BusinessUnitCustomTypeSetMessagePayload.raml deleted file mode 100644 index b6463d715..000000000 --- a/api-specs/api/types/message/payload/BusinessUnitCustomTypeSetMessagePayload.raml +++ /dev/null @@ -1,16 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#business-unit-custom-type-set -type: MessagePayload -displayName: BusinessUnitCustomTypeSetMessagePayload -discriminatorValue: BusinessUnitCustomTypeSet -description: | - Generated after adding a Custom Type to a Business Unit using the [Set Custom Type](ctp:api:type:BusinessUnitSetCustomTypeAction) update action. -properties: - customFields: - type: CustomFields - description: The Custom Fields that were set. - oldTypeId?: - type: string - description: | - `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/payload/CustomerAddressCustomFieldAddedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerAddressCustomFieldAddedMessagePayload.raml deleted file mode 100644 index 9a93f08d1..000000000 --- a/api-specs/api/types/message/payload/CustomerAddressCustomFieldAddedMessagePayload.raml +++ /dev/null @@ -1,17 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-address-custom-field-added -type: MessagePayload -displayName: CustomerAddressCustomFieldAddedMessagePayload -discriminatorValue: CustomerAddressCustomFieldAdded -description: | - Generated after adding a Custom Field to an Address of a Customer using the [Set CustomField in Address](ctp:api:type:CustomerSetAddressCustomFieldAction) update action. - If a Custom Field already exists with the same name, a [CustomerAddressCustomFieldChanged](ctp:api:type:CustomerAddressCustomFieldChangedMessage) Message is generated instead. -properties: - name: - type: string - description: | - Name of the Custom Field that was added. - value: - type: CustomFieldValue - description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/payload/CustomerAddressCustomFieldChangedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerAddressCustomFieldChangedMessagePayload.raml deleted file mode 100644 index cb350337e..000000000 --- a/api-specs/api/types/message/payload/CustomerAddressCustomFieldChangedMessagePayload.raml +++ /dev/null @@ -1,22 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-address-custom-field-changed -type: MessagePayload -displayName: CustomerAddressCustomFieldChangedMessagePayload -discriminatorValue: CustomerAddressCustomFieldChanged -description: | - Generated after changing an existing Custom Field on an Address of a Customer using the [Set CustomField in Address](ctp:api:type:CustomerSetAddressCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that changed. - value: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:CustomerSetAddressCustomFieldAction) update action. - previousValue?: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:CustomerSetAddressCustomFieldAction) update action. - When there has not been a Custom Field with the `name` on the Customer Address before, a [Customer Address Custom Field Added](ctp:api:type:CustomerAddressCustomFieldAddedMessage) Message is generated instead. diff --git a/api-specs/api/types/message/payload/CustomerAddressCustomFieldRemovedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerAddressCustomFieldRemovedMessagePayload.raml deleted file mode 100644 index 04ed4b061..000000000 --- a/api-specs/api/types/message/payload/CustomerAddressCustomFieldRemovedMessagePayload.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-address-custom-field-removed -type: MessagePayload -displayName: CustomerAddressCustomFieldRemovedMessagePayload -discriminatorValue: CustomerAddressCustomFieldRemoved -description: | - Generated after removing a Custom Field from an Address of a Customer using the [Set CustomField in Address](ctp:api:type:CustomerSetAddressCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that was removed. diff --git a/api-specs/api/types/message/payload/CustomerAddressCustomTypeRemovedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerAddressCustomTypeRemovedMessagePayload.raml deleted file mode 100644 index 78342f733..000000000 --- a/api-specs/api/types/message/payload/CustomerAddressCustomTypeRemovedMessagePayload.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-address-custom-type-removed -type: MessagePayload -displayName: CustomerAddressCustomTypeRemovedMessagePayload -discriminatorValue: CustomerAddressCustomTypeRemoved -description: | - Generated after removing a Custom Type from an Address of a Customer using the [Set Custom Type in Address](ctp:api:type:CustomerSetAddressCustomTypeAction) update action. -properties: - previousTypeId?: - type: string - description: | - `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/payload/CustomerAddressCustomTypeSetMessagePayload.raml b/api-specs/api/types/message/payload/CustomerAddressCustomTypeSetMessagePayload.raml deleted file mode 100644 index 8165ce87c..000000000 --- a/api-specs/api/types/message/payload/CustomerAddressCustomTypeSetMessagePayload.raml +++ /dev/null @@ -1,16 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-address-custom-type-set -type: MessagePayload -displayName: CustomerAddressCustomTypeSetMessagePayload -discriminatorValue: CustomerAddressCustomTypeSet -description: | - Generated after adding a Custom Type to an Address of a Customer using the [Set Custom Type in Address](ctp:api:type:CustomerSetAddressCustomTypeAction) update action. -properties: - customFields: - type: CustomFields - description: The Custom Fields that have been set. - previousTypeId?: - type: string - description: | - `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/payload/CustomerCustomFieldAddedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerCustomFieldAddedMessagePayload.raml deleted file mode 100644 index debf60895..000000000 --- a/api-specs/api/types/message/payload/CustomerCustomFieldAddedMessagePayload.raml +++ /dev/null @@ -1,17 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-custom-field-added -type: MessagePayload -displayName: CustomerCustomFieldAddedMessagePayload -discriminatorValue: CustomerCustomFieldAdded -description: | - Generated after adding a Custom Field to a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. - If a Custom Field already exists with the same name, a [CustomerCustomFieldChanged](ctp:api:type:CustomerCustomFieldChangedMessage) Message is generated instead. -properties: - name: - type: string - description: | - Name of the Custom Field that was added. - value: - type: CustomFieldValue - description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/payload/CustomerCustomFieldChangedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerCustomFieldChangedMessagePayload.raml deleted file mode 100644 index c60b6c75c..000000000 --- a/api-specs/api/types/message/payload/CustomerCustomFieldChangedMessagePayload.raml +++ /dev/null @@ -1,22 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-custom-field-changed -type: MessagePayload -displayName: CustomerCustomFieldChangedMessagePayload -discriminatorValue: CustomerCustomFieldChanged -description: | - Generated after changing an existing Custom Field on a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that changed. - value: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. - previousValue?: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. - When there has not been a Custom Field with the `name` on the Customer before, a [Customer Custom Field Added](ctp:api:type:CustomerCustomFieldAddedMessage) Message is generated instead. diff --git a/api-specs/api/types/message/payload/CustomerCustomFieldRemovedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerCustomFieldRemovedMessagePayload.raml deleted file mode 100644 index dbf88426b..000000000 --- a/api-specs/api/types/message/payload/CustomerCustomFieldRemovedMessagePayload.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-custom-field-removed -type: MessagePayload -displayName: CustomerCustomFieldRemovedMessagePayload -discriminatorValue: CustomerCustomFieldRemoved -description: | - Generated after removing a Custom Field from a Customer using the [Set CustomField](ctp:api:type:CustomerSetCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that was removed. diff --git a/api-specs/api/types/message/payload/CustomerCustomTypeRemovedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerCustomTypeRemovedMessagePayload.raml deleted file mode 100644 index 4aa20c901..000000000 --- a/api-specs/api/types/message/payload/CustomerCustomTypeRemovedMessagePayload.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-custom-type-removed -type: MessagePayload -displayName: CustomerCustomTypeRemovedMessagePayload -discriminatorValue: CustomerCustomTypeRemoved -description: | - Generated after removing a Custom Type from a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action with empty parameters. -properties: - previousTypeId?: - type: string - description: | - `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/payload/CustomerCustomTypeSetMessagePayload.raml b/api-specs/api/types/message/payload/CustomerCustomTypeSetMessagePayload.raml deleted file mode 100644 index d0cbd6658..000000000 --- a/api-specs/api/types/message/payload/CustomerCustomTypeSetMessagePayload.raml +++ /dev/null @@ -1,16 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-custom-type-set -type: MessagePayload -displayName: CustomerCustomTypeSetMessagePayload -discriminatorValue: CustomerCustomTypeSet -description: | - Generated after adding a Custom Type to a Customer using the [Set Custom Type](ctp:api:type:CustomerSetCustomTypeAction) update action. -properties: - customFields: - type: CustomFields - description: The Custom Fields that have been set. - previousTypeId?: - type: string - description: | - `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/payload/CustomerGroupCustomFieldAddedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerGroupCustomFieldAddedMessagePayload.raml deleted file mode 100644 index ba9327ded..000000000 --- a/api-specs/api/types/message/payload/CustomerGroupCustomFieldAddedMessagePayload.raml +++ /dev/null @@ -1,17 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-field-added -type: MessagePayload -displayName: CustomerGroupCustomFieldAddedMessagePayload -discriminatorValue: CustomerGroupCustomFieldAdded -description: | - Generated after adding a Custom Field to a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. - If a Custom Field already exists with the same name, a [CustomerGroupCustomFieldChanged](ctp:api:type:CustomerGroupCustomFieldChangedMessage) Message is generated instead. -properties: - name: - type: string - description: | - Name of the Custom Field that was added. - value: - type: CustomFieldValue - description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/payload/CustomerGroupCustomFieldChangedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerGroupCustomFieldChangedMessagePayload.raml deleted file mode 100644 index a8c297215..000000000 --- a/api-specs/api/types/message/payload/CustomerGroupCustomFieldChangedMessagePayload.raml +++ /dev/null @@ -1,21 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-field-changed -type: MessagePayload -displayName: CustomerGroupCustomFieldChangedMessagePayload -discriminatorValue: CustomerGroupCustomFieldChanged -description: | - Generated after changing an existing Custom Field on a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that changed. - value: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. - oldValue?: - type: CustomFieldValue - description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) before the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. diff --git a/api-specs/api/types/message/payload/CustomerGroupCustomFieldRemovedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerGroupCustomFieldRemovedMessagePayload.raml deleted file mode 100644 index 951f29275..000000000 --- a/api-specs/api/types/message/payload/CustomerGroupCustomFieldRemovedMessagePayload.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-field-removed -type: MessagePayload -displayName: CustomerGroupCustomFieldRemovedMessagePayload -discriminatorValue: CustomerGroupCustomFieldRemoved -description: | - Generated after removing a Custom Field from a Customer Group using the [Set CustomField](ctp:api:type:CustomerGroupSetCustomFieldAction) update action. -properties: - name: - type: string - description: | - Name of the Custom Field that was removed. diff --git a/api-specs/api/types/message/payload/CustomerGroupCustomTypeRemovedMessagePayload.raml b/api-specs/api/types/message/payload/CustomerGroupCustomTypeRemovedMessagePayload.raml deleted file mode 100644 index 3f74c664e..000000000 --- a/api-specs/api/types/message/payload/CustomerGroupCustomTypeRemovedMessagePayload.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-type-removed -type: MessagePayload -displayName: CustomerGroupCustomTypeRemovedMessagePayload -discriminatorValue: CustomerGroupCustomTypeRemoved -description: | - Generated after removing a Custom Type from a Customer Group using the [Set Custom Type](ctp:api:type:CustomerGroupSetCustomTypeAction) update action with empty parameters. -properties: - oldTypeId?: - type: string - description: | - `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/payload/CustomerGroupCustomTypeSetMessagePayload.raml b/api-specs/api/types/message/payload/CustomerGroupCustomTypeSetMessagePayload.raml deleted file mode 100644 index a31aedd7f..000000000 --- a/api-specs/api/types/message/payload/CustomerGroupCustomTypeSetMessagePayload.raml +++ /dev/null @@ -1,16 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#customer-group-custom-type-set -type: MessagePayload -displayName: CustomerGroupCustomTypeSetMessagePayload -discriminatorValue: CustomerGroupCustomTypeSet -description: | - Generated after adding a Custom Type to a Customer Group using the [Set Custom Type](ctp:api:type:CustomerGroupSetCustomTypeAction) update action. -properties: - customFields: - type: CustomFields - description: The Custom Fields that have been set. - oldTypeId?: - type: string - description: | - `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. diff --git a/api-specs/api/types/message/payload/OrderCustomFieldAddedMessagePayload.raml b/api-specs/api/types/message/payload/OrderCustomFieldAddedMessagePayload.raml index 3fa4cb18e..37105207c 100644 --- a/api-specs/api/types/message/payload/OrderCustomFieldAddedMessagePayload.raml +++ b/api-specs/api/types/message/payload/OrderCustomFieldAddedMessagePayload.raml @@ -10,7 +10,7 @@ properties: name: type: string description: | - Name of the Custom Field that was added. + Name of the Custom Field that has been added. value: type: CustomFieldValue description: The added [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType). diff --git a/api-specs/api/types/message/payload/OrderCustomFieldChangedMessagePayload.raml b/api-specs/api/types/message/payload/OrderCustomFieldChangedMessagePayload.raml index 7dd05fe1c..80fa09012 100644 --- a/api-specs/api/types/message/payload/OrderCustomFieldChangedMessagePayload.raml +++ b/api-specs/api/types/message/payload/OrderCustomFieldChangedMessagePayload.raml @@ -10,11 +10,11 @@ properties: name: type: string description: | - Name of the Custom Field that changed. + Name of the Custom Field that has been changed. value: type: CustomFieldValue description: | - [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set CustomField](ctp:api:type:OrderSetCustomFieldAction) update action. + [CustomFieldValue](ctp:api:type:CustomFieldValue) based on the [FieldType](ctp:api:type:FieldType) after the [Set Custom Field](ctp:api:type:OrderSetCustomFieldAction) update action. previousValue?: type: CustomFieldValue description: | diff --git a/api-specs/api/types/message/payload/OrderCustomFieldRemovedMessagePayload.raml b/api-specs/api/types/message/payload/OrderCustomFieldRemovedMessagePayload.raml index 9083a9d6e..0fb2fd6f6 100644 --- a/api-specs/api/types/message/payload/OrderCustomFieldRemovedMessagePayload.raml +++ b/api-specs/api/types/message/payload/OrderCustomFieldRemovedMessagePayload.raml @@ -10,4 +10,4 @@ properties: name: type: string description: | - Name of the Custom Field that was removed. + Name of the Custom Field that has been removed. diff --git a/api-specs/api/types/message/payload/OrderCustomTypeRemovedMessagePayload.raml b/api-specs/api/types/message/payload/OrderCustomTypeRemovedMessagePayload.raml index 1b02b12eb..fd2a3fe84 100644 --- a/api-specs/api/types/message/payload/OrderCustomTypeRemovedMessagePayload.raml +++ b/api-specs/api/types/message/payload/OrderCustomTypeRemovedMessagePayload.raml @@ -10,4 +10,6 @@ properties: previousTypeId?: type: string description: | - `id` of the [Custom Type](ctp:api:type:Type) that was removed. Absent if there was no previous Custom Type present. + `id` of the [Custom Type](ctp:api:type:Type) that has been removed. + + Absent when there has not been a Custom Type before. diff --git a/api-specs/api/types/message/payload/OrderCustomTypeSetMessagePayload.raml b/api-specs/api/types/message/payload/OrderCustomTypeSetMessagePayload.raml index 31d102db3..a746363a9 100644 --- a/api-specs/api/types/message/payload/OrderCustomTypeSetMessagePayload.raml +++ b/api-specs/api/types/message/payload/OrderCustomTypeSetMessagePayload.raml @@ -13,4 +13,6 @@ properties: previousTypeId?: type: string description: | - `id` of the previous [Custom Type](ctp:api:type:Type). Absent if there was no previous Custom Type present. + `id` of the previous [Custom Type](ctp:api:type:Type). + + Absent when there has not been a Custom Type before. diff --git a/api-specs/api/types/message/payload/QuoteRenegotiationRequestedMessagePayload.raml b/api-specs/api/types/message/payload/QuoteRenegotiationRequestedMessagePayload.raml deleted file mode 100644 index 18c10e4aa..000000000 --- a/api-specs/api/types/message/payload/QuoteRenegotiationRequestedMessagePayload.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#quote-renegotiation-requested -type: MessagePayload -displayName: QuoteRenegotiationRequestedMessagePayload -discriminatorValue: QuoteRenegotiationRequested -description: | - Generated after a successful [Request Quote Renegotiation](ctp:api:type:QuoteRequestQuoteRenegotiationAction) update action. -properties: - buyerComment?: - type: string - description: | - Message from the [Buyer](/api/quotes-overview#buyer) regarding the Quote renegotiation request. diff --git a/api-specs/api/types/message/payload/StandalonePriceStagedChangesRemovedMessagePayload.raml b/api-specs/api/types/message/payload/StandalonePriceStagedChangesRemovedMessagePayload.raml deleted file mode 100644 index bc10be3df..000000000 --- a/api-specs/api/types/message/payload/StandalonePriceStagedChangesRemovedMessagePayload.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(package): Message -(docs-uri): https://docs.commercetools.com/api/projects/messages#standalone-price-staged-changes-removed -type: MessagePayload -displayName: StandalonePriceStagedChangesRemovedMessagePayload -discriminatorValue: StandalonePriceStagedChangesRemoved -description: | - Generated after a successful [Remove Staged Changes](ctp:api:type:StandalonePriceRemoveStagedChangesAction) update action. -properties: - stagedChanges: - type: StagedStandalonePrice - description: | - Removed changes of the [StandalonePrice](ctp:api:type:StandalonePrice) after the [Remove Staged Changes](ctp:api:type:StandalonePriceRemoveStagedChangesAction) update action. diff --git a/api-specs/api/types/order/Order.raml b/api-specs/api/types/order/Order.raml index e34abeddf..6ba1ebd3b 100644 --- a/api-specs/api/types/order/Order.raml +++ b/api-specs/api/types/order/Order.raml @@ -44,6 +44,7 @@ properties: [Anonymous session](ctp:api:type:AnonymousSession) associated with the Order. businessUnit?: type: BusinessUnitKeyReference + (beta): true description: | [Reference](ctp:api:type:Reference) to a Business Unit the Order belongs to. store?: diff --git a/api-specs/api/types/order/OrderImportDraft.raml b/api-specs/api/types/order/OrderImportDraft.raml index c194a3f1e..1e037516f 100644 --- a/api-specs/api/types/order/OrderImportDraft.raml +++ b/api-specs/api/types/order/OrderImportDraft.raml @@ -29,6 +29,7 @@ properties: The Customer Group of the Customer the Order belongs to. businessUnit?: type: BusinessUnitResourceIdentifier + (beta): true description: | [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to the Business Unit the Order should belong to. When the `customerId` of the Order is also set, the [Customer](ctp:api:type:Customer) must be an [Associate](ctp:api:type:Associate) of the Business Unit. diff --git a/api-specs/api/types/payment/updates/PaymentSetTransactionCustomTypeAction.raml b/api-specs/api/types/payment/updates/PaymentSetTransactionCustomTypeAction.raml index 6ac3c4788..1fdf7275d 100644 --- a/api-specs/api/types/payment/updates/PaymentSetTransactionCustomTypeAction.raml +++ b/api-specs/api/types/payment/updates/PaymentSetTransactionCustomTypeAction.raml @@ -1,6 +1,6 @@ #%RAML 1.0 DataType (package): Payment -(docs-uri): https://docs.commercetools.com/api/projects/payments#set-transaction-custom-type +(docs-uri): https://docs.commercetools.com/api/projects/payments#set-transaction-customtype type: PaymentUpdateAction displayName: PaymentSetTransactionCustomTypeAction discriminatorValue: setTransactionCustomType diff --git a/api-specs/api/types/product-discount/ProductDiscountValueAbsoluteDraft.raml b/api-specs/api/types/product-discount/ProductDiscountValueAbsoluteDraft.raml index 15897d0f4..b43bc24fc 100644 --- a/api-specs/api/types/product-discount/ProductDiscountValueAbsoluteDraft.raml +++ b/api-specs/api/types/product-discount/ProductDiscountValueAbsoluteDraft.raml @@ -9,7 +9,4 @@ properties: money: type: Money[] description: | - Money values in different currencies. - An absolute Product Discount will match a price only if the array contains a value with the same currency. For example, if it contains 10€ and 15$, the matching € price will be decreased by 10€ and the matching $ price will be decreased by 15$. If the array has multiple values of the same currency, the API returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error. - - If the array is empty, the discount does not apply. + Money values in different currencies. An absolute [ProductDiscount](ctp:api:type:ProductDiscount) will only match a price if this array contains a value with the same currency. For example, if it contains 10€ and 15$, the matching € price will be decreased by 10€ and the matching $ price will be decreased by 15\$. diff --git a/api-specs/api/types/project/BusinessUnitConfiguration.raml b/api-specs/api/types/project/BusinessUnitConfiguration.raml index 1e2360e34..decca20bd 100644 --- a/api-specs/api/types/project/BusinessUnitConfiguration.raml +++ b/api-specs/api/types/project/BusinessUnitConfiguration.raml @@ -6,7 +6,6 @@ properties: myBusinessUnitStatusOnCreation: type: BusinessUnitConfigurationStatus description: Status of Business Units created using the [My Business Unit endpoint](ctp:api:endpoint:/{projectKey}/me/business-units:POST). - default: Inactive myBusinessUnitAssociateRoleOnCreation?: type: AssociateRoleKeyReference description: | diff --git a/api-specs/api/types/project/Project.raml b/api-specs/api/types/project/Project.raml index 41fed4816..eef073ad7 100644 --- a/api-specs/api/types/project/Project.raml +++ b/api-specs/api/types/project/Project.raml @@ -64,5 +64,6 @@ properties: Controls indexing of resources to be provided on high performance read-only search endpoints. businessUnits?: type: BusinessUnitConfiguration + (beta): true description: | Holds configuration specific to [Business Units](ctp:api:type:BusinessUnit). diff --git a/api-specs/api/types/quote-request/QuoteRequest.raml b/api-specs/api/types/quote-request/QuoteRequest.raml index 48b8cb84d..aec45651c 100644 --- a/api-specs/api/types/quote-request/QuoteRequest.raml +++ b/api-specs/api/types/quote-request/QuoteRequest.raml @@ -149,11 +149,8 @@ properties: description: | Identifier for a purchase order, usually in a B2B context. The Purchase Order Number is typically entered by the [Buyer](/quotes-overview#buyer). - cart?: - type: CartReference - description: | - The [Cart](ctp:api:type:Cart) from which a Quote is requested. businessUnit?: type: BusinessUnitKeyReference + (beta): true description: | The [BusinessUnit](ctp:api:type:BusinessUnit) for the Quote Request. diff --git a/api-specs/api/types/quote/Quote.raml b/api-specs/api/types/quote/Quote.raml index 04b5abdc7..97fc7754b 100644 --- a/api-specs/api/types/quote/Quote.raml +++ b/api-specs/api/types/quote/Quote.raml @@ -167,5 +167,6 @@ properties: track the purchase order during the [quote and order flow](/../api/quotes-overview#intended-workflow). businessUnit?: type: BusinessUnitKeyReference + (beta): true description: | The [BusinessUnit](ctp:api:type:BusinessUnit) for the Quote. diff --git a/api-specs/api/types/quote/QuoteState.raml b/api-specs/api/types/quote/QuoteState.raml index cc1a037ad..192118e35 100644 --- a/api-specs/api/types/quote/QuoteState.raml +++ b/api-specs/api/types/quote/QuoteState.raml @@ -11,6 +11,7 @@ enum: - DeclinedForRenegotiation - RenegotiationAddressed - Accepted + - Failed - Withdrawn (enumDescriptions): Pending: | @@ -25,5 +26,7 @@ enum: A state indicating that the [Seller](/../api/quotes-overview#seller) has created a new Quote after a renegotiation has been requested. Accepted: | A state indicating that the [Buyer](/../api/quotes-overview#buyer) has accepted the Quote. + Failed: | + A state indicating a circumstance - other than the [Buyer](/../api/quotes-overview#buyer) declining - that led to the Quote failing. Withdrawn: | A state indicating that the [Seller](/../api/quotes-overview#seller) has withdrawn the Quote before the [Buyer](/../api/quotes-overview#buyer) has accepted it. diff --git a/api-specs/api/types/quote/updates/QuoteRequestQuoteRenegotiationAction.raml b/api-specs/api/types/quote/updates/QuoteRequestQuoteRenegotiationAction.raml index 06b54e6f2..b8d399263 100644 --- a/api-specs/api/types/quote/updates/QuoteRequestQuoteRenegotiationAction.raml +++ b/api-specs/api/types/quote/updates/QuoteRequestQuoteRenegotiationAction.raml @@ -6,7 +6,7 @@ displayName: QuoteRequestQuoteRenegotiationAction discriminatorValue: requestQuoteRenegotiation example: !include ../../../examples/Quote/QuoteRequestQuoteRenegotiationAction.json description: | - Represents the Buyer requesting renegotiation for a Quote. Valid for Quotes in a `Pending` [state](ctp:api:type:QuoteState). + Represents the Buyer requesting renegotiation for a Quote. Valid for Quotes in a `Pending` or `Failed` [state](ctp:api:type:QuoteState). properties: buyerComment?: type: string diff --git a/api-specs/api/types/shipping-method/updates/ShippingMethodSetCustomTypeAction.raml b/api-specs/api/types/shipping-method/updates/ShippingMethodSetCustomTypeAction.raml index 6284bad09..f550c98a4 100644 --- a/api-specs/api/types/shipping-method/updates/ShippingMethodSetCustomTypeAction.raml +++ b/api-specs/api/types/shipping-method/updates/ShippingMethodSetCustomTypeAction.raml @@ -1,6 +1,6 @@ #%RAML 1.0 DataType (package): ShippingMethod -(docs-uri): https://docs.commercetools.com/api/projects/shippingMethods#set-custom-type +(docs-uri): https://docs.commercetools.com/api/projects/shippingMethods#set-customtype type: ShippingMethodUpdateAction displayName: ShippingMethodSetCustomTypeAction discriminatorValue: setCustomType diff --git a/api-specs/api/types/staged-quote/StagedQuote.raml b/api-specs/api/types/staged-quote/StagedQuote.raml index b9c94c329..403eae4f8 100644 --- a/api-specs/api/types/staged-quote/StagedQuote.raml +++ b/api-specs/api/types/staged-quote/StagedQuote.raml @@ -73,5 +73,6 @@ properties: track the purchase order during the [quote and order flow](/../api/quotes-overview#intended-workflow). businessUnit?: type: BusinessUnitKeyReference + (beta): true description: | The [BusinessUnit](ctp:api:type:BusinessUnit) for the Staged Quote. diff --git a/api-specs/api/types/standalone-price/StagedPriceDraft.raml b/api-specs/api/types/standalone-price/StagedPriceDraft.raml deleted file mode 100644 index 867ab363d..000000000 --- a/api-specs/api/types/standalone-price/StagedPriceDraft.raml +++ /dev/null @@ -1,10 +0,0 @@ -#%RAML 1.0 DataType -(package): StandalonePrice -(docs-uri): https://docs.commercetools.com/api/projects/standalone-prices#stagedpricedraft -type: object -displayName: StagedPriceDraft -properties: - value: - type: TypedMoneyDraft - description: | - Money value for the StagedPriceDraft. diff --git a/api-specs/api/types/standalone-price/StagedStandalonePrice.raml b/api-specs/api/types/standalone-price/StagedStandalonePrice.raml index 4eeeca787..111a2b1ad 100644 --- a/api-specs/api/types/standalone-price/StagedStandalonePrice.raml +++ b/api-specs/api/types/standalone-price/StagedStandalonePrice.raml @@ -3,10 +3,7 @@ (docs-uri): https://docs.commercetools.com/api/projects/standalone-prices#stagedstandaloneprice type: object displayName: StagedStandalonePrice -description: | - Staged changes on a Standalone Price. - To update the `value` property of a Staged Standalone Price, use the [Change Value](ctp:api:type:StandalonePriceChangeValueAction) update action. - To apply all staged changes to the Standalone Price, use the [Apply Staged Changes](ctp:api:type:StandalonePriceApplyStagedChangesAction) update action. +description: Staged changes on a Standalone Price. To update the `value` property of a Staged Standalone Price, use the corresponding [update action](ctp:api:type:StandalonePriceChangeValueAction). To apply all staged changes to the Standalone Price, use the [Apply Staged Changes](ctp:api:type:StandalonePriceApplyStagedChangesAction) update action. properties: value: type: TypedMoney diff --git a/api-specs/api/types/standalone-price/StandalonePriceDraft.raml b/api-specs/api/types/standalone-price/StandalonePriceDraft.raml index 76ac20c2e..b833e6c9f 100644 --- a/api-specs/api/types/standalone-price/StandalonePriceDraft.raml +++ b/api-specs/api/types/standalone-price/StandalonePriceDraft.raml @@ -56,10 +56,6 @@ properties: type: CustomFieldsDraft description: | Custom Fields for the StandalonePrice. - staged?: - type: StagedPriceDraft - description: | - Staged changes for the StandalonePrice. active?: type: boolean default: true diff --git a/api-specs/api/types/standalone-price/updates/StandalonePriceRemoveStagedChangesAction.raml b/api-specs/api/types/standalone-price/updates/StandalonePriceRemoveStagedChangesAction.raml deleted file mode 100644 index ebef79b5e..000000000 --- a/api-specs/api/types/standalone-price/updates/StandalonePriceRemoveStagedChangesAction.raml +++ /dev/null @@ -1,10 +0,0 @@ -#%RAML 1.0 DataType -(package): StandalonePrice -(docs-uri): https://docs.commercetools.com/api/projects/standalone-prices#remove-staged-changes -type: StandalonePriceUpdateAction -displayName: StandalonePriceRemoveStagedChangesAction -discriminatorValue: removeStagedChanges -description: | - Removes all staged changes from the StandalonePrice. - Removing staged changes successfully produces the [StandalonePriceStagedChangesRemoved](ctp:api:type:StandalonePriceStagedChangesRemovedMessage) Message. -example: !include ../../../examples/StandalonePrice/StandalonePriceRemoveStagedChangesAction.json diff --git a/api-specs/api/types/types.raml b/api-specs/api/types/types.raml index b1a48e9d3..1124046ee 100644 --- a/api-specs/api/types/types.raml +++ b/api-specs/api/types/types.raml @@ -164,7 +164,6 @@ LineItem: !include cart/LineItem.raml LineItemDraft: !include cart/LineItemDraft.raml LineItemMode: !include cart/LineItemMode.raml LineItemPriceMode: !include cart/LineItemPriceMode.raml -MethodExternalTaxRateDraft: !include cart/MethodExternalTaxRateDraft.raml MethodTaxRate: !include cart/MethodTaxRate.raml MethodTaxedPrice: !include cart/MethodTaxedPrice.raml ReplicaCartDraft: !include cart/ReplicaCartDraft.raml @@ -777,11 +776,6 @@ AssociateRolePermissionRemovedMessage: !include message/AssociateRolePermissionR AssociateRolePermissionsSetMessage: !include message/AssociateRolePermissionsSetMessage.raml BusinessUnitAddressAddedMessage: !include message/BusinessUnitAddressAddedMessage.raml BusinessUnitAddressChangedMessage: !include message/BusinessUnitAddressChangedMessage.raml -BusinessUnitAddressCustomFieldAddedMessage: !include message/BusinessUnitAddressCustomFieldAddedMessage.raml -BusinessUnitAddressCustomFieldChangedMessage: !include message/BusinessUnitAddressCustomFieldChangedMessage.raml -BusinessUnitAddressCustomFieldRemovedMessage: !include message/BusinessUnitAddressCustomFieldRemovedMessage.raml -BusinessUnitAddressCustomTypeRemovedMessage: !include message/BusinessUnitAddressCustomTypeRemovedMessage.raml -BusinessUnitAddressCustomTypeSetMessage: !include message/BusinessUnitAddressCustomTypeSetMessage.raml BusinessUnitAddressRemovedMessage: !include message/BusinessUnitAddressRemovedMessage.raml BusinessUnitAssociateAddedMessage: !include message/BusinessUnitAssociateAddedMessage.raml BusinessUnitAssociateChangedMessage: !include message/BusinessUnitAssociateChangedMessage.raml @@ -792,11 +786,6 @@ BusinessUnitBillingAddressAddedMessage: !include message/BusinessUnitBillingAddr BusinessUnitBillingAddressRemovedMessage: !include message/BusinessUnitBillingAddressRemovedMessage.raml BusinessUnitContactEmailSetMessage: !include message/BusinessUnitContactEmailSetMessage.raml BusinessUnitCreatedMessage: !include message/BusinessUnitCreatedMessage.raml -BusinessUnitCustomFieldAddedMessage: !include message/BusinessUnitCustomFieldAddedMessage.raml -BusinessUnitCustomFieldChangedMessage: !include message/BusinessUnitCustomFieldChangedMessage.raml -BusinessUnitCustomFieldRemovedMessage: !include message/BusinessUnitCustomFieldRemovedMessage.raml -BusinessUnitCustomTypeRemovedMessage: !include message/BusinessUnitCustomTypeRemovedMessage.raml -BusinessUnitCustomTypeSetMessage: !include message/BusinessUnitCustomTypeSetMessage.raml BusinessUnitDefaultBillingAddressSetMessage: !include message/BusinessUnitDefaultBillingAddressSetMessage.raml BusinessUnitDefaultShippingAddressSetMessage: !include message/BusinessUnitDefaultShippingAddressSetMessage.raml BusinessUnitDeletedMessage: !include message/BusinessUnitDeletedMessage.raml @@ -815,29 +804,14 @@ ContainerAndKey: !include message/ContainerAndKey.raml CustomLineItemStateTransitionMessage: !include message/CustomLineItemStateTransitionMessage.raml CustomerAddressAddedMessage: !include message/CustomerAddressAddedMessage.raml CustomerAddressChangedMessage: !include message/CustomerAddressChangedMessage.raml -CustomerAddressCustomFieldAddedMessage: !include message/CustomerAddressCustomFieldAddedMessage.raml -CustomerAddressCustomFieldChangedMessage: !include message/CustomerAddressCustomFieldChangedMessage.raml -CustomerAddressCustomFieldRemovedMessage: !include message/CustomerAddressCustomFieldRemovedMessage.raml -CustomerAddressCustomTypeRemovedMessage: !include message/CustomerAddressCustomTypeRemovedMessage.raml -CustomerAddressCustomTypeSetMessage: !include message/CustomerAddressCustomTypeSetMessage.raml CustomerAddressRemovedMessage: !include message/CustomerAddressRemovedMessage.raml CustomerCompanyNameSetMessage: !include message/CustomerCompanyNameSetMessage.raml CustomerCreatedMessage: !include message/CustomerCreatedMessage.raml -CustomerCustomFieldAddedMessage: !include message/CustomerCustomFieldAddedMessage.raml -CustomerCustomFieldChangedMessage: !include message/CustomerCustomFieldChangedMessage.raml -CustomerCustomFieldRemovedMessage: !include message/CustomerCustomFieldRemovedMessage.raml -CustomerCustomTypeRemovedMessage: !include message/CustomerCustomTypeRemovedMessage.raml -CustomerCustomTypeSetMessage: !include message/CustomerCustomTypeSetMessage.raml CustomerDateOfBirthSetMessage: !include message/CustomerDateOfBirthSetMessage.raml CustomerDeletedMessage: !include message/CustomerDeletedMessage.raml CustomerEmailChangedMessage: !include message/CustomerEmailChangedMessage.raml CustomerEmailVerifiedMessage: !include message/CustomerEmailVerifiedMessage.raml CustomerFirstNameSetMessage: !include message/CustomerFirstNameSetMessage.raml -CustomerGroupCustomFieldAddedMessage: !include message/CustomerGroupCustomFieldAddedMessage.raml -CustomerGroupCustomFieldChangedMessage: !include message/CustomerGroupCustomFieldChangedMessage.raml -CustomerGroupCustomFieldRemovedMessage: !include message/CustomerGroupCustomFieldRemovedMessage.raml -CustomerGroupCustomTypeRemovedMessage: !include message/CustomerGroupCustomTypeRemovedMessage.raml -CustomerGroupCustomTypeSetMessage: !include message/CustomerGroupCustomTypeSetMessage.raml CustomerGroupSetMessage: !include message/CustomerGroupSetMessage.raml CustomerLastNameSetMessage: !include message/CustomerLastNameSetMessage.raml CustomerPasswordUpdatedMessage: !include message/CustomerPasswordUpdatedMessage.raml @@ -932,7 +906,6 @@ ProductVariantDeletedMessage: !include message/ProductVariantDeletedMessage.raml QuoteCreatedMessage: !include message/QuoteCreatedMessage.raml QuoteCustomerChangedMessage: !include message/QuoteCustomerChangedMessage.raml QuoteDeletedMessage: !include message/QuoteDeletedMessage.raml -QuoteRenegotiationRequestedMessage: !include message/QuoteRenegotiationRequestedMessage.raml QuoteRequestCreatedMessage: !include message/QuoteRequestCreatedMessage.raml QuoteRequestCustomerChangedMessage: !include message/QuoteRequestCustomerChangedMessage.raml QuoteRequestDeletedMessage: !include message/QuoteRequestDeletedMessage.raml @@ -958,7 +931,6 @@ StandalonePriceDiscountSetMessage: !include message/StandalonePriceDiscountSetMe StandalonePriceExternalDiscountSetMessage: !include message/StandalonePriceExternalDiscountSetMessage.raml StandalonePriceKeySetMessage: !include message/StandalonePriceKeySetMessage.raml StandalonePriceStagedChangesAppliedMessage: !include message/StandalonePriceStagedChangesAppliedMessage.raml -StandalonePriceStagedChangesRemovedMessage: !include message/StandalonePriceStagedChangesRemovedMessage.raml StandalonePriceTierAddedMessage: !include message/StandalonePriceTierAddedMessage.raml StandalonePriceTierRemovedMessage: !include message/StandalonePriceTierRemovedMessage.raml StandalonePriceTiersSetMessage: !include message/StandalonePriceTiersSetMessage.raml @@ -985,16 +957,6 @@ AssociateRolePermissionRemovedMessagePayload: !include message/payload/Associate AssociateRolePermissionsSetMessagePayload: !include message/payload/AssociateRolePermissionsSetMessagePayload.raml BusinessUnitAddressAddedMessagePayload: !include message/payload/BusinessUnitAddressAddedMessagePayload.raml BusinessUnitAddressChangedMessagePayload: !include message/payload/BusinessUnitAddressChangedMessagePayload.raml -# yamllint disable-line rule:line-length -BusinessUnitAddressCustomFieldAddedMessagePayload: !include message/payload/BusinessUnitAddressCustomFieldAddedMessagePayload.raml -# yamllint disable-line rule:line-length -BusinessUnitAddressCustomFieldChangedMessagePayload: !include message/payload/BusinessUnitAddressCustomFieldChangedMessagePayload.raml -# yamllint disable-line rule:line-length -BusinessUnitAddressCustomFieldRemovedMessagePayload: !include message/payload/BusinessUnitAddressCustomFieldRemovedMessagePayload.raml -# yamllint disable-line rule:line-length -BusinessUnitAddressCustomTypeRemovedMessagePayload: !include message/payload/BusinessUnitAddressCustomTypeRemovedMessagePayload.raml -# yamllint disable-line rule:line-length -BusinessUnitAddressCustomTypeSetMessagePayload: !include message/payload/BusinessUnitAddressCustomTypeSetMessagePayload.raml BusinessUnitAddressRemovedMessagePayload: !include message/payload/BusinessUnitAddressRemovedMessagePayload.raml BusinessUnitAssociateAddedMessagePayload: !include message/payload/BusinessUnitAssociateAddedMessagePayload.raml BusinessUnitAssociateChangedMessagePayload: !include message/payload/BusinessUnitAssociateChangedMessagePayload.raml @@ -1008,11 +970,6 @@ BusinessUnitBillingAddressAddedMessagePayload: !include message/payload/Business BusinessUnitBillingAddressRemovedMessagePayload: !include message/payload/BusinessUnitBillingAddressRemovedMessagePayload.raml BusinessUnitContactEmailSetMessagePayload: !include message/payload/BusinessUnitContactEmailSetMessagePayload.raml BusinessUnitCreatedMessagePayload: !include message/payload/BusinessUnitCreatedMessagePayload.raml -BusinessUnitCustomFieldAddedMessagePayload: !include message/payload/BusinessUnitCustomFieldAddedMessagePayload.raml -BusinessUnitCustomFieldChangedMessagePayload: !include message/payload/BusinessUnitCustomFieldChangedMessagePayload.raml -BusinessUnitCustomFieldRemovedMessagePayload: !include message/payload/BusinessUnitCustomFieldRemovedMessagePayload.raml -BusinessUnitCustomTypeRemovedMessagePayload: !include message/payload/BusinessUnitCustomTypeRemovedMessagePayload.raml -BusinessUnitCustomTypeSetMessagePayload: !include message/payload/BusinessUnitCustomTypeSetMessagePayload.raml # yamllint disable-line rule:line-length BusinessUnitDefaultBillingAddressSetMessagePayload: !include message/payload/BusinessUnitDefaultBillingAddressSetMessagePayload.raml # yamllint disable-line rule:line-length @@ -1034,35 +991,14 @@ CategorySlugChangedMessagePayload: !include message/payload/CategorySlugChangedM CustomLineItemStateTransitionMessagePayload: !include message/payload/CustomLineItemStateTransitionMessagePayload.raml CustomerAddressAddedMessagePayload: !include message/payload/CustomerAddressAddedMessagePayload.raml CustomerAddressChangedMessagePayload: !include message/payload/CustomerAddressChangedMessagePayload.raml -# yamllint disable-line rule:line-length -CustomerAddressCustomFieldAddedMessagePayload: !include message/payload/CustomerAddressCustomFieldAddedMessagePayload.raml -# yamllint disable-line rule:line-length -CustomerAddressCustomFieldChangedMessagePayload: !include message/payload/CustomerAddressCustomFieldChangedMessagePayload.raml -# yamllint disable-line rule:line-length -CustomerAddressCustomFieldRemovedMessagePayload: !include message/payload/CustomerAddressCustomFieldRemovedMessagePayload.raml -# yamllint disable-line rule:line-length -CustomerAddressCustomTypeRemovedMessagePayload: !include message/payload/CustomerAddressCustomTypeRemovedMessagePayload.raml -CustomerAddressCustomTypeSetMessagePayload: !include message/payload/CustomerAddressCustomTypeSetMessagePayload.raml CustomerAddressRemovedMessagePayload: !include message/payload/CustomerAddressRemovedMessagePayload.raml CustomerCompanyNameSetMessagePayload: !include message/payload/CustomerCompanyNameSetMessagePayload.raml CustomerCreatedMessagePayload: !include message/payload/CustomerCreatedMessagePayload.raml -CustomerCustomFieldAddedMessagePayload: !include message/payload/CustomerCustomFieldAddedMessagePayload.raml -CustomerCustomFieldChangedMessagePayload: !include message/payload/CustomerCustomFieldChangedMessagePayload.raml -CustomerCustomFieldRemovedMessagePayload: !include message/payload/CustomerCustomFieldRemovedMessagePayload.raml -CustomerCustomTypeRemovedMessagePayload: !include message/payload/CustomerCustomTypeRemovedMessagePayload.raml -CustomerCustomTypeSetMessagePayload: !include message/payload/CustomerCustomTypeSetMessagePayload.raml CustomerDateOfBirthSetMessagePayload: !include message/payload/CustomerDateOfBirthSetMessagePayload.raml CustomerDeletedMessagePayload: !include message/payload/CustomerDeletedMessagePayload.raml CustomerEmailChangedMessagePayload: !include message/payload/CustomerEmailChangedMessagePayload.raml CustomerEmailVerifiedMessagePayload: !include message/payload/CustomerEmailVerifiedMessagePayload.raml CustomerFirstNameSetMessagePayload: !include message/payload/CustomerFirstNameSetMessagePayload.raml -CustomerGroupCustomFieldAddedMessagePayload: !include message/payload/CustomerGroupCustomFieldAddedMessagePayload.raml -# yamllint disable-line rule:line-length -CustomerGroupCustomFieldChangedMessagePayload: !include message/payload/CustomerGroupCustomFieldChangedMessagePayload.raml -# yamllint disable-line rule:line-length -CustomerGroupCustomFieldRemovedMessagePayload: !include message/payload/CustomerGroupCustomFieldRemovedMessagePayload.raml -CustomerGroupCustomTypeRemovedMessagePayload: !include message/payload/CustomerGroupCustomTypeRemovedMessagePayload.raml -CustomerGroupCustomTypeSetMessagePayload: !include message/payload/CustomerGroupCustomTypeSetMessagePayload.raml CustomerGroupSetMessagePayload: !include message/payload/CustomerGroupSetMessagePayload.raml CustomerLastNameSetMessagePayload: !include message/payload/CustomerLastNameSetMessagePayload.raml CustomerPasswordUpdatedMessagePayload: !include message/payload/CustomerPasswordUpdatedMessagePayload.raml @@ -1160,7 +1096,6 @@ ProductVariantDeletedMessagePayload: !include message/payload/ProductVariantDele QuoteCreatedMessagePayload: !include message/payload/QuoteCreatedMessagePayload.raml QuoteCustomerChangedMessagePayload: !include message/payload/QuoteCustomerChangedMessagePayload.raml QuoteDeletedMessagePayload: !include message/payload/QuoteDeletedMessagePayload.raml -QuoteRenegotiationRequestedMessagePayload: !include message/payload/QuoteRenegotiationRequestedMessagePayload.raml QuoteRequestCreatedMessagePayload: !include message/payload/QuoteRequestCreatedMessagePayload.raml QuoteRequestCustomerChangedMessagePayload: !include message/payload/QuoteRequestCustomerChangedMessagePayload.raml QuoteRequestDeletedMessagePayload: !include message/payload/QuoteRequestDeletedMessagePayload.raml @@ -1189,8 +1124,6 @@ StandalonePriceExternalDiscountSetMessagePayload: !include message/payload/Stand StandalonePriceKeySetMessagePayload: !include message/payload/StandalonePriceKeySetMessagePayload.raml # yamllint disable-line rule:line-length StandalonePriceStagedChangesAppliedMessagePayload: !include message/payload/StandalonePriceStagedChangesAppliedMessagePayload.raml -# yamllint disable-line rule:line-length -StandalonePriceStagedChangesRemovedMessagePayload: !include message/payload/StandalonePriceStagedChangesRemovedMessagePayload.raml StandalonePriceTierAddedMessagePayload: !include message/payload/StandalonePriceTierAddedMessagePayload.raml StandalonePriceTierRemovedMessagePayload: !include message/payload/StandalonePriceTierRemovedMessagePayload.raml StandalonePriceTiersSetMessagePayload: !include message/payload/StandalonePriceTiersSetMessagePayload.raml @@ -1871,7 +1804,6 @@ StagedQuoteSetCustomTypeAction: !include staged-quote/updates/StagedQuoteSetCust StagedQuoteSetSellerCommentAction: !include staged-quote/updates/StagedQuoteSetSellerCommentAction.raml StagedQuoteSetValidToAction: !include staged-quote/updates/StagedQuoteSetValidToAction.raml StagedQuoteTransitionStateAction: !include staged-quote/updates/StagedQuoteTransitionStateAction.raml -StagedPriceDraft: !include standalone-price/StagedPriceDraft.raml StagedStandalonePrice: !include standalone-price/StagedStandalonePrice.raml StandalonePrice: !include standalone-price/StandalonePrice.raml StandalonePriceDraft: !include standalone-price/StandalonePriceDraft.raml @@ -1885,8 +1817,6 @@ StandalonePriceApplyStagedChangesAction: !include standalone-price/updates/Stand StandalonePriceChangeActiveAction: !include standalone-price/updates/StandalonePriceChangeActiveAction.raml StandalonePriceChangeValueAction: !include standalone-price/updates/StandalonePriceChangeValueAction.raml StandalonePriceRemovePriceTierAction: !include standalone-price/updates/StandalonePriceRemovePriceTierAction.raml -# yamllint disable-line rule:line-length -StandalonePriceRemoveStagedChangesAction: !include standalone-price/updates/StandalonePriceRemoveStagedChangesAction.raml StandalonePriceSetCustomFieldAction: !include standalone-price/updates/StandalonePriceSetCustomFieldAction.raml StandalonePriceSetCustomTypeAction: !include standalone-price/updates/StandalonePriceSetCustomTypeAction.raml StandalonePriceSetDiscountedPriceAction: !include standalone-price/updates/StandalonePriceSetDiscountedPriceAction.raml diff --git a/api-specs/connect/api.raml b/api-specs/connect/api.raml index 1e3659dad..e6b312bcc 100644 --- a/api-specs/connect/api.raml +++ b/api-specs/connect/api.raml @@ -61,7 +61,7 @@ traits: ['manage_project:{projectKey}', 'manage_connectors:{projectKey}'], }, ] - secured_by_view_connectors_deployments: + secured_by_view_deployments: securedBy: [ oauth_2_0: @@ -69,12 +69,12 @@ traits: scopes: [ 'manage_project:{projectKey}', - 'manage_connectors_deployments:{projectKey}', - 'view_connectors_deployments:{projectKey}', + 'manage_deployments:{projectKey}', + 'view_deployments:{projectKey}', ], }, ] - secured_by_manage_connectors_deployments: + secured_by_manage_deployments: securedBy: [ oauth_2_0: @@ -82,7 +82,7 @@ traits: scopes: [ 'manage_project:{projectKey}', - 'manage_connectors_deployments:{projectKey}', + 'manage_deployments:{projectKey}', ], }, ] @@ -103,7 +103,7 @@ resourceTypes: !include types/resource-types.raml resourceType: Deployment post: is: - - secured_by_manage_connectors_deployments + - secured_by_manage_deployments body: type: DeploymentDraft example: !include ./examples/deployment/draft.json @@ -138,7 +138,7 @@ resourceTypes: !include types/resource-types.raml type: string[] description: Retrieves all deployments of a project key. is: - - secured_by_view_connectors_deployments + - secured_by_view_deployments responses: 200: body: diff --git a/api-specs/connect/examples/connector/ConnectorConfigurationApplication.json b/api-specs/connect/examples/connector/ConnectorConfigurationApplication.json index 84f723137..cfb5fa2ed 100644 --- a/api-specs/connect/examples/connector/ConnectorConfigurationApplication.json +++ b/api-specs/connect/examples/connector/ConnectorConfigurationApplication.json @@ -1,6 +1,5 @@ { "applicationName": "app-1", - "applicationType": "service", "standardConfiguration": [ { "key": "CONFIG_KEY", diff --git a/api-specs/connect/examples/connector/ConnectorReportEntry.json b/api-specs/connect/examples/connector/ConnectorReportEntry.json deleted file mode 100644 index d7b0c54f8..000000000 --- a/api-specs/connect/examples/connector/ConnectorReportEntry.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "Error", - "title": "Connector specification file not found", - "createdAt": "2023-08-08T12:20:31.143Z" -} diff --git a/api-specs/connect/examples/connector/Creator.json b/api-specs/connect/examples/connector/Creator.json index 3fa35850c..54601124d 100644 --- a/api-specs/connect/examples/connector/Creator.json +++ b/api-specs/connect/examples/connector/Creator.json @@ -3,7 +3,5 @@ "name": "John Doe", "email": "john.doe@example.com", "company": "commercetools", - "noOfContributors": 200, - "logoUrl": "https://www.example.com/logo.png", - "supportUrl": "https://www.example.com/support" + "noOfDevelopers": 200 } diff --git a/api-specs/connect/examples/connector/draft.json b/api-specs/connect/examples/connector/draft.json index 342d813bf..ae5a20c28 100644 --- a/api-specs/connect/examples/connector/draft.json +++ b/api-specs/connect/examples/connector/draft.json @@ -7,13 +7,12 @@ "name": "John Doe", "email": "john.doe@example.com", "company": "commercetools", - "noOfContributors": 200 + "noOfDevelopers": 200 }, "repository": { "url": "git@github.com:commercetools/connect-application-kit.git", "tag": "0.0.0" }, "privateProjects": [], - "supportedRegions": ["us-central1.gcp", "europe-west1.gcp"], - "isPreviewable": "true" + "supportedRegions": ["us-central1.gcp", "europe-west1.gcp"] } diff --git a/api-specs/connect/examples/connector/minimal.json b/api-specs/connect/examples/connector/minimal.json index 7ebbf7edb..2e2b6c7fa 100644 --- a/api-specs/connect/examples/connector/minimal.json +++ b/api-specs/connect/examples/connector/minimal.json @@ -9,7 +9,7 @@ "name": "John Doe", "email": "john.doe@example.com", "company": "commercetools", - "noOfContributors": 200 + "noOfDevelopers": 200 }, "repository": { "url": "git@github.com:commercetools/connect-application-kit.git", @@ -18,7 +18,6 @@ "configurations": [ { "applicationName": "app-1", - "applicationType": "service", "standardConfiguration": [ { "key": "CONFIG_KEY", @@ -34,6 +33,5 @@ } ], "private": false, - "supportedRegions": ["us-central1.gcp", "europe-west1.gcp"], - "certified": true + "supportedRegions": ["us-central1.gcp", "europe-west1.gcp"] } diff --git a/api-specs/connect/examples/connector/paged.json b/api-specs/connect/examples/connector/paged.json index 6c9b042ce..e1776cd2a 100644 --- a/api-specs/connect/examples/connector/paged.json +++ b/api-specs/connect/examples/connector/paged.json @@ -15,7 +15,7 @@ "name": "John Doe", "email": "john.doe@example.com", "company": "commercetools", - "noOfContributors": 200 + "noOfDevelopers": 200 }, "repository": { "url": "git@github.com:commercetools/connect-application-kit.git", @@ -24,7 +24,6 @@ "configurations": [ { "applicationName": "app-1", - "applicationType": "service", "standardConfiguration": [ { "key": "CONFIG_KEY", @@ -40,8 +39,7 @@ } ], "private": false, - "supportedRegions": ["us-central1.gcp", "europe-west1.gcp"], - "certified": true + "supportedRegions": ["us-central1.gcp", "europe-west1.gcp"] } ] } diff --git a/api-specs/connect/examples/connector/staged-paged.json b/api-specs/connect/examples/connector/staged-paged.json index 2a44d4bce..e23b858aa 100644 --- a/api-specs/connect/examples/connector/staged-paged.json +++ b/api-specs/connect/examples/connector/staged-paged.json @@ -15,7 +15,7 @@ "name": "John Doe", "email": "john.doe@example.com", "company": "commercetools", - "noOfContributors": 200 + "noOfDevelopers": 200 }, "repository": { "url": "git@github.com:commercetools/connect-application-kit.git", @@ -24,7 +24,6 @@ "configurations": [ { "applicationName": "app-1", - "applicationType": "service", "standardConfiguration": [ { "key": "CONFIG_KEY", @@ -44,10 +43,7 @@ "supportedRegions": ["us-central1.gcp", "europe-west1.gcp"], "hasChanges": false, "alreadyListed": false, - "status": "Draft", - "publishingReport": null, - "isPreviewable": "none", - "previewableReport": null + "status": "Draft" } ] } diff --git a/api-specs/connect/examples/connector/staged.json b/api-specs/connect/examples/connector/staged.json index 6655a7452..4ff2c713b 100644 --- a/api-specs/connect/examples/connector/staged.json +++ b/api-specs/connect/examples/connector/staged.json @@ -9,7 +9,7 @@ "name": "John Doe", "email": "john.doe@example.com", "company": "commercetools", - "noOfContributors": 200 + "noOfDevelopers": 200 }, "repository": { "url": "git@github.com:commercetools/connect-application-kit.git", @@ -18,7 +18,6 @@ "configurations": [ { "applicationName": "app-1", - "applicationType": "service", "standardConfiguration": [ { "key": "CONFIG_KEY", @@ -38,24 +37,5 @@ "supportedRegions": ["us-central1.gcp", "europe-west1.gcp"], "hasChanges": false, "alreadyListed": false, - "status": "Failed", - "publishingReport": { - "entries": [ - { - "type": "Error", - "title": "Connector specification file not found", - "createdAt": "2023-08-08T17:00:59.327Z" - } - ] - }, - "isPreviewable": "false", - "previewableReport": { - "entries": [ - { - "type": "Error", - "title": "Connector specification file not found", - "createdAt": "2023-08-08T12:20:31.143Z" - } - ] - } + "status": "Draft" } diff --git a/api-specs/connect/examples/connector/updates/ConnectorPublishAction.json b/api-specs/connect/examples/connector/updates/ConnectorPublishAction.json deleted file mode 100644 index ec05ba19a..000000000 --- a/api-specs/connect/examples/connector/updates/ConnectorPublishAction.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "action": "publish", - "certification": true -} diff --git a/api-specs/connect/examples/connector/updates/ConnectorSetCreatorLogoAction.json b/api-specs/connect/examples/connector/updates/ConnectorSetCreatorLogoAction.json deleted file mode 100644 index d73a4a992..000000000 --- a/api-specs/connect/examples/connector/updates/ConnectorSetCreatorLogoAction.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "action": "setCreatorLogo", - "logoUrl": "https://www.example.com/logo.png" -} diff --git a/api-specs/connect/examples/connector/updates/ConnectorSetCreatorNoOfContributorsAction.json b/api-specs/connect/examples/connector/updates/ConnectorSetCreatorNoOfContributorsAction.json deleted file mode 100644 index 1dbdcb059..000000000 --- a/api-specs/connect/examples/connector/updates/ConnectorSetCreatorNoOfContributorsAction.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "action": "setCreatorNoOfContributors", - "creatorNoOfContributors": 123 -} diff --git a/api-specs/connect/examples/connector/updates/ConnectorSetCreatorNoOfDevelopersAction.json b/api-specs/connect/examples/connector/updates/ConnectorSetCreatorNoOfDevelopersAction.json new file mode 100644 index 000000000..f8cedca68 --- /dev/null +++ b/api-specs/connect/examples/connector/updates/ConnectorSetCreatorNoOfDevelopersAction.json @@ -0,0 +1,4 @@ +{ + "action": "setCreatorNoOfDevelopers", + "creatorNoOfDevelopers": 123 +} diff --git a/api-specs/connect/examples/connector/updates/ConnectorSetCreatorSupportUrlAction.json b/api-specs/connect/examples/connector/updates/ConnectorSetCreatorSupportUrlAction.json deleted file mode 100644 index 1b9afcd0e..000000000 --- a/api-specs/connect/examples/connector/updates/ConnectorSetCreatorSupportUrlAction.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "action": "setCreatorSupportUrl", - "creatorSupportUrl": "https://www.example.com/support" -} diff --git a/api-specs/connect/examples/connector/updates/ConnectorSetDocumentationUrlAction.json b/api-specs/connect/examples/connector/updates/ConnectorSetDocumentationUrlAction.json deleted file mode 100644 index 10a3028bb..000000000 --- a/api-specs/connect/examples/connector/updates/ConnectorSetDocumentationUrlAction.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "action": "setDocumentationUrl", - "documentationUrl": "https://www.example.com/my-connector/documentation" -} diff --git a/api-specs/connect/examples/connector/updates/ConnectorTriggerCertificationAction.json b/api-specs/connect/examples/connector/updates/ConnectorTriggerCertificationAction.json new file mode 100644 index 000000000..820558b01 --- /dev/null +++ b/api-specs/connect/examples/connector/updates/ConnectorTriggerCertificationAction.json @@ -0,0 +1,3 @@ +{ + "action": "triggerCertification" +} diff --git a/api-specs/connect/examples/deployment/DeploymentConnector.json b/api-specs/connect/examples/deployment/DeploymentConnector.json index b705df1db..3dc3b2ce9 100644 --- a/api-specs/connect/examples/deployment/DeploymentConnector.json +++ b/api-specs/connect/examples/deployment/DeploymentConnector.json @@ -9,11 +9,10 @@ "name": "John Doe", "email": "john.doe@example.com", "company": "commercetools", - "noOfContributors": 200 + "noOfDevelopers": 200 }, "repository": { "url": "git@github.com:commercetools/connect-application-kit.git", "tag": "0.0.0" - }, - "certified": true + } } diff --git a/api-specs/connect/examples/deployment/DeploymentCreator.json b/api-specs/connect/examples/deployment/DeploymentCreator.json deleted file mode 100644 index 47329f274..000000000 --- a/api-specs/connect/examples/deployment/DeploymentCreator.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "title": "Mr", - "name": "John Doe", - "email": "john.doe@example.com", - "company": "commercetools", - "noOfContributors": 200 -} diff --git a/api-specs/connect/examples/deployment/DeploymentDetailsBuild.json b/api-specs/connect/examples/deployment/DeploymentDetailsBuild.json index 55ef1159d..353e57be5 100644 --- a/api-specs/connect/examples/deployment/DeploymentDetailsBuild.json +++ b/api-specs/connect/examples/deployment/DeploymentDetailsBuild.json @@ -1,13 +1,3 @@ { - "id": "a317ce94-5149-45ec-8717-d1c05b49005a", - "report": { - "entries": [ - { - "type": "Warning", - "application": "service", - "title": "Failed during the execution of 'postDeploy' script", - "createdAt": "2023-08-08T17:00:59.327Z" - } - ] - } + "id": "a317ce94-5149-45ec-8717-d1c05b49005a" } diff --git a/api-specs/connect/examples/deployment/minimal.json b/api-specs/connect/examples/deployment/minimal.json index 38d8f5b2d..513e9dcc5 100644 --- a/api-specs/connect/examples/deployment/minimal.json +++ b/api-specs/connect/examples/deployment/minimal.json @@ -13,27 +13,16 @@ "name": "John Doe", "email": "john.doe@example.com", "company": "commercetools", - "noOfContributors": 200 + "noOfDevelopers": 200 }, "repository": { "url": "git@github.com:commercetools/connect-application-kit.git", "tag": "0.0.0" - }, - "certified": true + } }, "details": { "build": { - "id": "a317ce94-5149-45ec-8717-d1c05b49005a", - "report": { - "entries": [ - { - "type": "Warning", - "application": "service", - "title": "Failed during the execution of 'postDeploy' script", - "createdAt": "2023-08-08T17:00:59.327Z" - } - ] - } + "id": "a317ce94-5149-45ec-8717-d1c05b49005a" } }, "applications": [ @@ -56,6 +45,5 @@ } ], "deployedRegion": "europe-west1.gcp", - "preview": true, "status": "Deployed" } diff --git a/api-specs/connect/examples/deployment/paged.json b/api-specs/connect/examples/deployment/paged.json index f62ebee62..1985d294b 100644 --- a/api-specs/connect/examples/deployment/paged.json +++ b/api-specs/connect/examples/deployment/paged.json @@ -19,27 +19,16 @@ "name": "John Doe", "email": "john.doe@example.com", "company": "commercetools", - "noOfContributors": 200 + "noOfDevelopers": 200 }, "repository": { "url": "git@github.com:commercetools/connect-application-kit.git", "tag": "0.0.0" - }, - "certified": true + } }, "details": { "build": { - "id": "a317ce94-5149-45ec-8717-d1c05b49005a", - "report": { - "entries": [ - { - "type": "Warning", - "application": "service", - "title": "Failed during the execution of 'postDeploy' script", - "createdAt": "2023-08-08T17:00:59.327Z" - } - ] - } + "id": "a317ce94-5149-45ec-8717-d1c05b49005a" } }, "applications": [ @@ -62,7 +51,6 @@ } ], "deployedRegion": "europe-west1.gcp", - "preview": true, "status": "Deployed" } ] diff --git a/api-specs/connect/security-schemes/oauth2.raml b/api-specs/connect/security-schemes/oauth2.raml index 66ac3f13c..dde159481 100644 --- a/api-specs/connect/security-schemes/oauth2.raml +++ b/api-specs/connect/security-schemes/oauth2.raml @@ -43,5 +43,5 @@ settings: - 'manage_project:{projectKey}' - 'view_connectors:{projectKey}' - 'manage_connectors:{projectKey}' - - 'view_connectors_deployments:{projectKey}' - - 'manage_connectors_deployments:{projectKey}' + - 'view_deployments:{projectKey}' + - 'manage_deployments:{projectKey}' diff --git a/api-specs/connect/types/annotations.raml b/api-specs/connect/types/annotations.raml index f5d5bfc8d..398063cdd 100644 --- a/api-specs/connect/types/annotations.raml +++ b/api-specs/connect/types/annotations.raml @@ -37,6 +37,3 @@ annotationTypes: region: string provider: string name: string - markDeprecated: - type: boolean - allowedTargets: TypeDeclaration diff --git a/api-specs/connect/types/common.raml b/api-specs/connect/types/common.raml index 4da946ff6..3b7588704 100644 --- a/api-specs/connect/types/common.raml +++ b/api-specs/connect/types/common.raml @@ -52,24 +52,17 @@ types: ConnectorConfigurationApplication: example: !include ../examples/connector/ConnectorConfigurationApplication.json description: | - The configuration of a Connect application. These values are automatically obtained from the connect.yaml file in the GitHub repository. + Describes the required configuration for a Connector. properties: applicationName: type: string - description: Name of the Connect application. - applicationType: - type: string - description: The Connect application type. - enum: - - service - - event - - job + description: Name of the application. Should match the value of `name` within the connect.yaml file of the Connect application. standardConfiguration: type: ConfigurationKey[] - description: Contains the name and description of standard environment variables. + description: Contains the name and description of keys saved as plain text. securedConfiguration: type: ConfigurationKey[] - description: Contains the name and description of secret environment variables. + description: Contains the name and description of secret keys. DeploymentConfigurationApplication: description: | Describes the configuration set of a given application. @@ -109,58 +102,22 @@ types: schedule?: type: string description: Cron schedule for job applications. - ConnectorReportEntryType: - type: string - description: | - The type of message being reported. - (annotations.enumDescriptions): - Information: Indicates information returned during the publish/preview task. - Warning: Indicates an issue that arose during the publish/preview task. - Error: Indicates a crash or failure to complete the publish/preview task. - enum: - - Information - - Warning - - Error - ConnectorReportEntry: - description: Describes an information, error, or warning notice. - example: !include ../examples/connector/ConnectorReportEntry.json - properties: - type: - type: ConnectorReportEntryType - description: The report entry type. - title: - type: string - description: The title of the report entry. - message?: - type: string - description: The message related to the report entry. - createdAt: - type: datetime - description: When the report entry was created. - ConnectorReport: - description: Contains report entries for publish/preview requests. - properties: - entries: - type: ConnectorReportEntry[] - description: Contains information, error, and warning notices. ConnectorStatus: type: string description: | Indicates the current status of the ConnectorStaged. (annotations.enumDescriptions): Draft: The ConnectorStaged is currently a draft. - Processing: The ConnectorStaged publish request is being processed. ReadyForCertification: The ConnectorStaged is ready to be certified. InCertification: The ConnectorStaged is in the certification process. - Published: The ConnectorStaged was published. - Failed: The ConnectorStaged was not published. + FeedbackRequired: The ConnectorStaged requires action from the creator to continue with the certification process. + Certified: The ConnectorStaged is certified. enum: - Draft - - Processing - ReadyForCertification - InCertification - - Published - - Failed + - FeedbackRequired + - Certified ConnectorReference: description: Reference to a Connector. Either `id` or `key` is required. example: !include ../examples/connector/ConnectorReference.json @@ -182,7 +139,7 @@ types: Creator: example: !include ../examples/connector/Creator.json description: | - Details of the individual or organization who developed the Connector. + Details of the individual or organization who developed the Connector. This information is used to facilitate communication during the certification process. properties: name?: type: string @@ -192,19 +149,13 @@ types: description: Title of the person who owns the Connector. email: type: string - description: Contact email address of the creator. + description: Contact email address of the Creator. company?: type: string description: Name of the company that owns the Connector. - logoUrl?: - type: string - description: URL to a logo image used to represent the creator. - noOfContributors?: + noOfDevelopers?: type: integer - description: Number of contributors currently working for the company. - supportUrl?: - type: string - description: URL to the support website of the Connector. + description: Number of developers currently working for the company. DeploymentConnector: example: !include ../examples/deployment/DeploymentConnector.json description: The details of the deployed [Connector](ctp:connect:type:Connector). @@ -227,81 +178,19 @@ types: type: string description: Description of the Connector. creator: - type: DeploymentCreator + type: Creator description: Owner of the Connector. repository: type: Repository - description: Details of the GitHub repository that contains the Connect applications. - certified: - type: boolean - description: If `true`, the Connector is certified. - DeploymentCreator: - example: !include ../examples/deployment/DeploymentCreator.json - description: The details of the deployed [DeploymentConnector](ctp:connect:type:DeploymentConnector) creator. - type: object - properties: - name?: - type: string - description: Name of the person who owns the Connector. - title?: - type: string - description: Title of the person who owns the Connector. - email: - type: string - description: Contact email address of the creator. - company?: - type: string - description: Name of the company that owns the Connector. - noOfContributors?: - type: integer - description: Number of contributors currently working for the company. - DeploymentReportEntryType: - type: string - description: | - The type of message being reported. - (annotations.enumDescriptions): - Information: Indicates information returned during the deployment process. - Warning: Indicates an issue that arose during the deployment process. - Error: Indicates a crash or failure to complete the deployment process. - enum: - - Information - - Warning - - Error - DeploymentReportEntry: - description: Describes an information, error, or warning in the deployment report. - properties: - type: - type: DeploymentReportEntryType - description: The report entry type. - title: - type: string - description: The title of the report entry. - message?: - type: string - description: The message related to the report entry. - application?: - type: string - description: The name of the Connect application related to the entry. - createdAt: - type: datetime - description: When the report entry was created. - DeploymentReport: - description: Describes a report of the Connector deployment process. - properties: - entries: - type: DeploymentReportEntry[] - description: Contains informations, errors and warnings about the Connector deployment. + description: Details of the GitHub repository that contains the Connect application. DeploymentDetailsBuild: example: !include ../examples/deployment/DeploymentDetailsBuild.json properties: id: type: string description: The build execution id of the deployed application. - report?: - type: DeploymentReport - description: The build report of the deployed Connector. DeploymentDetails: - description: Additional details about the deployed Connector. + description: The build and runtime details of deployed applications. type: object properties: build: @@ -328,7 +217,7 @@ types: - UndeployFailed DeploymentLogSeverity: type: string - description: The severity of the log message. + description: Indicates the severity of the log message. (annotations.enumDescriptions): DEFAULT: The log entry has no assigned severity level. DEBUG: Debug or trace information. @@ -359,7 +248,7 @@ types: Repository: example: !include ../examples/connector/Repository.json description: | - Details of the GitHub repository that contains the Connect applications. + Details of the GitHub repository that contains the Connect application. properties: url: type: string diff --git a/api-specs/connect/types/connector/connector-draft.raml b/api-specs/connect/types/connector/connector-draft.raml index da856ace3..640f12ae6 100644 --- a/api-specs/connect/types/connector/connector-draft.raml +++ b/api-specs/connect/types/connector/connector-draft.raml @@ -26,6 +26,3 @@ properties: privateProjects?: type: common.ProjectIdentifier[] description: Composable Commerce Projects that can access the Connector. If empty, only the creator can access this Connector. - documentationUrl?: - type: string - description: URL to the documentation of the Connector. diff --git a/api-specs/connect/types/connector/connector-staged.raml b/api-specs/connect/types/connector/connector-staged.raml index 306cd165e..f837dc3d4 100644 --- a/api-specs/connect/types/connector/connector-staged.raml +++ b/api-specs/connect/types/connector/connector-staged.raml @@ -46,22 +46,13 @@ properties: type: common.ConnectorStatus description: Current status of the Connector. default: Draft - publishingReport?: - type: common.ConnectorReport - description: The publishing request report of the Connector. alreadyListed: type: boolean description: If `true`, the Connector is published and ready for use. hasChanges: type: boolean description: If `true`, the ConnectorStaged data is different from the production [Connector](ctp:connect:type:Connector) data. - isPreviewable: + isPreviewable?: type: common.IsPreviewable description: The previewable status of the ConnectorStaged. default: none - previewableReport?: - type: common.ConnectorReport - description: The previewable request report. - documentationUrl?: - type: string - description: URL to the documentation of the Connector. diff --git a/api-specs/connect/types/connector/connector.raml b/api-specs/connect/types/connector/connector.raml index 0ab71579e..7795ad7e5 100644 --- a/api-specs/connect/types/connector/connector.raml +++ b/api-specs/connect/types/connector/connector.raml @@ -36,9 +36,3 @@ properties: supportedRegions: type: common.Region[] description: If not empty, Connectors can only be deployed in these Regions. If empty, Connectors can be deployed in any [supported Region](hosts-and-authorization#hosts). - certified: - type: boolean - description: If `true`, the Connector is certified. - documentationUrl?: - type: string - description: URL to the documentation of the Connector. diff --git a/api-specs/connect/types/connector/updates/connector-publish-action.raml b/api-specs/connect/types/connector/updates/connector-publish-action.raml deleted file mode 100644 index 5d8ea8175..000000000 --- a/api-specs/connect/types/connector/updates/connector-publish-action.raml +++ /dev/null @@ -1,12 +0,0 @@ -#%RAML 1.0 DataType -(annotations.package): Connector -type: ConnectorUpdateAction -displayName: ConnectorPublishAction -discriminatorValue: publish -example: !include ../../../examples/connector/updates/ConnectorPublishAction.json -description: | - Starts the Connector publishing process. You will be unable to update the Connector until the process completes. -properties: - certification: - type: boolean - description: If `true`, the ConnectorStaged enters the certification process. After completing the certification process, the Connector will become publicly available. If `false`, the published Connector becomes private and is available for deployment to Projects listed in `ConnectorStaged.privateProjects`. diff --git a/api-specs/connect/types/connector/updates/connector-set-company-action.raml b/api-specs/connect/types/connector/updates/connector-set-company-action.raml index bd032f1c1..5aabb6086 100644 --- a/api-specs/connect/types/connector/updates/connector-set-company-action.raml +++ b/api-specs/connect/types/connector/updates/connector-set-company-action.raml @@ -5,7 +5,7 @@ displayName: ConnectorSetCreatorCompanyAction discriminatorValue: setCreatorCompany example: !include ../../../examples/connector/updates/ConnectorSetCreatorCompanyAction.json description: | - Updates the company of the creator. + Updates the creator's company. properties: creatorCompany: type: string diff --git a/api-specs/connect/types/connector/updates/connector-set-creator-email-action.raml b/api-specs/connect/types/connector/updates/connector-set-creator-email-action.raml index dde62843a..5cb7b35bd 100644 --- a/api-specs/connect/types/connector/updates/connector-set-creator-email-action.raml +++ b/api-specs/connect/types/connector/updates/connector-set-creator-email-action.raml @@ -5,7 +5,7 @@ displayName: ConnectorSetCreatorEmailAction discriminatorValue: setCreatorEmail example: !include ../../../examples/connector/updates/ConnectorSetCreatorEmailAction.json description: | - Updates the email address of the creator. + Updates the creator's contact email address. properties: creatorEmail: type: string diff --git a/api-specs/connect/types/connector/updates/connector-set-creator-logo-action.raml b/api-specs/connect/types/connector/updates/connector-set-creator-logo-action.raml deleted file mode 100644 index b1f90dac1..000000000 --- a/api-specs/connect/types/connector/updates/connector-set-creator-logo-action.raml +++ /dev/null @@ -1,12 +0,0 @@ -#%RAML 1.0 DataType -(annotations.package): Connector -type: ConnectorUpdateAction -displayName: ConnectorSetCreatorLogoAction -discriminatorValue: setCreatorLogo -example: !include ../../../examples/connector/updates/ConnectorSetCreatorLogoAction.json -description: | - Updates the logo of the creator. -properties: - logoUrl: - type: string - description: Value to set. diff --git a/api-specs/connect/types/connector/updates/connector-set-creator-name-action.raml b/api-specs/connect/types/connector/updates/connector-set-creator-name-action.raml index 12b1036e9..4b083959b 100644 --- a/api-specs/connect/types/connector/updates/connector-set-creator-name-action.raml +++ b/api-specs/connect/types/connector/updates/connector-set-creator-name-action.raml @@ -5,7 +5,7 @@ displayName: ConnectorSetCreatorNameAction discriminatorValue: setCreatorName example: !include ../../../examples/connector/updates/ConnectorSetCreatorNameAction.json description: | - Updates the name of the creator. + Updates the creator's name. properties: creatorName: type: string diff --git a/api-specs/connect/types/connector/updates/connector-set-creator-support-url-action.raml b/api-specs/connect/types/connector/updates/connector-set-creator-support-url-action.raml deleted file mode 100644 index 04b0d2d58..000000000 --- a/api-specs/connect/types/connector/updates/connector-set-creator-support-url-action.raml +++ /dev/null @@ -1,12 +0,0 @@ -#%RAML 1.0 DataType -(annotations.package): Connector -type: ConnectorUpdateAction -displayName: ConnectorSetCreatorSupportUrlAction -discriminatorValue: setCreatorSupportUrl -example: !include ../../../examples/connector/updates/ConnectorSetCreatorSupportUrlAction.json -description: | - Updates the support URL of the creator. -properties: - creatorSupportUrl: - type: string - description: Value to set. diff --git a/api-specs/connect/types/connector/updates/connector-set-creator-title-action.raml b/api-specs/connect/types/connector/updates/connector-set-creator-title-action.raml index 6ce0ede7b..d3518ec5c 100644 --- a/api-specs/connect/types/connector/updates/connector-set-creator-title-action.raml +++ b/api-specs/connect/types/connector/updates/connector-set-creator-title-action.raml @@ -5,7 +5,7 @@ displayName: ConnectorSetCreatorTitleAction discriminatorValue: setCreatorTitle example: !include ../../../examples/connector/updates/ConnectorSetCreatorTitleAction.json description: | - Updates the title of the creator. + Updates the creator's title. properties: creatorTitle: type: string diff --git a/api-specs/connect/types/connector/updates/connector-set-description-action.raml b/api-specs/connect/types/connector/updates/connector-set-description-action.raml index a7204b96f..88582c969 100644 --- a/api-specs/connect/types/connector/updates/connector-set-description-action.raml +++ b/api-specs/connect/types/connector/updates/connector-set-description-action.raml @@ -5,7 +5,7 @@ displayName: ConnectorSetDescriptionAction discriminatorValue: setDescription example: !include ../../../examples/connector/updates/ConnectorSetDescriptionAction.json description: | - Updates the description of the Connector. + Updates the description in Connector. properties: description: type: string diff --git a/api-specs/connect/types/connector/updates/connector-set-documentation-url-action.raml b/api-specs/connect/types/connector/updates/connector-set-documentation-url-action.raml deleted file mode 100644 index 1227629ef..000000000 --- a/api-specs/connect/types/connector/updates/connector-set-documentation-url-action.raml +++ /dev/null @@ -1,12 +0,0 @@ -#%RAML 1.0 DataType -(annotations.package): Connector -type: ConnectorUpdateAction -displayName: ConnectorSetDocumentationUrlAction -discriminatorValue: setDocumentationUrl -example: !include ../../../examples/connector/updates/ConnectorSetDocumentationUrlAction.json -description: | - Updates the documentation URL of the Connector. -properties: - documentationUrl: - type: string - description: Value to set. diff --git a/api-specs/connect/types/connector/updates/connector-set-no-contributors-action.raml b/api-specs/connect/types/connector/updates/connector-set-no-contributors-action.raml deleted file mode 100644 index 5c9f16d22..000000000 --- a/api-specs/connect/types/connector/updates/connector-set-no-contributors-action.raml +++ /dev/null @@ -1,13 +0,0 @@ -#%RAML 1.0 DataType -(annotations.package): Connector -type: ConnectorUpdateAction -displayName: ConnectorSetCreatorNoOfContributorsAction -discriminatorValue: setCreatorNoOfContributors -example: !include ../../../examples/connector/updates/ConnectorSetCreatorNoOfContributorsAction.json -description: | - Updates the number of contributors of the creator. -properties: - creatorNoOfContributors: - type: integer - description: Value to set. - minimum: 1 diff --git a/api-specs/connect/types/connector/updates/connector-set-no-developers-action.raml b/api-specs/connect/types/connector/updates/connector-set-no-developers-action.raml new file mode 100644 index 000000000..9ccf058e5 --- /dev/null +++ b/api-specs/connect/types/connector/updates/connector-set-no-developers-action.raml @@ -0,0 +1,12 @@ +#%RAML 1.0 DataType +(annotations.package): Connector +type: ConnectorUpdateAction +displayName: ConnectorSetCreatorNoOfDevelopersAction +discriminatorValue: setCreatorNoOfDevelopers +example: !include ../../../examples/connector/updates/ConnectorSetCreatorNoOfDevelopersAction.json +description: | + Updates the number of developers within the creator's company. +properties: + creatorNoOfDevelopers: + type: integer + description: Value to set. diff --git a/api-specs/connect/types/connector/updates/connector-set-repository-action.raml b/api-specs/connect/types/connector/updates/connector-set-repository-action.raml index 602021bc5..69e5a68ce 100644 --- a/api-specs/connect/types/connector/updates/connector-set-repository-action.raml +++ b/api-specs/connect/types/connector/updates/connector-set-repository-action.raml @@ -5,7 +5,7 @@ displayName: ConnectorSetRepositoryAction discriminatorValue: setRepository example: !include ../../../examples/connector/updates/ConnectorSetRepositoryAction.json description: | - Updates the GitHub repository details of the Connector. + Update the GitHub repository details for the Connector. properties: url: type: string diff --git a/api-specs/connect/types/connector/updates/connector-set-supported-regions-action.raml b/api-specs/connect/types/connector/updates/connector-set-supported-regions-action.raml index cd4d84e72..54b475d58 100644 --- a/api-specs/connect/types/connector/updates/connector-set-supported-regions-action.raml +++ b/api-specs/connect/types/connector/updates/connector-set-supported-regions-action.raml @@ -5,7 +5,7 @@ displayName: ConnectorSetSupportedRegionsAction discriminatorValue: setSupportedRegions example: !include ../../../examples/connector/updates/ConnectorSetSupportedRegionsAction.json description: | - Updates the regions that the Connector can be deployed in. + Updates the Regions that the Connector can be deployed in. properties: regions: type: common.Region[] diff --git a/api-specs/connect/types/connector/updates/connector-trigger-certification-action.raml b/api-specs/connect/types/connector/updates/connector-trigger-certification-action.raml new file mode 100644 index 000000000..ddec249f9 --- /dev/null +++ b/api-specs/connect/types/connector/updates/connector-trigger-certification-action.raml @@ -0,0 +1,10 @@ +#%RAML 1.0 DataType +(annotations.package): Connector +type: ConnectorUpdateAction +displayName: ConnectorTriggerCertificationAction +example: !include ../../../examples/connector/updates/ConnectorTriggerCertificationAction.json +discriminatorValue: triggerCertification +description: | + After triggering the certification process you cannot update the Connector until the review process is complete. + + Triggering the certification process when the Connector is already certified, or when the Connector is in the certification process, returns the [ConnectorAlreadyCertified](ctp:connect:type:ConnectorAlreadyCertifiedError) and [ConnectorStagedInCertification](ctp:connect:type:ConnectorStagedInCertificationError) errors, respectively. diff --git a/api-specs/connect/types/deployment/deployment.raml b/api-specs/connect/types/deployment/deployment.raml index e990af014..611c9273b 100644 --- a/api-specs/connect/types/deployment/deployment.raml +++ b/api-specs/connect/types/deployment/deployment.raml @@ -27,9 +27,6 @@ properties: applications: type: common.ApplicationDeployment[] description: Application deployments needed by the connector for hosting and configuration, refer to Connector configurations for details. - preview: - type: boolean - description: If `true`, the Deployment is a preview. status: type: common.DeploymentStatus - description: The current status of the Deployment. + description: Indicates the current status of the Deployment. diff --git a/api-specs/connect/types/deployment/updates/deployment-redeploy-action.raml b/api-specs/connect/types/deployment/updates/deployment-redeploy-action.raml index cf2812fd9..ae7db77ac 100644 --- a/api-specs/connect/types/deployment/updates/deployment-redeploy-action.raml +++ b/api-specs/connect/types/deployment/updates/deployment-redeploy-action.raml @@ -11,10 +11,6 @@ description: | Attempting to redeploy a Deployment with a `Queued`, `Deploying`, or `Undeploying` [DeploymentStatus](ctp:connect:type:DeploymentStatus) returns a [DeploymentInvalidStatusTransition](ctp:connect:type:DeploymentInvalidStatusTransitionError) error. properties: - skipScripts?: - type: boolean - default: false - description: If scripts execution should be skipped during deployment. configurationValues?: type: common.DeploymentConfigurationApplication[] description: New configuration values for Deployment. If empty, any existing value is unchanged. diff --git a/api-specs/connect/types/error/ConnectorAlreadyCertifiedError.raml b/api-specs/connect/types/error/ConnectorAlreadyCertifiedError.raml index da91ecf0a..dcdc35f70 100644 --- a/api-specs/connect/types/error/ConnectorAlreadyCertifiedError.raml +++ b/api-specs/connect/types/error/ConnectorAlreadyCertifiedError.raml @@ -4,9 +4,9 @@ type: ErrorObject displayName: ConnectorAlreadyCertifiedError discriminatorValue: ConnectorAlreadyCertified description: | - Returned when trying to certify a Connector that is already certified. + Returned when trying to trigger the certification process for a Connector, but the Connector is already certified. - The error is returned as a failed response to the [Publish](ctp:connect:type:ConnectorPublishAction) update action only when certification is required. + The error is returned as a failed response to the [Trigger Certification Process](ctp:connect:type:ConnectorTriggerCertificationAction) update action. properties: code: type: string diff --git a/api-specs/connect/types/error/ConnectorStagedInCertificationError.raml b/api-specs/connect/types/error/ConnectorStagedInCertificationError.raml index 905c86510..8c897958e 100644 --- a/api-specs/connect/types/error/ConnectorStagedInCertificationError.raml +++ b/api-specs/connect/types/error/ConnectorStagedInCertificationError.raml @@ -4,9 +4,9 @@ type: ErrorObject displayName: ConnectorStagedInCertificationError discriminatorValue: ConnectorStagedInCertification description: | - Returned when trying to publish a Connector that requires certification but is already in the certification process. + Returned when trying to trigger the certification process for a Connector that is already in the certification process. - The error is returned as a failed response to the [Publish](ctp:connect:type:ConnectorPublishAction) update actiononly when certification is required. + The error is returned as a failed response to the [Trigger Certification Process](ctp:connect:type:ConnectorTriggerCertificationAction) update action. properties: code: type: string diff --git a/api-specs/connect/types/error/DeploymentEntityApplicationDoNotBelongError.raml b/api-specs/connect/types/error/DeploymentEntityApplicationDoNotBelongError.raml deleted file mode 100644 index 08ab804f1..000000000 --- a/api-specs/connect/types/error/DeploymentEntityApplicationDoNotBelongError.raml +++ /dev/null @@ -1,14 +0,0 @@ -#%RAML 1.0 DataType -(annotations.package): error -type: ErrorObject -displayName: DeploymentEntityApplicationDoNotBelongError -discriminatorValue: DeploymentApplicationDoNotBelong -description: | - Returned when attempting to add an application that does not belong to the Deployment. -properties: - code: - type: string - message: - type: string - description: | - `"Deployment with id=$resourceId or key=$resourceKey does not include application: $applicationName"` diff --git a/api-specs/connect/types/error/DeploymentEntityApplicationRequiredError.raml b/api-specs/connect/types/error/DeploymentEntityApplicationRequiredError.raml deleted file mode 100644 index 09f8a0ada..000000000 --- a/api-specs/connect/types/error/DeploymentEntityApplicationRequiredError.raml +++ /dev/null @@ -1,14 +0,0 @@ -#%RAML 1.0 DataType -(annotations.package): error -type: ErrorObject -displayName: DeploymentEntityApplicationRequiredError -discriminatorValue: DeploymentApplicationRequired -description: | - Returned when a Deployment does not contain any applications. -properties: - code: - type: string - message: - type: string - description: | - `"A Deployment requires at least one application"` diff --git a/api-specs/connect/types/error/DeploymentEntityMustIncludeApplicationError.raml b/api-specs/connect/types/error/DeploymentEntityMustIncludeApplicationError.raml deleted file mode 100644 index 5364b6ce0..000000000 --- a/api-specs/connect/types/error/DeploymentEntityMustIncludeApplicationError.raml +++ /dev/null @@ -1,14 +0,0 @@ -#%RAML 1.0 DataType -(annotations.package): error -type: ErrorObject -displayName: DeploymentEntityMustIncludeApplicationError -discriminatorValue: DeploymentMustIncludeApplication -description: | - Returned when attempting to remove an application that belongs to the Deployment. -properties: - code: - type: string - message: - type: string - description: | - `"Deployment with id=$resourceId or key=$resourceKey must include application: $applicationName"` diff --git a/api-specs/connect/types/error/FieldValueNotFoundError.raml b/api-specs/connect/types/error/FieldValueNotFoundError.raml index af7805ad8..e84fba674 100644 --- a/api-specs/connect/types/error/FieldValueNotFoundError.raml +++ b/api-specs/connect/types/error/FieldValueNotFoundError.raml @@ -4,7 +4,7 @@ type: ErrorObject displayName: FieldValueNotFoundError discriminatorValue: FieldValueNotFound description: | - Returned when a value for a field is not found. + Returned when a specified value for a field is not found. properties: code: type: string diff --git a/api-specs/connect/types/resource-types.raml b/api-specs/connect/types/resource-types.raml index 9599b03d9..bb746dacb 100644 --- a/api-specs/connect/types/resource-types.raml +++ b/api-specs/connect/types/resource-types.raml @@ -38,8 +38,6 @@ baseByParam: displayName: Delete <> by <> responses: 200: - body: - type: Deployment connectorByParam: type: baseByParam get: @@ -65,7 +63,7 @@ deploymentByParam: type: baseByParam get: is: - - secured_by_view_connectors_deployments + - secured_by_view_deployments responses: 200: body: @@ -73,7 +71,7 @@ deploymentByParam: example: !include ../examples/deployment/minimal.json post: is: - - secured_by_manage_connectors_deployments + - secured_by_manage_deployments body: type: DeploymentUpdate example: !include ../examples/deployment/update.json @@ -84,7 +82,7 @@ deploymentByParam: example: !include ../examples/deployment/minimal.json delete: is: - - secured_by_manage_connectors_deployments + - secured_by_manage_deployments responses: 202: body: @@ -95,7 +93,7 @@ deploymentLogs: get: description: Retrieves logs for the given deployment. is: - - secured_by_view_connectors_deployments + - secured_by_view_deployments queryParameters: pageToken?: type: string diff --git a/api-specs/connect/types/types.raml b/api-specs/connect/types/types.raml index cd3bd6d60..a4a1ed263 100644 --- a/api-specs/connect/types/types.raml +++ b/api-specs/connect/types/types.raml @@ -9,19 +9,16 @@ ConnectorSetCreatorEmailAction: !include connector/updates/connector-set-creator ConnectorSetCreatorNameAction: !include connector/updates/connector-set-creator-name-action.raml ConnectorSetCreatorTitleAction: !include connector/updates/connector-set-creator-title-action.raml ConnectorSetDescriptionAction: !include connector/updates/connector-set-description-action.raml -ConnectorSetCreatorSupportUrlAction: !include connector/updates/connector-set-creator-support-url-action.raml ConnectorSetNameAction: !include connector/updates/connector-set-name-action.raml -ConnectorSetCreatorLogoAction: !include connector/updates/connector-set-creator-logo-action.raml -ConnectorSetCreatorNoOfContributorsAction: !include connector/updates/connector-set-no-contributors-action.raml +ConnectorSetCreatorNoOfDevelopersAction: !include connector/updates/connector-set-no-developers-action.raml ConnectorAddPrivateProjectAction: !include connector/updates/connector-add-private-project-action.raml ConnectorRemovePrivateProjectAction: !include connector/updates/connector-remove-private-project-action.raml ConnectorSetRepositoryAction: !include connector/updates/connector-set-repository-action.raml ConnectorSetSupportedRegionsAction: !include connector/updates/connector-set-supported-regions-action.raml -ConnectorSetDocumentationUrlAction: !include connector/updates/connector-set-documentation-url-action.raml +ConnectorTriggerCertificationAction: !include connector/updates/connector-trigger-certification-action.raml ConnectorUnlistAction: !include connector/updates/connector-unlist.action.raml ConnectorAddCertificationCommentAction: !include connector/updates/connector-add-certification-comment-action.raml ConnectorUpdatePreviewableAction: !include connector/updates/connector-update-previewable-action.raml -ConnectorPublishAction: !include connector/updates/connector-publish-action.raml # Deployment Deployment: !include deployment/deployment.raml DeploymentDraft: !include deployment/deployment-draft.raml @@ -60,6 +57,3 @@ DeploymentInvalidStatusTransitionError: !include error/DeploymentInvalidStatusTr DeploymentUnknownApplicationConfigurationError: !include error/DeploymentUnknownApplicationConfigurationError.raml DeploymentUnknownApplicationConfigurationKeyError: !include error/DeploymentUnknownApplicationConfigurationKeyError.raml DeploymentUnsupportedRegionError: !include error/DeploymentUnsupportedRegionError.raml -DeploymentEntityApplicationDoNotBelongError: !include error/DeploymentEntityApplicationDoNotBelongError.raml -DeploymentEntityApplicationRequiredError: !include error/DeploymentEntityApplicationRequiredError.raml -DeploymentEntityMustIncludeApplicationError: !include error/DeploymentEntityMustIncludeApplicationError.raml diff --git a/api-specs/graphql/schema.sdl b/api-specs/graphql/schema.sdl index 88797b66b..96bebe47b 100644 --- a/api-specs/graphql/schema.sdl +++ b/api-specs/graphql/schema.sdl @@ -140,7 +140,6 @@ input AddCartLineItem { inventoryMode: InventoryMode externalTotalPrice: ExternalLineItemTotalPriceDraft externalPrice: BaseMoneyInput - perMethodExternalTaxRate: [MethodExternalTaxRateDraft!] = [] externalTaxRate: ExternalTaxRateDraft custom: CustomFieldsDraft distributionChannel: ResourceIdentifierInput @@ -416,7 +415,6 @@ input AddStagedOrderLineItem { inventoryMode: InventoryMode externalTotalPrice: ExternalLineItemTotalPriceDraft externalPrice: BaseMoneyInput - perMethodExternalTaxRate: [MethodExternalTaxRateDraft!] = [] externalTaxRate: ExternalTaxRateDraft custom: CustomFieldsDraft distributionChannel: ResourceIdentifierInput @@ -659,36 +657,57 @@ input ApplyStagedChanges { dummy: String } -type AsAssociate implements CartQueryInterface & OrderQueryInterface & QuoteQueryInterface & QuoteRequestQueryInterface { +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" +type AsAssociate implements CartQueryInterface & OrderQueryInterface { + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" cart(id: String!): Cart + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" carts(where: String, sort: [String!], limit: Int, offset: Int): CartQueryResult! + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" order( "Queries with specified ID" id: String, orderNumber: String): Order + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" orders(where: String, sort: [String!], limit: Int, offset: Int): OrderQueryResult! + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" quoteRequest( "Queries with specified ID" id: String, "Queries with specified key" key: String): QuoteRequest + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" quoteRequests(where: String, sort: [String!], limit: Int, offset: Int): QuoteRequestQueryResult! + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" quote( "Queries with specified ID" id: String, "Queries with specified key" key: String): Quote + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" quotes(where: String, sort: [String!], limit: Int, offset: Int): QuoteQueryResult! + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" businessUnit( "Queries with specified ID" id: String, "Queries with specified key" key: String): BusinessUnit + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" businessUnits(where: String, sort: [String!], limit: Int, offset: Int): BusinessUnitQueryResult! } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input AsAssociateArgument { businessUnitKey: KeyReferenceInput! associateId: String! @@ -750,22 +769,29 @@ input AssetSourceInput { contentType: String } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type Associate { + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" associateRoleAssignments: [AssociateRoleAssignment!]! customerRef: Reference customer: Customer } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input AssociateDraft { customer: ResourceIdentifierInput! + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" associateRoleAssignments: [AssociateRoleAssignmentDraft!] } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" enum AssociateInheritanceMode { Disabled Enabled } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type AssociateRole implements Versioned { key: String! buyerAssignable: Boolean! @@ -780,14 +806,23 @@ type AssociateRole implements Versioned { lastModifiedBy: Initiator } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type AssociateRoleAssignment { + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" associateRoleRef: KeyReference + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" associateRole: AssociateRole! + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" inheritance: AssociateInheritanceMode! } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input AssociateRoleAssignmentDraft { associateRole: ResourceIdentifierInput! + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" inheritance: AssociateInheritanceMode } @@ -805,6 +840,7 @@ type AssociateRoleDeleted implements MessagePayload { type: String! } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input AssociateRoleDraft { key: String! name: String @@ -843,6 +879,7 @@ type AssociateRoleQueryResult { results: [AssociateRole!]! } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input AssociateRoleUpdateAction { addPermission: AddAssociateRolePermission changeBuyerAssignable: ChangeAssociateRoleBuyerAssignable @@ -1096,6 +1133,7 @@ type BooleanType implements FieldType { name: String! } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type BusinessUnit implements Versioned { key: String! name: String! @@ -1115,7 +1153,11 @@ type BusinessUnit implements Versioned { storeMode: String unitType: BusinessUnitType! associates: [Associate!]! + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" associateMode: BusinessUnitAssociateMode! + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" inheritedAssociates: [InheritedAssociate!] custom: CustomFieldsType parentUnitRef: KeyReference @@ -1146,35 +1188,6 @@ type BusinessUnitAddressChanged implements MessagePayload { type: String! } -type BusinessUnitAddressCustomFieldAdded implements MessagePayload { - name: String! - value: Json! - type: String! -} - -type BusinessUnitAddressCustomFieldChanged implements MessagePayload { - name: String! - value: Json! - oldValue: Json - type: String! -} - -type BusinessUnitAddressCustomFieldRemoved implements MessagePayload { - name: String! - type: String! -} - -type BusinessUnitAddressCustomTypeRemoved implements MessagePayload { - oldTypeId: String - type: String! -} - -type BusinessUnitAddressCustomTypeSet implements MessagePayload { - customFields: CustomFieldsType! - oldTypeId: String - type: String! -} - type BusinessUnitAddressRemoved implements MessagePayload { address: Address! type: String! @@ -1190,6 +1203,7 @@ type BusinessUnitAssociateChanged implements MessagePayload { type: String! } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" enum BusinessUnitAssociateMode { Explicit ExplicitAndFromParent @@ -1246,35 +1260,6 @@ type BusinessUnitCreated implements MessagePayload { type: String! } -type BusinessUnitCustomFieldAdded implements MessagePayload { - name: String! - value: Json! - type: String! -} - -type BusinessUnitCustomFieldChanged implements MessagePayload { - name: String! - value: Json! - oldValue: Json - type: String! -} - -type BusinessUnitCustomFieldRemoved implements MessagePayload { - name: String! - type: String! -} - -type BusinessUnitCustomTypeRemoved implements MessagePayload { - oldTypeId: String - type: String! -} - -type BusinessUnitCustomTypeSet implements MessagePayload { - customFields: CustomFieldsType! - oldTypeId: String - type: String! -} - type BusinessUnitDefaultBillingAddressSet implements MessagePayload { address: Address type: String! @@ -1289,6 +1274,7 @@ type BusinessUnitDeleted implements MessagePayload { type: String! } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input BusinessUnitDraft { key: String! name: String! @@ -1312,6 +1298,8 @@ input BusinessUnitDraft { parentUnit: ResourceIdentifierInput stores: [ResourceIdentifierInput!] associates: [AssociateDraft!] + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" associateMode: BusinessUnitAssociateMode } @@ -1348,6 +1336,7 @@ type BusinessUnitShippingAddressRemoved implements MessagePayload { type: String! } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" enum BusinessUnitStatus { Active Inactive @@ -1386,11 +1375,13 @@ type BusinessUnitStoresSet implements MessagePayload { type: String! } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" enum BusinessUnitType { Company Division } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input BusinessUnitUpdateAction { addAddress: AddBusinessUnitAddress addAssociate: AddBusinessUnitAssociate @@ -1417,6 +1408,8 @@ input BusinessUnitUpdateAction { setDefaultShippingAddress: SetBusinessUnitDefaultShippingAddress setStores: SetBusinessUnitStores setStoreMode: SetBusinessUnitStoreMode + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" changeAssociateMode: ChangeBusinessUnitAssociateMode } @@ -1675,7 +1668,7 @@ type CartLimitsProjection { } enum CartOrigin { - "The cart was created by our platform and belongs to a Quote." + "The cart was created by our platform and belongs to a Quote. BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" Quote "The cart was created by the merchant on behalf of the customer" @@ -1993,6 +1986,7 @@ input ChangeBusinessUnitAssociate { associate: AssociateDraft! } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input ChangeBusinessUnitAssociateMode { associateMode: BusinessUnitAssociateMode! } @@ -2764,7 +2758,6 @@ input CreateStandalonePrice { key: String sku: String! value: BaseMoneyInput! - staged: StagedPriceDraft country: Country customerGroup: ResourceIdentifierInput channel: ResourceIdentifierInput @@ -3125,35 +3118,6 @@ type CustomerAddressChanged implements MessagePayload { type: String! } -type CustomerAddressCustomFieldAdded implements MessagePayload { - name: String! - value: Json! - type: String! -} - -type CustomerAddressCustomFieldChanged implements MessagePayload { - name: String! - value: Json! - previousValue: Json - type: String! -} - -type CustomerAddressCustomFieldRemoved implements MessagePayload { - name: String! - type: String! -} - -type CustomerAddressCustomTypeRemoved implements MessagePayload { - previousTypeId: String - type: String! -} - -type CustomerAddressCustomTypeSet implements MessagePayload { - customFields: CustomFieldsType! - previousTypeId: String - type: String! -} - type CustomerAddressRemoved implements MessagePayload { address: Address! type: String! @@ -3169,35 +3133,6 @@ type CustomerCreated implements MessagePayload { type: String! } -type CustomerCustomFieldAdded implements MessagePayload { - name: String! - value: Json! - type: String! -} - -type CustomerCustomFieldChanged implements MessagePayload { - name: String! - value: Json! - previousValue: Json - type: String! -} - -type CustomerCustomFieldRemoved implements MessagePayload { - name: String! - type: String! -} - -type CustomerCustomTypeRemoved implements MessagePayload { - previousTypeId: String - type: String! -} - -type CustomerCustomTypeSet implements MessagePayload { - customFields: CustomFieldsType! - previousTypeId: String - type: String! -} - type CustomerDateOfBirthSet implements MessagePayload { dateOfBirth: Date type: String! @@ -3246,35 +3181,6 @@ type CustomerGroup implements Versioned & ReferenceExpandable { lastModifiedBy: Initiator } -type CustomerGroupCustomFieldAdded implements MessagePayload { - name: String! - value: Json! - type: String! -} - -type CustomerGroupCustomFieldChanged implements MessagePayload { - name: String! - value: Json! - oldValue: Json - type: String! -} - -type CustomerGroupCustomFieldRemoved implements MessagePayload { - name: String! - type: String! -} - -type CustomerGroupCustomTypeRemoved implements MessagePayload { - oldTypeId: String - type: String! -} - -type CustomerGroupCustomTypeSet implements MessagePayload { - customFields: CustomFieldsType! - oldTypeId: String - type: String! -} - input CustomerGroupDraft { groupName: String! key: String @@ -4339,19 +4245,29 @@ type InStoreMe implements MeQueryInterface & CartQueryInterface & ActiveCartInte shoppingLists(where: String, sort: [String!], limit: Int, offset: Int): ShoppingListQueryResult! } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type InheritedAssociate { associateRoleAssignments: [InheritedAssociateRoleAssignment!]! customerRef: Reference customer: Customer } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type InheritedAssociateRoleAssignment { + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" associateRoleRef: KeyReference! + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" associateRole: AssociateRole! + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" sourceRef: KeyReference! + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" source: BusinessUnit! } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" type InheritedStore { store: Store storeRef: KeyReference! @@ -4621,7 +4537,6 @@ type LineItemDraftOutput { variantId: Int custom: CustomFieldsCommand externalTaxRate: ExternalTaxRateDraftOutput - perMethodExternalTaxRate: [MethodExternalTaxRateDraftOutput!]! externalPrice: BaseMoney externalTotalPrice: ExternalLineItemTotalPrice inventoryMode: InventoryMode @@ -4975,16 +4890,6 @@ input MessagesConfigurationDraft { deleteDaysAfterCreation: Int! } -input MethodExternalTaxRateDraft { - shippingMethodKey: String! - taxRate: ExternalTaxRateDraft -} - -type MethodExternalTaxRateDraftOutput { - shippingMethodKey: String! - taxRate: ExternalTaxRateDraftOutput -} - type MethodTaxRate { shippingMethodKey: String! taxRate: TaxRate @@ -5443,14 +5348,14 @@ type Mutation { "The mutation is only performed if the resource is part of the store. Can be used with store-specific OAuth permissions." storeKey: KeyReferenceInput, - "Create/modify entity as an associate in business-unit." + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" asAssociate: AsAssociateArgument): Cart updateCart(version: Long!, actions: [CartUpdateAction!]!, "The mutation is only performed if the resource is part of the store. Can be used with store-specific OAuth permissions." storeKey: KeyReferenceInput, - "Create/modify entity as an associate in business-unit." + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" asAssociate: AsAssociateArgument, "Queries with specified ID" @@ -5463,7 +5368,7 @@ type Mutation { "The mutation is only performed if the resource is part of the store. Can be used with store-specific OAuth permissions." storeKey: KeyReferenceInput, - "Create/modify entity as an associate in business-unit." + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" asAssociate: AsAssociateArgument, "Queries with specified ID" @@ -5476,7 +5381,7 @@ type Mutation { "The mutation is only performed if the resource is part of the store. Can be used with store-specific OAuth permissions." storeKey: KeyReferenceInput, - "Create/modify entity as an associate in business-unit." + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" asAssociate: AsAssociateArgument): Cart "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" @@ -5504,14 +5409,14 @@ type Mutation { "The mutation is only performed if the resource is part of the store. Can be used with store-specific OAuth permissions." storeKey: KeyReferenceInput, - "Create/modify entity as an associate in business-unit." + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" asAssociate: AsAssociateArgument): Order updateOrder(version: Long!, actions: [OrderUpdateAction!]!, "The mutation is only performed if the resource is part of the store. Can be used with store-specific OAuth permissions." storeKey: KeyReferenceInput, - "Create/modify entity as an associate in business-unit." + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" asAssociate: AsAssociateArgument, "Queries with specified ID" @@ -5531,7 +5436,7 @@ type Mutation { storeKey: KeyReferenceInput): Order createOrderFromQuote(draft: OrderQuoteCommand!, - "Create/modify entity as an associate in business-unit." + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" asAssociate: AsAssociateArgument): Order "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" @@ -5721,11 +5626,11 @@ type Mutation { key: String): StandalonePrice createQuoteRequest(draft: QuoteRequestDraft!, - "Create/modify entity as an associate in business-unit." + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" asAssociate: AsAssociateArgument): QuoteRequest updateQuoteRequest(version: Long!, - "Create/modify entity as an associate in business-unit." + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" asAssociate: AsAssociateArgument, actions: [QuoteRequestUpdateAction!]!, "Queries with specified ID" @@ -5766,7 +5671,7 @@ type Mutation { createQuote(draft: QuoteDraft!): Quote updateQuote(version: Long!, actions: [QuoteUpdateAction!]!, - "Create/modify entity as an associate in business-unit." + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" asAssociate: AsAssociateArgument, "Queries with specified ID" @@ -5790,11 +5695,11 @@ type Mutation { key: String): Quote createBusinessUnit(draft: BusinessUnitDraft!, - "Create/modify entity as an associate in business-unit." + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" asAssociate: AsAssociateArgument): BusinessUnit updateBusinessUnit(version: Long!, actions: [BusinessUnitUpdateAction!]!, - "Create/modify entity as an associate in business-unit." + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" asAssociate: AsAssociateArgument, "Queries with specified ID" @@ -5817,7 +5722,11 @@ type Mutation { "Queries with specified key" key: String): BusinessUnit + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" createAssociateRole(draft: AssociateRoleDraft!): AssociateRole + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" updateAssociateRole(version: Long!, actions: [AssociateRoleUpdateAction!]!, "Queries with specified ID" @@ -5825,6 +5734,8 @@ type Mutation { "Queries with specified key" key: String): AssociateRole + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" deleteAssociateRole(version: Long!, personalDataErasure: Boolean = false, "Queries with specified ID" @@ -6038,6 +5949,7 @@ input MyQuoteRequestUpdateAction { enum MyQuoteState { Accepted Declined + Failed } input MyQuoteUpdateAction { @@ -6866,6 +6778,7 @@ input PaymentUpdateAction { transitionState: TransitionPaymentState } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" enum Permission { AcceptMyQuotes AcceptOthersQuotes @@ -8170,7 +8083,7 @@ type Query implements CartQueryInterface & CustomerActiveCartInterface & OrderQu "This field gives access to the resources (such as carts) that are inside one of the given stores." inStores(keys: [KeyReferenceInput!]!): InStore! - "This field gives access to the resources (such as carts) as an associate of a given business unit." + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" asAssociate(businessUnitKey: KeyReferenceInput!, associateId: String!): AsAssociate! customerGroup( "Queries with specified ID" @@ -8421,19 +8334,27 @@ type Query implements CartQueryInterface & CustomerActiveCartInterface & OrderQu "Queries with specified key" key: String): Quote quotes(where: String, sort: [String!], limit: Int, offset: Int): QuoteQueryResult! + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" businessUnit( "Queries with specified ID" id: String, "Queries with specified key" key: String): BusinessUnit + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" businessUnits(where: String, sort: [String!], limit: Int, offset: Int): BusinessUnitQueryResult! + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" associateRole( "Queries with specified ID" id: String, "Queries with specified key" key: String): AssociateRole + + "BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" associateRoles(where: String, sort: [String!], limit: Int, offset: Int): AssociateRoleQueryResult! productSelectionAssignments(where: String, sort: [String!], limit: Int, offset: Int): ProductAssignmentQueryResult! } @@ -8445,8 +8366,6 @@ type QueryLimitsProjection { type Quote implements Versioned { customerRef: Reference customer: Customer - customerGroupRef: Reference - customerGroup: CustomerGroup lineItems( "Queries with specified ID" id: String): [LineItem!]! @@ -8492,23 +8411,6 @@ type Quote implements Versioned { lastModifiedBy: Initiator } -type QuoteCreated implements MessagePayload { - quote: Quote! - type: String! -} - -type QuoteCustomerChanged implements MessagePayload { - customerRef: Reference! - previousCustomerRef: Reference! - customer: Customer - previousCustomer: Customer - type: String! -} - -type QuoteDeleted implements MessagePayload { - type: String! -} - input QuoteDraft { key: String stagedQuote: ResourceIdentifierInput @@ -8518,17 +8420,6 @@ input QuoteDraft { state: ReferenceInput } -"Fields to access Quotes." -interface QuoteQueryInterface { - quote( - "Queries with specified ID" - id: String, - - "Queries with specified key" - key: String): Quote - quotes(where: String, sort: [String!], limit: Int, offset: Int): QuoteQueryResult! -} - type QuoteQueryResult { offset: Int! count: Int! @@ -8539,16 +8430,9 @@ type QuoteQueryResult { results: [Quote!]! } -type QuoteRenegotiationRequested implements MessagePayload { - buyerComment: String - type: String! -} - type QuoteRequest implements Versioned { customerRef: Reference customer: Customer - customerGroupRef: Reference - customerGroup: CustomerGroup lineItems( "Queries with specified ID" id: String): [LineItem!]! @@ -8580,7 +8464,6 @@ type QuoteRequest implements Versioned { stateRef: Reference state: State purchaseOrderNumber: String - cartRef: Reference id: String! version: Long! createdAt: DateTime! @@ -8589,23 +8472,6 @@ type QuoteRequest implements Versioned { lastModifiedBy: Initiator } -type QuoteRequestCreated implements MessagePayload { - quoteRequest: QuoteRequest! - type: String! -} - -type QuoteRequestCustomerChanged implements MessagePayload { - customerRef: Reference! - previousCustomerRef: Reference! - customer: Customer - previousCustomer: Customer - type: String! -} - -type QuoteRequestDeleted implements MessagePayload { - type: String! -} - input QuoteRequestDraft { key: String cart: ResourceIdentifierInput @@ -8616,17 +8482,6 @@ input QuoteRequestDraft { purchaseOrderNumber: String } -"Fields to access QuoteRequests." -interface QuoteRequestQueryInterface { - quoteRequest( - "Queries with specified ID" - id: String, - - "Queries with specified key" - key: String): QuoteRequest - quoteRequests(where: String, sort: [String!], limit: Int, offset: Int): QuoteRequestQueryResult! -} - type QuoteRequestQueryResult { offset: Int! count: Int! @@ -8646,21 +8501,6 @@ enum QuoteRequestState { UnderReview } -type QuoteRequestStateChanged implements MessagePayload { - quoteRequestState: QuoteRequestState! - oldQuoteRequestState: QuoteRequestState! - type: String! -} - -type QuoteRequestStateTransition implements MessagePayload { - stateRef: Reference! - oldStateRef: Reference - force: Boolean! - state: State - oldState: State - type: String! -} - input QuoteRequestUpdateAction { changeCustomer: ChangeQuoteRequestCustomer changeQuoteRequestState: ChangeQuoteRequestState @@ -8673,26 +8513,12 @@ enum QuoteState { Accepted Declined DeclinedForRenegotiation + Failed Pending RenegotiationAddressed Withdrawn } -type QuoteStateChanged implements MessagePayload { - quoteState: QuoteState! - oldQuoteState: QuoteState! - type: String! -} - -type QuoteStateTransition implements MessagePayload { - stateRef: Reference! - oldStateRef: Reference - force: Boolean! - state: State - oldState: State - type: String! -} - input QuoteUpdateAction { changeCustomer: ChangeQuoteCustomer changeQuoteState: ChangeQuoteState @@ -9060,10 +8886,6 @@ input RemoveShoppingListTextLineItem { quantity: Int } -input RemoveStagedChanges { - dummy: String -} - input RemoveStagedOrderCustomLineItem { customLineItemId: String customLineItemKey: String @@ -9642,6 +9464,7 @@ input SetBusinessUnitDefaultShippingAddress { addressKey: String } +"BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta" input SetBusinessUnitStoreMode { stores: [ResourceIdentifierInput!] storeMode: String @@ -12477,10 +12300,6 @@ interface StagedOrderUpdateActionOutput { type: String! } -input StagedPriceDraft { - value: BaseMoneyInput! -} - type StagedQuote implements Versioned { key: String stagedQuoteState: StagedQuoteState! @@ -12506,15 +12325,6 @@ type StagedQuote implements Versioned { lastModifiedBy: Initiator } -type StagedQuoteCreated implements MessagePayload { - stagedQuote: StagedQuote! - type: String! -} - -type StagedQuoteDeleted implements MessagePayload { - type: String! -} - input StagedQuoteDraft { key: String quoteRequest: ResourceIdentifierInput @@ -12534,32 +12344,12 @@ type StagedQuoteQueryResult { results: [StagedQuote!]! } -type StagedQuoteSellerCommentSet implements MessagePayload { - sellerComment: String - type: String! -} - enum StagedQuoteState { Closed InProgress Sent } -type StagedQuoteStateChanged implements MessagePayload { - stagedQuoteState: StagedQuoteState! - oldStagedQuoteState: StagedQuoteState! - type: String! -} - -type StagedQuoteStateTransition implements MessagePayload { - stateRef: Reference! - oldStateRef: Reference - force: Boolean! - state: State - oldState: State - type: String! -} - input StagedQuoteUpdateAction { changeStagedQuoteState: ChangeStagedQuoteState setSellerComment: SetStagedQuoteSellerComment @@ -12569,11 +12359,6 @@ input StagedQuoteUpdateAction { transitionState: TransitionStagedQuoteState } -type StagedQuoteValidToSet implements MessagePayload { - validTo: DateTime - type: String! -} - type StagedStandalonePrice { value: BaseMoney! discounted: DiscountedProductPriceValue @@ -12654,11 +12439,6 @@ type StandalonePriceStagedChangesApplied implements MessagePayload { type: String! } -type StandalonePriceStagedChangesRemoved implements MessagePayload { - stagedChanges: StagedStandalonePrice - type: String! -} - type StandalonePriceTierAdded implements MessagePayload { tier: ProductPriceTier! type: String! @@ -12688,7 +12468,6 @@ input StandalonePriceUpdateAction { setValidUntil: SetStandalonePriceValidUntil addPriceTier: AddStandalonePriceTier removePriceTier: RemoveStandalonePriceTier - removeStagedChanges: RemoveStagedChanges setPriceTiers: SetStandalonePriceTiers } diff --git a/api-specs/history/api.raml b/api-specs/history/api.raml index ef2eeab33..bebadbb48 100644 --- a/api-specs/history/api.raml +++ b/api-specs/history/api.raml @@ -206,28 +206,16 @@ resourceTypes: [ID](/general-concepts#identifier) of the Merchant Center user who made the change. Can be used to query changes made by a Merchant Center user. - clientId?: - type: string - description: | - [ID](/general-concepts#identifier) of the [API Client](ctp:api:type:ApiClient) that made the change. - customerId?: - type: string - description: | - [ID](/general-concepts#identifier) of the [Customer](ctp:api:type:Customer) who made the change using a token from the [password flow](/authorization#password-flow). - associateId?: - type: string - description: | - [ID](/general-concepts#identifier) of the [Associate](ctp:api:type:Associate) that made the change. Only [Changes](ctp:history:type:Change) to [Business Units](ctp:api:type:BusinessUnit), [Orders](ctp:api:type:Order), [Quote Requests](ctp:api:type:QuoteRequest), and [Quotes](ctp:api:type:Quote) can be filtered. - businessUnit?: - type: string - description: | - `key` of the [Business Unit](ctp:api:type:BusinessUnit) linked to the change. Only [Changes](ctp:history:type:Change) to [Orders](ctp:api:type:Order), [Quote Requests](ctp:api:type:QuoteRequest), and [Quotes](ctp:api:type:Quote) can be filtered. type?: type: string description: | Can be `"ResourceCreated"`, `"ResourceUpdated"`, or `"ResourceDeleted"`. Can be used to filter for a specific type of change (creation, update, or deletion). + clientId?: + type: string + description: | + [ID](/general-concepts#identifier) of the [API Client](ctp:api:type:ApiClient) that made the change. resourceId?: type: string description: | @@ -249,6 +237,10 @@ resourceTypes: type: string[] description: | `key` of the [Store](ctp:api:type:Store) linked to the Change. + customerId?: + type: string + description: | + [ID](/general-concepts#identifier) of the [Customer](ctp:api:type:Customer) who made the change using a token from the [password flow](/authorization#password-flow). excludePlatformInitiatedChanges?: description: | Excludes [Changes](ctp:history:type:Change) initiated by background processes by passing the values of the `change` field. @@ -360,27 +352,15 @@ resourceTypes: description: | [ID](/general-concepts#identifier) of the Merchant Center user who made the change. Can be used to query changes made by a Merchant Center user. - clientId?: - type: string - description: | - [ID](/general-concepts#identifier) of the [API Client](/projects/api-clients#apiclient) that made the change. - customerId?: - type: string - description: | - [ID](/general-concepts#identifier) of the [Customer](/projects/customers#customer) who made the change using a token from the [Password Flow](/authorization#password-flow). - associateId?: - type: string - description: | - [ID](/general-concepts#identifier) of the [Associate](ctp:api:type:Associate) that made the change. Only [Changes](ctp:history:type:Change) to [Business Units](ctp:api:type:BusinessUnit), [Orders](ctp:api:type:Order), [Quote Requests](ctp:api:type:QuoteRequest), and [Quotes](ctp:api:type:Quote) can be filtered. - businessUnit?: - type: string - description: | - `key` of the [Business Unit](ctp:api:type:BusinessUnit) linked to the change. Only [Changes](ctp:history:type:Change) to [Orders](ctp:api:type:Order), [Quote Requests](ctp:api:type:QuoteRequest), and [Quotes](ctp:api:type:Quote) can be filtered. type?: type: string description: | Can be `"ResourceCreated"`, `"ResourceUpdated"`, or `"ResourceDeleted"`. Can be used to filter for a specific type of change. + clientId?: + type: string + description: | + [ID](/general-concepts#identifier) of the [API Client](/projects/api-clients#apiclient) that made the change. resourceKey?: type: string description: | @@ -398,6 +378,10 @@ resourceTypes: type: string[] description: | `key` of the [Store](/api/projects/stores#store) linked to the Change. + customerId?: + type: string + description: | + [ID](/general-concepts#identifier) of the [Customer](/projects/customers#customer) who made the change using a token from the [Password Flow](/authorization#password-flow). excludePlatformInitiatedChanges?: description: | Exclude [Changes](/history/change-types#change) initiated by background processes by passing the values of the `change` field. @@ -476,27 +460,15 @@ resourceTypes: description: | [ID](/general-concepts#identifier) of the Merchant Center user who made the change. Can be used to query changes made by a Merchant Center user. - clientId?: - type: string - description: | - [ID](/general-concepts#identifier) of the [API Client](/projects/api-clients#apiclient) that made the change. - customerId?: - type: string - description: | - [ID](/general-concepts#identifier) of the [Customer](/projects/customers#customer) who made the change using a token from the [Password Flow](/authorization#password-flow). - associateId?: - type: string - description: | - [ID](/general-concepts#identifier) of the [Associate](ctp:api:type:Associate) that made the change. Only [Changes](ctp:history:type:Change) to [Business Units](ctp:api:type:BusinessUnit), [Orders](ctp:api:type:Order), [Quote Requests](ctp:api:type:QuoteRequest), and [Quotes](ctp:api:type:Quote) can be filtered. - businessUnit?: - type: string - description: | - `key` of the [Business Unit](ctp:api:type:BusinessUnit) linked to the change. Only [Changes](ctp:history:type:Change) to [Orders](ctp:api:type:Order), [Quote Requests](ctp:api:type:QuoteRequest), and [Quotes](ctp:api:type:Quote) can be filtered. type?: type: string description: | Can be `"ResourceCreated"`, `"ResourceUpdated"`, or `"ResourceDeleted"`. Can be used to filter for a specific type of change. + clientId?: + type: string + description: | + [ID](/general-concepts#identifier) of the [API Client](/projects/api-clients#apiclient) that made the change. source?: type: string description: | @@ -510,6 +482,10 @@ resourceTypes: type: string[] description: | `key` of the [Store](/api/projects/stores#store) linked to the Change. + customerId?: + type: string + description: | + [ID](/general-concepts#identifier) of the [Customer](/projects/customers#customer) who made the change using a token from the [Password Flow](/authorization#password-flow). excludePlatformInitiatedChanges?: description: | Exclude [Changes](/history/change-types#change) initiated by background processes by passing the values of the `change` field. diff --git a/api-specs/history/examples/ModifiedBy.json b/api-specs/history/examples/ModifiedBy.json index d260b5f56..25f6e9aec 100644 --- a/api-specs/history/examples/ModifiedBy.json +++ b/api-specs/history/examples/ModifiedBy.json @@ -5,5 +5,7 @@ "customer": { "id": "test1", "typeId": "customer" - } + }, + "anonymousId": "", + "clientId": "" } diff --git a/api-specs/history/examples/Record.json b/api-specs/history/examples/Record.json index 0682a532b..06f967777 100644 --- a/api-specs/history/examples/Record.json +++ b/api-specs/history/examples/Record.json @@ -10,7 +10,9 @@ "customer": { "id": "test1", "typeId": "customer" - } + }, + "anonymousId": "", + "clientId": "" }, "resource": { "id": "some_entity_id_123", @@ -27,10 +29,6 @@ }, "withoutChanges": false, "stores": [], - "businessUnit": { - "typeId": "business-unit", - "key": "some_business_unit_key_123" - }, "changes": [ { "change": "setKey", diff --git a/api-specs/history/examples/RecordPagedQueryResponse.json b/api-specs/history/examples/RecordPagedQueryResponse.json index 32863435a..38dd3a46a 100644 --- a/api-specs/history/examples/RecordPagedQueryResponse.json +++ b/api-specs/history/examples/RecordPagedQueryResponse.json @@ -16,7 +16,9 @@ "customer": { "id": "test1", "typeId": "customer" - } + }, + "anonymousId": "", + "clientId": "" }, "resource": { "id": "some_entity_id_123", @@ -32,11 +34,7 @@ "type": "StringLabel" }, "withoutChanges": false, - "stores": [{ "key": "store-1", "typeId": "store" }], - "businessUnit": { - "typeId": "business-unit", - "key": "some_business_unit_key_123" - }, + "stores":[{ "key": "store-1", "typeId": "store" }], "changes": [ { "change": "setKey", diff --git a/api-specs/history/types/ModifiedBy.raml b/api-specs/history/types/ModifiedBy.raml index c4b00779f..b4e44f700 100644 --- a/api-specs/history/types/ModifiedBy.raml +++ b/api-specs/history/types/ModifiedBy.raml @@ -19,27 +19,22 @@ properties: - If the change was made by a user, the value is `"user"`. - If the change was made by an API Client with or without an [external user ID](/client-logging#external-user-ids), the value is `"external-user"`. - - If the change was made by an [Associate](ctp:api:type:Associate), the value is `"associate"`. - clientId?: - type: string + customer?: + type: Reference description: | - [ID](/general-concepts#identifier) of the [API Client](ctp:api:type:ApiClient) that made the change. + [Reference](ctp:api:type:Reference) to the [Customer](ctp:api:type:Customer) who made the change. - Present only if the change was made using an API Client. + Present only if the change was made using a token from the [password flow](/authorization#password-flow). anonymousId?: type: string description: | Present only if the change was made using a token from an [anonymous session](/authorization#tokens-for-anonymous-sessions). - customer?: - type: Reference + clientId?: + type: string description: | - The [Customer](ctp:api:type:Customer) who made the change. + [ID](/general-concepts#identifier) of the [API Client](ctp:api:type:ApiClient) that made the change. - Present only if the change was made using a token from the [password flow](/authorization#password-flow). - associate?: - type: Reference - description: | - The [Associate](ctp:api:type:Associate) who made the change in the context of a [Business Unit](ctp:api:type:BusinessUnit). Present only if the Associate acts on behalf of a company using the [associate endpoints](/associates-overview#on-the-associate-endpoints). + Present only if the change was made using an API Client. isPlatformClient: type: boolean description: | diff --git a/api-specs/history/types/Record.raml b/api-specs/history/types/Record.raml index 6ad402fdf..e65198cc9 100644 --- a/api-specs/history/types/Record.raml +++ b/api-specs/history/types/Record.raml @@ -50,10 +50,6 @@ properties: type: KeyReference[] description: | References to the [Stores](ctp:api:type:Store) associated with the [Change](ctp:history:type:Change). - businessUnit?: - type: KeyReference - description: | - Reference to the [Business Unit](ctp:api:type:BusinessUnit) associated with the [Change](ctp:history:type:Change). withoutChanges: description: | `true` if no change was detected. diff --git a/api-specs/history/types/change/AddAddressChange.raml b/api-specs/history/types/change/AddAddressChange.raml index 92c3e4a6c..bff945eda 100644 --- a/api-specs/history/types/change/AddAddressChange.raml +++ b/api-specs/history/types/change/AddAddressChange.raml @@ -13,9 +13,6 @@ properties: type: string enum: - AddAddressChange - previousValue: - type: Address - description: Value before the change. nextValue: type: Address description: Value after the change. diff --git a/api-specs/history/types/change/AddChannelRolesChange.raml b/api-specs/history/types/change/AddChannelRolesChange.raml index 58638df7c..0a8ea4b9e 100644 --- a/api-specs/history/types/change/AddChannelRolesChange.raml +++ b/api-specs/history/types/change/AddChannelRolesChange.raml @@ -16,10 +16,10 @@ properties: previousValue: type: array items: - type: ChannelRole + type: ChannelRoleEnum description: Value before the change. nextValue: type: array items: - type: ChannelRole + type: ChannelRoleEnum description: Value after the change. diff --git a/api-specs/history/types/change/AddLocalizedEnumValueChange.raml b/api-specs/history/types/change/AddLocalizedEnumValueChange.raml index 0033d9bec..37c0a887c 100644 --- a/api-specs/history/types/change/AddLocalizedEnumValueChange.raml +++ b/api-specs/history/types/change/AddLocalizedEnumValueChange.raml @@ -18,7 +18,7 @@ properties: enum: - addLocalizedEnumValue nextValue: - type: LocalizedEnumValue + type: AttributeLocalizedEnumValue description: Value after the change. fieldName: type: string diff --git a/api-specs/history/types/change/AddLocationChange.raml b/api-specs/history/types/change/AddLocationChange.raml index caa0a51e6..296e1d3bc 100644 --- a/api-specs/history/types/change/AddLocationChange.raml +++ b/api-specs/history/types/change/AddLocationChange.raml @@ -13,9 +13,6 @@ properties: type: string enum: - addLocation - previousValue: - type: Location - description: Value before the change. nextValue: type: Location description: Value after the change. diff --git a/api-specs/history/types/change/AddPlainEnumValueChange.raml b/api-specs/history/types/change/AddPlainEnumValueChange.raml index 42574eeb0..109a595f6 100644 --- a/api-specs/history/types/change/AddPlainEnumValueChange.raml +++ b/api-specs/history/types/change/AddPlainEnumValueChange.raml @@ -14,7 +14,7 @@ properties: enum: - addPlainEnumValue nextValue: - type: EnumValue + type: AttributePlainEnumValue description: Value after the change. attributeName: type: string diff --git a/api-specs/history/types/change/AddStateRolesChange.raml b/api-specs/history/types/change/AddStateRolesChange.raml index 0f60c118f..296d68e12 100644 --- a/api-specs/history/types/change/AddStateRolesChange.raml +++ b/api-specs/history/types/change/AddStateRolesChange.raml @@ -16,10 +16,10 @@ properties: previousValue: type: array items: - type: StateRole + type: StateRoleEnum description: Value before the change. nextValue: type: array items: - type: StateRole + type: StateRoleEnum description: Value after the change. diff --git a/api-specs/history/types/change/ChangeDescriptionChange.raml b/api-specs/history/types/change/ChangeDescriptionChange.raml index 77ed4a2c2..4cccf7e52 100644 --- a/api-specs/history/types/change/ChangeDescriptionChange.raml +++ b/api-specs/history/types/change/ChangeDescriptionChange.raml @@ -4,10 +4,8 @@ type: Change displayName: ChangeDescriptionChange discriminatorValue: ChangeDescriptionChange description: | - Change triggered by the following update actions: + Change triggered by the [Change Description](ctp:api:type:ProductTypeChangeDescriptionAction) update action. - - [Change Description](ctp:api:type:ChannelChangeDescriptionAction) on Channels. - - [Change Description](ctp:api:type:ProductTypeChangeDescriptionAction) on Product Types. properties: type: type: string diff --git a/api-specs/history/types/change/ChangeLocalizedDescriptionChange.raml b/api-specs/history/types/change/ChangeLocalizedDescriptionChange.raml index 982802862..839a60661 100644 --- a/api-specs/history/types/change/ChangeLocalizedDescriptionChange.raml +++ b/api-specs/history/types/change/ChangeLocalizedDescriptionChange.raml @@ -4,10 +4,8 @@ type: Change displayName: ChangeLocalizedDescriptionChange discriminatorValue: ChangeLocalizedDescriptionChange description: | - Change triggered by the following update actions: + Change triggered by the [Change Description](ctp:api:type:ChannelChangeDescriptionAction) update action. - - [Change Description](ctp:api:type:ProductTypeChangeDescriptionAction) on Product Types. - - [Change Description](ctp:api:type:ChannelChangeDescriptionAction) on Channels. properties: type: type: string diff --git a/api-specs/history/types/change/ChangeLocalizedNameChange.raml b/api-specs/history/types/change/ChangeLocalizedNameChange.raml index bdbc437da..71451f4f6 100644 --- a/api-specs/history/types/change/ChangeLocalizedNameChange.raml +++ b/api-specs/history/types/change/ChangeLocalizedNameChange.raml @@ -9,14 +9,10 @@ description: | - [Change Name](ctp:api:type:CartDiscountChangeNameAction) on Cart Discounts. - [Change Name](ctp:api:type:CategoryChangeNameAction) on Categories. - [Change Name](ctp:api:type:ChannelChangeNameAction) on Channels. - - [Change Name](ctp:api:type:CustomerGroupChangeNameAction) on Customer Groups. - [Change Name](ctp:api:type:ProductChangeNameAction) on Products. - [Change Name](ctp:api:type:ProductDiscountChangeNameAction) on Product Discounts. - [Change Name](ctp:api:type:ProductSelectionChangeNameAction) on Product Selections. - - [Change Name](ctp:api:type:ProductTypeChangeNameAction) on Product Types. - [Change Name](ctp:api:type:ShoppingListChangeNameAction) on Shopping Lists. - - [Change Name](ctp:api:type:TaxCategoryChangeNameAction) on Tax Categories. - - [Change Name](ctp:api:type:TypeChangeNameAction) on Types. - [Change Name](ctp:api:type:ZoneChangeNameAction) on Zones. properties: type: diff --git a/api-specs/history/types/change/ChangeNameChange.raml b/api-specs/history/types/change/ChangeNameChange.raml index e3fd9ac19..769b0ee2c 100644 --- a/api-specs/history/types/change/ChangeNameChange.raml +++ b/api-specs/history/types/change/ChangeNameChange.raml @@ -6,17 +6,9 @@ discriminatorValue: ChangeNameChange description: | Change triggered by the following update actions: - - [Change Name](ctp:api:type:CartDiscountChangeNameAction) on Cart Discounts. - - [Change Name](ctp:api:type:CategoryChangeNameAction) on Categories. - - [Change Name](ctp:api:type:ChannelChangeNameAction) on Channels. - [Change Name](ctp:api:type:CustomerGroupChangeNameAction) on Customer Groups. - - [Change Name](ctp:api:type:ProductChangeNameAction) on Products. - - [Change Name](ctp:api:type:ProductDiscountChangeNameAction) on Product Discounts. - - [Change Name](ctp:api:type:ProductSelectionChangeNameAction) on Product Selections. - [Change Name](ctp:api:type:ProductTypeChangeNameAction) on Product Types. - - [Change Name](ctp:api:type:ShoppingListChangeNameAction) on Shopping Lists. - [Change Name](ctp:api:type:TaxCategoryChangeNameAction) on Tax Categories. - - [Change Name](ctp:api:type:TypeChangeNameAction) on Types. - [Change Name](ctp:api:type:ZoneChangeNameAction) on Zones. properties: type: diff --git a/api-specs/history/types/change/ChangeStateTypeChange.raml b/api-specs/history/types/change/ChangeStateTypeChange.raml index 904b911ee..ab5080f0d 100644 --- a/api-specs/history/types/change/ChangeStateTypeChange.raml +++ b/api-specs/history/types/change/ChangeStateTypeChange.raml @@ -14,8 +14,8 @@ properties: enum: - changeType previousValue: - type: StateType + type: StateTypeEnum description: Value before the change. nextValue: - type: StateType + type: StateTypeEnum description: Value after the change. diff --git a/api-specs/history/types/change/RemoveChannelRolesChange.raml b/api-specs/history/types/change/RemoveChannelRolesChange.raml index a1c3153f2..57ce942f1 100644 --- a/api-specs/history/types/change/RemoveChannelRolesChange.raml +++ b/api-specs/history/types/change/RemoveChannelRolesChange.raml @@ -16,10 +16,10 @@ properties: previousValue: type: array items: - type: ChannelRole + type: ChannelRoleEnum description: Value before the change. nextValue: type: array items: - type: ChannelRole + type: ChannelRoleEnum description: Value after the change. diff --git a/api-specs/history/types/change/RemoveLocationChange.raml b/api-specs/history/types/change/RemoveLocationChange.raml index bb8b8182f..5e5ae74c9 100644 --- a/api-specs/history/types/change/RemoveLocationChange.raml +++ b/api-specs/history/types/change/RemoveLocationChange.raml @@ -16,6 +16,3 @@ properties: previousValue: type: Location description: Value before the change. - nextValue: - type: Location - description: Value after the change. diff --git a/api-specs/history/types/change/RemoveStateRolesChange.raml b/api-specs/history/types/change/RemoveStateRolesChange.raml index cee4834f6..1f2eb4920 100644 --- a/api-specs/history/types/change/RemoveStateRolesChange.raml +++ b/api-specs/history/types/change/RemoveStateRolesChange.raml @@ -16,10 +16,10 @@ properties: previousValue: type: array items: - type: StateRole + type: StateRoleEnum description: Value before the change. nextValue: type: array items: - type: StateRole + type: StateRoleEnum description: Value after the change. diff --git a/api-specs/history/types/change/RemoveTaxRateChange.raml b/api-specs/history/types/change/RemoveTaxRateChange.raml index b01103d6b..5cb759695 100644 --- a/api-specs/history/types/change/RemoveTaxRateChange.raml +++ b/api-specs/history/types/change/RemoveTaxRateChange.raml @@ -16,6 +16,3 @@ properties: previousValue: type: TaxRate description: Value before the change. - nextValue: - type: TaxRate - description: Value after the change. diff --git a/api-specs/history/types/change/SetChannelRolesChange.raml b/api-specs/history/types/change/SetChannelRolesChange.raml index 153aacb05..d84e2fc51 100644 --- a/api-specs/history/types/change/SetChannelRolesChange.raml +++ b/api-specs/history/types/change/SetChannelRolesChange.raml @@ -16,10 +16,10 @@ properties: previousValue: type: array items: - type: ChannelRole + type: ChannelRoleEnum description: Value before the change. nextValue: type: array items: - type: ChannelRole + type: ChannelRoleEnum description: Value after the change. diff --git a/api-specs/history/types/change/SetDescriptionChange.raml b/api-specs/history/types/change/SetDescriptionChange.raml index d6098976b..5a7420102 100644 --- a/api-specs/history/types/change/SetDescriptionChange.raml +++ b/api-specs/history/types/change/SetDescriptionChange.raml @@ -6,13 +6,6 @@ discriminatorValue: SetDescriptionChange description: | Change triggered by the following update actions: - - [Set Description](ctp:api:type:CartDiscountSetDescriptionAction) on Cart Discounts. - - [Set Description](ctp:api:type:CategorySetDescriptionAction) on Categories. - - [Set Description](ctp:api:type:DiscountCodeSetDescriptionAction) on Discount Codes. - - [Set Description](ctp:api:type:ProductSetDescriptionAction) on Products. - - [Set Description](ctp:api:type:ProductDiscountSetDescriptionAction) on Product Discounts. - - [Set Description](ctp:api:type:ShoppingListSetDescriptionAction) on Shopping Lists. - - [Set Description](ctp:api:type:StateSetDescriptionAction) on States. - [Set Description](ctp:api:type:TaxCategorySetDescriptionAction) on Tax Categories. - [Set Description](ctp:api:type:TypeSetDescriptionAction) on Types. - [Set Description](ctp:api:type:ZoneSetDescriptionAction) on Zones. diff --git a/api-specs/history/types/change/SetLocalizedDescriptionChange.raml b/api-specs/history/types/change/SetLocalizedDescriptionChange.raml index 24cc5414c..7f67cb146 100644 --- a/api-specs/history/types/change/SetLocalizedDescriptionChange.raml +++ b/api-specs/history/types/change/SetLocalizedDescriptionChange.raml @@ -13,9 +13,7 @@ description: | - [Set Description](ctp:api:type:ProductDiscountSetDescriptionAction) on Product Discounts. - [Set Description](ctp:api:type:ShoppingListSetDescriptionAction) on Shopping Lists. - [Set Description](ctp:api:type:StateSetDescriptionAction) on States. - - [Set Description](ctp:api:type:TaxCategorySetDescriptionAction) on Tax Categories. - [Set Description](ctp:api:type:TypeSetDescriptionAction) on Types. - - [Set Description](ctp:api:type:ZoneSetDescriptionAction) on Zones. properties: type: type: string diff --git a/api-specs/history/types/change/SetStateRolesChange.raml b/api-specs/history/types/change/SetStateRolesChange.raml index ab3c821b2..71f294e22 100644 --- a/api-specs/history/types/change/SetStateRolesChange.raml +++ b/api-specs/history/types/change/SetStateRolesChange.raml @@ -16,10 +16,10 @@ properties: previousValue: type: array items: - type: StateRole + type: StateRoleEnum description: Value before the change. nextValue: type: array items: - type: StateRole + type: StateRoleEnum description: Value after the change. diff --git a/api-specs/history/types/common/ChannelRoleEnum.raml b/api-specs/history/types/common/ChannelRoleEnum.raml new file mode 100644 index 000000000..1d5cda927 --- /dev/null +++ b/api-specs/history/types/common/ChannelRoleEnum.raml @@ -0,0 +1,24 @@ +#%RAML 1.0 DataType +(package): Common +displayName: ChannelRoleEnum +type: string +description: | + Describes the purpose and type of the Channel. A Channel can have one or more roles. +enum: + - InventorySupply + - ProductDistribution + - OrderExport + - OrderImport + - Primary +(enumDescriptions): + InventorySupply: | + Channel can be used to track inventory entries (for example, Channels with this role can be treated as warehouses). + ProductDistribution: | + Channel can be used to expose Products to a specific distribution Channel. + The Channel can be used by a Cart to [select](ctp:api:type:LineItemPriceSelection) a Product Price. + OrderExport: | + Channel can be used to track order export activities. + OrderImport: | + Channel can be used to track order import activities. + Primary: | + This role can be combined with the other roles (for example, with `InventorySupply`). If used, the Channel is considered as the primary or main channel among Channels of the same type. diff --git a/api-specs/history/types/common/StateRole.raml b/api-specs/history/types/common/StateRole.raml deleted file mode 100644 index f09b3a685..000000000 --- a/api-specs/history/types/common/StateRole.raml +++ /dev/null @@ -1,8 +0,0 @@ -#%RAML 1.0 DataType -(package): Common -type: string -displayName: StateRole -description: -enum: - - ReviewIncludedInStatistics - - Return diff --git a/api-specs/history/types/types.raml b/api-specs/history/types/types.raml index 6e0e494a5..48d7ca584 100644 --- a/api-specs/history/types/types.raml +++ b/api-specs/history/types/types.raml @@ -59,6 +59,8 @@ AssociateRoleInheritanceMode: !include common/AssociateRoleInheritanceMode.raml AssociateRoleLabel: !include label/AssociateRoleLabel.raml AttributeConstraintEnum: !include common/AttributeConstraintEnum.raml AttributeDefinition: !include common/AttributeDefinition.raml +AttributeLocalizedEnumValue: !include ../../api/types/product-type/AttributeLocalizedEnumValue.raml +AttributePlainEnumValue: !include ../../api/types/product-type/AttributePlainEnumValue.raml AttributeType: !include common/AttributeType.raml AttributeValue: !include change/change-value/AttributeValue.raml AuthenticationMode: !include common/AuthenticationMode.raml @@ -144,7 +146,7 @@ ChangeValueChange: !include change/ChangeValueChange.raml ChangeValueExternalChangeValue: !include change/change-value/ChangeValueExternalChangeValue.raml ChangeValueGiftLineItemChangeValue: !include change/change-value/ChangeValueGiftLineItemChangeValue.raml ChangeValueRelativeChangeValue: !include change/change-value/ChangeValueRelativeChangeValue.raml -ChannelRole: !include common/ChannelRole.raml +ChannelRoleEnum: !include ../../api/types/channel/ChannelRoleEnum.raml CountryCode: !include common/CountryCode.raml CurrencyCode: !include common/CurrencyCode.raml CustomFieldExpandedValue: !include change/change-value/CustomFieldExpandedValue.raml @@ -408,8 +410,8 @@ ShoppingListLineItemValue: !include change/change-value/ShoppingListLineItemValu StackingMode: !include common/StackingMode.raml StagedQuoteLabel: !include label/StagedQuoteLabel.raml StagedQuoteState: !include common/StagedQuoteState.raml -StateRole: !include common/StateRole.raml -StateType: !include common/StateType.raml +StateRoleEnum: !include ../../api/types/state/StateRoleEnum.raml +StateTypeEnum: !include ../../api/types/state/StateTypeEnum.raml StoreCountry: !include common/StoreCountry.raml StringLabel: !include label/StringLabel.raml SubRate: !include common/SubRate.raml diff --git a/api-specs/importapi/types/common.raml b/api-specs/importapi/types/common.raml index 8c6e0fb82..bb226de63 100644 --- a/api-specs/importapi/types/common.raml +++ b/api-specs/importapi/types/common.raml @@ -341,15 +341,16 @@ types: - key-value-document ProcessingState: description: | - Every [Import Operation](/import-operation) is assigned one of the following states. + Every [Import Operation](/import-operation) is assigned with one of the following states. (annotations.enumDescriptions): - processing: The initial state assigned if the request payload (JSON structure and fields) meets Import API specifications. The resource import is in progress. - imported: The resource was successfully imported. - unresolved: The import request contains [KeyReferences](ctp:import:type:KeyReference) to resources that do not exist in your Composable Commerce Project. - validationFailed: Either the request payload is missing the data as per Import API specifications, or even though the references were resolved, the data does not meet validation constraints. - waitForMasterVariant: Products must have at least one Product Variant, also known as the Master Variant. If you import a Product without a Master Variant, the import request will have this status until another import request includes Master Variant data for the Product. - rejected: The resource could not be imported. References were resolved, but the system could not import the data due to an internal server error and the retry limit was reached. - canceled: The import request was canceled and the resource was not imported. + processing: Initial state assigned if the format (JSON structure and fields) meets the Import API's specification. The resource import is in progress. + imported: Resource was successfully imported. + unresolved: Import Request contains key references to resources that are currently not present in commercetools Composable Commerce. + validationFailed: Either the request payload is missing the data as per the Import API's specification or even though the references were resolved, the data does not meet the validation constraints. + waitForMasterVariant: + Waiting for a master variant to arrive. The Product Import has required + attributes and thus a master variant that provides those is required. + rejected: Resource could not be imported. References were resolved, but the system could not import the data due to an internal server error and the limit of retry has been reached. type: string enum: - processing @@ -358,7 +359,6 @@ types: - waitForMasterVariant - imported - rejected - - canceled Address: properties: id?: string diff --git a/api-specs/importapi/types/custom-field.raml b/api-specs/importapi/types/custom-field.raml index 75d5af5bd..1872008eb 100644 --- a/api-specs/importapi/types/custom-field.raml +++ b/api-specs/importapi/types/custom-field.raml @@ -10,25 +10,25 @@ types: Custom: description: The representation to be sent to the server when creating a resource with - Custom Fields. + custom fields. properties: type: description: The type that provides the field definitions for this object. type: common.TypeKeyReference fields?: - description: The Custom Fields of this object. + description: The custom fields of this object. type: FieldContainer FieldContainer: - description: Maps the Custom Field names to actual values. + description: Maps the custom field names to the actual values. type: object (annotations.asMap): keyTypeHint: string properties: //: - description: Mapping from the Custom Field name to the actual value. + description: Mapping from the custom field name to the actual value. type: CustomField CustomField: - description: Provides the value for a Custom Field of a specific type. + description: Provides the value for a custom field of a specific type. type: object discriminator: type properties: diff --git a/api-specs/importapi/types/import-summary.raml b/api-specs/importapi/types/import-summary.raml index 2a8b91795..6da7c42ab 100644 --- a/api-specs/importapi/types/import-summary.raml +++ b/api-specs/importapi/types/import-summary.raml @@ -48,7 +48,3 @@ types: description: The number of resources in the `rejected` state. type: integer format: int64 - canceled: - description: The number of resources in the `canceled` state. - type: integer - format: int64