Class: Pingram::AddressesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pingram/api/addresses_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AddressesApi

Returns a new instance of AddressesApi.



19
20
21
 
# File 'lib/pingram/api/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/pingram/api/addresses_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#addresses_create_address(create_address_request, opts = {}) ⇒ AddressResponse

Create a new email inbox. Omit domain for a built-in @mail.pingram.io address; set domain and displayName for a custom address on a verified domain.

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/pingram/api/addresses_api.rb', line 26

def addresses_create_address(create_address_request, opts = {})
  data, _status_code, _headers = addresses_create_address_with_http_info(create_address_request, opts)
  data
end

#addresses_create_address_with_http_info(create_address_request, opts = {}) ⇒ Array<(AddressResponse, Integer, Hash)>

Create a new email inbox. Omit `domain` for a built-in `@mail.pingram.io` address; set `domain` and `displayName` for a custom address on a verified domain.

Parameters:

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

    the optional parameters

Returns:

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

    AddressResponse data, response status code and response headers



35
36
37
38
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/pingram/api/addresses_api.rb', line 35

def addresses_create_address_with_http_info(create_address_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddressesApi.addresses_create_address ...'
  end
  # verify the required parameter 'create_address_request' is set
  if @api_client.config.client_side_validation && create_address_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_address_request' when calling AddressesApi.addresses_create_address"
  end
  # resource path
  local_var_path = '/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(create_address_request)

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

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

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

#addresses_delete_address(full_address, opts = {}) ⇒ SuccessResponse

Delete a custom inbound address. Builtin addresses cannot be deleted.

Parameters:

  • full_address (String) —

    Full address to delete (e.g. hello@example.com)

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

    the optional parameters

Returns:



92
93
94
95
 
# File 'lib/pingram/api/addresses_api.rb', line 92

def addresses_delete_address(full_address, opts = {})
  data, _status_code, _headers = addresses_delete_address_with_http_info(full_address, opts)
  data
end

#addresses_delete_address_with_http_info(full_address, opts = {}) ⇒ Array<(SuccessResponse, Integer, Hash)>

Delete a custom inbound address. Builtin addresses cannot be deleted.

Parameters:

  • full_address (String) —

    Full address to delete (e.g. hello@example.com)

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

    the optional parameters

Returns:

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

    SuccessResponse data, response status code and response headers



101
102
103
104
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
 
# File 'lib/pingram/api/addresses_api.rb', line 101

def addresses_delete_address_with_http_info(full_address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddressesApi.addresses_delete_address ...'
  end
  # verify the required parameter 'full_address' is set
  if @api_client.config.client_side_validation && full_address.nil?
    fail ArgumentError, "Missing the required parameter 'full_address' when calling AddressesApi.addresses_delete_address"
  end
  # resource path
  local_var_path = '/addresses/{fullAddress}'.sub('{' + 'fullAddress' + '}', CGI.escape(full_address.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] || 'SuccessResponse'

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

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

#addresses_list_addresses(opts = {}) ⇒ AccountAddressesResponse

List email inboxes (addresses) configured for receiving. Custom addresses must use a verified domain.

Parameters:

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

    the optional parameters

Returns:



152
153
154
155
 
# File 'lib/pingram/api/addresses_api.rb', line 152

def addresses_list_addresses(opts = {})
  data, _status_code, _headers = addresses_list_addresses_with_http_info(opts)
  data
end

#addresses_list_addresses_with_http_info(opts = {}) ⇒ Array<(AccountAddressesResponse, Integer, Hash)>

List email inboxes (addresses) configured for receiving. Custom addresses must use a verified domain.

Parameters:

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

    the optional parameters

Returns:

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

    AccountAddressesResponse data, response status code and response headers



160
161
162
163
164
165
166
167
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
 
# File 'lib/pingram/api/addresses_api.rb', line 160

def addresses_list_addresses_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddressesApi.addresses_list_addresses ...'
  end
  # resource path
  local_var_path = '/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']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

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

#addresses_update_address(update_address_request, opts = {}) ⇒ AddressResponse

Update an inbox prefix or display name.

Parameters:

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

    the optional parameters

Returns:



208
209
210
211
 
# File 'lib/pingram/api/addresses_api.rb', line 208

def addresses_update_address(update_address_request, opts = {})
  data, _status_code, _headers = addresses_update_address_with_http_info(update_address_request, opts)
  data
end

#addresses_update_address_with_http_info(update_address_request, opts = {}) ⇒ Array<(AddressResponse, Integer, Hash)>

Update an inbox prefix or display name.

Parameters:

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

    the optional parameters

Returns:

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

    AddressResponse data, response status code and response headers



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
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/pingram/api/addresses_api.rb', line 217

def addresses_update_address_with_http_info(update_address_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddressesApi.addresses_update_address ...'
  end
  # verify the required parameter 'update_address_request' is set
  if @api_client.config.client_side_validation && update_address_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_address_request' when calling AddressesApi.addresses_update_address"
  end
  # resource path
  local_var_path = '/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(update_address_request)

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

  # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
  auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

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