Files
officeconvert/gen/python/officeconvertapi/v1/conversion_pb2.pyi
T
end 06d4122e4e
Docker server image / build-and-push (push) Successful in 3m2s
add rich output support for slide notes
2026-05-07 10:35:37 -07:00

228 lines
11 KiB
Python

import datetime
from google.protobuf import timestamp_pb2 as _timestamp_pb2
from google.protobuf.internal import containers as _containers
from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
from google.protobuf import descriptor as _descriptor
from google.protobuf import message as _message
from collections.abc import Iterable as _Iterable, Mapping as _Mapping
from typing import ClassVar as _ClassVar, Optional as _Optional, Union as _Union
DESCRIPTOR: _descriptor.FileDescriptor
class ConversionStatus(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
__slots__ = ()
CONVERSION_STATUS_UNSPECIFIED: _ClassVar[ConversionStatus]
CONVERSION_STATUS_PENDING: _ClassVar[ConversionStatus]
CONVERSION_STATUS_RUNNING: _ClassVar[ConversionStatus]
CONVERSION_STATUS_SUCCEEDED: _ClassVar[ConversionStatus]
CONVERSION_STATUS_FAILED: _ClassVar[ConversionStatus]
class ConversionPhase(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
__slots__ = ()
CONVERSION_PHASE_UNSPECIFIED: _ClassVar[ConversionPhase]
CONVERSION_PHASE_INACTIVE: _ClassVar[ConversionPhase]
CONVERSION_PHASE_EXTRACTING_NOTES: _ClassVar[ConversionPhase]
CONVERSION_PHASE_PPTX_TO_PDF: _ClassVar[ConversionPhase]
CONVERSION_PHASE_PDF_TO_IMAGES: _ClassVar[ConversionPhase]
CONVERSION_PHASE_UPLOADING_RESULTS: _ClassVar[ConversionPhase]
class ConversionResolution(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
__slots__ = ()
CONVERSION_RESOLUTION_UNSPECIFIED: _ClassVar[ConversionResolution]
CONVERSION_RESOLUTION_SD: _ClassVar[ConversionResolution]
CONVERSION_RESOLUTION_HD: _ClassVar[ConversionResolution]
CONVERSION_RESOLUTION_FHD: _ClassVar[ConversionResolution]
CONVERSION_RESOLUTION_QHD: _ClassVar[ConversionResolution]
CONVERSION_RESOLUTION_UHD: _ClassVar[ConversionResolution]
class NotesFormat(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
__slots__ = ()
NOTES_FORMAT_UNSPECIFIED: _ClassVar[NotesFormat]
NOTES_FORMAT_PLAIN: _ClassVar[NotesFormat]
NOTES_FORMAT_HTML: _ClassVar[NotesFormat]
CONVERSION_STATUS_UNSPECIFIED: ConversionStatus
CONVERSION_STATUS_PENDING: ConversionStatus
CONVERSION_STATUS_RUNNING: ConversionStatus
CONVERSION_STATUS_SUCCEEDED: ConversionStatus
CONVERSION_STATUS_FAILED: ConversionStatus
CONVERSION_PHASE_UNSPECIFIED: ConversionPhase
CONVERSION_PHASE_INACTIVE: ConversionPhase
CONVERSION_PHASE_EXTRACTING_NOTES: ConversionPhase
CONVERSION_PHASE_PPTX_TO_PDF: ConversionPhase
CONVERSION_PHASE_PDF_TO_IMAGES: ConversionPhase
CONVERSION_PHASE_UPLOADING_RESULTS: ConversionPhase
CONVERSION_RESOLUTION_UNSPECIFIED: ConversionResolution
CONVERSION_RESOLUTION_SD: ConversionResolution
CONVERSION_RESOLUTION_HD: ConversionResolution
CONVERSION_RESOLUTION_FHD: ConversionResolution
CONVERSION_RESOLUTION_QHD: ConversionResolution
CONVERSION_RESOLUTION_UHD: ConversionResolution
NOTES_FORMAT_UNSPECIFIED: NotesFormat
NOTES_FORMAT_PLAIN: NotesFormat
NOTES_FORMAT_HTML: NotesFormat
class JpegOutputOptions(_message.Message):
__slots__ = ("quality",)
QUALITY_FIELD_NUMBER: _ClassVar[int]
quality: int
def __init__(self, quality: _Optional[int] = ...) -> None: ...
class SlideRasterOptions(_message.Message):
__slots__ = ("resolution", "jpeg")
RESOLUTION_FIELD_NUMBER: _ClassVar[int]
JPEG_FIELD_NUMBER: _ClassVar[int]
resolution: ConversionResolution
jpeg: JpegOutputOptions
def __init__(self, resolution: _Optional[_Union[ConversionResolution, str]] = ..., jpeg: _Optional[_Union[JpegOutputOptions, _Mapping]] = ...) -> None: ...
class HtmlFormattingPolicy(_message.Message):
__slots__ = ("ignore_bold", "ignore_italic", "ignore_underline", "ignore_strikethrough", "ignore_font_size", "ignore_color")
IGNORE_BOLD_FIELD_NUMBER: _ClassVar[int]
IGNORE_ITALIC_FIELD_NUMBER: _ClassVar[int]
IGNORE_UNDERLINE_FIELD_NUMBER: _ClassVar[int]
IGNORE_STRIKETHROUGH_FIELD_NUMBER: _ClassVar[int]
IGNORE_FONT_SIZE_FIELD_NUMBER: _ClassVar[int]
IGNORE_COLOR_FIELD_NUMBER: _ClassVar[int]
ignore_bold: bool
ignore_italic: bool
ignore_underline: bool
ignore_strikethrough: bool
ignore_font_size: bool
ignore_color: bool
def __init__(self, ignore_bold: _Optional[bool] = ..., ignore_italic: _Optional[bool] = ..., ignore_underline: _Optional[bool] = ..., ignore_strikethrough: _Optional[bool] = ..., ignore_font_size: _Optional[bool] = ..., ignore_color: _Optional[bool] = ...) -> None: ...
class NotesOptions(_message.Message):
__slots__ = ("format", "html_use_paragraph_tags", "html_policy")
FORMAT_FIELD_NUMBER: _ClassVar[int]
HTML_USE_PARAGRAPH_TAGS_FIELD_NUMBER: _ClassVar[int]
HTML_POLICY_FIELD_NUMBER: _ClassVar[int]
format: NotesFormat
html_use_paragraph_tags: bool
html_policy: HtmlFormattingPolicy
def __init__(self, format: _Optional[_Union[NotesFormat, str]] = ..., html_use_paragraph_tags: _Optional[bool] = ..., html_policy: _Optional[_Union[HtmlFormattingPolicy, _Mapping]] = ...) -> None: ...
class Slide(_message.Message):
__slots__ = ("index", "notes_plain", "image_url", "thumbnail_image_url", "notes_html")
INDEX_FIELD_NUMBER: _ClassVar[int]
NOTES_PLAIN_FIELD_NUMBER: _ClassVar[int]
IMAGE_URL_FIELD_NUMBER: _ClassVar[int]
THUMBNAIL_IMAGE_URL_FIELD_NUMBER: _ClassVar[int]
NOTES_HTML_FIELD_NUMBER: _ClassVar[int]
index: int
notes_plain: str
image_url: str
thumbnail_image_url: str
notes_html: str
def __init__(self, index: _Optional[int] = ..., notes_plain: _Optional[str] = ..., image_url: _Optional[str] = ..., thumbnail_image_url: _Optional[str] = ..., notes_html: _Optional[str] = ...) -> None: ...
class SlideDeck(_message.Message):
__slots__ = ("conversion_id", "source_filename", "slides", "created_at", "width", "height", "thumbnail_width", "thumbnail_height")
CONVERSION_ID_FIELD_NUMBER: _ClassVar[int]
SOURCE_FILENAME_FIELD_NUMBER: _ClassVar[int]
SLIDES_FIELD_NUMBER: _ClassVar[int]
CREATED_AT_FIELD_NUMBER: _ClassVar[int]
WIDTH_FIELD_NUMBER: _ClassVar[int]
HEIGHT_FIELD_NUMBER: _ClassVar[int]
THUMBNAIL_WIDTH_FIELD_NUMBER: _ClassVar[int]
THUMBNAIL_HEIGHT_FIELD_NUMBER: _ClassVar[int]
conversion_id: str
source_filename: str
slides: _containers.RepeatedCompositeFieldContainer[Slide]
created_at: _timestamp_pb2.Timestamp
width: int
height: int
thumbnail_width: int
thumbnail_height: int
def __init__(self, conversion_id: _Optional[str] = ..., source_filename: _Optional[str] = ..., slides: _Optional[_Iterable[_Union[Slide, _Mapping]]] = ..., created_at: _Optional[_Union[datetime.datetime, _timestamp_pb2.Timestamp, _Mapping]] = ..., width: _Optional[int] = ..., height: _Optional[int] = ..., thumbnail_width: _Optional[int] = ..., thumbnail_height: _Optional[int] = ...) -> None: ...
class CreateConversionRequest(_message.Message):
__slots__ = ("source_filename", "full", "thumbnail", "notes")
SOURCE_FILENAME_FIELD_NUMBER: _ClassVar[int]
FULL_FIELD_NUMBER: _ClassVar[int]
THUMBNAIL_FIELD_NUMBER: _ClassVar[int]
NOTES_FIELD_NUMBER: _ClassVar[int]
source_filename: str
full: SlideRasterOptions
thumbnail: SlideRasterOptions
notes: NotesOptions
def __init__(self, source_filename: _Optional[str] = ..., full: _Optional[_Union[SlideRasterOptions, _Mapping]] = ..., thumbnail: _Optional[_Union[SlideRasterOptions, _Mapping]] = ..., notes: _Optional[_Union[NotesOptions, _Mapping]] = ...) -> None: ...
class CreateConversionResponse(_message.Message):
__slots__ = ("conversion_id", "upload_bucket", "upload_object_key", "upload_url", "expires_at")
CONVERSION_ID_FIELD_NUMBER: _ClassVar[int]
UPLOAD_BUCKET_FIELD_NUMBER: _ClassVar[int]
UPLOAD_OBJECT_KEY_FIELD_NUMBER: _ClassVar[int]
UPLOAD_URL_FIELD_NUMBER: _ClassVar[int]
EXPIRES_AT_FIELD_NUMBER: _ClassVar[int]
conversion_id: str
upload_bucket: str
upload_object_key: str
upload_url: str
expires_at: _timestamp_pb2.Timestamp
def __init__(self, conversion_id: _Optional[str] = ..., upload_bucket: _Optional[str] = ..., upload_object_key: _Optional[str] = ..., upload_url: _Optional[str] = ..., expires_at: _Optional[_Union[datetime.datetime, _timestamp_pb2.Timestamp, _Mapping]] = ...) -> None: ...
class StartConversionRequest(_message.Message):
__slots__ = ("conversion_id",)
CONVERSION_ID_FIELD_NUMBER: _ClassVar[int]
conversion_id: str
def __init__(self, conversion_id: _Optional[str] = ...) -> None: ...
class StartConversionResponse(_message.Message):
__slots__ = ("conversion_id", "status")
CONVERSION_ID_FIELD_NUMBER: _ClassVar[int]
STATUS_FIELD_NUMBER: _ClassVar[int]
conversion_id: str
status: ConversionStatus
def __init__(self, conversion_id: _Optional[str] = ..., status: _Optional[_Union[ConversionStatus, str]] = ...) -> None: ...
class GetConversionStatusRequest(_message.Message):
__slots__ = ("conversion_id",)
CONVERSION_ID_FIELD_NUMBER: _ClassVar[int]
conversion_id: str
def __init__(self, conversion_id: _Optional[str] = ...) -> None: ...
class GetConversionStatusResponse(_message.Message):
__slots__ = ("conversion_id", "status", "error_message", "updated_at", "phase", "current_progress", "max_progress")
CONVERSION_ID_FIELD_NUMBER: _ClassVar[int]
STATUS_FIELD_NUMBER: _ClassVar[int]
ERROR_MESSAGE_FIELD_NUMBER: _ClassVar[int]
UPDATED_AT_FIELD_NUMBER: _ClassVar[int]
PHASE_FIELD_NUMBER: _ClassVar[int]
CURRENT_PROGRESS_FIELD_NUMBER: _ClassVar[int]
MAX_PROGRESS_FIELD_NUMBER: _ClassVar[int]
conversion_id: str
status: ConversionStatus
error_message: str
updated_at: _timestamp_pb2.Timestamp
phase: ConversionPhase
current_progress: int
max_progress: int
def __init__(self, conversion_id: _Optional[str] = ..., status: _Optional[_Union[ConversionStatus, str]] = ..., error_message: _Optional[str] = ..., updated_at: _Optional[_Union[datetime.datetime, _timestamp_pb2.Timestamp, _Mapping]] = ..., phase: _Optional[_Union[ConversionPhase, str]] = ..., current_progress: _Optional[int] = ..., max_progress: _Optional[int] = ...) -> None: ...
class GetSlideDeckRequest(_message.Message):
__slots__ = ("conversion_id",)
CONVERSION_ID_FIELD_NUMBER: _ClassVar[int]
conversion_id: str
def __init__(self, conversion_id: _Optional[str] = ...) -> None: ...
class GetSlideDeckResponse(_message.Message):
__slots__ = ("slide_deck",)
SLIDE_DECK_FIELD_NUMBER: _ClassVar[int]
slide_deck: SlideDeck
def __init__(self, slide_deck: _Optional[_Union[SlideDeck, _Mapping]] = ...) -> None: ...
class DeleteConversionRequest(_message.Message):
__slots__ = ("conversion_id",)
CONVERSION_ID_FIELD_NUMBER: _ClassVar[int]
conversion_id: str
def __init__(self, conversion_id: _Optional[str] = ...) -> None: ...
class DeleteConversionResponse(_message.Message):
__slots__ = ("conversion_id", "deleted")
CONVERSION_ID_FIELD_NUMBER: _ClassVar[int]
DELETED_FIELD_NUMBER: _ClassVar[int]
conversion_id: str
deleted: bool
def __init__(self, conversion_id: _Optional[str] = ..., deleted: _Optional[bool] = ...) -> None: ...