Skip to content

Commit 7abe530

Browse files
ct-sdks[bot]ct-sdks[bot]
committed
Updated API from documentation release
1 parent 4025ec4 commit 7abe530

11 files changed

+82
-0
lines changed

‎api-specs/api/types/message/ShoppingListLineItemAddedMessage.raml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: ShoppingListMessage
4+
displayName: ShoppingListLineItemAddedMessage
5+
discriminatorValue: ShoppingListLineItemAdded
6+
description: |
7+
Generated after a successful [Add ShoppingListLineItem](ctp:api:type:ShoppingListAddLineItemAction) update action.
8+
properties:
9+
lineItem:
10+
type: ShoppingListLineItem
11+
description: |
12+
[Line Item](ctp:api:type:ShoppingListLineItem) that was added to the [ShoppingList](ctp:api:type:ShoppingList).

‎api-specs/api/types/message/ShoppingListLineItemRemovedMessage.raml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: ShoppingListMessage
4+
displayName: ShoppingListLineItemRemovedMessage
5+
discriminatorValue: ShoppingListLineItemRemoved
6+
description: |
7+
Generated after a successful [Remove ShoppingListLineItem](ctp:api:type:ShoppingListRemoveLineItemAction) update action.
8+
properties:
9+
lineItem:
10+
type: ShoppingListLineItem
11+
description: |
12+
[Line Item](ctp:api:type:ShoppingListLineItem) that was removed from the [ShoppingList](ctp:api:type:ShoppingList).

‎api-specs/api/types/message/ShoppingListMessage.raml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: Message
4+
(ignoreValidators): [PolymorphicSubtypesRule]
5+
displayName: ShoppingListMessage

‎api-specs/api/types/message/payload/ShoppingListLineItemAddedMessagePayload.raml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: ShoppingListMessagePayload
4+
displayName: ShoppingListLineItemAddedMessagePayload
5+
discriminatorValue: ShoppingListLineItemAdded
6+
description: |
7+
Generated after a successful [Add ShoppingListLineItem](ctp:api:type:ShoppingListAddLineItemAction) update action.
8+
properties:
9+
lineItem:
10+
type: ShoppingListLineItem
11+
description: |
12+
[Line Item](ctp:api:type:ShoppingListLineItem) that was added to the [ShoppingList](ctp:api:type:ShoppingList).

‎api-specs/api/types/message/payload/ShoppingListLineItemRemovedMessagePayload.raml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: ShoppingListMessagePayload
4+
displayName: ShoppingListLineItemRemovedMessagePayload
5+
discriminatorValue: ShoppingListLineItemRemoved
6+
description: |
7+
Generated after a successful [Remove ShoppingListLineItem](ctp:api:type:ShoppingListRemoveLineItemAction) update action.
8+
properties:
9+
lineItem:
10+
type: ShoppingListLineItem
11+
description: |
12+
[Line Item](ctp:api:type:ShoppingListLineItem) that was removed from the [ShoppingList](ctp:api:type:ShoppingList).

‎api-specs/api/types/message/payload/ShoppingListMessagePayload.raml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: MessagePayload
4+
(ignoreValidators): [PolymorphicSubtypesRule]
5+
displayName: ShoppingListMessagePayload

‎api-specs/api/types/shopping-list/updates/ShoppingListAddLineItemAction.raml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ description: |
77
The [ProductVariant](ctp:api:type:ProductVariant) to be included in the ShoppingListLineItem must be specified using the `productID` and `variantID`, or by the `sku`.
88
If the ShoppingList already contains a ShoppingListLineItem for the same Product Variant with the same Custom Fields, then only the quantity of the existing ShoppingListLineItem is increased.
99
A ShoppingListLineItem with an empty `variantId` is not considered the same as a ShoppingListLineItem with a `variantId` currently referring to the Master Variant.
10+
11+
Produces the [Shopping List Line Item Added](ctp:api:type:ShoppingListLineItemAddedMessage) Message.
12+
1013
example: !include ../../../examples/ShoppingList/ShoppingListAddLineItemAction.json
1114
properties:
1215
key?:

‎api-specs/api/types/shopping-list/updates/ShoppingListRemoveLineItemAction.raml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ type: ShoppingListUpdateAction
44
displayName: ShoppingListRemoveLineItemAction
55
discriminatorValue: removeLineItem
66
example: !include ../../../examples/ShoppingList/ShoppingListRemoveLineItemAction.json
7+
description: |
8+
Produces the [Shopping List Line Item Removed](ctp:api:type:ShoppingListLineItemRemovedMessage) Message.
79
properties:
810
lineItemId?:
911
type: string

‎api-specs/api/types/subscription/MessageSubscriptionResourceTypeId.raml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ enum:
2323
- quote
2424
- quote-request
2525
- review
26+
- shopping-list
2627
- staged-quote
2728
- standalone-price
2829
- store
@@ -63,6 +64,8 @@ enum:
6364
Messages related to [Quote Requests](ctp:api:type:QuoteRequest).
6465
review: |
6566
Messages related to [Reviews](ctp:api:type:Review).
67+
shopping-list: |
68+
Messages related to [Shopping Lists](ctp:api:type:ShoppingList).
6669
staged-quote: |
6770
Messages related to [Staged Quotes](ctp:api:type:StagedQuote).
6871
standalone-price: |

‎api-specs/api/types/types.raml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1051,6 +1051,9 @@ ReturnInfoSetMessage: !include message/ReturnInfoSetMessage.raml
10511051
ReviewCreatedMessage: !include message/ReviewCreatedMessage.raml
10521052
ReviewRatingSetMessage: !include message/ReviewRatingSetMessage.raml
10531053
ReviewStateTransitionMessage: !include message/ReviewStateTransitionMessage.raml
1054+
ShoppingListLineItemAddedMessage: !include message/ShoppingListLineItemAddedMessage.raml
1055+
ShoppingListLineItemRemovedMessage: !include message/ShoppingListLineItemRemovedMessage.raml
1056+
ShoppingListMessage: !include message/ShoppingListMessage.raml
10541057
StagedQuoteCreatedMessage: !include message/StagedQuoteCreatedMessage.raml
10551058
StagedQuoteDeletedMessage: !include message/StagedQuoteDeletedMessage.raml
10561059
StagedQuoteSellerCommentSetMessage: !include message/StagedQuoteSellerCommentSetMessage.raml
@@ -1325,6 +1328,9 @@ ReturnInfoSetMessagePayload: !include message/payload/ReturnInfoSetMessagePayloa
13251328
ReviewCreatedMessagePayload: !include message/payload/ReviewCreatedMessagePayload.raml
13261329
ReviewRatingSetMessagePayload: !include message/payload/ReviewRatingSetMessagePayload.raml
13271330
ReviewStateTransitionMessagePayload: !include message/payload/ReviewStateTransitionMessagePayload.raml
1331+
ShoppingListLineItemAddedMessagePayload: !include message/payload/ShoppingListLineItemAddedMessagePayload.raml
1332+
ShoppingListLineItemRemovedMessagePayload: !include message/payload/ShoppingListLineItemRemovedMessagePayload.raml
1333+
ShoppingListMessagePayload: !include message/payload/ShoppingListMessagePayload.raml
13281334
ShoppingListStoreSetMessagePayload: !include message/payload/ShoppingListStoreSetMessagePayload.raml
13291335
StagedQuoteCreatedMessagePayload: !include message/payload/StagedQuoteCreatedMessagePayload.raml
13301336
StagedQuoteDeletedMessagePayload: !include message/payload/StagedQuoteDeletedMessagePayload.raml

0 commit comments

Comments
 (0)