vgen-apimatic-sdk 0.0.1

data/lib/videogen/apis/entities_api.rb

@@ -0,0 +1,230 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # EntitiesApi
+  class EntitiesApi < BaseApi
+    # List built-in actors, products, visual styles, and slideshow themes,
+    # followed by the entities available to your team. Built-in entities have
+    # `isBuiltIn: true` and cannot be updated or archived. 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 [V1EntitiesGetParametersEntityType] entity_type Optional parameter:
+    # When provided, returns only entities of this type. Omit to return all
+    # entities.
+    # @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_entities(authorization,
+                      entity_type: nil,
+                      limit: 50,
+                      cursor: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/entities',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(authorization, key: 'Authorization')
+                                  .is_required(true))
+                   .query_param(new_parameter(entity_type, key: 'entityType'))
+                   .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(ListEntitiesResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Create a new actor or visual style. Attach reference images with `POST
+    # /v1/entities/{entityId}/references`.
+    # @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 [CreateEntityRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_entity(authorization,
+                      body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/entities',
+                                     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(Entity.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Retrieve a single entity by its id, including its reference images.
+    # Built-in catalog entities are included.
+    # @param [String] entity_id Required parameter: The entity id (e.g.
+    # `vg_enti_...`).
+    # @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_entity(entity_id,
+                   authorization)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/entities/{entityId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(entity_id, key: 'entityId')
+                                    .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(Entity.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Update an entity's name or description. Provide at least one field.
+    # Built-in entities (`isBuiltIn: true`) cannot be updated.
+    # @param [String] entity_id Required parameter: The entity id (e.g.
+    # `vg_enti_...`).
+    # @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 [UpdateEntityRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_entity(entity_id,
+                      authorization,
+                      body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/entities/{entityId}/update',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(entity_id, key: 'entityId')
+                                    .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(Entity.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Archive an entity. Archived entities no longer appear in `GET
+    # /v1/entities` and can't be attached to new workflows. Built-in entities
+    # (`isBuiltIn: true`) cannot be archived.
+    # @param [String] entity_id Required parameter: The entity id (e.g.
+    # `vg_enti_...`).
+    # @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 archive_entity(entity_id,
+                       authorization)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/entities/{entityId}/archive',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(entity_id, key: 'entityId')
+                                    .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(EntityArchiveResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Attach an image file as a reference for the entity. Upload the image first
+    # via `POST /v1/files/upload`. Returns the updated entity. Built-in entities
+    # (`isBuiltIn: true`) cannot have references added.
+    # @param [String] entity_id Required parameter: The entity id (e.g.
+    # `vg_enti_...`).
+    # @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 [AddEntityReferenceRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def add_entity_reference(entity_id,
+                             authorization,
+                             body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/entities/{entityId}/references',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(entity_id, key: 'entityId')
+                                    .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(Entity.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Detach a reference image from the entity. Returns the updated entity.
+    # Built-in entities (`isBuiltIn: true`) cannot have references removed.
+    # @param [String] entity_id Required parameter: The entity id (e.g.
+    # `vg_enti_...`).
+    # @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 [RemoveEntityReferenceRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def remove_entity_reference(entity_id,
+                                authorization,
+                                body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/entities/{entityId}/references/remove',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(entity_id, key: 'entityId')
+                                    .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(Entity.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/videogen/apis/files_api.rb

@@ -0,0 +1,263 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # FilesApi
+  class FilesApi < BaseApi
+    # List files accessible to your team. By default this returns standalone
+    # files (direct tool-call outputs and uploads) and omits two categories:
+    # export files (the raw output files of your exports) and project files (the
+    # generative files created within a project, e.g. each AI image and
+    # text-to-speech file in a script-to-video workflow output). Set
+    # `includeExportFiles` and/or `includeProjectFiles` to true to include them.
+    # Use `selfOnly=true` to restrict results to files created by the calling
+    # API key's user. Files are returned most recently updated first.
+    # 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_export_files Optional parameter:
+    # When true, includes export files: the raw output files of your exports
+    # (the rendered MP4 you download from an export). When false (default), they
+    # are omitted.
+    # @param [TrueClass | FalseClass] include_project_files Optional parameter:
+    # When true, includes project files: the generative files created within a
+    # project (e.g. each AI image and text-to-speech file produced inside a
+    # script-to-video workflow output). When false (default), they are
+    # omitted.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_files(authorization,
+                  limit: 50,
+                  cursor: nil,
+                  self_only: false,
+                  include_export_files: false,
+                  include_project_files: false)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/files',
+                                     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_export_files, key: 'includeExportFiles'))
+                   .query_param(new_parameter(include_project_files, key: 'includeProjectFiles'))
+                   .header_param(new_parameter('application/json', key: 'accept')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetFilesResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Semantic vector search over your files. Embeds the query text and returns
+    # the closest matching files ranked by cosine similarity. Only files with
+    # indexed descriptions are searchable.
+    # @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 [SearchFilesRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def search_files(authorization,
+                     body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/files/search',
+                                     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(SearchFilesResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Retrieve metadata for a single file by its id.
+    # @param [String] file_id Required parameter: The file id (e.g.
+    # `vg_file_...`).
+    # @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_file(file_id,
+                 authorization)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/files/{fileId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(file_id, key: 'fileId')
+                                    .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(FileInfo.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Create a new file and receive a pre-signed upload URL. PUT the file bytes
+    # to the returned URL, then poll `GET /v1/files/{fileId}` until the file is
+    # ready.
+    # @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 [CreateFileUploadRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_file_upload(authorization,
+                           body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/files/upload',
+                                     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(FileUploadResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Generate fresh signed URLs for all available renditions of a file. Call
+    # this when source URLs are missing or expired. Returns the full file object
+    # with populated `downloadSource`, `thumbnailSource`, and `previewSource`
+    # (and the convenience root-level `downloadUrl` / `thumbnailUrl`).
+    # @param [String] file_id Required parameter: The file id (e.g.
+    # `vg_file_...`).
+    # @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 hydrate_file(file_id,
+                     authorization)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/files/{fileId}/hydrate',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(file_id, key: 'fileId')
+                                    .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(FileInfo.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Archive a file by setting its archived timestamp. Archived files are
+    # excluded from list results. Returns the updated file object.
+    # @param [String] file_id Required parameter: The file id (e.g.
+    # `vg_file_...`).
+    # @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 archive_file(file_id,
+                     authorization)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/files/{fileId}/archive',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(file_id, key: 'fileId')
+                                    .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(FileInfo.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Enable public preview for a file. Works for any file type. Copies the file
+    # to a permanent public URL (`staticPublicPreviewSource`) and, for video and
+    # audio, registers a public embed playback id (`publicPlaybackId`) for use
+    # with `@videogen/player`. If streaming playback is still processing, the
+    # endpoint polls briefly and background processing finishes creating the
+    # embed playback id. Returns the updated file.
+    # @param [String] file_id Required parameter: The file id (e.g.
+    # `vg_file_...`).
+    # @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 enable_public_preview(file_id,
+                              authorization)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/files/{fileId}/enable-public-preview',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(file_id, key: 'fileId')
+                                    .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(FileInfo.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Disable public preview for a file. Removes the permanent public URL copy
+    # and revokes unauthenticated embed streaming access. Authenticated signed
+    # URLs remain functional. Returns the updated file.
+    # @param [String] file_id Required parameter: The file id (e.g.
+    # `vg_file_...`).
+    # @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 disable_public_preview(file_id,
+                               authorization)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/files/{fileId}/disable-public-preview',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(file_id, key: 'fileId')
+                                    .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(FileInfo.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end