Class: ClerkHttpClient::BetaFeaturesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BetaFeaturesApi

Returns a new instance of BetaFeaturesApi.



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

def api_client
  @api_client
end

Instance Method Details

#change_production_instance_domain(opts = {}) ⇒ nil

Update production instance domain Change the domain of a production instance. Changing the domain requires updating the [DNS records](clerk.com/docs/deployments/overview#dns-records) accordingly, deploying new [SSL certificates](clerk.com/docs/deployments/overview#deploy), updating your Social Connection’s redirect URLs and setting the new keys in your code. WARNING: Changing your domain will invalidate all current user sessions (i.e. users will be logged out). Also, while your application is being deployed, a small downtime is expected to occur.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


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

def change_production_instance_domain(opts = {})
  change_production_instance_domain_with_http_info(opts)
  nil
end

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

Update production instance domain Change the domain of a production instance. Changing the domain requires updating the [DNS records](clerk.com/docs/deployments/overview#dns-records) accordingly, deploying new [SSL certificates](clerk.com/docs/deployments/overview#deploy), updating your Social Connection&#39;s redirect URLs and setting the new keys in your code. WARNING: Changing your domain will invalidate all current user sessions (i.e. users will be logged out). Also, while your application is being deployed, a small downtime is expected to occur. POST

Parameters:

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

    the optional parameters

Options Hash (opts):

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

def change_production_instance_domain_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BetaFeaturesApi.change_production_instance_domain ...'
  end
  # resource path
  local_var_path = '/instance/change_domain'

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#update_instance_auth_config(opts = {}) ⇒ UpdateInstanceAuthConfig200Response

Update instance settings Updates the settings of an instance

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



94
95
96
97
 
# File 'lib/clerk-http-client/api/beta_features_api.rb', line 94

def update_instance_auth_config(opts = {})
  data, _status_code, _headers = update_instance_auth_config_with_http_info(opts)
  data
end

#update_instance_auth_config_with_http_info(opts = {}) ⇒ Array<(UpdateInstanceAuthConfig200Response, Integer, Hash)>

Update instance settings Updates the settings of an instance PATCH

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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
149
150
151
152
 
# File 'lib/clerk-http-client/api/beta_features_api.rb', line 105

def update_instance_auth_config_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BetaFeaturesApi.update_instance_auth_config ...'
  end
  # resource path
  local_var_path = '/beta_features/instance_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_auth_config_request'])

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

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

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

#update_production_instance_domain(opts = {}) ⇒ nil

Update production instance domain Change the domain of a production instance. Changing the domain requires updating the [DNS records](clerk.com/docs/deployments/overview#dns-records) accordingly, deploying new [SSL certificates](clerk.com/docs/deployments/overview#deploy), updating your Social Connection’s redirect URLs and setting the new keys in your code. WARNING: Changing your domain will invalidate all current user sessions (i.e. users will be logged out). Also, while your application is being deployed, a small downtime is expected to occur.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


160
161
162
163
 
# File 'lib/clerk-http-client/api/beta_features_api.rb', line 160

def update_production_instance_domain(opts = {})
  update_production_instance_domain_with_http_info(opts)
  nil
end

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

Update production instance domain Change the domain of a production instance. Changing the domain requires updating the [DNS records](clerk.com/docs/deployments/overview#dns-records) accordingly, deploying new [SSL certificates](clerk.com/docs/deployments/overview#deploy), updating your Social Connection&#39;s redirect URLs and setting the new keys in your code. WARNING: Changing your domain will invalidate all current user sessions (i.e. users will be logged out). Also, while your application is being deployed, a small downtime is expected to occur. PUT

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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
212
213
214
215
216
217
218
 
# File 'lib/clerk-http-client/api/beta_features_api.rb', line 171

def update_production_instance_domain_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BetaFeaturesApi.update_production_instance_domain ...'
  end
  # resource path
  local_var_path = '/beta_features/domain'

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

  # return_type
  return_type = opts[:debug_return_type]

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

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