Updated API from documentation release

Author: ct-sdks[bot]

api-specs/api/examples/Cart/CartLockCartAction.json

@@ -0,0 +1,3 @@
+{
+  "action": "lockCart"
+}

api-specs/api/examples/Cart/CartUnlockCartAction.json

@@ -0,0 +1,3 @@
+{
+  "action": "unlockCart"
+}

api-specs/api/types/cart/Cart.raml

@@ -196,6 +196,10 @@ properties:
     type: DiscountTypeCombination
     description: |
       Indicates if a combination of discount types can apply on a Cart.
+  lock?:
+    type: CartLock
+    description: |
+      Indicates whether the Cart has been [locked](/../api/carts-orders-overview#lock-a-cart), preventing edits.
   deleteDaysAfterLastModification?:
     type: integer
     description: |

api-specs/api/types/cart/CartLock.raml

@@ -0,0 +1,17 @@
+#%RAML 1.0 DataType
+(package): Cart
+displayName: CartLock
+type: object
+description: |
+  Indicates that the Cart is [locked](/../api/carts-orders-overview#lock-a-cart) to prevent changes.
+  Provides metadata about when the lock was created and which
+  [API Client](ctp:api:type:ApiClient) initiated it.
+properties:
+  createdAt:
+    type: datetime
+    description: |
+      Date and time (UTC) the Cart was locked.
+  clientId:
+    type: string
+    description: |
+      `id` of the [API Client](ctp:api:type:ApiClient) that locked the Cart.

api-specs/api/types/cart/updates/CartLockCartAction.raml

@@ -0,0 +1,10 @@
+#%RAML 1.0 DataType
+(package): Cart
+type: CartUpdateAction
+displayName: CartLockCartAction
+discriminatorValue: lockCart
+example: !include ../../../examples/Cart/CartLockCartAction.json
+description: |
+  [Locks](/../api/carts-orders-overview#lock-a-cart) a Cart, preventing all updates from API Clients without an elevated [OAuth 2.0 Scope](/../api/scopes).
+  This action sets the Cart's `lock` [field](/projects/carts#cart) which identifies the API Client that locked the Cart and when the lock was applied.
+  This action requires an additional OAuth 2.0 Scope `manage_locked_carts`.

api-specs/api/types/cart/updates/CartUnlockCartAction.raml

@@ -0,0 +1,9 @@
+#%RAML 1.0 DataType
+(package): Cart
+type: CartUpdateAction
+displayName: CartUnlockCartAction
+discriminatorValue: unlockCart
+example: !include ../../../examples/Cart/CartUnlockCartAction.json
+description: |
+  Unlocks a Cart, removing all update restrictions that are in place while a Cart is [locked](/../api/carts-orders-overview#lock-a-cart).
+  This action requires an additional OAuth 2.0 Scope `manage_locked_carts`.

api-specs/api/types/types.raml

@@ -192,6 +192,7 @@ CartDiscountSetValidUntilAction: !include cart-discount/updates/CartDiscountSetV
 BestDeal: !include cart/BestDeal.raml
 Cart: !include cart/Cart.raml
 CartDraft: !include cart/CartDraft.raml
+CartLock: !include cart/CartLock.raml
 CartMergeMode: !include cart/CartMergeMode.raml
 CartOrigin: !include cart/CartOrigin.raml
 CartPagedQueryResponse: !include cart/CartPagedQueryResponse.raml
@@ -274,6 +275,7 @@ CartChangeTaxCalculationModeAction: !include cart/updates/CartChangeTaxCalculati
 CartChangeTaxModeAction: !include cart/updates/CartChangeTaxModeAction.raml
 CartChangeTaxRoundingModeAction: !include cart/updates/CartChangeTaxRoundingModeAction.raml
 CartFreezeCartAction: !include cart/updates/CartFreezeCartAction.raml
+CartLockCartAction: !include cart/updates/CartLockCartAction.raml
 CartRecalculateAction: !include cart/updates/CartRecalculateAction.raml
 CartRemoveCustomLineItemAction: !include cart/updates/CartRemoveCustomLineItemAction.raml
 CartRemoveDiscountCodeAction: !include cart/updates/CartRemoveDiscountCodeAction.raml
@@ -328,6 +330,7 @@ CartSetShippingMethodTaxAmountAction: !include cart/updates/CartSetShippingMetho
 CartSetShippingMethodTaxRateAction: !include cart/updates/CartSetShippingMethodTaxRateAction.raml
 CartSetShippingRateInputAction: !include cart/updates/CartSetShippingRateInputAction.raml
 CartUnfreezeCartAction: !include cart/updates/CartUnfreezeCartAction.raml
+CartUnlockCartAction: !include cart/updates/CartUnlockCartAction.raml
 CartUpdateItemShippingAddressAction: !include cart/updates/CartUpdateItemShippingAddressAction.raml
 Category: !include category/Category.raml
 CategoryDraft: !include category/CategoryDraft.raml

api-specs/graphql/schema.sdl

@@ -1836,6 +1836,7 @@ type Cart implements Versioned & ReferenceExpandable {
   discountTypeCombination: DiscountTypeCombination
   cartState: CartState!
   key: String
+  lock: CartLock
   custom: CustomFieldsType
   deleteDaysAfterLastModification: Int
   totalLineItemQuantity: Long
@@ -2114,6 +2115,12 @@ type CartLimitsProjection {
   total: CartLimitWithCurrent!
 }
 
+"Prevents edits on a Cart unless the caller has the `manage_locked_carts` OAuth scope."
+type CartLock {
+  createdAt: DateTime!
+  clientId: String!
+}
+
 enum CartMergeMode {
   """
   `LineItem`s of the anonymous cart will be copied to the customer’s active cart that has been modified most recently.
@@ -2253,6 +2260,8 @@ input CartUpdateAction {
   updateItemShippingAddress: UpdateCartItemShippingAddress
   freezeCart: FreezeCart
   unfreezeCart: UnfreezeCart
+  lockCart: LockCart
+  unlockCart: UnlockCart
   applyDeltaToLineItemShippingDetailsTargets: ApplyCartDeltaToLineItemShippingDetailsTargets
   applyDeltaToCustomLineItemShippingDetailsTargets: ApplyCartDeltaToCustomLineItemShippingDetailsTargets
   addLineItem: AddCartLineItem
@@ -5849,6 +5858,10 @@ type Location {
   state: String
 }
 
+input LockCart {
+  dummy: String
+}
+
 "The `Long` scalar type represents non-fractional signed whole numeric values. Long can represent values between -(2^63) and 2^63 - 1."
 scalar Long
 
@@ -16796,6 +16809,10 @@ input UnfreezeCart {
   dummy: String
 }
 
+input UnlockCart {
+  dummy: String
+}
+
 input UnpublishProduct {
   dummy: String
 }