fix: extend constructor options types to allow additional properties (#925)

dpopp07 · web-flow · commit 03d241a9af49 · 2019-08-05T11:11:18.000-05:00
* this will allow TypeScript users to use request parameters like the `axios` config properties. we support these in the code but not in the types

* bump core version to 0.3.4: this version includes the corresponding changes for allowing additional properties in the base service constructor
diff --git a/assistant/v1.ts b/assistant/v1.ts
@@ -3289,6 +3289,8 @@ namespace AssistantV1 {
     disable_ssl_verification?: boolean;
     use_unauthenticated?: boolean;
     headers?: OutgoingHttpHeaders;
+    /** Allow additional request config parameters */
+    [propName: string]: any;
   }
 
   export interface Response<T = any>  {
diff --git a/assistant/v2.ts b/assistant/v2.ts
@@ -288,6 +288,8 @@ namespace AssistantV2 {
     disable_ssl_verification?: boolean;
     use_unauthenticated?: boolean;
     headers?: OutgoingHttpHeaders;
+    /** Allow additional request config parameters */
+    [propName: string]: any;
   }
 
   export interface Response<T = any>  {
diff --git a/authorization/v1.ts b/authorization/v1.ts
@@ -100,6 +100,8 @@ namespace AuthorizationV1 {
     url?: string;
     iam_apikey?: string;
     iam_url?: string;
+    /** Allow additional request config parameters */
+    [propName: string]: any;
   }
 
   export interface GetTokenResponse {
diff --git a/compare-comply/v1.ts b/compare-comply/v1.ts
@@ -906,6 +906,8 @@ namespace CompareComplyV1 {
     disable_ssl_verification?: boolean;
     use_unauthenticated?: boolean;
     headers?: OutgoingHttpHeaders;
+    /** Allow additional request config parameters */
+    [propName: string]: any;
   }
 
   export interface Response<T = any>  {
diff --git a/discovery/v1.ts b/discovery/v1.ts
@@ -4178,6 +4178,8 @@ namespace DiscoveryV1 {
     disable_ssl_verification?: boolean;
     use_unauthenticated?: boolean;
     headers?: OutgoingHttpHeaders;
+    /** Allow additional request config parameters */
+    [propName: string]: any;
   }
 
   export interface Response<T = any>  {
diff --git a/language-translator/v3.ts b/language-translator/v3.ts
@@ -776,6 +776,8 @@ namespace LanguageTranslatorV3 {
     disable_ssl_verification?: boolean;
     use_unauthenticated?: boolean;
     headers?: OutgoingHttpHeaders;
+    /** Allow additional request config parameters */
+    [propName: string]: any;
   }
 
   export interface Response<T = any>  {
diff --git a/natural-language-classifier/v1.ts b/natural-language-classifier/v1.ts
@@ -420,6 +420,8 @@ namespace NaturalLanguageClassifierV1 {
     disable_ssl_verification?: boolean;
     use_unauthenticated?: boolean;
     headers?: OutgoingHttpHeaders;
+    /** Allow additional request config parameters */
+    [propName: string]: any;
   }
 
   export interface Response<T = any>  {
diff --git a/natural-language-understanding/v1.ts b/natural-language-understanding/v1.ts
@@ -287,6 +287,8 @@ namespace NaturalLanguageUnderstandingV1 {
     disable_ssl_verification?: boolean;
     use_unauthenticated?: boolean;
     headers?: OutgoingHttpHeaders;
+    /** Allow additional request config parameters */
+    [propName: string]: any;
   }
 
   export interface Response<T = any>  {
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -86,7 +86,7 @@
     "axios": "^0.18.0",
     "dotenv": "^6.2.0",
     "extend": "~3.0.2",
-    "ibm-cloud-sdk-core": "^0.3.3",
+    "ibm-cloud-sdk-core": "^0.3.4",
     "isstream": "~0.1.2",
     "object.pick": "~1.3.0",
     "snyk": "^1.192.4",
diff --git a/personality-insights/v3.ts b/personality-insights/v3.ts
@@ -332,6 +332,8 @@ namespace PersonalityInsightsV3 {
     disable_ssl_verification?: boolean;
     use_unauthenticated?: boolean;
     headers?: OutgoingHttpHeaders;
+    /** Allow additional request config parameters */
+    [propName: string]: any;
   }
 
   export interface Response<T = any>  {
diff --git a/speech-to-text/v1-generated.ts b/speech-to-text/v1-generated.ts
@@ -3509,6 +3509,8 @@ namespace SpeechToTextV1 {
     disable_ssl_verification?: boolean;
     use_unauthenticated?: boolean;
     headers?: OutgoingHttpHeaders;
+    /** Allow additional request config parameters */
+    [propName: string]: any;
   }
 
   export interface Response<T = any>  {
diff --git a/text-to-speech/v1-generated.ts b/text-to-speech/v1-generated.ts
@@ -1166,6 +1166,8 @@ namespace TextToSpeechV1 {
     disable_ssl_verification?: boolean;
     use_unauthenticated?: boolean;
     headers?: OutgoingHttpHeaders;
+    /** Allow additional request config parameters */
+    [propName: string]: any;
   }
 
   export interface Response<T = any>  {
diff --git a/tone-analyzer/v3.ts b/tone-analyzer/v3.ts
@@ -266,6 +266,8 @@ namespace ToneAnalyzerV3 {
     disable_ssl_verification?: boolean;
     use_unauthenticated?: boolean;
     headers?: OutgoingHttpHeaders;
+    /** Allow additional request config parameters */
+    [propName: string]: any;
   }
 
   export interface Response<T = any>  {
diff --git a/visual-recognition/v3.ts b/visual-recognition/v3.ts
@@ -706,6 +706,8 @@ namespace VisualRecognitionV3 {
     disable_ssl_verification?: boolean;
     use_unauthenticated?: boolean;
     headers?: OutgoingHttpHeaders;
+    /** Allow additional request config parameters */
+    [propName: string]: any;
   }
 
   export interface Response<T = any>  {

Original file line number	Diff line number	Diff line change
`@@ -3289,6 +3289,8 @@ namespace AssistantV1 {`
`3289`	`3289`	`disable_ssl_verification?: boolean;`
`3290`	`3290`	`use_unauthenticated?: boolean;`
`3291`	`3291`	`headers?: OutgoingHttpHeaders;`
	`3292`	`+ /** Allow additional request config parameters */`
	`3293`	`+ [propName: string]: any;`
`3292`	`3294`	`}`
`3293`	`3295`
`3294`	`3296`	`export interface Response<T = any> {`
Original file line number	Diff line number	Diff line change
`@@ -288,6 +288,8 @@ namespace AssistantV2 {`
`288`	`288`	`disable_ssl_verification?: boolean;`
`289`	`289`	`use_unauthenticated?: boolean;`
`290`	`290`	`headers?: OutgoingHttpHeaders;`
	`291`	`+ /** Allow additional request config parameters */`
	`292`	`+ [propName: string]: any;`
`291`	`293`	`}`
`292`	`294`
`293`	`295`	`export interface Response<T = any> {`
Original file line number	Diff line number	Diff line change
`@@ -100,6 +100,8 @@ namespace AuthorizationV1 {`
`100`	`100`	`url?: string;`
`101`	`101`	`iam_apikey?: string;`
`102`	`102`	`iam_url?: string;`
	`103`	`+ /** Allow additional request config parameters */`
	`104`	`+ [propName: string]: any;`
`103`	`105`	`}`
`104`	`106`
`105`	`107`	`export interface GetTokenResponse {`
Original file line number	Diff line number	Diff line change
`@@ -906,6 +906,8 @@ namespace CompareComplyV1 {`
`906`	`906`	`disable_ssl_verification?: boolean;`
`907`	`907`	`use_unauthenticated?: boolean;`
`908`	`908`	`headers?: OutgoingHttpHeaders;`
	`909`	`+ /** Allow additional request config parameters */`
	`910`	`+ [propName: string]: any;`
`909`	`911`	`}`
`910`	`912`
`911`	`913`	`export interface Response<T = any> {`
Original file line number	Diff line number	Diff line change
`@@ -4178,6 +4178,8 @@ namespace DiscoveryV1 {`
`4178`	`4178`	`disable_ssl_verification?: boolean;`
`4179`	`4179`	`use_unauthenticated?: boolean;`
`4180`	`4180`	`headers?: OutgoingHttpHeaders;`
	`4181`	`+ /** Allow additional request config parameters */`
	`4182`	`+ [propName: string]: any;`
`4181`	`4183`	`}`
`4182`	`4184`
`4183`	`4185`	`export interface Response<T = any> {`
Original file line number	Diff line number	Diff line change
`@@ -776,6 +776,8 @@ namespace LanguageTranslatorV3 {`
`776`	`776`	`disable_ssl_verification?: boolean;`
`777`	`777`	`use_unauthenticated?: boolean;`
`778`	`778`	`headers?: OutgoingHttpHeaders;`
	`779`	`+ /** Allow additional request config parameters */`
	`780`	`+ [propName: string]: any;`
`779`	`781`	`}`
`780`	`782`
`781`	`783`	`export interface Response<T = any> {`
Original file line number	Diff line number	Diff line change
`@@ -420,6 +420,8 @@ namespace NaturalLanguageClassifierV1 {`
`420`	`420`	`disable_ssl_verification?: boolean;`
`421`	`421`	`use_unauthenticated?: boolean;`
`422`	`422`	`headers?: OutgoingHttpHeaders;`
	`423`	`+ /** Allow additional request config parameters */`
	`424`	`+ [propName: string]: any;`
`423`	`425`	`}`
`424`	`426`
`425`	`427`	`export interface Response<T = any> {`
Original file line number	Diff line number	Diff line change
`@@ -287,6 +287,8 @@ namespace NaturalLanguageUnderstandingV1 {`
`287`	`287`	`disable_ssl_verification?: boolean;`
`288`	`288`	`use_unauthenticated?: boolean;`
`289`	`289`	`headers?: OutgoingHttpHeaders;`
	`290`	`+ /** Allow additional request config parameters */`
	`291`	`+ [propName: string]: any;`
`290`	`292`	`}`
`291`	`293`
`292`	`294`	`export interface Response<T = any> {`
Original file line number	Diff line number	Diff line change
`@@ -332,6 +332,8 @@ namespace PersonalityInsightsV3 {`
`332`	`332`	`disable_ssl_verification?: boolean;`
`333`	`333`	`use_unauthenticated?: boolean;`
`334`	`334`	`headers?: OutgoingHttpHeaders;`
	`335`	`+ /** Allow additional request config parameters */`
	`336`	`+ [propName: string]: any;`
`335`	`337`	`}`
`336`	`338`
`337`	`339`	`export interface Response<T = any> {`
Original file line number	Diff line number	Diff line change
`@@ -3509,6 +3509,8 @@ namespace SpeechToTextV1 {`
`3509`	`3509`	`disable_ssl_verification?: boolean;`
`3510`	`3510`	`use_unauthenticated?: boolean;`
`3511`	`3511`	`headers?: OutgoingHttpHeaders;`
	`3512`	`+ /** Allow additional request config parameters */`
	`3513`	`+ [propName: string]: any;`
`3512`	`3514`	`}`
`3513`	`3515`
`3514`	`3516`	`export interface Response<T = any> {`