{ "openapi": "3.1.0", "info": { "title": "Pactlyra API", "version": "1.0.0", "description": "The generated contract for every shipped /v1 route." }, "servers": [ { "url": "https://api.pactlyra.com" } ], "security": [ { "bearerAuth": [] } ], "paths": { "/v1/ai/assist": { "post": { "tags": [ "Ai" ], "summary": "Post ai/assist", "operationId": "post_ai_assist", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/ai/assist" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/ai/assist', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/ai/assist',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/ai/providers": { "get": { "tags": [ "Ai" ], "summary": "Get ai/providers", "operationId": "get_ai_providers", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/ai/providers" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/ai/providers', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/ai/providers',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/billing": { "get": { "tags": [ "Billing" ], "summary": "Get billing", "operationId": "get_billing", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/billing" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/billing', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/billing',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "put": { "tags": [ "Billing" ], "summary": "Put billing", "operationId": "put_billing", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X PUT -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/billing" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/billing', {\n method: 'PUT',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.put(\n 'https://api.pactlyra.com/v1/billing',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/billing/addons/ai": { "post": { "tags": [ "Billing" ], "summary": "Post billing/addons/ai", "operationId": "post_billing_addons_ai", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/billing/addons/ai" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/billing/addons/ai', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/billing/addons/ai',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/billing/catalogue": { "get": { "tags": [ "Billing" ], "summary": "Get billing/catalogue", "operationId": "get_billing_catalogue", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/billing/catalogue" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/billing/catalogue', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/billing/catalogue',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/billing/credits": { "post": { "tags": [ "Billing" ], "summary": "Post billing/credits", "operationId": "post_billing_credits", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/billing/credits" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/billing/credits', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/billing/credits',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/billing/portal": { "post": { "tags": [ "Billing" ], "summary": "Post billing/portal", "operationId": "post_billing_portal", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/billing/portal" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/billing/portal', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/billing/portal',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/billing/subscribe": { "post": { "tags": [ "Billing" ], "summary": "Post billing/subscribe", "operationId": "post_billing_subscribe", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/billing/subscribe" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/billing/subscribe', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/billing/subscribe',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/documents": { "get": { "tags": [ "Documents" ], "summary": "Get documents", "operationId": "get_documents", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/documents" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/documents', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/documents',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "post": { "tags": [ "Documents" ], "summary": "Post documents", "operationId": "post_documents", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "name": "agreement.pdf" } } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{\"name\":\"agreement.pdf\"}' https://api.pactlyra.com/v1/documents" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/documents', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({\n \"name\": \"agreement.pdf\"\n})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/documents',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={\"name\":\"agreement.pdf\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/documents/{id}/versions": { "post": { "tags": [ "Documents" ], "summary": "Post documents/:id/versions", "operationId": "post_documents_by_id_versions", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "content": "JVBERi0xLjcK" } } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{\"content\":\"JVBERi0xLjcK\"}' https://api.pactlyra.com/v1/documents/env_123/versions" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/documents/env_123/versions', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({\n \"content\": \"JVBERi0xLjcK\"\n})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/documents/env_123/versions',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={\"content\":\"JVBERi0xLjcK\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/embed/receipts/{code}": { "post": { "tags": [ "Embed" ], "summary": "Post embed/receipts/:code", "operationId": "post_embed_receipts_by_code", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" }, "example": "receipt_code" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/embed/receipts/receipt_code" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/embed/receipts/receipt_code', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/embed/receipts/receipt_code',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes": { "get": { "tags": [ "Envelopes" ], "summary": "Get envelopes", "operationId": "get_envelopes", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/envelopes" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/envelopes',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "post": { "tags": [ "Envelopes" ], "summary": "Post envelopes", "operationId": "post_envelopes", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "routing": "sequential" } } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{\"routing\":\"sequential\"}' https://api.pactlyra.com/v1/envelopes" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({\n \"routing\": \"sequential\"\n})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/envelopes',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={\"routing\":\"sequential\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes/{id}": { "get": { "tags": [ "Envelopes" ], "summary": "Get envelopes/:id", "operationId": "get_envelopes_by_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/envelopes/env_123" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/envelopes/env_123',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes/{id}/cost": { "get": { "tags": [ "Envelopes" ], "summary": "Get envelopes/:id/cost", "operationId": "get_envelopes_by_id_cost", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/envelopes/env_123/cost" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/cost', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/envelopes/env_123/cost',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes/{id}/document": { "get": { "tags": [ "Envelopes" ], "summary": "Get envelopes/:id/document", "operationId": "get_envelopes_by_id_document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/envelopes/env_123/document" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/document', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/envelopes/env_123/document',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes/{id}/documents": { "post": { "tags": [ "Envelopes" ], "summary": "Post envelopes/:id/documents", "operationId": "post_envelopes_by_id_documents", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "documentId": "doc_123", "versionId": "ver_123" } } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{\"documentId\":\"doc_123\",\"versionId\":\"ver_123\"}' https://api.pactlyra.com/v1/envelopes/env_123/documents" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/documents', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({\n \"documentId\": \"doc_123\",\n \"versionId\": \"ver_123\"\n})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/envelopes/env_123/documents',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={\"documentId\":\"doc_123\",\"versionId\":\"ver_123\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes/{id}/events": { "get": { "tags": [ "Envelopes" ], "summary": "Get envelopes/:id/events", "operationId": "get_envelopes_by_id_events", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/envelopes/env_123/events" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/events', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/envelopes/env_123/events',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes/{id}/evidence": { "get": { "tags": [ "Envelopes" ], "summary": "Get envelopes/:id/evidence", "operationId": "get_envelopes_by_id_evidence", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/envelopes/env_123/evidence" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/evidence', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/envelopes/env_123/evidence',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes/{id}/fields": { "post": { "tags": [ "Envelopes" ], "summary": "Post envelopes/:id/fields", "operationId": "post_envelopes_by_id_fields", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "type": "signature", "recipientId": "rec_123", "documentVersionId": "ver_123", "page": 1, "rect": { "x": 72, "y": 480, "width": 200, "height": 28 } } } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{\"type\":\"signature\",\"recipientId\":\"rec_123\",\"documentVersionId\":\"ver_123\",\"page\":1,\"rect\":{\"x\":72,\"y\":480,\"width\":200,\"height\":28}}' https://api.pactlyra.com/v1/envelopes/env_123/fields" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/fields', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({\n \"type\": \"signature\",\n \"recipientId\": \"rec_123\",\n \"documentVersionId\": \"ver_123\",\n \"page\": 1,\n \"rect\": {\n \"x\": 72,\n \"y\": 480,\n \"width\": 200,\n \"height\": 28\n }\n})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/envelopes/env_123/fields',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={\"type\":\"signature\",\"recipientId\":\"rec_123\",\"documentVersionId\":\"ver_123\",\"page\":1,\"rect\":{\"x\":72,\"y\":480,\"width\":200,\"height\":28}},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes/{id}/fields/{fieldId}": { "delete": { "tags": [ "Envelopes" ], "summary": "Delete envelopes/:id/fields/:fieldId", "operationId": "delete_envelopes_by_id_fields_by_fieldId", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "fld_123" } ], "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X DELETE -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/envelopes/env_123/fields/fld_123" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/fields/fld_123', {\n method: 'DELETE',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.delete(\n 'https://api.pactlyra.com/v1/envelopes/env_123/fields/fld_123',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes/{id}/payment": { "delete": { "tags": [ "Envelopes" ], "summary": "Delete envelopes/:id/payment", "operationId": "delete_envelopes_by_id_payment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X DELETE -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/envelopes/env_123/payment" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/payment', {\n method: 'DELETE',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.delete(\n 'https://api.pactlyra.com/v1/envelopes/env_123/payment',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "put": { "tags": [ "Envelopes" ], "summary": "Put envelopes/:id/payment", "operationId": "put_envelopes_by_id_payment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X PUT -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/envelopes/env_123/payment" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/payment', {\n method: 'PUT',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.put(\n 'https://api.pactlyra.com/v1/envelopes/env_123/payment',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes/{id}/prepare": { "post": { "tags": [ "Envelopes" ], "summary": "Post envelopes/:id/prepare", "operationId": "post_envelopes_by_id_prepare", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/envelopes/env_123/prepare" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/prepare', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/envelopes/env_123/prepare',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes/{id}/recipients": { "post": { "tags": [ "Envelopes" ], "summary": "Post envelopes/:id/recipients", "operationId": "post_envelopes_by_id_recipients", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "email": "signer@example.com", "role": "signer", "authLevel": "basic" } } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{\"email\":\"signer@example.com\",\"role\":\"signer\",\"authLevel\":\"basic\"}' https://api.pactlyra.com/v1/envelopes/env_123/recipients" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/recipients', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({\n \"email\": \"signer@example.com\",\n \"role\": \"signer\",\n \"authLevel\": \"basic\"\n})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/envelopes/env_123/recipients',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={\"email\":\"signer@example.com\",\"role\":\"signer\",\"authLevel\":\"basic\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes/{id}/recipients/{recipientId}/condition": { "delete": { "tags": [ "Envelopes" ], "summary": "Delete envelopes/:id/recipients/:recipientId/condition", "operationId": "delete_envelopes_by_id_recipients_by_recipientId_condition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" }, { "name": "recipientId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "rec_123" } ], "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X DELETE -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/condition" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/condition', {\n method: 'DELETE',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.delete(\n 'https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/condition',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "put": { "tags": [ "Envelopes" ], "summary": "Put envelopes/:id/recipients/:recipientId/condition", "operationId": "put_envelopes_by_id_recipients_by_recipientId_condition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" }, { "name": "recipientId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "rec_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X PUT -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/condition" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/condition', {\n method: 'PUT',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.put(\n 'https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/condition',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes/{id}/recipients/{recipientId}/copy": { "post": { "tags": [ "Envelopes" ], "summary": "Post envelopes/:id/recipients/:recipientId/copy", "operationId": "post_envelopes_by_id_recipients_by_recipientId_copy", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" }, { "name": "recipientId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "rec_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/copy" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/copy', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/copy',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes/{id}/recipients/{recipientId}/embed": { "post": { "tags": [ "Envelopes" ], "summary": "Post envelopes/:id/recipients/:recipientId/embed", "operationId": "post_envelopes_by_id_recipients_by_recipientId_embed", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" }, { "name": "recipientId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "rec_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/embed" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/embed', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/embed',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes/{id}/recipients/{recipientId}/resend": { "post": { "tags": [ "Envelopes" ], "summary": "Post envelopes/:id/recipients/:recipientId/resend", "operationId": "post_envelopes_by_id_recipients_by_recipientId_resend", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" }, { "name": "recipientId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "rec_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/resend" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/resend', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/envelopes/env_123/recipients/rec_123/resend',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes/{id}/reminders": { "put": { "tags": [ "Envelopes" ], "summary": "Put envelopes/:id/reminders", "operationId": "put_envelopes_by_id_reminders", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X PUT -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/envelopes/env_123/reminders" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/reminders', {\n method: 'PUT',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.put(\n 'https://api.pactlyra.com/v1/envelopes/env_123/reminders',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes/{id}/send": { "post": { "tags": [ "Envelopes" ], "summary": "Post envelopes/:id/send", "operationId": "post_envelopes_by_id_send", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/envelopes/env_123/send" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/send', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/envelopes/env_123/send',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/envelopes/{id}/void": { "post": { "tags": [ "Envelopes" ], "summary": "Post envelopes/:id/void", "operationId": "post_envelopes_by_id_void", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/envelopes/env_123/void" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/envelopes/env_123/void', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/envelopes/env_123/void',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/forms": { "get": { "tags": [ "Forms" ], "summary": "Get forms", "operationId": "get_forms", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/forms" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/forms', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/forms',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "post": { "tags": [ "Forms" ], "summary": "Post forms", "operationId": "post_forms", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/forms" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/forms', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/forms',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/forms/{id}": { "delete": { "tags": [ "Forms" ], "summary": "Delete forms/:id", "operationId": "delete_forms_by_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X DELETE -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/forms/env_123" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/forms/env_123', {\n method: 'DELETE',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.delete(\n 'https://api.pactlyra.com/v1/forms/env_123',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "get": { "tags": [ "Forms" ], "summary": "Get forms/:id", "operationId": "get_forms_by_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/forms/env_123" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/forms/env_123', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/forms/env_123',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "put": { "tags": [ "Forms" ], "summary": "Put forms/:id", "operationId": "put_forms_by_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X PUT -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/forms/env_123" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/forms/env_123', {\n method: 'PUT',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.put(\n 'https://api.pactlyra.com/v1/forms/env_123',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/health": { "get": { "tags": [ "Health" ], "summary": "Get health", "operationId": "get_health", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/health" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/health', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/health',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/keys": { "get": { "tags": [ "Keys" ], "summary": "Get keys", "operationId": "get_keys", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/keys" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/keys', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/keys',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "post": { "tags": [ "Keys" ], "summary": "Post keys", "operationId": "post_keys", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/keys" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/keys', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/keys',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/keys/{id}": { "delete": { "tags": [ "Keys" ], "summary": "Delete keys/:id", "operationId": "delete_keys_by_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X DELETE -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/keys/env_123" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/keys/env_123', {\n method: 'DELETE',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.delete(\n 'https://api.pactlyra.com/v1/keys/env_123',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/pay/{token}": { "get": { "tags": [ "Pay" ], "summary": "Get pay/:token", "operationId": "get_pay_by_token", "security": [], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "example": "link_token" } ], "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET https://api.pactlyra.com/v1/pay/link_token" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/pay/link_token', {\n method: 'GET',\n headers: {}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/pay/link_token',\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/pay/{token}/checkout": { "post": { "tags": [ "Pay" ], "summary": "Post pay/:token/checkout", "operationId": "post_pay_by_token_checkout", "security": [], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "example": "link_token" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/pay/link_token/checkout" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/pay/link_token/checkout', {\n method: 'POST',\n headers: {\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/pay/link_token/checkout',\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/payment-account": { "delete": { "tags": [ "Payment Account" ], "summary": "Delete payment-account", "operationId": "delete_payment_account", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X DELETE -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/payment-account" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/payment-account', {\n method: 'DELETE',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.delete(\n 'https://api.pactlyra.com/v1/payment-account',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "get": { "tags": [ "Payment Account" ], "summary": "Get payment-account", "operationId": "get_payment_account", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/payment-account" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/payment-account', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/payment-account',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "put": { "tags": [ "Payment Account" ], "summary": "Put payment-account", "operationId": "put_payment_account", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X PUT -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/payment-account" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/payment-account', {\n method: 'PUT',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.put(\n 'https://api.pactlyra.com/v1/payment-account',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/sandbox": { "get": { "tags": [ "Sandbox" ], "summary": "Get sandbox", "operationId": "get_sandbox", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/sandbox" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/sandbox', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/sandbox',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "post": { "tags": [ "Sandbox" ], "summary": "Post sandbox", "operationId": "post_sandbox", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "name": "Test workspace" } } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{\"name\":\"Test workspace\"}' https://api.pactlyra.com/v1/sandbox" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/sandbox', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({\n \"name\": \"Test workspace\"\n})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/sandbox',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={\"name\":\"Test workspace\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/sandbox/keys": { "post": { "tags": [ "Sandbox" ], "summary": "Post sandbox/keys", "operationId": "post_sandbox_keys", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "label": "quickstart" } } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Content-Type: application/json\" --data '{\"label\":\"quickstart\"}' https://api.pactlyra.com/v1/sandbox/keys" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/sandbox/keys', {\n method: 'POST',\n headers: {\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({\n \"label\": \"quickstart\"\n})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/sandbox/keys',\n json={\"label\":\"quickstart\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/sandbox/messages": { "delete": { "tags": [ "Sandbox" ], "summary": "Delete sandbox/messages", "operationId": "delete_sandbox_messages", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X DELETE -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/sandbox/messages" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/sandbox/messages', {\n method: 'DELETE',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.delete(\n 'https://api.pactlyra.com/v1/sandbox/messages',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "get": { "tags": [ "Sandbox" ], "summary": "Get sandbox/messages", "operationId": "get_sandbox_messages", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/sandbox/messages" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/sandbox/messages', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/sandbox/messages',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/sign/{token}": { "get": { "tags": [ "Sign" ], "summary": "Get sign/:token", "operationId": "get_sign_by_token", "security": [], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "example": "link_token" } ], "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET https://api.pactlyra.com/v1/sign/link_token" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/sign/link_token', {\n method: 'GET',\n headers: {}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/sign/link_token',\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/sign/{token}/challenge": { "post": { "tags": [ "Sign" ], "summary": "Post sign/:token/challenge", "operationId": "post_sign_by_token_challenge", "security": [], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "example": "link_token" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/sign/link_token/challenge" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/sign/link_token/challenge', {\n method: 'POST',\n headers: {\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/sign/link_token/challenge',\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/sign/{token}/complete": { "post": { "tags": [ "Sign" ], "summary": "Post sign/:token/complete", "operationId": "post_sign_by_token_complete", "security": [], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "example": "link_token" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/sign/link_token/complete" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/sign/link_token/complete', {\n method: 'POST',\n headers: {\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/sign/link_token/complete',\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/sign/{token}/consent": { "post": { "tags": [ "Sign" ], "summary": "Post sign/:token/consent", "operationId": "post_sign_by_token_consent", "security": [], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "example": "link_token" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/sign/link_token/consent" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/sign/link_token/consent', {\n method: 'POST',\n headers: {\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/sign/link_token/consent',\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/sign/{token}/decline": { "post": { "tags": [ "Sign" ], "summary": "Post sign/:token/decline", "operationId": "post_sign_by_token_decline", "security": [], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "example": "link_token" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/sign/link_token/decline" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/sign/link_token/decline', {\n method: 'POST',\n headers: {\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/sign/link_token/decline',\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/sign/{token}/fields/{fieldId}": { "post": { "tags": [ "Sign" ], "summary": "Post sign/:token/fields/:fieldId", "operationId": "post_sign_by_token_fields_by_fieldId", "security": [], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "example": "link_token" }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "fld_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/sign/link_token/fields/fld_123" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/sign/link_token/fields/fld_123', {\n method: 'POST',\n headers: {\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/sign/link_token/fields/fld_123',\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/sign/{token}/verify": { "post": { "tags": [ "Sign" ], "summary": "Post sign/:token/verify", "operationId": "post_sign_by_token_verify", "security": [], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "example": "link_token" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/sign/link_token/verify" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/sign/link_token/verify', {\n method: 'POST',\n headers: {\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/sign/link_token/verify',\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/sign/{token}/view": { "post": { "tags": [ "Sign" ], "summary": "Post sign/:token/view", "operationId": "post_sign_by_token_view", "security": [], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" }, "example": "link_token" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/sign/link_token/view" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/sign/link_token/view', {\n method: 'POST',\n headers: {\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/sign/link_token/view',\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/storage": { "delete": { "tags": [ "Storage" ], "summary": "Delete storage", "operationId": "delete_storage", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X DELETE -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/storage" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/storage', {\n method: 'DELETE',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.delete(\n 'https://api.pactlyra.com/v1/storage',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "get": { "tags": [ "Storage" ], "summary": "Get storage", "operationId": "get_storage", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/storage" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/storage', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/storage',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "put": { "tags": [ "Storage" ], "summary": "Put storage", "operationId": "put_storage", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X PUT -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/storage" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/storage', {\n method: 'PUT',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.put(\n 'https://api.pactlyra.com/v1/storage',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/suppressions": { "get": { "tags": [ "Suppressions" ], "summary": "Get suppressions", "operationId": "get_suppressions", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/suppressions" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/suppressions', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/suppressions',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/suppressions/{email}": { "delete": { "tags": [ "Suppressions" ], "summary": "Delete suppressions/:email", "operationId": "delete_suppressions_by_email", "parameters": [ { "name": "email", "in": "path", "required": true, "schema": { "type": "string" }, "example": "person@example.com" } ], "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X DELETE -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/suppressions/person@example.com" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/suppressions/person@example.com', {\n method: 'DELETE',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.delete(\n 'https://api.pactlyra.com/v1/suppressions/person@example.com',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/templates": { "get": { "tags": [ "Templates" ], "summary": "Get templates", "operationId": "get_templates", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/templates" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/templates', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/templates',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "post": { "tags": [ "Templates" ], "summary": "Post templates", "operationId": "post_templates", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/templates" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/templates', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/templates',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/templates/{id}": { "delete": { "tags": [ "Templates" ], "summary": "Delete templates/:id", "operationId": "delete_templates_by_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X DELETE -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/templates/env_123" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/templates/env_123', {\n method: 'DELETE',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.delete(\n 'https://api.pactlyra.com/v1/templates/env_123',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "get": { "tags": [ "Templates" ], "summary": "Get templates/:id", "operationId": "get_templates_by_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/templates/env_123" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/templates/env_123', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/templates/env_123',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "put": { "tags": [ "Templates" ], "summary": "Put templates/:id", "operationId": "put_templates_by_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X PUT -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/templates/env_123" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/templates/env_123', {\n method: 'PUT',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.put(\n 'https://api.pactlyra.com/v1/templates/env_123',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/templates/{id}/envelopes": { "post": { "tags": [ "Templates" ], "summary": "Post templates/:id/envelopes", "operationId": "post_templates_by_id_envelopes", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/templates/env_123/envelopes" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/templates/env_123/envelopes', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/templates/env_123/envelopes',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/templates/{id}/roles/{key}": { "put": { "tags": [ "Templates" ], "summary": "Put templates/:id/roles/:key", "operationId": "put_templates_by_id_roles_by_key", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" }, { "name": "key", "in": "path", "required": true, "schema": { "type": "string" }, "example": "key_value" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X PUT -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/templates/env_123/roles/key_value" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/templates/env_123/roles/key_value', {\n method: 'PUT',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.put(\n 'https://api.pactlyra.com/v1/templates/env_123/roles/key_value',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/tickets": { "get": { "tags": [ "Tickets" ], "summary": "Get tickets", "operationId": "get_tickets", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/tickets" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/tickets', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/tickets',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "post": { "tags": [ "Tickets" ], "summary": "Post tickets", "operationId": "post_tickets", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/tickets" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/tickets', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/tickets',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/usage": { "get": { "tags": [ "Usage" ], "summary": "Get usage", "operationId": "get_usage", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/usage" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/usage', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/usage',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/usage/limit": { "put": { "tags": [ "Usage" ], "summary": "Put usage/limit", "operationId": "put_usage_limit", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X PUT -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/usage/limit" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/usage/limit', {\n method: 'PUT',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.put(\n 'https://api.pactlyra.com/v1/usage/limit',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/webhooks": { "get": { "tags": [ "Webhooks" ], "summary": "Get webhooks", "operationId": "get_webhooks", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/webhooks" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/webhooks', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/webhooks',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "post": { "tags": [ "Webhooks" ], "summary": "Post webhooks", "operationId": "post_webhooks", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "url": "https://example.com/pactlyra", "events": [ "envelope.completed" ] } } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{\"url\":\"https://example.com/pactlyra\",\"events\":[\"envelope.completed\"]}' https://api.pactlyra.com/v1/webhooks" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/webhooks', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({\n \"url\": \"https://example.com/pactlyra\",\n \"events\": [\n \"envelope.completed\"\n ]\n})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/webhooks',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={\"url\":\"https://example.com/pactlyra\",\"events\":[\"envelope.completed\"]},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/webhooks/{id}": { "delete": { "tags": [ "Webhooks" ], "summary": "Delete webhooks/:id", "operationId": "delete_webhooks_by_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X DELETE -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/webhooks/env_123" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/webhooks/env_123', {\n method: 'DELETE',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.delete(\n 'https://api.pactlyra.com/v1/webhooks/env_123',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/webhooks/{id}/enable": { "post": { "tags": [ "Webhooks" ], "summary": "Post webhooks/:id/enable", "operationId": "post_webhooks_by_id_enable", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "example": "env_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/webhooks/env_123/enable" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/webhooks/env_123/enable', {\n method: 'POST',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/webhooks/env_123/enable',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/webhooks/mail/{provider}": { "post": { "tags": [ "Webhooks" ], "summary": "Post webhooks/mail/:provider", "operationId": "post_webhooks_mail_by_provider", "security": [], "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" }, "example": "postmark" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/webhooks/mail/postmark" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/webhooks/mail/postmark', {\n method: 'POST',\n headers: {\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/webhooks/mail/postmark',\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/webhooks/payments/{workspaceId}": { "post": { "tags": [ "Webhooks" ], "summary": "Post webhooks/payments/:workspaceId", "operationId": "post_webhooks_payments_by_workspaceId", "security": [], "parameters": [ { "name": "workspaceId", "in": "path", "required": true, "schema": { "type": "string" }, "example": "ws_123" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/webhooks/payments/ws_123" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/webhooks/payments/ws_123', {\n method: 'POST',\n headers: {\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/webhooks/payments/ws_123',\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/webhooks/stripe": { "post": { "tags": [ "Webhooks" ], "summary": "Post webhooks/stripe", "operationId": "post_webhooks_stripe", "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X POST -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/webhooks/stripe" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/webhooks/stripe', {\n method: 'POST',\n headers: {\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.post(\n 'https://api.pactlyra.com/v1/webhooks/stripe',\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/workspace/embedding": { "get": { "tags": [ "Workspace" ], "summary": "Get workspace/embedding", "operationId": "get_workspace_embedding", "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X GET -H \"Authorization: Bearer $PACTLYRA_API_KEY\" https://api.pactlyra.com/v1/workspace/embedding" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/workspace/embedding', {\n method: 'GET',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`\n}\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.get(\n 'https://api.pactlyra.com/v1/workspace/embedding',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] }, "put": { "tags": [ "Workspace" ], "summary": "Put workspace/embedding", "operationId": "put_workspace_embedding", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X PUT -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/workspace/embedding" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/workspace/embedding', {\n method: 'PUT',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.put(\n 'https://api.pactlyra.com/v1/workspace/embedding',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } }, "/v1/workspace/notifications": { "put": { "tags": [ "Workspace" ], "summary": "Put workspace/notifications", "operationId": "put_workspace_notifications", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": {} } } }, "responses": { "200": { "description": "Request completed." }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "429": { "$ref": "#/components/responses/RateLimited" } }, "x-codeSamples": [ { "lang": "Curl", "source": "curl --fail-with-body -sS -X PUT -H \"Authorization: Bearer $PACTLYRA_API_KEY\" -H \"Content-Type: application/json\" --data '{}' https://api.pactlyra.com/v1/workspace/notifications" }, { "lang": "JavaScript", "source": "const response = await fetch('https://api.pactlyra.com/v1/workspace/notifications', {\n method: 'PUT',\n headers: {\n \"Authorization\": `Bearer ${process.env.PACTLYRA_API_KEY}`,\n \"Content-Type\": \"application/json\"\n},\n body: JSON.stringify({})\n});\nif (!response.ok) throw new Error(await response.text());\nconsole.log(await response.json());" }, { "lang": "Python", "source": "import os, requests\nresponse = requests.put(\n 'https://api.pactlyra.com/v1/workspace/notifications',\n headers={'Authorization': f\"Bearer {os.environ['PACTLYRA_API_KEY']}\"},\n json={},\n timeout=30,\n)\nresponse.raise_for_status()\nprint(response.json())" } ] } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "pk_test_ or pk_live_" } }, "schemas": { "Error": { "type": "object", "required": [ "error", "message", "requestId" ], "properties": { "error": { "type": "string", "example": "invalid_input" }, "message": { "type": "string" }, "detail": { "type": "object", "additionalProperties": true }, "requestId": { "type": "string", "example": "req_a1b2c3d4e5f6" } } } }, "responses": { "BadRequest": { "description": "Invalid request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Unauthorized": { "description": "Authentication required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "RateLimited": { "description": "Rate limited. Retry after the number of seconds in Retry-After.", "headers": { "Retry-After": { "schema": { "type": "integer" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }