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

#update(update_instance_request, opts = {}) ⇒ nil

Update instance settings Updates the settings of an instance

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


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

def update(update_instance_request, opts = {})
  update_with_http_info(update_instance_request, opts)
  nil
end

#update_organization_settings(update_instance_organization_settings_request, opts = {}) ⇒ OrganizationSettings

Update instance organization settings Updates the organization settings of the instance

Parameters:

Returns:



98
99
100
101
 
# File 'lib/clerk-http-client/api/instance_settings_api.rb', line 98

def update_organization_settings(update_instance_organization_settings_request, opts = {})
  data, _status_code, _headers = update_organization_settings_with_http_info(update_instance_organization_settings_request, opts)
  data
end

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

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

Parameters:

Returns:

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

    OrganizationSettings data, response status code and response headers



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

def update_organization_settings_with_http_info(update_instance_organization_settings_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InstanceSettingsApi.update_instance_organization_settings ...'
  end
  # verify the required parameter 'update_instance_organization_settings_request' is set
  if @api_client.config.client_side_validation && update_instance_organization_settings_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_instance_organization_settings_request' when calling 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(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_restrictions(update_instance_restrictions_request, opts = {}) ⇒ InstanceRestrictions

Update instance restrictions Updates the restriction settings of an instance

Parameters:

Returns:



168
169
170
171
 
# File 'lib/clerk-http-client/api/instance_settings_api.rb', line 168

def update_restrictions(update_instance_restrictions_request, opts = {})
  data, _status_code, _headers = update_restrictions_with_http_info(update_instance_restrictions_request, opts)
  data
end

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

Update instance restrictions Updates the restriction settings of an instance PATCH

Parameters:

Returns:

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

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

def update_restrictions_with_http_info(update_instance_restrictions_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InstanceSettingsApi.update_instance_restrictions ...'
  end
  # verify the required parameter 'update_instance_restrictions_request' is set
  if @api_client.config.client_side_validation && update_instance_restrictions_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_instance_restrictions_request' when calling 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(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_with_http_info(update_instance_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update instance settings Updates the settings of an instance PATCH

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
88
89
90
 
# File 'lib/clerk-http-client/api/instance_settings_api.rb', line 39

def update_with_http_info(update_instance_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InstanceSettingsApi.update_instance ...'
  end
  # verify the required parameter 'update_instance_request' is set
  if @api_client.config.client_side_validation && update_instance_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_instance_request' when calling 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(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