Skip to content
ksef2

Authenticated client: Open batch session

Open a batch session using caller-prepared encryption metadata.

Use via auth = client.authentication.with_token(...)
Source src/ksef2/clients/authenticated.py:255 Generated from async source src/ksef2/clients/async_authenticated.py
auth.open_batch_session
auth.open_batch_session(*, batch_file: BatchFileInfo, aes_key: bytes, iv: bytes, encrypted_key: bytes, public_key_id: str | None = None, form_code: FormSchema = FormSchema.FA3, offline_mode: bool = False, prepared_batch: PreparedBatch | None = None) -> BatchSessionClient

Returns

BatchSessionClient

Parameters

batch_file BatchFileInfo
required / keyword-only
aes_key bytes
required / keyword-only
iv bytes
required / keyword-only
encrypted_key bytes
required / keyword-only
public_key_id str | None
default None / keyword-only
form_code FormSchema
default FormSchema.FA3 / keyword-only
offline_mode bool
default False / keyword-only
prepared_batch PreparedBatch | None
default None / keyword-only
Use via auth = async_client.authentication.with_token(...)
Source src/ksef2/clients/async_authenticated.py:255 Authored source
auth.open_batch_session
auth.open_batch_session(*, batch_file: BatchFileInfo, aes_key: bytes, iv: bytes, encrypted_key: bytes, public_key_id: str | None = None, form_code: FormSchema = FormSchema.FA3, offline_mode: bool = False, prepared_batch: PreparedBatch | None = None) -> _AwaitableSession[AsyncBatchSessionClient]

Returns

_AwaitableSession[AsyncBatchSessionClient]

Parameters

batch_file BatchFileInfo
required / keyword-only
aes_key bytes
required / keyword-only
iv bytes
required / keyword-only
encrypted_key bytes
required / keyword-only
public_key_id str | None
default None / keyword-only
form_code FormSchema
default FormSchema.FA3 / keyword-only
offline_mode bool
default False / keyword-only
prepared_batch PreparedBatch | None
default None / keyword-only