vgen-apimatic-sdk 0.0.1

data/lib/videogen/apis/projects_api.rb

@@ -0,0 +1,355 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # ProjectsApi
+  class ProjectsApi < BaseApi
+    # Returns projects, most recently updated first. By default only API-created
+    # projects are included; pass `includeUiProjects=true` to also include
+    # dashboard-created projects. Use `selfOnly=true` to restrict results to the
+    # calling API key's user; otherwise all matching projects for the team are
+    # returned. Cursor-paginated; see the [Pagination](/pagination) guide.
+    # @param [String] authorization Required parameter: API key from
+    # [app.videogen.io/api](https://app.videogen.io/api). The full key is only
+    # shown once when you create it.
+    # @param [Integer] limit Optional parameter: Maximum number of items to
+    # return in the page. Defaults to 50; capped at 200. See
+    # [Pagination](/pagination).
+    # @param [String] cursor Optional parameter: Opaque pagination cursor
+    # returned as `nextCursor` by the previous page. Omit on the first request.
+    # Cursors are tied to the endpoint that produced them and must be passed
+    # unmodified. See [Pagination](/pagination).
+    # @param [TrueClass | FalseClass] self_only Optional parameter: When true,
+    # returns only items created by the API key's owner. When false (default),
+    # returns all items accessible to the team.
+    # @param [TrueClass | FalseClass] include_ui_projects Optional parameter:
+    # When true, includes dashboard-created projects in addition to API-created
+    # projects. When false (default), returns only API-created projects.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_projects(authorization,
+                      limit: 50,
+                      cursor: nil,
+                      self_only: false,
+                      include_ui_projects: false)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/projects',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(self_only, key: 'selfOnly'))
+                   .query_param(new_parameter(include_ui_projects, key: 'includeUiProjects'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListProjectsResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Returns a simplified view of a project including its title, aspect ratio,
+    # status, and URL.
+    # @param [String] project_id Required parameter: The project id (e.g.
+    # `vg_proj_...`).
+    # @param [String] authorization Required parameter: API key from
+    # [app.videogen.io/api](https://app.videogen.io/api). The full key is only
+    # shown once when you create it.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_project(project_id,
+                    authorization)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/projects/{projectId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(project_id, key: 'projectId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ProjectResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Starts an export of a project to MP4. Returns immediately with an export
+    # id; the file becomes available when the export task completes. Exporting
+    # requires a paid plan in the app, but the API lets you export for free with
+    # a VideoGen watermark and a short 'Made with VideoGen' end screen appended
+    # to the video. A Pro plan lets you remove both by setting `watermarkMode`
+    # and `endScreenMode` to `NONE`.
+    # @param [String] project_id Required parameter: The project id (e.g.
+    # `vg_proj_...`).
+    # @param [String] authorization Required parameter: API key from
+    # [app.videogen.io/api](https://app.videogen.io/api). The full key is only
+    # shown once when you create it.
+    # @param [ExportProjectRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def export_project(project_id,
+                       authorization,
+                       body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/projects/{projectId}/export',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(project_id, key: 'projectId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ExportProjectResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Returns a project's exports, newest first, as fully hydrated
+    # `ProjectExport` objects (status, signed download/thumbnail URLs, and the
+    # embedded `file`). Signed URLs are re-signed when within an hour of
+    # expiring, so they are always valid long enough to use. Cursor-paginated;
+    # see the [Pagination](/pagination) guide.
+    # @param [String] project_id Required parameter: The project id (e.g.
+    # `vg_proj_...`).
+    # @param [String] authorization Required parameter: API key from
+    # [app.videogen.io/api](https://app.videogen.io/api). The full key is only
+    # shown once when you create it.
+    # @param [Integer] limit Optional parameter: Maximum number of items to
+    # return in the page. Defaults to 50; capped at 200. See
+    # [Pagination](/pagination).
+    # @param [String] cursor Optional parameter: Opaque pagination cursor
+    # returned as `nextCursor` by the previous page. Omit on the first request.
+    # Cursors are tied to the endpoint that produced them and must be passed
+    # unmodified. See [Pagination](/pagination).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_project_exports(project_id,
+                             authorization,
+                             limit: 50,
+                             cursor: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/projects/{projectId}/exports',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(project_id, key: 'projectId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListProjectExportsResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Returns the current status of a project export started via `POST
+    # /v1/projects/{projectId}/export`, and — once `status` is `succeeded` — the
+    # signed download/thumbnail URLs and the hydrated export `file`. Poll this
+    # endpoint until `status` is `succeeded`, `failed`, or `cancelled`. The
+    # signed URLs are private and valid for 7 days; this endpoint automatically
+    # re-signs them when they are within an hour of expiring, so a caller always
+    # receives a URL valid long enough to use. Every endpoint that returns
+    # hydrated files auto-rehydrates this way — only the file endpoints (`GET
+    # /v1/files/{fileId}` and `POST /v1/files/{fileId}/hydrate`) are the
+    # explicit, on-demand hydration paths. Use `exportFileId` with `POST
+    # /v1/files/{fileId}/hydrate` if you need to re-sign the export file
+    # directly later.
+    # @param [String] project_id Required parameter: The project id (e.g.
+    # `vg_proj_...`).
+    # @param [String] export_id Required parameter: The export id (e.g.
+    # `vg_expo_...`) returned by `POST /v1/projects/{projectId}/export`.
+    # @param [String] authorization Required parameter: API key from
+    # [app.videogen.io/api](https://app.videogen.io/api). The full key is only
+    # shown once when you create it.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_project_export(project_id,
+                           export_id,
+                           authorization)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/projects/{projectId}/exports/{exportId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(project_id, key: 'projectId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(export_id, key: 'exportId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ProjectExport.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Starts a timeline interchange job that converts a project into an editor
+    # interchange document (Final Cut Pro FCPXML, Adobe Premiere Pro XML,
+    # OpenTimelineIO, or an SRT caption sidecar). Returns immediately with an
+    # interchange job id; the file becomes available when the job completes.
+    # Unlike `POST /v1/projects/{projectId}/export` (which renders a flattened
+    # MP4), this preserves the project as an editable timeline of separate
+    # clips, tracks, and captions so you can keep editing it in a desktop video
+    # editor. Choose `mediaDelivery` to control how the document references
+    # media: `REMOTE_URLS` produces a single document that links to signed media
+    # URLs, while `BUNDLE` produces a zip containing the document plus every
+    # referenced media file for durable offline relinking.
+    # @param [String] project_id Required parameter: The project id (e.g.
+    # `vg_proj_...`).
+    # @param [String] authorization Required parameter: API key from
+    # [app.videogen.io/api](https://app.videogen.io/api). The full key is only
+    # shown once when you create it.
+    # @param [CreateTimelineInterchangeRequest] body Optional parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_timeline_interchange(project_id,
+                                    authorization,
+                                    body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/projects/{projectId}/timeline-interchange',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(project_id, key: 'projectId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CreateTimelineInterchangeResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Returns the current status of a timeline interchange job started via `POST
+    # /v1/projects/{projectId}/timeline-interchange`, and, once `status` is
+    # `succeeded`, the signed download URL and the hydrated interchange `file`.
+    # Poll this endpoint until `status` is `succeeded`, `failed`, or
+    # `cancelled`. The signed URL is private and valid for 7 days; this endpoint
+    # automatically re-signs it when it is within an hour of expiring. Use
+    # `interchangeFileId` with `POST /v1/files/{fileId}/hydrate` if you need to
+    # re-sign the file directly later.
+    # @param [String] interchange_job_id Required parameter: The timeline
+    # interchange job id (e.g. `vg_inte_...`) returned by `POST
+    # /v1/projects/{projectId}/timeline-interchange`.
+    # @param [String] authorization Required parameter: API key from
+    # [app.videogen.io/api](https://app.videogen.io/api). The full key is only
+    # shown once when you create it.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_timeline_interchange(interchange_job_id,
+                                 authorization)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/timeline-interchange/{interchangeJobId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(interchange_job_id, key: 'interchangeJobId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TimelineInterchange.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Applies an ordered list of edits (background music, logo overlay, caption
+    # visibility/style) to a project. Each action runs asynchronously as its own
+    # remix action; the response returns one remix action id per action in
+    # order. Set `saveAsNewProject` to apply the edits to a copy and leave the
+    # original untouched. Poll `GET /v1/projects/{projectId}/remix-actions` for
+    # status.
+    # @param [String] project_id Required parameter: The project id (e.g.
+    # `vg_proj_...`).
+    # @param [String] authorization Required parameter: API key from
+    # [app.videogen.io/api](https://app.videogen.io/api). The full key is only
+    # shown once when you create it.
+    # @param [RemixProjectRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def remix_project(project_id,
+                      authorization,
+                      body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/projects/{projectId}/remix',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(project_id, key: 'projectId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(RemixProjectResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Returns remix actions applied to a project (via `POST
+    # /v1/projects/{projectId}/remix` or as a post-workflow step), most recent
+    # first, with each action's status and progress. Cursor-paginated; see the
+    # [Pagination](/pagination) guide.
+    # @param [String] project_id Required parameter: The project id (e.g.
+    # `vg_proj_...`).
+    # @param [String] authorization Required parameter: API key from
+    # [app.videogen.io/api](https://app.videogen.io/api). The full key is only
+    # shown once when you create it.
+    # @param [Integer] limit Optional parameter: Maximum number of items to
+    # return in the page. Defaults to 50; capped at 200. See
+    # [Pagination](/pagination).
+    # @param [String] cursor Optional parameter: Opaque pagination cursor
+    # returned as `nextCursor` by the previous page. Omit on the first request.
+    # Cursors are tied to the endpoint that produced them and must be passed
+    # unmodified. See [Pagination](/pagination).
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_project_remix_actions(project_id,
+                                   authorization,
+                                   limit: 50,
+                                   cursor: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/projects/{projectId}/remix-actions',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(project_id, key: 'projectId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListRemixActionsResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/videogen/apis/resources_api.rb

@@ -0,0 +1,81 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # ResourcesApi
+  class ResourcesApi < BaseApi
+    # List available text-to-speech voices. Pass a `voiceId` or `displayName`
+    # from the response to the text-to-speech endpoint. Cursor-paginated; see
+    # the [Pagination](/pagination) guide. Pass `query` to filter by voice id,
+    # display name, language, accent, or description.
+    # @param [String] authorization Required parameter: API key from
+    # [app.videogen.io/api](https://app.videogen.io/api). The full key is only
+    # shown once when you create it.
+    # @param [Integer] limit Optional parameter: Maximum number of items to
+    # return in the page. Defaults to 50; capped at 200. See
+    # [Pagination](/pagination).
+    # @param [String] cursor Optional parameter: Opaque pagination cursor
+    # returned as `nextCursor` by the previous page. Omit on the first request.
+    # Cursors are tied to the endpoint that produced them and must be passed
+    # unmodified. See [Pagination](/pagination).
+    # @param [TrueClass | FalseClass] include_deprecated_voices Optional
+    # parameter: When true, includes voices that are deprecated but still
+    # callable. Defaults to false.
+    # @param [String] query Optional parameter: Optional case-insensitive
+    # substring filter across each item's searchable text fields. Omit to return
+    # the unfiltered catalogue.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_tts_voices(authorization,
+                        limit: 50,
+                        cursor: nil,
+                        include_deprecated_voices: false,
+                        query: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/resources/tts-voices',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(include_deprecated_voices, key: 'includeDeprecatedVoices'))
+                   .query_param(new_parameter(query, key: 'query'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TtsVoiceListResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # List the languages a project can be translated into. Pass a `languageCode`
+    # from the response to the `TRANSLATE_PROJECT` remix action. Returns the
+    # full catalogue in a single response (not paginated). Pass `query` to
+    # filter by language code or English name.
+    # @param [String] authorization Required parameter: API key from
+    # [app.videogen.io/api](https://app.videogen.io/api). The full key is only
+    # shown once when you create it.
+    # @param [String] query Optional parameter: Optional case-insensitive
+    # substring filter across each item's searchable text fields. Omit to return
+    # the unfiltered catalogue.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_languages(authorization,
+                       query: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/resources/languages',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .query_param(new_parameter(query, key: 'query'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LanguageListResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/videogen/apis/text_api.rb

@@ -0,0 +1,39 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # TextApi
+  class TextApi < BaseApi
+    # Generate text from a prompt using a general-purpose language model. Choose
+    # a quality tier with `quality` (`LOW`, `STANDARD`, `HIGH`, or `MAX`).
+    # Synchronous: the response includes the generated text. Useful for drafting
+    # scripts, titles, descriptions, and other short copy before generating a
+    # video.
+    # @param [String] authorization Required parameter: API key from
+    # [app.videogen.io/api](https://app.videogen.io/api). The full key is only
+    # shown once when you create it.
+    # @param [GenerateTextRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def generate_text(authorization,
+                      body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/text/generate',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GenerateTextResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end