ibm-cloud-sdk-core 5.0.2 → 5.1.1

package/build/docs/ibm-cloud-sdk-core.tokenmanager.setheaders.md

@@ -0,0 +1,53 @@
+<!-- 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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [setHeaders](./ibm-cloud-sdk-core.tokenmanager.setheaders.md)
+
+## TokenManager.setHeaders() method
+
+Sets the headers to be included with each outbound request to the token server.
+
+**Signature:**
+
+```typescript
+setHeaders(headers: OutgoingHttpHeaders): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+headers
+
+
+</td><td>
+
+OutgoingHttpHeaders
+
+
+</td><td>
+
+the set of headers to send with each request to the token server
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/build/docs/ibm-cloud-sdk-core.tokenmanager.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [url](./ibm-cloud-sdk-core.tokenmanager.url.md)
+
+## TokenManager.url property
+
+**Signature:**
+
+```typescript
+protected url: string;
+```

package/build/docs/ibm-cloud-sdk-core.tokenmanager.useragent.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; [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md) &gt; [userAgent](./ibm-cloud-sdk-core.tokenmanager.useragent.md)
+
+## TokenManager.userAgent property
+
+**Signature:**
+
+```typescript
+protected userAgent: string;
+```

package/build/docs/ibm-cloud-sdk-core.tokenmanageroptions.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; [TokenManagerOptions](./ibm-cloud-sdk-core.tokenmanageroptions.md)
+
+## TokenManagerOptions type
+
+Configuration options for token retrieval.
+
+**Signature:**
+
+```typescript
+export type TokenManagerOptions = {
+    url?: string;
+    headers?: OutgoingHttpHeaders;
+    disableSslVerification?: boolean;
+    [propName: string]: any;
+};
+```

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

@@ -0,0 +1,66 @@
+<!-- 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; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md)
+
+## TokenRequestBasedAuthenticator class
+
+Class for common functionality shared by token-request authenticators. TokenRequestBasedAuthenticators use token managers to retrieve, store, and refresh tokens. Not intended to be used as stand-alone authenticator, but as base class to authenticators that have their own token manager implementations.
+
+The token will be added as an Authorization header in the form:
+
+Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;
+
+**Signature:**
+
+```typescript
+export declare class TokenRequestBasedAuthenticator extends TokenRequestBasedAuthenticatorImmutable 
+```
+**Extends:** TokenRequestBasedAuthenticatorImmutable
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[setDisableSslVerification(value)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Set the flag that indicates whether verification of the server's SSL certificate should be disabled or not.
+
+
+</td></tr>
+<tr><td>
+
+[setHeaders(headers)](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setheaders.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Set headers.
+
+
+</td></tr>
+</tbody></table>

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.md

@@ -0,0 +1,53 @@
+<!-- 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; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) &gt; [setDisableSslVerification](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.md)
+
+## TokenRequestBasedAuthenticator.setDisableSslVerification() method
+
+Set the flag that indicates whether verification of the server's SSL certificate should be disabled or not.
+
+**Signature:**
+
+```typescript
+setDisableSslVerification(value: boolean): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+value
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+a flag that indicates whether verification of the token server's SSL certificate should be disabled or not.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setheaders.md

@@ -0,0 +1,53 @@
+<!-- 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; [TokenRequestBasedAuthenticator](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md) &gt; [setHeaders](./ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setheaders.md)
+
+## TokenRequestBasedAuthenticator.setHeaders() method
+
+Set headers.
+
+**Signature:**
+
+```typescript
+setHeaders(headers: OutgoingHttpHeaders): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+headers
+
+
+</td><td>
+
+OutgoingHttpHeaders
+
+
+</td><td>
+
+a set of HTTP headers to be sent with each outbound token server request. Overwrites previous default headers.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

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

@@ -0,0 +1,55 @@
+<!-- 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; [toLowerKeys](./ibm-cloud-sdk-core.tolowerkeys.md)
+
+## toLowerKeys() function
+
+This function converts an object's keys to lower case. note: does not convert nested keys
+
+**Signature:**
+
+```typescript
+export declare function toLowerKeys(obj: Object): Object;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+obj
+
+
+</td><td>
+
+Object
+
+
+</td><td>
+
+The object to convert the keys of.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+Object
+
+the object with keys folded to lowercase
+

package/build/docs/ibm-cloud-sdk-core.useroptions.authenticator.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; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [authenticator](./ibm-cloud-sdk-core.useroptions.authenticator.md)
+
+## UserOptions.authenticator property
+
+The Authenticator object used to authenticate requests to the service
+
+**Signature:**
+
+```typescript
+authenticator?: AuthenticatorInterface;
+```

package/build/docs/ibm-cloud-sdk-core.useroptions.disablesslverification.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; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [disableSslVerification](./ibm-cloud-sdk-core.useroptions.disablesslverification.md)
+
+## UserOptions.disableSslVerification property
+
+Set to `true` to allow unauthorized requests - not recommended for production use.
+
+**Signature:**
+
+```typescript
+disableSslVerification?: boolean;
+```

package/build/docs/ibm-cloud-sdk-core.useroptions.headers.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; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [headers](./ibm-cloud-sdk-core.useroptions.headers.md)
+
+## UserOptions.headers property
+
+Default headers that shall be included with every request to the service.
+
+**Signature:**
+
+```typescript
+headers?: OutgoingHttpHeaders;
+```

package/build/docs/ibm-cloud-sdk-core.useroptions.jar.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; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [jar](./ibm-cloud-sdk-core.useroptions.jar.md)
+
+## UserOptions.jar property
+
+Set your own cookie jar object
+
+**Signature:**
+
+```typescript
+jar?: CookieJar | boolean;
+```

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

@@ -0,0 +1,171 @@
+<!-- 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; [UserOptions](./ibm-cloud-sdk-core.useroptions.md)
+
+## UserOptions interface
+
+Configuration values for a service.
+
+**Signature:**
+
+```typescript
+export interface UserOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[authenticator?](./ibm-cloud-sdk-core.useroptions.authenticator.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[AuthenticatorInterface](./ibm-cloud-sdk-core.authenticatorinterface.md)
+
+
+</td><td>
+
+_(Optional)_ The Authenticator object used to authenticate requests to the service
+
+
+</td></tr>
+<tr><td>
+
+[disableSslVerification?](./ibm-cloud-sdk-core.useroptions.disablesslverification.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ Set to `true` to allow unauthorized requests - not recommended for production use.
+
+
+</td></tr>
+<tr><td>
+
+[headers?](./ibm-cloud-sdk-core.useroptions.headers.md)
+
+
+</td><td>
+
+
+</td><td>
+
+OutgoingHttpHeaders
+
+
+</td><td>
+
+_(Optional)_ Default headers that shall be included with every request to the service.
+
+
+</td></tr>
+<tr><td>
+
+[jar?](./ibm-cloud-sdk-core.useroptions.jar.md)
+
+
+</td><td>
+
+
+</td><td>
+
+CookieJar \| boolean
+
+
+</td><td>
+
+_(Optional)_ Set your own cookie jar object
+
+
+</td></tr>
+<tr><td>
+
+[serviceUrl?](./ibm-cloud-sdk-core.useroptions.serviceurl.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The base url to use when contacting the service. The base url may differ between IBM Cloud regions.
+
+
+</td></tr>
+<tr><td>
+
+[url?](./ibm-cloud-sdk-core.useroptions.url.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ Deprecated. Use `serviceUrl` instead.
+
+
+</td></tr>
+<tr><td>
+
+[version?](./ibm-cloud-sdk-core.useroptions.version.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ The API version date to use with the service, in "YYYY-MM-DD" format.
+
+
+</td></tr>
+</tbody></table>

package/build/docs/ibm-cloud-sdk-core.useroptions.serviceurl.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; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [serviceUrl](./ibm-cloud-sdk-core.useroptions.serviceurl.md)
+
+## UserOptions.serviceUrl property
+
+The base url to use when contacting the service. The base url may differ between IBM Cloud regions.
+
+**Signature:**
+
+```typescript
+serviceUrl?: string;
+```

package/build/docs/ibm-cloud-sdk-core.useroptions.url.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; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [url](./ibm-cloud-sdk-core.useroptions.url.md)
+
+## UserOptions.url property
+
+Deprecated. Use `serviceUrl` instead.
+
+**Signature:**
+
+```typescript
+url?: string;
+```

package/build/docs/ibm-cloud-sdk-core.useroptions.version.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; [UserOptions](./ibm-cloud-sdk-core.useroptions.md) &gt; [version](./ibm-cloud-sdk-core.useroptions.version.md)
+
+## UserOptions.version property
+
+The API version date to use with the service, in "YYYY-MM-DD" format.
+
+**Signature:**
+
+```typescript
+version?: string;
+```

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

@@ -0,0 +1,73 @@
+<!-- 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; [validateInput](./ibm-cloud-sdk-core.validateinput.md)
+
+## validateInput() function
+
+Validates "options".
+
+**Signature:**
+
+```typescript
+export declare function validateInput(options: any, requiredOptions: string[]): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+a configuration options object
+
+
+</td></tr>
+<tr><td>
+
+requiredOptions
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+the list of properties that must be present in "options"
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+
+## Exceptions
+
+Error: "options" failed validation
+