Class: Wave::Editor
- Inherits:
-
Object
- Object
- Wave::Editor
- Defined in:
- lib/wave/editor.rb
Overview
Editor — Cloud video editing projects
Instance Method Summary collapse
-
#create_project(body) ⇒ Object
Create an editor project (operationId: createProject, POST /editor/projects).
-
#delete_project(project_id) ⇒ Object
Delete a project (operationId: deleteProject, DELETE /editor/projects/projectId).
-
#export_project(project_id, body) ⇒ Object
Export a project (operationId: exportProject, POST /editor/projects/projectId/export).
-
#get_project(project_id) ⇒ Object
Get a project (operationId: getProject, GET /editor/projects/projectId).
-
#initialize(client) ⇒ Editor
constructor
A new instance of Editor.
-
#list_projects(page: nil, per_page: nil, status: nil) ⇒ Object
List editor projects (operationId: listProjects, GET /editor/projects).
-
#update_project(project_id, body) ⇒ Object
Update a project (operationId: updateProject, PATCH /editor/projects/projectId).
Constructor Details
#initialize(client) ⇒ Editor
Returns a new instance of Editor.
6 7 8 |
# File 'lib/wave/editor.rb', line 6 def initialize(client) @client = client end |
Instance Method Details
#create_project(body) ⇒ Object
Create an editor project (operationId: createProject, POST /editor/projects).
21 22 23 |
# File 'lib/wave/editor.rb', line 21 def create_project(body) @client.request("POST", "/editor/projects", body: body) end |
#delete_project(project_id) ⇒ Object
Delete a project (operationId: deleteProject, DELETE /editor/projects/projectId).
36 37 38 |
# File 'lib/wave/editor.rb', line 36 def delete_project(project_id) @client.request("DELETE", "/editor/projects/#{project_id}") end |
#export_project(project_id, body) ⇒ Object
Export a project (operationId: exportProject, POST /editor/projects/projectId/export).
41 42 43 |
# File 'lib/wave/editor.rb', line 41 def export_project(project_id, body) @client.request("POST", "/editor/projects/#{project_id}/export", body: body) end |
#get_project(project_id) ⇒ Object
Get a project (operationId: getProject, GET /editor/projects/projectId).
26 27 28 |
# File 'lib/wave/editor.rb', line 26 def get_project(project_id) @client.request("GET", "/editor/projects/#{project_id}") end |
#list_projects(page: nil, per_page: nil, status: nil) ⇒ Object
List editor projects (operationId: listProjects, GET /editor/projects).
11 12 13 14 15 16 17 18 |
# File 'lib/wave/editor.rb', line 11 def list_projects(page: nil, per_page: nil, status: nil) query = { "page" => page, "perPage" => per_page, "status" => status, } @client.request("GET", "/editor/projects", query: query) end |
#update_project(project_id, body) ⇒ Object
Update a project (operationId: updateProject, PATCH /editor/projects/projectId).
31 32 33 |
# File 'lib/wave/editor.rb', line 31 def update_project(project_id, body) @client.request("PATCH", "/editor/projects/#{project_id}", body: body) end |