Skip to content

videos_thumbnails.md

Latest commit

 

History

History
115 lines (91 loc) · 6.07 KB

videos_thumbnails.md

File metadata and controls

115 lines (91 loc) · 6.07 KB
Raw

VideosThumbnails — operations

Accessor: client.videos_thumbnails · Source: vimeo_api/apis/videos_thumbnails.py · 7 operations

Each ### block is one operation and assumes sdk-map.md is loaded: blocks omit what its invariants table covers and are otherwise self-contained, so chunk at block level. Signatures are the sync parsed spelling; the async and raw spellings take the same parameters (see sdk-map.md). Type sources names the module declaring each type an operation mentions, so resolving a body, return or error payload is a lookup rather than a search; the runtime types RawError and ApiResult are excluded, and an operation with no table mentions nothing but builtins and those.

client.videos_thumbnails.create_video_thumbnail

  • Route: POST /videos/{video_id}/pictures
  • Auth: oauth2_authorization_code OR oauth2_client_credentials OR bearer
  • Signature: def create_video_thumbnail(video_id: float, *, body: VideosPicturesRequest | VideosPicturesRequestDict | None = None, request_options: RequestOptionsOrDict | None = None)
    • required, positional: video_id
  • Params: video_id — path · body — JSON body
  • Returns (parsed): Picture
  • Returns (raw): ApiResult[Picture, RawError]
  • Error: RawError — Case B
Type Source
VideosPicturesRequest vimeo_api/models/videos_pictures_request.py
VideosPicturesRequestDict vimeo_api/models/videos_pictures_request.py
Picture vimeo_api/models/picture.py

client.videos_thumbnails.create_video_thumbnail_alt1

  • Route: POST /channels/{channel_id}/videos/{video_id}/pictures
  • Auth: oauth2_authorization_code OR oauth2_client_credentials OR bearer
  • Signature: def create_video_thumbnail_alt1(channel_id: float, video_id: float, *, body: ChannelsVideosPicturesRequest | ChannelsVideosPicturesRequestDict | None = None, request_options: RequestOptionsOrDict | None = None)
    • required, positional: channel_id, video_id
  • Params: channel_id — path · video_id — path · body — JSON body
  • Returns (parsed): Picture
  • Returns (raw): ApiResult[Picture, RawError]
  • Error: RawError — Case B
Type Source
ChannelsVideosPicturesRequest vimeo_api/models/channels_videos_pictures_request.py
ChannelsVideosPicturesRequestDict vimeo_api/models/channels_videos_pictures_request.py
Picture vimeo_api/models/picture.py

client.videos_thumbnails.delete_video_thumbnail

  • Route: DELETE /videos/{video_id}/pictures/{picture_id}
  • Auth: oauth2_authorization_code OR oauth2_client_credentials OR bearer
  • Signature: def delete_video_thumbnail(picture_id: float, video_id: float, *, request_options: RequestOptionsOrDict | None = None)
    • required, positional: picture_id, video_id
  • Params: picture_id — path · video_id — path
  • Returns (parsed): None
  • Returns (raw): ApiResult[None, RawError]
  • Error: RawError — Case B

client.videos_thumbnails.edit_video_thumbnail

  • Route: PATCH /videos/{video_id}/pictures/{picture_id}
  • Auth: oauth2_authorization_code OR oauth2_client_credentials OR bearer
  • Signature: def edit_video_thumbnail(picture_id: float, video_id: float, *, body: VideosPicturesRequest1 | VideosPicturesRequest1Dict | None = None, request_options: RequestOptionsOrDict | None = None)
    • required, positional: picture_id, video_id
  • Params: picture_id — path · video_id — path · body — JSON body
  • Returns (parsed): Picture
  • Returns (raw): ApiResult[Picture, RawError]
  • Error: RawError — Case B
Type Source
VideosPicturesRequest1 vimeo_api/models/videos_pictures_request1.py
VideosPicturesRequest1Dict vimeo_api/models/videos_pictures_request1.py
Picture vimeo_api/models/picture.py

client.videos_thumbnails.get_video_thumbnail

  • Route: GET /videos/{video_id}/pictures/{picture_id}
  • Auth: oauth2_authorization_code OR oauth2_client_credentials OR bearer
  • Signature: def get_video_thumbnail(picture_id: float, video_id: float, *, request_options: RequestOptionsOrDict | None = None)
    • required, positional: picture_id, video_id
  • Params: picture_id — path · video_id — path
  • Returns (parsed): Picture
  • Returns (raw): ApiResult[Picture, RawError]
  • Error: RawError — Case B
Type Source
Picture vimeo_api/models/picture.py

client.videos_thumbnails.get_video_thumbnails

  • Route: GET /videos/{video_id}/pictures
  • Auth: oauth2_authorization_code OR oauth2_client_credentials OR bearer
  • Signature: def get_video_thumbnails(video_id: float, *, page: float | None = None, per_page: float | None = None, request_options: RequestOptionsOrDict | None = None)
    • required, positional: video_id
  • Params: video_id — path · page — query · per_page — query
  • Returns (parsed): PictureConnection
  • Returns (raw): ApiResult[PictureConnection, RawError]
  • Error: RawError — Case B
Type Source
PictureConnection vimeo_api/models/picture_connection.py

client.videos_thumbnails.get_video_thumbnails_alt1

  • Route: GET /channels/{channel_id}/videos/{video_id}/pictures
  • Auth: oauth2_authorization_code OR oauth2_client_credentials OR bearer
  • Signature: def get_video_thumbnails_alt1(channel_id: float, video_id: float, *, page: float | None = None, per_page: float | None = None, request_options: RequestOptionsOrDict | None = None)
    • required, positional: channel_id, video_id
  • Params: channel_id — path · video_id — path · page — query · per_page — query
  • Returns (parsed): PictureConnection
  • Returns (raw): ApiResult[PictureConnection, RawError]
  • Error: RawError — Case B
Type Source
PictureConnection vimeo_api/models/picture_connection.py