✨ add requestType to requestOptions

Provide a value that can be used to identify the type of request. Useful for error logs.

Author: Crhistian Ramirez

codegen/templates/api/Auth.ts

@@ -35,14 +35,17 @@ class Auth {
    * @param password of the user logging in
    * @param client_id of the application the user is logging into
    * @param scope roles being requested - space delimited string or array
+   * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
+   * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
    */
   public async Login(
     username: string,
     password: string,
     clientID: string,
     scope: ApiRole[],
-    options: {
+    requestOptions: {
       cancelToken?: CancelToken
+      requestType?: string
     } = {}
   ): Promise<RequiredDeep<AccessToken>> {
     if (!Array.isArray(scope)) {
@@ -62,7 +65,7 @@ class Auth {
           'Content-Type': 'application/x-www-form-urlencoded',
           Accept: 'application/json',
         },
-        ...options,
+        ...requestOptions,
       })
       .catch(e => {
         if (e.response) {
@@ -83,15 +86,18 @@ class Auth {
    * @param scope roles being requested - space delimited string or array
    * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
    * @param reportProgress flag to report request and response progress.
+   * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
+   * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
    */
   public async ElevatedLogin(
     clientSecret: string,
     username: string,
     password: string,
     clientID: string,
     scope: ApiRole[],
-    options: {
+    requestOptions: {
       cancelToken?: CancelToken
+      requestType?: string
     } = {}
   ): Promise<RequiredDeep<AccessToken>> {
     if (!Array.isArray(scope)) {
@@ -112,7 +118,7 @@ class Auth {
           'Content-Type': 'application/x-www-form-urlencoded',
           Accept: 'application/json',
         },
-        ...options,
+        ...requestOptions,
       })
       .catch(e => {
         if (e.response) {
@@ -131,13 +137,16 @@ class Auth {
    * @param scope roles being requested - space delimited string or array
    * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
    * @param reportProgress flag to report request and response progress.
+   * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
+   * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
    */
   public async ClientCredentials(
     clientSecret: string,
     clientID: string,
     scope: ApiRole[],
-    options: {
+    requestOptions: {
       cancelToken?: CancelToken
+      requestType?: string
     } = {}
   ): Promise<RequiredDeep<AccessToken>> {
     if (!Array.isArray(scope)) {
@@ -156,7 +165,7 @@ class Auth {
           'Content-Type': 'application/x-www-form-urlencoded',
           Accept: 'application/json',
         },
-        ...options,
+        ...requestOptions,
       })
       .catch(e => {
         if (e.response) {
@@ -172,14 +181,15 @@ class Auth {
    *
    * @param refreshToken of the application
    * @param clientID of the application the user is logging into
-   * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
-   * @param reportProgress flag to report request and response progress.
+   * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
+   * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
    */
   public async RefreshToken(
     refreshToken: string,
     clientID: string,
-    options: {
+    requestOptions: {
       cancelToken?: CancelToken
+      requestType?: string
     } = {}
   ): Promise<RequiredDeep<AccessToken>> {
     const body = {
@@ -194,7 +204,7 @@ class Auth {
           'Content-Type': 'application/x-www-form-urlencoded',
           Accept: 'application/json',
         },
-        ...options,
+        ...requestOptions,
       })
       .catch(e => {
         if (e.response) {
@@ -210,14 +220,15 @@ class Auth {
    *
    * @param clientID of the application the user is logging into
    * @param scope roles being requested - space delimited string or array
-   * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
-   * @param reportProgress flag to report request and response progress.
+   * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
+   * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
    */
   public async Anonymous(
     clientID: string,
     scope: ApiRole[],
-    options: {
+    requestOptions: {
       cancelToken?: CancelToken
+      requestType?: string
     } = {}
   ): Promise<RequiredDeep<AccessToken>> {
     if (!Array.isArray(scope)) {
@@ -235,7 +246,7 @@ class Auth {
           'Content-Type': 'application/x-www-form-urlencoded',
           Accept: 'application/json',
         },
-        ...options,
+        ...requestOptions,
       })
       .catch(e => {
         if (e.response) {

codegen/templates/api/_RESOURCE_.ts.hbs

@@ -29,6 +29,7 @@ class {{resource.id}} {
     * @param {{#if isQueryParam}}listOptions.{{name}} {{description}}{{else}}{{name}} {{description}}{{#if isBodyParam}}{{#if hasRequiredFields}}Required fields: {{commaSeparate requiredFields}}{{/if}}{{/if}}{{/if}}{{/allParams}}
     * @param requestOptions.accessToken Provide an alternative token to the one stored in the sdk instance (useful for impersonation).
     * @param requestOptions.cancelToken Provide an [axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
+    * @param requestOptions.requestType Provide a value that can be used to identify the type of request. Useful for error logs.
     */
     public async {{name}}({{#allParams}}{{#unless isQueryParam}}{{#if isBodyParam}}{{#if ../isPatch}}{{name}}: PartialDeep<{{typescriptType}}>, {{else}}{{name}}: {{typescriptType}},{{/if}}{{else}}{{name}}: {{typescriptType}}, {{/if}}{{/unless}}{{/allParams}}{{#if hasQueryParams}}listOptions?: { {{#queryParams}}{{#unless isFilter}}{{name}}?: {{typescriptType}}{{/unless}}{{#if isFilter}}filters?: Filters<Required<{{../returnType}}>>{{/if}}{{#unless @last}}, {{/unless}}{{/queryParams}} }, {{/if}}requestOptions?: RequestOptions ): Promise<{{#if hasReturnType}}RequiredDeep<{{#if isList}}{{#if isFacetList}}ListPageWithFacets<{{returnType}}>{{else}}ListPage<{{returnType}}>{{/if}}{{else}}{{returnType}}{{/if}}>{{else}}void{{/if}}>;
     public async {{name}}{{#if hasReturnType}}{{#if isList}}<T{{returnType}} extends {{returnType}}>{{else}}<T{{returnType}} extends {{returnType}}>{{/if}}{{/if}}({{#allParams}}{{#unless isQueryParam}}{{#if isBodyParam}}{{#if ../isPatch}}{{name}}: PartialDeep<{{typescriptType}}>, {{else}}{{name}}: {{typescriptType}},{{/if}}{{else}}{{name}}: {{typescriptType}}, {{/if}}{{/unless}}{{/allParams}}{{#if hasQueryParams}}listOptions?: { {{#queryParams}}{{#unless isFilter}}{{name}}?: {{typescriptType}}{{/unless}}{{#if isFilter}}filters?: Filters<Required<T{{../returnType}}>>{{/if}}{{#unless @last}}, {{/unless}}{{/queryParams}} }, {{/if}}requestOptions?: RequestOptions ): Promise<{{#if hasReturnType}}RequiredDeep<{{#if isList}}{{#if isFacetList}}ListPageWithFacets<T{{returnType}}>{{else}}ListPage<T{{returnType}}>{{/if}}{{else}}T{{returnType}}{{/if}}>{{else}}void{{/if}}>;

codegen/templates/models/RequestOptions.ts

@@ -1,6 +1,18 @@
 import { CancelToken } from 'axios'
 
 export interface RequestOptions {
+  /**
+   * Alternative token to the one stored in the sdk instance (useful for impersonation).
+   */
   accessToken?: string
+
+  /**
+   * [Axios cancelToken](https://github.com/axios/axios#cancellation) that can be used to cancel the request.
+   */
   cancelToken?: CancelToken
+
+  /**
+   * Identify the type of request. Useful for error logs.
+   */
+  requestType?: string
 }