form

konigle.managers.core.form

Form managers for the Konigle SDK.

This module provides managers for Form resources from the forms service. Forms are accessed through a separate service at forms.konigle.com requiring Bearer token authentication.

AsyncFormManager

Bases: BaseFormManager, BaseAsyncManager

Async manager for form resources.

create(data) async

Create a new form.

PARAMETER	DESCRIPTION
data	Form creation data TYPE: Union[FormCreate, Dict[str, str]]

RETURNS	DESCRIPTION
Form	Created form instance

delete(*args, **kwargs) async

Deletion not supported.

get(slug) async

Get a specific form by slug

list(page=1, page_size=20) async

List forms with pagination.

PARAMETER	DESCRIPTION
page	Page number (1-based) TYPE: int DEFAULT: 1
page_size	Number of items per page TYPE: int DEFAULT: 20
**filter_kwargs	Filter arguments as keyword arguments

RETURNS	DESCRIPTION
PaginatedResponse[Form]	Paginated response containing list of forms

list_submissions(slug, page=1, page_size=20) async

List submissions for a specific form.

PARAMETER	DESCRIPTION
slug	Form slug TYPE: str
page	Page number (1-based) TYPE: int DEFAULT: 1
page_size	Number of items per page TYPE: int DEFAULT: 20

RETURNS	DESCRIPTION
PaginatedResponse[FormSubmission]	Paginated response containing list of form submissions

update(*args, **kwargs) async

Update not supported.

BaseFormManager

Base configuration for Form resource managers.

base_path = '/api/dev/forms/' class-attribute instance-attribute

The API base path for this resource type.

forms_base_url = 'https://forms.konigle.com' class-attribute instance-attribute

The base URL for the forms service.

forms_connection_provider = 'konigle_forms' class-attribute instance-attribute

The connection provider code for forms service.

resource_class = Form class-attribute instance-attribute

The resource model class this manager handles.

set_connection_manager(connection_manager)

Set the connection manager for fetching credentials.

PARAMETER	DESCRIPTION
connection_manager	Connection manager instance TYPE: Union[ConnectionManager, AsyncConnectionManager]

FormManager

Bases: BaseFormManager, BaseSyncManager

Manager for form resources.

create(data)

Create a new form.

PARAMETER	DESCRIPTION
data	Form creation data TYPE: Union[FormCreate, Dict[str, str]]

RETURNS	DESCRIPTION
Form	Created form instance

delete(*args, **kwargs)

Deletion not supported.

get(slug)

Get a specific form by slug

list(page=1, page_size=20)

List forms with pagination.

PARAMETER	DESCRIPTION
page	Page number (1-based) TYPE: int DEFAULT: 1
page_size	Number of items per page TYPE: int DEFAULT: 20
**filter_kwargs	Filter arguments as keyword arguments

RETURNS	DESCRIPTION
PaginatedResponse[Form]	Paginated response containing list of forms

list_submissions(slug, page=1, page_size=20)

List submissions for a specific form.

PARAMETER	DESCRIPTION
slug	Form slug TYPE: str
page	Page number (1-based) TYPE: int DEFAULT: 1
page_size	Number of items per page TYPE: int DEFAULT: 20

RETURNS	DESCRIPTION
PaginatedResponse[FormSubmission]	Paginated response containing list of form submissions

update(*args, **kwargs)

Update not supported.