ibm-cloud-sdk-core 4.3.2-beta-2 → 4.3.2

package/build/docs/ibm-cloud-sdk-core.baseservice.setdefaultheaders.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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [setDefaultHeaders](./ibm-cloud-sdk-core.baseservice.setdefaultheaders.md)
+
+## BaseService.setDefaultHeaders() method
+
+Set the HTTP headers to be sent in every request.
+
+**Signature:**
+
+```typescript
+setDefaultHeaders(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 map of headers to include in requests.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/build/docs/ibm-cloud-sdk-core.baseservice.setenablegzipcompression.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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [setEnableGzipCompression](./ibm-cloud-sdk-core.baseservice.setenablegzipcompression.md)
+
+## BaseService.setEnableGzipCompression() method
+
+Turn request body compression on or off.
+
+**Signature:**
+
+```typescript
+setEnableGzipCompression(setting: boolean): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+setting
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+Will turn it on if 'true', off if 'false'.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

package/build/docs/ibm-cloud-sdk-core.baseservice.setserviceurl.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; [BaseService](./ibm-cloud-sdk-core.baseservice.md) &gt; [setServiceUrl](./ibm-cloud-sdk-core.baseservice.setserviceurl.md)
+
+## BaseService.setServiceUrl() method
+
+Set the service URL to send requests to.
+
+**Signature:**
+
+```typescript
+setServiceUrl(url: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+url
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the base URL for the service.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

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

@@ -0,0 +1,54 @@
+<!-- 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; [BasicAuthenticator](./ibm-cloud-sdk-core.basicauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.basicauthenticator._constructor_.md)
+
+## BasicAuthenticator.(constructor)
+
+Create a new BasicAuthenticator instance.
+
+**Signature:**
+
+```typescript
+constructor(options: Options);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+Options
+
+
+</td><td>
+
+Configuration options for basic authentication. This should be an object containing these fields: - username: the username portion of basic authentication - password: the password portion of basic authentication
+
+
+</td></tr>
+</tbody></table>
+
+## Exceptions
+
+Error: the configuration options are not valid.
+

package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authenticate.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; [BasicAuthenticator](./ibm-cloud-sdk-core.basicauthenticator.md) &gt; [authenticate](./ibm-cloud-sdk-core.basicauthenticator.authenticate.md)
+
+## BasicAuthenticator.authenticate() method
+
+Add basic authentication information to `requestOptions`<!-- -->. The basic authentication information will be set in the Authorization property of `requestOptions.headers` in the form:
+
+Authorization: Basic &lt;<!-- -->encoded username and password<!-- -->&gt;
+
+**Signature:**
+
+```typescript
+authenticate(requestOptions: AuthenticateOptions): Promise<void>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+requestOptions
+
+
+</td><td>
+
+AuthenticateOptions
+
+
+</td><td>
+
+The request to augment with authentication information.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+Promise&lt;void&gt;
+

package/build/docs/ibm-cloud-sdk-core.basicauthenticator.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; [BasicAuthenticator](./ibm-cloud-sdk-core.basicauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.basicauthenticator.authenticationtype.md)
+
+## BasicAuthenticator.authenticationType() method
+
+Returns the authenticator's type ('basic').
+
+**Signature:**
+
+```typescript
+authenticationType(): string;
+```
+**Returns:**
+
+string
+
+a string that indicates the authenticator's type
+

package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authheader.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; [BasicAuthenticator](./ibm-cloud-sdk-core.basicauthenticator.md) &gt; [authHeader](./ibm-cloud-sdk-core.basicauthenticator.authheader.md)
+
+## BasicAuthenticator.authHeader property
+
+**Signature:**
+
+```typescript
+protected authHeader: {
+        Authorization: string;
+    };
+```

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

@@ -0,0 +1,165 @@
+<!-- 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; [BasicAuthenticator](./ibm-cloud-sdk-core.basicauthenticator.md)
+
+## BasicAuthenticator class
+
+The BasicAuthenticator is used to add basic authentication information to requests.
+
+Basic Authorization will be sent as an Authorization header in the form:
+
+Authorization: Basic &lt;<!-- -->encoded username and password<!-- -->&gt;
+
+**Signature:**
+
+```typescript
+export declare class BasicAuthenticator extends Authenticator 
+```
+**Extends:** [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(options)](./ibm-cloud-sdk-core.basicauthenticator._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Create a new BasicAuthenticator instance.
+
+
+</td></tr>
+</tbody></table>
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[authHeader](./ibm-cloud-sdk-core.basicauthenticator.authheader.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+{ Authorization: string; }
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[requiredOptions](./ibm-cloud-sdk-core.basicauthenticator.requiredoptions.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[authenticate(requestOptions)](./ibm-cloud-sdk-core.basicauthenticator.authenticate.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Add basic authentication information to `requestOptions`<!-- -->. The basic authentication information will be set in the Authorization property of `requestOptions.headers` in the form:
+
+Authorization: Basic &lt;<!-- -->encoded username and password<!-- -->&gt;
+
+
+</td></tr>
+<tr><td>
+
+[authenticationType()](./ibm-cloud-sdk-core.basicauthenticator.authenticationtype.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Returns the authenticator's type ('basic').
+
+
+</td></tr>
+</tbody></table>

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

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

@@ -0,0 +1,54 @@
+<!-- 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; [BearerTokenAuthenticator](./ibm-cloud-sdk-core.bearertokenauthenticator.md) &gt; [(constructor)](./ibm-cloud-sdk-core.bearertokenauthenticator._constructor_.md)
+
+## BearerTokenAuthenticator.(constructor)
+
+Create a new BearerTokenAuthenticator instance.
+
+**Signature:**
+
+```typescript
+constructor(options: Options);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+options
+
+
+</td><td>
+
+Options
+
+
+</td><td>
+
+Configuration options for bearer authentication. This should be an object containing the "bearerToken" field.
+
+
+</td></tr>
+</tbody></table>
+
+## Exceptions
+
+Error: the options.bearerToken field is not valid, or unspecified
+

package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.authenticate.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; [BearerTokenAuthenticator](./ibm-cloud-sdk-core.bearertokenauthenticator.md) &gt; [authenticate](./ibm-cloud-sdk-core.bearertokenauthenticator.authenticate.md)
+
+## BearerTokenAuthenticator.authenticate() method
+
+Add a bearer token to `requestOptions`<!-- -->. The bearer token information will be set in the Authorization property of "requestOptions.headers" in the form:
+
+Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;
+
+**Signature:**
+
+```typescript
+authenticate(requestOptions: AuthenticateOptions): Promise<void>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+requestOptions
+
+
+</td><td>
+
+AuthenticateOptions
+
+
+</td><td>
+
+The request to augment with authentication information.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+Promise&lt;void&gt;
+

package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.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; [BearerTokenAuthenticator](./ibm-cloud-sdk-core.bearertokenauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.bearertokenauthenticator.authenticationtype.md)
+
+## BearerTokenAuthenticator.authenticationType() method
+
+Returns the authenticator's type ('bearertoken').
+
+**Signature:**
+
+```typescript
+authenticationType(): string;
+```
+**Returns:**
+
+string
+
+a string that indicates the authenticator's type
+