Class: Autorender::Resources::Folders

Inherits:
Object
  • Object
show all
Defined in:
lib/autorender/resources/folders.rb

Overview

Folder management endpoints (API key required)

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Folders

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Folders.

Parameters:



104
105
106
 
# File 'lib/autorender/resources/folders.rb', line 104

def initialize(client:)
  @client = client
end

Instance Method Details

#create(name:, parent_folder_no: nil, request_options: {}) ⇒ Autorender::Models::FolderCreateResponse

Create folder

Parameters:

  • name (String) —

    Folder name without slashes

  • parent_folder_no (String) —

    Parent folder number

  • request_options (Autorender::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



20
21
22
23
24
25
26
27
28
29
 
# File 'lib/autorender/resources/folders.rb', line 20

def create(params)
  parsed, options = Autorender::FolderCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "api/v1/folders",
    body: parsed,
    model: Autorender::Models::FolderCreateResponse,
    options: options
  )
end

#delete(folder_no, request_options: {}) ⇒ nil

Delete folder

Parameters:

Returns:

  • (nil)

See Also:



68
69
70
71
72
73
74
75
 
# File 'lib/autorender/resources/folders.rb', line 68

def delete(folder_no, params = {})
  @client.request(
    method: :delete,
    path: ["api/v1/folders/%1$s", folder_no],
    model: NilClass,
    options: params[:request_options]
  )
end

#list(parent_folder_no: nil, search: nil, sort: nil, request_options: {}) ⇒ Autorender::Models::FolderListResponse

List folders

Parameters:

Returns:

See Also:



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/autorender/resources/folders.rb', line 46

def list(params = {})
  parsed, options = Autorender::FolderListParams.dump_request(params)
  query = Autorender::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "api/v1/folders",
    query: query,
    model: Autorender::Models::FolderListResponse,
    options: options
  )
end

#rename(folder_no, name:, request_options: {}) ⇒ Autorender::Models::FolderRenameResponse

Rename folder

Parameters:

  • folder_no (String)
  • name (String) —

    New folder name without slashes

  • request_options (Autorender::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



90
91
92
93
94
95
96
97
98
99
 
# File 'lib/autorender/resources/folders.rb', line 90

def rename(folder_no, params)
  parsed, options = Autorender::FolderRenameParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["api/v1/folders/rename/%1$s", folder_no],
    body: parsed,
    model: Autorender::Models::FolderRenameResponse,
    options: options
  )
end