ibm-cloud-sdk-core 3.0.1 → 3.1.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [3.1.0](https://github.com/IBM/node-sdk-core/compare/v3.0.1...v3.1.0) (2022-07-28)
+
+
+### Features
+
+* add `setDefaultHeaders` method on base service class ([#207](https://github.com/IBM/node-sdk-core/issues/207)) ([29bec13](https://github.com/IBM/node-sdk-core/commit/29bec13b67ea08071be488af62b919899f21ec50))
+
 ## [3.0.1](https://github.com/IBM/node-sdk-core/compare/v3.0.0...v3.0.1) (2022-07-28)
 
 

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

@@ -38,6 +38,7 @@ export declare class BaseService
 |  [enableRetries(retryOptions)](./ibm-cloud-sdk-core.baseservice.enableretries.md) |  | Enable retries for unfulfilled requests. |
 |  [getAuthenticator()](./ibm-cloud-sdk-core.baseservice.getauthenticator.md) |  | Get the instance of the authenticator set on the service. |
 |  [getHttpClient()](./ibm-cloud-sdk-core.baseservice.gethttpclient.md) |  | Get the Axios instance set on the service. All requests will be made using this instance. |
+|  [setDefaultHeaders(headers)](./ibm-cloud-sdk-core.baseservice.setdefaultheaders.md) |  | Set the HTTP headers to be sent in every request. |
 |  [setEnableGzipCompression(setting)](./ibm-cloud-sdk-core.baseservice.setenablegzipcompression.md) |  | Turn request body compression on or off. |
 |  [setServiceUrl(url)](./ibm-cloud-sdk-core.baseservice.setserviceurl.md) |  | Set the service URL to send requests to. |
 

package/build/docs/ibm-cloud-sdk-core.baseservice.setdefaultheaders.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; [setDefaultHeaders](./ibm-cloud-sdk-core.baseservice.setdefaultheaders.md)
+
+## BaseService.setDefaultHeaders() method
+
+Set the HTTP headers to be sent in every request.
+
+<b>Signature:</b>
+
+```typescript
+setDefaultHeaders(headers: OutgoingHttpHeaders): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  headers | OutgoingHttpHeaders | The map of headers to include in requests. |
+
+<b>Returns:</b>
+
+void
+

package/docs/ibm-cloud-sdk-core.api.json

@@ -1088,6 +1088,53 @@
               "parameters": [],
               "name": "getHttpClient"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "ibm-cloud-sdk-core!BaseService#setDefaultHeaders:member(1)",
+              "docComment": "/**\n * Set the HTTP headers to be sent in every request.\n *\n * @param headers - The map of headers to include in requests.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setDefaultHeaders(headers: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "OutgoingHttpHeaders",
+                  "canonicalReference": "!\"\\\"http\\\"\".OutgoingHttpHeaders:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "headers",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "setDefaultHeaders"
+            },
             {
               "kind": "Method",
               "canonicalReference": "ibm-cloud-sdk-core!BaseService#setEnableGzipCompression:member(1)",

package/es/lib/base-service.d.ts

@@ -87,6 +87,12 @@ export declare class BaseService {
      * @param {string} url The base URL for the service.
      */
     setServiceUrl(url: string): void;
+    /**
+     * Set the HTTP headers to be sent in every request.
+     *
+     * @param {OutgoingHttpHeaders} headers The map of headers to include in requests.
+     */
+    setDefaultHeaders(headers: OutgoingHttpHeaders): void;
     /**
      * Turn request body compression on or off.
      *

package/es/lib/base-service.js

@@ -90,6 +90,18 @@ export class BaseService {
             this.baseOptions.serviceUrl = stripTrailingSlash(url);
         }
     }
+    /**
+     * Set the HTTP headers to be sent in every request.
+     *
+     * @param {OutgoingHttpHeaders} headers The map of headers to include in requests.
+     */
+    setDefaultHeaders(headers) {
+        if (typeof headers !== 'object') {
+            // do nothing, for now
+            return;
+        }
+        this.baseOptions.headers = headers;
+    }
     /**
      * Turn request body compression on or off.
      *

package/etc/ibm-cloud-sdk-core.api.md

@@ -64,6 +64,7 @@ export class BaseService {
     enableRetries(retryOptions?: RetryOptions): void;
     getAuthenticator(): any;
     getHttpClient(): AxiosInstance;
+    setDefaultHeaders(headers: OutgoingHttpHeaders): void;
     setEnableGzipCompression(setting: boolean): void;
     setServiceUrl(url: string): void;
 }

package/ibm-cloud-sdk-core.d.ts

@@ -158,6 +158,12 @@ export declare class BaseService {
       * @param {string} url The base URL for the service.
       */
      setServiceUrl(url: string): void;
+     /**
+      * Set the HTTP headers to be sent in every request.
+      *
+      * @param {OutgoingHttpHeaders} headers The map of headers to include in requests.
+      */
+     setDefaultHeaders(headers: OutgoingHttpHeaders): void;
      /**
       * Turn request body compression on or off.
       *

package/lib/base-service.d.ts

@@ -87,6 +87,12 @@ export declare class BaseService {
      * @param {string} url The base URL for the service.
      */
     setServiceUrl(url: string): void;
+    /**
+     * Set the HTTP headers to be sent in every request.
+     *
+     * @param {OutgoingHttpHeaders} headers The map of headers to include in requests.
+     */
+    setDefaultHeaders(headers: OutgoingHttpHeaders): void;
     /**
      * Turn request body compression on or off.
      *

package/lib/base-service.js

@@ -106,6 +106,18 @@ var BaseService = /** @class */ (function () {
             this.baseOptions.serviceUrl = helper_1.stripTrailingSlash(url);
         }
     };
+    /**
+     * Set the HTTP headers to be sent in every request.
+     *
+     * @param {OutgoingHttpHeaders} headers The map of headers to include in requests.
+     */
+    BaseService.prototype.setDefaultHeaders = function (headers) {
+        if (typeof headers !== 'object') {
+            // do nothing, for now
+            return;
+        }
+        this.baseOptions.headers = headers;
+    };
     /**
      * Turn request body compression on or off.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ibm-cloud-sdk-core",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
   "main": "index.js",
   "typings": "./es/index.d.ts",

package/temp/ibm-cloud-sdk-core.api.json

@@ -1088,6 +1088,53 @@
               "parameters": [],
               "name": "getHttpClient"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "ibm-cloud-sdk-core!BaseService#setDefaultHeaders:member(1)",
+              "docComment": "/**\n * Set the HTTP headers to be sent in every request.\n *\n * @param headers - The map of headers to include in requests.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "setDefaultHeaders(headers: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "OutgoingHttpHeaders",
+                  "canonicalReference": "!\"\\\"http\\\"\".OutgoingHttpHeaders:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "headers",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "setDefaultHeaders"
+            },
             {
               "kind": "Method",
               "canonicalReference": "ibm-cloud-sdk-core!BaseService#setEnableGzipCompression:member(1)",

package/temp/ibm-cloud-sdk-core.api.md

@@ -64,6 +64,7 @@ export class BaseService {
     enableRetries(retryOptions?: RetryOptions): void;
     getAuthenticator(): any;
     getHttpClient(): AxiosInstance;
+    setDefaultHeaders(headers: OutgoingHttpHeaders): void;
     setEnableGzipCompression(setting: boolean): void;
     setServiceUrl(url: string): void;
 }