Skip to content

Commit de47ebf

Browse files
committed
Updated API from documentation release
1 parent 33d20f6 commit de47ebf

File tree

8 files changed

+150
-0
lines changed

8 files changed

+150
-0
lines changed
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): responses
3+
type: Message
4+
displayName: GiftCardBalanceError
5+
discriminatorValue: gift_card_balance_error
6+
description: |
7+
Generated when an error occurs while retrieving the balance of a gift card.
8+
properties:
9+
code:
10+
type: string
11+
description:
12+
severity:
13+
type: string
14+
description: \`error`
15+
message:
16+
type: string
17+
description: Gift card balance failed.
18+
correlationId:
19+
type: string
20+
description: Unique identifier of the event.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): responses
3+
type: Message
4+
displayName: GiftCardBalanceRemoved
5+
discriminatorValue: gift_card_balance_removed
6+
description: |
7+
Generated when the customer removes a gift card's balance that was initially applied as a payment method.
8+
properties:
9+
code:
10+
type: string
11+
description:
12+
severity:
13+
type: string
14+
description: \`info`
15+
message:
16+
type: string
17+
description: Gift card balance removed.
18+
correlationId:
19+
type: string
20+
description: Unique identifier of the event.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): responses
3+
type: Message
4+
displayName: GiftCardBalanceStarted
5+
discriminatorValue: gift_card_balance_started
6+
description: |
7+
Generated when the customer enters the gift card's code for the payment, and Checkout initiates the retrieving of the gift card's balance.
8+
properties:
9+
code:
10+
type: string
11+
description:
12+
severity:
13+
type: string
14+
description: \`info`
15+
message:
16+
type: string
17+
description: Gift card balance started.
18+
correlationId:
19+
type: string
20+
description: Unique identifier of the event.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): responses
3+
type: ResponseMessage
4+
displayName: GiftCardBalanceSuccess
5+
discriminatorValue: gift_card_balance_success
6+
description: |
7+
Generated when Checkout successfully retrieves a gift card's balance.
8+
properties:
9+
code:
10+
type: string
11+
description:
12+
severity:
13+
type: string
14+
description: \`info`
15+
message:
16+
type: string
17+
description: Gift card balance started.
18+
correlationId:
19+
type: string
20+
description: Unique identifier of the event.
21+
payload:
22+
type: object
23+
description: Contains the `amount` and `isBalanceSufficient` properties.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): responses
3+
type: Message
4+
displayName: GiftCardRedeemError
5+
discriminatorValue: gift_card_redeem_error
6+
description: |
7+
Generated when the redemption of a gift card's balance fails.
8+
properties:
9+
code:
10+
type: string
11+
description:
12+
severity:
13+
type: string
14+
description: \`error`
15+
message:
16+
type: string
17+
description: Gift card redeem failed.
18+
correlationId:
19+
type: string
20+
description: Unique identifier of the event.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): responses
3+
type: Message
4+
displayName: GiftCardRedeemStarted
5+
discriminatorValue: gift_card_redeem_started
6+
description: |
7+
Generated when the customer confirms the payment by gift card and Checkout initiates the redemption of the gift card's balance.
8+
properties:
9+
code:
10+
type: string
11+
description:
12+
severity:
13+
type: string
14+
description: \`info`
15+
message:
16+
type: string
17+
description: Gift card redeem started.
18+
correlationId:
19+
type: string
20+
description: Unique identifier of the event.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): responses
3+
type: Message
4+
displayName: GiftCardRedeemSuccess
5+
discriminatorValue: gift_card_redeem_success
6+
description: |
7+
Generated when the redemption of a gift card's balance is successful.
8+
properties:
9+
code:
10+
type: string
11+
description:
12+
severity:
13+
type: string
14+
description: \`info`
15+
message:
16+
type: string
17+
description: Gift card redeem success.
18+
correlationId:
19+
type: string
20+
description: Unique identifier of the event.

api-specs/checkout/types/types.raml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@ CheckoutLoaded: !include responses/CheckoutLoaded.raml
1515
CheckoutStarted: !include responses/CheckoutStarted.raml
1616
ExpiredSession: !include responses/ExpiredSession.raml
1717
FailedToRefreshSession: !include responses/FailedToRefreshSession.raml
18+
GiftCardBalanceError: !include responses/GiftCardBalanceError.raml
19+
GiftCardBalanceRemoved: !include responses/GiftCardBalanceRemoved.raml
20+
GiftCardBalanceStarted: !include responses/GiftCardBalanceStarted.raml
21+
GiftCardBalanceSuccess: !include responses/GiftCardBalanceSuccess.raml
22+
GiftCardRedeemError: !include responses/GiftCardRedeemError.raml
23+
GiftCardRedeemStarted: !include responses/GiftCardRedeemStarted.raml
24+
GiftCardRedeemSuccess: !include responses/GiftCardRedeemSuccess.raml
1825
InitTimeout: !include responses/InitTimeout.raml
1926
InvalidLocale: !include responses/InvalidLocale.raml
2027
InvalidMode: !include responses/InvalidMode.raml

0 commit comments

Comments
 (0)