From c8a374e9c967c7b8c5080c9a6ed2cd92261680ef Mon Sep 17 00:00:00 2001 From: "ct-sdks[bot]" <153784748+ct-sdks[bot]@users.noreply.github.com> Date: Mon, 15 Apr 2024 13:03:18 +0000 Subject: [PATCH] Updated API from documentation release --- api-specs/api/examples/customer-sign-in-result.example.json | 3 ++- api-specs/api/examples/customer-update-response.example.json | 3 ++- api-specs/api/types/business-unit/BusinessUnit.raml | 2 +- .../business-unit/updates/BusinessUnitSetStoresAction.raml | 2 +- .../cart-discount/updates/CartDiscountSetStoresAction.raml | 2 +- api-specs/api/types/customer/Customer.raml | 4 ++-- .../api/types/customer/updates/CustomerSetStoresAction.raml | 2 +- 7 files changed, 10 insertions(+), 8 deletions(-) diff --git a/api-specs/api/examples/customer-sign-in-result.example.json b/api-specs/api/examples/customer-sign-in-result.example.json index f1f96a4dc..43a433e34 100644 --- a/api-specs/api/examples/customer-sign-in-result.example.json +++ b/api-specs/api/examples/customer-sign-in-result.example.json @@ -10,6 +10,7 @@ "version": 1, "createdAt": "2015-07-06T13:22:33.339Z", "lastModifiedAt": "2015-07-06T13:22:33.339Z", - "authenticationMode": "Password" + "authenticationMode": "Password", + "stores": [] } } diff --git a/api-specs/api/examples/customer-update-response.example.json b/api-specs/api/examples/customer-update-response.example.json index 430ce1659..8b5b69de1 100644 --- a/api-specs/api/examples/customer-update-response.example.json +++ b/api-specs/api/examples/customer-update-response.example.json @@ -18,5 +18,6 @@ "version": 4, "createdAt": "2015-05-06T12:10:12.421Z", "lastModifiedAt": "2015-07-06T13:22:33.339Z", - "authenticationMode": "Password" + "authenticationMode": "Password", + "stores": [] } diff --git a/api-specs/api/types/business-unit/BusinessUnit.raml b/api-specs/api/types/business-unit/BusinessUnit.raml index ed14461ee..99c9e4150 100644 --- a/api-specs/api/types/business-unit/BusinessUnit.raml +++ b/api-specs/api/types/business-unit/BusinessUnit.raml @@ -46,7 +46,7 @@ properties: type: BusinessUnitStatus description: | Indicates whether the Business Unit can be edited and used in [Orders](/../api/projects/orders). - stores?: + stores: type: StoreKeyReference[] description: | References to [Stores](ctp:api:type:Store) the Business Unit is associated with. Only present when `storeMode` is `Explicit`. diff --git a/api-specs/api/types/business-unit/updates/BusinessUnitSetStoresAction.raml b/api-specs/api/types/business-unit/updates/BusinessUnitSetStoresAction.raml index 9db3e4da6..fef38350a 100644 --- a/api-specs/api/types/business-unit/updates/BusinessUnitSetStoresAction.raml +++ b/api-specs/api/types/business-unit/updates/BusinessUnitSetStoresAction.raml @@ -11,7 +11,7 @@ description: | Orders created before the Set Stores update action remain unchanged. Setting the Stores on a Business Unit generates a [BusinessUnitStoresSet](ctp:api:type:BusinessUnitStoresSetMessage) Message. properties: - stores?: + stores: type: StoreResourceIdentifier[] description: | [Stores](ctp:api:type:Store) to set. Overrides the current list of Stores. diff --git a/api-specs/api/types/cart-discount/updates/CartDiscountSetStoresAction.raml b/api-specs/api/types/cart-discount/updates/CartDiscountSetStoresAction.raml index e2b2c4ff3..ef63d781e 100644 --- a/api-specs/api/types/cart-discount/updates/CartDiscountSetStoresAction.raml +++ b/api-specs/api/types/cart-discount/updates/CartDiscountSetStoresAction.raml @@ -9,7 +9,7 @@ description: | This action generates a [CartDiscountStoresSet](ctp:api:type:CartDiscountStoresSetMessage) Message. properties: - stores?: + stores: type: StoreResourceIdentifier[] maxItems: 500 description: | diff --git a/api-specs/api/types/customer/Customer.raml b/api-specs/api/types/customer/Customer.raml index 22fb18ecb..5d58a511a 100644 --- a/api-specs/api/types/customer/Customer.raml +++ b/api-specs/api/types/customer/Customer.raml @@ -128,12 +128,12 @@ properties: type: string description: | Salutation of the Customer, for example, 'Mr.' or 'Mrs.'. - stores?: + stores: type: StoreKeyReference[] description: | [Stores](ctp:api:type:Store) to which the Customer is assigned to. - - If no Stores are specified, the Customer is a global customer, and can log in using the [Password Flow for global Customers](/../api/authorization#password-flow-for-global-customers). + - If `stores` is empty, the Customer is a global customer, and can log in using the [Password Flow for global Customers](/../api/authorization#password-flow-for-global-customers). - If any Stores are specified, the Customer can only log in using the [Password Flow for Customers in a Store](/../api/authorization#password-flow-for-customers-in-a-store) for those specific Stores. authenticationMode: type: AuthenticationMode diff --git a/api-specs/api/types/customer/updates/CustomerSetStoresAction.raml b/api-specs/api/types/customer/updates/CustomerSetStoresAction.raml index 62c6a58af..4cdd39b50 100644 --- a/api-specs/api/types/customer/updates/CustomerSetStoresAction.raml +++ b/api-specs/api/types/customer/updates/CustomerSetStoresAction.raml @@ -8,7 +8,7 @@ description: | Sets the Stores the Customer account is associated with. If no Stores are specified, the Customer becomes a [global Customer](/../api/customers-overview#global-versus-store-specific-customers). properties: - stores?: + stores: type: StoreResourceIdentifier[] description: | ResourceIdentifier of the Stores to set.