vgen-apimatic-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14b5f03cdedbb3f8117386372585f51450aa682af41008628d21995d214872af
+  data.tar.gz: a00180861a93292562d9fcc7c2b19dc86d090bf378311a316d565daf328a14ad
+SHA512:
+  metadata.gz: 1f36642af396fa22c5b6cad882499c501514f66e6702a91e2ad4360bb0dc5eae043613bfa3c1c0ef0aa2f5cf285ac21eced2e89886b9f121b6db53f7ad4ede97
+  data.tar.gz: e6c303b9bd4f8566a9484b6068c88fb410994479c00ead8904f0ffe62d508f8e0716ba6ed56cb48f7c3b82644805364e43640f26b5fb964fc4127b293662f12c

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2026 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,152 @@
+
+# Getting Started with Videogen
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install vgen-apimatic-sdk -v 0.0.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'vgen-apimatic-sdk', '0.0.1'
+```
+
+For additional gem details, see the [RubyGems page for the vgen-apimatic-sdk gem](https://rubygems.org/gems/vgen-apimatic-sdk/versions/0.0.1).
+
+## IRB Console Usage
+
+You can explore the SDK interactively using IRB in two ways
+
+### 1. Use IRB with Installed Gem
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
+
+```bash
+irb
+```
+
+Now you can load the SDK in the IRB
+
+```ruby
+require 'videogen'
+include Videogen
+```
+
+### 2. Use IRB within SDK
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
+
+```
+cd path/to/videogen
+```
+
+Now you can start the preconfigured irb console by running the following command
+
+```bash
+ruby bin/console
+```
+
+**_Note:_** This automatically loads the SDK from lib/
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| timeout | `Float` | The value to use for connection timeout. <br> **Default: 30** |
+| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| bearer_auth_credentials | [`BearerAuthCredentials`](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'videogen'
+include Videogen
+
+client = Client.new(
+  bearer_auth_credentials: BearerAuthCredentials.new(
+    access_token: 'AccessToken'
+  ),
+  logging_configuration: LoggingConfiguration.new(
+    log_level: Logger::INFO,
+    request_logging_config: RequestLoggingConfiguration.new(
+      log_body: true
+    ),
+    response_logging_config: ResponseLoggingConfiguration.new(
+      log_headers: true
+    )
+  )
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'videogen'
+include Videogen
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md) section for details.
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`bearerAuth (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md)
+
+## List of APIs
+
+* [Workflows](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/workflows.md)
+* [Projects](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/projects.md)
+* [Assistant](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/assistant.md)
+* [Tools](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/tools.md)
+* [Text](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/text.md)
+* [Files](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/files.md)
+* [Entities](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/entities.md)
+* [Resources](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/resources.md)
+* [Webhooks](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/webhooks.md)
+* [Account](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/account.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/vgen-apimatic-ruby-sdk/tree/0.0.1/doc/date-time-helper.md)
+

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# Load the lib folder into Ruby's load path
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+# Require the gem
+require 'videogen'
+
+puts 'Videogen SDK loaded!'
+puts 'You can now create a client with: client = Videogen::Client.new'
+puts 'Or use from_env: client = Videogen::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/videogen/api_helper.rb

@@ -0,0 +1,10 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end

data/lib/videogen/apis/account_api.rb

@@ -0,0 +1,31 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # AccountApi
+  class AccountApi < BaseApi
+    # Return the account and team behind the API key making the request. Takes
+    # no parameters. Call it as a connection test to confirm a key is valid and
+    # to discover the `teamId` and account `email` a key belongs to.
+    # @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_me(authorization)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/me',
+                                     Server::DEFAULT)
+                   .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(MeResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/videogen/apis/assistant_api.rb

@@ -0,0 +1,191 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # AssistantApi
+  class AssistantApi < BaseApi
+    # Creates a new project and sends the first message to the VideoGen AI
+    # assistant, exactly like typing into the assistant on a new project in the
+    # app. Asynchronous: the response contains the `messageId` of the
+    # assistant's pending reply (e.g. `vg_mesg_...`). Poll `GET
+    # /v1/assistant-messages/{messageId}` until `status` is `succeeded`,
+    # `failed`, or `cancelled`, or subscribe to `assistant_message.*` webhooks.
+    # Fetch the parent assistant with `GET /v1/assistants/{assistantId}` to list
+    # all messages in the chat.
+    # @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 [StartAssistantChatRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def start_assistant_chat(authorization,
+                             body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/assistants',
+                                     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(StartAssistantChatResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Returns the assistant chat identified by `assistantId`, including every
+    # message in it (user and assistant turns) in chronological order.
+    # @param [String] assistant_id Required parameter: The assistant chat id
+    # (e.g. `vg_asst_...`). Every API project has one assistant chat; find it on
+    # `ProjectResponse.assistantId`.
+    # @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_assistant(assistant_id,
+                      authorization)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/assistants/{assistantId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(assistant_id, key: 'assistantId')
+                                    .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(GetAssistantResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Sends a follow-up message to an existing assistant chat started with `POST
+    # /v1/assistants`. Asynchronous: the response contains the `messageId` of
+    # the assistant's pending reply. Poll `GET
+    # /v1/assistant-messages/{messageId}` until `status` is terminal, or
+    # subscribe to `assistant_message.*` webhooks.
+    # @param [String] assistant_id Required parameter: The assistant chat id
+    # (e.g. `vg_asst_...`). Every API project has one assistant chat; find it on
+    # `ProjectResponse.assistantId`.
+    # @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 [SendAssistantMessageRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def send_assistant_message(assistant_id,
+                               authorization,
+                               body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/assistants/{assistantId}/messages',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(assistant_id, key: 'assistantId')
+                                    .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(SendAssistantMessageResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Acts on an actionable widget the assistant offered on a prior turn.
+    # Reference the action by its `actionId` from a prior assistant message.
+    # `APPROVE` (the default) completes the action; `REJECT` records the
+    # rejection. Two kinds are actionable via the API: accepting a workflow
+    # suggestion (`APPROVE` applies the suggested workflow and immediately
+    # starts generating; the returned assistant message carries the workflow run
+    # in `generation`), and applying an assistant edit (an `APPLY_EDIT` action
+    # with `requiresApp` false, which applies the edit to the project). Actions
+    # with `requiresApp` set to true (plans, tools, and other app-only widgets)
+    # can only be completed in the web app: open the assistant's `projectUrl`
+    # instead. Asynchronous: the response contains the `messageId` of the
+    # resulting assistant message. Poll `GET /v1/assistant-messages/{messageId}`
+    # for its terminal state.
+    # @param [String] assistant_id Required parameter: The assistant chat id
+    # (e.g. `vg_asst_...`). Every API project has one assistant chat; find it on
+    # `ProjectResponse.assistantId`.
+    # @param [String] action_id Required parameter: The `actionId` of the action
+    # to act on, from a prior assistant message.
+    # @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 [ActOnAssistantActionRequest] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def act_on_assistant_action(assistant_id,
+                                action_id,
+                                authorization,
+                                body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/assistants/{assistantId}/actions/{actionId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(assistant_id, key: 'assistantId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(action_id, key: 'actionId')
+                                    .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(ActOnAssistantActionResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Returns a single assistant chat message by id. Poll after a POST that
+    # returned `messageId` until `status` is `succeeded`, `failed`, or
+    # `cancelled`. Also supported for `USER` messages (which reach terminal
+    # state as soon as they're accepted).
+    # @param [String] message_id Required parameter: The assistant message id
+    # (e.g. `vg_mesg_...`) returned by an assistant POST.
+    # @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_assistant_message(message_id,
+                              authorization)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v1/assistant-messages/{messageId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(message_id, key: 'messageId')
+                                    .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(proc do |response, should_symbolize|
+                      APIHelper.deserialize_union_type(
+                        UnionTypeLookUp.get(:AssistantMessage2),
+                        response, should_symbolize, true
+                      )
+                    end)
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/videogen/apis/base_api.rb

@@ -0,0 +1,67 @@
+# videogen
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Videogen
+  # BaseApi.
+  class BaseApi
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'Ruby-SDK/0.0.1 (OS: {os-info}, Engine: {engine}/{engine-version})'
+    end
+
+    def self.user_agent_parameters
+      {
+        '{engine}' => { 'value' => RUBY_ENGINE, 'encode' => false },
+        '{engine-version}' => { 'value' => RUBY_ENGINE_VERSION, 'encode' => false },
+        '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
+      }
+    end
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end