Class: Ittybit::MediaClient

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Ittybit::MediaClient

Parameters:



19
20
21
 
# File 'lib/ittybit/media/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/media/client.rb', line 15

def request_client
  @request_client
end

Instance Method Details

#create(title: nil, alt: nil, metadata: nil, request_options: nil) ⇒ Ittybit::Media::MediaCreateResponse

Creates a new media item. See [Media Object](/docs/media) for more details.

Examples:

api = Ittybit::Client.new(
  base_url: "https://api.example.com",
  environment: Ittybit::Environment::DEFAULT,
  api_key: "YOUR_AUTH_TOKEN"
)
api.media.create(
  title: "My Video Example",
  alt: "An example video used to demonstrate the ittybit API",
  metadata: { "customKey": "your custom value" }
)

Parameters:

  • title (String) (defaults to: nil)
  • alt (String) (defaults to: nil)
  • metadata (Hash{String => Object}) (defaults to: nil)
  • request_options (Ittybit::RequestOptions) (defaults to: nil)

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/ittybit/media/client.rb', line 78

def create(title: nil, alt: 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 || {}),
      title: title,
      alt: alt,
      metadata: metadata
    }.compact
    req.url "#{@request_client.get_url(request_options: request_options)}/media"
  end
  Ittybit::Media::MediaCreateResponse.from_json(json_object: response.body)
end

#delete(id:, request_options: nil) ⇒ Ittybit::Media::MediaDeleteResponse

Permanently removes a media object 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.media.delete(id: "med_abcdefgh1234")

Parameters:

Returns:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/ittybit/media/client.rb', line 150

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)}/media/#{id}"
  end
  Ittybit::Media::MediaDeleteResponse.from_json(json_object: response.body)
end

#get(id:, request_options: nil) ⇒ Ittybit::Media::MediaGetResponse

Retrieves the media object for a media 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.media.get(id: "med_abcdefgh1234")

Parameters:

Returns:



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/ittybit/media/client.rb', line 115

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)}/media/#{id}"
  end
  Ittybit::Media::MediaGetResponse.from_json(json_object: response.body)
end

#list(page: nil, limit: nil, request_options: nil) ⇒ Ittybit::MEDIA_LIST_RESPONSE

Retrieves a paginated list of all media for the current project.

Examples:

api = Ittybit::Client.new(
  base_url: "https://api.example.com",
  environment: Ittybit::Environment::DEFAULT,
  api_key: "YOUR_AUTH_TOKEN"
)
api.media.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/media/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)}/media"
  end
  parsed_json = JSON.parse(response.body)
  parsed_json&.map do |item|
    item = item.to_json
    Ittybit::MediaListResponseItem.from_json(json_object: item)
  end
end

#update(id:, title: nil, alt: nil, metadata: nil, request_options: nil) ⇒ Ittybit::Media::MediaUpdateResponse

Updates a media object’s ‘title`, `alt`, 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.media.update(
  id: "med_abcdefgh1234",
  title: "Updated Video Example",
  alt: "An updated example video used to demonstrate the ittybit API",
  metadata: { "customKey": "a different custom value" }
)

Parameters:

  • id (String)
  • title (String) (defaults to: nil)
  • alt (String) (defaults to: nil)
  • metadata (Hash{String => Object}) (defaults to: nil)
  • request_options (Ittybit::RequestOptions) (defaults to: nil)

Returns:



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/ittybit/media/client.rb', line 193

def update(id:, title: nil, alt: 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 || {}),
      title: title,
      alt: alt,
      metadata: metadata
    }.compact
    req.url "#{@request_client.get_url(request_options: request_options)}/media/#{id}"
  end
  Ittybit::Media::MediaUpdateResponse.from_json(json_object: response.body)
end