Class: ClerkHttpClient::DomainsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DomainsApi

Returns a new instance of DomainsApi.



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

def api_client
  @api_client
end

Instance Method Details

#add_domain(opts = {}) ⇒ Domain

Add a domain Add a new domain for your instance. Useful in the case of multi-domain instances, allows adding satellite domains to an instance. The new domain must have a ‘name`. The domain name can contain the port for development instances, like `localhost:3000`. At the moment, instances can have only one primary domain, so the `is_satellite` parameter must be set to `true`. If you’re planning to configure the new satellite domain to run behind a proxy, pass the ‘proxy_url` parameter accordingly.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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

def add_domain(opts = {})
  data, _status_code, _headers = add_domain_with_http_info(opts)
  data
end

#add_domain_with_http_info(opts = {}) ⇒ Array<(Domain, Integer, Hash)>

Add a domain Add a new domain for your instance. Useful in the case of multi-domain instances, allows adding satellite domains to an instance. The new domain must have a &#x60;name&#x60;. The domain name can contain the port for development instances, like &#x60;localhost:3000&#x60;. At the moment, instances can have only one primary domain, so the &#x60;is_satellite&#x60; parameter must be set to &#x60;true&#x60;. If you&#39;re planning to configure the new satellite domain to run behind a proxy, pass the &#x60;proxy_url&#x60; parameter accordingly. POST

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Domain data, 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/domains_api.rb', line 39

def add_domain_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.add_domain ...'
  end
  # resource path
  local_var_path = '/domains'

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

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

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

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

#delete_domain(domain_id, opts = {}) ⇒ DeletedObject

Delete a satellite domain Deletes a satellite domain for the instance. It is currently not possible to delete the instance’s primary domain.

Parameters:

  • domain_id (String) —

    The ID of the domain that will be deleted. Must be a satellite domain.

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

    the optional parameters

Returns:



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

def delete_domain(domain_id, opts = {})
  data, _status_code, _headers = delete_domain_with_http_info(domain_id, opts)
  data
end

#delete_domain_with_http_info(domain_id, opts = {}) ⇒ Array<(DeletedObject, Integer, Hash)>

Delete a satellite domain Deletes a satellite domain for the instance. It is currently not possible to delete the instance&#39;s primary domain. DELETE

Parameters:

  • domain_id (String) —

    The ID of the domain that will be deleted. Must be a satellite domain.

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

    the optional parameters

Returns:

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

    DeletedObject data, response status code and response headers



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

def delete_domain_with_http_info(domain_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.delete_domain ...'
  end
  # verify the required parameter 'domain_id' is set
  if @api_client.config.client_side_validation && domain_id.nil?
    fail ArgumentError, "Missing the required parameter 'domain_id' when calling DomainsApi.delete_domain"
  end
  # resource path
  local_var_path = '/domains/{domain_id}'.sub('{' + 'domain_id' + '}', CGI.escape(domain_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] || 'DeletedObject'

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

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

#list_domains(opts = {}) ⇒ Domains

List all instance domains Use this endpoint to get a list of all domains for an instance. The response will contain the primary domain for the instance and any satellite domains. Each domain in the response contains information about the URLs where Clerk operates and the required CNAME targets.

Parameters:

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

    the optional parameters

Returns:



158
159
160
161
 
# File 'lib/clerk-http-client/api/domains_api.rb', line 158

def list_domains(opts = {})
  data, _status_code, _headers = list_domains_with_http_info(opts)
  data
end

#list_domains_with_http_info(opts = {}) ⇒ Array<(Domains, Integer, Hash)>

List all instance domains Use this endpoint to get a list of all domains for an instance. The response will contain the primary domain for the instance and any satellite domains. Each domain in the response contains information about the URLs where Clerk operates and the required CNAME targets. GET

Parameters:

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

    the optional parameters

Returns:

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

    Domains data, response status code and response headers



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

def list_domains_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.list_domains ...'
  end
  # resource path
  local_var_path = '/domains'

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

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

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

#update_domain(domain_id, update_domain_request, opts = {}) ⇒ Domain

Update a domain The ‘proxy_url` can be updated only for production instances. Update one of the instance’s domains. Both primary and satellite domains can be updated. If you choose to use Clerk via proxy, use this endpoint to specify the ‘proxy_url`. Whenever you decide you’d rather switch to DNS setup for Clerk, simply set ‘proxy_url` to `null` for the domain. When you update a production instance’s primary domain name, you have to make sure that you’ve completed all the necessary setup steps for DNS and emails to work. Expect downtime otherwise. Updating a primary domain’s name will also update the instance’s home origin, affecting the default application paths.

Parameters:

  • domain_id (String) —

    The ID of the domain that will be updated.

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

    the optional parameters

Returns:



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

def update_domain(domain_id, update_domain_request, opts = {})
  data, _status_code, _headers = update_domain_with_http_info(domain_id, update_domain_request, opts)
  data
end

#update_domain_with_http_info(domain_id, update_domain_request, opts = {}) ⇒ Array<(Domain, Integer, Hash)>

Update a domain The &#x60;proxy_url&#x60; can be updated only for production instances. Update one of the instance&#39;s domains. Both primary and satellite domains can be updated. If you choose to use Clerk via proxy, use this endpoint to specify the &#x60;proxy_url&#x60;. Whenever you decide you&#39;d rather switch to DNS setup for Clerk, simply set &#x60;proxy_url&#x60; to &#x60;null&#x60; for the domain. When you update a production instance&#39;s primary domain name, you have to make sure that you&#39;ve completed all the necessary setup steps for DNS and emails to work. Expect downtime otherwise. Updating a primary domain&#39;s name will also update the instance&#39;s home origin, affecting the default application paths. PATCH

Parameters:

  • domain_id (String) —

    The ID of the domain that will be updated.

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

    the optional parameters

Returns:

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

    Domain data, response status code and response headers



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
278
279
280
281
282
283
284
285
286
 
# File 'lib/clerk-http-client/api/domains_api.rb', line 231

def update_domain_with_http_info(domain_id, update_domain_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.update_domain ...'
  end
  # verify the required parameter 'domain_id' is set
  if @api_client.config.client_side_validation && domain_id.nil?
    fail ArgumentError, "Missing the required parameter 'domain_id' when calling DomainsApi.update_domain"
  end
  # verify the required parameter 'update_domain_request' is set
  if @api_client.config.client_side_validation && update_domain_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_domain_request' when calling DomainsApi.update_domain"
  end
  # resource path
  local_var_path = '/domains/{domain_id}'.sub('{' + 'domain_id' + '}', CGI.escape(domain_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(update_domain_request)

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

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

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