ibm-cloud-sdk-core 3.2.2-beta-5 → 3.2.2

package/auth/utils/get-authenticator-from-environment.js

@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAuthenticatorFromEnvironment = void 0;
 var authenticators_1 = require("../authenticators");
 var read_external_sources_1 = require("./read-external-sources");
 /**
@@ -34,7 +33,7 @@ function getAuthenticatorFromEnvironment(serviceName) {
         throw new Error('Service name is required.');
     }
     // construct the credentials object from the environment
-    var credentials = (0, read_external_sources_1.readExternalSources)(serviceName);
+    var credentials = read_external_sources_1.readExternalSources(serviceName);
     if (credentials === null) {
         throw new Error('Unable to create an authenticator from the environment.');
     }
@@ -88,7 +87,7 @@ function getAuthenticatorFromEnvironment(serviceName) {
         authenticator = new authenticators_1.VpcInstanceAuthenticator(credentials);
     }
     else {
-        throw new Error("Invalid value for AUTH_TYPE: ".concat(authType));
+        throw new Error("Invalid value for AUTH_TYPE: " + authType);
     }
     return authenticator;
 }

package/auth/utils/helpers.js

@@ -15,7 +15,6 @@
  * limitations under the License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.atMostOne = exports.atLeastOne = exports.removeSuffix = exports.onlyOne = exports.getCurrentTime = exports.validateInput = exports.checkCredentials = exports.computeBasicAuthHeader = void 0;
 var helper_1 = require("../../lib/helper");
 /**
  * Compute and return a Basic Authorization header from a username and password.
@@ -25,8 +24,8 @@ var helper_1 = require("../../lib/helper");
  * @returns {string} - A Basic Auth header with format "Basic <encoded-credentials>"
  */
 function computeBasicAuthHeader(username, password) {
-    var encodedCreds = Buffer.from("".concat(username, ":").concat(password)).toString('base64');
-    return "Basic ".concat(encodedCreds);
+    var encodedCreds = Buffer.from(username + ":" + password).toString('base64');
+    return "Basic " + encodedCreds;
 }
 exports.computeBasicAuthHeader = computeBasicAuthHeader;
 // returns true if the string has a curly bracket or quote as the first or last character
@@ -45,7 +44,7 @@ function checkCredentials(obj, credsToCheck) {
     var errorMessage = '';
     credsToCheck.forEach(function (cred) {
         if (obj[cred] && badCharAtAnEnd(obj[cred])) {
-            errorMessage += "The ".concat(cred, " shouldn't start or end with curly brackets or quotes. Be sure to remove any {, }, or \"");
+            errorMessage += "The " + cred + " shouldn't start or end with curly brackets or quotes. Be sure to remove any {, }, or \"";
         }
     });
     if (errorMessage.length) {
@@ -62,7 +61,7 @@ exports.checkCredentials = checkCredentials;
  */
 function validateInput(options, requiredOptions) {
     // check for required params
-    var missingParamsError = (0, helper_1.getMissingParams)(options, requiredOptions);
+    var missingParamsError = helper_1.getMissingParams(options, requiredOptions);
     if (missingParamsError) {
         throw missingParamsError;
     }

package/auth/utils/index.js

@@ -14,22 +14,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readExternalSources = exports.getAuthenticatorFromEnvironment = void 0;
 /**
  * @module utils
  * Helper functions used by generated SDKs.
@@ -38,9 +26,9 @@ exports.readExternalSources = exports.getAuthenticatorFromEnvironment = void 0;
  *   getAuthenticatorFromEnvironment: Get authenticator from external sources.
  *   readExternalSources: Get config object from external sources.
  */
-__exportStar(require("./helpers"), exports);
-__exportStar(require("./file-reading-helpers"), exports);
+__export(require("./helpers"));
+__export(require("./file-reading-helpers"));
 var get_authenticator_from_environment_1 = require("./get-authenticator-from-environment");
-Object.defineProperty(exports, "getAuthenticatorFromEnvironment", { enumerable: true, get: function () { return get_authenticator_from_environment_1.getAuthenticatorFromEnvironment; } });
+exports.getAuthenticatorFromEnvironment = get_authenticator_from_environment_1.getAuthenticatorFromEnvironment;
 var read_external_sources_1 = require("./read-external-sources");
-Object.defineProperty(exports, "readExternalSources", { enumerable: true, get: function () { return read_external_sources_1.readExternalSources; } });
+exports.readExternalSources = read_external_sources_1.readExternalSources;

package/auth/utils/read-external-sources.js

@@ -4,7 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readExternalSources = void 0;
 /**
  * (C) Copyright IBM Corp. 2019, 2021.
  *
@@ -47,11 +46,11 @@ function getProperties(serviceName) {
     // 3. VCAP Services (Cloud Foundry)
     // only get properties from one source, return null if none found
     var properties = null;
-    properties = filterPropertiesByServiceName((0, file_reading_helpers_1.readCredentialsFile)(), serviceName);
-    if ((0, lodash_isempty_1.default)(properties)) {
+    properties = filterPropertiesByServiceName(file_reading_helpers_1.readCredentialsFile(), serviceName);
+    if (lodash_isempty_1.default(properties)) {
         properties = filterPropertiesByServiceName(process.env, serviceName);
     }
-    if ((0, lodash_isempty_1.default)(properties)) {
+    if (lodash_isempty_1.default(properties)) {
         properties = getPropertiesFromVCAP(serviceName);
     }
     return properties;
@@ -69,11 +68,11 @@ function getProperties(serviceName) {
  */
 function filterPropertiesByServiceName(envObj, serviceName) {
     var credentials = {};
-    var name = "".concat(serviceName.toUpperCase().replace(/-/g, '_'), "_"); // append the underscore that must follow the service name
+    var name = serviceName.toUpperCase().replace(/-/g, '_') + "_"; // append the underscore that must follow the service name
     // filter out properties that don't begin with the service name
     Object.keys(envObj).forEach(function (key) {
         if (key.startsWith(name)) {
-            var propName = (0, camelcase_1.default)(key.substring(name.length)); // remove the name from the front of the string and make camelcase
+            var propName = camelcase_1.default(key.substring(name.length)); // remove the name from the front of the string and make camelcase
             credentials[propName] = envObj[key];
         }
     });

package/build/docs/ibm-cloud-sdk-core.atleastone.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [atLeastOne](./ibm-cloud-sdk-core.atleastone.md)
+
+## atLeastOne() function
+
+Check for at least one of two elements being defined. Returns true if a or b is defined. Returns false if both are undefined.
+
+<b>Signature:</b>
+
+```typescript
+export declare function atLeastOne(a: any, b: any): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  a | any | The first object |
+|  b | any | The second object |
+
+<b>Returns:</b>
+
+boolean
+
+{<!-- -->boolean<!-- -->}
+

package/build/docs/ibm-cloud-sdk-core.atmostone.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [atMostOne](./ibm-cloud-sdk-core.atmostone.md)
+
+## atMostOne() function
+
+Verify that both properties are not specified. Returns true if only a, only b, or neither is defined. Returns false if both are defined.
+
+<b>Signature:</b>
+
+```typescript
+export declare function atMostOne(a: any, b: any): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  a | any | The first object |
+|  b | any | The second object |
+
+<b>Returns:</b>
+
+boolean
+
+{<!-- -->boolean<!-- -->}
+

package/build/docs/ibm-cloud-sdk-core.authenticator._constructor_.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.authenticator._constructor_.md)
+
+## Authenticator.(constructor)
+
+Create a new Authenticator instance.
+
+<b>Signature:</b>
+
+```typescript
+constructor();
+```
+
+## Exceptions
+
+{<!-- -->Error<!-- -->} The `new` keyword was not used to create construct the authenticator.
+

package/build/docs/ibm-cloud-sdk-core.authenticator.authenticate.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [authenticate](./ibm-cloud-sdk-core.authenticator.authenticate.md)
+
+## Authenticator.authenticate() method
+
+Augment the request with authentication information.
+
+<b>Signature:</b>
+
+```typescript
+authenticate(requestOptions: AuthenticateOptions): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  requestOptions | AuthenticateOptions | The request to augment with authentication information. |
+
+<b>Returns:</b>
+
+Promise&lt;void&gt;
+
+## Exceptions
+
+{<!-- -->Error<!-- -->} - The authenticate method was not implemented by a subclass.
+

package/build/docs/ibm-cloud-sdk-core.authenticator.authenticationtype.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.authenticator.authenticationtype.md)
+
+## Authenticator.authenticationType() method
+
+Retrieves the authenticator's type. The returned value will be the same string that is used when configuring an instance of the authenticator with the "<!-- -->&lt;<!-- -->service\_name<!-- -->&gt;<!-- -->\_AUTH\_TYPE" configuration property (e.g. "basic", "iam", etc.). This function should be overridden in each authenticator implementation class that extends this class.
+
+<b>Signature:</b>
+
+```typescript
+authenticationType(): string;
+```
+<b>Returns:</b>
+
+string
+
+a string that indicates the authenticator's type
+

package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_basic.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_BASIC](./ibm-cloud-sdk-core.authenticator.authtype_basic.md)
+
+## Authenticator.AUTHTYPE\_BASIC property
+
+Constants that define the various authenticator types.
+
+<b>Signature:</b>
+
+```typescript
+static AUTHTYPE_BASIC: string;
+```

package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_bearertoken.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_BEARERTOKEN](./ibm-cloud-sdk-core.authenticator.authtype_bearertoken.md)
+
+## Authenticator.AUTHTYPE\_BEARERTOKEN property
+
+<b>Signature:</b>
+
+```typescript
+static AUTHTYPE_BEARERTOKEN: string;
+```

package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_container.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_CONTAINER](./ibm-cloud-sdk-core.authenticator.authtype_container.md)
+
+## Authenticator.AUTHTYPE\_CONTAINER property
+
+<b>Signature:</b>
+
+```typescript
+static AUTHTYPE_CONTAINER: string;
+```

package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_cp4d.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_CP4D](./ibm-cloud-sdk-core.authenticator.authtype_cp4d.md)
+
+## Authenticator.AUTHTYPE\_CP4D property
+
+<b>Signature:</b>
+
+```typescript
+static AUTHTYPE_CP4D: string;
+```

package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_iam.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_IAM](./ibm-cloud-sdk-core.authenticator.authtype_iam.md)
+
+## Authenticator.AUTHTYPE\_IAM property
+
+<b>Signature:</b>
+
+```typescript
+static AUTHTYPE_IAM: string;
+```

package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_noauth.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_NOAUTH](./ibm-cloud-sdk-core.authenticator.authtype_noauth.md)
+
+## Authenticator.AUTHTYPE\_NOAUTH property
+
+<b>Signature:</b>
+
+```typescript
+static AUTHTYPE_NOAUTH: string;
+```

package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_unknown.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_UNKNOWN](./ibm-cloud-sdk-core.authenticator.authtype_unknown.md)
+
+## Authenticator.AUTHTYPE\_UNKNOWN property
+
+<b>Signature:</b>
+
+```typescript
+static AUTHTYPE_UNKNOWN: string;
+```

package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_vpc.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md) &gt; [AUTHTYPE\_VPC](./ibm-cloud-sdk-core.authenticator.authtype_vpc.md)
+
+## Authenticator.AUTHTYPE\_VPC property
+
+<b>Signature:</b>
+
+```typescript
+static AUTHTYPE_VPC: string;
+```

package/build/docs/ibm-cloud-sdk-core.authenticator.md

@@ -0,0 +1,41 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
+
+## Authenticator class
+
+Base Authenticator class for other Authenticators to extend. Not intended to be used as a stand-alone authenticator.
+
+<b>Signature:</b>
+
+```typescript
+export declare class Authenticator implements AuthenticatorInterface 
+```
+<b>Implements:</b> [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)()](./ibm-cloud-sdk-core.authenticator._constructor_.md) |  | Create a new Authenticator instance. |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [AUTHTYPE\_BASIC](./ibm-cloud-sdk-core.authenticator.authtype_basic.md) | <code>static</code> | string | Constants that define the various authenticator types. |
+|  [AUTHTYPE\_BEARERTOKEN](./ibm-cloud-sdk-core.authenticator.authtype_bearertoken.md) | <code>static</code> | string |  |
+|  [AUTHTYPE\_CONTAINER](./ibm-cloud-sdk-core.authenticator.authtype_container.md) | <code>static</code> | string |  |
+|  [AUTHTYPE\_CP4D](./ibm-cloud-sdk-core.authenticator.authtype_cp4d.md) | <code>static</code> | string |  |
+|  [AUTHTYPE\_IAM](./ibm-cloud-sdk-core.authenticator.authtype_iam.md) | <code>static</code> | string |  |
+|  [AUTHTYPE\_NOAUTH](./ibm-cloud-sdk-core.authenticator.authtype_noauth.md) | <code>static</code> | string |  |
+|  [AUTHTYPE\_UNKNOWN](./ibm-cloud-sdk-core.authenticator.authtype_unknown.md) | <code>static</code> | string |  |
+|  [AUTHTYPE\_VPC](./ibm-cloud-sdk-core.authenticator.authtype_vpc.md) | <code>static</code> | string |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.authenticator.authenticate.md) |  | Augment the request with authentication information. |
+|  [authenticationType()](./ibm-cloud-sdk-core.authenticator.authenticationtype.md) |  | Retrieves the authenticator's type. The returned value will be the same string that is used when configuring an instance of the authenticator with the "<!-- -->&lt;<!-- -->service\_name<!-- -->&gt;<!-- -->\_AUTH\_TYPE" configuration property (e.g. "basic", "iam", etc.). This function should be overridden in each authenticator implementation class that extends this class. |
+

package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticate.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md) &gt; [authenticate](./ibm-cloud-sdk-core.authenticatorinterface.authenticate.md)
+
+## AuthenticatorInterface.authenticate() method
+
+Add authentication information to the specified request.
+
+<b>Signature:</b>
+
+```typescript
+authenticate(requestOptions: AuthenticateOptions): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  requestOptions | AuthenticateOptions | The request to augment with authentication information. |
+
+<b>Returns:</b>
+
+Promise&lt;void&gt;
+

package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticationtype.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md) &gt; [authenticationType](./ibm-cloud-sdk-core.authenticatorinterface.authenticationtype.md)
+
+## AuthenticatorInterface.authenticationType() method
+
+Returns a string that indicates the authentication type.
+
+<b>Signature:</b>
+
+```typescript
+authenticationType(): string;
+```
+<b>Returns:</b>
+
+string
+

package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md)
+
+## AuthenticatorInterface interface
+
+This interface defines the common methods associated with an Authenticator implementation.
+
+<b>Signature:</b>
+
+```typescript
+export interface AuthenticatorInterface 
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [authenticate(requestOptions)](./ibm-cloud-sdk-core.authenticatorinterface.authenticate.md) | Add authentication information to the specified request. |
+|  [authenticationType()](./ibm-cloud-sdk-core.authenticatorinterface.authenticationtype.md) | Returns a string that indicates the authentication type. |
+

package/build/docs/ibm-cloud-sdk-core.baseservice._constructor_.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [(constructor)](./ibm-cloud-sdk-core.baseservice._constructor_.md)
+
+## BaseService.(constructor)
+
+Configuration values for a service.
+
+<b>Signature:</b>
+
+```typescript
+constructor(userOptions: UserOptions);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  userOptions | [UserOptions](./ibm-cloud-sdk-core.useroptions.md) |  |
+

package/build/docs/ibm-cloud-sdk-core.baseservice.baseoptions.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [baseOptions](./ibm-cloud-sdk-core.baseservice.baseoptions.md)
+
+## BaseService.baseOptions property
+
+<b>Signature:</b>
+
+```typescript
+protected baseOptions: BaseServiceOptions;
+```

package/build/docs/ibm-cloud-sdk-core.baseservice.configureservice.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [configureService](./ibm-cloud-sdk-core.baseservice.configureservice.md)
+
+## BaseService.configureService() method
+
+Configure the service using external configuration
+
+<b>Signature:</b>
+
+```typescript
+protected configureService(serviceName: string): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  serviceName | string | The name of the service. Will be used to read from external configuration. |
+
+<b>Returns:</b>
+
+void
+

package/build/docs/ibm-cloud-sdk-core.baseservice.createrequest.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [createRequest](./ibm-cloud-sdk-core.baseservice.createrequest.md)
+
+## BaseService.createRequest() method
+
+Wrapper around `sendRequest` that enforces the request will be authenticated.
+
+<b>Signature:</b>
+
+```typescript
+protected createRequest(parameters: any): Promise<any>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  parameters | any | Service request options passed in by user. |
+
+<b>Returns:</b>
+
+Promise&lt;any&gt;
+
+{<!-- -->Promise<any>}
+

package/build/docs/ibm-cloud-sdk-core.baseservice.default_service_name.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [DEFAULT\_SERVICE\_NAME](./ibm-cloud-sdk-core.baseservice.default_service_name.md)
+
+## BaseService.DEFAULT\_SERVICE\_NAME property
+
+<b>Signature:</b>
+
+```typescript
+static DEFAULT_SERVICE_NAME: string;
+```

package/build/docs/ibm-cloud-sdk-core.baseservice.default_service_url.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [DEFAULT\_SERVICE\_URL](./ibm-cloud-sdk-core.baseservice.default_service_url.md)
+
+## BaseService.DEFAULT\_SERVICE\_URL property
+
+<b>Signature:</b>
+
+```typescript
+static DEFAULT_SERVICE_URL: string;
+```

package/build/docs/ibm-cloud-sdk-core.baseservice.disableretries.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [disableRetries](./ibm-cloud-sdk-core.baseservice.disableretries.md)
+
+## BaseService.disableRetries() method
+
+Disables retries.
+
+<b>Signature:</b>
+
+```typescript
+disableRetries(): void;
+```
+<b>Returns:</b>
+
+void
+

package/build/docs/ibm-cloud-sdk-core.baseservice.enableretries.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [enableRetries](./ibm-cloud-sdk-core.baseservice.enableretries.md)
+
+## BaseService.enableRetries() method
+
+Enable retries for unfulfilled requests.
+
+<b>Signature:</b>
+
+```typescript
+enableRetries(retryOptions?: RetryOptions): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  retryOptions | RetryOptions | <i>(Optional)</i> configuration for retries |
+
+<b>Returns:</b>
+
+void
+

package/build/docs/ibm-cloud-sdk-core.baseservice.getauthenticator.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [getAuthenticator](./ibm-cloud-sdk-core.baseservice.getauthenticator.md)
+
+## BaseService.getAuthenticator() method
+
+Get the instance of the authenticator set on the service.
+
+<b>Signature:</b>
+
+```typescript
+getAuthenticator(): any;
+```
+<b>Returns:</b>
+
+any
+
+{<!-- -->Authenticator<!-- -->}
+