Class: ClerkHttpClient::EmailAddressesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EmailAddressesApi

Returns a new instance of EmailAddressesApi.



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

def api_client
  @api_client
end

Instance Method Details

#create_email_address(opts = {}) ⇒ EmailAddress

Create an email address Create a new email address

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



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

def create_email_address(opts = {})
  data, _status_code, _headers = create_email_address_with_http_info(opts)
  data
end

#create_email_address_with_http_info(opts = {}) ⇒ Array<(EmailAddress, Integer, Hash)>

Create an email address Create a new email address POST

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    EmailAddress 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/email_addresses_api.rb', line 39

def create_email_address_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailAddressesApi.create_email_address ...'
  end
  # resource path
  local_var_path = '/email_addresses'

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

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

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

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

#delete_email_address(email_address_id, opts = {}) ⇒ DeletedObject

Delete an email address Delete the email address with the given ID

Parameters:

  • email_address_id (String) —

    The ID of the email address to delete

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

    the optional parameters

Returns:



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

def delete_email_address(email_address_id, opts = {})
  data, _status_code, _headers = delete_email_address_with_http_info(email_address_id, opts)
  data
end

#delete_email_address_with_http_info(email_address_id, opts = {}) ⇒ Array<(DeletedObject, Integer, Hash)>

Delete an email address Delete the email address with the given ID DELETE

Parameters:

  • email_address_id (String) —

    The ID of the email address to delete

  • 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/email_addresses_api.rb', line 105

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

#get_email_address(email_address_id, opts = {}) ⇒ EmailAddress

Retrieve an email address Returns the details of an email address.

Parameters:

  • email_address_id (String) —

    The ID of the email address to retrieve

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

    the optional parameters

Returns:



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

def get_email_address(email_address_id, opts = {})
  data, _status_code, _headers = get_email_address_with_http_info(email_address_id, opts)
  data
end

#get_email_address_with_http_info(email_address_id, opts = {}) ⇒ Array<(EmailAddress, Integer, Hash)>

Retrieve an email address Returns the details of an email address. GET

Parameters:

  • email_address_id (String) —

    The ID of the email address to retrieve

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

    the optional parameters

Returns:

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

    EmailAddress data, response status code and response headers



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

def get_email_address_with_http_info(email_address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailAddressesApi.get_email_address ...'
  end
  # verify the required parameter 'email_address_id' is set
  if @api_client.config.client_side_validation && email_address_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_address_id' when calling EmailAddressesApi.get_email_address"
  end
  # resource path
  local_var_path = '/email_addresses/{email_address_id}'.sub('{' + 'email_address_id' + '}', CGI.escape(email_address_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] || 'EmailAddress'

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

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

#update_email_address(email_address_id, opts = {}) ⇒ EmailAddress

Update an email address Updates an email address.

Parameters:

  • email_address_id (String) —

    The ID of the email address to update

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

    the optional parameters

Options Hash (opts):

Returns:



225
226
227
228
 
# File 'lib/clerk-http-client/api/email_addresses_api.rb', line 225

def update_email_address(email_address_id, opts = {})
  data, _status_code, _headers = update_email_address_with_http_info(email_address_id, opts)
  data
end

#update_email_address_with_http_info(email_address_id, opts = {}) ⇒ Array<(EmailAddress, Integer, Hash)>

Update an email address Updates an email address. PATCH

Parameters:

  • email_address_id (String) —

    The ID of the email address to update

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

    the optional parameters

Options Hash (opts):

Returns:

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

    EmailAddress data, response status code and response headers



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
287
288
 
# File 'lib/clerk-http-client/api/email_addresses_api.rb', line 237

def update_email_address_with_http_info(email_address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EmailAddressesApi.update_email_address ...'
  end
  # verify the required parameter 'email_address_id' is set
  if @api_client.config.client_side_validation && email_address_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_address_id' when calling EmailAddressesApi.update_email_address"
  end
  # resource path
  local_var_path = '/email_addresses/{email_address_id}'.sub('{' + 'email_address_id' + '}', CGI.escape(email_address_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(opts[:'update_email_address_request'])

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

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

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