Terminals models

Models of the terminal endpoints.

Generated by python -m codegen from the iikoCloud OpenAPI specification. Do not edit by hand.

CashRegisterListItem

Bases: IikoModel

CashRegisterListItem.

id class-attribute instance-attribute

id: str | None = None

Cash register identifier (UUID)

name class-attribute instance-attribute

name: str | None = None

Cash register name

number class-attribute instance-attribute

number: str | None = None

Cash register number

status class-attribute instance-attribute

status: str | None = None

Cash register status

terminal_group_ids class-attribute instance-attribute

terminal_group_ids: list[str] | None = None

Identifiers of the terminal groups linked to the cash register (UUID)

CashRegisterListRequest

Bases: IikoModel

CashRegisterListRequest.

limit class-attribute instance-attribute

limit: int | None = None

Items per page. Default value: 50, from 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Offset. Default value: 0, non-negative

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

search class-attribute instance-attribute

search: str | None = None

Case-insensitive substring search by name or number

terminal_group_ids class-attribute instance-attribute

terminal_group_ids: list[str] | None = None

Filter by terminal group identifiers (UUID). Duplicates do not affect the result

CashRegisterListResponse

Bases: IikoModel

CashRegisterListResponse.

items class-attribute instance-attribute

items: list[CashRegisterListItem] | None = None

Cash registers

limit class-attribute instance-attribute

limit: int | None = None

Items per page. Default value: 50, from 1 to 1000

offset class-attribute instance-attribute

offset: int | None = None

Offset. Default value: 0, non-negative

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of matches before pagination

TerminalListItem

Bases: IikoModel

TerminalListItem.

computer_name class-attribute instance-attribute

computer_name: str | None = None

Terminal host address

id class-attribute instance-attribute

id: str | None = None

Terminal identifier (UUID)

is_anonymous class-attribute instance-attribute

is_anonymous: bool | None = None

Anonymous terminal flag

name class-attribute instance-attribute

name: str | None = None

Terminal name

restaurant_section_ids class-attribute instance-attribute

restaurant_section_ids: list[str] | None = None

Identifiers of the dining-hall sections available to the terminal

TerminalListRequest

Bases: IikoModel

TerminalListRequest.

include_anonymous class-attribute instance-attribute

include_anonymous: bool | None = None

Include anonymous terminals. Default value: false

organization_id instance-attribute

organization_id: str

Organization identifier (GUID)

search class-attribute instance-attribute

search: str | None = None

Filter by terminal name

TerminalListResponse

Bases: IikoModel

TerminalListResponse.

items class-attribute instance-attribute

items: list[TerminalListItem] | None = None

Terminals

total_count class-attribute instance-attribute

total_count: int | None = None

Total number of terminals in the response