Class: VeniceClient::VideoApi

Inherits:
Object
  • Object
show all
Defined in:
lib/venice_client/api/video_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VideoApi

Returns a new instance of VideoApi.



19
20
21
 
# File 'lib/venice_client/api/video_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/venice_client/api/video_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#complete_video(opts = {}) ⇒ CompleteVideo200Response

/api/v1/video/complete Delete a video generation request from storage after it has been successfully downloaded. Videos can be automatically deleted after retrieval by setting the ‘delete_media_on_completion` flag to true when calling the retrieve API.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



27
28
29
30
 
# File 'lib/venice_client/api/video_api.rb', line 27

def complete_video(opts = {})
  data, _status_code, _headers = complete_video_with_http_info(opts)
  data
end

#complete_video_with_http_info(opts = {}) ⇒ Array<(CompleteVideo200Response, Integer, Hash)>

/api/v1/video/complete Delete a video generation request from storage after it has been successfully downloaded. Videos can be automatically deleted after retrieval by setting the &#x60;delete_media_on_completion&#x60; flag to true when calling the retrieve API.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(CompleteVideo200Response, Integer, Hash)>) —

    CompleteVideo200Response data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/venice_client/api/video_api.rb', line 37

def complete_video_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VideoApi.complete_video ...'
  end
  # resource path
  local_var_path = '/video/complete'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'complete_video_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'CompleteVideo200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

  new_options = opts.merge(
    :operation => :"VideoApi.complete_video",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VideoApi#complete_video\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#queue_video(opts = {}) ⇒ QueueVideo200Response

/api/v1/video/queue Queue a new video generation request.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



91
92
93
94
 
# File 'lib/venice_client/api/video_api.rb', line 91

def queue_video(opts = {})
  data, _status_code, _headers = queue_video_with_http_info(opts)
  data
end

#queue_video_with_http_info(opts = {}) ⇒ Array<(QueueVideo200Response, Integer, Hash)>

/api/v1/video/queue Queue a new video generation request.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(QueueVideo200Response, Integer, Hash)>) —

    QueueVideo200Response data, response status code and response headers



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/venice_client/api/video_api.rb', line 101

def queue_video_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VideoApi.queue_video ...'
  end
  # resource path
  local_var_path = '/video/queue'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'queue_video_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'QueueVideo200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

  new_options = opts.merge(
    :operation => :"VideoApi.queue_video",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VideoApi#queue_video\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#quote_video(opts = {}) ⇒ QuoteVideo200Response

/api/v1/video/quote Quote a video generation request. Utilizes the same parameters as the queue API and will return the price in USD for the request.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



155
156
157
158
 
# File 'lib/venice_client/api/video_api.rb', line 155

def quote_video(opts = {})
  data, _status_code, _headers = quote_video_with_http_info(opts)
  data
end

#quote_video_with_http_info(opts = {}) ⇒ Array<(QuoteVideo200Response, Integer, Hash)>

/api/v1/video/quote Quote a video generation request. Utilizes the same parameters as the queue API and will return the price in USD for the request.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(QuoteVideo200Response, Integer, Hash)>) —

    QuoteVideo200Response data, response status code and response headers



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/venice_client/api/video_api.rb', line 165

def quote_video_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VideoApi.quote_video ...'
  end
  # resource path
  local_var_path = '/video/quote'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'queue_video_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'QuoteVideo200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

  new_options = opts.merge(
    :operation => :"VideoApi.quote_video",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VideoApi#quote_video\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retrieve_video(opts = {}) ⇒ RetrieveVideo200Response

/api/v1/video/retrieve Retrieve a video generation result. Returns the video file if completed, or a status if the request is still processing.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



219
220
221
222
 
# File 'lib/venice_client/api/video_api.rb', line 219

def retrieve_video(opts = {})
  data, _status_code, _headers = retrieve_video_with_http_info(opts)
  data
end

#retrieve_video_with_http_info(opts = {}) ⇒ Array<(RetrieveVideo200Response, Integer, Hash)>

/api/v1/video/retrieve Retrieve a video generation result. Returns the video file if completed, or a status if the request is still processing.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(RetrieveVideo200Response, Integer, Hash)>) —

    RetrieveVideo200Response data, response status code and response headers



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/venice_client/api/video_api.rb', line 229

def retrieve_video_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VideoApi.retrieve_video ...'
  end
  # resource path
  local_var_path = '/video/retrieve'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'video/mp4']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'retrieve_video_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'RetrieveVideo200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth']

  new_options = opts.merge(
    :operation => :"VideoApi.retrieve_video",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VideoApi#retrieve_video\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end