Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update List all gift cards endpoint description #1351

Merged
merged 3 commits into from
Oct 24, 2024
Merged

Update List all gift cards endpoint description #1351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
17c1c82
Update List all gift cards endpoint description
ricardoaerobr Oct 24, 2024
db97117
Update generated files by portman
Oct 24, 2024
0c6d75c
Update VTEX - Giftcard Provider Protocol.json
ricardoaerobr Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 38 additions & 38 deletions PostmanCollections/VTEX - Giftcard Provider Protocol.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
{
"_": {
"postman_id": "e618919e-bebf-446f-a80c-79ea6d4eafce"
"postman_id": "878cf2c5-924c-4225-917d-c8a4a49cc47f"
},
"item": [
{
"id": "ef4341d1-91b3-4cc1-af78-6e7e7de85b1f",
"id": "045d328d-9661-4e3b-822b-f3676e99bf82",
"name": "Gift Cards",
"description": {
"content": "",
"type": "text/plain"
},
"item": [
{
"id": "fdc78d82-e361-4e01-954d-2c671d4f35ed",
"id": "8f55a60d-43bd-44f6-b612-5a85db837118",
"name": "List all gift cards",
"request": {
"name": "List all gift cards",
"description": {
"content": "Returns a list of all gift cards available from a gift card provider for a specific customer's cart.\r\n\r\n> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.",
"content": " Returns a list of all gift cards available from a gift card provider for a specific customer's cart.\r\n\r\nFor scenarios in which there is a gift card with no balance associated with the customer, the payment provider must choose one of the options below to display the information in the response body and implement it on the endpoint:\n\r\n\r1. **Response body returns the complete gift card data mentioning the balance field equal to 0** (`\"balance\": 0`): In this option, whenever the customer has associated a gift card without a balance, they will need to log in to the store to access the balance information.\n\r2. **The response body only returns an empty array** (`[]`): The customer does not need to log in to the store to access balance information when they have a gift card with no balance associated with it.\n\r\n\r> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.",
"type": "text/plain"
},
"url": {
Expand Down Expand Up @@ -85,7 +85,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "4fde8129-3c53-443b-a73b-eb4d842b666b",
"id": "b6bea191-d7cb-4cc7-908d-009990592fbc",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -172,7 +172,7 @@
{
"listen": "test",
"script": {
"id": "b8d7ad27-3e6f-4eb4-a5df-4204a55fa849",
"id": "552f0979-8c46-4453-8ce2-33347606c040",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[POST]::/giftcards/_search - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -188,7 +188,7 @@
}
},
{
"id": "1db8ceee-fb12-432c-964c-d7986197634f",
"id": "ff2368fe-f0c0-4704-b156-099f55079943",
"name": "Get a gift card by ID",
"request": {
"name": "Get a gift card by ID",
Expand Down Expand Up @@ -250,7 +250,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "f5b6e125-f1a0-4169-b67b-01fbbefe4ca4",
"id": "d7a77904-6c0f-471a-a935-ee8c94061e6f",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -315,7 +315,7 @@
{
"listen": "test",
"script": {
"id": "0926a62b-691c-493e-a274-21077d24d411",
"id": "43fd065f-bbc6-4a06-ab0a-ca71707e58c6",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/giftcards/:giftCardId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -331,7 +331,7 @@
}
},
{
"id": "0207b12f-399d-42f2-8779-d3640f705e07",
"id": "0acb23a0-7c68-4331-bdf4-ac2b97844b80",
"name": "Create a gift card",
"request": {
"name": "Create a gift card",
Expand Down Expand Up @@ -394,7 +394,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "8b3fa1fd-4448-4bea-8fef-9a7fe21f2c9b",
"id": "1dda3ba9-2d28-4006-9776-8897703d2d26",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -471,7 +471,7 @@
{
"listen": "test",
"script": {
"id": "2ae05f5c-1ca7-4786-b64e-7d2f26543c87",
"id": "b676c530-a21a-4d56-ad40-7cf02ae52390",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[POST]::/giftcards - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -490,15 +490,15 @@
"event": []
},
{
"id": "b3878978-6691-4608-b892-05356c7224b3",
"id": "fee4d6f4-de9a-4217-bef6-c81503324da5",
"name": "Transactions",
"description": {
"content": "",
"type": "text/plain"
},
"item": [
{
"id": "94dbf175-c074-4612-91ed-7c4d7c6b79d4",
"id": "77182f44-2b0b-4d0b-bffd-f1e00d3a0c05",
"name": "Create a gift card transaction",
"request": {
"name": "Create a gift card transaction",
Expand Down Expand Up @@ -574,7 +574,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "a52340a8-1727-4833-bcc6-f17058482c42",
"id": "8cdf2e88-9538-4caa-a343-ea4eefb9a17b",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -653,7 +653,7 @@
{
"listen": "test",
"script": {
"id": "e5c01a3d-48e7-4c03-9d78-29cfd50b6837",
"id": "68e9397e-8e46-4558-a91c-aa82bd6e1d77",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[POST]::/giftcards/:giftCardId/transactions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -669,7 +669,7 @@
}
},
{
"id": "ede53929-8b01-4b2a-a513-195ee4900b77",
"id": "7cc14fac-43bc-4f77-95cf-15124f292d5f",
"name": "List all gift card transactions",
"request": {
"name": "List all gift card transactions",
Expand Down Expand Up @@ -732,7 +732,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "8b371642-acc2-47d7-9c3a-7424d71350f4",
"id": "2f21bc05-2af8-4354-885a-74f9df2ba00f",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -798,7 +798,7 @@
{
"listen": "test",
"script": {
"id": "f2bb5c4b-d97c-4491-86f5-9079df822f3d",
"id": "9ba785f2-fb25-4552-8ea6-cf8c627b5c5e",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/giftcards/:giftCardId/transactions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -814,7 +814,7 @@
}
},
{
"id": "83ba2a1d-bc19-4463-a924-60c1d6772669",
"id": "5d0c6fc0-0c3a-4a79-ac67-3a4c3e63d050",
"name": "Get a gift card transaction by ID",
"request": {
"name": "Get a gift card transaction by ID",
Expand Down Expand Up @@ -888,7 +888,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "4b32d0f3-2f14-458e-a715-b24d513a1d3f",
"id": "5418f77c-dccd-4e4e-b7f3-3f83e8ceb92d",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -955,7 +955,7 @@
{
"listen": "test",
"script": {
"id": "903b8481-b7ac-4a0f-83f1-5b717cfc8021",
"id": "063084b6-7761-40e4-b2a7-61b4a216ba51",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/giftcards/:giftCardId/transactions/:transactionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -971,7 +971,7 @@
}
},
{
"id": "8d304ccf-195d-4721-9021-b71da616736c",
"id": "80c006cd-12b6-44cc-9c28-af687b13d34a",
"name": "Get a gift card transaction authorization",
"request": {
"name": "Get a gift card transaction authorization",
Expand Down Expand Up @@ -1046,7 +1046,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "d2bf3b8e-ea99-4006-938c-1a8736c438f9",
"id": "b53481a0-1ef2-443f-b732-d84cc3a0e6c4",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1114,7 +1114,7 @@
{
"listen": "test",
"script": {
"id": "ea13aaed-8da5-438c-8159-0dbc2cbaf20d",
"id": "53537f3c-274a-4c7e-8b5d-016db983a29a",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/giftcards/:giftCardId/transactions/:transactionId/authorization - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -1130,7 +1130,7 @@
}
},
{
"id": "a36f02c6-6f8d-4d40-ba2a-94f2e227040c",
"id": "e4685abf-051d-46cc-af3f-330d349a9490",
"name": "Cancel a gift card transaction",
"request": {
"name": "Cancel a gift card transaction",
Expand Down Expand Up @@ -1218,7 +1218,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "459693ef-6976-44d5-8aee-c13e9ceb06c7",
"id": "e88a2447-0d26-4489-91fc-01e9fa4cf52a",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1299,7 +1299,7 @@
{
"listen": "test",
"script": {
"id": "59a2e8e0-e07d-4a02-a412-2a18e3ac97e0",
"id": "c0d5b24b-2c6d-493d-99ba-3d8f5212c738",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[POST]::/giftcards/:giftCardId/transactions/:transactionId/cancellations - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -1315,7 +1315,7 @@
}
},
{
"id": "dcc05994-717b-44fb-8e0b-94a4ca94b172",
"id": "b540acee-c30d-435a-a392-03ea6fa1bdd5",
"name": "List all gift card transactions cancellations",
"request": {
"name": "List all gift card transactions cancellations",
Expand Down Expand Up @@ -1390,7 +1390,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "053480d5-6847-4b87-a817-d64768d388b3",
"id": "97830b7a-6363-4af8-8864-172e10d02843",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1458,7 +1458,7 @@
{
"listen": "test",
"script": {
"id": "a6d619eb-ee32-4454-9259-237e19b5aeee",
"id": "884594cf-2d0c-4cd3-a60e-2c62a319c3cc",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/giftcards/:giftCardId/transactions/:transactionId/cancellations - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -1474,7 +1474,7 @@
}
},
{
"id": "f5ceea62-2ad8-4a26-8c3c-d4ca2cf09608",
"id": "b31f5a8e-33dc-4340-a687-939a13a6af46",
"name": "Settle a gift card transaction",
"request": {
"name": "Settle a gift card transaction",
Expand Down Expand Up @@ -1562,7 +1562,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "f6153195-45ca-4f00-92e4-f00949b3abaf",
"id": "c781f808-8bc0-4860-8d66-45f6acdbc8c1",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1643,7 +1643,7 @@
{
"listen": "test",
"script": {
"id": "9866ad3c-fc48-4e21-a1f5-7ed00f5592aa",
"id": "25bc4463-1758-41d3-978c-1a38466b79ad",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[POST]::/giftcards/:giftCardId/transactions/:tId/settlements - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -1659,7 +1659,7 @@
}
},
{
"id": "c91db7d8-5859-4956-84e2-a5d2d0537a25",
"id": "745156bd-0520-4605-abc4-28d5ec0f0562",
"name": "List all gift card transactions settlements",
"request": {
"name": "List all gift card transactions settlements",
Expand Down Expand Up @@ -1734,7 +1734,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "94e16a9a-e3d1-4c2e-a72f-c45a47222f04",
"id": "98739437-d16b-4c5e-8aef-7aa6fe7d6215",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1802,7 +1802,7 @@
{
"listen": "test",
"script": {
"id": "8bb2f30b-9836-4f50-bc92-4fa4cfcc0ad7",
"id": "1e7aa006-5d90-4d28-8b2f-944cfe939069",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/giftcards/:giftCardId/transactions/:tId/settlements - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand Down Expand Up @@ -1855,7 +1855,7 @@
}
],
"info": {
"_postman_id": "e618919e-bebf-446f-a80c-79ea6d4eafce",
"_postman_id": "878cf2c5-924c-4225-917d-c8a4a49cc47f",
"name": "Giftcard Provider Protocol",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"description": {
Expand Down
2 changes: 1 addition & 1 deletion VTEX - Giftcard Provider Protocol.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"Gift Cards"
],
"summary": "List all gift cards",
"description": "Returns a list of all gift cards available from a gift card provider for a specific customer's cart.\r\n\r\n> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.",
"description": " Returns a list of all gift cards available from a gift card provider for a specific customer's cart.\r\n\r\nFor scenarios in which there is a gift card with no balance associated with the customer, the payment provider must choose one of the options below to display the information in the response body and implement it on the endpoint:\n\r\n\r- Response body returns the complete gift card data mentioning the balance field equal to 0 (`\"balance\": 0`): In this option, whenever the customer has associated a gift card without a balance, they will need to log in to the store to access the balance information.\n\r- The response body only returns an empty array (`[]`): The customer does not need to log in to the store to access balance information when they have a gift card with no balance associated with it.\n\r\n\r> ℹ️ This request is made from VTEX to the gift card payment provider.\r\n\r\n## Permissions\r\n\r\nCheck with your service provider to know what permissions are needed.",
"operationId": "ListAllGiftCards",
"parameters": [
{
Expand Down
Loading