ilovevideoeditor-sdk 1.0.0

data/lib/generated/ilovevideoeditor-sdk/api/projects_api.rb

@@ -0,0 +1,614 @@
+=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 'cgi'
+
+module ILoveVideoEditor
+  class ProjectsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Bulk delete projects
+    # @param batch_delete_projects_request [BatchDeleteProjectsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [BatchDeleteResult]
+    def batch_delete_projects(batch_delete_projects_request, opts = {})
+      data, _status_code, _headers = batch_delete_projects_with_http_info(batch_delete_projects_request, opts)
+      data
+    end
+
+    # Bulk delete projects
+    # @param batch_delete_projects_request [BatchDeleteProjectsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BatchDeleteResult, Integer, Hash)>] BatchDeleteResult data, response status code and response headers
+    def batch_delete_projects_with_http_info(batch_delete_projects_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProjectsApi.batch_delete_projects ...'
+      end
+      # verify the required parameter 'batch_delete_projects_request' is set
+      if @api_client.config.client_side_validation && batch_delete_projects_request.nil?
+        fail ArgumentError, "Missing the required parameter 'batch_delete_projects_request' when calling ProjectsApi.batch_delete_projects"
+      end
+      # resource path
+      local_var_path = '/v1/projects/batch-delete'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(batch_delete_projects_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'BatchDeleteResult'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProjectsApi.batch_delete_projects",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProjectsApi#batch_delete_projects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a project
+    # @param project_create [ProjectCreate] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateProject200Response]
+    def create_project(project_create, opts = {})
+      data, _status_code, _headers = create_project_with_http_info(project_create, opts)
+      data
+    end
+
+    # Create a project
+    # @param project_create [ProjectCreate] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateProject200Response, Integer, Hash)>] CreateProject200Response data, response status code and response headers
+    def create_project_with_http_info(project_create, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProjectsApi.create_project ...'
+      end
+      # verify the required parameter 'project_create' is set
+      if @api_client.config.client_side_validation && project_create.nil?
+        fail ArgumentError, "Missing the required parameter 'project_create' when calling ProjectsApi.create_project"
+      end
+      # resource path
+      local_var_path = '/v1/projects'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(project_create)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateProject200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProjectsApi.create_project",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProjectsApi#create_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a project
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [DeleteProject200Response]
+    def delete_project(id, opts = {})
+      data, _status_code, _headers = delete_project_with_http_info(id, opts)
+      data
+    end
+
+    # Delete a project
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DeleteProject200Response, Integer, Hash)>] DeleteProject200Response data, response status code and response headers
+    def delete_project_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProjectsApi.delete_project ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProjectsApi.delete_project"
+      end
+      # resource path
+      local_var_path = '/v1/projects/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'DeleteProject200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProjectsApi.delete_project",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProjectsApi#delete_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Duplicate a project
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateProject200Response]
+    def duplicate_project(id, opts = {})
+      data, _status_code, _headers = duplicate_project_with_http_info(id, opts)
+      data
+    end
+
+    # Duplicate a project
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateProject200Response, Integer, Hash)>] CreateProject200Response data, response status code and response headers
+    def duplicate_project_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProjectsApi.duplicate_project ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProjectsApi.duplicate_project"
+      end
+      # resource path
+      local_var_path = '/v1/projects/{id}/duplicate'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateProject200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProjectsApi.duplicate_project",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProjectsApi#duplicate_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a project
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetProject200Response]
+    def get_project(id, opts = {})
+      data, _status_code, _headers = get_project_with_http_info(id, opts)
+      data
+    end
+
+    # Get a project
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetProject200Response, Integer, Hash)>] GetProject200Response data, response status code and response headers
+    def get_project_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProjectsApi.get_project ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProjectsApi.get_project"
+      end
+      # resource path
+      local_var_path = '/v1/projects/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetProject200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProjectsApi.get_project",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProjectsApi#get_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get total project count
+    # @param [Hash] opts the optional parameters
+    # @return [GetProjectStats200Response]
+    def get_project_stats(opts = {})
+      data, _status_code, _headers = get_project_stats_with_http_info(opts)
+      data
+    end
+
+    # Get total project count
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetProjectStats200Response, Integer, Hash)>] GetProjectStats200Response data, response status code and response headers
+    def get_project_stats_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProjectsApi.get_project_stats ...'
+      end
+      # resource path
+      local_var_path = '/v1/projects/stats'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetProjectStats200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProjectsApi.get_project_stats",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProjectsApi#get_project_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List user projects
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :limit  (default to 25)
+    # @option opts [String] :sort_by  (default to 'updated_at')
+    # @option opts [String] :sort_order  (default to 'desc')
+    # @option opts [String] :search 
+    # @return [ListProjects200Response]
+    def list_projects(opts = {})
+      data, _status_code, _headers = list_projects_with_http_info(opts)
+      data
+    end
+
+    # List user projects
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :limit  (default to 25)
+    # @option opts [String] :sort_by  (default to 'updated_at')
+    # @option opts [String] :sort_order  (default to 'desc')
+    # @option opts [String] :search 
+    # @return [Array<(ListProjects200Response, Integer, Hash)>] ListProjects200Response data, response status code and response headers
+    def list_projects_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProjectsApi.list_projects ...'
+      end
+      allowable_values = ["created_at", "updated_at", "name", "duration"]
+      if @api_client.config.client_side_validation && opts[:'sort_by'] && !allowable_values.include?(opts[:'sort_by'])
+        fail ArgumentError, "invalid value for \"sort_by\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["asc", "desc"]
+      if @api_client.config.client_side_validation && opts[:'sort_order'] && !allowable_values.include?(opts[:'sort_order'])
+        fail ArgumentError, "invalid value for \"sort_order\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/v1/projects'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
+      query_params[:'sortOrder'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
+      query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListProjects200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProjectsApi.list_projects",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProjectsApi#list_projects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Partially update a project
+    # @param id [String] 
+    # @param project_update [ProjectUpdate] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateProject200Response]
+    def patch_project(id, project_update, opts = {})
+      data, _status_code, _headers = patch_project_with_http_info(id, project_update, opts)
+      data
+    end
+
+    # Partially update a project
+    # @param id [String] 
+    # @param project_update [ProjectUpdate] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateProject200Response, Integer, Hash)>] CreateProject200Response data, response status code and response headers
+    def patch_project_with_http_info(id, project_update, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProjectsApi.patch_project ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProjectsApi.patch_project"
+      end
+      # verify the required parameter 'project_update' is set
+      if @api_client.config.client_side_validation && project_update.nil?
+        fail ArgumentError, "Missing the required parameter 'project_update' when calling ProjectsApi.patch_project"
+      end
+      # resource path
+      local_var_path = '/v1/projects/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(project_update)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateProject200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProjectsApi.patch_project",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProjectsApi#patch_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a project
+    # @param id [String] 
+    # @param project_update [ProjectUpdate] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateProject200Response]
+    def update_project(id, project_update, opts = {})
+      data, _status_code, _headers = update_project_with_http_info(id, project_update, opts)
+      data
+    end
+
+    # Update a project
+    # @param id [String] 
+    # @param project_update [ProjectUpdate] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateProject200Response, Integer, Hash)>] CreateProject200Response data, response status code and response headers
+    def update_project_with_http_info(id, project_update, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProjectsApi.update_project ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling ProjectsApi.update_project"
+      end
+      # verify the required parameter 'project_update' is set
+      if @api_client.config.client_side_validation && project_update.nil?
+        fail ArgumentError, "Missing the required parameter 'project_update' when calling ProjectsApi.update_project"
+      end
+      # resource path
+      local_var_path = '/v1/projects/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(project_update)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateProject200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ProjectsApi.update_project",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ProjectsApi#update_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end