form_api 1.9.1 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80f32ae5eff2c08ae091c1d9de515617d97c2c5c6d86bc2e1dd0d16a14624bd0
-  data.tar.gz: b73c11805ada83d4b2b50c7155408b04bdc3c9e80191833de8f1d78d8a5492c3
+  metadata.gz: '080c6ad5e07b710188158e45db7ecfbffd37b02c05e731278d51b80af49e668c'
+  data.tar.gz: ae91e06d7589ecc6cebe94a78a431110b7568075331bc838c3f940de2c5d088a
 SHA512:
-  metadata.gz: 8feaf13ab7b4f0f00810e0aeddc449629d1634a64d009f5a0ac83f68d26f3fe92f3f30b5a596df968586d8826a908be50b571b99e84504fd3b1993b3b377cf29
-  data.tar.gz: 014bb9a629bb2462d0b89e152300826d7329711a7f403ceb58d633ab580ec2e87e11b1ad9ed1f83f81c66d7dbd834fe6be875b93a541a6cf3f1ea50b632c3833
+  metadata.gz: ff818be54ca54f3ae63767ac6b0928280dcd670bc00c4691b565b14dbdac0a5a7120016163834a441a66320bab8b9bf2f089ca7945f04b0ba75705e6a887c06b
+  data.tar.gz: 07e4434c1e642b08e5dea6275a39dbdea5ec2b97b91f13183b65ebc977bd9f7589219b786d48a5a3c95afc8e3df3b35671d7f695dd256973ec45528c8f6a30b3

data/CHANGELOG.md

@@ -1,27 +1,44 @@
+### 1.11.0 [October 9, 2019]
+
+- Add parent folder ID and path params to GET template response
+- Add parent folder ID param when creating a new template, so you can upload a template into a folder
+
+### 1.10.0 [Aug 7, 2019]
+* Added Create Folder, List Folder, Move to Folder endpoints
+
 ### 1.9.1 [August 2, 2019]
-* Relax json dependency to support older versions (>= 1.8)
+
+- Relax json dependency to support older versions (>= 1.8)
 
 ### 1.9.0 [June 22, 2019]
-* **BREAKING CHANGE** Renamed "Get Templates" endpoint to "List Templates". Added a search query parameter.
+
+- **BREAKING CHANGE** Renamed "Get Templates" endpoint to "List Templates". Added a search query parameter.
 
 ### 1.8.0 [April 11, 2019]
-* Added support for editable PDFS (editable: true)
+
+- Added support for editable PDFS (editable: true)
 
 ### 1.7.0 [December 23, 2018]
-* Added CustomFiles, and combinePdf call to support many different types of source PDFs. Renamed a few models
+
+- Added CustomFiles, and combinePdf call to support many different types of source PDFs. Renamed a few models
 
 ### 1.6.0 [December 18, 2018]
-* Updated API host to api.formapi.io
+
+- Updated API host to api.formapi.io
 
 ### 1.5.0 [December 13, 2018]
-* Fix model name for newly created Templates (PendingTemplate)
-* Added "actions" to submission and combined_submission responses. Includes information about custom S3 uploads
+
+- Fix model name for newly created Templates (PendingTemplate)
+- Added "actions" to submission and combined_submission responses. Includes information about custom S3 uploads
 
 ### 1.4.1 [December 2, 2018]
-* Fixed crash in 1.4.0, did not include all of the necessary files
+
+- Fixed crash in 1.4.0, did not include all of the necessary files
 
 ### 1.4.0 [December 1, 2018]
-* Added Create Template, Get Template, and Get Template Schema endpoints
+
+- Added Create Template, Get Template, and Get Template Schema endpoints
 
 ### 1.3.0 [November 4, 2018]
-* Initial changelog
+
+- Initial changelog

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    form_api (1.9.1)
+    form_api (1.11.0)
       ffi (~> 1.0, >= 1.9.24)
       json (>= 1.8)
       typhoeus (~> 1.0, >= 1.0.1)

data/README.md

@@ -7,7 +7,7 @@ FormAPI is a service that helps you fill out and sign PDF templates.
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: v1
-- Package version: 1.9.1
+- Package version: 1.11.0
 - Build package: io.formapi.codegen.FormApiRubyClientCodegen
 
 ## Installation
@@ -23,15 +23,15 @@ gem build form_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./form_api-1.9.1.gem
+gem install ./form_api-1.11.0.gem
 ```
-(for development, run `gem install --dev ./form_api-1.9.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./form_api-1.11.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'form_api', '~> 1.9.1'
+    gem 'form_api', '~> 1.11.0'
 
 ### Install from Git
 
@@ -87,8 +87,10 @@ Class | Method | HTTP request | Description
 *FormAPI::PDFApi* | [**combine_submissions**](docs/PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
 *FormAPI::PDFApi* | [**create_custom_file_from_upload**](docs/PDFApi.md#create_custom_file_from_upload) | **POST** /custom_files | Create a new custom file from a cached presign upload
 *FormAPI::PDFApi* | [**create_data_request_token**](docs/PDFApi.md#create_data_request_token) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication
+*FormAPI::PDFApi* | [**create_folder**](docs/PDFApi.md#create_folder) | **POST** /folders/ | Create a folder
 *FormAPI::PDFApi* | [**create_template**](docs/PDFApi.md#create_template) | **POST** /templates | Upload a new PDF template with a file upload
 *FormAPI::PDFApi* | [**create_template_from_upload**](docs/PDFApi.md#create_template_from_upload) | **POST** /templates?v=2 | Create a new PDF template from a cached presign upload
+*FormAPI::PDFApi* | [**delete_folder**](docs/PDFApi.md#delete_folder) | **DELETE** /folders/{folder_id} | Delete a folder
 *FormAPI::PDFApi* | [**expire_combined_submission**](docs/PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
 *FormAPI::PDFApi* | [**expire_submission**](docs/PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
 *FormAPI::PDFApi* | [**generate_pdf**](docs/PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
@@ -97,9 +99,13 @@ Class | Method | HTTP request | Description
 *FormAPI::PDFApi* | [**get_presign_url**](docs/PDFApi.md#get_presign_url) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket
 *FormAPI::PDFApi* | [**get_submission**](docs/PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
 *FormAPI::PDFApi* | [**get_submission_batch**](docs/PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
-*FormAPI::PDFApi* | [**get_template**](docs/PDFApi.md#get_template) | **GET** /templates/{template_id} | Check the status of an uploaded template
+*FormAPI::PDFApi* | [**get_template**](docs/PDFApi.md#get_template) | **GET** /templates/{template_id} | Get a single template
 *FormAPI::PDFApi* | [**get_template_schema**](docs/PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
+*FormAPI::PDFApi* | [**list_folders**](docs/PDFApi.md#list_folders) | **GET** /folders/ | Get a list of all folders
 *FormAPI::PDFApi* | [**list_templates**](docs/PDFApi.md#list_templates) | **GET** /templates | Get a list of all templates
+*FormAPI::PDFApi* | [**move_folder_to_folder**](docs/PDFApi.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder
+*FormAPI::PDFApi* | [**move_template_to_folder**](docs/PDFApi.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder
+*FormAPI::PDFApi* | [**rename_folder**](docs/PDFApi.md#rename_folder) | **POST** /folders/{folder_id}/rename | Rename a folder
 *FormAPI::PDFApi* | [**test_authentication**](docs/PDFApi.md#test_authentication) | **GET** /authentication | Test Authentication
 *FormAPI::PDFApi* | [**update_data_request**](docs/PDFApi.md#update_data_request) | **PUT** /data_requests/{data_request_id} | Update a submission data request
 
@@ -115,6 +121,7 @@ Class | Method | HTTP request | Description
  - [FormAPI::CreateCombinedSubmissionResponse](docs/CreateCombinedSubmissionResponse.md)
  - [FormAPI::CreateCustomFileData](docs/CreateCustomFileData.md)
  - [FormAPI::CreateCustomFileResponse](docs/CreateCustomFileResponse.md)
+ - [FormAPI::CreateFolderData](docs/CreateFolderData.md)
  - [FormAPI::CreateSubmissionBatchResponse](docs/CreateSubmissionBatchResponse.md)
  - [FormAPI::CreateSubmissionBatchSubmissionsResponse](docs/CreateSubmissionBatchSubmissionsResponse.md)
  - [FormAPI::CreateSubmissionDataRequestData](docs/CreateSubmissionDataRequestData.md)
@@ -124,8 +131,13 @@ Class | Method | HTTP request | Description
  - [FormAPI::CreateTemplateData](docs/CreateTemplateData.md)
  - [FormAPI::CustomFile](docs/CustomFile.md)
  - [FormAPI::Error](docs/Error.md)
+ - [FormAPI::Folder](docs/Folder.md)
+ - [FormAPI::FoldersFolder](docs/FoldersFolder.md)
  - [FormAPI::InvalidRequest](docs/InvalidRequest.md)
+ - [FormAPI::MoveFolderData](docs/MoveFolderData.md)
+ - [FormAPI::MoveTemplateData](docs/MoveTemplateData.md)
  - [FormAPI::PendingTemplate](docs/PendingTemplate.md)
+ - [FormAPI::RenameFolderData](docs/RenameFolderData.md)
  - [FormAPI::Submission](docs/Submission.md)
  - [FormAPI::SubmissionAction](docs/SubmissionAction.md)
  - [FormAPI::SubmissionBatch](docs/SubmissionBatch.md)

data/docs/CreateFolderData.md

@@ -0,0 +1,8 @@
+# FormAPI::CreateFolderData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**folder** | [**FoldersFolder**](FoldersFolder.md) |  | 
+
+

data/docs/Folder.md

@@ -0,0 +1,11 @@
+# FormAPI::Folder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**path** | **String** |  | [optional] 
+**parent_folder_id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+
+

data/docs/FoldersFolder.md

@@ -0,0 +1,9 @@
+# FormAPI::FoldersFolder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parent_folder_id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+
+

data/docs/MoveFolderData.md

@@ -0,0 +1,8 @@
+# FormAPI::MoveFolderData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parent_folder_id** | **String** |  | [optional] 
+
+

data/docs/MoveTemplateData.md

@@ -0,0 +1,8 @@
+# FormAPI::MoveTemplateData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parent_folder_id** | **String** |  | [optional] 
+
+

data/docs/PDFApi.md

@@ -10,8 +10,10 @@ Method | HTTP request | Description
 [**combine_submissions**](PDFApi.md#combine_submissions) | **POST** /combined_submissions | Merge generated PDFs together
 [**create_custom_file_from_upload**](PDFApi.md#create_custom_file_from_upload) | **POST** /custom_files | Create a new custom file from a cached presign upload
 [**create_data_request_token**](PDFApi.md#create_data_request_token) | **POST** /data_requests/{data_request_id}/tokens | Creates a new data request token for form authentication
+[**create_folder**](PDFApi.md#create_folder) | **POST** /folders/ | Create a folder
 [**create_template**](PDFApi.md#create_template) | **POST** /templates | Upload a new PDF template with a file upload
 [**create_template_from_upload**](PDFApi.md#create_template_from_upload) | **POST** /templates?v=2 | Create a new PDF template from a cached presign upload
+[**delete_folder**](PDFApi.md#delete_folder) | **DELETE** /folders/{folder_id} | Delete a folder
 [**expire_combined_submission**](PDFApi.md#expire_combined_submission) | **DELETE** /combined_submissions/{combined_submission_id} | Expire a combined submission
 [**expire_submission**](PDFApi.md#expire_submission) | **DELETE** /submissions/{submission_id} | Expire a PDF submission
 [**generate_pdf**](PDFApi.md#generate_pdf) | **POST** /templates/{template_id}/submissions | Generates a new PDF
@@ -20,9 +22,13 @@ Method | HTTP request | Description
 [**get_presign_url**](PDFApi.md#get_presign_url) | **GET** /uploads/presign | Get a presigned URL so that you can upload a file to our AWS S3 bucket
 [**get_submission**](PDFApi.md#get_submission) | **GET** /submissions/{submission_id} | Check the status of a PDF
 [**get_submission_batch**](PDFApi.md#get_submission_batch) | **GET** /submissions/batches/{submission_batch_id} | Check the status of a submission batch job
-[**get_template**](PDFApi.md#get_template) | **GET** /templates/{template_id} | Check the status of an uploaded template
+[**get_template**](PDFApi.md#get_template) | **GET** /templates/{template_id} | Get a single template
 [**get_template_schema**](PDFApi.md#get_template_schema) | **GET** /templates/{template_id}/schema | Fetch the JSON schema for a template
+[**list_folders**](PDFApi.md#list_folders) | **GET** /folders/ | Get a list of all folders
 [**list_templates**](PDFApi.md#list_templates) | **GET** /templates | Get a list of all templates
+[**move_folder_to_folder**](PDFApi.md#move_folder_to_folder) | **POST** /folders/{folder_id}/move | Move a folder
+[**move_template_to_folder**](PDFApi.md#move_template_to_folder) | **POST** /templates/{template_id}/move | Move Template to folder
+[**rename_folder**](PDFApi.md#rename_folder) | **POST** /folders/{folder_id}/rename | Rename a folder
 [**test_authentication**](PDFApi.md#test_authentication) | **GET** /authentication | Test Authentication
 [**update_data_request**](PDFApi.md#update_data_request) | **PUT** /data_requests/{data_request_id} | Update a submission data request
 
@@ -323,8 +329,57 @@ Name | Type | Description  | Notes
 
 
 
+# **create_folder**
+> Folder create_folder(create_folder_data)
+
+Create a folder
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+create_folder_data = FormAPI::CreateFolderData.new # CreateFolderData | 
+
+begin
+  #Create a folder
+  result = api_instance.create_folder(create_folder_data)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->create_folder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_folder_data** | [**CreateFolderData**](CreateFolderData.md)|  | 
+
+### Return type
+
+[**Folder**](Folder.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **create_template**
-> PendingTemplate create_template(template_document, template_name)
+> PendingTemplate create_template(template_document, template_name, opts)
 
 Upload a new PDF template with a file upload
 
@@ -342,10 +397,13 @@ end
 api_instance = FormAPI::PDFApi.new
 template_document = File.new('/path/to/file') # File | 
 template_name = 'template_name_example' # String | 
+opts = {
+  template_parent_folder_id: 'template_parent_folder_id_example' # String | 
+}
 
 begin
   #Upload a new PDF template with a file upload
-  result = api_instance.create_template(template_document, template_name)
+  result = api_instance.create_template(template_document, template_name, opts)
   p result
 rescue FormAPI::ApiError => e
   puts "Exception when calling PDFApi->create_template: #{e}"
@@ -358,6 +416,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **template_document** | **File**|  | 
  **template_name** | **String**|  | 
+ **template_parent_folder_id** | **String**|  | [optional] 
 
 ### Return type
 
@@ -423,6 +482,55 @@ Name | Type | Description  | Notes
 
 
 
+# **delete_folder**
+> Folder delete_folder(folder_id)
+
+Delete a folder
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+folder_id = 'fld_000000000000000001' # String | 
+
+begin
+  #Delete a folder
+  result = api_instance.delete_folder(folder_id)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->delete_folder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **folder_id** | **String**|  | 
+
+### Return type
+
+[**Folder**](Folder.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
 # **expire_combined_submission**
 > CombinedSubmission expire_combined_submission(combined_submission_id)
 
@@ -824,7 +932,7 @@ Name | Type | Description  | Notes
 # **get_template**
 > Template get_template(template_id)
 
-Check the status of an uploaded template
+Get a single template
 
 ### Example
 ```ruby
@@ -838,10 +946,10 @@ FormAPI.configure do |config|
 end
 
 api_instance = FormAPI::PDFApi.new
-template_id = 'tpl_000000000000000001' # String | 
+template_id = 'tpl_000000000000000011' # String | 
 
 begin
-  #Check the status of an uploaded template
+  #Get a single template
   result = api_instance.get_template(template_id)
   p result
 rescue FormAPI::ApiError => e
@@ -919,6 +1027,57 @@ Name | Type | Description  | Notes
 
 
 
+# **list_folders**
+> Array<Folder> list_folders(opts)
+
+Get a list of all folders
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+opts = {
+  parent_folder_id: 'fld_000000000000000002' # String | Filter By Folder Id
+}
+
+begin
+  #Get a list of all folders
+  result = api_instance.list_folders(opts)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->list_folders: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **parent_folder_id** | **String**| Filter By Folder Id | [optional] 
+
+### Return type
+
+[**Array<Folder>**](Folder.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
 # **list_templates**
 > Array<Template> list_templates(opts)
 
@@ -938,6 +1097,7 @@ end
 api_instance = FormAPI::PDFApi.new
 opts = {
   query: '2', # String | Search By Name
+  parent_folder_id: 'fld_000000000000000001', # String | Filter By Folder Id
   page: 2, # Integer | Default: 1
   per_page: 1 # Integer | Default: 50
 }
@@ -956,6 +1116,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **query** | **String**| Search By Name | [optional] 
+ **parent_folder_id** | **String**| Filter By Folder Id | [optional] 
  **page** | **Integer**| Default: 1 | [optional] 
  **per_page** | **Integer**| Default: 50 | [optional] 
 
@@ -974,6 +1135,158 @@ Name | Type | Description  | Notes
 
 
 
+# **move_folder_to_folder**
+> Folder move_folder_to_folder(folder_id, move_folder_data)
+
+Move a folder
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+folder_id = 'fld_000000000000000001' # String | 
+move_folder_data = FormAPI::MoveFolderData.new # MoveFolderData | 
+
+begin
+  #Move a folder
+  result = api_instance.move_folder_to_folder(folder_id, move_folder_data)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->move_folder_to_folder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **folder_id** | **String**|  | 
+ **move_folder_data** | [**MoveFolderData**](MoveFolderData.md)|  | 
+
+### Return type
+
+[**Folder**](Folder.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **move_template_to_folder**
+> Template move_template_to_folder(template_id, move_template_data)
+
+Move Template to folder
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+template_id = 'tpl_000000000000000001' # String | 
+move_template_data = FormAPI::MoveTemplateData.new # MoveTemplateData | 
+
+begin
+  #Move Template to folder
+  result = api_instance.move_template_to_folder(template_id, move_template_data)
+  p result
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->move_template_to_folder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **template_id** | **String**|  | 
+ **move_template_data** | [**MoveTemplateData**](MoveTemplateData.md)|  | 
+
+### Return type
+
+[**Template**](Template.md)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **rename_folder**
+> rename_folder(folder_id, rename_folder_data)
+
+Rename a folder
+
+### Example
+```ruby
+# load the gem
+require 'form_api'
+# setup authorization
+FormAPI.configure do |config|
+  # Configure HTTP basic authorization: api_token_basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = FormAPI::PDFApi.new
+folder_id = 'fld_000000000000000001' # String | 
+rename_folder_data = FormAPI::RenameFolderData.new # RenameFolderData | 
+
+begin
+  #Rename a folder
+  api_instance.rename_folder(folder_id, rename_folder_data)
+rescue FormAPI::ApiError => e
+  puts "Exception when calling PDFApi->rename_folder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **folder_id** | **String**|  | 
+ **rename_folder_data** | [**RenameFolderData**](RenameFolderData.md)|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_token_basic](../README.md#api_token_basic)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **test_authentication**
 > AuthenticationSuccessResponse test_authentication