Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

🌿 ✨ [Scheduled] Update API Spec #64

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

🌿 ✨ [Scheduled] Update API Spec #64

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
20e2067
feat(openapi): add support for Bridge API key authentication
fern-api[bot] Oct 15, 2024
1e47be7
feat(openapi.json): added support for Treezor payment gateway
fern-api[bot] Oct 16, 2024
8c3af9d
fix(openapi): Add delete operation for transformations and update ret…
fern-api[bot] Oct 22, 2024
00339b7
feat(openapi.json): add support for Praxis payment provider
fern-api[bot] Oct 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
180 changes: 179 additions & 1 deletion openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1662,6 +1662,7 @@
"HMAC",
"BASIC_AUTH",
"API_KEY",
"BRIDGE",
"CLOUDSIGNAL",
"COURIER",
"FRONTAPP",
Expand Down Expand Up @@ -1719,7 +1720,9 @@
"RAZORPAY",
"MAILCHIMP",
"PADDLE",
"PAYPAL"
"PAYPAL",
"TREEZOR",
"PRAXIS"
]
},
"IntegrationFeature": {
Expand Down Expand Up @@ -2982,6 +2985,40 @@
"additionalProperties": false,
"x-docs-type": "API Key"
},
"VerificationBridgeConfigs": {
"type": "object",
"properties": {
"public_key": {
"type": "string"
}
},
"required": [
"public_key"
],
"additionalProperties": false,
"description": "The verification configs for Bridge. Only included if the ?include=verification.configs query param is present",
"x-docs-type": "BridgeConfigs"
},
"VerificationBridge": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"bridge",
"BRIDGE"
]
},
"configs": {
"$ref": "#/components/schemas/VerificationBridgeConfigs"
}
},
"required": [
"type"
],
"additionalProperties": false,
"x-docs-type": "Bridge"
},
"VerificationCloudSignalConfigs": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -4975,6 +5012,74 @@
"additionalProperties": false,
"x-docs-type": "Paypal"
},
"VerificationTreezorConfigs": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"description": "The verification configs for Treezor. Only included if the ?include=verification.configs query param is present",
"x-docs-type": "TreezorConfigs"
},
"VerificationTreezor": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"treezor",
"TREEZOR"
]
},
"configs": {
"$ref": "#/components/schemas/VerificationTreezorConfigs"
}
},
"required": [
"type"
],
"additionalProperties": false,
"x-docs-type": "Treezor"
},
"VerificationPraxisConfigs": {
"type": "object",
"properties": {
"webhook_secret_key": {
"type": "string"
}
},
"required": [
"webhook_secret_key"
],
"additionalProperties": false,
"description": "The verification configs for Praxis. Only included if the ?include=verification.configs query param is present",
"x-docs-type": "PraxisConfigs"
},
"VerificationPraxis": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"praxis",
"PRAXIS"
]
},
"configs": {
"$ref": "#/components/schemas/VerificationPraxisConfigs"
}
},
"required": [
"type"
],
"additionalProperties": false,
"x-docs-type": "Praxis"
},
"VerificationConfig": {
"oneOf": [
{
Expand All @@ -4986,6 +5091,9 @@
{
"$ref": "#/components/schemas/VerificationAPIKey"
},
{
"$ref": "#/components/schemas/VerificationBridge"
},
{
"$ref": "#/components/schemas/VerificationCloudSignal"
},
Expand Down Expand Up @@ -5159,6 +5267,12 @@
},
{
"$ref": "#/components/schemas/VerificationPaypal"
},
{
"$ref": "#/components/schemas/VerificationTreezor"
},
{
"$ref": "#/components/schemas/VerificationPraxis"
}
],
"nullable": true,
Expand Down Expand Up @@ -5693,6 +5807,17 @@
"type": "integer",
"nullable": true,
"description": "Maximum number of retries to attempt"
},
"response_status_codes": {
"type": "array",
"items": {
"type": "string",
"pattern": "^(?:([2-5]\\d{2})-([2-5]\\d{2})|([><=]{1,2})([2-5]\\d{2})|!?([2-5]\\d{2}))$"
},
"minItems": 1,
"maxItems": 10,
"nullable": true,
"description": "HTTP codes to retry on. Accepts: range expressions (e.g., \"400-499\", \">400\"), specific codes (e.g., 404), and exclusions (e.g., \"!401\"). Example: [\"500-599\", \">400\", 404, \"!401\"]"
}
},
"required": [
Expand Down Expand Up @@ -16047,6 +16172,59 @@
"x-fern-sdk-group-name": "transformation",
"x-fern-sdk-method-name": "retrieve"
},
"delete": {
"operationId": "deleteTransformation",
"summary": "Delete a transformation",
"description": "",
"tags": [
"Transformations"
],
"responses": {
"200": {
"description": "An object with deleted transformation id",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID of the Transformation"
}
},
"required": [
"id"
],
"additionalProperties": false
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "id",
"schema": {
"type": "string",
"description": "Transformation ID"
},
"required": true
}
],
"x-fern-sdk-group-name": "transformation",
"x-fern-sdk-method-name": "delete"
},
"put": {
"operationId": "updateTransformation",
"summary": "Update a transformation",
Expand Down