From 6041dca409bc6d87fe040dc557901ce096930880 Mon Sep 17 00:00:00 2001 From: Auto Mation Date: Thu, 23 Nov 2023 11:46:53 +0000 Subject: [PATCH] Updated API from documentation release --- api-specs/api/traits/data-erasure.raml | 2 +- api-specs/api/types/approval-flow/ApprovalFlow.raml | 4 ++-- api-specs/api/types/approval-rule/ApprovalRule.raml | 4 ++-- api-specs/api/types/associate-role/AssociateRole.raml | 4 ++-- api-specs/api/types/attribute-group/AttributeGroup.raml | 4 ++-- api-specs/api/types/business-unit/BusinessUnit.raml | 4 ++-- api-specs/api/types/cart-discount/CartDiscount.raml | 4 ++-- api-specs/api/types/cart/Cart.raml | 4 ++-- api-specs/api/types/category/Category.raml | 4 ++-- api-specs/api/types/channel/Channel.raml | 4 ++-- api-specs/api/types/common/ClientLogging.raml | 4 ++-- api-specs/api/types/common/CreatedBy.raml | 4 ++-- api-specs/api/types/common/LastModifiedBy.raml | 4 ++-- api-specs/api/types/custom-object/CustomObject.raml | 4 ++-- api-specs/api/types/customer-group/CustomerGroup.raml | 4 ++-- api-specs/api/types/customer/Customer.raml | 4 ++-- api-specs/api/types/discount-code/DiscountCode.raml | 4 ++-- api-specs/api/types/extension/Extension.raml | 4 ++-- api-specs/api/types/inventory/InventoryEntry.raml | 4 ++-- api-specs/api/types/message/Message.raml | 2 +- api-specs/api/types/order-edit/OrderEdit.raml | 4 ++-- api-specs/api/types/order/Order.raml | 4 ++-- api-specs/api/types/payment/Payment.raml | 4 ++-- api-specs/api/types/product-discount/ProductDiscount.raml | 4 ++-- api-specs/api/types/product-selection/ProductSelection.raml | 4 ++-- api-specs/api/types/product-type/ProductType.raml | 4 ++-- api-specs/api/types/product/Product.raml | 4 ++-- .../api/types/project/SearchIndexingConfigurationValues.raml | 2 +- api-specs/api/types/quote-request/QuoteRequest.raml | 4 ++-- api-specs/api/types/quote/Quote.raml | 4 ++-- api-specs/api/types/review/Review.raml | 4 ++-- api-specs/api/types/shipping-method/ShippingMethod.raml | 4 ++-- api-specs/api/types/shopping-list/ShoppingList.raml | 4 ++-- api-specs/api/types/staged-quote/StagedQuote.raml | 4 ++-- api-specs/api/types/standalone-price/StandalonePrice.raml | 4 ++-- api-specs/api/types/state/State.raml | 4 ++-- api-specs/api/types/store/Store.raml | 4 ++-- .../types/subscription/ResourceDeletedDeliveryPayload.raml | 2 +- api-specs/api/types/subscription/Subscription.raml | 4 ++-- api-specs/api/types/tax-category/TaxCategory.raml | 4 ++-- api-specs/api/types/type/Type.raml | 4 ++-- api-specs/api/types/zone/Zone.raml | 4 ++-- api-specs/history/types/ModifiedBy.raml | 2 +- 43 files changed, 81 insertions(+), 81 deletions(-) diff --git a/api-specs/api/traits/data-erasure.raml b/api-specs/api/traits/data-erasure.raml index 3b8bc1586..d4d4058d5 100644 --- a/api-specs/api/traits/data-erasure.raml +++ b/api-specs/api/traits/data-erasure.raml @@ -6,4 +6,4 @@ queryParameters: required: false description: | Defaults to `false`. - Set to `true` if you want to [erase all related personal data](/../api/general-concepts#data-erasure-of-personal-data) in compliance with GDPR. + Set to `true` if you want to [erase all related personal data](/../api/gdpr#data-erasure-of-personal-data) in compliance with GDPR. diff --git a/api-specs/api/types/approval-flow/ApprovalFlow.raml b/api-specs/api/types/approval-flow/ApprovalFlow.raml index 3852015ac..54eae3801 100644 --- a/api-specs/api/types/approval-flow/ApprovalFlow.raml +++ b/api-specs/api/types/approval-flow/ApprovalFlow.raml @@ -23,7 +23,7 @@ properties: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/general-concepts#events-tracked). lastModifiedAt: type: datetime description: | @@ -32,7 +32,7 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/general-concepts#events-tracked). order: type: OrderReference description: | diff --git a/api-specs/api/types/approval-rule/ApprovalRule.raml b/api-specs/api/types/approval-rule/ApprovalRule.raml index 1a8ae2a3e..c5bc46068 100644 --- a/api-specs/api/types/approval-rule/ApprovalRule.raml +++ b/api-specs/api/types/approval-rule/ApprovalRule.raml @@ -23,7 +23,7 @@ properties: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/general-concepts#events-tracked). lastModifiedAt: type: datetime description: | @@ -32,7 +32,7 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/general-concepts#events-tracked). key?: type: string description: | diff --git a/api-specs/api/types/associate-role/AssociateRole.raml b/api-specs/api/types/associate-role/AssociateRole.raml index 640ce9bdf..da158c970 100644 --- a/api-specs/api/types/associate-role/AssociateRole.raml +++ b/api-specs/api/types/associate-role/AssociateRole.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources updated after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key: type: string description: | diff --git a/api-specs/api/types/attribute-group/AttributeGroup.raml b/api-specs/api/types/attribute-group/AttributeGroup.raml index 2d8e39766..20d70406e 100644 --- a/api-specs/api/types/attribute-group/AttributeGroup.raml +++ b/api-specs/api/types/attribute-group/AttributeGroup.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). name: type: LocalizedString description: | diff --git a/api-specs/api/types/business-unit/BusinessUnit.raml b/api-specs/api/types/business-unit/BusinessUnit.raml index 4fb39432a..ad6b63eac 100644 --- a/api-specs/api/types/business-unit/BusinessUnit.raml +++ b/api-specs/api/types/business-unit/BusinessUnit.raml @@ -30,12 +30,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources updated after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key: type: string description: | diff --git a/api-specs/api/types/cart-discount/CartDiscount.raml b/api-specs/api/types/cart-discount/CartDiscount.raml index 54b4e38c2..ee089271c 100644 --- a/api-specs/api/types/cart-discount/CartDiscount.raml +++ b/api-specs/api/types/cart-discount/CartDiscount.raml @@ -26,12 +26,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources updated after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). name: type: LocalizedString description: | diff --git a/api-specs/api/types/cart/Cart.raml b/api-specs/api/types/cart/Cart.raml index 1219e80da..6847bd51e 100644 --- a/api-specs/api/types/cart/Cart.raml +++ b/api-specs/api/types/cart/Cart.raml @@ -203,9 +203,9 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources updated after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). diff --git a/api-specs/api/types/category/Category.raml b/api-specs/api/types/category/Category.raml index f8f69c1f8..5ee61a078 100644 --- a/api-specs/api/types/category/Category.raml +++ b/api-specs/api/types/category/Category.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources updated after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). name: type: LocalizedString description: | diff --git a/api-specs/api/types/channel/Channel.raml b/api-specs/api/types/channel/Channel.raml index fd08e94b1..9a6b351f3 100644 --- a/api-specs/api/types/channel/Channel.raml +++ b/api-specs/api/types/channel/Channel.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources updated after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key: type: string description: | diff --git a/api-specs/api/types/common/ClientLogging.raml b/api-specs/api/types/common/ClientLogging.raml index eec28d60b..3b9713aad 100644 --- a/api-specs/api/types/common/ClientLogging.raml +++ b/api-specs/api/types/common/ClientLogging.raml @@ -4,7 +4,7 @@ displayName: ClientLogging type: object description: | - These objects represent information about which [API Client](/../api/projects/api-clients) created or modified a resource. For more information, see [Client Logging](/client-logging). + These objects represent information about which [API Client](/../api/projects/api-clients) created or modified a resource. For more information, see [Client Logging](/../api/general-concepts#client-logging). properties: clientId?: type: string @@ -13,7 +13,7 @@ properties: externalUserId?: type: string description: | - [External user ID](/../api/client-logging#external-user-ids) provided by `X-External-User-ID` HTTP Header. + [External user ID](/../api/general-concepts#external-user-ids) provided by `X-External-User-ID` HTTP Header. maxLength: 128 customer?: type: CustomerReference diff --git a/api-specs/api/types/common/CreatedBy.raml b/api-specs/api/types/common/CreatedBy.raml index 0dc8df0df..1f5a4fcd6 100644 --- a/api-specs/api/types/common/CreatedBy.raml +++ b/api-specs/api/types/common/CreatedBy.raml @@ -2,7 +2,7 @@ (package): Common displayName: CreatedBy type: ClientLogging -description: Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). +description: Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). properties: clientId?: type: string @@ -11,7 +11,7 @@ properties: externalUserId?: type: string description: | - [External user ID](/../api/client-logging#external-user-ids) provided by `X-External-User-ID` HTTP Header. + [External user ID](/../api/general-concepts#external-user-ids) provided by `X-External-User-ID` HTTP Header. maxLength: 128 customer?: type: CustomerReference diff --git a/api-specs/api/types/common/LastModifiedBy.raml b/api-specs/api/types/common/LastModifiedBy.raml index 7edd97b4a..61981f8a8 100644 --- a/api-specs/api/types/common/LastModifiedBy.raml +++ b/api-specs/api/types/common/LastModifiedBy.raml @@ -2,7 +2,7 @@ (package): Common displayName: LastModifiedBy type: ClientLogging -description: Present on resources modified after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). +description: Present on resources modified after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). properties: clientId?: type: string @@ -11,7 +11,7 @@ properties: externalUserId?: type: string description: | - [External user ID](/../api/client-logging#external-user-ids) provided by `X-External-User-ID` HTTP Header. + [External user ID](/../api/general-concepts#external-user-ids) provided by `X-External-User-ID` HTTP Header. maxLength: 128 customer?: type: CustomerReference diff --git a/api-specs/api/types/custom-object/CustomObject.raml b/api-specs/api/types/custom-object/CustomObject.raml index 417e50925..67ece25cc 100644 --- a/api-specs/api/types/custom-object/CustomObject.raml +++ b/api-specs/api/types/custom-object/CustomObject.raml @@ -26,12 +26,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). container: type: string description: | diff --git a/api-specs/api/types/customer-group/CustomerGroup.raml b/api-specs/api/types/customer-group/CustomerGroup.raml index aa965f4be..6dadd10c5 100644 --- a/api-specs/api/types/customer-group/CustomerGroup.raml +++ b/api-specs/api/types/customer-group/CustomerGroup.raml @@ -28,12 +28,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources updated after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources updated after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: | diff --git a/api-specs/api/types/customer/Customer.raml b/api-specs/api/types/customer/Customer.raml index 6a7a0448a..3b77f5748 100644 --- a/api-specs/api/types/customer/Customer.raml +++ b/api-specs/api/types/customer/Customer.raml @@ -46,12 +46,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). email: type: string description: | diff --git a/api-specs/api/types/discount-code/DiscountCode.raml b/api-specs/api/types/discount-code/DiscountCode.raml index 7bc258f00..63d1dce15 100644 --- a/api-specs/api/types/discount-code/DiscountCode.raml +++ b/api-specs/api/types/discount-code/DiscountCode.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). name?: type: LocalizedString description: | diff --git a/api-specs/api/types/extension/Extension.raml b/api-specs/api/types/extension/Extension.raml index bdaa3cf0f..645744314 100644 --- a/api-specs/api/types/extension/Extension.raml +++ b/api-specs/api/types/extension/Extension.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: | diff --git a/api-specs/api/types/inventory/InventoryEntry.raml b/api-specs/api/types/inventory/InventoryEntry.raml index 73e19cf47..a23ad990f 100644 --- a/api-specs/api/types/inventory/InventoryEntry.raml +++ b/api-specs/api/types/inventory/InventoryEntry.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: | diff --git a/api-specs/api/types/message/Message.raml b/api-specs/api/types/message/Message.raml index 0c2151ac3..e7194a971 100644 --- a/api-specs/api/types/message/Message.raml +++ b/api-specs/api/types/message/Message.raml @@ -30,7 +30,7 @@ properties: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). sequenceNumber: type: number format: int64 diff --git a/api-specs/api/types/order-edit/OrderEdit.raml b/api-specs/api/types/order-edit/OrderEdit.raml index 47dbf6718..7a69dfa61 100644 --- a/api-specs/api/types/order-edit/OrderEdit.raml +++ b/api-specs/api/types/order-edit/OrderEdit.raml @@ -55,9 +55,9 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). diff --git a/api-specs/api/types/order/Order.raml b/api-specs/api/types/order/Order.raml index e8b045b6f..10b590b5a 100644 --- a/api-specs/api/types/order/Order.raml +++ b/api-specs/api/types/order/Order.raml @@ -240,9 +240,9 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). diff --git a/api-specs/api/types/payment/Payment.raml b/api-specs/api/types/payment/Payment.raml index c328e66c8..50afef3f8 100644 --- a/api-specs/api/types/payment/Payment.raml +++ b/api-specs/api/types/payment/Payment.raml @@ -23,12 +23,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). customer?: type: CustomerReference description: | diff --git a/api-specs/api/types/product-discount/ProductDiscount.raml b/api-specs/api/types/product-discount/ProductDiscount.raml index 6066d2668..65b7b07e9 100644 --- a/api-specs/api/types/product-discount/ProductDiscount.raml +++ b/api-specs/api/types/product-discount/ProductDiscount.raml @@ -28,12 +28,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). name: type: LocalizedString description: | diff --git a/api-specs/api/types/product-selection/ProductSelection.raml b/api-specs/api/types/product-selection/ProductSelection.raml index e990efda2..2aa3648af 100644 --- a/api-specs/api/types/product-selection/ProductSelection.raml +++ b/api-specs/api/types/product-selection/ProductSelection.raml @@ -25,11 +25,11 @@ properties: lastModifiedBy?: type: LastModifiedBy description: |- - Present on resources updated after 1/02/2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources updated after 1/02/2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy description: |- - Present on resources created after 1/02/2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1/02/2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: | diff --git a/api-specs/api/types/product-type/ProductType.raml b/api-specs/api/types/product-type/ProductType.raml index 6a3210704..01e0bda07 100644 --- a/api-specs/api/types/product-type/ProductType.raml +++ b/api-specs/api/types/product-type/ProductType.raml @@ -26,12 +26,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: |- diff --git a/api-specs/api/types/product/Product.raml b/api-specs/api/types/product/Product.raml index 5b6867308..304796b1b 100644 --- a/api-specs/api/types/product/Product.raml +++ b/api-specs/api/types/product/Product.raml @@ -32,12 +32,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: | diff --git a/api-specs/api/types/project/SearchIndexingConfigurationValues.raml b/api-specs/api/types/project/SearchIndexingConfigurationValues.raml index fc19b602c..8b4cbb0d1 100644 --- a/api-specs/api/types/project/SearchIndexingConfigurationValues.raml +++ b/api-specs/api/types/project/SearchIndexingConfigurationValues.raml @@ -14,4 +14,4 @@ properties: (beta): true type: LastModifiedBy description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). diff --git a/api-specs/api/types/quote-request/QuoteRequest.raml b/api-specs/api/types/quote-request/QuoteRequest.raml index 48b8cb84d..d1cec9555 100644 --- a/api-specs/api/types/quote-request/QuoteRequest.raml +++ b/api-specs/api/types/quote-request/QuoteRequest.raml @@ -34,12 +34,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). quoteRequestState: type: QuoteRequestState description: | diff --git a/api-specs/api/types/quote/Quote.raml b/api-specs/api/types/quote/Quote.raml index 04b5abdc7..1a0ac1c3a 100644 --- a/api-specs/api/types/quote/Quote.raml +++ b/api-specs/api/types/quote/Quote.raml @@ -34,12 +34,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). quoteRequest: type: QuoteRequestReference description: | diff --git a/api-specs/api/types/review/Review.raml b/api-specs/api/types/review/Review.raml index 24a2da8b0..e71d6649f 100644 --- a/api-specs/api/types/review/Review.raml +++ b/api-specs/api/types/review/Review.raml @@ -26,12 +26,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: | diff --git a/api-specs/api/types/shipping-method/ShippingMethod.raml b/api-specs/api/types/shipping-method/ShippingMethod.raml index c22a787b0..7de124a22 100644 --- a/api-specs/api/types/shipping-method/ShippingMethod.raml +++ b/api-specs/api/types/shipping-method/ShippingMethod.raml @@ -24,12 +24,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: User-defined unique identifier of the ShippingMethod. diff --git a/api-specs/api/types/shopping-list/ShoppingList.raml b/api-specs/api/types/shopping-list/ShoppingList.raml index d7364a09b..434ff6ff3 100644 --- a/api-specs/api/types/shopping-list/ShoppingList.raml +++ b/api-specs/api/types/shopping-list/ShoppingList.raml @@ -73,9 +73,9 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). diff --git a/api-specs/api/types/staged-quote/StagedQuote.raml b/api-specs/api/types/staged-quote/StagedQuote.raml index b9c94c329..fe3d7aa02 100644 --- a/api-specs/api/types/staged-quote/StagedQuote.raml +++ b/api-specs/api/types/staged-quote/StagedQuote.raml @@ -30,12 +30,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). stagedQuoteState: type: StagedQuoteState customer?: diff --git a/api-specs/api/types/standalone-price/StandalonePrice.raml b/api-specs/api/types/standalone-price/StandalonePrice.raml index 82d29e990..f20328ec3 100644 --- a/api-specs/api/types/standalone-price/StandalonePrice.raml +++ b/api-specs/api/types/standalone-price/StandalonePrice.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: |- diff --git a/api-specs/api/types/state/State.raml b/api-specs/api/types/state/State.raml index c982626fc..cc0495070 100644 --- a/api-specs/api/types/state/State.raml +++ b/api-specs/api/types/state/State.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key: type: string description: | diff --git a/api-specs/api/types/store/Store.raml b/api-specs/api/types/store/Store.raml index 5e879ae65..1fd50bc0b 100644 --- a/api-specs/api/types/store/Store.raml +++ b/api-specs/api/types/store/Store.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key: type: string description: | diff --git a/api-specs/api/types/subscription/ResourceDeletedDeliveryPayload.raml b/api-specs/api/types/subscription/ResourceDeletedDeliveryPayload.raml index ba1479c2d..c6e01e4bd 100644 --- a/api-specs/api/types/subscription/ResourceDeletedDeliveryPayload.raml +++ b/api-specs/api/types/subscription/ResourceDeletedDeliveryPayload.raml @@ -20,4 +20,4 @@ properties: dataErasure?: type: boolean description: | - `true` if the `dataErasure` [parameter](/../api/general-concepts#data-erasure-of-personal-data) on the `DELETE` request was set to `true`. + `true` if the `dataErasure` [parameter](/../api/gdpr#data-erasure-of-personal-data) on the `DELETE` request was set to `true`. diff --git a/api-specs/api/types/subscription/Subscription.raml b/api-specs/api/types/subscription/Subscription.raml index 37eac4aa6..d805f89f0 100644 --- a/api-specs/api/types/subscription/Subscription.raml +++ b/api-specs/api/types/subscription/Subscription.raml @@ -28,12 +28,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). changes: type: ChangeSubscription[] description: | diff --git a/api-specs/api/types/tax-category/TaxCategory.raml b/api-specs/api/types/tax-category/TaxCategory.raml index 630754282..fdd93312b 100644 --- a/api-specs/api/types/tax-category/TaxCategory.raml +++ b/api-specs/api/types/tax-category/TaxCategory.raml @@ -27,12 +27,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). name: type: string description: | diff --git a/api-specs/api/types/type/Type.raml b/api-specs/api/types/type/Type.raml index 06e58e71a..b654e2406 100644 --- a/api-specs/api/types/type/Type.raml +++ b/api-specs/api/types/type/Type.raml @@ -25,12 +25,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key: type: string description: |- diff --git a/api-specs/api/types/zone/Zone.raml b/api-specs/api/types/zone/Zone.raml index 541e689f5..5be862452 100644 --- a/api-specs/api/types/zone/Zone.raml +++ b/api-specs/api/types/zone/Zone.raml @@ -26,12 +26,12 @@ properties: type: LastModifiedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). createdBy?: type: CreatedBy (beta): true description: | - Present on resources created after 1 February 2019 except for [events not tracked](/../api/client-logging#events-tracked). + Present on resources created after 1 February 2019 except for [events not tracked](/../api/general-concepts#events-tracked). key?: type: string description: | diff --git a/api-specs/history/types/ModifiedBy.raml b/api-specs/history/types/ModifiedBy.raml index c4b00779f..b118aef32 100644 --- a/api-specs/history/types/ModifiedBy.raml +++ b/api-specs/history/types/ModifiedBy.raml @@ -18,7 +18,7 @@ properties: Indicates who performed the change. - 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 API Client with or without an [external user ID](/general-concepts#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