FormstackformsClient

Attributes

TRIGGER_OPERATIONS module-attribute

TRIGGER_OPERATIONS: Dict[str, Dict[str, Any]] = {'FormstackFormSubmitted': {'operation_id': 'FormstackFormSubmitted', 'path': '/{connectionId}/api/v2/form/{form_id}/webhook/', 'method': 'post', 'required_parameters': ['form_id', 'body'], 'callback_payload_type': 'FormstackFormSubmittedResponse'}}

Classes

FormstackFormSubmittedInput dataclass

FormstackFormSubmittedInput(url: str, content_type: str, file_transfer_type: str, standardize_field_values: bool)

Triggers when a form is submitted

Attributes

url instance-attribute

url: str

url

content_type instance-attribute

content_type: str

content type

file_transfer_type instance-attribute

file_transfer_type: str

file transfer type

standardize_field_values instance-attribute

standardize_field_values: bool

standardize field values

FormstackFormSubmittedResponse dataclass

FormstackFormSubmittedResponse(*, id: Optional[str] = None)

Response for Triggers when a form is submitted

GetAvailableFormsResponse dataclass

GetAvailableFormsResponse(*, forms: Optional[List[Dict[str, Any]]] = None, total: Optional[int] = None)

Response for Get Available Forms

Attributes

forms class-attribute instance-attribute

forms: Optional[List[Dict[str, Any]]] = dataclass_field(default=None, kw_only=True)

forms

total class-attribute instance-attribute

total: Optional[int] = dataclass_field(default=None, kw_only=True)

total

FormstackformsClient

FormstackformsClient(connection_runtime_url: str, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

Bases: ConnectorClientBase

Typed client for formstackforms connector.

Initialize a FormstackformsClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

get_available_forms async

get_available_forms(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get Available Forms

Returns all available forms

Swagger operation ID: GetAvailableForms.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

get_form_schema async

get_form_schema(form_id: int, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Returns Form Schema from Webhook API

Used for the x-ms-dynamic-schema

Swagger operation ID: GetFormSchema.

Parameters:

Name	Type	Description	Default
form_id	int	form_id.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.