ibm-cloud-sdk-core 2.17.15 → 3.1.0

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

@@ -350,16 +350,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<void | "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Error",
-                  "canonicalReference": "!Error:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ">"
+                  "text": "<void>"
                 },
                 {
                   "kind": "Content",
@@ -370,7 +361,7 @@
               "isStatic": false,
               "returnTypeTokenRange": {
                 "startIndex": 3,
-                "endIndex": 7
+                "endIndex": 5
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -677,16 +668,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<void | "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Error",
-                  "canonicalReference": "!Error:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ">"
+                  "text": "<void>"
                 },
                 {
                   "kind": "Content",
@@ -696,7 +678,7 @@
               "isOptional": false,
               "returnTypeTokenRange": {
                 "startIndex": 3,
-                "endIndex": 7
+                "endIndex": 5
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -1106,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)",
@@ -1280,16 +1309,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<void | "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Error",
-                  "canonicalReference": "!Error:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ">"
+                  "text": "<void>"
                 },
                 {
                   "kind": "Content",
@@ -1300,7 +1320,7 @@
               "isStatic": false,
               "returnTypeTokenRange": {
                 "startIndex": 3,
-                "endIndex": 7
+                "endIndex": 5
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -1639,11 +1659,24 @@
               "kind": "Content",
               "text": "): "
             },
+            {
+              "kind": "Reference",
+              "text": "Promise",
+              "canonicalReference": "!Promise:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
             {
               "kind": "Reference",
               "text": "FileObject",
               "canonicalReference": "ibm-cloud-sdk-core!FileObject:interface"
             },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
             {
               "kind": "Content",
               "text": ";"
@@ -1651,7 +1684,7 @@
           ],
           "returnTypeTokenRange": {
             "startIndex": 3,
-            "endIndex": 4
+            "endIndex": 7
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -2589,8 +2622,8 @@
             },
             {
               "kind": "Reference",
-              "text": "Buffer",
-              "canonicalReference": "!Buffer:interface"
+              "text": "FileObject",
+              "canonicalReference": "ibm-cloud-sdk-core!FileObject:interface"
             },
             {
               "kind": "Content",
@@ -2607,8 +2640,8 @@
             },
             {
               "kind": "Reference",
-              "text": "FileObject",
-              "canonicalReference": "ibm-cloud-sdk-core!FileObject:interface"
+              "text": "Buffer",
+              "canonicalReference": "!Buffer:interface"
             },
             {
               "kind": "Content",
@@ -3185,9 +3218,14 @@
               "kind": "Content",
               "text": "): "
             },
+            {
+              "kind": "Reference",
+              "text": "Promise",
+              "canonicalReference": "!Promise:interface"
+            },
             {
               "kind": "Content",
-              "text": "string"
+              "text": "<string>"
             },
             {
               "kind": "Content",
@@ -3196,7 +3234,7 @@
           ],
           "returnTypeTokenRange": {
             "startIndex": 5,
-            "endIndex": 6
+            "endIndex": 7
           },
           "releaseTag": "Public",
           "overloadIndex": 1,
@@ -5892,16 +5930,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "<void | "
-                },
-                {
-                  "kind": "Reference",
-                  "text": "Error",
-                  "canonicalReference": "!Error:interface"
-                },
-                {
-                  "kind": "Content",
-                  "text": ">"
+                  "text": "<void>"
                 },
                 {
                   "kind": "Content",
@@ -5912,7 +5941,7 @@
               "isStatic": false,
               "returnTypeTokenRange": {
                 "startIndex": 3,
-                "endIndex": 7
+                "endIndex": 5
               },
               "releaseTag": "Public",
               "overloadIndex": 1,

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

@@ -21,7 +21,7 @@ export function atMostOne(a: any, b: any): boolean;
 export class Authenticator implements AuthenticatorInterface {
     constructor();
     // Warning: (ae-forgotten-export) The symbol "AuthenticateOptions" needs to be exported by the entry point index.d.ts
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     authenticationType(): string;
     static AUTHTYPE_BASIC: string;
     // (undocumented)
@@ -42,7 +42,7 @@ export class Authenticator implements AuthenticatorInterface {
 
 // @public
 export interface AuthenticatorInterface {
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     authenticationType(): string;
 }
 
@@ -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;
 }
@@ -72,7 +73,7 @@ export class BaseService {
 export class BasicAuthenticator extends Authenticator {
     // Warning: (ae-forgotten-export) The symbol "Options" needs to be exported by the entry point index.d.ts
     constructor(options: Options);
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     authenticationType(): string;
     // (undocumented)
     protected authHeader: {
@@ -94,7 +95,7 @@ export class BearerTokenAuthenticator extends Authenticator {
 }
 
 // @public
-export function buildRequestFileObject(fileParam: FileWithMetadata): FileObject;
+export function buildRequestFileObject(fileParam: FileWithMetadata): Promise<FileObject>;
 
 // @public
 export function checkCredentials(obj: any, credsToCheck: string[]): Error | null;
@@ -155,7 +156,7 @@ export class ContainerTokenManager extends IamRequestBasedTokenManager {
 
 // @public (undocumented)
 export const contentType: {
-    fromFilename: (file: String | File | Buffer | NodeJS.ReadableStream | FileObject) => string;
+    fromFilename: (file: String | File | FileObject | NodeJS.ReadableStream | Buffer) => string;
     fromHeader: (buffer: Buffer) => string;
 };
 
@@ -211,7 +212,7 @@ export interface FileWithMetadata {
 export function getAuthenticatorFromEnvironment(serviceName: string): Authenticator;
 
 // @public
-export function getContentType(inputData: NodeJS.ReadableStream | Buffer): string;
+export function getContentType(inputData: NodeJS.ReadableStream | Buffer): Promise<string>;
 
 // @public
 export function getCurrentTime(): number;
@@ -390,7 +391,7 @@ export type TokenManagerOptions = {
 export class TokenRequestBasedAuthenticator extends Authenticator {
     // Warning: (ae-forgotten-export) The symbol "BaseOptions" needs to be exported by the entry point index.d.ts
     constructor(options: BaseOptions);
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     // (undocumented)
     protected disableSslVerification: boolean;
     // (undocumented)