Updated API from documentation release

ct-sdks[bot] · ct-sdks[bot] · commit 75612a593ac1 · 2025-02-14T12:53:22.000Z
diff --git a/api-specs/api/types/cart-discount/CartDiscountPatternTarget.raml b/api-specs/api/types/cart-discount/CartDiscountPatternTarget.raml
@@ -24,7 +24,7 @@ properties:
     description: |
       Defines the set of units of (Custom) Line Items in a Cart on which the Discount is applied.
 
-      Based on the availability of matching units and the limits from the `triggerPattern` or `maxOccurence`, the `targetPattern` can match multiple times.
+      Based on the availability of matching units and the limits from the `triggerPattern` or `maxOccurrence`, the `targetPattern` can match multiple times.
 
       This array cannot be empty.
   maxOccurrence?:
diff --git a/api-specs/api/types/cart/ShippingMode.raml b/api-specs/api/types/cart/ShippingMode.raml
@@ -8,6 +8,6 @@ enum:
 (enumDescriptions):
   Single: |
     Cart can contain only a single Shipping Method.
-    This is the default mode for backwards compatibilty.
+    This is the default mode for backwards compatibility.
   Multiple: |
     Cart can contain multiple Shipping Methods.
diff --git a/api-specs/api/types/cart/ShippingRateInputDraft.raml b/api-specs/api/types/cart/ShippingRateInputDraft.raml
@@ -2,7 +2,7 @@
 (package): Cart
 displayName: ShippingRateInputDraft
 type: object
-description: Generic type holding specifc ShippingRateInputDraft types.
+description: Generic type holding specific ShippingRateInputDraft types.
 discriminator: type
 properties:
   type:
diff --git a/api-specs/api/types/cart/updates/CartAddShippingMethodAction.raml b/api-specs/api/types/cart/updates/CartAddShippingMethodAction.raml
@@ -14,7 +14,7 @@ properties:
   shippingMethod:
     type: ShippingMethodResourceIdentifier
     description: |
-      RecourceIdentifier to a [ShippingMethod](ctp:api:type:ShippingMethod) to add to the Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
+      ResourceIdentifier to a [ShippingMethod](ctp:api:type:ShippingMethod) to add to the Cart with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
       If the referenced Shipping Method has a predicate that does not match the Cart, an [InvalidOperation](ctp:api:type:InvalidOperationError) error is returned.
   shippingAddress:
     type: BaseAddress
diff --git a/api-specs/api/types/customer/CustomerDraft.raml b/api-specs/api/types/customer/CustomerDraft.raml
@@ -70,7 +70,7 @@ properties:
   companyName?:
     type: string
     description: |
-      Company name of the Customer. When representing a company as a Customer, [Business Units](ctp:api:type:BusinessUnit) provide extended funtionality.
+      Company name of the Customer. When representing a company as a Customer, [Business Units](ctp:api:type:BusinessUnit) provide extended functionality.
   vatId?:
     type: string
     description: |
diff --git a/api-specs/api/types/customer/updates/CustomerSetFirstNameAction.raml b/api-specs/api/types/customer/updates/CustomerSetFirstNameAction.raml
@@ -5,7 +5,7 @@ displayName: CustomerSetFirstNameAction
 discriminatorValue: setFirstName
 example: !include ../../../examples/Customer/CustomerSetFirstNameAction.json
 description: |
-  Setting the first name of the Customer produces the [CustomeFirstNameSet](ctp:api:type:CustomerFirstNameSetMessage) Message.
+  Setting the first name of the Customer produces the [CustomerFirstNameSet](ctp:api:type:CustomerFirstNameSetMessage) Message.
 properties:
   firstName?:
     type: string
diff --git a/api-specs/api/types/me/updates/MyCartAddItemShippingAddressAction.raml b/api-specs/api/types/me/updates/MyCartAddItemShippingAddressAction.raml
@@ -12,4 +12,4 @@ properties:
     description: |
       Address to append to `itemShippingAddresses`.
 
-      The new address must have a key that is unique accross this Cart.
+      The new address must have a key that is unique across this Cart.
diff --git a/api-specs/api/types/order-edit/OrderEditApplied.raml b/api-specs/api/types/order-edit/OrderEditApplied.raml
@@ -4,7 +4,7 @@ type: OrderEditResult
 displayName: OrderEditApplied
 discriminatorValue: Applied
 description: |
-  Result of a succesful application of `stagedActions` to the Order.
+  Result of a successful application of `stagedActions` to the Order.
 properties:
   type:
     type: string
diff --git a/api-specs/api/types/payment/TransactionState.raml b/api-specs/api/types/payment/TransactionState.raml
@@ -15,6 +15,6 @@ enum:
   Pending: |
     The payment service has accepted the Transaction, but it is not completed yet.
   Success: |
-    The payment service has confirmed the successful completion of the Transation.
+    The payment service has confirmed the successful completion of the Transaction.
   Failure: |
     Transaction has unrecoverably failed.
diff --git a/api-specs/api/types/state/StateDraft.raml b/api-specs/api/types/state/StateDraft.raml
@@ -27,7 +27,7 @@ properties:
   roles?:
     type: StateRoleEnum[]
     description: |
-      If suitable, assign predifined roles the State can fulfill in case the State's `type` is `LineItemState` or `ReviewState`.
+      If suitable, assign predefined roles the State can fulfill in case the State's `type` is `LineItemState` or `ReviewState`.
   transitions?:
     type: StateResourceIdentifier[]
     description: |
diff --git a/api-specs/api/types/store/Store.raml b/api-specs/api/types/store/Store.raml
@@ -67,8 +67,8 @@ properties:
       Controls availability of Products for this Store via Product Selections:
 
       - Leave empty if all Products in the [Project](ctp:api:type:Project) should be available in this Store.
-      - If only `inactive` Product Selections with `IndividualExclusion` [ProductSelectionMode](ctp:api:type:ProductSelectionMode) are provided, all the Products are availlable in this Store.
-      - If all the Product Selections provided are `inactive` and there's at least a Product Selection of mode `Individual`, no Product is availlable in this Store.
+      - If only `inactive` Product Selections with `IndividualExclusion` [ProductSelectionMode](ctp:api:type:ProductSelectionMode) are provided, all the Products are available in this Store.
+      - If all the Product Selections provided are `inactive` and there's at least a Product Selection of mode `Individual`, no Product is available in this Store.
       - If at least an `active` Product Selection is provided, only `active` Product Selections are considered to compute the availlability in this Store.
     maxItems: 100
 
diff --git a/api-specs/api/types/type/CustomFieldValue.raml b/api-specs/api/types/type/CustomFieldValue.raml
@@ -14,7 +14,7 @@ description: |-
   | [CustomFieldBooleanType](ctp:api:type:CustomFieldBooleanType)                 | Boolean (`true` or `false`)                                                                                                                                                     |
   | [CustomFieldStringType](ctp:api:type:CustomFieldStringType)                   | String                                                                                                                                                                |
   | [CustomFieldLocalizedStringType](ctp:api:type:CustomFieldLocalizedStringType) | [LocalizedString](ctp:api:type:LocalizedString)                                                                                                                             |
-  | [CustomFieldEnumType](ctp:api:type:CustomFieldEnumType)                       | String. Must be a `key` of one of the [EnumValues](ctp:api:type:CustomFieldEnumValue) defined in the [EnumType](ctp:api:type:CustomFiedEnumType)                                     |
+  | [CustomFieldEnumType](ctp:api:type:CustomFieldEnumType)                       | String. Must be a `key` of one of the [EnumValues](ctp:api:type:CustomFieldEnumValue) defined in the [EnumType](ctp:api:type:CustomFieldEnumType)                                     |
   | [CustomFieldLocalizedEnumType](ctp:api:type:CustomFieldLocalizedEnumType)     | String. Must be a `key` of one of the [LocalizedEnumValues](ctp:api:type:CustomFieldLocalizedEnumValue) defined in the [LocalizedEnumType](ctp:api:type:CustomFieldLocalizedEnumType) |
   | [CustomFieldNumberType](ctp:api:type:CustomFieldNumberType)                   | Number                                                                                                                                                                |
   | [CustomFieldMoneyType](ctp:api:type:CustomFieldMoneyType)                     | [CentPrecisionMoney](ctp:api:type:CentPrecisionMoney)                                                                                                                                         |
diff --git a/api-specs/checkout/types/annotations.raml b/api-specs/checkout/types/annotations.raml
@@ -7,7 +7,7 @@ annotationTypes:
   package:
     description: |
       Allows to specify a target package for a generator for a RAML library.
-      This package name should be a language indepedent logical name (e.g. "products"), which a generator then uses to
+      This package name should be a language independent logical name (e.g. "products"), which a generator then uses to
       generate a language-specific package name (e.g. "com.myapi.jvm.products") from its configuration.
     allowedTargets:
       - Library
diff --git a/api-specs/checkout/types/error/PaymentFailureError.raml b/api-specs/checkout/types/error/PaymentFailureError.raml
@@ -5,11 +5,11 @@ type: ErrorObject
 displayName: PaymentFailureError
 discriminatorValue: PaymentFailure
 description: |
-  Returned when the payment cannot be completed succesfully.
+  Returned when the payment cannot be completed successfully.
 properties:
   code:
     type: string
   message:
     type: string
     description: |
-      `"Payment could not be completed succesfully."`
+      `"Payment could not be completed successfully."`
diff --git a/api-specs/connect/types/annotations.raml b/api-specs/connect/types/annotations.raml
@@ -7,7 +7,7 @@ annotationTypes:
   package:
     description: |
       Allows to specify a target package for a generator for a RAML library.
-      This package name should be a language indepedent logical name (e.g. "products"), which a generator then uses to
+      This package name should be a language independent logical name (e.g. "products"), which a generator then uses to
       generate a language-specific package name (e.g. "com.myapi.jvm.products") from its configuration.
     allowedTargets:
       - Library
diff --git a/api-specs/connect/types/common.raml b/api-specs/connect/types/common.raml
@@ -378,7 +378,7 @@ types:
     properties:
       entries:
         type: DeploymentReportEntry[]
-        description: Contains informations, errors and warnings about the Connector deployment.
+        description: Contains information, errors and warnings about the Connector deployment.
   DeploymentDetailsBuild:
     example: !include ../examples/deployment/DeploymentDetailsBuild.json
     properties:
diff --git a/api-specs/connect/types/error/AuthenticationError.raml b/api-specs/connect/types/error/AuthenticationError.raml
@@ -11,4 +11,4 @@ properties:
   message:
     type: string
     description: |
-      `"Bad credientals or Client ID is not defined"`
+      `"Bad credentials or Client ID is not defined"`
diff --git a/api-specs/history/types/UpdateType.raml b/api-specs/history/types/UpdateType.raml
@@ -139,7 +139,7 @@ enum:
   - 'setAssetDescription'
   - 'setAssetSources'
   - 'setAssetTags'
-  - 'setAsssetKey'
+  - 'setAssetKey'
   - 'setAttribute'
   - 'setAuthenticationMode'
   - 'setAuthorName'
diff --git a/api-specs/import/types/order-import.raml b/api-specs/import/types/order-import.raml
@@ -249,7 +249,7 @@ types:
       - MatchesCart
   ShippingInfoImportDraft:
     description: |
-      Maps to an order's `shippingInfo` property. This field is usually populated by the cart assosciated with
+      Maps to an order's `shippingInfo` property. This field is usually populated by the cart associated with
       the order, but when importing orders you must provide a draft representation as a part of the OrderImport.
     properties:
       shippingMethodName:
@@ -269,7 +269,7 @@ types:
         description: References a shipping method by key.
       deliveries?:
         type: Delivery[]
-        description: Note that you can not add a `DeliveryItem` on import, as `LineItems` and `CustomLineItems` are not yet referencable by an `id`.
+        description: Note that you can not add a `DeliveryItem` on import, as `LineItems` and `CustomLineItems` are not yet referenceable by an `id`.
       discountedPrice?:
         type: DiscountedLineItemPriceDraft
       shippingMethodState?:
diff --git a/api-specs/mist/annotations.raml b/api-specs/mist/annotations.raml
@@ -7,7 +7,7 @@ annotationTypes:
   package:
     description: |
       Allows to specify a target package for a generator for a RAML library.
-      This package name should be a language indepedent logical name (e.g. "products"), which a generator then uses to
+      This package name should be a language independent logical name (e.g. "products"), which a generator then uses to
       generate a language-specific package name (e.g. "com.myapi.jvm.products") from its configuration.
     allowedTargets:
       - Library
