ibm-cloud-sdk-core 5.1.0 → 5.1.1

package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticate.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; [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.
+
+**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 which authentication information is added (in the headers field).
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+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.
+
+**Signature:**
+
+```typescript
+authenticationType(): string;
+```
+**Returns:**
+
+string
+

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

@@ -0,0 +1,50 @@
+<!-- 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.
+
+**Signature:**
+
+```typescript
+export interface AuthenticatorInterface 
+```
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[authenticate(requestOptions)](./ibm-cloud-sdk-core.authenticatorinterface.authenticate.md)
+
+
+</td><td>
+
+Add authentication information to the specified request.
+
+
+</td></tr>
+<tr><td>
+
+[authenticationType()](./ibm-cloud-sdk-core.authenticatorinterface.authenticationtype.md)
+
+
+</td><td>
+
+Returns a string that indicates the authentication type.
+
+
+</td></tr>
+</tbody></table>

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

@@ -0,0 +1,49 @@
+<!-- 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.
+
+**Signature:**
+
+```typescript
+constructor(userOptions: UserOptions);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+userOptions
+
+
+</td><td>
+
+[UserOptions](./ibm-cloud-sdk-core.useroptions.md)
+
+
+</td><td>
+
+the configuration options to set on the service instance. This should be an object with the following fields: - authenticator: (required) an Object used to authenticate requests to the service. - serviceUrl: (optional) the base url to use when contacting the service. The base url may differ between IBM Cloud regions. - headers: (optional) a set of HTTP headers that should be included with every request sent to the service - disableSslVerification: (optional) a flag that indicates whether verification of the server's SSL certificate should be disabled or not.
+
+
+</td></tr>
+</tbody></table>

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
+
+**Signature:**
+
+```typescript
+protected baseOptions: BaseServiceOptions;
+```

package/build/docs/ibm-cloud-sdk-core.baseservice.configureservice.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; [configureService](./ibm-cloud-sdk-core.baseservice.configureservice.md)
+
+## BaseService.configureService() method
+
+Configure the service using external configuration
+
+**Signature:**
+
+```typescript
+protected configureService(serviceName: string): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+serviceName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+the name of the service. This will be used to read from external configuration.
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+void
+

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

@@ -0,0 +1,85 @@
+<!-- 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; [convertModel](./ibm-cloud-sdk-core.baseservice.convertmodel.md)
+
+## BaseService.convertModel() method
+
+Applies a given modifier function on a model object. Since the model object can be a map, or an array, or a model, these types needs different handling. Considering whether the input object is a map happens with an explicit parameter.
+
+**Signature:**
+
+```typescript
+static convertModel(input: any, converterFn: any, isMap?: boolean): any;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+input
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+the input model object
+
+
+</td></tr>
+<tr><td>
+
+converterFn
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+the function that is applied on the input object
+
+
+</td></tr>
+<tr><td>
+
+isMap
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ is `true` when the input object should be handled as a map
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+any
+

package/build/docs/ibm-cloud-sdk-core.baseservice.createrequest.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; [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.
+
+**Signature:**
+
+```typescript
+protected createRequest(parameters: any): Promise<any>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+parameters
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+Service request options passed in by user. This should be an object with the following fields: - options.method: the http method - options.url: the path portion of the URL to be appended to the serviceUrl - options.path: the path parameters to be inserted into the URL - options.qs: the querystring to be included in the URL - options.body: the data to be sent as the request body - options.form: an object containing the key/value pairs for a www-form-urlencoded request. - options.formData: an object containing the contents for a multipart/form-data request The following processing is performed on formData values: - string: no special processing -- the value is sent as is - object: the value is converted to a JSON string before insertion into the form body - NodeJS.ReadableStream\|Buffer\|FileWithMetadata: sent as a file, with any associated metadata - array: each element of the array is sent as a separate form part using any special processing as described above - defaultOptions.serviceUrl: the base URL of the service - defaultOptions.headers: additional HTTP headers to be sent with the request
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+Promise&lt;any&gt;
+
+a Promise
+

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

@@ -0,0 +1,87 @@
+<!-- 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; [createRequestAndDeserializeResponse](./ibm-cloud-sdk-core.baseservice.createrequestanddeserializeresponse.md)
+
+## BaseService.createRequestAndDeserializeResponse() method
+
+Wrapper around `createRequest` that enforces arrived response to be deserialized.
+
+**Signature:**
+
+```typescript
+protected createRequestAndDeserializeResponse(parameters: any, deserializerFn: (any: any) => any, isMap?: boolean): Promise<any>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+parameters
+
+
+</td><td>
+
+any
+
+
+</td><td>
+
+see `parameters` in `createRequest`
+
+
+</td></tr>
+<tr><td>
+
+deserializerFn
+
+
+</td><td>
+
+(any: any) =&gt; any
+
+
+</td><td>
+
+the deserializer function that is applied on the response object
+
+
+</td></tr>
+<tr><td>
+
+isMap
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ is `true` when the response object should be handled as a map
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+Promise&lt;any&gt;
+
+a Promise
+

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
+
+**Signature:**
+
+```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
+
+**Signature:**
+
+```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.
+
+**Signature:**
+
+```typescript
+disableRetries(): void;
+```
+**Returns:**
+
+void
+

package/build/docs/ibm-cloud-sdk-core.baseservice.enableretries.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; [enableRetries](./ibm-cloud-sdk-core.baseservice.enableretries.md)
+
+## BaseService.enableRetries() method
+
+Enable retries for unfulfilled requests.
+
+**Signature:**
+
+```typescript
+enableRetries(retryOptions?: RetryOptions): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+retryOptions
+
+
+</td><td>
+
+RetryOptions
+
+
+</td><td>
+
+_(Optional)_ the configuration for retries
+
+
+</td></tr>
+</tbody></table>
+**Returns:**
+
+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.
+
+**Signature:**
+
+```typescript
+getAuthenticator(): any;
+```
+**Returns:**
+
+any
+
+the Authenticator instance
+

package/build/docs/ibm-cloud-sdk-core.baseservice.gethttpclient.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; [getHttpClient](./ibm-cloud-sdk-core.baseservice.gethttpclient.md)
+
+## BaseService.getHttpClient() method
+
+Get the Axios instance set on the service. All requests will be made using this instance.
+
+**Signature:**
+
+```typescript
+getHttpClient(): import("axios").AxiosInstance;
+```
+**Returns:**
+
+import("axios").AxiosInstance
+