Class: ClerkHttpClient::OrganizationDomainsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OrganizationDomainsApi

Returns a new instance of OrganizationDomainsApi.



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

def api_client
  @api_client
end

Instance Method Details

#all(organization_id, opts = {}) ⇒ OrganizationDomains

Get a list of all domains of an organization. Get a list of all domains of an organization.

Parameters:

  • organization_id (String) —

    The organization ID.

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

    the optional parameters

Options Hash (opts):

  • :limit (Float) —

    Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`. (default to 10)

  • :offset (Float) —

    Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`. (default to 0)

  • :verified (String) —

    Filter domains by their verification status. `true` or `false`

  • :enrollment_mode (String) —

    Filter domains by their enrollment mode

Returns:



179
180
181
182
 
# File 'lib/clerk-http-client/api/organization_domains_api.rb', line 179

def all(organization_id, opts = {})
  data, _status_code, _headers = all_with_http_info(organization_id, opts)
  data
end

#all_with_http_info(organization_id, opts = {}) ⇒ Array<(OrganizationDomains, Integer, Hash)>

Get a list of all domains of an organization. Get a list of all domains of an organization. GET

Parameters:

  • organization_id (String) —

    The organization ID.

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

    the optional parameters

Options Hash (opts):

  • :limit (Float) —

    Applies a limit to the number of results returned. Can be used for paginating the results together with &#x60;offset&#x60;. (default to 10)

  • :offset (Float) —

    Skip the first &#x60;offset&#x60; results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with &#x60;limit&#x60;. (default to 0)

  • :verified (String) —

    Filter domains by their verification status. &#x60;true&#x60; or &#x60;false&#x60;

  • :enrollment_mode (String) —

    Filter domains by their enrollment mode

Returns:

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

    OrganizationDomains data, response status code and response headers



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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/clerk-http-client/api/organization_domains_api.rb', line 194

def all_with_http_info(organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationDomainsApi.list_organization_domains ...'
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationDomainsApi.list_organization_domains"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling OrganizationDomainsApi.list_organization_domains, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling OrganizationDomainsApi.list_organization_domains, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling OrganizationDomainsApi.list_organization_domains, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/organizations/{organization_id}/domains'.sub('{' + 'organization_id' + '}', CGI.escape(organization_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'verified'] = opts[:'verified'] if !opts[:'verified'].nil?
  query_params[:'enrollment_mode'] = opts[:'enrollment_mode'] if !opts[:'enrollment_mode'].nil?

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

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

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

#create(organization_id, create_organization_domain_request, opts = {}) ⇒ OrganizationDomain

Create a new organization domain. Creates a new organization domain. By default the domain is verified, but can be optionally set to unverified.

Parameters:

  • organization_id (String) —

    The ID of the organization where the new domain will be created.

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

    the optional parameters

Returns:



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

def create(organization_id, create_organization_domain_request, opts = {})
  data, _status_code, _headers = create_with_http_info(organization_id, create_organization_domain_request, opts)
  data
end

#create_with_http_info(organization_id, create_organization_domain_request, opts = {}) ⇒ Array<(OrganizationDomain, Integer, Hash)>

Create a new organization domain. Creates a new organization domain. By default the domain is verified, but can be optionally set to unverified. POST

Parameters:

  • organization_id (String) —

    The ID of the organization where the new domain will be created.

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

    the optional parameters

Returns:

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

    OrganizationDomain data, response status code and response headers



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
91
92
93
94
95
96
 
# File 'lib/clerk-http-client/api/organization_domains_api.rb', line 41

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

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

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

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

#delete(organization_id, domain_id, opts = {}) ⇒ DeletedObject

Remove a domain from an organization. Removes the given domain from the organization.

Parameters:

  • organization_id (String) —

    The ID of the organization the domain belongs to

  • domain_id (String) —

    The ID of the domain

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

    the optional parameters

Returns:



105
106
107
108
 
# File 'lib/clerk-http-client/api/organization_domains_api.rb', line 105

def delete(organization_id, domain_id, opts = {})
  data, _status_code, _headers = delete_with_http_info(organization_id, domain_id, opts)
  data
end

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

Remove a domain from an organization. Removes the given domain from the organization. DELETE

Parameters:

  • organization_id (String) —

    The ID of the organization the domain belongs to

  • domain_id (String) —

    The ID of the domain

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

    the optional parameters

Returns:

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

    DeletedObject data, response status code and response headers



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
161
162
163
164
165
166
167
 
# File 'lib/clerk-http-client/api/organization_domains_api.rb', line 117

def delete_with_http_info(organization_id, domain_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OrganizationDomainsApi.delete_organization_domain ...'
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationDomainsApi.delete_organization_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 OrganizationDomainsApi.delete_organization_domain"
  end
  # resource path
  local_var_path = '/organizations/{organization_id}/domains/{domain_id}'.sub('{' + 'organization_id' + '}', CGI.escape(organization_id.to_s)).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 => :"OrganizationDomainsApi.delete_organization_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: OrganizationDomainsApi#delete_organization_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end