Releasing version 1.5.0

Releasing version 1.5.0

Author: waruwaruwaru

CHANGELOG.md

@@ -3,6 +3,16 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
+## 1.5.0 - 2020-08-11
+### Added
+- Support for autonomous json databases in the Database service
+- Support for cleaning up uncommitted multipart uploads in the Object Storage service
+- Support for additional list API filters in the Data Catalog service
+
+
+### Breaking
+- Some unusable region enums were removed from the Support Management service
+
 ## 1.4.0 - 2020-08-04
 ### Added
 - Support for calling Oracle Cloud Infrastructure services in the uk-gov-cardiff-1 region

examples/javascript/custom-retry.js

@@ -0,0 +1,248 @@
+/*
+ * Copyright (c) 2020, Oracle and/or its affiliates.  All rights reserved.
+ * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+ */
+
+/*
+  This script provides a basic example of how to use the Email Service in the TypeScript SDK.
+  This will demonstrate:
+   * Creating, retrieving, updating, listing, and deleting email senders
+   * Creating, retrieving, listing, and deleting email suppressions
+   * Creating, updating, listing, and deleting SMTP credentials.
+     See https://docs.cloud.oracle.com/iaas/Content/Email/Tasks/configuresmtpconnection.htm for more
+     information on sending emails with your IAM user
+
+ This script accepts four arguments:
+   * The compartment ID where email senders will be created
+   * The target compartmentId to change compartments
+   * The address of the email sender
+   * The address of the email suppression
+
+ Note that email senders are created in the compartment which you specify, but the suppressions are always created at the tenancy
+ level. The tenancy will be read from your configuration file.
+*/
+
+const identity = require("oci-identity");
+const common = require("oci-common");
+const email = require("oci-email");
+
+const provider = new common.ConfigFileAuthenticationDetailsProvider();
+
+const args = process.argv.slice(2);
+if (args.length !== 4) {
+  console.error(
+    "Unexpected number of arguments received. Consult the script header comments for expected arguments"
+  );
+  process.exit(-1);
+}
+
+const compartmentId = args[0];
+const targetCompartmentId = args[1];
+const senderEmailAddress = args[2];
+const suppressionEmailAddress = args[3];
+
+const emailClient = new email.EmailClient({ authenticationDetailsProvider: provider });
+const identityClient = new identity.IdentityClient({ authenticationDetailsProvider: provider });
+
+async function delay(s) {
+  return new Promise(resolve => setTimeout(resolve, s * 1000));
+}
+
+async function createEmailSender(compartmentId, senderEmailAddress) {
+  const request = {
+    createSenderDetails: {
+      compartmentId: compartmentId,
+      emailAddress: senderEmailAddress
+    }
+  };
+
+  // Try to add a generic waiter here or use delay of 2min 30s
+  const response = await emailClient.createSender(request);
+  await delay(240); // Give some time to createSender.
+  console.log("Created Sender: ", response);
+  return response;
+}
+
+async function updateEmailSender(sender) {
+  const request = {
+    senderId: sender.sender.id,
+    updateSenderDetails: {
+      freeformTags: {
+        department: "Finance"
+      }
+    }
+  };
+  const response = await emailClient.updateSender(request);
+  console.log("Updated Sender with freeformTags: ", response.sender.freeformTags);
+  return response;
+}
+
+async function changeSenderCompartment(sender) {
+  const request = {
+    senderId: sender.sender.id,
+    changeSenderCompartmentDetails: {
+      compartmentId: targetCompartmentId
+    }
+  };
+  const response = await emailClient.changeSenderCompartment(request);
+  console.log(`Change sender compartment to: ${targetCompartmentId}`);
+  return response;
+}
+
+async function listAllSender(compartmentId, emailAddress) {
+  const request = {
+    compartmentId: compartmentId
+  };
+  if (emailAddress) {
+    request["emailAddress"] = emailAddress;
+  }
+
+  const senders = await common.paginatedRecordsWithLimit(request, req =>
+    emailClient.listSenders(request)
+  );
+  console.log("Listing all senders: ");
+  senders.forEach(sender => {
+    console.log("Sender: ", sender);
+  });
+  return;
+}
+
+async function createSuppresion(compartmentId, emailAddress) {
+  const request = {
+    createSuppressionDetails: {
+      compartmentId: compartmentId,
+      emailAddress: emailAddress
+    }
+  };
+  const response = await emailClient.createSuppression(request);
+  console.log("Created suppression: ", response.suppression);
+  return response;
+}
+
+async function listAllSuppressions(compartmentId, emailAddress) {
+  const request = {
+    compartmentId: compartmentId
+  };
+  if (emailAddress) {
+    request["emailAddress"] = emailAddress;
+  }
+  const suppressions = await common.paginatedRecordsWithLimit(request, req =>
+    emailClient.listSuppressions(request)
+  );
+  console.log("List suppressions: ");
+  suppressions.forEach(suppression => {
+    console.log("Suppression: ", suppression);
+  });
+}
+
+async function deleteSender(sender) {
+  const request = {
+    senderId: sender.sender.id
+  };
+  await emailClient.deleteSender(request);
+  console.log("Deleted Sender.");
+  return;
+}
+
+async function deleteSuppression(suppression) {
+  const request = {
+    suppressionId: suppression.suppression.id
+  };
+  await emailClient.deleteSuppression(request);
+  console.log("Deleted Supression.");
+  return;
+}
+
+async function createSmtpCredential() {
+  const request = {
+    userId: provider.getUser(),
+    createSmtpCredentialDetails: {
+      description: "New Credentials"
+    }
+  };
+  const smptCredential = await identityClient.createSmtpCredential(request);
+  console.log("Created smptCredential: ", smptCredential);
+  return smptCredential;
+}
+
+async function updateSmtpCredential(smptCredential) {
+  const request = {
+    userId: provider.getUser(),
+    smtpCredentialId: smptCredential.smtpCredential.id,
+    updateSmtpCredentialDetails: {
+      description: "Updated Credentials"
+    }
+  };
+  const updatedSmtpCredential = await identityClient.updateSmtpCredential(request);
+  console.log("Updated SMTP Credential: ", updatedSmtpCredential.smtpCredentialSummary);
+  return;
+}
+
+async function listSmtpCredentials() {
+  const request = {
+    userId: provider.getUser()
+  };
+  const smtpCredentialsResponse = await identityClient.listSmtpCredentials(request);
+  console.log("SMTP Credentials for user: ", smtpCredentialsResponse);
+  return;
+}
+
+async function deleteSmtpCredential(smptCredential) {
+  const request = {
+    userId: provider.getUser(),
+    smtpCredentialId: smptCredential.smtpCredential.id
+  };
+  await identityClient.deleteSmtpCredential(request);
+  console.log("Deleted SMTP Credential");
+  return;
+}
+
+(async () => {
+  // Create a sender
+  const sender = await createEmailSender(compartmentId, senderEmailAddress);
+
+  // Update sender
+  await updateEmailSender(sender);
+
+  // Change sender compartment
+  await changeSenderCompartment(sender);
+
+  // List all senders in a compartment
+  await listAllSender(compartmentId, "");
+
+  // List all senders in a compartment filtered by email address
+  await listAllSender(compartmentId, senderEmailAddress);
+
+  // Create Suppression
+  const suppression = await createSuppresion(compartmentId, suppressionEmailAddress);
+
+  // List Suppression in a compartment
+  await listAllSuppressions(compartmentId, "");
+
+  // List Suppression in a compartment filtered by email address
+  await listAllSuppressions(compartmentId, suppressionEmailAddress);
+
+  // Delete Sender
+  await deleteSender(sender);
+
+  // Delete Suppression
+  await deleteSuppression(suppression);
+
+  /*
+   * In order to send email, we'll need to create an SMTP credential associated with an IAM user. More
+   * information on sending email can be found here: https://docs.cloud.oracle.com/Content/Email/Tasks/configuresmtpconnection.htm
+   *
+   * Note, also, that an IAM user can only have two active SMTP credentials at any time
+   * Also the password for the SMTP credential is ONLY available in the create response, so you should store/save this as it won't be retrievable later
+   */
+  const smtpCredential = await createSmtpCredential();
+
+  // Update the description of an SMTP credential
+  await updateSmtpCredential(smtpCredential);
+
+  // List the credentials for a user
+  await listSmtpCredentials();
+
+  // Delete SMTP credential
+  await deleteSmtpCredential(smtpCredential);
+})();