{"id":19383930,"url":"https://github.com/docspring/formapi-csharp","last_synced_at":"2025-07-08T12:43:23.006Z","repository":{"id":40916718,"uuid":"155846621","full_name":"DocSpring/formapi-csharp","owner":"DocSpring","description":"C# API Client for https://formapi.io - https://www.nuget.org/packages/FormApi.Client","archived":false,"fork":false,"pushed_at":"2022-12-07T20:01:08.000Z","size":132,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-07T07:14:25.514Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DocSpring.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-11-02T09:52:50.000Z","updated_at":"2019-10-09T17:49:06.000Z","dependencies_parsed_at":"2023-01-24T22:00:26.415Z","dependency_job_id":null,"html_url":"https://github.com/DocSpring/formapi-csharp","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-csharp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-csharp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-csharp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DocSpring%2Fformapi-csharp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DocSpring","download_url":"https://codeload.github.com/DocSpring/formapi-csharp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240521037,"owners_count":19814694,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T09:28:26.075Z","updated_at":"2025-02-24T17:18:27.797Z","avatar_url":"https://github.com/DocSpring.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FormApi.Client - the C# library for the API v1\n\nFormAPI is a service that helps you fill out and sign PDF templates.\n\nThis C# SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: v1\n- SDK version: 1.13.0\n- Build package: io.formapi.codegen.FormApiCSharpClientCodegen\n\n\u003ca name=\"frameworks-supported\"\u003e\u003c/a\u003e\n## Frameworks supported\n- .NET 4.0 or later\n- Windows Phone 7.1 (Mango)\n\n\u003ca name=\"dependencies\"\u003e\u003c/a\u003e\n## Dependencies\n- [RestSharp](https://www.nuget.org/packages/RestSharp) - 105.1.0 or later\n- [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/) - 7.0.0 or later\n- [JsonSubTypes](https://www.nuget.org/packages/JsonSubTypes/) - 1.2.0 or later\n\nThe DLLs included in the package may not be the latest version. We recommend using [NuGet](https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:\n```\nInstall-Package RestSharp\nInstall-Package Newtonsoft.Json\nInstall-Package JsonSubTypes\n```\n\nNOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See [RestSharp#742](https://github.com/restsharp/RestSharp/issues/742)\n\n\u003ca name=\"installation\"\u003e\u003c/a\u003e\n## Installation\nRun the following command to generate the DLL\n- [Mac/Linux] `/bin/sh build.sh`\n- [Windows] `build.bat`\n\nThen include the DLL (under the `bin` folder) in the C# project, and use the namespaces:\n```csharp\nusing FormApi.Client.Api;\nusing FormApi.Client.Client;\nusing FormApi.Client.Model;\n```\n\u003ca name=\"packaging\"\u003e\u003c/a\u003e\n## Packaging\n\nA `.nuspec` is included with the project. You can follow the Nuget quickstart to [create](https://docs.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package#create-the-package) and [publish](https://docs.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package#publish-the-package) packages.\n\nThis `.nuspec` uses placeholders from the `.csproj`, so build the `.csproj` directly:\n\n```\nnuget pack -Build -OutputDirectory out FormApi.Client.csproj\n```\n\nThen, publish to a [local feed](https://docs.microsoft.com/en-us/nuget/hosting-packages/local-feeds) or [other host](https://docs.microsoft.com/en-us/nuget/hosting-packages/overview) and consume the new package via Nuget as usual.\n\n\u003ca name=\"getting-started\"\u003e\u003c/a\u003e\n## Getting Started\n\n```csharp\nusing System;\nusing System.Diagnostics;\nusing FormApi.Client.Api;\nusing FormApi.Client.Client;\nusing FormApi.Client.Model;\n\nnamespace Example\n{\n    public class Example\n    {\n        public void main()\n        {\n\n            // Configure HTTP basic authorization: api_token_basic\n            Configuration.Default.Username = \"YOUR_USERNAME\";\n            Configuration.Default.Password = \"YOUR_PASSWORD\";\n\n            var apiInstance = new PDFApi();\n            var templateId = tpl_000000000000000001;  // string | \n            var requestBody = new List\u003cObject\u003e(); // List\u003cObject\u003e | \n\n            try\n            {\n                // Generates multiple PDFs\n                List\u003cCreateSubmissionResponse\u003e result = apiInstance.BatchGeneratePdfV1(templateId, requestBody);\n                Debug.WriteLine(result);\n            }\n            catch (Exception e)\n            {\n                Debug.Print(\"Exception when calling PDFApi.BatchGeneratePdfV1: \" + e.Message );\n            }\n\n        }\n    }\n}\n```\n\n\u003ca name=\"documentation-for-api-endpoints\"\u003e\u003c/a\u003e\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.formapi.io/api/v1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*PDFApi* | [**BatchGeneratePdfV1**](docs/PDFApi.md#batchgeneratepdfv1) | **POST** /templates/{template_id}/submissions/batch | Generates multiple PDFs\n*PDFApi* | [**BatchGeneratePdfs**](docs/PDFApi.md#batchgeneratepdfs) | **POST** /submissions/batches | Generates multiple PDFs\n*PDFApi* | [**CombinePdfs**](docs/PDFApi.md#combinepdfs) | **POST** /combined_submissions?v\u0026#x3D;2 | Merge submission PDFs, template PDFs, or custom files\n*PDFApi* | [**CombineSubmissions**](docs/PDFApi.md#combinesubmissions) | **POST** /combined_submissions | Merge generated PDFs together\n*PDFApi* | [**CreateCustomFileFromUpload**](docs/PDFApi.md#createcustomfilefromupload) | **POST** /custom_files | Create a new custom file from a cached presign upload\n*PDFApi* | [**CreateDataRequestToken**](docs/PDFApi.md#createdatarequesttoken) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication\n*PDFApi* | [**CreateFolder**](docs/PDFApi.md#createfolder) | **POST** /folders/ | Create a folder\n*PDFApi* | [**CreateTemplate**](docs/PDFApi.md#createtemplate) | **POST** /templates | Upload a new PDF template with a file upload\n*PDFApi* | [**CreateTemplateFromUpload**](docs/PDFApi.md#createtemplatefromupload) | **POST** /templates?v\u0026#x3D;2 | Create a new PDF template from a cached presign upload\n*PDFApi* | [**DeleteFolder**](docs/PDFApi.md#deletefolder) | **DELETE** /folders/{folder_id} | Delete a folder\n*PDFApi* | [**ExpireCombinedSubmission**](docs/PDFApi.md#expirecombinedsubmission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission\n*PDFApi* | [**ExpireSubmission**](docs/PDFApi.md#expiresubmission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission\n*PDFApi* | [**GeneratePDF**](docs/PDFApi.md#generatepdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF\n*PDFApi* | [**GetCombinedSubmission**](docs/PDFApi.md#getcombinedsubmission) | **GET** /combined_submissions/{combined_submission_id} | Check the status of a combined submission (merged PDFs)\n*PDFApi* | [**GetDataRequest**](docs/PDFApi.md#getdatarequest) | **GET** /data_requests/{data_request_id} | Look up a submission data request\n*PDFApi* | [**GetPresignUrl**](docs/PDFApi.md#getpresignurl) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket\n*PDFApi* | [**GetSubmission**](docs/PDFApi.md#getsubmission) | **GET** /submissions/{submission_id} | Check the status of a PDF\n*PDFApi* | [**GetSubmissionBatch**](docs/PDFApi.md#getsubmissionbatch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job\n*PDFApi* | [**GetTemplate**](docs/PDFApi.md#gettemplate) | **GET** /templates/{template_id} | Get a single template\n*PDFApi* | [**GetTemplateSchema**](docs/PDFApi.md#gettemplateschema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template\n*PDFApi* | [**ListFolders**](docs/PDFApi.md#listfolders) | **GET** /folders/ | Get a list of all folders\n*PDFApi* | [**ListTemplates**](docs/PDFApi.md#listtemplates) | **GET** /templates | Get a list of all templates\n*PDFApi* | [**MoveFolderToFolder**](docs/PDFApi.md#movefoldertofolder) | **POST** /folders/{folder_id}/move | Move a folder\n*PDFApi* | [**MoveTemplateToFolder**](docs/PDFApi.md#movetemplatetofolder) | **POST** /templates/{template_id}/move | Move Template to folder\n*PDFApi* | [**RenameFolder**](docs/PDFApi.md#renamefolder) | **POST** /folders/{folder_id}/rename | Rename a folder\n*PDFApi* | [**TestAuthentication**](docs/PDFApi.md#testauthentication) | **GET** /authentication | Test Authentication\n*PDFApi* | [**UpdateDataRequest**](docs/PDFApi.md#updatedatarequest) | **PUT** /data_requests/{data_request_id} | Update a submission data request\n\n\n\u003ca name=\"documentation-for-models\"\u003e\u003c/a\u003e\n## Documentation for Models\n\n - [Model.AuthenticationError](docs/AuthenticationError.md)\n - [Model.AuthenticationSuccessResponse](docs/AuthenticationSuccessResponse.md)\n - [Model.CombinePdfsData](docs/CombinePdfsData.md)\n - [Model.CombinedSubmission](docs/CombinedSubmission.md)\n - [Model.CombinedSubmissionAction](docs/CombinedSubmissionAction.md)\n - [Model.CombinedSubmissionData](docs/CombinedSubmissionData.md)\n - [Model.CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)\n - [Model.CreateCustomFileData](docs/CreateCustomFileData.md)\n - [Model.CreateCustomFileResponse](docs/CreateCustomFileResponse.md)\n - [Model.CreateFolderData](docs/CreateFolderData.md)\n - [Model.CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)\n - [Model.CreateSubmissionBatchSubmissionsResponse](docs/CreateSubmissionBatchSubmissionsResponse.md)\n - [Model.CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)\n - [Model.CreateSubmissionDataRequestTokenResponse](docs/CreateSubmissionDataRequestTokenResponse.md)\n - [Model.CreateSubmissionDataRequestTokenResponseToken](docs/CreateSubmissionDataRequestTokenResponseToken.md)\n - [Model.CreateSubmissionResponse](docs/CreateSubmissionResponse.md)\n - [Model.CreateTemplateData](docs/CreateTemplateData.md)\n - [Model.CustomFile](docs/CustomFile.md)\n - [Model.Error](docs/Error.md)\n - [Model.Folder](docs/Folder.md)\n - [Model.FoldersFolder](docs/FoldersFolder.md)\n - [Model.InvalidRequest](docs/InvalidRequest.md)\n - [Model.MoveFolderData](docs/MoveFolderData.md)\n - [Model.MoveTemplateData](docs/MoveTemplateData.md)\n - [Model.PendingTemplate](docs/PendingTemplate.md)\n - [Model.RenameFolderData](docs/RenameFolderData.md)\n - [Model.Submission](docs/Submission.md)\n - [Model.SubmissionAction](docs/SubmissionAction.md)\n - [Model.SubmissionBatch](docs/SubmissionBatch.md)\n - [Model.SubmissionBatchData](docs/SubmissionBatchData.md)\n - [Model.SubmissionData](docs/SubmissionData.md)\n - [Model.SubmissionDataBatchRequest](docs/SubmissionDataBatchRequest.md)\n - [Model.SubmissionDataRequest](docs/SubmissionDataRequest.md)\n - [Model.Template](docs/Template.md)\n - [Model.Templatesv2Template](docs/Templatesv2Template.md)\n - [Model.Templatesv2TemplateDocument](docs/Templatesv2TemplateDocument.md)\n - [Model.Templatesv2TemplateDocumentMetadata](docs/Templatesv2TemplateDocumentMetadata.md)\n - [Model.UpdateDataRequestResponse](docs/UpdateDataRequestResponse.md)\n - [Model.UpdateSubmissionDataRequestData](docs/UpdateSubmissionDataRequestData.md)\n\n\n\u003ca name=\"documentation-for-authorization\"\u003e\u003c/a\u003e\n## Documentation for Authorization\n\n\u003ca name=\"api_token_basic\"\u003e\u003c/a\u003e\n### api_token_basic\n\n- **Type**: HTTP basic authentication\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fformapi-csharp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdocspring%2Fformapi-csharp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdocspring%2Fformapi-csharp/lists"}