pdf_generator_api_client.FormsApi

All URIs are relative to https://us1.pdfgeneratorapi.com/api/v4

Method	HTTP request	Description
create_form	POST /forms	Create form
delete_form	DELETE /forms/{formId}	Delete form
get_form	GET /forms/{formId}	Get form
get_forms	GET /forms	Get forms
import_form	POST /forms/import	Import Form
open_form_builder	POST /forms/open	Open new form builder
open_form_builder_for_existing_form	POST /forms/{formId}/open	Open existing form builder
share_form	POST /forms/{formId}/share	Share form
update_form	PUT /forms/{formId}	Update form

create_form

InlineObject17 create_form(form_configuration_new)

Create form

Creates a new form based on the configuration sent in the request body.

Example

Bearer (JWT) Authentication (JSONWebTokenAuth):

import pdf_generator_api_client
from pdf_generator_api_client.models.form_configuration_new import FormConfigurationNew
from pdf_generator_api_client.models.inline_object17 import InlineObject17
from pdf_generator_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://us1.pdfgeneratorapi.com/api/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = pdf_generator_api_client.Configuration(
    host = "https://us1.pdfgeneratorapi.com/api/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JSONWebTokenAuth
configuration = pdf_generator_api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with pdf_generator_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pdf_generator_api_client.FormsApi(api_client)
    form_configuration_new = pdf_generator_api_client.FormConfigurationNew() # FormConfigurationNew | Form configuration

    try:
        # Create form
        api_response = api_instance.create_form(form_configuration_new)
        print("The response of FormsApi->create_form:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FormsApi->create_form: %s\n" % e)

Parameters

Name	Type	Description	Notes
form_configuration_new	FormConfigurationNew	Form configuration

Return type

InlineObject17

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Form configuration	-
401	Unauthorized	-
402	Account Suspended	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_form

delete_form(form_id)

Delete form

Deletes the form with specified id

Example

Bearer (JWT) Authentication (JSONWebTokenAuth):

import pdf_generator_api_client
from pdf_generator_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://us1.pdfgeneratorapi.com/api/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = pdf_generator_api_client.Configuration(
    host = "https://us1.pdfgeneratorapi.com/api/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JSONWebTokenAuth
configuration = pdf_generator_api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with pdf_generator_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pdf_generator_api_client.FormsApi(api_client)
    form_id = 1 # int | Form unique identifier

    try:
        # Delete form
        api_instance.delete_form(form_id)
    except Exception as e:
        print("Exception when calling FormsApi->delete_form: %s\n" % e)

Parameters

Name	Type	Description	Notes
form_id	int	Form unique identifier

Return type

void (empty response body)

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	The resource was deleted successfully.	-
401	Unauthorized	-
402	Account Suspended	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_form

InlineObject17 get_form(form_id)

Get form

Returns form configuration

Example

Bearer (JWT) Authentication (JSONWebTokenAuth):

import pdf_generator_api_client
from pdf_generator_api_client.models.inline_object17 import InlineObject17
from pdf_generator_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://us1.pdfgeneratorapi.com/api/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = pdf_generator_api_client.Configuration(
    host = "https://us1.pdfgeneratorapi.com/api/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JSONWebTokenAuth
configuration = pdf_generator_api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with pdf_generator_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pdf_generator_api_client.FormsApi(api_client)
    form_id = 1 # int | Form unique identifier

    try:
        # Get form
        api_response = api_instance.get_form(form_id)
        print("The response of FormsApi->get_form:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FormsApi->get_form: %s\n" % e)

Parameters

Name	Type	Description	Notes
form_id	int	Form unique identifier

Return type

InlineObject17

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Form configuration	-
401	Unauthorized	-
402	Account Suspended	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_forms

InlineObject6 get_forms(page=page, per_page=per_page)

Get forms

Returns a list of forms available for the organization

Example

Bearer (JWT) Authentication (JSONWebTokenAuth):

import pdf_generator_api_client
from pdf_generator_api_client.models.inline_object6 import InlineObject6
from pdf_generator_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://us1.pdfgeneratorapi.com/api/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = pdf_generator_api_client.Configuration(
    host = "https://us1.pdfgeneratorapi.com/api/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JSONWebTokenAuth
configuration = pdf_generator_api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with pdf_generator_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pdf_generator_api_client.FormsApi(api_client)
    page = 1 # int | Pagination: page to return (optional) (default to 1)
    per_page = 15 # int | Pagination: How many records to return per page (optional) (default to 15)

    try:
        # Get forms
        api_response = api_instance.get_forms(page=page, per_page=per_page)
        print("The response of FormsApi->get_forms:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FormsApi->get_forms: %s\n" % e)

Parameters

Name	Type	Description	Notes
page	int	Pagination: page to return	[optional] [default to 1]
per_page	int	Pagination: How many records to return per page	[optional] [default to 15]

Return type

InlineObject6

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	An array of form objects	-
401	Unauthorized	-
402	Account Suspended	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

import_form

InlineObject17 import_form(import_form_request)

Import Form

Creates a new form based on editable PDF

Example

Bearer (JWT) Authentication (JSONWebTokenAuth):

import pdf_generator_api_client
from pdf_generator_api_client.models.import_form_request import ImportFormRequest
from pdf_generator_api_client.models.inline_object17 import InlineObject17
from pdf_generator_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://us1.pdfgeneratorapi.com/api/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = pdf_generator_api_client.Configuration(
    host = "https://us1.pdfgeneratorapi.com/api/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JSONWebTokenAuth
configuration = pdf_generator_api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with pdf_generator_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pdf_generator_api_client.FormsApi(api_client)
    import_form_request = pdf_generator_api_client.ImportFormRequest() # ImportFormRequest | Import editable PDF via URL or base64 string as form

    try:
        # Import Form
        api_response = api_instance.import_form(import_form_request)
        print("The response of FormsApi->import_form:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FormsApi->import_form: %s\n" % e)

Parameters

Name	Type	Description	Notes
import_form_request	ImportFormRequest	Import editable PDF via URL or base64 string as form

Return type

InlineObject17

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Form configuration	-
401	Unauthorized	-
402	Account Suspended	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

open_form_builder

InlineObject19 open_form_builder()

Open new form builder

Creates a new Form Builder session and returns a URL that can be used to open the embeddable Form Builder for creating a new form.

Example

Bearer (JWT) Authentication (JSONWebTokenAuth):

import pdf_generator_api_client
from pdf_generator_api_client.models.inline_object19 import InlineObject19
from pdf_generator_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://us1.pdfgeneratorapi.com/api/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = pdf_generator_api_client.Configuration(
    host = "https://us1.pdfgeneratorapi.com/api/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JSONWebTokenAuth
configuration = pdf_generator_api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with pdf_generator_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pdf_generator_api_client.FormsApi(api_client)

    try:
        # Open new form builder
        api_response = api_instance.open_form_builder()
        print("The response of FormsApi->open_form_builder:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FormsApi->open_form_builder: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

InlineObject19

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Form Builder URL	-
401	Unauthorized	-
402	Account Suspended	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

open_form_builder_for_existing_form

InlineObject19 open_form_builder_for_existing_form(form_id)

Open existing form builder

Creates a Form Builder session for editing an existing form and returns a URL that can be used to open the embeddable Form Builder.

Example

Bearer (JWT) Authentication (JSONWebTokenAuth):

import pdf_generator_api_client
from pdf_generator_api_client.models.inline_object19 import InlineObject19
from pdf_generator_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://us1.pdfgeneratorapi.com/api/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = pdf_generator_api_client.Configuration(
    host = "https://us1.pdfgeneratorapi.com/api/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JSONWebTokenAuth
configuration = pdf_generator_api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with pdf_generator_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pdf_generator_api_client.FormsApi(api_client)
    form_id = 1 # int | Form unique identifier

    try:
        # Open existing form builder
        api_response = api_instance.open_form_builder_for_existing_form(form_id)
        print("The response of FormsApi->open_form_builder_for_existing_form:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FormsApi->open_form_builder_for_existing_form: %s\n" % e)

Parameters

Name	Type	Description	Notes
form_id	int	Form unique identifier

Return type

InlineObject19

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Form Builder URL	-
401	Unauthorized	-
402	Account Suspended	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

share_form

InlineObject18 share_form(form_id)

Share form

Creates an unique sharing URL to collect form data

Example

Bearer (JWT) Authentication (JSONWebTokenAuth):

import pdf_generator_api_client
from pdf_generator_api_client.models.inline_object18 import InlineObject18
from pdf_generator_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://us1.pdfgeneratorapi.com/api/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = pdf_generator_api_client.Configuration(
    host = "https://us1.pdfgeneratorapi.com/api/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JSONWebTokenAuth
configuration = pdf_generator_api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with pdf_generator_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pdf_generator_api_client.FormsApi(api_client)
    form_id = 1 # int | Form unique identifier

    try:
        # Share form
        api_response = api_instance.share_form(form_id)
        print("The response of FormsApi->share_form:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FormsApi->share_form: %s\n" % e)

Parameters

Name	Type	Description	Notes
form_id	int	Form unique identifier

Return type

InlineObject18

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Form sharing URL	-
401	Unauthorized	-
402	Account Suspended	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_form

InlineObject17 update_form(form_id, form_configuration_new)

Update form

Updates the form configuration. The form configuration must be complete as the entire configuration is replaced and not merged.

Example

Bearer (JWT) Authentication (JSONWebTokenAuth):

import pdf_generator_api_client
from pdf_generator_api_client.models.form_configuration_new import FormConfigurationNew
from pdf_generator_api_client.models.inline_object17 import InlineObject17
from pdf_generator_api_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://us1.pdfgeneratorapi.com/api/v4
# See configuration.py for a list of all supported configuration parameters.
configuration = pdf_generator_api_client.Configuration(
    host = "https://us1.pdfgeneratorapi.com/api/v4"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): JSONWebTokenAuth
configuration = pdf_generator_api_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with pdf_generator_api_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pdf_generator_api_client.FormsApi(api_client)
    form_id = 1 # int | Form unique identifier
    form_configuration_new = pdf_generator_api_client.FormConfigurationNew() # FormConfigurationNew | Form configuration

    try:
        # Update form
        api_response = api_instance.update_form(form_id, form_configuration_new)
        print("The response of FormsApi->update_form:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling FormsApi->update_form: %s\n" % e)

Parameters

Name	Type	Description	Notes
form_id	int	Form unique identifier
form_configuration_new	FormConfigurationNew	Form configuration

Return type

InlineObject17

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Form configuration	-
401	Unauthorized	-
402	Account Suspended	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

FormsApi.md

Latest commit

History

FormsApi.md

File metadata and controls

pdf_generator_api_client.FormsApi

create_form

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_form

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_form

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_forms

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

import_form

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

open_form_builder

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

open_form_builder_for_existing_form

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

share_form

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_form

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details