Class: OryClient::RelationshipApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RelationshipApi

Returns a new instance of RelationshipApi.



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

def api_client
  @api_client
end

Instance Method Details

#check_opl_syntax(opts = {}) ⇒ CheckOplSyntaxResult

Check the syntax of an OPL file The OPL file is expected in the body of the request.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (String)

Returns:



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

def check_opl_syntax(opts = {})
  data, _status_code, _headers = check_opl_syntax_with_http_info(opts)
  data
end

#check_opl_syntax_with_http_info(opts = {}) ⇒ Array<(CheckOplSyntaxResult, Integer, Hash)>

Check the syntax of an OPL file The OPL file is expected in the body of the request.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :body (String)

Returns:

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

    CheckOplSyntaxResult 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/ory-client/api/relationship_api.rb', line 37

def check_opl_syntax_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RelationshipApi.check_opl_syntax ...'
  end
  # resource path
  local_var_path = '/opl/syntax/check'

  # 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(['text/plain'])
  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[:'body'])

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

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

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

#create_relationship(opts = {}) ⇒ Relationship

Create a Relationship Use this endpoint to create a relationship.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



91
92
93
94
 
# File 'lib/ory-client/api/relationship_api.rb', line 91

def create_relationship(opts = {})
  data, _status_code, _headers = create_relationship_with_http_info(opts)
  data
end

#create_relationship_with_http_info(opts = {}) ⇒ Array<(Relationship, Integer, Hash)>

Create a Relationship Use this endpoint to create a relationship.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Relationship 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/ory-client/api/relationship_api.rb', line 101

def create_relationship_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RelationshipApi.create_relationship ...'
  end
  # resource path
  local_var_path = '/admin/relation-tuples'

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

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

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

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

#delete_relationships(opts = {}) ⇒ nil

Delete Relationships Use this endpoint to delete relationships

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :namespace (String) —

    Namespace of the Relationship

  • :object (String) —

    Object of the Relationship

  • :relation (String) —

    Relation of the Relationship

  • :subject_id (String) —

    SubjectID of the Relationship

  • :subject_set_namespace (String) —

    Namespace of the Subject Set

  • :subject_set_object (String) —

    Object of the Subject Set

  • :subject_set_relation (String) —

    Relation of the Subject Set

Returns:

  • (nil) 


161
162
163
164
 
# File 'lib/ory-client/api/relationship_api.rb', line 161

def delete_relationships(opts = {})
  delete_relationships_with_http_info(opts)
  nil
end

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

Delete Relationships Use this endpoint to delete relationships

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :namespace (String) —

    Namespace of the Relationship

  • :object (String) —

    Object of the Relationship

  • :relation (String) —

    Relation of the Relationship

  • :subject_id (String) —

    SubjectID of the Relationship

  • :subject_set_namespace (String) —

    Namespace of the Subject Set

  • :subject_set_object (String) —

    Object of the Subject Set

  • :subject_set_relation (String) —

    Relation of the Subject Set

Returns:

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

    nil, response status code and response headers



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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/ory-client/api/relationship_api.rb', line 177

def delete_relationships_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RelationshipApi.delete_relationships ...'
  end
  # resource path
  local_var_path = '/admin/relation-tuples'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'namespace'] = opts[:'namespace'] if !opts[:'namespace'].nil?
  query_params[:'object'] = opts[:'object'] if !opts[:'object'].nil?
  query_params[:'relation'] = opts[:'relation'] if !opts[:'relation'].nil?
  query_params[:'subject_id'] = opts[:'subject_id'] if !opts[:'subject_id'].nil?
  query_params[:'subject_set.namespace'] = opts[:'subject_set_namespace'] if !opts[:'subject_set_namespace'].nil?
  query_params[:'subject_set.object'] = opts[:'subject_set_object'] if !opts[:'subject_set_object'].nil?
  query_params[:'subject_set.relation'] = opts[:'subject_set_relation'] if !opts[:'subject_set_relation'].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]

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

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

#get_relationships(opts = {}) ⇒ Relationships

Query relationships Get all relationships that match the query. Only the namespace field is required.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_token (String)
  • :page_size (Integer)
  • :namespace (String) —

    Namespace of the Relationship

  • :object (String) —

    Object of the Relationship

  • :relation (String) —

    Relation of the Relationship

  • :subject_id (String) —

    SubjectID of the Relationship

  • :subject_set_namespace (String) —

    Namespace of the Subject Set

  • :subject_set_object (String) —

    Object of the Subject Set

  • :subject_set_relation (String) —

    Relation of the Subject Set

Returns:



241
242
243
244
 
# File 'lib/ory-client/api/relationship_api.rb', line 241

def get_relationships(opts = {})
  data, _status_code, _headers = get_relationships_with_http_info(opts)
  data
end

#get_relationships_with_http_info(opts = {}) ⇒ Array<(Relationships, Integer, Hash)>

Query relationships Get all relationships that match the query. Only the namespace field is required.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_token (String)
  • :page_size (Integer)
  • :namespace (String) —

    Namespace of the Relationship

  • :object (String) —

    Object of the Relationship

  • :relation (String) —

    Relation of the Relationship

  • :subject_id (String) —

    SubjectID of the Relationship

  • :subject_set_namespace (String) —

    Namespace of the Subject Set

  • :subject_set_object (String) —

    Object of the Subject Set

  • :subject_set_relation (String) —

    Relation of the Subject Set

Returns:

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

    Relationships data, response status code and response headers



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/ory-client/api/relationship_api.rb', line 259

def get_relationships_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RelationshipApi.get_relationships ...'
  end
  # resource path
  local_var_path = '/relation-tuples'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page_token'] = opts[:'page_token'] if !opts[:'page_token'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'namespace'] = opts[:'namespace'] if !opts[:'namespace'].nil?
  query_params[:'object'] = opts[:'object'] if !opts[:'object'].nil?
  query_params[:'relation'] = opts[:'relation'] if !opts[:'relation'].nil?
  query_params[:'subject_id'] = opts[:'subject_id'] if !opts[:'subject_id'].nil?
  query_params[:'subject_set.namespace'] = opts[:'subject_set_namespace'] if !opts[:'subject_set_namespace'].nil?
  query_params[:'subject_set.object'] = opts[:'subject_set_object'] if !opts[:'subject_set_object'].nil?
  query_params[:'subject_set.relation'] = opts[:'subject_set_relation'] if !opts[:'subject_set_relation'].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] || 'Relationships'

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

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

#list_relationship_namespaces(opts = {}) ⇒ RelationshipNamespaces

Query namespaces Get all namespaces

Parameters:

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

    the optional parameters

Returns:



316
317
318
319
 
# File 'lib/ory-client/api/relationship_api.rb', line 316

def list_relationship_namespaces(opts = {})
  data, _status_code, _headers = list_relationship_namespaces_with_http_info(opts)
  data
end

#list_relationship_namespaces_with_http_info(opts = {}) ⇒ Array<(RelationshipNamespaces, Integer, Hash)>

Query namespaces Get all namespaces

Parameters:

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

    the optional parameters

Returns:

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

    RelationshipNamespaces data, response status code and response headers



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/ory-client/api/relationship_api.rb', line 325

def list_relationship_namespaces_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RelationshipApi.list_relationship_namespaces ...'
  end
  # resource path
  local_var_path = '/namespaces'

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

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

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

#patch_relationships(opts = {}) ⇒ nil

Patch Multiple Relationships Use this endpoint to patch one or more relationships.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


374
375
376
377
 
# File 'lib/ory-client/api/relationship_api.rb', line 374

def patch_relationships(opts = {})
  patch_relationships_with_http_info(opts)
  nil
end

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

Patch Multiple Relationships Use this endpoint to patch one or more relationships.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/ory-client/api/relationship_api.rb', line 384

def patch_relationships_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RelationshipApi.patch_relationships ...'
  end
  # resource path
  local_var_path = '/admin/relation-tuples'

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

  # return_type
  return_type = opts[:debug_return_type]

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

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