Class: MuxRuby::URLSigningKeysApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mux_ruby/api/url_signing_keys_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ URLSigningKeysApi

Returns a new instance of URLSigningKeysApi.



12
13
14
 
# File 'lib/mux_ruby/api/url_signing_keys_api.rb', line 12

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



10
11
12
 
# File 'lib/mux_ruby/api/url_signing_keys_api.rb', line 10

def api_client
  @api_client
end

Instance Method Details

#create_url_signing_key(opts = {}) ⇒ SigningKeyResponse

Create a URL signing key Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens.

Parameters:

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

    the optional parameters

Returns:



19
20
21
22
 
# File 'lib/mux_ruby/api/url_signing_keys_api.rb', line 19

def create_url_signing_key(opts = {})
  data, _status_code, _headers = create_url_signing_key_with_http_info(opts)
  data
end

#create_url_signing_key_with_http_info(opts = {}) ⇒ Array<(SigningKeyResponse, Fixnum, Hash)>

Create a URL signing key Creates a new signing key pair. When creating a new signing key, the API will generate a 2048-bit RSA key-pair and return the private key and a generated key-id; the public key will be stored at Mux to validate signed tokens.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(SigningKeyResponse, Fixnum, Hash)>) —

    SigningKeyResponse data, response status code and response headers



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/mux_ruby/api/url_signing_keys_api.rb', line 28

def create_url_signing_key_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: URLSigningKeysApi.create_url_signing_key ...'
  end
  # resource path
  local_var_path = '/video/v1/signing-keys'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['accessToken']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SigningKeyResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: URLSigningKeysApi#create_url_signing_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_url_signing_key(signing_key_id, opts = {}) ⇒ nil

Delete a URL signing key Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again.

Parameters:

  • signing_key_id —

    The ID of the signing key.

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

    the optional parameters

Returns:

  • (nil) 


67
68
69
70
 
# File 'lib/mux_ruby/api/url_signing_keys_api.rb', line 67

def delete_url_signing_key(signing_key_id, opts = {})
  delete_url_signing_key_with_http_info(signing_key_id, opts)
  nil
end

#delete_url_signing_key_with_http_info(signing_key_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a URL signing key Deletes an existing signing key. Use with caution, as this will invalidate any existing signatures and no URLs can be signed using the key again.

Parameters:

  • signing_key_id —

    The ID of the signing key.

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

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



77
78
79
80
81
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
109
110
 
# File 'lib/mux_ruby/api/url_signing_keys_api.rb', line 77

def delete_url_signing_key_with_http_info(signing_key_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: URLSigningKeysApi.delete_url_signing_key ...'
  end
  # verify the required parameter 'signing_key_id' is set
  if @api_client.config.client_side_validation && signing_key_id.nil?
    fail ArgumentError, "Missing the required parameter 'signing_key_id' when calling URLSigningKeysApi.delete_url_signing_key"
  end
  # resource path
  local_var_path = '/video/v1/signing-keys/{SIGNING_KEY_ID}'.sub('{' + 'SIGNING_KEY_ID' + '}', signing_key_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['accessToken']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: URLSigningKeysApi#delete_url_signing_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_url_signing_key(signing_key_id, opts = {}) ⇒ SigningKeyResponse

Retrieve a URL signing key Retrieves the details of a URL signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.**

Parameters:

  • signing_key_id —

    The ID of the signing key.

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

    the optional parameters

Returns:



117
118
119
120
 
# File 'lib/mux_ruby/api/url_signing_keys_api.rb', line 117

def get_url_signing_key(signing_key_id, opts = {})
  data, _status_code, _headers = get_url_signing_key_with_http_info(signing_key_id, opts)
  data
end

#get_url_signing_key_with_http_info(signing_key_id, opts = {}) ⇒ Array<(SigningKeyResponse, Fixnum, Hash)>

Retrieve a URL signing key Retrieves the details of a URL signing key that has previously been created. Supply the unique signing key ID that was returned from your previous request, and Mux will return the corresponding signing key information. **The private key is not returned in this response.**

Parameters:

  • signing_key_id —

    The ID of the signing key.

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

    the optional parameters

Returns:

  • (Array<(SigningKeyResponse, Fixnum, Hash)>) —

    SigningKeyResponse data, response status code and response headers



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/mux_ruby/api/url_signing_keys_api.rb', line 127

def get_url_signing_key_with_http_info(signing_key_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: URLSigningKeysApi.get_url_signing_key ...'
  end
  # verify the required parameter 'signing_key_id' is set
  if @api_client.config.client_side_validation && signing_key_id.nil?
    fail ArgumentError, "Missing the required parameter 'signing_key_id' when calling URLSigningKeysApi.get_url_signing_key"
  end
  # resource path
  local_var_path = '/video/v1/signing-keys/{SIGNING_KEY_ID}'.sub('{' + 'SIGNING_KEY_ID' + '}', signing_key_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['accessToken']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SigningKeyResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: URLSigningKeysApi#get_url_signing_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_url_signing_keys(opts = {}) ⇒ ListSigningKeysResponse

List URL signing keys Returns a list of URL signing keys.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of items to include in the response (default to 25)

  • :page (Integer) —

    Offset by this many pages, of the size of &#x60;limit&#x60; (default to 1)

Returns:



171
172
173
174
 
# File 'lib/mux_ruby/api/url_signing_keys_api.rb', line 171

def list_url_signing_keys(opts = {})
  data, _status_code, _headers = list_url_signing_keys_with_http_info(opts)
  data
end

#list_url_signing_keys_with_http_info(opts = {}) ⇒ Array<(ListSigningKeysResponse, Fixnum, Hash)>

List URL signing keys Returns a list of URL signing keys.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of items to include in the response

  • :page (Integer) —

    Offset by this many pages, of the size of &#x60;limit&#x60;

Returns:

  • (Array<(ListSigningKeysResponse, Fixnum, Hash)>) —

    ListSigningKeysResponse data, response status code and response headers



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
213
214
215
216
 
# File 'lib/mux_ruby/api/url_signing_keys_api.rb', line 182

def list_url_signing_keys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: URLSigningKeysApi.list_url_signing_keys ...'
  end
  # resource path
  local_var_path = '/video/v1/signing-keys'

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['accessToken']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListSigningKeysResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: URLSigningKeysApi#list_url_signing_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end