Module: Auth0::Api::V2::LogStreams
- Included in:
- Auth0::Api::V2
- Defined in:
- lib/auth0/api/v2/log_streams.rb
Overview
Methods to use the log streams endpoints
Instance Method Summary collapse
-
#create_log_stream(name, type, options) ⇒ json
Creates a new log stream according to the JSON object received in body.
-
#delete_log_stream(id) ⇒ Object
Deletes a log stream by its ID.
-
#log_stream(id) ⇒ json
(also: #get_log_stream)
Retrieves a log stream by its ID.
-
#log_streams ⇒ json
(also: #get_log_streams)
Retrieves a list of all log streams.
-
#patch_log_stream(id, status) ⇒ Object
Updates a log stream.
Instance Method Details
#create_log_stream(name, type, options) ⇒ json
Creates a new log stream according to the JSON object received in body.
35 36 37 38 39 40 41 42 43 44 45 |
# File 'lib/auth0/api/v2/log_streams.rb', line 35 def create_log_stream(name, type, ) raise Auth0::InvalidParameter, 'Name must contain at least one character' if name.to_s.empty? raise Auth0::InvalidParameter, 'Must specify a valid type' if type.to_s.empty? raise Auth0::InvalidParameter, 'Must supply a valid hash for options' unless .is_a? Hash request_params = {} request_params[:name] = name request_params[:type] = type request_params[:sink] = post(log_streams_path, request_params) end |
#delete_log_stream(id) ⇒ Object
Deletes a log stream by its ID.
50 51 52 53 54 |
# File 'lib/auth0/api/v2/log_streams.rb', line 50 def delete_log_stream(id) raise Auth0::InvalidParameter, 'Must supply a valid log stream id' if id.to_s.empty? path = "#{log_streams_path}/#{id}" delete(path) end |
#log_stream(id) ⇒ json Also known as: get_log_stream
Retrieves a log stream by its ID.
21 22 23 24 25 |
# File 'lib/auth0/api/v2/log_streams.rb', line 21 def log_stream(id) raise Auth0::InvalidParameter, 'Must supply a valid log stream id' if id.to_s.empty? path = "#{log_streams_path}/#{id}" get(path) end |
#log_streams ⇒ json Also known as: get_log_streams
Retrieves a list of all log streams.
11 12 13 |
# File 'lib/auth0/api/v2/log_streams.rb', line 11 def log_streams() get(log_streams_path) end |
#patch_log_stream(id, status) ⇒ Object
Updates a log stream.
60 61 62 63 64 65 66 67 68 |
# File 'lib/auth0/api/v2/log_streams.rb', line 60 def patch_log_stream(id, status) raise Auth0::InvalidParameter, 'Must specify a log stream id' if id.to_s.empty? raise Auth0::InvalidParameter, 'Must specify a valid status' if status.to_s.empty? request_params = {} request_params[:status] = status path = "#{log_streams_path}/#{id}" patch(path, request_params) end |