Class: Spatio::ResourcesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/spatio-sdk/api/resources_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ResourcesApi

Returns a new instance of ResourcesApi.



19
20
21
 
# File 'lib/spatio-sdk/api/resources_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/spatio-sdk/api/resources_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#list_resource_permission_grants(platform, resource_id, opts = {}) ⇒ Hash<String, Object>

List access grants on a resource (per-resource ACL).

Parameters:

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

    the optional parameters

Returns:

  • (Hash<String, Object>) 


27
28
29
30
 
# File 'lib/spatio-sdk/api/resources_api.rb', line 27

def list_resource_permission_grants(platform, resource_id, opts = {})
  data, _status_code, _headers = list_resource_permission_grants_with_http_info(platform, resource_id, opts)
  data
end

#list_resource_permission_grants_with_http_info(platform, resource_id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

List access grants on a resource (per-resource ACL).

Parameters:

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

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> 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
85
86
87
 
# File 'lib/spatio-sdk/api/resources_api.rb', line 37

def list_resource_permission_grants_with_http_info(platform, resource_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourcesApi.list_resource_permission_grants ...'
  end
  # verify the required parameter 'platform' is set
  if @api_client.config.client_side_validation && platform.nil?
    fail ArgumentError, "Missing the required parameter 'platform' when calling ResourcesApi.list_resource_permission_grants"
  end
  # verify the required parameter 'resource_id' is set
  if @api_client.config.client_side_validation && resource_id.nil?
    fail ArgumentError, "Missing the required parameter 'resource_id' when calling ResourcesApi.list_resource_permission_grants"
  end
  # resource path
  local_var_path = '/v1/resources/{platform}/{resourceId}/permissions'.sub('{platform}', CGI.escape(platform.to_s)).sub('{resourceId}', CGI.escape(resource_id.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] || 'Hash<String, Object>'

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

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

#revoke_resource_permission_grant(platform, resource_id, grant_id, opts = {}) ⇒ nil

Revoke an access grant.

Parameters:

  • platform (String)
  • resource_id (String)
  • grant_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


95
96
97
98
 
# File 'lib/spatio-sdk/api/resources_api.rb', line 95

def revoke_resource_permission_grant(platform, resource_id, grant_id, opts = {})
  revoke_resource_permission_grant_with_http_info(platform, resource_id, grant_id, opts)
  nil
end

#revoke_resource_permission_grant_with_http_info(platform, resource_id, grant_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Revoke an access grant.

Parameters:

  • platform (String)
  • resource_id (String)
  • grant_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
152
153
154
155
156
157
158
159
160
 
# File 'lib/spatio-sdk/api/resources_api.rb', line 106

def revoke_resource_permission_grant_with_http_info(platform, resource_id, grant_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourcesApi.revoke_resource_permission_grant ...'
  end
  # verify the required parameter 'platform' is set
  if @api_client.config.client_side_validation && platform.nil?
    fail ArgumentError, "Missing the required parameter 'platform' when calling ResourcesApi.revoke_resource_permission_grant"
  end
  # verify the required parameter 'resource_id' is set
  if @api_client.config.client_side_validation && resource_id.nil?
    fail ArgumentError, "Missing the required parameter 'resource_id' when calling ResourcesApi.revoke_resource_permission_grant"
  end
  # verify the required parameter 'grant_id' is set
  if @api_client.config.client_side_validation && grant_id.nil?
    fail ArgumentError, "Missing the required parameter 'grant_id' when calling ResourcesApi.revoke_resource_permission_grant"
  end
  # resource path
  local_var_path = '/v1/resources/{platform}/{resourceId}/permissions/{grantId}'.sub('{platform}', CGI.escape(platform.to_s)).sub('{resourceId}', CGI.escape(resource_id.to_s)).sub('{grantId}', CGI.escape(grant_id.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] || ['bearerAuth']

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

#set_resource_permission_grant(platform, resource_id, request_body, opts = {}) ⇒ Hash<String, Object>

Create or update an access grant.

Parameters:

  • platform (String)
  • resource_id (String)
  • request_body (Hash<String, Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Hash<String, Object>) 


168
169
170
171
 
# File 'lib/spatio-sdk/api/resources_api.rb', line 168

def set_resource_permission_grant(platform, resource_id, request_body, opts = {})
  data, _status_code, _headers = set_resource_permission_grant_with_http_info(platform, resource_id, request_body, opts)
  data
end

#set_resource_permission_grant_with_http_info(platform, resource_id, request_body, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Create or update an access grant.

Parameters:

  • platform (String)
  • resource_id (String)
  • request_body (Hash<String, Object>)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



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
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/spatio-sdk/api/resources_api.rb', line 179

def set_resource_permission_grant_with_http_info(platform, resource_id, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ResourcesApi.set_resource_permission_grant ...'
  end
  # verify the required parameter 'platform' is set
  if @api_client.config.client_side_validation && platform.nil?
    fail ArgumentError, "Missing the required parameter 'platform' when calling ResourcesApi.set_resource_permission_grant"
  end
  # verify the required parameter 'resource_id' is set
  if @api_client.config.client_side_validation && resource_id.nil?
    fail ArgumentError, "Missing the required parameter 'resource_id' when calling ResourcesApi.set_resource_permission_grant"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling ResourcesApi.set_resource_permission_grant"
  end
  # resource path
  local_var_path = '/v1/resources/{platform}/{resourceId}/permissions'.sub('{platform}', CGI.escape(platform.to_s)).sub('{resourceId}', CGI.escape(resource_id.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']
  # 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(request_body)

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

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

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