Class: Ittybit::FilesClient

Inherits:
Object
  • Object
show all
Defined in:
lib/ittybit/files/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Ittybit::FilesClient

Parameters:



19
20
21
 
# File 'lib/ittybit/files/client.rb', line 19

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Ittybit::RequestClient (readonly)

Returns:



15
16
17
 
# File 'lib/ittybit/files/client.rb', line 15

def request_client
  @request_client
end

Instance Method Details

#create(url:, media_id: nil, folder: nil, filename: nil, ref: nil, metadata: nil, request_options: nil) ⇒ Ittybit::Files::FilesCreateResponse

Creates a new file from a publicly accessible or signed URL.

Examples:

api = Ittybit::Client.new(
  base_url: "https://api.example.com",
  environment: Ittybit::Environment::DEFAULT,
  api_key: "YOUR_AUTH_TOKEN"
)
api.files.create(
  url: "https://ittyb.it/sample.mp4",
  folder: "ittybit/samples",
  filename: "video.mp4",
  metadata: { "customKey": "your custom value" }
)

Parameters:

  • url (String)
  • media_id (String) (defaults to: nil)
  • folder (String) (defaults to: nil)
  • filename (String) (defaults to: nil)
  • ref (String) (defaults to: nil)
  • metadata (Hash{String => Object}) (defaults to: nil)
  • request_options (Ittybit::RequestOptions) (defaults to: nil)

Returns:



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/ittybit/files/client.rb', line 82

def create(url:, media_id: nil, folder: nil, filename: nil, ref: nil, metadata: nil, request_options: nil)
  response = @request_client.conn.post do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
    req.headers = {
      **(req.headers || {}),
      **@request_client.get_headers,
      **(request_options&.additional_headers || {}),
      "Accept-Version": "2025-08-20"
    }.compact
    unless request_options.nil? || request_options&.additional_query_parameters.nil?
      req.params = { **(request_options&.additional_query_parameters || {}) }.compact
    end
    req.body = {
      **(request_options&.additional_body_parameters || {}),
      url: url,
      media_id: media_id,
      folder: folder,
      filename: filename,
      ref: ref,
      metadata: metadata
    }.compact
    req.url "#{@request_client.get_url(request_options: request_options)}/files"
  end
  Ittybit::Files::FilesCreateResponse.from_json(json_object: response.body)
end

#delete(id:, request_options: nil) ⇒ Ittybit::Files::FilesDeleteResponse

Permanently removes a file from the system. This action cannot be undone.

Examples:

api = Ittybit::Client.new(
  base_url: "https://api.example.com",
  environment: Ittybit::Environment::DEFAULT,
  api_key: "YOUR_AUTH_TOKEN"
)
api.files.delete(id: "file_abcdefgh1234")

Parameters:

Returns:



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/ittybit/files/client.rb', line 156

def delete(id:, request_options: nil)
  response = @request_client.conn.delete do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
    req.headers = {
      **(req.headers || {}),
      **@request_client.get_headers,
      **(request_options&.additional_headers || {}),
      "Accept-Version": "2025-08-20"
    }.compact
    unless request_options.nil? || request_options&.additional_query_parameters.nil?
      req.params = { **(request_options&.additional_query_parameters || {}) }.compact
    end
    unless request_options.nil? || request_options&.additional_body_parameters.nil?
      req.body = { **(request_options&.additional_body_parameters || {}) }.compact
    end
    req.url "#{@request_client.get_url(request_options: request_options)}/files/#{id}"
  end
  Ittybit::Files::FilesDeleteResponse.from_json(json_object: response.body)
end

#get(id:, request_options: nil) ⇒ Ittybit::Files::FilesGetResponse

Retrieve the file object for a file with the given ID.

Examples:

api = Ittybit::Client.new(
  base_url: "https://api.example.com",
  environment: Ittybit::Environment::DEFAULT,
  api_key: "YOUR_AUTH_TOKEN"
)
api.files.get(id: "file_abcdefgh1234")

Parameters:

Returns:



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/ittybit/files/client.rb', line 122

def get(id:, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
    req.headers = {
      **(req.headers || {}),
      **@request_client.get_headers,
      **(request_options&.additional_headers || {}),
      "Accept-Version": "2025-08-20"
    }.compact
    unless request_options.nil? || request_options&.additional_query_parameters.nil?
      req.params = { **(request_options&.additional_query_parameters || {}) }.compact
    end
    unless request_options.nil? || request_options&.additional_body_parameters.nil?
      req.body = { **(request_options&.additional_body_parameters || {}) }.compact
    end
    req.url "#{@request_client.get_url(request_options: request_options)}/files/#{id}"
  end
  Ittybit::Files::FilesGetResponse.from_json(json_object: response.body)
end

#list(page: nil, limit: nil, request_options: nil) ⇒ Array<Ittybit::Files::FilesListResponseItem>

Retrieves a paginated list of all files associated with the current project.

Examples:

api = Ittybit::Client.new(
  base_url: "https://api.example.com",
  environment: Ittybit::Environment::DEFAULT,
  api_key: "YOUR_AUTH_TOKEN"
)
api.files.list

Parameters:

  • page (Integer) (defaults to: nil)
  • limit (Integer) (defaults to: nil)
  • request_options (Ittybit::RequestOptions) (defaults to: nil)

Returns:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/ittybit/files/client.rb', line 36

def list(page: nil, limit: nil, request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
    req.headers = {
      **(req.headers || {}),
      **@request_client.get_headers,
      **(request_options&.additional_headers || {}),
      "Accept-Version": "2025-08-20"
    }.compact
    req.params = { **(request_options&.additional_query_parameters || {}), "page": page, "limit": limit }.compact
    unless request_options.nil? || request_options&.additional_body_parameters.nil?
      req.body = { **(request_options&.additional_body_parameters || {}) }.compact
    end
    req.url "#{@request_client.get_url(request_options: request_options)}/files"
  end
  parsed_json = JSON.parse(response.body)
  parsed_json&.map do |item|
    item = item.to_json
    Ittybit::Files::FilesListResponseItem.from_json(json_object: item)
  end
end

#update(id:, folder: nil, filename: nil, ref: nil, metadata: nil, request_options: nil) ⇒ Ittybit::Files::FilesUpdateResponse

Update a file’s ‘filename`, `folder`, `ref`, or `metadata`. Only the specified

fields will be updated.

Examples:

api = Ittybit::Client.new(
  base_url: "https://api.example.com",
  environment: Ittybit::Environment::DEFAULT,
  api_key: "YOUR_AUTH_TOKEN"
)
api.files.update(
  id: "file_abcdefgh1234",
  folder: "updated/folder",
  filename: "new_filename.mp4",
  metadata: { "customKey": "a different custom value" }
)

Parameters:

  • id (String)
  • folder (String) (defaults to: nil)
  • filename (String) (defaults to: nil)
  • ref (String) (defaults to: nil)
  • metadata (Hash{String => Object}) (defaults to: nil)
  • request_options (Ittybit::RequestOptions) (defaults to: nil)

Returns:



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/ittybit/files/client.rb', line 200

def update(id:, folder: nil, filename: nil, ref: nil, metadata: nil, request_options: nil)
  response = @request_client.conn.patch do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
    req.headers["ACCEPT_VERSION"] = request_options.version unless request_options&.version.nil?
    req.headers = {
      **(req.headers || {}),
      **@request_client.get_headers,
      **(request_options&.additional_headers || {}),
      "Accept-Version": "2025-08-20"
    }.compact
    unless request_options.nil? || request_options&.additional_query_parameters.nil?
      req.params = { **(request_options&.additional_query_parameters || {}) }.compact
    end
    req.body = {
      **(request_options&.additional_body_parameters || {}),
      folder: folder,
      filename: filename,
      ref: ref,
      metadata: metadata
    }.compact
    req.url "#{@request_client.get_url(request_options: request_options)}/files/#{id}"
  end
  Ittybit::Files::FilesUpdateResponse.from_json(json_object: response.body)
end