ilovevideoeditor-sdk 1.0.0

data/lib/generated/ilovevideoeditor-sdk/models/workspace_integration_input.rb

@@ -0,0 +1,260 @@
+=begin
+#iLoveVideoEditor API
+
+#Cloud video rendering API for iLoveVideoEditor. Submit a `VideoJSON` payload, queue a render job, and download the resulting MP4.  **Authentication** - **API Key** (`x-api-key` header) — accepted by render pipeline and tool endpoints. - **Bearer Token** (`Authorization: Bearer <jwt>`) — required for user-scoped project, asset, billing, and webhook endpoints. - Many endpoints accept either form of authentication.  **SDKs** Official typed SDKs are available for JavaScript/TypeScript, PHP, Python, Ruby, and Go. See https://ilovevideoeditor.com/docs/sdks  **Outbound Webhooks** Render lifecycle events (`render.completed`, `render.failed`) are delivered to your endpoints as signed HTTP POST requests. See the `Webhooks` tag and the root-level `x-webhook-docs` extension for the payload format (`RenderWebhookPayload`), signature headers, HMAC verification, and the retry policy.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ILoveVideoEditor
+  class WorkspaceIntegrationInput < ApiModelBase
+    attr_accessor :provider
+
+    attr_accessor :name
+
+    attr_accessor :is_active
+
+    attr_accessor :is_default
+
+    attr_accessor :config
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'provider' => :'provider',
+        :'name' => :'name',
+        :'is_active' => :'isActive',
+        :'is_default' => :'isDefault',
+        :'config' => :'config'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'provider' => :'String',
+        :'name' => :'String',
+        :'is_active' => :'Boolean',
+        :'is_default' => :'Boolean',
+        :'config' => :'Hash<String, Object>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `ILoveVideoEditor::WorkspaceIntegrationInput` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ILoveVideoEditor::WorkspaceIntegrationInput`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'provider')
+        self.provider = attributes[:'provider']
+      else
+        self.provider = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'is_active')
+        self.is_active = attributes[:'is_active']
+      end
+
+      if attributes.key?(:'is_default')
+        self.is_default = attributes[:'is_default']
+      end
+
+      if attributes.key?(:'config')
+        if (value = attributes[:'config']).is_a?(Hash)
+          self.config = value
+        end
+      else
+        self.config = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @provider.nil?
+        invalid_properties.push('invalid value for "provider", provider cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @config.nil?
+        invalid_properties.push('invalid value for "config", config cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @provider.nil?
+      provider_validator = EnumAttributeValidator.new('String', ["s3", "r2", "b2", "wasabi", "gcs", "azure", "drive"])
+      return false unless provider_validator.valid?(@provider)
+      return false if @name.nil?
+      return false if @config.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] provider Object to be assigned
+    def provider=(provider)
+      validator = EnumAttributeValidator.new('String', ["s3", "r2", "b2", "wasabi", "gcs", "azure", "drive"])
+      unless validator.valid?(provider)
+        fail ArgumentError, "invalid value for \"provider\", must be one of #{validator.allowable_values}."
+      end
+      @provider = provider
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] config Value to be assigned
+    def config=(config)
+      if config.nil?
+        fail ArgumentError, 'config cannot be nil'
+      end
+
+      @config = config
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          provider == o.provider &&
+          name == o.name &&
+          is_active == o.is_active &&
+          is_default == o.is_default &&
+          config == o.config
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [provider, name, is_active, is_default, config].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/generated/ilovevideoeditor-sdk/version.rb

@@ -0,0 +1,15 @@
+=begin
+#iLoveVideoEditor API
+
+#Cloud video rendering API for iLoveVideoEditor. Submit a `VideoJSON` payload, queue a render job, and download the resulting MP4.  **Authentication** - **API Key** (`x-api-key` header) — accepted by render pipeline and tool endpoints. - **Bearer Token** (`Authorization: Bearer <jwt>`) — required for user-scoped project, asset, billing, and webhook endpoints. - Many endpoints accept either form of authentication.  **SDKs** Official typed SDKs are available for JavaScript/TypeScript, PHP, Python, Ruby, and Go. See https://ilovevideoeditor.com/docs/sdks  **Outbound Webhooks** Render lifecycle events (`render.completed`, `render.failed`) are delivered to your endpoints as signed HTTP POST requests. See the `Webhooks` tag and the root-level `x-webhook-docs` extension for the payload format (`RenderWebhookPayload`), signature headers, HMAC verification, and the retry policy.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+module ILoveVideoEditor
+  VERSION = '1.0.0'
+end

data/lib/generated/ilovevideoeditor-sdk.rb

@@ -0,0 +1,150 @@
+=begin
+#iLoveVideoEditor API
+
+#Cloud video rendering API for iLoveVideoEditor. Submit a `VideoJSON` payload, queue a render job, and download the resulting MP4.  **Authentication** - **API Key** (`x-api-key` header) — accepted by render pipeline and tool endpoints. - **Bearer Token** (`Authorization: Bearer <jwt>`) — required for user-scoped project, asset, billing, and webhook endpoints. - Many endpoints accept either form of authentication.  **SDKs** Official typed SDKs are available for JavaScript/TypeScript, PHP, Python, Ruby, and Go. See https://ilovevideoeditor.com/docs/sdks  **Outbound Webhooks** Render lifecycle events (`render.completed`, `render.failed`) are delivered to your endpoints as signed HTTP POST requests. See the `Webhooks` tag and the root-level `x-webhook-docs` extension for the payload format (`RenderWebhookPayload`), signature headers, HMAC verification, and the retry policy.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+# Common files
+require 'ilovevideoeditor-sdk/api_client'
+require 'ilovevideoeditor-sdk/api_error'
+require 'ilovevideoeditor-sdk/api_model_base'
+require 'ilovevideoeditor-sdk/version'
+require 'ilovevideoeditor-sdk/configuration'
+
+# Models
+require 'ilovevideoeditor-sdk/models/api_key'
+require 'ilovevideoeditor-sdk/models/api_key_with_secret'
+require 'ilovevideoeditor-sdk/models/asset'
+require 'ilovevideoeditor-sdk/models/asset_create'
+require 'ilovevideoeditor-sdk/models/asset_upload_url_response'
+require 'ilovevideoeditor-sdk/models/batch_delete_projects_request'
+require 'ilovevideoeditor-sdk/models/batch_delete_result'
+require 'ilovevideoeditor-sdk/models/billing_prices'
+require 'ilovevideoeditor-sdk/models/billing_prices_tiers'
+require 'ilovevideoeditor-sdk/models/billing_subscription'
+require 'ilovevideoeditor-sdk/models/cancel_render200_response'
+require 'ilovevideoeditor-sdk/models/create_api_key_request'
+require 'ilovevideoeditor-sdk/models/create_asset201_response'
+require 'ilovevideoeditor-sdk/models/create_checkout_session200_response'
+require 'ilovevideoeditor-sdk/models/create_checkout_session_request'
+require 'ilovevideoeditor-sdk/models/create_integration201_response'
+require 'ilovevideoeditor-sdk/models/create_project200_response'
+require 'ilovevideoeditor-sdk/models/create_workflow201_response'
+require 'ilovevideoeditor-sdk/models/create_workflow_request'
+require 'ilovevideoeditor-sdk/models/credit_balance'
+require 'ilovevideoeditor-sdk/models/credit_balance_summary'
+require 'ilovevideoeditor-sdk/models/credit_balance_usage'
+require 'ilovevideoeditor-sdk/models/delete_project200_response'
+require 'ilovevideoeditor-sdk/models/destination'
+require 'ilovevideoeditor-sdk/models/destination_input'
+require 'ilovevideoeditor-sdk/models/error'
+require 'ilovevideoeditor-sdk/models/estimate_render_cost_request'
+require 'ilovevideoeditor-sdk/models/get_asset_signed_url200_response'
+require 'ilovevideoeditor-sdk/models/get_asset_upload_url_request'
+require 'ilovevideoeditor-sdk/models/get_destination200_response'
+require 'ilovevideoeditor-sdk/models/get_project200_response'
+require 'ilovevideoeditor-sdk/models/get_project_stats200_response'
+require 'ilovevideoeditor-sdk/models/get_render_download_url200_response'
+require 'ilovevideoeditor-sdk/models/get_rendition200_response'
+require 'ilovevideoeditor-sdk/models/get_subscription200_response'
+require 'ilovevideoeditor-sdk/models/get_template200_response'
+require 'ilovevideoeditor-sdk/models/get_usage200_response'
+require 'ilovevideoeditor-sdk/models/get_workflow200_response'
+require 'ilovevideoeditor-sdk/models/get_workflow_run200_response'
+require 'ilovevideoeditor-sdk/models/health_check200_response'
+require 'ilovevideoeditor-sdk/models/health_check_detailed200_response'
+require 'ilovevideoeditor-sdk/models/health_check_detailed200_response_services'
+require 'ilovevideoeditor-sdk/models/list_api_keys200_response'
+require 'ilovevideoeditor-sdk/models/list_assets200_response'
+require 'ilovevideoeditor-sdk/models/list_integrations200_response'
+require 'ilovevideoeditor-sdk/models/list_invoices200_response'
+require 'ilovevideoeditor-sdk/models/list_projects200_response'
+require 'ilovevideoeditor-sdk/models/list_renditions200_response'
+require 'ilovevideoeditor-sdk/models/list_templates200_response'
+require 'ilovevideoeditor-sdk/models/list_webhook_subscriptions200_response'
+require 'ilovevideoeditor-sdk/models/list_workflow_runs200_response'
+require 'ilovevideoeditor-sdk/models/list_workflow_step_types200_response'
+require 'ilovevideoeditor-sdk/models/list_workflows200_response'
+require 'ilovevideoeditor-sdk/models/project'
+require 'ilovevideoeditor-sdk/models/project_create'
+require 'ilovevideoeditor-sdk/models/project_update'
+require 'ilovevideoeditor-sdk/models/queue_render200_response'
+require 'ilovevideoeditor-sdk/models/queue_render_request'
+require 'ilovevideoeditor-sdk/models/refresh_render_url200_response'
+require 'ilovevideoeditor-sdk/models/render_cost_estimate'
+require 'ilovevideoeditor-sdk/models/render_cost_estimate_resolution'
+require 'ilovevideoeditor-sdk/models/render_cost_estimate_tier'
+require 'ilovevideoeditor-sdk/models/render_job'
+require 'ilovevideoeditor-sdk/models/render_job_progress'
+require 'ilovevideoeditor-sdk/models/render_list_item'
+require 'ilovevideoeditor-sdk/models/render_template_request'
+require 'ilovevideoeditor-sdk/models/render_webhook_payload'
+require 'ilovevideoeditor-sdk/models/rendition'
+require 'ilovevideoeditor-sdk/models/rendition_cancel_result'
+require 'ilovevideoeditor-sdk/models/rendition_output'
+require 'ilovevideoeditor-sdk/models/rendition_stats'
+require 'ilovevideoeditor-sdk/models/run_workflow202_response'
+require 'ilovevideoeditor-sdk/models/run_workflow_request'
+require 'ilovevideoeditor-sdk/models/service_health'
+require 'ilovevideoeditor-sdk/models/template'
+require 'ilovevideoeditor-sdk/models/template_summary'
+require 'ilovevideoeditor-sdk/models/test_integration200_response'
+require 'ilovevideoeditor-sdk/models/tier_info'
+require 'ilovevideoeditor-sdk/models/tier_info_credits'
+require 'ilovevideoeditor-sdk/models/tool_job_request'
+require 'ilovevideoeditor-sdk/models/tool_job_request_dimensions'
+require 'ilovevideoeditor-sdk/models/tool_job_status'
+require 'ilovevideoeditor-sdk/models/track_render_bandwidth200_response'
+require 'ilovevideoeditor-sdk/models/update_workflow_request'
+require 'ilovevideoeditor-sdk/models/upload_asset200_response'
+require 'ilovevideoeditor-sdk/models/usage_log'
+require 'ilovevideoeditor-sdk/models/video_json'
+require 'ilovevideoeditor-sdk/models/video_json_destination'
+require 'ilovevideoeditor-sdk/models/webhook_subscription'
+require 'ilovevideoeditor-sdk/models/webhook_subscription_create'
+require 'ilovevideoeditor-sdk/models/workflow'
+require 'ilovevideoeditor-sdk/models/workflow_definition'
+require 'ilovevideoeditor-sdk/models/workflow_run'
+require 'ilovevideoeditor-sdk/models/workflow_run_step'
+require 'ilovevideoeditor-sdk/models/workflow_step'
+require 'ilovevideoeditor-sdk/models/workflow_variable'
+require 'ilovevideoeditor-sdk/models/workspace_integration'
+require 'ilovevideoeditor-sdk/models/workspace_integration_input'
+
+# APIs
+require 'ilovevideoeditor-sdk/api/api_keys_api'
+require 'ilovevideoeditor-sdk/api/assets_api'
+require 'ilovevideoeditor-sdk/api/billing_api'
+require 'ilovevideoeditor-sdk/api/health_api'
+require 'ilovevideoeditor-sdk/api/integrations_api'
+require 'ilovevideoeditor-sdk/api/projects_api'
+require 'ilovevideoeditor-sdk/api/render_api'
+require 'ilovevideoeditor-sdk/api/renditions_api'
+require 'ilovevideoeditor-sdk/api/templates_api'
+require 'ilovevideoeditor-sdk/api/tools_api'
+require 'ilovevideoeditor-sdk/api/webhooks_api'
+require 'ilovevideoeditor-sdk/api/workflows_api'
+
+module ILoveVideoEditor
+  class << self
+    # Customize default settings for the SDK using block.
+    #   ILoveVideoEditor.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/ilovevideoeditor/client.rb

@@ -0,0 +1,106 @@
+require 'ilovevideoeditor-sdk'
+
+module ILoveVideoEditor
+  # High-level iLoveVideoEditor client with polling and friendly method names.
+  #
+  # Usage:
+  #   client = ILoveVideoEditor::Client.new(api_key: 'vf_live_xxx')
+  #   result = client.render({ name: 'Hello', layers: [...] })
+  #   puts result.download_url
+  class Client
+    RenderResult = Struct.new(
+      :job_id, :status, :progress, :url, :download_url,
+      :error, :created_at, :completed_at,
+      keyword_init: true
+    )
+
+    def initialize(api_key:, base_url: 'https://api.ilovevideoeditor.com')
+      raise ArgumentError, 'api_key is required' if api_key.nil? || api_key.empty?
+
+      ILoveVideoEditor.configure do |config|
+        config.host = base_url
+        config.api_key['x-api-key'] = api_key
+      end
+
+      @render_api = ILoveVideoEditor::RenderApi.new
+      @templates_api = ILoveVideoEditor::TemplatesApi.new
+    end
+
+    # Normalize the API progress payload ({done, total, percent}) to a percent number.
+    def self.progress_percent(progress)
+      return 0.0 if progress.nil?
+      return progress.to_f if progress.is_a?(Numeric)
+
+      progress.respond_to?(:percent) && progress.percent ? progress.percent.to_f : 0.0
+    end
+
+    # Submit a VideoJSON payload and block until the render finishes.
+    def render(video_json, poll_interval: 2, max_wait: 300, on_progress: nil)
+      body = ILoveVideoEditor::QueueRenderRequest.new(video_json: video_json)
+      queued = @render_api.queue_render(body)
+      job_id = queued.job_id
+
+      deadline = Time.now + max_wait
+      while Time.now < deadline
+        status = @render_api.get_render_status(job_id)
+        progress = self.class.progress_percent(status.progress)
+        on_progress&.call(status.status, progress)
+
+        if status.status == 'completed'
+          refresh = @render_api.refresh_render_url(job_id)
+          return RenderResult.new(
+            job_id: job_id,
+            status: status.status,
+            progress: progress,
+            url: status.url,
+            download_url: refresh.download_url,
+            error: status.error,
+            created_at: status.created_at,
+            completed_at: status.completed_at
+          )
+        end
+
+        if status.status == 'failed'
+          return RenderResult.new(
+            job_id: job_id,
+            status: status.status,
+            progress: progress,
+            error: status.error,
+            created_at: status.created_at,
+            completed_at: status.completed_at
+          )
+        end
+
+        sleep(poll_interval)
+      end
+
+      raise Timeout::Error, "Render #{job_id} did not complete within #{max_wait}s"
+    end
+
+    def get_render(job_id)
+      status = @render_api.get_render_status(job_id)
+      RenderResult.new(
+        job_id: status.job_id,
+        status: status.status,
+        progress: self.class.progress_percent(status.progress),
+        url: status.url,
+        error: status.error,
+        created_at: status.created_at,
+        completed_at: status.completed_at
+      )
+    end
+
+    def refresh_url(job_id)
+      result = @render_api.refresh_render_url(job_id)
+      result.download_url
+    end
+
+    def list_templates
+      @templates_api.list_templates.templates
+    end
+
+    def get_template(id)
+      @templates_api.get_template(id).template
+    end
+  end
+end

data/lib/ilovevideoeditor-sdk.rb

@@ -0,0 +1,2 @@
+require_relative 'generated/ilovevideoeditor-sdk'
+require_relative 'ilovevideoeditor/client'