Class: OryClient::WorkspaceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ory-client/api/workspace_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WorkspaceApi

Returns a new instance of WorkspaceApi.



19
20
21
 
# File 'lib/ory-client/api/workspace_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/ory-client/api/workspace_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_workspace(opts = {}) ⇒ Workspace

Create a new workspace

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



26
27
28
29
 
# File 'lib/ory-client/api/workspace_api.rb', line 26

def create_workspace(opts = {})
  data, _status_code, _headers = create_workspace_with_http_info(opts)
  data
end

#create_workspace_with_http_info(opts = {}) ⇒ Array<(Workspace, Integer, Hash)>

Create a new workspace

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Workspace data, response status code and response headers



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
76
77
78
79
80
81
82
 
# File 'lib/ory-client/api/workspace_api.rb', line 35

def create_workspace_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkspaceApi.create_workspace ...'
  end
  # resource path
  local_var_path = '/workspaces'

  # 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'])
  # 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[:'create_workspace_body'])

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

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

  new_options = opts.merge(
    :operation => :"WorkspaceApi.create_workspace",
    :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: WorkspaceApi#create_workspace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_workspace(workspace, opts = {}) ⇒ Workspace

Get a workspace Any workspace member can access this endpoint.

Parameters:

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

    the optional parameters

Returns:



89
90
91
92
 
# File 'lib/ory-client/api/workspace_api.rb', line 89

def get_workspace(workspace, opts = {})
  data, _status_code, _headers = get_workspace_with_http_info(workspace, opts)
  data
end

#get_workspace_with_http_info(workspace, opts = {}) ⇒ Array<(Workspace, Integer, Hash)>

Get a workspace Any workspace member can access this endpoint.

Parameters:

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

    the optional parameters

Returns:

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

    Workspace data, response status code and response headers



99
100
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
 
# File 'lib/ory-client/api/workspace_api.rb', line 99

def get_workspace_with_http_info(workspace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkspaceApi.get_workspace ...'
  end
  # verify the required parameter 'workspace' is set
  if @api_client.config.client_side_validation && workspace.nil?
    fail ArgumentError, "Missing the required parameter 'workspace' when calling WorkspaceApi.get_workspace"
  end
  # resource path
  local_var_path = '/workspaces/{workspace}'.sub('{' + 'workspace' + '}', CGI.escape(workspace.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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"WorkspaceApi.get_workspace",
    :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: WorkspaceApi#get_workspace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_workspace_projects(workspace, opts = {}) ⇒ ListWorkspaceProjects

List all projects of a workspace Any workspace member can access this endpoint.

Parameters:

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

    the optional parameters

Returns:



152
153
154
155
 
# File 'lib/ory-client/api/workspace_api.rb', line 152

def list_workspace_projects(workspace, opts = {})
  data, _status_code, _headers = list_workspace_projects_with_http_info(workspace, opts)
  data
end

#list_workspace_projects_with_http_info(workspace, opts = {}) ⇒ Array<(ListWorkspaceProjects, Integer, Hash)>

List all projects of a workspace Any workspace member can access this endpoint.

Parameters:

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

    the optional parameters

Returns:

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

    ListWorkspaceProjects data, response status code and response headers



162
163
164
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
 
# File 'lib/ory-client/api/workspace_api.rb', line 162

def list_workspace_projects_with_http_info(workspace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkspaceApi.list_workspace_projects ...'
  end
  # verify the required parameter 'workspace' is set
  if @api_client.config.client_side_validation && workspace.nil?
    fail ArgumentError, "Missing the required parameter 'workspace' when calling WorkspaceApi.list_workspace_projects"
  end
  # resource path
  local_var_path = '/workspaces/{workspace}/projects'.sub('{' + 'workspace' + '}', CGI.escape(workspace.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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"WorkspaceApi.list_workspace_projects",
    :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: WorkspaceApi#list_workspace_projects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_workspaces(opts = {}) ⇒ ListWorkspaces

List workspaces the user is a member of

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



215
216
217
218
 
# File 'lib/ory-client/api/workspace_api.rb', line 215

def list_workspaces(opts = {})
  data, _status_code, _headers = list_workspaces_with_http_info(opts)
  data
end

#list_workspaces_with_http_info(opts = {}) ⇒ Array<(ListWorkspaces, Integer, Hash)>

List workspaces the user is a member of

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    ListWorkspaces data, response status code and response headers



225
226
227
228
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
277
 
# File 'lib/ory-client/api/workspace_api.rb', line 225

def list_workspaces_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkspaceApi.list_workspaces ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling WorkspaceApi.list_workspaces, must be smaller than or equal to 1000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling WorkspaceApi.list_workspaces, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/workspaces'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page_token'] = opts[:'page_token'] if !opts[:'page_token'].nil?

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

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

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

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

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

  new_options = opts.merge(
    :operation => :"WorkspaceApi.list_workspaces",
    :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: WorkspaceApi#list_workspaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_workspace(workspace, opts = {}) ⇒ Workspace

Update an workspace Workspace members with the role ‘OWNER` can access this endpoint.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



285
286
287
288
 
# File 'lib/ory-client/api/workspace_api.rb', line 285

def update_workspace(workspace, opts = {})
  data, _status_code, _headers = update_workspace_with_http_info(workspace, opts)
  data
end

#update_workspace_with_http_info(workspace, opts = {}) ⇒ Array<(Workspace, Integer, Hash)>

Update an workspace Workspace members with the role &#x60;OWNER&#x60; can access this endpoint.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Workspace data, response status code and response headers



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/ory-client/api/workspace_api.rb', line 296

def update_workspace_with_http_info(workspace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WorkspaceApi.update_workspace ...'
  end
  # verify the required parameter 'workspace' is set
  if @api_client.config.client_side_validation && workspace.nil?
    fail ArgumentError, "Missing the required parameter 'workspace' when calling WorkspaceApi.update_workspace"
  end
  # resource path
  local_var_path = '/workspaces/{workspace}'.sub('{' + 'workspace' + '}', CGI.escape(workspace.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'])
  # 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[:'update_workspace_body'])

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

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

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