Skip to content

Commit

Permalink
Updated API from documentation release
Browse files Browse the repository at this point in the history
  • Loading branch information
ct-sdks[bot] committed May 31, 2024
1 parent 5bb32d1 commit 061b3c5
Show file tree
Hide file tree
Showing 37 changed files with 43 additions and 0 deletions.
3 changes: 3 additions & 0 deletions api-specs/api/types/annotations.raml
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,6 @@ enumGroups:
//:
description: |
Specifies the group for the enum value given by the key.
expandable:
type: boolean
allowedTargets: TypeDeclaration
2 changes: 2 additions & 0 deletions api-specs/api/types/business-unit/Associate.raml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
#%RAML 1.0 DataType
(package): BusinessUnit
displayName: Associate
type: object
(expandable): true
properties:
associateRoleAssignments:
type: AssociateRoleAssignment[]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#%RAML 1.0 DataType
(package): BusinessUnit
displayName: AssociateRoleAssignment
type: object
properties:
associateRole:
type: AssociateRoleKeyReference
Expand Down
2 changes: 2 additions & 0 deletions api-specs/api/types/business-unit/InheritedAssociate.raml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
#%RAML 1.0 DataType
(package): BusinessUnit
displayName: InheritedAssociate
type: object
(expandable): true
properties:
associateRoleAssignments:
type: InheritedAssociateRoleAssignment[]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#%RAML 1.0 DataType
(package): BusinessUnit
displayName: InheritedAssociateRoleAssignment
type: object
properties:
associateRole:
type: AssociateRoleKeyReference
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/cart/CustomLineItem.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): Cart
displayName: CustomLineItem
type: object
(expandable): true
description: |
A generic item that can be added to the Cart but is not bound to a Product that can be used for discounts (negative money), vouchers, complex cart rules, additional services, or fees.
You control the lifecycle of this item.
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/cart/DiscountCodeInfo.raml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#%RAML 1.0 DataType
(package): Cart
displayName: DiscountCodeInfo
(expandable): true
type: object
properties:
discountCode:
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/cart/DiscountedTotalPricePortion.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): Cart
displayName: DiscountedTotalPricePortion
type: object
(expandable): true
properties:
discount:
type: CartDiscountReference
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/cart/LineItem.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): Cart
displayName: LineItem
type: object
(expandable): true
description: |
The representation of a [Line Item](/../api/carts-orders-overview#line-items) in a [Cart](ctp:api:type:Cart) or in an [Order](ctp:api:type:Order).
properties:
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/cart/ShippingInfo.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): Cart
displayName: ShippingInfo
type: object
(expandable): true
properties:
shippingMethodName:
type: string
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/common/BaseResource.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): Common
displayName: BaseResource
type: object
(expandable): true
(abstract): true
(ignoreValidators): [PolymorphicSubtypesRule]
properties:
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/common/ClientLogging.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): Common
displayName: ClientLogging
type: object
(expandable): true
description: |
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).
(ignoreValidators): [PolymorphicSubtypesRule]
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/common/DiscountedPrice.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): Common
displayName: DiscountedPrice
type: object
(expandable): true
properties:
value:
type: TypedMoney
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/common/Price.raml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ description: |-
The representation for prices embedded in [LineItems](ctp:api:type:LineItem) and in [ProductVariants](ctp:api:type:ProductVariant) when the [ProductPriceMode](ctp:api:type:ProductPriceModeEnum) is `Embedded`.
For the `Standalone` ProductPriceMode refer to [StandalonePrice](ctp:api:type:StandalonePrice).
type: object
(expandable): true
properties:
id:
type: string
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/common/QueryPrice.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): Common
displayName: QueryPrice
type: object
(expandable): true
properties:
id?:
type: string
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/common/Reference.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): Common
displayName: Reference
type: object
(expandable): true
discriminator: typeId
description: |
A Reference represents a loose reference to another resource in the same Project identified by its `id`. The `typeId` indicates the type of the referenced resource. Each resource type has its corresponding Reference type, like [ChannelReference](ctp:api:type:ChannelReference). A referenced resource can be embedded through [Reference Expansion](/general-concepts#reference-expansion). The expanded reference is the value of an additional `obj` field then.
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/common/ScopedPrice.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): Common
displayName: ScopedPrice
type: object
(expandable): true
description: |
Scoped Price is contained in a [ProductVariant](ctp:api:type:ProductVariant) which is returned in response to a
[Product Projection Search](ctp:api:type:ProductProjectionSearchFilterScopedPrice) request when [Scoped Price Search](/../api/pricing-and-discounts-overview#scoped-price-search) is used.
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/me/MyPayment.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): Me
type: object
displayName: MyPayment
(expandable): true
(updateType): MyPaymentUpdate
(actionType): MyPaymentUpdateAction
properties:
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/order/ItemState.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): Order
displayName: ItemState
type: object
(expandable): true
properties:
quantity:
type: number
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/order/PaymentInfo.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): Order
displayName: PaymentInfo
type: object
(expandable): true
properties:
payments:
type: PaymentReference[]
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/order/SyncInfo.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): Order
displayName: SyncInfo
type: object
(expandable): true
description: |
Contains synchronization activity information of the Order (like export or import).
properties:
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/payment/PaymentStatus.raml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#%RAML 1.0 DataType
(package): Payment
type: object
(expandable): true
displayName: PaymentStatus
properties:
interfaceCode?:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#%RAML 1.0 DataType
(package): ProductSelection
type: object
(expandable): true
displayName: AssignedProductReference
properties:
product:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): ProductSelection
type: object
displayName: AssignedProductSelection
(expandable): true
properties:
productSelection:
type: ProductSelectionReference
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#%RAML 1.0 DataType
(package): ProductSelection
type: object
(expandable): true
displayName: ProductSelectionAssignment
description: |-
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): ProductSelection
displayName: ProductSelectionProductPagedQueryResponse
type: object
(expandable): true
description: |
[PagedQueryResult](/general-concepts#pagedqueryresult) containing an array of [AssignedProductReference](ctp:api:type:AssignedProductReference).
properties:
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/product-type/AttributeNestedType.raml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#%RAML 1.0 DataType
(package): ProductType
type: AttributeType
(expandable): true
displayName: AttributeNestedType
discriminatorValue: nested
description: |
Expand Down
2 changes: 2 additions & 0 deletions api-specs/api/types/product/Attribute.raml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#%RAML 1.0 DataType
(package): Product
type: object
(expandable): true
displayName: Attribute
properties:
name:
Expand All @@ -10,6 +11,7 @@ properties:
description: |
Name of the Attribute.
value:
(expandable): true
# type: AttributeValue | AttributeValue[]
type: any
# type:
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/product/ProductData.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): Product
displayName: ProductData
type: object
(expandable): true
description: |
Contains all the data of a Product and its Product Variants.
properties:
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/product/ProductVariant.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): Product
displayName: ProductVariant
type: object
(expandable): true
description: |
A concrete sellable good for which inventory can be tracked. Product Variants are generally mapped to specific SKUs.
properties:
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/shipping-method/ZoneRate.raml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ displayName: ZoneRate
description: |
Defines shipping rates in different currencies for a specific [Zone](ctp:api:type:Zone).
type: object
(expandable): true
properties:
zone:
type: ZoneReference
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#%RAML 1.0 DataType
(package): ShoppingList
type: object
(expandable): true
displayName: ShoppingListLineItem
example: !include ../../examples/ShoppingList/ShoppingListLineItem.json
description: |
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/shopping-list/TextLineItem.raml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#%RAML 1.0 DataType
(package): ShoppingList
type: object
(expandable): true
displayName: TextLineItem
example: !include ../../examples/ShoppingList/TextLineItem.json
description: |
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/store/ProductSelectionSetting.raml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#%RAML 1.0 DataType
(package): Store
type: object
(expandable): true
displayName: ProductSelectionSetting
properties:
productSelection:
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/type/CustomFieldValue.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): Type
# This is a union type that we cannot support in SDKs due to lack of discriminator fields
type: any
(expandable): true
displayName: CustomFieldValue
description: |-
The value of a Custom Field.
Expand Down
1 change: 1 addition & 0 deletions api-specs/api/types/type/CustomFields.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
(package): Type
displayName: CustomFields
type: object
(expandable): true
description: |
Serves as value of the `custom` field on a resource or data type customized with a [Type](ctp:api:type:Type).
properties:
Expand Down
2 changes: 2 additions & 0 deletions api-specs/api/types/type/FieldContainer.raml
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,15 @@
(package): Type
displayName: FieldContainer
type: object
(expandable): true
(asMap):
key: string
value: any
example: !include ../../examples/Type/FieldContainer.json
properties:
# field naming constraint: https://docs.commercetools.com/api/projects/types#fielddefinition
/^[a-zA-Z0-9_-]{2,36}$/:
(expandable): true
type: CustomFieldValue
description: |
JSON object with keys matching the names of Custom Fields (that is, `name`s in the [FieldDefinitions](ctp:api:type:FieldDefinition)) and values given by [CustomFieldValue](ctp:api:type:CustomFieldValue).

0 comments on commit 061b3c5

Please sign in to comment.