Class: ClerkHttpClient::InstanceSettingsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/clerk-http-client/api/instance_settings_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InstanceSettingsApi

Returns a new instance of InstanceSettingsApi.



19
20
21
 
# File 'lib/clerk-http-client/api/instance_settings_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/clerk-http-client/api/instance_settings_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_instance(opts = {}) ⇒ Instance

Fetch the current instance Fetches the current instance

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/clerk-http-client/api/instance_settings_api.rb', line 27

def get_instance(opts = {})
  data, _status_code, _headers = get_instance_with_http_info(opts)
  data
end

#get_instance_with_http_info(opts = {}) ⇒ Array<(Instance, Integer, Hash)>

Fetch the current instance Fetches the current instance GET

Parameters:

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

    the optional parameters

Returns:

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

    Instance 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
 
# File 'lib/clerk-http-client/api/instance_settings_api.rb', line 37

def get_instance_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InstanceSettingsApi.get_instance ...'
  end
  # resource path
  local_var_path = '/instance'

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

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

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

#update_instance(opts = {}) ⇒ nil

Update instance settings Updates the settings of an instance

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


87
88
89
90
 
# File 'lib/clerk-http-client/api/instance_settings_api.rb', line 87

def update_instance(opts = {})
  update_instance_with_http_info(opts)
  nil
end

#update_instance_organization_settings(opts = {}) ⇒ OrganizationSettings

Update instance organization settings Updates the organization settings of the instance

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



153
154
155
156
 
# File 'lib/clerk-http-client/api/instance_settings_api.rb', line 153

def update_instance_organization_settings(opts = {})
  data, _status_code, _headers = update_instance_organization_settings_with_http_info(opts)
  data
end

#update_instance_organization_settings_with_http_info(opts = {}) ⇒ Array<(OrganizationSettings, Integer, Hash)>

Update instance organization settings Updates the organization settings of the instance PATCH

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    OrganizationSettings data, response status code and response headers



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
209
210
211
 
# File 'lib/clerk-http-client/api/instance_settings_api.rb', line 164

def update_instance_organization_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InstanceSettingsApi.update_instance_organization_settings ...'
  end
  # resource path
  local_var_path = '/instance/organization_settings'

  # 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(opts[:'update_instance_organization_settings_request'])

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

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

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

#update_instance_restrictions(opts = {}) ⇒ InstanceRestrictions

Update instance restrictions Updates the restriction settings of an instance

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



219
220
221
222
 
# File 'lib/clerk-http-client/api/instance_settings_api.rb', line 219

def update_instance_restrictions(opts = {})
  data, _status_code, _headers = update_instance_restrictions_with_http_info(opts)
  data
end

#update_instance_restrictions_with_http_info(opts = {}) ⇒ Array<(InstanceRestrictions, Integer, Hash)>

Update instance restrictions Updates the restriction settings of an instance PATCH

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    InstanceRestrictions data, response status code and response headers



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/clerk-http-client/api/instance_settings_api.rb', line 230

def update_instance_restrictions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InstanceSettingsApi.update_instance_restrictions ...'
  end
  # resource path
  local_var_path = '/instance/restrictions'

  # 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(opts[:'update_instance_restrictions_request'])

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

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

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

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

Update instance settings Updates the settings of an instance PATCH

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



98
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/clerk-http-client/api/instance_settings_api.rb', line 98

def update_instance_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InstanceSettingsApi.update_instance ...'
  end
  # resource path
  local_var_path = '/instance'

  # 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(opts[:'update_instance_request'])

  # return_type
  return_type = opts[:debug_return_type]

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

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