Class: Autorender::Resources::Files

Inherits:
Object
  • Object
show all
Defined in:
lib/autorender/resources/files.rb,
sig/autorender/resources/files.rbs

Overview

File management endpoints (API key required)

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Files

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 Files.

Parameters:



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

def initialize(client:)
  @client = client
end

Instance Method Details

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

Delete file

Parameters:

Returns:

  • (nil)

See Also:



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

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

#list(folder_no: nil, limit: nil, page: nil, search: nil, sort: nil, request_options: {}) ⇒ Autorender::Internal::PagePagination<Autorender::Models::FileListResponse>

List/search files with pagination, filtering, and sorting.

Parameters:

Returns:

See Also:



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

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

#rename(file_no, name:, request_options: {}) ⇒ Autorender::Models::FileRenameResponse

Rename file

Parameters:

  • file_no (String)
  • name (String) —

    New file name without extension or path separators

  • 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/files.rb', line 90

def rename(file_no, params)
  parsed, options = Autorender::FileRenameParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["api/v1/files/%1$s/rename", file_no],
    body: parsed,
    model: Autorender::Models::FileRenameResponse,
    options: options
  )
end

#retrieve(file_no, request_options: {}) ⇒ Autorender::Models::FileRetrieveResponse

Get file details

Parameters:

Returns:

See Also:



17
18
19
20
21
22
23
24
 
# File 'lib/autorender/resources/files.rb', line 17

def retrieve(file_no, params = {})
  @client.request(
    method: :get,
    path: ["api/v1/files/%1$s", file_no],
    model: Autorender::Models::FileRetrieveResponse,
    options: params[:request_options]
  )
end