From 93d18f14c6905b8e344360fb3c9d4ba928b5f5f4 Mon Sep 17 00:00:00 2001 From: dphuang2 Date: Fri, 29 Mar 2024 15:33:30 -0700 Subject: [PATCH] yarn pages --- generator/konfig-docs/redirects.json | 2 + .../konfig-docs/src/pages/sdk/categories.json | 5 + .../src/pages/sdk/category/translation.tsx | 5 + .../konfig-docs/src/pages/sdk/companies.json | 224 + .../src/pages/sdk/finley/index.tsx | 69 + .../sdk/finley/typescript/_first-request.mdx | 7 + .../finley/typescript/_getting-started.mdx | 5 + .../src/pages/sdk/finley/typescript/index.tsx | 569 ++ .../src/pages/sdk/finshark/index.tsx | 79 + .../finshark/typescript/_first-request.mdx | 4 + .../finshark/typescript/_getting-started.mdx | 8 + .../pages/sdk/finshark/typescript/index.tsx | 2801 +++++++ .../src/pages/sdk/fordefi/index.tsx | 68 + .../sdk/fordefi/typescript/_first-request.mdx | 4 + .../fordefi/typescript/_getting-started.mdx | 7 + .../pages/sdk/fordefi/typescript/index.tsx | 3052 ++++++++ .../src/pages/sdk/golioth/index.tsx | 63 + .../sdk/golioth/typescript/_first-request.mdx | 4 + .../golioth/typescript/_getting-started.mdx | 8 + .../pages/sdk/golioth/typescript/index.tsx | 4657 +++++++++++ .../pages/sdk/griffin/typescript/index.tsx | 4 +- .../konfig-docs/src/pages/sdk/ilert/index.tsx | 66 + .../sdk/ilert/typescript/_first-request.mdx | 6 + .../sdk/ilert/typescript/_getting-started.mdx | 8 + .../src/pages/sdk/ilert/typescript/index.tsx | 6916 +++++++++++++++++ .../src/pages/sdk/in-mobile/index.tsx | 70 + .../in-mobile/typescript/_first-request.mdx | 4 + .../in-mobile/typescript/_getting-started.mdx | 11 + .../pages/sdk/in-mobile/typescript/index.tsx | 1567 ++++ .../src/pages/sdk/innoship/index.tsx | 74 + .../innoship/typescript/_first-request.mdx | 7 + .../innoship/typescript/_getting-started.mdx | 7 + .../pages/sdk/innoship/typescript/index.tsx | 2987 +++++++ .../src/pages/sdk/keatext-ai/index.tsx | 72 + .../keatext-ai/typescript/_first-request.mdx | 9 + .../typescript/_getting-started.mdx | 5 + .../pages/sdk/keatext-ai/typescript/index.tsx | 1128 +++ .../konfig-docs/src/pages/sdk/kombo/index.tsx | 69 + .../sdk/kombo/typescript/_first-request.mdx | 4 + .../sdk/kombo/typescript/_getting-started.mdx | 8 + .../src/pages/sdk/kombo/typescript/index.tsx | 2982 +++++++ .../src/pages/sdk/localizely/index.tsx | 69 + .../localizely/typescript/_first-request.mdx | 8 + .../typescript/_getting-started.mdx | 7 + .../pages/sdk/localizely/typescript/index.tsx | 292 + .../lucca/timmi-absences/typescript/index.tsx | 10 +- .../konfig-docs/src/pages/sdk/mambu/index.tsx | 67 + .../payments/typescript/_first-request.mdx | 7 + .../payments/typescript/_getting-started.mdx | 5 + .../sdk/mambu/payments/typescript/index.tsx | 2559 ++++++ .../sdk/measure-one/typescript/index.tsx | 4 +- .../pages/sdk/pay-fit/typescript/index.tsx | 10 +- .../konfig-docs/src/pages/sdk/sdk-links.json | 156 + 53 files changed, 30825 insertions(+), 14 deletions(-) create mode 100644 generator/konfig-docs/src/pages/sdk/category/translation.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/finley/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/finley/typescript/_first-request.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/finley/typescript/_getting-started.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/finley/typescript/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/finshark/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/finshark/typescript/_first-request.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/finshark/typescript/_getting-started.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/finshark/typescript/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/fordefi/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/fordefi/typescript/_first-request.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/fordefi/typescript/_getting-started.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/fordefi/typescript/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/golioth/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/golioth/typescript/_first-request.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/golioth/typescript/_getting-started.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/golioth/typescript/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/ilert/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/ilert/typescript/_first-request.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/ilert/typescript/_getting-started.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/ilert/typescript/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/in-mobile/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/in-mobile/typescript/_first-request.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/in-mobile/typescript/_getting-started.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/in-mobile/typescript/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/innoship/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/innoship/typescript/_first-request.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/innoship/typescript/_getting-started.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/innoship/typescript/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/keatext-ai/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/keatext-ai/typescript/_first-request.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/keatext-ai/typescript/_getting-started.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/keatext-ai/typescript/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/kombo/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/kombo/typescript/_first-request.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/kombo/typescript/_getting-started.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/kombo/typescript/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/localizely/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/localizely/typescript/_first-request.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/localizely/typescript/_getting-started.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/localizely/typescript/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/mambu/index.tsx create mode 100644 generator/konfig-docs/src/pages/sdk/mambu/payments/typescript/_first-request.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/mambu/payments/typescript/_getting-started.mdx create mode 100644 generator/konfig-docs/src/pages/sdk/mambu/payments/typescript/index.tsx diff --git a/generator/konfig-docs/redirects.json b/generator/konfig-docs/redirects.json index 77de6192b..a261f7392 100644 --- a/generator/konfig-docs/redirects.json +++ b/generator/konfig-docs/redirects.json @@ -83,6 +83,8 @@ "/sdk/lucca/organization/": "/sdk/lucca/organization/typescript/", "/sdk/lucca/timmi-timesheet": "/sdk/lucca/timmi-timesheet/typescript/", "/sdk/lucca/timmi-timesheet/": "/sdk/lucca/timmi-timesheet/typescript/", + "/sdk/mambu/payments": "/sdk/mambu/payments/typescript/", + "/sdk/mambu/payments/": "/sdk/mambu/payments/typescript/", "/sdk/microsoft/dynamics-365-business-central": "/sdk/microsoft/dynamics-365-business-central/typescript/", "/sdk/microsoft/dynamics-365-business-central/": "/sdk/microsoft/dynamics-365-business-central/typescript/", "/sdk/nasa/tech-port": "/sdk/nasa/tech-port/typescript/", diff --git a/generator/konfig-docs/src/pages/sdk/categories.json b/generator/konfig-docs/src/pages/sdk/categories.json index ede5b2385..e67d4928d 100644 --- a/generator/konfig-docs/src/pages/sdk/categories.json +++ b/generator/konfig-docs/src/pages/sdk/categories.json @@ -12,6 +12,11 @@ "page": "text-to-speech", "subpath": "/sdk/category/text-to-speech" }, + { + "category": "Translation", + "page": "translation", + "subpath": "/sdk/category/translation" + }, { "category": "Video Generation", "page": "video-generation", diff --git a/generator/konfig-docs/src/pages/sdk/category/translation.tsx b/generator/konfig-docs/src/pages/sdk/category/translation.tsx new file mode 100644 index 000000000..b104f34d3 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/category/translation.tsx @@ -0,0 +1,5 @@ +import { SdkDirectory } from "@site/src/components/SdkDirectory"; + +export default function Sdks() { + return ; +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/companies.json b/generator/konfig-docs/src/pages/sdk/companies.json index f7974fa1a..326c75eec 100644 --- a/generator/konfig-docs/src/pages/sdk/companies.json +++ b/generator/konfig-docs/src/pages/sdk/companies.json @@ -1135,6 +1135,26 @@ "difficultyScore": 422.5, "subpath": "/sdk/wannme" }, + { + "parentCategories": [ + "Business Intelligence" + ], + "subCategories": [ + "Compliance & Security" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/ilert/favicon.png", + "metaDescription": "ilert is a SaaS company for alerting, on-call management and incident communication and helps companies to increase their digital uptime. B2C and B2B companies from across the globe, including well-known brands such as Bertelsmann, TeamViewer and REWE, trust ilert to empower their operations teams and ensure everything is running smoothly.", + "services": [], + "company": "ilert", + "keywords": [ + "alerting", + "on_call_management", + "incident_communication" + ], + "numberOfApis": 1, + "difficultyScore": 422.25, + "subpath": "/sdk/ilert" + }, { "parentCategories": [ "IT Operations" @@ -1549,6 +1569,26 @@ "difficultyScore": 362.75, "subpath": "/sdk/bamboo-hr" }, + { + "parentCategories": [ + "Data" + ], + "subCategories": [ + "Finance" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/fordefi/favicon.png", + "metaDescription": "The future of institutional web3 wallets.\n\nFor builders, traders, and operators, Fordefi's comprehensive MPC wallet platform and web3 gateway enables you to securely self-custody your private keys, seamlessly connect to thousands of dApps across any blockchain, protect your workflows with granular policies, and manage your digital asset operations all-in-one place.", + "services": [], + "company": "FORDEFI", + "keywords": [ + "cryptocurrency", + "web_3", + "mpc_wallet" + ], + "numberOfApis": 1, + "difficultyScore": 346, + "subpath": "/sdk/fordefi" + }, { "parentCategories": [ "Content & Files" @@ -1860,6 +1900,25 @@ "difficultyScore": 284, "subpath": "/sdk/weavy" }, + { + "parentCategories": [ + "Artificial Intelligence" + ], + "subCategories": [ + "AI Tools" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/golioth/favicon.png", + "metaDescription": "Built IoT your way without the stress. Securely connect your MCU then capture and route sensor data anywhere with the Golioth SDK. Build secure, scalable, and innovative IoT in a fraction of the time.", + "services": [], + "company": "Golioth", + "keywords": [ + "iot", + "hardware" + ], + "numberOfApis": 1, + "difficultyScore": 280.75, + "subpath": "/sdk/golioth" + }, { "parentCategories": [ "Human Resources" @@ -2068,6 +2127,27 @@ "difficultyScore": 245.75, "subpath": "/sdk/jiko" }, + { + "parentCategories": [ + "Artificial Intelligence" + ], + "subCategories": [ + "AI Tools" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/kombo/favicon.png", + "metaDescription": "Kombo is changing how B2B SaaS companies provide HR integrations to their customers. Instead of having to build and maintain many APIs themselves, Kombos customers can integrate with Kombo's API once and offer dozens of APIs to their customers instantly.", + "services": [], + "company": "Kombo", + "keywords": [ + "integrations", + "ats", + "hris", + "payroll" + ], + "numberOfApis": 1, + "difficultyScore": 242, + "subpath": "/sdk/kombo" + }, { "parentCategories": [ "Human Resources" @@ -2715,6 +2795,26 @@ "difficultyScore": 177.25, "subpath": "/sdk/open-banking" }, + { + "parentCategories": [ + "Commerce" + ], + "subCategories": [ + "eCommerce" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/innoship/favicon.png", + "metaDescription": "Innoship is the advanced delivery management platform that helps retailers to improve customer experience by streamlining the delivery process. We combined our eCommerce logistics expertise with all the enterprise features you need to master last-mile customer experience. \n\nBacked by Abris Capital Partners, the ESG transformation specialist private equity investor, Innoship is now part of Alsendo group, the leading eCommerce shipping solutions technologies in the CEE region.\n\nFrom checkout and shipping to tracking, returns and analytics, Innoship helps you safely deliver on promises made to your customers. \n\nEffortless integration, hassle-free delivery\nโ€ข\tA simple, one-time integration with the Innoship app allows retailers to access any carrier, local or international.\nโ€ข\tExternal markets become readily available with seamless connections to hundreds of carriers in 15+ countries.", + "services": [], + "company": "Innoship", + "keywords": [ + "shipping_api", + "logistics_provider", + "shipping_integration" + ], + "numberOfApis": 1, + "difficultyScore": 171, + "subpath": "/sdk/innoship" + }, { "parentCategories": [ "Communication" @@ -2987,6 +3087,28 @@ "difficultyScore": 148, "subpath": "/sdk/git-lab" }, + { + "parentCategories": [ + "Data" + ], + "subCategories": [ + "Finance" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/finshark/favicon.jpg", + "metaDescription": "More and more non-financial companies are looking into new ways to boost revenue through embedded finance as the financial services industry has been disrupted. Through open banking, we remove any legacy friction within online payments and other financial processes to create new, instant paths for modern companies to fully own finance, deliver proprietary solutions and, ultimately, reach the success they desire.\n\n๐—œ๐—ป๐˜€๐˜๐—ฎ๐—ป๐˜ ๐—ฝ๐—ฎ๐˜†๐—บ๐—ฒ๐—ป๐˜๐˜€. | Let your customers pay with their bank. \n๐—œ๐—ป๐˜€๐˜๐—ฎ๐—ป๐˜ ๐—ฝ๐—ฎ๐˜†๐—ผ๐˜‚๐˜๐˜€. | Send funds to anyone from your business.\n๐—ฃ๐—ฟ๐—ฒ๐—บ๐—ถ๐˜‚๐—บ ๐—ถ๐—ป๐˜€๐—ถ๐—ด๐—ต๐˜๐˜€. | Holistic financial data to streamline your KYC checks.\n๐—ฆ๐˜๐—ฟ๐—ฒ๐—ฎ๐—บ๐˜€. | All our products rolled into one single interface. Zero coding.\n\nFinshark is a licensed Payment Institution by the Financial Supervisory Authority, authorised to provide payment services across EU/EES.", + "services": [], + "company": "Finshark", + "keywords": [ + "financial_services", + "online_payments", + "fintech", + "payment_solutions", + "payouts" + ], + "numberOfApis": 1, + "difficultyScore": 147.75, + "subpath": "/sdk/finshark" + }, { "parentCategories": [ "Marketing" @@ -3137,6 +3259,27 @@ "difficultyScore": 141.25, "subpath": "/sdk/sage" }, + { + "parentCategories": [ + "Data" + ], + "subCategories": [ + "Finance" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/mambu/payments/favicon.png", + "metaDescription": "Heard of composable banking? The concept originated here at Mambu. We've been champions of composable for over a decade.\n\nMambu is the only true SaaS cloud core banking platform. Our unique and sustainable composable approach means that independent engines, systems and connectors can be assembled in any configuration to meet business requirements and the ever-changing demands of your customers. 260+ banks, lenders, fintechs, and even retailers in 65 countries turn to us to help them build modern digital financial products faster, securely and cost-effectively.\n\nReady to become a Mambuvian? Check our Jobs tab.", + "services": [ + "Payments" + ], + "company": "Mambu", + "keywords": [ + "finance", + "banking" + ], + "numberOfApis": 1, + "difficultyScore": 141, + "subpath": "/sdk/mambu" + }, { "parentCategories": [ "IT Operations" @@ -3721,6 +3864,28 @@ "difficultyScore": 106.75, "subpath": "/sdk/hypatos" }, + { + "parentCategories": [ + "Artificial Intelligence" + ], + "subCategories": [ + "AI Tools" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/keatext-ai/favicon.png", + "metaDescription": "Keatext brings the voice of customer and employee into your day-to-day activities. Easily understand what drives engagement and get tailored AI-based recommendations to improve people experiences.", + "services": [], + "company": "Keatext AI", + "keywords": [ + "ai", + "nlp", + "text", + "text_analytics", + "ai_text" + ], + "numberOfApis": 1, + "difficultyScore": 106.25, + "subpath": "/sdk/keatext-ai" + }, { "parentCategories": [ "Business Intelligence" @@ -4212,6 +4377,25 @@ "difficultyScore": 88.5, "subpath": "/sdk/pay-pal" }, + { + "parentCategories": [ + "Communication" + ], + "subCategories": [ + "Phone & SMS" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/inmobile/favicon.jpg", + "metaDescription": "inMobile er en SMS-Gateway testet af over 8.000 brugere. Vi hรฅndterer over 150 mio. SMS-beskeder รฅrligt og tilstrรฆber en oppetid pรฅ 100%, men sandheden er 99,99%.\n\nUanset, om det drejer sig om at informere dine kunder, medarbejdere eller andre personer, som er vigtige for din virksomhed, gรธr inMobile det nemt for de rette personer at fรฅ besked pรฅ det rette tidspunkt.\n\nDu fรฅr adgang til en brugervenlig SMS-Gateway og et gennemtestet API, som du nemt kan integrere med dit eget system eller hjemmeside.\n\nร˜nsker du at hรธre mere om vores lรธsning, er du velkommen til at kontakte os pรฅ +45 88 33 66 99 eller pรฅ mail salg@inmobile.dk\nVi har รฅbent alle hverdage mellem kl. 8-17", + "services": [], + "company": "inMobile", + "keywords": [ + "messaging", + "sms" + ], + "numberOfApis": 1, + "difficultyScore": 86.75, + "subpath": "/sdk/in-mobile" + }, { "parentCategories": [ "Marketing" @@ -5559,6 +5743,27 @@ "difficultyScore": 31.75, "subpath": "/sdk/global-predictions-inc" }, + { + "parentCategories": [ + "Data" + ], + "subCategories": [ + "Finance" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/finley/favicon.png", + "metaDescription": "Finley's software simplifies debt capital raise and management for businesses. High-growth startups like Ramp, Even, and Arc rely on Finley to manage over $2 billion in debt capital. By automating due diligence, ensuring compliance, and streamlining ongoing reporting with capital providers, Finley helps ensure that companies always have access to funding when they need it. Finley's investors include Y Combinator, Bain Capital Ventures, Haystack, Nine Four Ventures, and TwentyTwo VC.", + "services": [], + "company": "Finley", + "keywords": [ + "debt_capital_raise", + "due_diligence", + "compliance", + "capital_providers_reporting" + ], + "numberOfApis": 1, + "difficultyScore": 31.5, + "subpath": "/sdk/finley" + }, { "parentCategories": [ "Communication" @@ -5946,6 +6151,25 @@ "difficultyScore": 12.25, "subpath": "/sdk/interviewstream" }, + { + "parentCategories": [ + "Artificial Intelligence" + ], + "subCategories": [ + "Translation" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/localizely/favicon.png", + "metaDescription": "Localizely is a translation management system for agile teams that streamlines software localization. \n\nWe believe translation management for apps should be easy, so the team can focus on things that bring business value.\n\nDevelopers can easily integrate translations into the apps build process, and managers can easily collaborate with translators.\n\nWe built Localizely from our experience by working on software projects with 2 to 100 languages.", + "services": [], + "company": "Localizely", + "keywords": [ + "language", + "translation" + ], + "numberOfApis": 1, + "difficultyScore": 12, + "subpath": "/sdk/localizely" + }, { "parentCategories": [ "Artificial Intelligence" diff --git a/generator/konfig-docs/src/pages/sdk/finley/index.tsx b/generator/konfig-docs/src/pages/sdk/finley/index.tsx new file mode 100644 index 000000000..3e75670fd --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/finley/index.tsx @@ -0,0 +1,69 @@ +import React from 'react'; +import { Company } from '../../../components/Company'; + +const sdks = [ + { + "name": "Finley", + "numberOfMethods": 17, + "categories": [ + "debt_capital_raise", + "due_diligence", + "compliance", + "capital_providers_reporting" + ], + "index": "finley/typescript", + "language": "TypeScript", + "link": "/sdk/finley/typescript/", + "developerDocumentation": "docs.finleycms.com/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/finley/openapi.yaml" + }, + { + "name": "Finley", + "numberOfMethods": 17, + "categories": [ + "debt_capital_raise", + "due_diligence", + "compliance", + "capital_providers_reporting" + ], + "index": "finley/python", + "language": "Python", + "link": "/sdk/finley/python/", + "developerDocumentation": "docs.finleycms.com/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/finley/openapi.yaml" + }, + { + "name": "Finley", + "numberOfMethods": 17, + "categories": [ + "debt_capital_raise", + "due_diligence", + "compliance", + "capital_providers_reporting" + ], + "index": "finley/java", + "language": "Java", + "link": "/sdk/finley/java/", + "developerDocumentation": "docs.finleycms.com/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/finley/openapi.yaml" + } +]; + +export default function Finley() { + const allCategories: string[] = Array.from( + new Set(sdks.flatMap((service) => service.categories)), + ) + return ( + + ) +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/finley/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/finley/typescript/_first-request.mdx new file mode 100644 index 000000000..68353ca96 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/finley/typescript/_first-request.mdx @@ -0,0 +1,7 @@ +```typescript index.ts +// Get Borrowing-base Report +const getByIdResponse = finley.borrowingBaseReports.getById({ + creditFacilityId: "2c843493-ee7d-4998-94cb-6a97deb92123" + borrowingBaseReportId: "4a61197g-a7c6-32cd-b9f7-f02921c5b123" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/finley/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/finley/typescript/_getting-started.mdx new file mode 100644 index 000000000..c8c1dd45e --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/finley/typescript/_getting-started.mdx @@ -0,0 +1,5 @@ +```typescript index.ts +import { Finley } from 'finley-typescript-sdk'; + +const finley = new Finley() +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/finley/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/finley/typescript/index.tsx new file mode 100644 index 000000000..cd01173b2 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/finley/typescript/index.tsx @@ -0,0 +1,569 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function FinleyTypeScriptSdk() { + return ( + + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/finshark/index.tsx b/generator/konfig-docs/src/pages/sdk/finshark/index.tsx new file mode 100644 index 000000000..47f3004d4 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/finshark/index.tsx @@ -0,0 +1,79 @@ +import React from 'react'; +import { Company } from '../../../components/Company'; + +const sdks = [ + { + "name": "Finshark", + "numberOfMethods": 51, + "categories": [ + "financial_services", + "online_payments", + "fintech", + "payment_solutions", + "payouts" + ], + "index": "finshark/typescript", + "language": "TypeScript", + "link": "/sdk/finshark/typescript/", + "developerDocumentation": "oas.finshark.io/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/finshark/openapi.yaml" + }, + { + "name": "Finshark", + "numberOfMethods": 51, + "categories": [ + "financial_services", + "online_payments", + "fintech", + "payment_solutions", + "payouts" + ], + "index": "finshark/python", + "language": "Python", + "link": "/sdk/finshark/python/", + "developerDocumentation": "oas.finshark.io/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/finshark/openapi.yaml" + }, + { + "name": "Finshark", + "numberOfMethods": 51, + "categories": [ + "financial_services", + "online_payments", + "fintech", + "payment_solutions", + "payouts" + ], + "index": "finshark/java", + "language": "Java", + "link": "/sdk/finshark/java/", + "developerDocumentation": "oas.finshark.io/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/finshark/openapi.yaml" + } +]; + +export default function Finshark() { + const allCategories: string[] = Array.from( + new Set(sdks.flatMap((service) => service.categories)), + ) + return ( + + ) +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/finshark/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/finshark/typescript/_first-request.mdx new file mode 100644 index 000000000..1c3ee24b9 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/finshark/typescript/_first-request.mdx @@ -0,0 +1,4 @@ +```typescript index.ts +// Get list of accounts. +const listResponse = finshark.accounts.list() +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/finshark/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/finshark/typescript/_getting-started.mdx new file mode 100644 index 000000000..abfac6209 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/finshark/typescript/_getting-started.mdx @@ -0,0 +1,8 @@ +```typescript index.ts +import { Finshark } from 'finshark-typescript-sdk'; + +const finshark = new Finshark({ + // Please enter into field the word 'Bearer' following by space and JWT + bearer: "AUTHORIZATION" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/finshark/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/finshark/typescript/index.tsx new file mode 100644 index 000000000..6c295cf70 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/finshark/typescript/index.tsx @@ -0,0 +1,2801 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function FinsharkTypeScriptSdk() { + return ( + + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/fordefi/index.tsx b/generator/konfig-docs/src/pages/sdk/fordefi/index.tsx new file mode 100644 index 000000000..63c45e2da --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/fordefi/index.tsx @@ -0,0 +1,68 @@ +import React from 'react'; +import { Company } from '../../../components/Company'; + +const sdks = [ + { + "name": "FORDEFI", + "numberOfMethods": 44, + "categories": [ + "cryptocurrency", + "web_3", + "mpc_wallet" + ], + "index": "fordefi/typescript", + "language": "TypeScript", + "link": "/sdk/fordefi/typescript/", + "developerDocumentation": "docs.fordefi.com/reference/api-overview", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/fordefi/openapi.yaml" + }, + { + "name": "FORDEFI", + "numberOfMethods": 44, + "categories": [ + "cryptocurrency", + "web_3", + "mpc_wallet" + ], + "index": "fordefi/python", + "language": "Python", + "link": "/sdk/fordefi/python/", + "developerDocumentation": "docs.fordefi.com/reference/api-overview", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/fordefi/openapi.yaml" + }, + { + "name": "FORDEFI", + "numberOfMethods": 44, + "categories": [ + "cryptocurrency", + "web_3", + "mpc_wallet" + ], + "index": "fordefi/java", + "language": "Java", + "link": "/sdk/fordefi/java/", + "developerDocumentation": "docs.fordefi.com/reference/api-overview", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/fordefi/openapi.yaml" + } +]; + +export default function Fordefi() { + const allCategories: string[] = Array.from( + new Set(sdks.flatMap((service) => service.categories)), + ) + return ( + + ) +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/fordefi/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/fordefi/typescript/_first-request.mdx new file mode 100644 index 000000000..2c9454b12 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/fordefi/typescript/_first-request.mdx @@ -0,0 +1,4 @@ +```typescript index.ts +// List Chains +const getListResponse = fordefi.blockchains.getList() +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/fordefi/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/fordefi/typescript/_getting-started.mdx new file mode 100644 index 000000000..60474191e --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/fordefi/typescript/_getting-started.mdx @@ -0,0 +1,7 @@ +```typescript index.ts +import { Fordefi } from 'fordefi-typescript-sdk'; + +const fordefi = new Fordefi({ + bearerAuth: "BEARER_AUTH" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/fordefi/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/fordefi/typescript/index.tsx new file mode 100644 index 000000000..7876d10b1 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/fordefi/typescript/index.tsx @@ -0,0 +1,3052 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function FordefiTypeScriptSdk() { + return ( +
  • `active`: The user can perform all actions in the Fordefi platform.
  • `onboarding`: The user has been approved but still needs to activate the account.
  • `pending_approval`: The user has been invited but not yet approved.
  • `deleted`: The user has been deleted." + }, + { + "name": "includeDeleted", + "schema": "boolean", + "required": false, + "description": "", + "default": false + }, + { + "name": "name", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "email", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "search", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "userIds", + "schema": "array", + "required": false, + "description": "The unique identifiers of the users." + }, + { + "name": "externalId", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "groupIds", + "schema": "array", + "required": false, + "description": "The unique identifiers of the user groups." + }, + { + "name": "groupIdsNot", + "schema": "array", + "required": false, + "description": "The unique identifiers of the user groups to exclude." + }, + { + "name": "statesOnGroups", + "schema": "array", + "required": false, + "description": "The states of the user groups to filter group_ids on. Is one of:
    • `active`: The user group is active.
    • `pending_addition`: The user is pending to be added to the group.
    • `pending_removal`: The user is pending to be removed from the group.
    " + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/users/{id}", + "method": "getUserById", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Users", + "typeScriptTag": "users", + "description": "Get User", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the user to retrieve.", + "example": "ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/user-groups", + "method": "getList", + "httpMethod": HttpMethodsEnum.GET, + "tag": "User Groups", + "typeScriptTag": "userGroups", + "description": "List User Groups", + "parameters": [ + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number to fetch.", + "default": 1 + }, + { + "name": "size", + "schema": "integer", + "required": false, + "description": "The number of items per page.", + "default": 50 + }, + { + "name": "states", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "userGroupIds", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "userIds", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "modifiedBy", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "name", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "search", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "sortBy", + "schema": "array", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/user-groups/{id}", + "method": "getDetails", + "httpMethod": HttpMethodsEnum.GET, + "tag": "User Groups", + "typeScriptTag": "userGroups", + "description": "Get User Group", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the user group to retrieve.", + "example": "ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/vaults", + "method": "list", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Vaults", + "typeScriptTag": "vaults", + "description": "List Vaults", + "parameters": [ + { + "name": "sortBy", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number to fetch.", + "default": 1 + }, + { + "name": "size", + "schema": "integer", + "required": false, + "description": "The number of items per page.", + "default": 50 + }, + { + "name": "vaultIds", + "schema": "array", + "required": false, + "description": "Vault IDs to filter on." + }, + { + "name": "search", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "vaultTypes", + "schema": "array", + "required": false, + "description": "Vault types to filter on." + }, + { + "name": "vaultStates", + "schema": "array", + "required": false, + "description": "Vault states to filter on." + }, + { + "name": "keysetIds", + "schema": "array", + "required": false, + "description": "List of keyset IDs to filter on." + }, + { + "name": "keyHolderIds", + "schema": "array", + "required": false, + "description": "List of key holder IDs to filter on." + }, + { + "name": "vaultGroupIds", + "schema": "array", + "required": false, + "description": "List of vault group IDs to filter on. Filter applies to current and pending vault groups." + }, + { + "name": "excludeVaultGroupIds", + "schema": "array", + "required": false, + "description": "List of vault group IDs to exclude." + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/vaults", + "method": "createNewVault", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Vaults", + "typeScriptTag": "vaults", + "description": "Create Vault", + "parameters": [], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/vaults/export", + "method": "exportWithAssets", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Vaults", + "typeScriptTag": "vaults", + "description": "Export Vaults With Assets", + "parameters": [ + { + "name": "vaultsIds", + "schema": "array", + "required": false, + "description": "Vault IDs to filter on." + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/vaults/{id}", + "method": "getDetails", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Vaults", + "typeScriptTag": "vaults", + "description": "Get Vault", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the vault to retrieve.", + "example": "ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/vaults/{id}/assets/{asset_id}", + "method": "getAsset", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Vaults", + "typeScriptTag": "vaults", + "description": "Get Vault Asset", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the vault to retrieve.", + "example": "ID" + }, + { + "name": "assetId", + "schema": "string", + "required": true, + "description": "ID of the asset to retrieve.", + "example": "ASSET_ID" + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number to fetch.", + "default": 1 + }, + { + "name": "size", + "schema": "integer", + "required": false, + "description": "The number of items per page.", + "default": 50 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Represents an owned asset on Fordefi's platform" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/vaults/{id}/assets", + "method": "getAssets", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Vaults", + "typeScriptTag": "vaults", + "description": "Get Vault Assets", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the vault to retrieve.", + "example": "ID" + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number to fetch.", + "default": 1 + }, + { + "name": "size", + "schema": "integer", + "required": false, + "description": "The number of items per page.", + "default": 50 + }, + { + "name": "assetIds", + "schema": "array", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/vaults/{id}/name", + "method": "renameVault", + "httpMethod": HttpMethodsEnum.PUT, + "tag": "Vaults", + "typeScriptTag": "vaults", + "description": "Rename Vault", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the vault to rename.", + "example": "ID" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Successful Response" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/vaults/{id}/addresses", + "method": "listAddresses", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Vaults", + "typeScriptTag": "vaults", + "description": "List Vault Addresses", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the vault.", + "example": "ID" + }, + { + "name": "sortBy", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number to fetch.", + "default": 1 + }, + { + "name": "size", + "schema": "integer", + "required": false, + "description": "The number of items per page.", + "default": 50 + }, + { + "name": "search", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "addresses", + "schema": "array", + "required": false, + "description": "List of addresses to filter on." + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/vaults/{id}/addresses", + "method": "createAddress", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Vaults", + "typeScriptTag": "vaults", + "description": "Create Address", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the vault to create address in.", + "example": "ID" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "address_type", + "schema": "string", + "description": "" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/vaults/addresses/{id}/name", + "method": "renameAddress", + "httpMethod": HttpMethodsEnum.PUT, + "tag": "Vaults", + "typeScriptTag": "vaults", + "description": "Rename Vault Address", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the vault address to rename.", + "example": "ID" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Successful Response" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/vault-groups", + "method": "list", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Vault Groups", + "typeScriptTag": "vaultGroups", + "description": "List Vault Groups", + "parameters": [ + { + "name": "sortBy", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number to fetch.", + "default": 1 + }, + { + "name": "size", + "schema": "integer", + "required": false, + "description": "The number of items per page.", + "default": 50 + }, + { + "name": "vaultGroupIds", + "schema": "array", + "required": false, + "description": "Vault group IDs to filter on." + }, + { + "name": "search", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "accessLevel", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/assets/owned-assets/{id}", + "method": "getOwnedAsset", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Assets", + "typeScriptTag": "assets", + "description": "Get Owned Asset", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the asset to retrieve.", + "example": "ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "Represents an owned asset on Fordefi's platform" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/assets/owned-assets", + "method": "listOwnedAssets", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Assets", + "typeScriptTag": "assets", + "description": "List Owned Assets", + "parameters": [ + { + "name": "vaultIds", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "chains", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "endUserIds", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "assetIds", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "isHidden", + "schema": "boolean", + "required": false, + "description": "" + }, + { + "name": "search", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "sortBy", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number to fetch.", + "default": 1 + }, + { + "name": "size", + "schema": "integer", + "required": false, + "description": "The number of items per page.", + "default": 50 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/assets", + "method": "updateConfiguration", + "httpMethod": HttpMethodsEnum.PUT, + "tag": "Assets", + "typeScriptTag": "assets", + "description": "Update Asset Configuration", + "parameters": [ + { + "name": "asset", + "schema": "undefined", + "required": true, + "description": "" + }, + { + "name": "hidden", + "schema": "boolean", + "required": true, + "description": "", + "example": true + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Successful Response" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/assets/prices", + "method": "getPrices", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Assets", + "typeScriptTag": "assets", + "description": "Fetch Asset Prices", + "parameters": [ + { + "name": "asset_identifiers", + "schema": "array", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/transactions/export", + "method": "exportCsvList", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Transactions", + "typeScriptTag": "transactions", + "description": "Export Transactions", + "parameters": [ + { + "name": "limit", + "schema": "integer", + "required": false, + "description": "The amount of transactions to export, 1000 if not set.", + "default": 1000 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/transactions/{id}", + "method": "getDetails", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Transactions", + "typeScriptTag": "transactions", + "description": "Get Transaction", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the transaction to retrieve.", + "example": "ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/transactions", + "method": "listAllInOrganization", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Transactions", + "typeScriptTag": "transactions", + "description": "List Transactions", + "parameters": [ + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number to fetch.", + "default": 1 + }, + { + "name": "size", + "schema": "integer", + "required": false, + "description": "The number of items per page.", + "default": 50 + }, + { + "name": "createdBefore", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "createdAfter", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "modifiedAfter", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "vaultIds", + "schema": "array", + "required": false, + "description": "The filter applies both to transactions that have been signed by the vault and also to transactions that have interacted with the vault. " + }, + { + "name": "chains", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "initiatorIds", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "states", + "schema": "array", + "required": false, + "description": "State of the transaction. Can be one of:
    • `pending`
    • `finalized`, which can be one of:
      • `completed`
      • `aborted`
      • `error_pushing_to_blockchain`
      • `reverted`
      • `accelerated`
      • `canceled`
    • `approved`
    " + }, + { + "name": "types", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "subTypes", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "signerTypes", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "transactionIds", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "endUserIds", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "isHidden", + "schema": "boolean", + "required": false, + "description": "" + }, + { + "name": "direction", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "includeFullResponse", + "schema": "boolean", + "required": false, + "description": "", + "default": true + }, + { + "name": "sortBy", + "schema": "array", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/transactions", + "method": "createNewTransaction", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Transactions", + "typeScriptTag": "transactions", + "description": "Create Transaction", + "parameters": [ + { + "name": "xSignature", + "schema": "string", + "required": false, + "description": "Signature of the body. Base64 encoded string. If the request is made programatically by an API user, signing of the request is required and is intended to protect you from malicious backends. ", + "example": "SGVsbG8=" + }, + { + "name": "xTimestamp", + "schema": "integer", + "required": false, + "description": "Timestamp of the signature. Integer. Specify an Epoch date. If the request is made programatically by an API user, the timestamp of the request is required and is intended to protect you from replay attacks." + }, + { + "name": "xIdempotenceId", + "schema": "string", + "required": false, + "description": "Optional idempotence ID of a transaction." + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/transactions/{id}/approve", + "method": "approveTransaction", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Transactions", + "typeScriptTag": "transactions", + "description": "Approve Transaction", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the transaction to approve.", + "example": "ID" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Successful Response" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/transactions/{id}/abort", + "method": "abortTransactionAndShowBalanceChange", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Transactions", + "typeScriptTag": "transactions", + "description": "Abort Transaction", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the transaction to abort.", + "example": "ID" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Successful Response" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/transactions/{id}/release", + "method": "releaseTransaction", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Transactions", + "typeScriptTag": "transactions", + "description": "Release Transaction", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the transaction to release.", + "example": "ID" + }, + { + "name": "xSignature", + "schema": "string", + "required": false, + "description": "Signature of the body. Base64 encoded string. If the request is made programatically by an API user, signing of the request is required and is intended to protect you from malicious backends. ", + "example": "SGVsbG8=" + }, + { + "name": "xTimestamp", + "schema": "integer", + "required": false, + "description": "Timestamp of the signature. Integer. Specify an Epoch date. If the request is made programatically by an API user, the timestamp of the request is required and is intended to protect you from replay attacks." + }, + { + "name": "type", + "schema": "undefined", + "required": true, + "description": "" + }, + { + "name": "release_type", + "schema": "string", + "required": true, + "description": "", + "example": "RELEASE_TYPE" + }, + { + "name": "signer_type", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "fail_on_prediction_failure", + "schema": "boolean", + "required": false, + "description": "", + "default": true + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/transactions/describe", + "method": "getBlockchainFeePriceAndEstimateTransactionFee", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Transactions", + "typeScriptTag": "transactions", + "description": "Describe Transaction", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/transactions/predict", + "method": "simulateTransactionAndShowBalanceChange", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Transactions", + "typeScriptTag": "transactions", + "description": "Predict Transaction", + "parameters": [], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/transactions/{id}/update-spam-state", + "method": "updateSpamState", + "httpMethod": HttpMethodsEnum.PUT, + "tag": "Transactions", + "typeScriptTag": "transactions", + "description": "Update Transaction Spam State", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the transaction to update spam state.", + "example": "ID" + }, + { + "name": "is_spam", + "schema": "boolean", + "required": true, + "description": "", + "example": true + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Successful Response" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/addressbook/contacts", + "method": "listContacts", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Address Book", + "typeScriptTag": "addressBook", + "description": "List Contacts", + "parameters": [ + { + "name": "sortBy", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number to fetch.", + "default": 1 + }, + { + "name": "size", + "schema": "integer", + "required": false, + "description": "The number of items per page.", + "default": 50 + }, + { + "name": "contactIds", + "schema": "array", + "required": false, + "description": "The contact IDs to filter by." + }, + { + "name": "search", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "states", + "schema": "array", + "required": false, + "description": "The states to filter by." + }, + { + "name": "chainTypes", + "schema": "array", + "required": false, + "description": "The chain types to filter by." + }, + { + "name": "chains", + "schema": "array", + "required": false, + "description": "The chain unique ids to filter by." + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/webhooks/test", + "method": "testWebhook", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Webhooks", + "typeScriptTag": "webhooks", + "description": "Test Webhook", + "parameters": [ + { + "name": "url", + "schema": "string", + "required": true, + "description": "", + "example": "URL" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Successful Response" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/webhooks/trigger/transaction/{id}", + "method": "triggerTransaction", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Webhooks", + "typeScriptTag": "webhooks", + "description": "Trigger Transaction Webhook", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the transaction to send events for.", + "example": "ID" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Successful Response" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/keysets", + "method": "getAll", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Keysets", + "typeScriptTag": "keysets", + "description": "List Keysets", + "parameters": [ + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number to fetch.", + "default": 1 + }, + { + "name": "size", + "schema": "integer", + "required": false, + "description": "The number of items per page.", + "default": 50 + }, + { + "name": "keysetIds", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "userIds", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "scopes", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "search", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "sortBy", + "schema": "array", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/keysets", + "method": "createKeyset", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Keysets", + "typeScriptTag": "keysets", + "description": "Create Keyset", + "parameters": [ + { + "name": "user_id", + "schema": "string", + "required": true, + "description": "", + "example": "USER_ID" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "NAME" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/keysets/{id}", + "method": "getDetails", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Keysets", + "typeScriptTag": "keysets", + "description": "Get Keyset", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the keyset to retrieve.", + "example": "ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/end-users", + "method": "getList", + "httpMethod": HttpMethodsEnum.GET, + "tag": "End Users", + "typeScriptTag": "endUsers", + "description": "List End Users", + "parameters": [ + { + "name": "sortBy", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number to fetch.", + "default": 1 + }, + { + "name": "size", + "schema": "integer", + "required": false, + "description": "The number of items per page.", + "default": 50 + }, + { + "name": "search", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "userIds", + "schema": "array", + "required": false, + "description": "The unique identifiers of the users." + }, + { + "name": "externalId", + "schema": "string", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/end-users", + "method": "createNewUser", + "httpMethod": HttpMethodsEnum.POST, + "tag": "End Users", + "typeScriptTag": "endUsers", + "description": "Create End User", + "parameters": [ + { + "name": "external_id", + "schema": "string", + "required": true, + "description": "", + "example": "EXTERNAL_ID" + } + ], + "responses": [ + { + "statusCode": "201", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "409", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/end-users/{id}", + "method": "getUserById", + "httpMethod": HttpMethodsEnum.GET, + "tag": "End Users", + "typeScriptTag": "endUsers", + "description": "Get End User", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the end user to retrieve.", + "example": "ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/authorization-tokens", + "method": "list", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Authorization Tokens", + "typeScriptTag": "authorizationTokens", + "description": "List Authorization Tokens", + "parameters": [ + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number to fetch.", + "default": 1 + }, + { + "name": "size", + "schema": "integer", + "required": false, + "description": "The number of items per page.", + "default": 50 + }, + { + "name": "userIds", + "schema": "array", + "required": false, + "description": "The unique identifiers of the users." + }, + { + "name": "userTypes", + "schema": "array", + "required": false, + "description": "User types to filter. Only end users are currently supported." + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/authorization-tokens", + "method": "issueToken", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Authorization Tokens", + "typeScriptTag": "authorizationTokens", + "description": "Issue Authorization Token", + "parameters": [ + { + "name": "user_type", + "schema": "undefined", + "required": true, + "description": "" + }, + { + "name": "user_id", + "schema": "string", + "required": true, + "description": "", + "example": "USER_ID" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/authorization-tokens/{id}", + "method": "deleteToken", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "Authorization Tokens", + "typeScriptTag": "authorizationTokens", + "description": "Delete Authorization Token", + "parameters": [ + { + "name": "id", + "schema": "string", + "required": true, + "description": "ID of the authorization token to delete.", + "example": "ID" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Successful Response" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "404", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + }, + { + "url": "/api/v1/web-devices", + "method": "getList", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Web Devices", + "typeScriptTag": "webDevices", + "description": "List Web Devices", + "parameters": [ + { + "name": "page", + "schema": "integer", + "required": false, + "description": "The page number to fetch.", + "default": 1 + }, + { + "name": "size", + "schema": "integer", + "required": false, + "description": "The number of items per page.", + "default": 50 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "401", + "description": "" + }, + { + "statusCode": "403", + "description": "" + }, + { + "statusCode": "408", + "description": "" + }, + { + "statusCode": "422", + "description": "" + }, + { + "statusCode": "429", + "description": "" + }, + { + "statusCode": "500", + "description": "" + } + ] + } +] + } + language="TypeScript" + apiTitle="Fordefi API" + apiBaseUrl="https://api.fordefi.com/" + apiVersion="0.2.0" + endpoints={38} + sdkMethods={44} + schemas={526} + parameters={146} + difficulty="Hard" + openApiRaw="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/fordefi/openapi.yaml" + openApiGitHubUi="https://github.com/konfig-sdks/openapi-examples/tree/HEAD/fordefi/openapi.yaml" + developerDocumentation="docs.fordefi.com/reference/api-overview" + /> + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/golioth/index.tsx b/generator/konfig-docs/src/pages/sdk/golioth/index.tsx new file mode 100644 index 000000000..a7e3ede13 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/golioth/index.tsx @@ -0,0 +1,63 @@ +import React from 'react'; +import { Company } from '../../../components/Company'; + +const sdks = [ + { + "name": "Golioth", + "numberOfMethods": 106, + "categories": [ + "iot", + "hardware" + ], + "index": "golioth/typescript", + "language": "TypeScript", + "link": "/sdk/golioth/typescript/", + "developerDocumentation": "docs.golioth.io/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/golioth/openapi.yaml" + }, + { + "name": "Golioth", + "numberOfMethods": 106, + "categories": [ + "iot", + "hardware" + ], + "index": "golioth/python", + "language": "Python", + "link": "/sdk/golioth/python/", + "developerDocumentation": "docs.golioth.io/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/golioth/openapi.yaml" + }, + { + "name": "Golioth", + "numberOfMethods": 106, + "categories": [ + "iot", + "hardware" + ], + "index": "golioth/java", + "language": "Java", + "link": "/sdk/golioth/java/", + "developerDocumentation": "docs.golioth.io/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/golioth/openapi.yaml" + } +]; + +export default function Golioth() { + const allCategories: string[] = Array.from( + new Set(sdks.flatMap((service) => service.categories)), + ) + return ( + + ) +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/golioth/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/golioth/typescript/_first-request.mdx new file mode 100644 index 000000000..97124712a --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/golioth/typescript/_first-request.mdx @@ -0,0 +1,4 @@ +```typescript index.ts +// +const createResponse = golioth.artifacts.create() +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/golioth/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/golioth/typescript/_getting-started.mdx new file mode 100644 index 000000000..34cd53171 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/golioth/typescript/_getting-started.mdx @@ -0,0 +1,8 @@ +```typescript index.ts +import { Golioth } from 'golioth-typescript-sdk'; + +const golioth = new Golioth({ + bearer: "AUTHORIZATION", + apiKey: "X_API_KEY" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/golioth/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/golioth/typescript/index.tsx new file mode 100644 index 000000000..82e8810e1 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/golioth/typescript/index.tsx @@ -0,0 +1,4657 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function GoliothTypeScriptSdk() { + return ( + + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/griffin/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/griffin/typescript/index.tsx index e36dccc12..0ed8a3d84 100644 --- a/generator/konfig-docs/src/pages/sdk/griffin/typescript/index.tsx +++ b/generator/konfig-docs/src/pages/sdk/griffin/typescript/index.tsx @@ -21,7 +21,7 @@ Griffin is authorised (with restrictions) by the PRA and FCA and backed by leadi companyKebabCase="griffin" clientNameCamelCase="griffin" homepage="griffin.com" - lastUpdated={new Date("2024-03-25T20:47:15.965Z")} + lastUpdated={new Date("2024-03-29T22:11:39.095Z")} faviconUrl="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/griffin/favicon.png" // Missing contactUrl // Missing contactEmail @@ -3235,7 +3235,7 @@ Griffin is authorised (with restrictions) by the PRA and FCA and backed by leadi sdkMethods={69} schemas={82} parameters={199} - difficulty="Medium" + difficulty="Easy" openApiRaw="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/griffin/openapi.yaml" openApiGitHubUi="https://github.com/konfig-sdks/openapi-examples/tree/HEAD/griffin/openapi.yaml" developerDocumentation="docs.griffin.com/api" diff --git a/generator/konfig-docs/src/pages/sdk/ilert/index.tsx b/generator/konfig-docs/src/pages/sdk/ilert/index.tsx new file mode 100644 index 000000000..aaad04033 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/ilert/index.tsx @@ -0,0 +1,66 @@ +import React from 'react'; +import { Company } from '../../../components/Company'; + +const sdks = [ + { + "name": "ilert", + "numberOfMethods": 162, + "categories": [ + "alerting", + "on_call_management", + "incident_communication" + ], + "index": "ilert/typescript", + "language": "TypeScript", + "link": "/sdk/ilert/typescript/", + "developerDocumentation": "api.ilert.com/api-docs", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/ilert/openapi.yaml" + }, + { + "name": "ilert", + "numberOfMethods": 162, + "categories": [ + "alerting", + "on_call_management", + "incident_communication" + ], + "index": "ilert/python", + "language": "Python", + "link": "/sdk/ilert/python/", + "developerDocumentation": "api.ilert.com/api-docs", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/ilert/openapi.yaml" + }, + { + "name": "ilert", + "numberOfMethods": 162, + "categories": [ + "alerting", + "on_call_management", + "incident_communication" + ], + "index": "ilert/java", + "language": "Java", + "link": "/sdk/ilert/java/", + "developerDocumentation": "api.ilert.com/api-docs", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/ilert/openapi.yaml" + } +]; + +export default function Ilert() { + const allCategories: string[] = Array.from( + new Set(sdks.flatMap((service) => service.categories)), + ) + return ( + + ) +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/ilert/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/ilert/typescript/_first-request.mdx new file mode 100644 index 000000000..0b117c8a3 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/ilert/typescript/_first-request.mdx @@ -0,0 +1,6 @@ +```typescript index.ts +// Delete the specified user. +const deleteUserResponse = ilert.users.deleteUser({ + userId: "USER-ID" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/ilert/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/ilert/typescript/_getting-started.mdx new file mode 100644 index 000000000..c40552945 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/ilert/typescript/_getting-started.mdx @@ -0,0 +1,8 @@ +```typescript index.ts +import { Ilert } from 'ilert-typescript-sdk'; + +const ilert = new Ilert({ + // The Bearer API key of your user more info. + apiKey: "AUTHORIZATION" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/ilert/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/ilert/typescript/index.tsx new file mode 100644 index 000000000..615d486ba --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/ilert/typescript/index.tsx @@ -0,0 +1,6916 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function IlertTypeScriptSdk() { + return ( + + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/in-mobile/index.tsx b/generator/konfig-docs/src/pages/sdk/in-mobile/index.tsx new file mode 100644 index 000000000..648a6d4ae --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/in-mobile/index.tsx @@ -0,0 +1,70 @@ +import React from 'react'; +import { Company } from '../../../components/Company'; + +const sdks = [ + { + "name": "inMobile", + "numberOfMethods": 36, + "categories": [ + "messaging", + "sms" + ], + "index": "in-mobile/typescript", + "language": "TypeScript", + "link": "/sdk/in-mobile/typescript/", + "developerDocumentation": "www.inmobile.com/docs/rest-api", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/inmobile/openapi.yaml" + }, + { + "name": "inMobile", + "numberOfMethods": 36, + "categories": [ + "messaging", + "sms" + ], + "index": "in-mobile/python", + "language": "Python", + "link": "/sdk/in-mobile/python/", + "developerDocumentation": "www.inmobile.com/docs/rest-api", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/inmobile/openapi.yaml" + }, + { + "name": "inMobile", + "numberOfMethods": 36, + "categories": [ + "messaging", + "sms" + ], + "index": "in-mobile/java", + "language": "Java", + "link": "/sdk/in-mobile/java/", + "developerDocumentation": "www.inmobile.com/docs/rest-api", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/inmobile/openapi.yaml" + } +]; + +export default function InMobile() { + const allCategories: string[] = Array.from( + new Set(sdks.flatMap((service) => service.categories)), + ) + return ( + + ) +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/in-mobile/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/in-mobile/typescript/_first-request.mdx new file mode 100644 index 000000000..e43942337 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/in-mobile/typescript/_first-request.mdx @@ -0,0 +1,4 @@ +```typescript index.ts +// Returns all blacklists (Paged result. Follow _links.next to fetch all) +const getAllResponse = inMobile.blacklist.getAll() +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/in-mobile/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/in-mobile/typescript/_getting-started.mdx new file mode 100644 index 000000000..04d489022 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/in-mobile/typescript/_getting-started.mdx @@ -0,0 +1,11 @@ +```typescript index.ts +import { InMobile } from 'in-mobile-typescript-sdk'; + +const inMobile = new InMobile({ + // Provide Basic Authentiation with an arbitrary username and your api key as password, e.g. some_value_to_be_ignored:your_api_key_here + username: "USERNAME", + password: "PASSWORD", + // Specify your apikey in the url as https://api.inmobile.com/some/path?apikey=your_api_key_here. This method is only recommended if basic authorization is not possible. + queryParameter: "APIKEY" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/in-mobile/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/in-mobile/typescript/index.tsx new file mode 100644 index 000000000..c579c1e59 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/in-mobile/typescript/index.tsx @@ -0,0 +1,1567 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function InMobileTypeScriptSdk() { + return ( + + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/innoship/index.tsx b/generator/konfig-docs/src/pages/sdk/innoship/index.tsx new file mode 100644 index 000000000..cc1e0b451 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/innoship/index.tsx @@ -0,0 +1,74 @@ +import React from 'react'; +import { Company } from '../../../components/Company'; + +const sdks = [ + { + "name": "Innoship", + "numberOfMethods": 51, + "categories": [ + "shipping_api", + "logistics_provider", + "shipping_integration" + ], + "index": "innoship/typescript", + "language": "TypeScript", + "link": "/sdk/innoship/typescript/", + "developerDocumentation": "api.innoship.io/index.html", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/innoship/openapi.yaml" + }, + { + "name": "Innoship", + "numberOfMethods": 51, + "categories": [ + "shipping_api", + "logistics_provider", + "shipping_integration" + ], + "index": "innoship/python", + "language": "Python", + "link": "/sdk/innoship/python/", + "developerDocumentation": "api.innoship.io/index.html", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/innoship/openapi.yaml" + }, + { + "name": "Innoship", + "numberOfMethods": 51, + "categories": [ + "shipping_api", + "logistics_provider", + "shipping_integration" + ], + "index": "innoship/java", + "language": "Java", + "link": "/sdk/innoship/java/", + "developerDocumentation": "api.innoship.io/index.html", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/innoship/openapi.yaml" + } +]; + +export default function Innoship() { + const allCategories: string[] = Array.from( + new Set(sdks.flatMap((service) => service.categories)), + ) + return ( + + ) +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/innoship/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/innoship/typescript/_first-request.mdx new file mode 100644 index 000000000..f5df30673 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/innoship/typescript/_first-request.mdx @@ -0,0 +1,7 @@ +```typescript index.ts +// +const getDetailResponse = innoship.clientLocation.getDetail({ + apiVersion: "API-VERSION" + apiVersion: "1.0" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/innoship/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/innoship/typescript/_getting-started.mdx new file mode 100644 index 000000000..a5b9016e6 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/innoship/typescript/_getting-started.mdx @@ -0,0 +1,7 @@ +```typescript index.ts +import { Innoship } from 'innoship-typescript-sdk'; + +const innoship = new Innoship({ + apiKeyAuth: "X_API_KEY" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/innoship/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/innoship/typescript/index.tsx new file mode 100644 index 000000000..b67dab2ed --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/innoship/typescript/index.tsx @@ -0,0 +1,2987 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function InnoshipTypeScriptSdk() { + return ( + + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/keatext-ai/index.tsx b/generator/konfig-docs/src/pages/sdk/keatext-ai/index.tsx new file mode 100644 index 000000000..a6a0ac6e0 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/keatext-ai/index.tsx @@ -0,0 +1,72 @@ +import React from 'react'; +import { Company } from '../../../components/Company'; + +const sdks = [ + { + "name": "Keatext AI", + "numberOfMethods": 21, + "categories": [ + "ai", + "nlp", + "text", + "text_analytics", + "ai_text" + ], + "index": "keatext-ai/typescript", + "language": "TypeScript", + "link": "/sdk/keatext-ai/typescript/", + "developerDocumentation": "developer.keatext.ai/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/keatext-ai/openapi.yaml" + }, + { + "name": "Keatext AI", + "numberOfMethods": 21, + "categories": [ + "ai", + "nlp", + "text", + "text_analytics", + "ai_text" + ], + "index": "keatext-ai/python", + "language": "Python", + "link": "/sdk/keatext-ai/python/", + "developerDocumentation": "developer.keatext.ai/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/keatext-ai/openapi.yaml" + }, + { + "name": "Keatext AI", + "numberOfMethods": 21, + "categories": [ + "ai", + "nlp", + "text", + "text_analytics", + "ai_text" + ], + "index": "keatext-ai/java", + "language": "Java", + "link": "/sdk/keatext-ai/java/", + "developerDocumentation": "developer.keatext.ai/", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/keatext-ai/openapi.yaml" + } +]; + +export default function KeatextAi() { + const allCategories: string[] = Array.from( + new Set(sdks.flatMap((service) => service.categories)), + ) + return ( + + ) +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/keatext-ai/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/keatext-ai/typescript/_first-request.mdx new file mode 100644 index 000000000..1b332eb01 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/keatext-ai/typescript/_first-request.mdx @@ -0,0 +1,9 @@ +```typescript index.ts +// Get Statement Groups +const getStatementGroupsResponse = keatextAi.analytics.getStatementGroups({ + authorization: "Bearer ZW1haWxAZXhhbXBsZS5jb206cGFzc3dvcmQ=" + limit: 15 + orgId: "qU7zwuA6JQNw7fy8zut4VW5C" + filters: [{"type":"isKnown","field":"5a6658f1abb99b1a00f39451:myField"}] +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/keatext-ai/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/keatext-ai/typescript/_getting-started.mdx new file mode 100644 index 000000000..a4ba2c0d6 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/keatext-ai/typescript/_getting-started.mdx @@ -0,0 +1,5 @@ +```typescript index.ts +import { KeatextAi } from 'keatext-ai-typescript-sdk'; + +const keatextAi = new KeatextAi() +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/keatext-ai/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/keatext-ai/typescript/index.tsx new file mode 100644 index 000000000..ade42f643 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/keatext-ai/typescript/index.tsx @@ -0,0 +1,1128 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function KeatextAiTypeScriptSdk() { + return ( + NY" + }, + { + "name": "primaryDate", + "schema": "string", + "description": "", + "example": "entry_date" + }, + { + "name": "customerId", + "schema": "string", + "description": "", + "example": "client_id" + }, + { + "name": "primaryKey", + "schema": "string", + "description": "", + "example": "response_id" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Dataset successfully updated" + } + ] + }, + { + "url": "/datasets", + "method": "getOrganizationData", + "httpMethod": HttpMethodsEnum.GET, + "tag": "datasets", + "typeScriptTag": "datasets", + "description": "Get an Organization's Datasets", + "parameters": [ + { + "name": "authorization", + "schema": "string", + "required": true, + "description": "The [authorization token](https://developer.keatext.ai/.", + "example": "Bearer ZW1haWxAZXhhbXBsZS5jb206cGFzc3dvcmQ=" + }, + { + "name": "orgId", + "schema": "string", + "required": true, + "description": "The organization's id.", + "example": "592dc9a6afbf6d1b0095f097" + }, + { + "name": "limit", + "schema": "integer", + "required": false, + "description": "The number of items to include in the result set.", + "default": 15 + }, + { + "name": "offset", + "schema": "integer", + "required": false, + "description": "The starting position of the result set.", + "default": 0 + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/datasets", + "method": "addRecords", + "httpMethod": HttpMethodsEnum.POST, + "tag": "datasets", + "typeScriptTag": "datasets", + "description": "Create a Dataset", + "parameters": [ + { + "name": "authorization", + "schema": "string", + "required": true, + "description": "The [authorization token](https://developer.keatext.ai/.", + "example": "Bearer ZW1haWxAZXhhbXBsZS5jb206cGFzc3dvcmQ=" + }, + { + "name": "description", + "schema": "string", + "required": false, + "description": "", + "example": "Reviews for New York stores for Summer 2018" + }, + { + "name": "id", + "schema": "undefined", + "required": false, + "description": "" + }, + { + "name": "orgId", + "schema": "string", + "required": true, + "description": "", + "example": "592dc9a6afbf6d1b0095f097" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "Summer 2018 <> NY" + }, + { + "name": "fields", + "schema": "array", + "required": true, + "description": "", + "example": [ + { + "key": "review_id", + "name": "Review ID", + "type": "number" + }, + { + "key": "review_date", + "name": "Review Date", + "type": "datetime", + "dateFormat": "YYYY-MM-DD" + }, + { + "key": "author_id", + "name": "Author ID", + "type": "number" + }, + { + "key": "review_content", + "name": "Review Content", + "type": "string", + "analyze": true + }, + { + "key": "borough", + "name": "Borough", + "type": "string", + "analyze": false + } + ] + }, + { + "name": "primaryDate", + "schema": "undefined", + "required": false, + "description": "" + }, + { + "name": "customerId", + "schema": "undefined", + "required": false, + "description": "" + }, + { + "name": "primaryKey", + "schema": "undefined", + "required": false, + "description": "" + }, + { + "name": "recordCount", + "schema": "number", + "required": false, + "description": "", + "example": 12635 + }, + { + "name": "createdBy", + "schema": "string", + "required": false, + "description": "", + "example": "auth0|592dc9a5c272ed7010e51d35" + }, + { + "name": "createdAt", + "schema": "string", + "required": false, + "description": "", + "example": "2018-09-07T22:57:19.026Z" + }, + { + "name": "updatedAt", + "schema": "string", + "required": false, + "description": "", + "example": "2018-10-19T08:23:11.098Z" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/datasets/{datasetId}/fields", + "method": "addFieldToDataset", + "httpMethod": HttpMethodsEnum.POST, + "tag": "datasets", + "typeScriptTag": "datasets", + "description": "Create a Dataset Field", + "parameters": [ + { + "name": "authorization", + "schema": "string", + "required": true, + "description": "The [authorization token](https://developer.keatext.ai/.", + "example": "Bearer ZW1haWxAZXhhbXBsZS5jb206cGFzc3dvcmQ=" + }, + { + "name": "key", + "schema": "string", + "required": true, + "description": "", + "example": "KEY" + }, + { + "name": "name", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "type", + "schema": "string", + "required": true, + "description": "", + "example": "TYPE" + }, + { + "name": "analyze", + "schema": "boolean", + "required": false, + "description": "", + "default": false + }, + { + "name": "dateFormat", + "schema": "string", + "required": false, + "description": "" + }, + { + "name": "isVisible", + "schema": "boolean", + "required": false, + "description": "", + "default": true + } + ], + "responses": [ + { + "statusCode": "201", + "description": "Field successfully created" + } + ] + }, + { + "url": "/datasets/{datasetId}/fields/{fieldKey}", + "method": "removeField", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "datasets", + "typeScriptTag": "datasets", + "description": "Delete a Dataset Field", + "parameters": [ + { + "name": "authorization", + "schema": "string", + "required": true, + "description": "The [authorization token](https://developer.keatext.ai/.", + "example": "Bearer ZW1haWxAZXhhbXBsZS5jb206cGFzc3dvcmQ=" + }, + { + "name": "fieldKey", + "schema": "string", + "required": true, + "description": "The field's unique identifier.", + "example": "customer_response_1" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Field successfully deleted" + } + ] + }, + { + "url": "/datasets/{datasetId}/fields/{fieldKey}", + "method": "updateFieldVisibility", + "httpMethod": HttpMethodsEnum.PATCH, + "tag": "datasets", + "typeScriptTag": "datasets", + "description": "Update a Dataset Field", + "parameters": [ + { + "name": "authorization", + "schema": "string", + "required": true, + "description": "The [authorization token](https://developer.keatext.ai/.", + "example": "Bearer ZW1haWxAZXhhbXBsZS5jb206cGFzc3dvcmQ=" + }, + { + "name": "fieldKey", + "schema": "string", + "required": true, + "description": "The field's unique identifier.", + "example": "customer_response_1" + }, + { + "name": "name", + "schema": "string", + "description": "" + }, + { + "name": "isVisible", + "schema": "boolean", + "description": "" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Field successfully updated" + } + ] + }, + { + "url": "/datasets/{datasetId}/records", + "method": "ingestRecords", + "httpMethod": HttpMethodsEnum.POST, + "tag": "datasets", + "typeScriptTag": "datasets", + "description": "Populate a Dataset", + "parameters": [ + { + "name": "undefined", + "schema": "undefined", + "description": "The dataset's id.", + "example": "XdzFGgUhXsf7" + }, + { + "name": "authorization", + "schema": "string", + "required": true, + "description": "The [authorization token](https://developer.keatext.ai/.", + "example": "Bearer ZW1haWxAZXhhbXBsZS5jb206cGFzc3dvcmQ=" + }, + { + "name": "records", + "schema": "array", + "required": true, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/organizations", + "method": "listYour", + "httpMethod": HttpMethodsEnum.GET, + "tag": "organizations", + "typeScriptTag": "organizations", + "description": "Get Your Organizations", + "parameters": [ + { + "name": "authorization", + "schema": "string", + "required": true, + "description": "The [authorization token](https://developer.keatext.ai/.", + "example": "Bearer ZW1haWxAZXhhbXBsZS5jb206cGFzc3dvcmQ=" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/organizations", + "method": "createOrganization", + "httpMethod": HttpMethodsEnum.POST, + "tag": "organizations", + "typeScriptTag": "organizations", + "description": "Create an Organization", + "parameters": [ + { + "name": "authorization", + "schema": "string", + "required": true, + "description": "The [authorization token](https://developer.keatext.ai/.", + "example": "Bearer ZW1haWxAZXhhbXBsZS5jb206cGFzc3dvcmQ=" + }, + { + "name": "id", + "schema": "string", + "required": false, + "description": "", + "example": "qU7zwuA6JQNw7fy8zut4VW5C" + }, + { + "name": "ownerId", + "schema": "string", + "required": false, + "description": "", + "example": "auth0|592dc9a5c272ed7010e51d35" + }, + { + "name": "name", + "schema": "string", + "required": true, + "description": "", + "example": "Mulberry and Sons" + }, + { + "name": "createdAt", + "schema": "string", + "required": false, + "description": "", + "example": "2017-09-07 22:57:19.026+00" + }, + { + "name": "updatedAt", + "schema": "string", + "required": false, + "description": "", + "example": "2018-10-19 08:23:11.098+00" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/organizations/{organizationId}", + "method": "deleteOrganizationPermanently", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "organizations", + "typeScriptTag": "organizations", + "description": "Delete an Organization", + "parameters": [ + { + "name": "authorization", + "schema": "string", + "required": true, + "description": "The [authorization token](https://developer.keatext.ai/.", + "example": "Bearer ZW1haWxAZXhhbXBsZS5jb206cGFzc3dvcmQ=" + }, + { + "name": "organizationId", + "schema": "string", + "required": true, + "description": "The organization's id.", + "example": "qU7zwuA6JQNw7fy8zut4VW5C" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "Organization successfully deleted" + } + ] + }, + { + "url": "/organizations/{organizationId}/access-url", + "method": "createAndAuthenticateUser", + "httpMethod": HttpMethodsEnum.POST, + "tag": "organizations", + "typeScriptTag": "organizations", + "description": "Create and Authenticate a User", + "parameters": [ + { + "name": "organizationId", + "schema": "string", + "required": true, + "description": "The organization's id.", + "example": "qU7zwuA6JQNw7fy8zut4VW5C" + }, + { + "name": "authorization", + "schema": "string", + "required": true, + "description": "The [authorization token](https://developer.keatext.ai/.", + "example": "Bearer ZW1haWxAZXhhbXBsZS5jb206cGFzc3dvcmQ=" + }, + { + "name": "email", + "schema": "string", + "required": true, + "description": "", + "example": "tom@example.com" + }, + { + "name": "filters", + "schema": "array", + "required": false, + "description": "" + }, + { + "name": "permissions", + "schema": "array", + "required": false, + "description": "" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + } + ] + }, + { + "url": "/organizations/{organizationId}/users", + "method": "revokeAccess", + "httpMethod": HttpMethodsEnum.DELETE, + "tag": "organizations", + "typeScriptTag": "organizations", + "description": "Remove a User", + "parameters": [ + { + "name": "authorization", + "schema": "string", + "required": true, + "description": "The [authorization token](https://developer.keatext.ai/.", + "example": "Bearer ZW1haWxAZXhhbXBsZS5jb206cGFzc3dvcmQ=" + }, + { + "name": "organizationId", + "schema": "string", + "required": true, + "description": "The organization's id.", + "example": "qU7zwuA6JQNw7fy8zut4VW5C" + }, + { + "name": "email", + "schema": "string", + "description": "The user's encoded email address.", + "example": "tom%40example.com" + } + ], + "responses": [ + { + "statusCode": "204", + "description": "User successfully removed" + } + ] + }, + { + "url": "/", + "method": "listAvailableFilters", + "httpMethod": HttpMethodsEnum.OPTIONS, + "tag": "filters", + "typeScriptTag": "filters", + "description": "Available filters", + "parameters": [ + { + "name": "isKnown", + "schema": "undefined", + "description": "" + }, + { + "name": "isUnknown", + "schema": "undefined", + "description": "" + }, + { + "name": "greaterThan", + "schema": "undefined", + "description": "" + }, + { + "name": "smallerThan", + "schema": "undefined", + "description": "" + }, + { + "name": "equal", + "schema": "undefined", + "description": "" + }, + { + "name": "dateFriendly", + "schema": "undefined", + "description": "" + }, + { + "name": "primaryDate", + "schema": "undefined", + "description": "" + }, + { + "name": "before", + "schema": "undefined", + "description": "" + }, + { + "name": "after", + "schema": "undefined", + "description": "" + }, + { + "name": "beforeOrEqual", + "schema": "undefined", + "description": "" + }, + { + "name": "afterOrEqual", + "schema": "undefined", + "description": "" + }, + { + "name": "inDateRange", + "schema": "undefined", + "description": "" + }, + { + "name": "contains", + "schema": "undefined", + "description": "" + }, + { + "name": "doesNotContain", + "schema": "undefined", + "description": "" + }, + { + "name": "matches", + "schema": "undefined", + "description": "" + }, + { + "name": "notMatches", + "schema": "undefined", + "description": "" + }, + { + "name": "source", + "schema": "undefined", + "description": "" + }, + { + "name": "matchesOpinion", + "schema": "undefined", + "description": "" + }, + { + "name": "matchesTopic", + "schema": "undefined", + "description": "" + }, + { + "name": "matchesIndicator", + "schema": "undefined", + "description": "" + }, + { + "name": "matchesKeyword", + "schema": "undefined", + "description": "" + }, + { + "name": "matchesLabel", + "schema": "undefined", + "description": "" + }, + { + "name": "labelIsKnown", + "schema": "undefined", + "description": "" + } + ], + "responses": [ + { + "statusCode": "default", + "description": "Default response" + } + ] + } +] + } + language="TypeScript" + apiTitle="Keatext Partner API" + apiBaseUrl="https://icarusapi.keatext.ai/api" + apiVersion="2.0.0" + endpoints={17} + sdkMethods={39} + schemas={76} + parameters={135} + difficulty="Easy" + openApiRaw="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/keatext-ai/openapi.yaml" + openApiGitHubUi="https://github.com/konfig-sdks/openapi-examples/tree/HEAD/keatext-ai/openapi.yaml" + developerDocumentation="developer.keatext.ai/" + /> + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/kombo/index.tsx b/generator/konfig-docs/src/pages/sdk/kombo/index.tsx new file mode 100644 index 000000000..b63916f0a --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/kombo/index.tsx @@ -0,0 +1,69 @@ +import React from 'react'; +import { Company } from '../../../components/Company'; + +const sdks = [ + { + "name": "Kombo", + "numberOfMethods": 54, + "categories": [ + "integrations", + "ats", + "hris", + "payroll" + ], + "index": "kombo/typescript", + "language": "TypeScript", + "link": "/sdk/kombo/typescript/", + "developerDocumentation": "docs.kombo.dev", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/kombo/openapi.yaml" + }, + { + "name": "Kombo", + "numberOfMethods": 54, + "categories": [ + "integrations", + "ats", + "hris", + "payroll" + ], + "index": "kombo/python", + "language": "Python", + "link": "/sdk/kombo/python/", + "developerDocumentation": "docs.kombo.dev", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/kombo/openapi.yaml" + }, + { + "name": "Kombo", + "numberOfMethods": 54, + "categories": [ + "integrations", + "ats", + "hris", + "payroll" + ], + "index": "kombo/java", + "language": "Java", + "link": "/sdk/kombo/java/", + "developerDocumentation": "docs.kombo.dev", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/kombo/openapi.yaml" + } +]; + +export default function Kombo() { + const allCategories: string[] = Array.from( + new Set(sdks.flatMap((service) => service.categories)), + ) + return ( + + ) +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/kombo/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/kombo/typescript/_first-request.mdx new file mode 100644 index 000000000..819652082 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/kombo/typescript/_first-request.mdx @@ -0,0 +1,4 @@ +```typescript index.ts +// Check API key +const verifyApiKeyResponse = kombo.general.verifyApiKey() +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/kombo/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/kombo/typescript/_getting-started.mdx new file mode 100644 index 000000000..05ab0444e --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/kombo/typescript/_getting-started.mdx @@ -0,0 +1,8 @@ +```typescript index.ts +import { Kombo } from 'kombo-typescript-sdk'; + +const kombo = new Kombo({ + // Create an API key on the [Secrets](https://app.kombo.dev/secrets) page in the Kombo dashboard. + apiKey: "API_KEY" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/kombo/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/kombo/typescript/index.tsx new file mode 100644 index 000000000..eaac45d8b --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/kombo/typescript/index.tsx @@ -0,0 +1,2982 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function KomboTypeScriptSdk() { + return ( + + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/localizely/index.tsx b/generator/konfig-docs/src/pages/sdk/localizely/index.tsx new file mode 100644 index 000000000..86b645c0a --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/localizely/index.tsx @@ -0,0 +1,69 @@ +import React from 'react'; +import { Company } from '../../../components/Company'; + +const sdks = [ + { + "name": "Localizely", + "numberOfMethods": 4, + "categories": [ + "language", + "translation" + ], + "index": "localizely/typescript", + "language": "TypeScript", + "link": "/sdk/localizely/typescript/", + "developerDocumentation": "api.localizely.com/swagger-ui/index.html", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/localizely/openapi.yaml" + }, + { + "name": "Localizely", + "numberOfMethods": 4, + "categories": [ + "language", + "translation" + ], + "index": "localizely/python", + "language": "Python", + "link": "/sdk/localizely/python/", + "developerDocumentation": "api.localizely.com/swagger-ui/index.html", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/localizely/openapi.yaml" + }, + { + "name": "Localizely", + "numberOfMethods": 4, + "categories": [ + "language", + "translation" + ], + "index": "localizely/java", + "language": "Java", + "link": "/sdk/localizely/java/", + "developerDocumentation": "api.localizely.com/swagger-ui/index.html", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/localizely/openapi.yaml" + } +]; + +export default function Localizely() { + const allCategories: string[] = Array.from( + new Set(sdks.flatMap((service) => service.categories)), + ) + return ( + + ) +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/localizely/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/localizely/typescript/_first-request.mdx new file mode 100644 index 000000000..fbbf2c752 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/localizely/typescript/_first-request.mdx @@ -0,0 +1,8 @@ +```typescript index.ts +// Upload translations for a language +const languageTranslationsUploadResponse = localizely.uploadApi.languageTranslationsUpload({ + projectId: "PROJECT_ID" + langCode: "LANG_CODE" + file: "FILE" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/localizely/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/localizely/typescript/_getting-started.mdx new file mode 100644 index 000000000..32d8a4d7c --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/localizely/typescript/_getting-started.mdx @@ -0,0 +1,7 @@ +```typescript index.ts +import { Localizely } from 'localizely-typescript-sdk'; + +const localizely = new Localizely({ + apiAuth: "X_API_TOKEN" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/localizely/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/localizely/typescript/index.tsx new file mode 100644 index 000000000..eb1eea5e0 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/localizely/typescript/index.tsx @@ -0,0 +1,292 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function LocalizelyTypeScriptSdk() { + return ( +
    Multiple tags can be defined in a following way: `&tag_added_keys=NEW&tag_added_keys=NEW_SPRINT05`" + }, + { + "name": "tagUpdated", + "schema": "array", + "required": false, + "description": "Optional list of tags to add to updated translations from uploading file.

    Multiple tags can be defined in a following way: `&tag_updated_keys=UPDATED&tag_updated_keys=UPDATED_SPRINT05`" + }, + { + "name": "tagRemoved", + "schema": "array", + "required": false, + "description": "Optional list of tags to add to removed translations from uploading file.

    Multiple tags can be defined in a following way: `&tag_removed_keys=REMOVED&tag_removed_keys=REMOVED_SPRINT05`" + }, + { + "name": "file", + "schema": "string", + "required": true, + "description": "", + "example": "FILE" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "OK, file uploaded" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/v1/projects/{project_id}/branches/{branch}", + "method": "createNewBranch", + "httpMethod": HttpMethodsEnum.POST, + "tag": "Branch API", + "typeScriptTag": "branchApi", + "description": "Create a new branch", + "parameters": [ + { + "name": "projectId", + "schema": "string", + "required": true, + "description": "Project ID - Can be found on 'My projects' page", + "example": "PROJECT_ID" + }, + { + "name": "branch", + "schema": "string", + "required": true, + "description": "Name of the branch to be created", + "example": "BRANCH" + }, + { + "name": "sourceBranch", + "schema": "string", + "required": true, + "description": "Name of the source branch from which new branch will be created", + "example": "SOURCE_BRANCH" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "OK, created" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/v1/projects/{project_id}/status", + "method": "getProjectStatus", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Translation Status API", + "typeScriptTag": "translationStatusApi", + "description": "Get Translation Status for the project", + "parameters": [ + { + "name": "projectId", + "schema": "string", + "required": true, + "description": "Project ID - Can be found on 'My projects' page", + "example": "PROJECT_ID" + }, + { + "name": "branch", + "schema": "string", + "required": false, + "description": "Name of the branch to get translation status for. Only in case of activated branching feature." + } + ], + "responses": [ + { + "statusCode": "200", + "description": "" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + }, + { + "url": "/v1/projects/{project_id}/files/download", + "method": "translationsDownload", + "httpMethod": HttpMethodsEnum.GET, + "tag": "Download API", + "typeScriptTag": "downloadApi", + "description": "Download translations for a language in a specified file format", + "parameters": [ + { + "name": "projectId", + "schema": "string", + "required": true, + "description": "Project ID - Can be found on 'My projects' page", + "example": "PROJECT_ID" + }, + { + "name": "branch", + "schema": "string", + "required": false, + "description": "Name of the branch to download file from. Only in case of activated branching feature." + }, + { + "name": "langCodes", + "schema": "string", + "required": false, + "description": "Language to download, specified as language code. e.g. `en`, `en_GB` or `en-GB`. For multiple languages use comma separator. If omitted, all languages are downloaded." + }, + { + "name": "type", + "schema": "string", + "required": true, + "description": "File format", + "example": "TYPE" + }, + { + "name": "javaPropertiesEncoding", + "schema": "string", + "required": false, + "description": "(Only for Java .properties files download) Character encoding. Default is `latin_1`." + }, + { + "name": "includeTags", + "schema": "array", + "required": false, + "description": "Optional list of tags to be downloaded.
    If not set, all string keys will be considered for download.

    Multiple tags can be defined in a following way: `&include_tags=ANDROID&include_tags=ANDROID_SPRINT05`." + }, + { + "name": "excludeTags", + "schema": "array", + "required": false, + "description": "Optional list of tags to be excluded from download.
    If not set, all string keys will be considered for download.

    Multiple tags can be defined in a following way: `&exclude_tags=REMOVED&exclude_tags=REMOVED_SPRINT05`." + }, + { + "name": "exportEmptyAs", + "schema": "string", + "required": false, + "description": "Optional. How you would like empty translations to be exported. Allowed values are `empty` to keep empty, `main` to replace with the main language value, or `skip` to omit.", + "default": "empty" + } + ], + "responses": [ + { + "statusCode": "200", + "description": "OK, file returned" + }, + { + "statusCode": "400", + "description": "" + }, + { + "statusCode": "404", + "description": "" + } + ] + } +] + } + language="TypeScript" + apiTitle="Localizely API" + apiBaseUrl="https://api.localizely.com" + apiVersion="1.2.1" + endpoints={4} + sdkMethods={4} + schemas={6} + parameters={22} + difficulty="Very Easy" + openApiRaw="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/localizely/openapi.yaml" + openApiGitHubUi="https://github.com/konfig-sdks/openapi-examples/tree/HEAD/localizely/openapi.yaml" + developerDocumentation="api.localizely.com/swagger-ui/index.html" + /> + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/lucca/timmi-absences/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/lucca/timmi-absences/typescript/index.tsx index a04a42d09..ad0fdb13f 100644 --- a/generator/konfig-docs/src/pages/sdk/lucca/timmi-absences/typescript/index.tsx +++ b/generator/konfig-docs/src/pages/sdk/lucca/timmi-absences/typescript/index.tsx @@ -19,7 +19,7 @@ Crรฉรฉe en dรฉcembre 2011, Nereo propose dรฉjร  une solution complรจte de gestio companyKebabCase="lucca" clientNameCamelCase="luccaTimmiAbsences" homepage="lucca-hr.com" - lastUpdated={new Date("2024-03-26T19:55:14.920Z")} + lastUpdated={new Date("2024-03-29T22:11:39.095Z")} faviconUrl="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/lucca/timmi-absences/favicon.png" contactUrl="https://www.lucca.fr" contactEmail="developers@lucca.fr" @@ -240,7 +240,7 @@ Crรฉรฉe en dรฉcembre 2011, Nereo propose dรฉjร  une solution complรจte de gestio "httpMethod": HttpMethodsEnum.POST, "tag": "Imports", "typeScriptTag": "imports", - "description": "Import entitlements (deprecated)", + "description": "Import entitlements (https://developers.lucca.fr/", "parameters": [ { "name": "strict", @@ -326,7 +326,7 @@ Crรฉรฉe en dรฉcembre 2011, Nereo propose dรฉjร  une solution complรจte de gestio "httpMethod": HttpMethodsEnum.POST, "tag": "Imports", "typeScriptTag": "imports", - "description": "Replace entitlements (deprecated)", + "description": "Replace entitlements (https://developers.lucca.fr/", "parameters": [ { "name": "strict", @@ -424,7 +424,7 @@ Crรฉรฉe en dรฉcembre 2011, Nereo propose dรฉjร  une solution complรจte de gestio "httpMethod": HttpMethodsEnum.POST, "tag": "Imports", "typeScriptTag": "imports", - "description": "Import leaves (deprecated)", + "description": "Import leaves (https://developers.lucca.fr/", "parameters": [ { "name": "type", @@ -542,7 +542,7 @@ Crรฉรฉe en dรฉcembre 2011, Nereo propose dรฉjร  une solution complรจte de gestio sdkMethods={24} schemas={22} parameters={41} - difficulty="Easy" + difficulty="Very Easy" openApiRaw="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/lucca/timmi-absences/openapi.yaml" openApiGitHubUi="https://github.com/konfig-sdks/openapi-examples/tree/HEAD/lucca/timmi-absences/openapi.yaml" developerDocumentation="developers.lucca.fr/" diff --git a/generator/konfig-docs/src/pages/sdk/mambu/index.tsx b/generator/konfig-docs/src/pages/sdk/mambu/index.tsx new file mode 100644 index 000000000..8bbcc25f2 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/mambu/index.tsx @@ -0,0 +1,67 @@ +import React from 'react'; +import { Company } from '../../../components/Company'; + +const sdks = [ + { + "name": "Payments", + "numberOfMethods": 46, + "categories": [ + "finance", + "banking" + ], + "index": "payments/typescript", + "language": "TypeScript", + "link": "/sdk/mambu/payments/typescript/", + "developerDocumentation": "api.mambu.com/payments-api/#welcome", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/mambu/payments/openapi.yaml" + }, + { + "name": "Payments", + "numberOfMethods": 46, + "categories": [ + "finance", + "banking" + ], + "index": "payments/python", + "language": "Python", + "link": "/sdk/mambu/payments/python/", + "developerDocumentation": "api.mambu.com/payments-api/#welcome", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/mambu/payments/openapi.yaml" + }, + { + "name": "Payments", + "numberOfMethods": 46, + "categories": [ + "finance", + "banking" + ], + "index": "payments/java", + "language": "Java", + "link": "/sdk/mambu/payments/java/", + "developerDocumentation": "api.mambu.com/payments-api/#welcome", + "openapiGitHubUi": "https://github.com/konfig-sdks/openapi-examples/tree/HEAD/mambu/payments/openapi.yaml" + } +]; + +export default function Mambu() { + const allCategories: string[] = Array.from( + new Set(sdks.flatMap((service) => service.categories)), + ) + return ( + + ) +} \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/mambu/payments/typescript/_first-request.mdx b/generator/konfig-docs/src/pages/sdk/mambu/payments/typescript/_first-request.mdx new file mode 100644 index 000000000..0af088dd6 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/mambu/payments/typescript/_first-request.mdx @@ -0,0 +1,7 @@ +```typescript index.ts +// Request deletion of blocking rules for the specified Mambu account. If no request body is provided, all rules for the account will be removed, if you provide a JSON body with a specific mandate ID, only the rule for that mandate will be removed. For more information on blocking SEPA Direct Debits, consult the [Blocking SEPA Direct Debits](https://support.mambu.com/docs/blocking-sepa-direct-debits) article in our user guide. +const removeBlockingRulesResponse = mambuPayments.sepaDirectDebit.removeBlockingRules({ + accountId: "ACCOUNTID" + product: "PRODUCT" +}) +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/mambu/payments/typescript/_getting-started.mdx b/generator/konfig-docs/src/pages/sdk/mambu/payments/typescript/_getting-started.mdx new file mode 100644 index 000000000..22c61d8ec --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/mambu/payments/typescript/_getting-started.mdx @@ -0,0 +1,5 @@ +```typescript index.ts +import { MambuPayments } from 'mambu-payments-typescript-sdk'; + +const mambuPayments = new MambuPayments() +``` \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/mambu/payments/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/mambu/payments/typescript/index.tsx new file mode 100644 index 000000000..f2272ee81 --- /dev/null +++ b/generator/konfig-docs/src/pages/sdk/mambu/payments/typescript/index.tsx @@ -0,0 +1,2559 @@ +import React from "react"; +import { HttpMethodsEnum } from "konfig-lib/dist/forEachOperation"; +// @ts-ignore +import GettingStarted from "./_getting-started.mdx"; +// @ts-ignore +import FirstRequest from "./_first-request.mdx" +import { SdkNew } from "@site/src/components/SdkNew"; + +export default function MambuPaymentsTypeScriptSdk() { + return ( + + ); +} + \ No newline at end of file diff --git a/generator/konfig-docs/src/pages/sdk/measure-one/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/measure-one/typescript/index.tsx index 44c738349..e813741ca 100644 --- a/generator/konfig-docs/src/pages/sdk/measure-one/typescript/index.tsx +++ b/generator/konfig-docs/src/pages/sdk/measure-one/typescript/index.tsx @@ -17,7 +17,7 @@ export default function MeasureOneTypeScriptSdk() { companyKebabCase="measure-one" clientNameCamelCase="measureOne" homepage="measureone.com" - lastUpdated={new Date("2024-03-29T19:11:15.684Z")} + lastUpdated={new Date("2024-03-29T22:11:39.095Z")} faviconUrl="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/measureone/favicon.png" // Missing contactUrl contactEmail="support@measureone.com" @@ -2530,7 +2530,7 @@ export default function MeasureOneTypeScriptSdk() { sdkMethods={36} schemas={298} parameters={189} - difficulty="Medium" + difficulty="Easy" openApiRaw="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/measureone/openapi.yaml" openApiGitHubUi="https://github.com/konfig-sdks/openapi-examples/tree/HEAD/measureone/openapi.yaml" developerDocumentation="docs.measureone.com" diff --git a/generator/konfig-docs/src/pages/sdk/pay-fit/typescript/index.tsx b/generator/konfig-docs/src/pages/sdk/pay-fit/typescript/index.tsx index 6c7c832e8..5c15bf3d4 100644 --- a/generator/konfig-docs/src/pages/sdk/pay-fit/typescript/index.tsx +++ b/generator/konfig-docs/src/pages/sdk/pay-fit/typescript/index.tsx @@ -23,7 +23,7 @@ We have a strong presence in France since 2015 and have been quickly growing in companyKebabCase="pay-fit" clientNameCamelCase="payFit" homepage="payfit.com" - lastUpdated={new Date("2024-03-27T04:52:35.159Z")} + lastUpdated={new Date("2024-03-29T21:57:13.775Z")} faviconUrl="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/payfit/favicon.png" // Missing contactUrl // Missing contactEmail @@ -293,7 +293,7 @@ We have a strong presence in France since 2015 and have been quickly growing in "httpMethod": HttpMethodsEnum.GET, "tag": "Company", "typeScriptTag": "company", - "description": "Get Company (FR)", + "description": "Get Company (https://developers.payfit.io/reference", "parameters": [ { "name": "companyId", @@ -489,7 +489,7 @@ We have a strong presence in France since 2015 and have been quickly growing in "httpMethod": HttpMethodsEnum.GET, "tag": "Contract", "typeScriptTag": "contract", - "description": "List all Contracts (FR)", + "description": "List all Contracts (https://developers.payfit.io/reference", "parameters": [ { "name": "companyId", @@ -547,7 +547,7 @@ We have a strong presence in France since 2015 and have been quickly growing in "httpMethod": HttpMethodsEnum.GET, "tag": "Contract", "typeScriptTag": "contract", - "description": "Get a contract (FR)", + "description": "Get a contract (https://developers.payfit.io/reference", "parameters": [ { "name": "companyId", @@ -964,7 +964,7 @@ We have a strong presence in France since 2015 and have been quickly growing in sdkMethods={19} schemas={111} parameters={46} - difficulty="Easy" + difficulty="Very Easy" openApiRaw="https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/payfit/openapi.yaml" openApiGitHubUi="https://github.com/konfig-sdks/openapi-examples/tree/HEAD/payfit/openapi.yaml" developerDocumentation="developers.payfit.io/reference" diff --git a/generator/konfig-docs/src/pages/sdk/sdk-links.json b/generator/konfig-docs/src/pages/sdk/sdk-links.json index 0ae6113c2..75526ff32 100644 --- a/generator/konfig-docs/src/pages/sdk/sdk-links.json +++ b/generator/konfig-docs/src/pages/sdk/sdk-links.json @@ -1724,6 +1724,37 @@ "subCategory": "Payment Processing", "apiVersion": "1.16.0" }, + { + "index": "finley/typescript", + "link": "/sdk/finley/typescript/", + "homepage": "finleycms.com", + "categories": [ + "debt_capital_raise", + "due_diligence", + "compliance", + "capital_providers_reporting" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/finley/favicon.png", + "parentCategory": "Data", + "subCategory": "Finance", + "apiVersion": "0.0.2" + }, + { + "index": "finshark/typescript", + "link": "/sdk/finshark/typescript/", + "homepage": "finshark.io/", + "categories": [ + "financial_services", + "online_payments", + "fintech", + "payment_solutions", + "payouts" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/finshark/favicon.jpg", + "parentCategory": "Data", + "subCategory": "Finance", + "apiVersion": "v1" + }, { "index": "foodkit/typescript", "link": "/sdk/foodkit/typescript/", @@ -1737,6 +1768,20 @@ "subCategory": "eCommerce", "apiVersion": "6.0" }, + { + "index": "fordefi/typescript", + "link": "/sdk/fordefi/typescript/", + "homepage": "fordefi.com", + "categories": [ + "cryptocurrency", + "web_3", + "mpc_wallet" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/fordefi/favicon.png", + "parentCategory": "Data", + "subCategory": "Finance", + "apiVersion": "0.2.0" + }, { "index": "fountain/typescript", "link": "/sdk/fountain/typescript/", @@ -1893,6 +1938,19 @@ "subCategory": "AI Tools", "apiVersion": "1.0.0" }, + { + "index": "golioth/typescript", + "link": "/sdk/golioth/typescript/", + "homepage": "golioth.io", + "categories": [ + "iot", + "hardware" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/golioth/favicon.png", + "parentCategory": "Artificial Intelligence", + "subCategory": "AI Tools", + "apiVersion": "1.0" + }, { "index": "gorgias/typescript", "link": "/sdk/gorgias/typescript/", @@ -2181,6 +2239,20 @@ "subCategory": "AI Tools", "apiVersion": "1.0" }, + { + "index": "ilert/typescript", + "link": "/sdk/ilert/typescript/", + "homepage": "ilert.com", + "categories": [ + "alerting", + "on_call_management", + "incident_communication" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/ilert/favicon.png", + "parentCategory": "Business Intelligence", + "subCategory": "Compliance & Security", + "apiVersion": "" + }, { "index": "induced-ai/typescript", "link": "/sdk/induced-ai/typescript/", @@ -2196,6 +2268,33 @@ "subCategory": "AI Tools", "apiVersion": "1.0.0" }, + { + "index": "in-mobile/typescript", + "link": "/sdk/in-mobile/typescript/", + "homepage": "inmobile.com", + "categories": [ + "messaging", + "sms" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/inmobile/favicon.jpg", + "parentCategory": "Communication", + "subCategory": "Phone & SMS", + "apiVersion": "version 4" + }, + { + "index": "innoship/typescript", + "link": "/sdk/innoship/typescript/", + "homepage": "innoship.io", + "categories": [ + "shipping_api", + "logistics_provider", + "shipping_integration" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/innoship/favicon.png", + "parentCategory": "Commerce", + "subCategory": "eCommerce", + "apiVersion": "v1" + }, { "index": "insightly/typescript", "link": "/sdk/insightly/typescript/", @@ -2409,6 +2508,22 @@ "subCategory": "CRM (Customer Relationship Management)", "apiVersion": "1.70.0.652598" }, + { + "index": "keatext-ai/typescript", + "link": "/sdk/keatext-ai/typescript/", + "homepage": "www.keatext.ai/", + "categories": [ + "ai", + "nlp", + "text", + "text_analytics", + "ai_text" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/keatext-ai/favicon.png", + "parentCategory": "Artificial Intelligence", + "subCategory": "AI Tools", + "apiVersion": "2.0.0" + }, { "index": "keka-hr/typescript", "link": "/sdk/keka-hr/typescript/", @@ -2488,6 +2603,21 @@ "subCategory": "Payment Processing", "apiVersion": "1.0.0" }, + { + "index": "kombo/typescript", + "link": "/sdk/kombo/typescript/", + "homepage": "kombo.dev", + "categories": [ + "integrations", + "ats", + "hris", + "payroll" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/kombo/favicon.png", + "parentCategory": "Artificial Intelligence", + "subCategory": "AI Tools", + "apiVersion": "1.0.0" + }, { "index": "kustomer/typescript", "link": "/sdk/kustomer/typescript/", @@ -2611,6 +2741,19 @@ "subCategory": "Printing", "apiVersion": "1.19.28" }, + { + "index": "localizely/typescript", + "link": "/sdk/localizely/typescript/", + "homepage": "localizely.com", + "categories": [ + "language", + "translation" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/localizely/favicon.png", + "parentCategory": "Artificial Intelligence", + "subCategory": "Translation", + "apiVersion": "1.2.1" + }, { "index": "logistics-os/typescript", "link": "/sdk/logistics-os/typescript/", @@ -2756,6 +2899,19 @@ "subCategory": "Payment Processing", "apiVersion": "0.5" }, + { + "index": "mambu/payments/typescript", + "link": "/sdk/mambu/payments/typescript/", + "homepage": "mambu.com", + "categories": [ + "finance", + "banking" + ], + "favicon": "https://raw.githubusercontent.com/konfig-sdks/openapi-examples/HEAD/mambu/payments/favicon.png", + "parentCategory": "Data", + "subCategory": "Finance", + "apiVersion": "v1.44.15" + }, { "index": "measure-one/typescript", "link": "/sdk/measure-one/typescript/",