Class: Authentik::Api::SsfApi

Inherits:
Object
  • Object
show all
Defined in:
lib/authentik/api/api/ssf_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SsfApi

Returns a new instance of SsfApi.



13
14
15
 
# File 'lib/authentik/api/api/ssf_api.rb', line 13

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



11
12
13
 
# File 'lib/authentik/api/api/ssf_api.rb', line 11

def api_client
  @api_client
end

Instance Method Details

#ssf_streams_destroy(uuid, opts = {}) ⇒ nil

SSFStream Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this SSF Stream.

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

    the optional parameters

Returns:

  • (nil) 


20
21
22
23
 
# File 'lib/authentik/api/api/ssf_api.rb', line 20

def ssf_streams_destroy(uuid, opts = {})
  ssf_streams_destroy_with_http_info(uuid, opts)
  nil
end

#ssf_streams_destroy_with_http_info(uuid, opts = {}) ⇒ Array<(nil, Integer, Hash)>

SSFStream Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this SSF Stream.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/authentik/api/api/ssf_api.rb', line 29

def ssf_streams_destroy_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SsfApi.ssf_streams_destroy ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling SsfApi.ssf_streams_destroy"
  end
  # resource path
  local_var_path = '/ssf/streams/{uuid}/'.sub('{uuid}', CGI.escape(uuid.to_s))

  # 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']

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"SsfApi.ssf_streams_destroy",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SsfApi#ssf_streams_destroy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ssf_streams_list(opts = {}) ⇒ PaginatedSSFStreamList

SSFStream Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :delivery_method (DeliveryMethodEnum)
  • :endpoint_url (String)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :provider (Integer)
  • :search (String) —

    A search term.

Returns:



87
88
89
90
 
# File 'lib/authentik/api/api/ssf_api.rb', line 87

def ssf_streams_list(opts = {})
  data, _status_code, _headers = ssf_streams_list_with_http_info(opts)
  data
end

#ssf_streams_list_with_http_info(opts = {}) ⇒ Array<(PaginatedSSFStreamList, Integer, Hash)>

SSFStream Viewset

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :delivery_method (DeliveryMethodEnum)
  • :endpoint_url (String)
  • :ordering (String) —

    Which field to use when ordering the results.

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

  • :provider (Integer)
  • :search (String) —

    A search term.

Returns:

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

    PaginatedSSFStreamList data, response status code and response headers



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
149
150
151
 
# File 'lib/authentik/api/api/ssf_api.rb', line 102

def ssf_streams_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SsfApi.ssf_streams_list ...'
  end
  # resource path
  local_var_path = '/ssf/streams/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'delivery_method'] = opts[:'delivery_method'] if !opts[:'delivery_method'].nil?
  query_params[:'endpoint_url'] = opts[:'endpoint_url'] if !opts[:'endpoint_url'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'provider'] = opts[:'provider'] if !opts[:'provider'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?

  # 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']

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"SsfApi.ssf_streams_list",
    :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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SsfApi#ssf_streams_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ssf_streams_retrieve(uuid, opts = {}) ⇒ SSFStream

SSFStream Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this SSF Stream.

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

    the optional parameters

Returns:



157
158
159
160
 
# File 'lib/authentik/api/api/ssf_api.rb', line 157

def ssf_streams_retrieve(uuid, opts = {})
  data, _status_code, _headers = ssf_streams_retrieve_with_http_info(uuid, opts)
  data
end

#ssf_streams_retrieve_with_http_info(uuid, opts = {}) ⇒ Array<(SSFStream, Integer, Hash)>

SSFStream Viewset

Parameters:

  • uuid (String) —

    A UUID string identifying this SSF Stream.

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

    the optional parameters

Returns:

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

    SSFStream data, response status code and response headers



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/authentik/api/api/ssf_api.rb', line 166

def ssf_streams_retrieve_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SsfApi.ssf_streams_retrieve ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling SsfApi.ssf_streams_retrieve"
  end
  # resource path
  local_var_path = '/ssf/streams/{uuid}/'.sub('{uuid}', CGI.escape(uuid.to_s))

  # 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']

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

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"SsfApi.ssf_streams_retrieve",
    :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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SsfApi#ssf_streams_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end