Skip to content

Commit a80637e

Browse files
ct-sdks[bot]ct-sdks[bot]
committed
Updated API from documentation release
1 parent 103ed42 commit a80637e

File tree

9 files changed

+96
-104
lines changed

9 files changed

+96
-104
lines changed

‎api-specs/checkout/api.raml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
title: Checkout API
44
uses:
55
annotations: types/annotations.raml
6-
common: types/common.raml
6+
77
(annotations.products):
88
- Checkout
99
version: v1

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

Lines changed: 0 additions & 40 deletions
This file was deleted.

‎api-specs/checkout/types/common/Amount.raml‎

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): Common
3+
(annotations.beta): true
4+
displayName: Amount
5+
type: object
6+
description: |
7+
Money in cent amounts for a specific currency.
8+
properties:
9+
centAmount:
10+
type: integer
11+
description: |
12+
Amount in the smallest indivisible unit of a currency, such as:
13+
14+
* Cents for EUR and USD, pence for GBP, or centime for CHF (5 CHF is specified as `500`).
15+
* The value in the major unit for currencies without minor units, like JPY (5 JPY is specified as `5`).
16+
currencyCode:
17+
type: string
18+
description: |
19+
Currency code compliant to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).
20+
pattern: ^[A-Z]{3}$

‎api-specs/checkout/types/common/Region.raml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): Common
3+
(annotations.beta): true
4+
displayName: Region
5+
type: string
6+
description: |
7+
The Region in which the Checkout application is [hosted](/hosts-and-authorization).
8+
enum:
9+
- europe-west1.gcp
10+
- us-central1.gcp
11+
- australia-southeast1.gcp
12+
(annotations.enumDescriptions):
13+
europe-west1.gcp: |
14+
for Europe (Google Cloud, Belgium)
15+
us-central1.gcp: |
16+
for North America (Google Cloud, Iowa)
17+
australia-southeast1.gcp: |
18+
for Australia (Google Cloud, Sydney)

‎api-specs/checkout/types/payment-intents/PaymentIntentAction.raml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ properties:
1010
description: |
1111
Action to execute for the given [Payment](/../api/projects/payments#payment).
1212
amount?:
13-
type: common.Amount
13+
type: Amount
1414
description: |
1515
Amount to be captured or refunded.
1616
merchantReference?:

‎api-specs/checkout/types/payment-intents/PaymentIntentCaptureAction.raml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ properties:
1414
amount:
1515
description: |
1616
Amount to be captured. It must be less than or equal to the [authorized](/payments-lifecycle#authorization) amount.
17-
type: common.Amount
17+
type: Amount
1818
merchantReference?:
1919
type: string
2020
description: |

‎api-specs/checkout/types/payment-intents/PaymentIntentRefundAction.raml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ properties:
1414
amount:
1515
description: |
1616
Amount to be refunded. It must be less than or equal to the [captured](/payments-lifecycle#payment-capture) amount.
17-
type: common.Amount
17+
type: Amount
1818
merchantReference?:
1919
type: string
2020
description: |

‎api-specs/checkout/types/transactions/TransactionItemDraft.raml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ properties:
88
type: PaymentIntegrationResourceIdentifier
99
description: Resource Identifier of the [Payment Integration](/connectors-and-applications#payment-integrations) to use to execute the payment.
1010
amount?:
11-
type: common.Amount
11+
type: Amount
1212
description: Money value of the Transaction Item.

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

Lines changed: 53 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,51 @@
1-
# Responses
2-
ResponseMessage: !include responses/ResponseMessage.raml
3-
Message: !include responses/Message.raml
4-
ApplicationDeactivated: !include responses/ApplicationDeactivated.raml
1+
ApplicationReference: !include applications/ApplicationReference.raml
2+
ApplicationResourceIdentifier: !include applications/ApplicationResourceIdentifier.raml
3+
CartReference: !include coco/CartReference.raml
4+
CartResourceIdentifier: !include coco/CartResourceIdentifier.raml
5+
OrderReference: !include coco/OrderReference.raml
6+
OrderResourceIdentifier: !include coco/OrderResourceIdentifier.raml
7+
PaymentReference: !include coco/PaymentReference.raml
8+
PaymentResourceIdentifier: !include coco/PaymentResourceIdentifier.raml
9+
Reference: !include coco/Reference.raml
10+
ReferenceTypeId: !include coco/ReferenceTypeId.raml
11+
ResourceIdentifier: !include coco/ResourceIdentifier.raml
12+
Amount: !include common/Amount.raml
13+
Region: !include common/Region.raml
14+
ConnectorFailedError: !include error/ConnectorFailedError.raml
15+
ErrorObject: !include error/ErrorObject.raml
16+
GeneralError: !include error/GeneralError.raml
17+
InvalidInputError: !include error/InvalidInputError.raml
18+
InvalidJsonInputError: !include error/InvalidJsonInputError.raml
19+
MultipleActionsNotAllowedError: !include error/MultipleActionsNotAllowedError.raml
20+
PaymentFailureError: !include error/PaymentFailureError.raml
21+
RequiredFieldError: !include error/RequiredFieldError.raml
22+
ResourceNotFoundError: !include error/ResourceNotFoundError.raml
23+
PaymentIntegrationReference: !include payment-integrations/PaymentIntegrationReference.raml
24+
PaymentIntegrationResourceIdentifier: !include payment-integrations/PaymentIntegrationResourceIdentifier.raml
25+
PaymentIntent: !include payment-intents/PaymentIntent.raml
26+
PaymentIntentAction: !include payment-intents/PaymentIntentAction.raml
27+
PaymentIntentCancelAction: !include payment-intents/PaymentIntentCancelAction.raml
28+
PaymentIntentCaptureAction: !include payment-intents/PaymentIntentCaptureAction.raml
29+
PaymentIntentOperation: !include payment-intents/PaymentIntentOperation.raml
30+
PaymentIntentRefundAction: !include payment-intents/PaymentIntentRefundAction.raml
31+
PaymentIntentReverseAction: !include payment-intents/PaymentIntentReverseAction.raml
532
AddDiscountCodeError: !include responses/AddDiscountCodeError.raml
6-
DiscountCodeNotApplicable: !include responses/DiscountCodeNotApplicable.raml
7-
RemoveDiscountCodeError: !include responses/RemoveDiscountCodeError.raml
8-
NotApplicableDiscountCodeRemoved: !include responses/NotApplicableDiscountCodeRemoved.raml
33+
ApplicationDeactivated: !include responses/ApplicationDeactivated.raml
34+
BadInputData: !include responses/BadInputData.raml
935
CartEmptiedDuringCheckout: !include responses/CartEmptiedDuringCheckout.raml
1036
CartEmpty: !include responses/CartEmpty.raml
1137
CartNotFound: !include responses/CartNotFound.raml
38+
CartWithExistingPayment: !include responses/CartWithExistingPayment.raml
1239
CheckoutCancelled: !include responses/CheckoutCancelled.raml
1340
CheckoutCompleted: !include responses/CheckoutCompleted.raml
1441
CheckoutLoaded: !include responses/CheckoutLoaded.raml
1542
CheckoutStarted: !include responses/CheckoutStarted.raml
43+
ConnectorError: !include responses/ConnectorError.raml
44+
DeprecatedFields: !include responses/DeprecatedFields.raml
45+
DiscountCodeNotApplicable: !include responses/DiscountCodeNotApplicable.raml
46+
ErrorLoadingAllPaymentIntegrations: !include responses/ErrorLoadingAllPaymentIntegrations.raml
1647
ExpiredSession: !include responses/ExpiredSession.raml
48+
ExternalTermsAndConditionsPending: !include responses/ExternalTermsAndConditionsPending.raml
1749
FailedToRefreshSession: !include responses/FailedToRefreshSession.raml
1850
GiftCardBalanceError: !include responses/GiftCardBalanceError.raml
1951
GiftCardBalanceRemoved: !include responses/GiftCardBalanceRemoved.raml
@@ -22,87 +54,49 @@ GiftCardBalanceSuccess: !include responses/GiftCardBalanceSuccess.raml
2254
GiftCardRedeemError: !include responses/GiftCardRedeemError.raml
2355
GiftCardRedeemStarted: !include responses/GiftCardRedeemStarted.raml
2456
GiftCardRedeemSuccess: !include responses/GiftCardRedeemSuccess.raml
57+
InitError: !include responses/InitError.raml
2558
InitTimeout: !include responses/InitTimeout.raml
2659
InvalidLocale: !include responses/InvalidLocale.raml
2760
InvalidMode: !include responses/InvalidMode.raml
28-
BadInputData: !include responses/BadInputData.raml
61+
Message: !include responses/Message.raml
2962
MultipleVendorButtonContainers: !include responses/MultipleVendorButtonContainers.raml
3063
NoPaymentIntegrations: !include responses/NoPaymentIntegrations.raml
64+
NoShippingMethods: !include responses/NoShippingMethods.raml
65+
NonOrderableCartError: !include responses/NonOrderableCartError.raml
66+
NotApplicableDiscountCodeRemoved: !include responses/NotApplicableDiscountCodeRemoved.raml
67+
OrderCreated: !include responses/OrderCreated.raml
68+
OrderCreationError: !include responses/OrderCreationError.raml
69+
PaymentCancelled: !include responses/PaymentCancelled.raml
3170
PaymentFailed: !include responses/PaymentFailed.raml
32-
PaymentStarted: !include responses/PaymentStarted.raml
33-
InitError: !include responses/InitError.raml
34-
ConnectorError: !include responses/ConnectorError.raml
3571
PaymentIntegrationLoaded: !include responses/PaymentIntegrationLoaded.raml
3672
PaymentIntegrationLoading: !include responses/PaymentIntegrationLoading.raml
3773
PaymentIntegrationLoadingError: !include responses/PaymentIntegrationLoadingError.raml
74+
PaymentIntegrationNotAvailable: !include responses/PaymentIntegrationNotAvailable.raml
3875
PaymentIntegrationSelected: !include responses/PaymentIntegrationSelected.raml
3976
PaymentIntegrationSelectionConfirmation: !include responses/PaymentIntegrationSelectionConfirmation.raml
4077
PaymentIntegrationSelectionConfirmationFailed: !include responses/PaymentIntegrationSelectionConfirmationFailed.raml
4178
PaymentIntegrationsReceived: !include responses/PaymentIntegrationsReceived.raml
42-
PaymentIntegrationNotAvailable: !include responses/PaymentIntegrationNotAvailable.raml
43-
ErrorLoadingAllPaymentIntegrations: !include responses/ErrorLoadingAllPaymentIntegrations.raml
44-
PaymentCancelled: !include responses/PaymentCancelled.raml
79+
PaymentStarted: !include responses/PaymentStarted.raml
4580
PaymentValidationFailed: !include responses/PaymentValidationFailed.raml
4681
PaymentValidationPassed: !include responses/PaymentValidationPassed.raml
4782
PaymentValidationStarted: !include responses/PaymentValidationStarted.raml
4883
PaymentVerificationStarted: !include responses/PaymentVerificationStarted.raml
4984
PaymentVerificationTimeout: !include responses/PaymentVerificationTimeout.raml
50-
ExternalTermsAndConditionsPending: !include responses/ExternalTermsAndConditionsPending.raml
85+
ProjectIsDeactivated: !include responses/ProjectIsDeactivated.raml
86+
RemoveDiscountCodeError: !include responses/RemoveDiscountCodeError.raml
87+
ResponseMessage: !include responses/ResponseMessage.raml
5188
SetShippingAddressError: !include responses/SetShippingAddressError.raml
5289
ShippingAddressMissingError: !include responses/ShippingAddressMissingError.raml
5390
ShippingMethodDoesNotMatchCart: !include responses/ShippingMethodDoesNotMatchCart.raml
54-
NoShippingMethods: !include responses/NoShippingMethods.raml
5591
ShippingMethodSelected: !include responses/ShippingMethodSelected.raml
5692
ShippingMethodSelectionConfirmation: !include responses/ShippingMethodSelectionConfirmation.raml
57-
OrderCreated: !include responses/OrderCreated.raml
58-
ProjectIsDeactivated: !include responses/ProjectIsDeactivated.raml
5993
UnavailableLocale: !include responses/UnavailableLocale.raml
60-
DeprecatedFields: !include responses/DeprecatedFields.raml
61-
OrderCreationError: !include responses/OrderCreationError.raml
62-
CartWithExistingPayment: !include responses/CartWithExistingPayment.raml
63-
NonOrderableCartError: !include responses/NonOrderableCartError.raml
6494
UnsupportedCountry: !include responses/UnsupportedCountry.raml
6595
UpdatedFields: !include responses/UpdatedFields.raml
66-
67-
# CoCo
68-
ReferenceTypeId: !include coco/ReferenceTypeId.raml
69-
ResourceIdentifier: !include coco/ResourceIdentifier.raml
70-
CartResourceIdentifier: !include coco/CartResourceIdentifier.raml
71-
PaymentResourceIdentifier: !include coco/PaymentResourceIdentifier.raml
72-
OrderResourceIdentifier: !include coco/OrderResourceIdentifier.raml
73-
Reference: !include coco/Reference.raml
74-
CartReference: !include coco/CartReference.raml
75-
OrderReference: !include coco/OrderReference.raml
76-
PaymentReference: !include coco/PaymentReference.raml
77-
# Applications
78-
ApplicationReference: !include applications/ApplicationReference.raml
79-
ApplicationResourceIdentifier: !include applications/ApplicationResourceIdentifier.raml
80-
# Payment Integrations
81-
PaymentIntegrationReference: !include payment-integrations/PaymentIntegrationReference.raml
82-
PaymentIntegrationResourceIdentifier: !include payment-integrations/PaymentIntegrationResourceIdentifier.raml
83-
# transactions
84-
TransactionDraft: !include transactions/TransactionDraft.raml
8596
Transaction: !include transactions/Transaction.raml
97+
TransactionDraft: !include transactions/TransactionDraft.raml
8698
TransactionError: !include transactions/TransactionError.raml
8799
TransactionItem: !include transactions/TransactionItem.raml
88100
TransactionItemDraft: !include transactions/TransactionItemDraft.raml
89101
TransactionState: !include transactions/TransactionState.raml
90102
TransactionStatus: !include transactions/TransactionStatus.raml
91-
# Payment Intents
92-
PaymentIntentOperation: !include payment-intents/PaymentIntentOperation.raml
93-
PaymentIntentAction: !include payment-intents/PaymentIntentAction.raml
94-
PaymentIntentCaptureAction: !include payment-intents/PaymentIntentCaptureAction.raml
95-
PaymentIntentRefundAction: !include payment-intents/PaymentIntentRefundAction.raml
96-
PaymentIntentCancelAction: !include payment-intents/PaymentIntentCancelAction.raml
97-
PaymentIntentReverseAction: !include payment-intents/PaymentIntentReverseAction.raml
98-
PaymentIntent: !include payment-intents/PaymentIntent.raml
99-
# Payment Errors
100-
ErrorObject: !include error/ErrorObject.raml
101-
GeneralError: !include error/GeneralError.raml
102-
MultipleActionsNotAllowedError: !include error/MultipleActionsNotAllowedError.raml
103-
RequiredFieldError: !include error/RequiredFieldError.raml
104-
ResourceNotFoundError: !include error/ResourceNotFoundError.raml
105-
ConnectorFailedError: !include error/ConnectorFailedError.raml
106-
PaymentFailureError: !include error/PaymentFailureError.raml
107-
InvalidInputError: !include error/InvalidInputError.raml
108-
InvalidJsonInputError: !include error/InvalidJsonInputError.raml

0 commit comments

Comments
 (0)