Skip to content

Commit

Permalink
Merge branch 'master' into deprecation-offer-management
Browse files Browse the repository at this point in the history
  • Loading branch information
@anabaarbosa
anabaarbosa authored Oct 17, 2024
2 parents 1b83d28 + 6cfbcf6 commit 4b0f311
Show file tree
Hide file tree
Showing 38 changed files with 29,945 additions and 20,771 deletions.
2 changes: 1 addition & 1 deletion .spectral.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ rules:
then:
function: pattern
functionOptions:
match: "^[A-Z](?:[a-z0-9 ]*(?:VTEX|TEX|DO|ID|JSON|)|(|OAuth|Customer Credit|CMS|appKey|appToken|-|,|API|DKIM|SKU|SLA|'))*[a-z0-9 ]*$"
match: "^[A-Z](?:[a-z0-9 ]*(?:VTEX|TEX|DO|ID|JSON|)|(|OAuth|Customer Credit|CMS|appKey|appToken|-|,|API|DKIM|SKU|SLA|Change order|'))*[a-z0-9 ]*$"

no-empty-descriptions:
description: No empty descriptions allowed. Make sure that this description is a valid string that does not start with a line break (\n or \r). If this description is inside an example, please fill it with a valid value.
Expand Down
72 changes: 36 additions & 36 deletions PostmanCollections/VTEX - Antifraud Provider API.json
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
{
"_": {
"postman_id": "78ffe0da-da8d-44ba-ae20-ed7a8a1472e3"
"postman_id": "18cfb68d-7778-420d-bb3b-19e47b8d03d9"
},
"item": [
{
"id": "c4702ac1-e626-447c-9dff-d1321221c58c",
"id": "0069de79-3a2c-410d-9d4d-a52d3d6d60c2",
"name": "Anti-fraud Flow",
"description": {
"content": "",
"type": "text/plain"
},
"item": [
{
"id": "6df4582c-4bc0-49c3-b139-94d78b768758",
"id": "50030a5f-f1a7-46b8-870c-beb77b859dbd",
"name": "Send anti-fraud pre-analysis data (optional)",
"request": {
"name": "Send anti-fraud pre-analysis data (optional)",
Expand Down Expand Up @@ -113,7 +113,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "edd9399f-d417-4370-b9de-2402ae44f580",
"id": "b50d39f8-0b70-46f9-8008-02f7b5596770",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -208,7 +208,7 @@
{
"listen": "test",
"script": {
"id": "347f5f8c-3fd1-415c-a890-e412989b71b7",
"id": "bf7e5b3c-0e11-4943-8aee-84e6d82aad6c",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[POST]::/pre-analysis - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -224,7 +224,7 @@
}
},
{
"id": "18b42d31-b025-4bb0-9f2f-dcff7b6f12c4",
"id": "154f9eed-6e03-43d5-a378-f9dfa9395d94",
"name": "Send anti-fraud data",
"request": {
"name": "Send anti-fraud data",
Expand Down Expand Up @@ -325,7 +325,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "772fe3b5-afd2-4824-a37e-16aeacbaadcf",
"id": "fb8ba722-f04e-4211-ba6c-0032408cf133",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -420,7 +420,7 @@
{
"listen": "test",
"script": {
"id": "57c6c214-48f3-424f-82b3-5b1e56541402",
"id": "34fea2c7-9608-4d93-a226-89361e5ae2f8",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[POST]::/transactions - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -436,7 +436,7 @@
}
},
{
"id": "7c404f1e-cb5c-4232-b5a9-0d2d34ed2789",
"id": "a4667d73-cd7e-4702-8e30-aef901059362",
"name": "Update anti-fraud transactions (optional)",
"request": {
"name": "Update anti-fraud transactions (optional)",
Expand Down Expand Up @@ -553,7 +553,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "7482fcfa-e3ef-4e27-aae7-43e0a3bd2a50",
"id": "9d04b05d-04fc-4976-8e96-cc07eec3f335",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -649,7 +649,7 @@
{
"listen": "test",
"script": {
"id": "f3cb5e2b-01d5-4f0c-bd39-818091ad54a1",
"id": "a075f361-117a-4388-ab39-2c94c9481f20",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[PUT]::/transactions/:transactionId - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -665,7 +665,7 @@
}
},
{
"id": "d4ad6394-9bc9-45c1-a89a-e42d23f9def5",
"id": "a83177d0-7b15-4079-9995-f7b957adbe5b",
"name": "List anti-fraud provider manifest",
"request": {
"name": "List anti-fraud provider manifest",
Expand Down Expand Up @@ -715,7 +715,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "73e050d2-0718-471a-8f01-3971a5d71970",
"id": "791e0b72-89c1-46e6-bbed-5966f926c5dd",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -763,21 +763,21 @@
"value": "application/json"
}
],
"body": "{\n \"cardholderDocument\": \"required\",\n \"customFields\": [\n {\n \"name\": \"ApiKey\",\n \"type\": \"text\"\n },\n {\n \"name\": \"AnalysisLocation\",\n \"type\": \"select\",\n \"options\": [\n {\n \"text\": \"MEX\",\n \"value\": \"Latin America\"\n },\n {\n \"text\": \"USA\",\n \"value\": \"United States\"\n }\n ]\n }\n ]\n}",
"body": "{\n \"cardholderDocument\": \"required\",\n \"allowAntifraudOnGiftCard\": true,\n \"customFields\": [\n {\n \"name\": \"AnalysisMode\",\n \"type\": \"text\"\n },\n {\n \"name\": \"Client secret\",\n \"type\": \"password\"\n },\n {\n \"name\": \"AnalysisLocation\",\n \"type\": \"select\",\n \"options\": [\n {\n \"text\": \"MEX\",\n \"value\": \"Latin America\"\n },\n {\n \"text\": \"USA\",\n \"value\": \"United States\"\n }\n ]\n }\n ]\n}",
"cookie": []
}
],
"event": [
{
"listen": "test",
"script": {
"id": "a4445531-4831-4453-84eb-2e0d2c975086",
"id": "a36d0930-29df-46d8-b28f-dbb5728bdcd5",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/manifest - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
"// Validate if response header has matching content-type\npm.test(\"[GET]::/manifest - Content-Type is application/json\", function () {\n pm.expect(pm.response.headers.get(\"Content-Type\")).to.include(\"application/json\");\n});\n",
"// Validate if response has JSON Body \npm.test(\"[GET]::/manifest - Response has JSON Body\", function () {\n pm.response.to.have.jsonBody();\n});\n",
"// Response Validation\nconst schema = {\"required\":[\"customFields\"],\"type\":\"object\",\"description\":\"Custom fields information.\",\"properties\":{\"cardholderDocument\":{\"type\":\"string\",\"description\":\"Indicates the requirement of cardholder document in card transactions. The field has three possible values: `required`, `optional`, or `unused`.\"},\"customFields\":{\"type\":\"array\",\"description\":\"Custom fields information.\",\"items\":{\"type\":\"object\",\"description\":\"Item information.\",\"additionalProperties\":true,\"properties\":{}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/manifest - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n"
"// Response Validation\nconst schema = {\"required\":[\"customFields\"],\"type\":\"object\",\"description\":\"Custom fields information.\",\"properties\":{\"cardholderDocument\":{\"type\":\"string\",\"description\":\"Indicates the requirement of cardholder document in card transactions. The field has three possible values: `required`, `optional`, or `unused`.\"},\"allowAntifraudOnGiftCard\":{\"type\":\"boolean\",\"description\":\"Indicates whether the anti-fraud provider can process payment transactions made using gift cards.\"},\"customFields\":{\"type\":\"array\",\"description\":\"Describes the customized fields supported by the connector.\",\"items\":{\"type\":\"object\",\"description\":\"Custom fields information.\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Custom field name.\"},\"type\":{\"type\":\"string\",\"description\":\"Custom field type. Sensitive or security data should be defined as `password`.\",\"enum\":[\"text\",\"password\",\"select\"]},\"options\":{\"type\":\"array\",\"description\":\"In case of `select` type, the possible params are `text` and `value`.\",\"items\":{\"type\":\"object\",\"description\":\"Custom field information.\",\"properties\":{\"text\":{\"type\":\"string\",\"description\":\"Custom field description.\"},\"value\":{\"type\":\"string\",\"description\":\"Custom field value.\"}}}}}}}}}\n\n// Validate if response matches JSON schema \npm.test(\"[GET]::/manifest - Schema is valid\", function() {\n pm.response.to.have.jsonSchema(schema,{unknownFormats: [\"int32\", \"int64\", \"float\", \"double\"]});\n});\n"
]
}
}
Expand All @@ -787,7 +787,7 @@
}
},
{
"id": "316ddd05-3329-4755-be9e-e30e36fe2944",
"id": "8ed1d9e3-8253-4881-9782-e45ddd26372e",
"name": "Get anti-fraud status",
"request": {
"name": "Get anti-fraud status",
Expand Down Expand Up @@ -891,7 +891,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "4d88c125-6c74-44cc-82be-e0cd277ce0bf",
"id": "d25fd4b9-40da-416e-9765-16b690a494e6",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -974,7 +974,7 @@
{
"listen": "test",
"script": {
"id": "5f99f699-532b-40ac-bfa4-6a0f37affc50",
"id": "fbcd603e-d5bb-4b63-9e23-33e9497cbd98",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/transactions/:transactions.id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -990,7 +990,7 @@
}
},
{
"id": "6dfc7e93-6c72-4491-8941-72135b37c862",
"id": "b3e6ed15-1a76-4b73-9762-c8b5810cb110",
"name": "Stop anti-fraud analysis (optional)",
"request": {
"name": "Stop anti-fraud analysis (optional)",
Expand Down Expand Up @@ -1094,7 +1094,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "0d0fcc4e-42d4-4654-a327-41283d08dfc7",
"id": "70ffc9c7-7927-4fe3-aad7-d2c886edce14",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1177,7 +1177,7 @@
{
"listen": "test",
"script": {
"id": "e49a4f83-49d2-4da5-a898-aa1747d0bb72",
"id": "0b36d805-b8c3-4cde-abac-d2a0dc8edc4c",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[DELETE]::/transactions/:transactions.Id - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -1196,15 +1196,15 @@
"event": []
},
{
"id": "2dc338aa-360c-4347-93e7-758cc717e2e0",
"id": "4fabcf4b-bef9-46c6-b448-57781a1e8a25",
"name": "OAuth Flow",
"description": {
"content": "",
"type": "text/plain"
},
"item": [
{
"id": "c7188b4b-4f43-4bb9-a36e-a99638113f0f",
"id": "6e9a5ad7-3faf-41c6-9e37-60dd0f69a1cb",
"name": "1. Retrieve token",
"request": {
"name": "1. Retrieve token",
Expand Down Expand Up @@ -1306,7 +1306,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "d47e9da9-e1d3-44ad-af61-961f6fc09679",
"id": "63b60b62-c6fa-421f-bd0d-26940f4874be",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1402,7 +1402,7 @@
{
"listen": "test",
"script": {
"id": "5f1ac783-b5d8-43c3-9b60-256fed6ed25d",
"id": "5836a4f3-33cf-4e7c-93e8-e21f00cad9a9",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[POST]::/authorization/token - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand All @@ -1418,7 +1418,7 @@
}
},
{
"id": "464005bf-101b-4326-8bd1-3f3b6cd8b374",
"id": "1bec7005-85de-447d-8e4c-84ab66d14104",
"name": "2. Redirect",
"request": {
"name": "2. Redirect",
Expand Down Expand Up @@ -1521,7 +1521,7 @@
"_": {
"postman_previewlanguage": "text"
},
"id": "938d44fe-1cee-4cf4-9ce7-125b95379789",
"id": "dea0ed0b-f7c7-458f-85c3-e1ba02ec0535",
"name": "OK. This endpoint does not return any data in the response body.",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1612,7 +1612,7 @@
{
"listen": "test",
"script": {
"id": "38498704-1d10-4847-b2dd-a39c8ad23875",
"id": "d7a1a395-0df6-49d5-9eec-64aeda2c6886",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/redirect - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n"
Expand All @@ -1625,7 +1625,7 @@
}
},
{
"id": "7a466759-ab17-48f3-801b-6142aa63197e",
"id": "72935870-653f-4bc4-8833-4899f42cf8ae",
"name": "3. Return to VTEX",
"request": {
"name": "3. Return to VTEX",
Expand Down Expand Up @@ -1701,7 +1701,7 @@
"_": {
"postman_previewlanguage": "text"
},
"id": "143439da-614a-43d4-9605-7fa1565f9c42",
"id": "2b3a1ee5-a9a5-408c-8d2d-d712066082f7",
"name": "OK. This endpoint does not return any data in the response body.",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1765,7 +1765,7 @@
{
"listen": "test",
"script": {
"id": "df9c03b5-6a7d-48cf-b151-c5078bf43556",
"id": "5fe24823-182e-45a0-8e0d-e06587eb144c",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/authorizationCode - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n"
Expand All @@ -1778,7 +1778,7 @@
}
},
{
"id": "687ebcfa-7e9f-460a-9f2d-616384e55417",
"id": "7bb6adee-d43a-4ab2-8c26-7d2cecca52c9",
"name": "4. Get credentials",
"request": {
"name": "4. Get credentials",
Expand Down Expand Up @@ -1868,7 +1868,7 @@
"_": {
"postman_previewlanguage": "json"
},
"id": "6c5716a1-4628-4fa2-abcd-b2ae9f0f01bb",
"id": "5f27fcb3-107a-4239-9222-1836c1da7450",
"name": "OK",
"originalRequest": {
"url": {
Expand Down Expand Up @@ -1952,7 +1952,7 @@
{
"listen": "test",
"script": {
"id": "876bebd4-9b4a-4d00-a7ce-0b498e516f39",
"id": "5e003f42-9c67-49ae-88c9-e43246c99679",
"type": "text/javascript",
"exec": [
"// Validate status 2xx \npm.test(\"[GET]::/authorization/credentials - Status code is 2xx\", function () {\n pm.response.to.be.success;\n});\n",
Expand Down Expand Up @@ -1985,7 +1985,7 @@
}
],
"info": {
"_postman_id": "78ffe0da-da8d-44ba-ae20-ed7a8a1472e3",
"_postman_id": "18cfb68d-7778-420d-bb3b-19e47b8d03d9",
"name": "Anti-fraud Provider API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"description": {
Expand Down
Loading

0 comments on commit 4b0f311

Please sign in to comment.