Merge pull request #644 from HubSpot/feature/13.0.0

Feature/13.0.0

Author: ksvirkou-hubspot

.eslintrc.js

@@ -8,6 +8,6 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: '14.x'
+          node-version: '18.x'
       - run: npm install
       - run: npm run lint

.github/workflows/lint.yml

@@ -8,6 +8,6 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: '14.x'
+          node-version: '18.x'
       - run: npm install
       - run: npm run test

.github/workflows/test.yml

@@ -427,8 +427,8 @@ console.log(response);
 
 ## Reserved words
 
-The SDK has reserved words(e.g. `from`, `in`). [Full list of reserved words.](https://openapi-generator.tech/docs/generators/typescript#reserved-words)
-When you face with a reserved word you have to add `_` before the word(e.g. `_from`, `_in`).
+The SDK has reserved words(e.g. `from`, `in`, `delete`). [Full list of reserved words.](https://openapi-generator.tech/docs/generators/typescript#reserved-words)
+When you face with a reserved word you have to add `_` before the word(e.g. `_from`, `_in`, `_delete`).
 
 ```javascript
 const BatchInputPublicAssociation = {

CHANGELOG.md

@@ -17,8 +17,9 @@ import { CallbackCompletionRequest } from '../models/CallbackCompletionRequest';
 export class CallbacksApiRequestFactory extends BaseAPIRequestFactory {
 
     /**
-     * Completes a single callback
-     * @param callbackId 
+     * Complete a specific blocked action execution by ID.
+     * Completes a callback
+     * @param callbackId The ID of the action execution.
      * @param callbackCompletionRequest 
      */
     public async complete(callbackId: string, callbackCompletionRequest: CallbackCompletionRequest, _options?: Configuration): Promise<RequestContext> {
@@ -63,7 +64,7 @@ export class CallbacksApiRequestFactory extends BaseAPIRequestFactory {
             await authMethod?.applySecurityAuthentication(requestContext);
         }
 
-        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
+        const defaultAuth: SecurityAuthentication | undefined = _config?.authMethods?.default
         if (defaultAuth?.applySecurityAuthentication) {
             await defaultAuth?.applySecurityAuthentication(requestContext);
         }
@@ -72,7 +73,8 @@ export class CallbacksApiRequestFactory extends BaseAPIRequestFactory {
     }
 
     /**
-     * Completes a batch of callbacks
+     * Complete a batch of blocked action executions.
+     * Complete a batch of callbacks
      * @param batchInputCallbackCompletionBatchRequest 
      */
     public async completeBatch(batchInputCallbackCompletionBatchRequest: BatchInputCallbackCompletionBatchRequest, _options?: Configuration): Promise<RequestContext> {
@@ -110,7 +112,7 @@ export class CallbacksApiRequestFactory extends BaseAPIRequestFactory {
             await authMethod?.applySecurityAuthentication(requestContext);
         }
 
-        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
+        const defaultAuth: SecurityAuthentication | undefined = _config?.authMethods?.default
         if (defaultAuth?.applySecurityAuthentication) {
             await defaultAuth?.applySecurityAuthentication(requestContext);
         }

README.md

@@ -19,9 +19,10 @@ import { PublicActionDefinitionPatch } from '../models/PublicActionDefinitionPat
 export class DefinitionsApiRequestFactory extends BaseAPIRequestFactory {
 
     /**
-     * Archive an extension definition
-     * @param definitionId 
-     * @param appId 
+     * Delete an action definition by ID.
+     * Delete an action definition
+     * @param definitionId The ID of the custom action definition.
+     * @param appId The ID of the app.
      */
     public async archive(definitionId: string, appId: number, _options?: Configuration): Promise<RequestContext> {
         let _config = _options || this.configuration;
@@ -55,7 +56,7 @@ export class DefinitionsApiRequestFactory extends BaseAPIRequestFactory {
             await authMethod?.applySecurityAuthentication(requestContext);
         }
 
-        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
+        const defaultAuth: SecurityAuthentication | undefined = _config?.authMethods?.default
         if (defaultAuth?.applySecurityAuthentication) {
             await defaultAuth?.applySecurityAuthentication(requestContext);
         }
@@ -64,8 +65,9 @@ export class DefinitionsApiRequestFactory extends BaseAPIRequestFactory {
     }
 
     /**
-     * Create a new extension definition
-     * @param appId 
+     * Create a new custom workflow action.
+     * Create a new custom action definition
+     * @param appId The ID of the app.
      * @param publicActionDefinitionEgg 
      */
     public async create(appId: number, publicActionDefinitionEgg: PublicActionDefinitionEgg, _options?: Configuration): Promise<RequestContext> {
@@ -110,7 +112,7 @@ export class DefinitionsApiRequestFactory extends BaseAPIRequestFactory {
             await authMethod?.applySecurityAuthentication(requestContext);
         }
 
-        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
+        const defaultAuth: SecurityAuthentication | undefined = _config?.authMethods?.default
         if (defaultAuth?.applySecurityAuthentication) {
             await defaultAuth?.applySecurityAuthentication(requestContext);
         }
@@ -119,9 +121,10 @@ export class DefinitionsApiRequestFactory extends BaseAPIRequestFactory {
     }
 
     /**
-     * Get extension definition by Id
-     * @param definitionId 
-     * @param appId 
+     * Retrieve a custom workflow action definition by ID.
+     * Retrieve a custom action definition
+     * @param definitionId The ID of the custom action.
+     * @param appId The ID of the app.
      * @param archived Whether to return only results that have been archived.
      */
     public async getById(definitionId: string, appId: number, archived?: boolean, _options?: Configuration): Promise<RequestContext> {
@@ -162,7 +165,7 @@ export class DefinitionsApiRequestFactory extends BaseAPIRequestFactory {
             await authMethod?.applySecurityAuthentication(requestContext);
         }
 
-        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
+        const defaultAuth: SecurityAuthentication | undefined = _config?.authMethods?.default
         if (defaultAuth?.applySecurityAuthentication) {
             await defaultAuth?.applySecurityAuthentication(requestContext);
         }
@@ -171,8 +174,9 @@ export class DefinitionsApiRequestFactory extends BaseAPIRequestFactory {
     }
 
     /**
-     * Get paged extension definitions
-     * @param appId 
+     * Retrieve custom workflow action definitions by app ID.
+     * Retrieve custom action definitions
+     * @param appId The ID of the app.
      * @param limit The maximum number of results to display per page.
      * @param after The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.
      * @param archived Whether to return only results that have been archived.
@@ -220,7 +224,7 @@ export class DefinitionsApiRequestFactory extends BaseAPIRequestFactory {
             await authMethod?.applySecurityAuthentication(requestContext);
         }
 
-        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
+        const defaultAuth: SecurityAuthentication | undefined = _config?.authMethods?.default
         if (defaultAuth?.applySecurityAuthentication) {
             await defaultAuth?.applySecurityAuthentication(requestContext);
         }
@@ -229,9 +233,10 @@ export class DefinitionsApiRequestFactory extends BaseAPIRequestFactory {
     }
 
     /**
-     * Patch an existing extension definition
-     * @param definitionId 
-     * @param appId 
+     * Update an existing action definition by ID.
+     * Update an existing action definition
+     * @param definitionId The ID of the custom action definition.
+     * @param appId The ID of the app.
      * @param publicActionDefinitionPatch 
      */
     public async update(definitionId: string, appId: number, publicActionDefinitionPatch: PublicActionDefinitionPatch, _options?: Configuration): Promise<RequestContext> {
@@ -283,7 +288,7 @@ export class DefinitionsApiRequestFactory extends BaseAPIRequestFactory {
             await authMethod?.applySecurityAuthentication(requestContext);
         }
 
-        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
+        const defaultAuth: SecurityAuthentication | undefined = _config?.authMethods?.default
         if (defaultAuth?.applySecurityAuthentication) {
             await defaultAuth?.applySecurityAuthentication(requestContext);
         }

codegen/automation/actions/apis/CallbacksApi.ts

@@ -70,7 +70,7 @@ export class FunctionsApiRequestFactory extends BaseAPIRequestFactory {
             await authMethod?.applySecurityAuthentication(requestContext);
         }
 
-        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
+        const defaultAuth: SecurityAuthentication | undefined = _config?.authMethods?.default
         if (defaultAuth?.applySecurityAuthentication) {
             await defaultAuth?.applySecurityAuthentication(requestContext);
         }
@@ -79,10 +79,11 @@ export class FunctionsApiRequestFactory extends BaseAPIRequestFactory {
     }
 
     /**
+     * Delete a function within a given definition.
      * Delete a function for a definition
-     * @param definitionId 
-     * @param functionType 
-     * @param appId 
+     * @param definitionId The ID of the definition.
+     * @param functionType The type of function. Can be `PRE_ACTION_EXECUTION`, `PRE_FETCH_OPTIONS`, `POST_FETCH_OPTIONS`, `POST_ACTION_EXECUTION`.
+     * @param appId The ID of the app.
      */
     public async archiveByFunctionType(definitionId: string, functionType: 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS' | 'POST_FETCH_OPTIONS' | 'POST_ACTION_EXECUTION', appId: number, _options?: Configuration): Promise<RequestContext> {
         let _config = _options || this.configuration;
@@ -123,7 +124,7 @@ export class FunctionsApiRequestFactory extends BaseAPIRequestFactory {
             await authMethod?.applySecurityAuthentication(requestContext);
         }
 
-        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
+        const defaultAuth: SecurityAuthentication | undefined = _config?.authMethods?.default
         if (defaultAuth?.applySecurityAuthentication) {
             await defaultAuth?.applySecurityAuthentication(requestContext);
         }
@@ -132,11 +133,12 @@ export class FunctionsApiRequestFactory extends BaseAPIRequestFactory {
     }
 
     /**
-     * Insert a function for a definition
-     * @param definitionId 
-     * @param functionType 
-     * @param functionId 
-     * @param appId 
+     * Update a function for a given definition by ID.
+     * Update a function for a definition
+     * @param definitionId The ID of the definition.
+     * @param functionType The type of function. Can be &#x60;PRE_ACTION_EXECUTION&#x60;, &#x60;PRE_FETCH_OPTIONS&#x60;, &#x60;POST_FETCH_OPTIONS&#x60;, &#x60;POST_ACTION_EXECUTION&#x60;.
+     * @param functionId The ID of the function.
+     * @param appId The ID of the app.
      * @param body 
      */
     public async createOrReplace(definitionId: string, functionType: 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS' | 'POST_FETCH_OPTIONS' | 'POST_ACTION_EXECUTION', functionId: string, appId: number, body: string, _options?: Configuration): Promise<RequestContext> {
@@ -202,7 +204,7 @@ export class FunctionsApiRequestFactory extends BaseAPIRequestFactory {
             await authMethod?.applySecurityAuthentication(requestContext);
         }
 
-        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
+        const defaultAuth: SecurityAuthentication | undefined = _config?.authMethods?.default
         if (defaultAuth?.applySecurityAuthentication) {
             await defaultAuth?.applySecurityAuthentication(requestContext);
         }
@@ -211,10 +213,11 @@ export class FunctionsApiRequestFactory extends BaseAPIRequestFactory {
     }
 
     /**
+     * Add a function for a given definition.
      * Insert a function for a definition
-     * @param definitionId 
-     * @param functionType 
-     * @param appId 
+     * @param definitionId The ID of the definition.
+     * @param functionType The type of function. Can be &#x60;PRE_ACTION_EXECUTION&#x60;, &#x60;PRE_FETCH_OPTIONS&#x60;, &#x60;POST_FETCH_OPTIONS&#x60;, &#x60;POST_ACTION_EXECUTION&#x60;.
+     * @param appId The ID of the app.
      * @param body 
      */
     public async createOrReplaceByFunctionType(definitionId: string, functionType: 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS' | 'POST_FETCH_OPTIONS' | 'POST_ACTION_EXECUTION', appId: number, body: string, _options?: Configuration): Promise<RequestContext> {
@@ -273,7 +276,7 @@ export class FunctionsApiRequestFactory extends BaseAPIRequestFactory {
             await authMethod?.applySecurityAuthentication(requestContext);
         }
 
-        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
+        const defaultAuth: SecurityAuthentication | undefined = _config?.authMethods?.default
         if (defaultAuth?.applySecurityAuthentication) {
             await defaultAuth?.applySecurityAuthentication(requestContext);
         }
@@ -282,10 +285,10 @@ export class FunctionsApiRequestFactory extends BaseAPIRequestFactory {
     }
 
     /**
-     * Get all functions by a type for a given definition
-     * @param definitionId 
-     * @param functionType 
-     * @param appId 
+     * Retrieve functions by a type for a given definition
+     * @param definitionId The ID of the definition.
+     * @param functionType The type of function. Can be &#x60;PRE_ACTION_EXECUTION&#x60;, &#x60;PRE_FETCH_OPTIONS&#x60;, &#x60;POST_FETCH_OPTIONS&#x60;, &#x60;POST_ACTION_EXECUTION&#x60;.
+     * @param appId The ID of the app.
      */
     public async getByFunctionType(definitionId: string, functionType: 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS' | 'POST_FETCH_OPTIONS' | 'POST_ACTION_EXECUTION', appId: number, _options?: Configuration): Promise<RequestContext> {
         let _config = _options || this.configuration;
@@ -326,7 +329,7 @@ export class FunctionsApiRequestFactory extends BaseAPIRequestFactory {
             await authMethod?.applySecurityAuthentication(requestContext);
         }
 
-        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
+        const defaultAuth: SecurityAuthentication | undefined = _config?.authMethods?.default
         if (defaultAuth?.applySecurityAuthentication) {
             await defaultAuth?.applySecurityAuthentication(requestContext);
         }
@@ -335,11 +338,12 @@ export class FunctionsApiRequestFactory extends BaseAPIRequestFactory {
     }
 
     /**
-     * Get a function for a given definition
-     * @param definitionId 
-     * @param functionType 
-     * @param functionId 
-     * @param appId 
+     * Retrieve a specific function from a given definition.
+     * Retrieve a function from a given definition
+     * @param definitionId The ID of the definition.
+     * @param functionType The type of function. Can be &#x60;PRE_ACTION_EXECUTION&#x60;, &#x60;PRE_FETCH_OPTIONS&#x60;, &#x60;POST_FETCH_OPTIONS&#x60;, &#x60;POST_ACTION_EXECUTION&#x60;.
+     * @param functionId The ID of the function.
+     * @param appId The ID of the app.
      */
     public async getById(definitionId: string, functionType: 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS' | 'POST_FETCH_OPTIONS' | 'POST_ACTION_EXECUTION', functionId: string, appId: number, _options?: Configuration): Promise<RequestContext> {
         let _config = _options || this.configuration;
@@ -387,7 +391,7 @@ export class FunctionsApiRequestFactory extends BaseAPIRequestFactory {
             await authMethod?.applySecurityAuthentication(requestContext);
         }
 
-        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
+        const defaultAuth: SecurityAuthentication | undefined = _config?.authMethods?.default
         if (defaultAuth?.applySecurityAuthentication) {
             await defaultAuth?.applySecurityAuthentication(requestContext);
         }
@@ -396,9 +400,10 @@ export class FunctionsApiRequestFactory extends BaseAPIRequestFactory {
     }
 
     /**
-     * Get all functions for a given definition
-     * @param definitionId 
-     * @param appId 
+     * Retrieve all functions included in a definition.
+     * Retrieve functions for a given definition
+     * @param definitionId The ID of the definition.
+     * @param appId The ID of the app.
      */
     public async getPage(definitionId: string, appId: number, _options?: Configuration): Promise<RequestContext> {
         let _config = _options || this.configuration;
@@ -432,7 +437,7 @@ export class FunctionsApiRequestFactory extends BaseAPIRequestFactory {
             await authMethod?.applySecurityAuthentication(requestContext);
         }
 
-        const defaultAuth: SecurityAuthentication | undefined = _options?.authMethods?.default || this.configuration?.authMethods?.default
+        const defaultAuth: SecurityAuthentication | undefined = _config?.authMethods?.default
         if (defaultAuth?.applySecurityAuthentication) {
             await defaultAuth?.applySecurityAuthentication(requestContext);
         }