Class: OCI::Email::EmailClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/email/email_client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, signer: nil) ⇒ EmailClient

Creates a new EmailClient. If a config is not specified, then the global OCI.config will be used.

A region must be specified in either the config or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

  • region (String) (defaults to: nil) —

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/email/email_client.rb', line 34

def initialize(config:nil, region:nil, signer:nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner and no config was supplied (which is valid for instance principals)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config ||= OCI.config unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner)
  config ||= OCI::Config.new if signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner)
  config.validate unless signer.is_a?(OCI::Auth::Signers::InstancePrincipalsSecurityTokenSigner)

  if signer.nil?
    signer = Signer.new(config.user, config.fingerprint, config.tenancy, config.key_file, pass_phrase: config.pass_phrase, private_key_content: config.key_content, signing_strategy: Signer::STANDARD)
  end

  @api_client = ApiClient.new(config, signer)

  region ||= config.region
  region ||= signer.region if signer.respond_to?(:region)
  self.region = region
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



12
13
14
 
# File 'lib/oci/email/email_client.rb', line 12

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/email/email_client.rb', line 16

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/email/email_client.rb', line 20

def region
  @region
end

Instance Method Details

#create_sender(create_sender_details, opts = {}) ⇒ Response

Creates a sender for a tenancy in a given compartment.

Parameters:

  • create_sender_details (CreateSenderDetails) —

    Create a sender.

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

    the optional parameters

Returns:

  • (Response) —

    A Response object with data of type OCI::Email::Models::Sender



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/email/email_client.rb', line 79

def create_sender(create_sender_details, opts = {})
  logger.debug "Calling operation EmailClient#create_sender." if logger

  raise "Missing the required parameter 'create_sender_details' when calling create_sender." if create_sender_details.nil?

  path = "/senders"

  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params['accept'] = 'application/json'
  header_params['content-type'] = 'application/json'

  post_body = @api_client.object_to_http_body(create_sender_details)

  return @api_client.call_api(
    :POST,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'OCI::Email::Models::Sender')
end

#create_suppression(create_suppression_details, opts = {}) ⇒ Response

Adds recipient email addresses to the suppression list for a tenancy.

Parameters:

  • create_suppression_details (CreateSuppressionDetails) —

    Adds a single email address to the suppression list for a compartment’s tenancy.

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

    the optional parameters

Returns:

  • (Response) —

    A Response object with data of type OCI::Email::Models::Suppression



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
 
# File 'lib/oci/email/email_client.rb', line 112

def create_suppression(create_suppression_details, opts = {})
  logger.debug "Calling operation EmailClient#create_suppression." if logger

  raise "Missing the required parameter 'create_suppression_details' when calling create_suppression." if create_suppression_details.nil?

  path = "/suppressions"

  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params['accept'] = 'application/json'
  header_params['content-type'] = 'application/json'

  post_body = @api_client.object_to_http_body(create_suppression_details)

  return @api_client.call_api(
    :POST,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'OCI::Email::Models::Suppression')
end

#delete_sender(sender_id, opts = {}) ⇒ Response

Deletes an approved sender for a tenancy in a given compartment for a provided ‘senderId`.

Parameters:

  • sender_id (String) —

    The unique OCID of the sender.

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

    the optional parameters

Returns:

  • (Response) —

    A Response object with data of type nil



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/email/email_client.rb', line 145

def delete_sender(sender_id, opts = {})
  logger.debug "Calling operation EmailClient#delete_sender." if logger

  raise "Missing the required parameter 'sender_id' when calling delete_sender." if sender_id.nil?

  path = "/senders/{senderId}".sub('{senderId}', sender_id.to_s)

  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params['accept'] = 'application/json'
  header_params['content-type'] = 'application/json'

  post_body = nil

  return @api_client.call_api(
    :DELETE,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body)
end

#delete_suppression(suppression_id, opts = {}) ⇒ Response

Removes a suppressed recipient email address from the suppression list for a tenancy in a given compartment for a provided ‘suppressionId`.

Parameters:

  • suppression_id (String) —

    The unique OCID of the suppression.

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

    the optional parameters

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/email/email_client.rb', line 177

def delete_suppression(suppression_id, opts = {})
  logger.debug "Calling operation EmailClient#delete_suppression." if logger

  raise "Missing the required parameter 'suppression_id' when calling delete_suppression." if suppression_id.nil?

  path = "/suppressions/{suppressionId}".sub('{suppressionId}', suppression_id.to_s)

  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params['accept'] = 'application/json'
  header_params['content-type'] = 'application/json'

  post_body = nil

  return @api_client.call_api(
    :DELETE,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body)
end

#get_sender(sender_id, opts = {}) ⇒ Response

Gets an approved sender for a given ‘senderId`.

Parameters:

  • sender_id (String) —

    The unique OCID of the sender.

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

    the optional parameters

Returns:

  • (Response) —

    A Response object with data of type OCI::Email::Models::Sender



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
 
# File 'lib/oci/email/email_client.rb', line 207

def get_sender(sender_id, opts = {})
  logger.debug "Calling operation EmailClient#get_sender." if logger

  raise "Missing the required parameter 'sender_id' when calling get_sender." if sender_id.nil?

  path = "/senders/{senderId}".sub('{senderId}', sender_id.to_s)

  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params['accept'] = 'application/json'
  header_params['content-type'] = 'application/json'

  post_body = nil

  return @api_client.call_api(
    :GET,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'OCI::Email::Models::Sender')
end

#get_suppression(suppression_id, opts = {}) ⇒ Response

Gets the details of a suppressed recipient email address for a given ‘suppressionId`. Each suppression is given a unique OCID.

Parameters:

  • suppression_id (String) —

    The unique OCID of the suppression.

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

    the optional parameters

Returns:

  • (Response) —

    A Response object with data of type OCI::Email::Models::Suppression



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
 
# File 'lib/oci/email/email_client.rb', line 240

def get_suppression(suppression_id, opts = {})
  logger.debug "Calling operation EmailClient#get_suppression." if logger

  raise "Missing the required parameter 'suppression_id' when calling get_suppression." if suppression_id.nil?

  path = "/suppressions/{suppressionId}".sub('{suppressionId}', suppression_id.to_s)

  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params['accept'] = 'application/json'
  header_params['content-type'] = 'application/json'

  post_body = nil

  return @api_client.call_api(
    :GET,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'OCI::Email::Models::Suppression')
end

#list_senders(compartment_id, opts = {}) ⇒ Response

Gets a collection of approved sender email addresses and sender IDs.

Parameters:

  • compartment_id (String) —

    The OCID for the compartment.

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

    the optional parameters

Options Hash (opts):

  • :lifecycle_state (String) —

    The current state of a sender.

  • :email_address (String) —

    The email address of the approved sender.

  • :page (String) —

    The value of the ‘opc-next-page` response header from the previous GET request.

  • :limit (Integer) —

    The maximum number of items to return in a paginated GET request.

  • :sort_by (String) —

    The field to sort by. The ‘TIMECREATED` value returns the list in in descending order by default. The `EMAILADDRESS` value returns the list in ascending order by default. Use the `SortOrderQueryParam` to change the direction of the returned list of items.

    Allowed values are: TIMECREATED, EMAILADDRESS

  • :sort_order (String) —

    The sort order to use, either ascending or descending order.

    Allowed values are: ASC, DESC

Returns:

  • (Response) —

    A Response object with data of type Array<OCI::Email::Models::SenderSummary>



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/oci/email/email_client.rb', line 288

def list_senders(compartment_id, opts = {})
  logger.debug "Calling operation EmailClient#list_senders." if logger

  raise "Missing the required parameter 'compartment_id' when calling list_senders." if compartment_id.nil?

  if opts[:'lifecycle_state'] && !OCI::Email::Models::Sender::LIFECYCLE_STATE_ENUM.include?(opts[:'lifecycle_state'])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Email::Models::Sender::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:'sort_by'] && !['TIMECREATED', 'EMAILADDRESS'].include?(opts[:'sort_by'])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, EMAILADDRESS.'
  end

  if opts[:'sort_order'] && !['ASC', 'DESC'].include?(opts[:'sort_order'])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  path = "/senders"

  # Query Params
  query_params = {}
  query_params[:'compartmentId'] = compartment_id
  query_params[:'lifecycleState'] = opts[:'lifecycle_state'] if opts[:'lifecycle_state']
  query_params[:'emailAddress'] = opts[:'email_address'] if opts[:'email_address']
  query_params[:'page'] = opts[:'page'] if opts[:'page']
  query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # Header Params
  header_params = {}
  header_params['accept'] = 'application/json'
  header_params['content-type'] = 'application/json'

  post_body = nil

  return @api_client.call_api(
    :GET,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'Array<OCI::Email::Models::SenderSummary>')
end

#list_suppressions(compartment_id, opts = {}) ⇒ Response

Gets a list of suppressed recipient email addresses for a user. The ‘compartmentId` for suppressions must be a tenancy OCID. The returned list is sorted by creation time in descending order.

Parameters:

  • compartment_id (String) —

    The OCID for the compartment.

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

    the optional parameters

Options Hash (opts):

  • :email_address (String) —

    The email address of the suppression.

  • :time_created_greater_than_or_equal_to (DateTime) —

    Search for suppressions that were created within a specific date range, using this parameter to specify the earliest creation date for the returned list (inclusive). Specifying this parameter without the corresponding ‘timeCreatedLessThan` parameter will retrieve suppressions created from the given `timeCreatedGreaterThanOrEqualTo` to the current time, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :time_created_less_than (DateTime) —

    Search for suppressions that were created within a specific date range, using this parameter to specify the latest creation date for the returned list (exclusive). Specifying this parameter without the corresponding ‘timeCreatedGreaterThanOrEqualTo` parameter will retrieve all suppressions created before the specified end date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

    Example: 2016-12-19T16:39:57.600Z

  • :page (String) —

    The value of the ‘opc-next-page` response header from the previous GET request.

  • :limit (Integer) —

    The maximum number of items to return in a paginated GET request.

  • :sort_by (String) —

    The field to sort by. The ‘TIMECREATED` value returns the list in in descending order by default. The `EMAILADDRESS` value returns the list in ascending order by default. Use the `SortOrderQueryParam` to change the direction of the returned list of items.

    Allowed values are: TIMECREATED, EMAILADDRESS

  • :sort_order (String) —

    The sort order to use, either ascending or descending order.

    Allowed values are: ASC, DESC

Returns:

  • (Response) —

    A Response object with data of type Array<OCI::Email::Models::SuppressionSummary>



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/oci/email/email_client.rb', line 374

def list_suppressions(compartment_id, opts = {})
  logger.debug "Calling operation EmailClient#list_suppressions." if logger

  raise "Missing the required parameter 'compartment_id' when calling list_suppressions." if compartment_id.nil?

  if opts[:'sort_by'] && !['TIMECREATED', 'EMAILADDRESS'].include?(opts[:'sort_by'])
    raise 'Invalid value for "sort_by", must be one of TIMECREATED, EMAILADDRESS.'
  end

  if opts[:'sort_order'] && !['ASC', 'DESC'].include?(opts[:'sort_order'])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  end

  path = "/suppressions"

  # Query Params
  query_params = {}
  query_params[:'compartmentId'] = compartment_id
  query_params[:'emailAddress'] = opts[:'email_address'] if opts[:'email_address']
  query_params[:'timeCreatedGreaterThanOrEqualTo'] = opts[:'time_created_greater_than_or_equal_to'] if opts[:'time_created_greater_than_or_equal_to']
  query_params[:'timeCreatedLessThan'] = opts[:'time_created_less_than'] if opts[:'time_created_less_than']
  query_params[:'page'] = opts[:'page'] if opts[:'page']
  query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # Header Params
  header_params = {}
  header_params['accept'] = 'application/json'
  header_params['content-type'] = 'application/json'

  post_body = nil

  return @api_client.call_api(
    :GET,
    path,
    endpoint,
    :header_params => header_params,
    :query_params => query_params,
    :body => post_body,
    :return_type => 'Array<OCI::Email::Models::SuppressionSummary>')
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



70
71
72
 
# File 'lib/oci/email/email_client.rb', line 70

def logger
  @api_client.config.logger
end