From f1b506768893193d7918effa9d5e75cc6a11d48f Mon Sep 17 00:00:00 2001 From: Majid Abbasi Date: Thu, 27 Jun 2024 11:06:40 +0200 Subject: [PATCH 1/2] fixed the readme links --- README.md | 37 +++++++++++++++++++------------------ package-lock.json | 4 ++-- package.json | 2 +- 3 files changed, 22 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index b497d74..4bb63d4 100644 --- a/README.md +++ b/README.md @@ -7,29 +7,29 @@ In here we explain how to use the client app and get payment methods to work. Each payment component takes a set of props that will be the same for everything. They are as follows: - **createPaymentUrl**: `string` - _POST_-Request - we get a [_CreatePaymentResponse_](src/types/index.ts) + _POST_-Request - we get a [_CreatePaymentResponse_](https://github.com/mediaopt/paypal-commercetools-client/blob/main/src/types/index.ts) It is **your** responsibility to develop this API The url that gets called to the endpoint of the connect app to create a payment in commercetools. Communicates with commercetools backend See the examples in our [CoFe integration example repository](https://github.com/mediaopt/paypal-commercetools-cofe-integration/blob/main/packages/poc/backend/payment-paypal/actionControllers/PayPalController.ts) - **getSettingsUrl**: `string` - _POST_-Request - we get a [_GetSettingsResponse_](src/types/index.ts) + _POST_-Request - we get a [_GetSettingsResponse_](https://github.com/mediaopt/paypal-commercetools-client/blob/main/src/types/index.ts) It is **your** responsibility to develop this API The url that gets called to the endpoint of the connect app to get settings of PayPal in commercetools. Communicates with commercetools backend See the examples in our [CoFe integration example repository](https://github.com/mediaopt/paypal-commercetools-cofe-integration/blob/main/packages/poc/backend/payment-paypal/actionControllers/PayPalController.ts) - **createOrderUrl**: `string` - _POST_-Request - we get a [_CreateOrderResponse_](src/types/index.ts) + _POST_-Request - we get a [_CreateOrderResponse_](https://github.com/mediaopt/paypal-commercetools-client/blob/main/src/types/index.ts) It is **your** responsibility to develop this API The url that gets called to the endpoint of the connect app to create a PayPal order in commercetools. Communicates with commercetools backend See the examples in our [CoFe integration example repository](https://github.com/mediaopt/paypal-commercetools-cofe-integration/blob/main/packages/poc/backend/payment-paypal/actionControllers/PayPalController.ts) - **onApproveUrl**: `string` - _POST_-Request - we get a [_OnApproveResponse_](src/types/index.ts) + _POST_-Request - we get a [_OnApproveResponse_](https://github.com/mediaopt/paypal-commercetools-client/blob/main/src/types/index.ts) It is **your** responsibility to develop this API The url that gets called to the endpoint of the connect app to capture a PayPal order in commercetools. Communicates with commercetools backend See the examples in our [CoFe integration example repository](https://github.com/mediaopt/paypal-commercetools-cofe-integration/blob/main/packages/poc/backend/payment-paypal/actionControllers/PayPalController.ts) - **onApproveRedirectionUrl**: `string` If you want to redirect to a page in onApprove step then set it to this property. It is useful for the `buy now` process and its review page. - **authorizeOrderUrl**: `string` - _POST_-Request - we get a [_OnApproveResponse_](src/types/index.ts) + _POST_-Request - we get a [_OnApproveResponse_](https://github.com/mediaopt/paypal-commercetools-client/blob/main/src/types/index.ts) It is **your** responsibility to develop this API The url that gets called to the endpoint of the connect app to authorize a PayPal order in commercetools. Communicates with commercetools backend See the examples in our [CoFe integration example repository](https://github.com/mediaopt/paypal-commercetools-cofe-integration/blob/main/packages/poc/backend/payment-paypal/actionControllers/PayPalController.ts) @@ -86,7 +86,7 @@ These properties are used when you want to set up vaulting during purchase. Set `true` if you want to enable vaulting in the payment method. - **getUserInfoUrl**: `string` - _POST_-Request - we get a [_GetUserInfoResponse_](src/types/index.ts) + _POST_-Request - we get a [_GetUserInfoResponse_](https://github.com/mediaopt/paypal-commercetools-client/blob/main/src/types/index.ts) It is **your** responsibility to develop this API The URL that gets called to the endpoint of the connect app to get some information related to vaulting for the logged-in user. Communicates with commercetools backend See the examples in our [CoFe integration example repository](https://github.com/mediaopt/paypal-commercetools-cofe-integration/blob/main/packages/poc/backend/payment-paypal/actionControllers/PayPalController.ts) @@ -96,13 +96,13 @@ These properties are used when you want to set up vaulting during purchase. In addition to `Vaulting properties` we have the following properties to vault for purchase later. - **createVaultSetupTokenUrl**: `string` - _POST_-Request - we get a [_CreateVaultSetupTokenResponse_](src/types/index.ts) + _POST_-Request - we get a [_CreateVaultSetupTokenResponse_](https://github.com/mediaopt/paypal-commercetools-client/blob/main/src/types/index.ts) It is **your** responsibility to develop this API The URL that gets called to the endpoint of the connect app to create a vault setup token for the logged-in user. Communicates with commercetools backend See the examples in our [CoFe integration example repository](https://github.com/mediaopt/paypal-commercetools-cofe-integration/blob/main/packages/poc/backend/payment-paypal/actionControllers/PayPalController.ts) - **approveVaultSetupTokenUrl**: `string` - _POST_-Request - we get a [_ApproveVaultSetupTokenResponse_](src/types/index.ts) + _POST_-Request - we get a [_ApproveVaultSetupTokenResponse_](https://github.com/mediaopt/paypal-commercetools-client/blob/main/src/types/index.ts) It is **your** responsibility to develop this API The URL that gets called to the endpoint of the connect app to approve a vault setup token for the logged-in user. Communicates with commercetools backend See the examples in our [CoFe integration example repository](https://github.com/mediaopt/paypal-commercetools-cofe-integration/blob/main/packages/poc/backend/payment-paypal/actionControllers/PayPalController.ts) @@ -127,23 +127,24 @@ PayPal messages props are based on PayPalMessages props and you can see them on - **applePayDisplayName**: `string` Name of your store. - ### GooglePay + Have a look at [Googles specification](https://developers.google.com/pay/api/web/reference/request-objects) for a detailed explanation of the options + - **environment**: `string` - "TEST" or "PRODUCTION"; + "TEST" or "PRODUCTION"; - **allowedCardNetworks**: `string[]` - One or more card networks that you support, also supported by the Google Pay API. + One or more card networks that you support, also supported by the Google Pay API. - **allowedCardAuthMethods**: `string` - "PAN_ONLY" (cards on file) and "CRYPTOGRAM_3DS" (Android powered device token) + "PAN_ONLY" (cards on file) and "CRYPTOGRAM_3DS" (Android powered device token) - **callbackIntents**: `string[]` - Specifies intents for PaymentDataCallback + Specifies intents for PaymentDataCallback - **apiVersion**: `number` - Major API version + Major API version - **apiVersionMinor**: `number` - Minor API version + Minor API version - **totalPriceStatus**: `string` - "FINAL" or "ESTIMATED" + "FINAL" or "ESTIMATED" - **buttonColor**: `string` - **buttonType**: `string` - **buttonRadius**: `number` @@ -162,7 +163,7 @@ Have a look at [Googles specification](https://developers.google.com/pay/api/web HostedFields are deprecated; CardFields is the preferred way to use advanced card payments. - **getClientTokenUrl**: `string` - _POST_-Request - we get a [_ClientTokenResponse_](src/types/index.ts) + _POST_-Request - we get a [_ClientTokenResponse_](https://github.com/mediaopt/paypal-commercetools-client/blob/main/src/types/index.ts) It is **your** responsibility to develop this API The URL that gets called to the endpoint of the connect app to get the client token to use in PayPalHostedFieldsProvider component in commercetools. Communicates with commercetools backend See the examples in our [CoFe integration example repository](https://github.com/mediaopt/paypal-commercetools-cofe-integration/blob/main/packages/poc/backend/payment-paypal/actionControllers/PayPalController.ts) @@ -174,7 +175,7 @@ If you want to get a list of vaulted payments you can use this component. It wil You need to pass properties that are mentioned in the `Vaulting properties` section and also pass the following specific property. - **removePaymentTokenUrl**: `string` - _POST_-Request - we get a [_GetUserInfoResponse_](src/types/index.ts) + _POST_-Request - we get a [_GetUserInfoResponse_](https://github.com/mediaopt/paypal-commercetools-client/blob/main/src/types/index.ts) It is **your** responsibility to develop this API The URL that gets called to the endpoint of the connect app to remove a `Payment Token` in the PaymentTokens component in commercetools. Communicates with commercetools backend See the examples in our [CoFe integration example repository](https://github.com/mediaopt/paypal-commercetools-cofe-integration/blob/main/packages/poc/backend/payment-paypal/actionControllers/PayPalController.ts) diff --git a/package-lock.json b/package-lock.json index 199a809..b24fb14 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "paypal-commercetools-client", - "version": "0.1.34", + "version": "0.1.35", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "paypal-commercetools-client", - "version": "0.1.34", + "version": "0.1.35", "license": "MIT", "dependencies": { "@heroicons/react": "^1.0.6", diff --git a/package.json b/package.json index 3b61a70..05b9465 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "paypal-commercetools-client", - "version": "0.1.34", + "version": "0.1.35", "private": false, "type": "module", "license": "MIT", From bad1ece8bf4d84987a4b285dda66eaa8f920a364 Mon Sep 17 00:00:00 2001 From: Majid Abbasi Date: Thu, 27 Jun 2024 11:22:18 +0200 Subject: [PATCH 2/2] fixed a typo in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4bb63d4..34f6b14 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,7 @@ PayPal messages props are based on PayPalMessages props and you can see them on ### GooglePay -Have a look at [Googles specification](https://developers.google.com/pay/api/web/reference/request-objects) for a detailed explanation of the options +Have a look at [Google's specification](https://developers.google.com/pay/api/web/reference/request-objects) for a detailed explanation of the options - **environment**: `string` "TEST" or "PRODUCTION";