@equisoft/equisoft-connect-sdk-typescript 10.30.2-snapshot.20220916200413 → 10.31.0

package/src/models/MxValidateRecipientsResponse.ts

@@ -13,8 +13,8 @@
  */
 
 import { exists, mapValues } from '../runtime';
+import type { MxRecipient } from './MxRecipient';
 import {
-    MxRecipient,
     MxRecipientFromJSON,
     MxRecipientFromJSONTyped,
     MxRecipientToJSON,
@@ -34,6 +34,16 @@ export interface MxValidateRecipientsResponse {
     invalidRecipients: Array<MxRecipient>;
 }
 
+/**
+ * Check if a given object implements the MxValidateRecipientsResponse interface.
+ */
+export function instanceOfMxValidateRecipientsResponse(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "invalidRecipients" in value;
+
+    return isInstance;
+}
+
 export function MxValidateRecipientsResponseFromJSON(json: any): MxValidateRecipientsResponse {
     return MxValidateRecipientsResponseFromJSONTyped(json, false);
 }

package/src/models/RemoteaccountAccountSyncResponse.ts

@@ -13,8 +13,8 @@
  */
 
 import { exists, mapValues } from '../runtime';
+import type { RemoteaccountSyncStatus } from './RemoteaccountSyncStatus';
 import {
-    RemoteaccountSyncStatus,
     RemoteaccountSyncStatusFromJSON,
     RemoteaccountSyncStatusFromJSONTyped,
     RemoteaccountSyncStatusToJSON,
@@ -40,6 +40,15 @@ export interface RemoteaccountAccountSyncResponse {
     data?: RemoteaccountSyncStatus;
 }
 
+/**
+ * Check if a given object implements the RemoteaccountAccountSyncResponse interface.
+ */
+export function instanceOfRemoteaccountAccountSyncResponse(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
 export function RemoteaccountAccountSyncResponseFromJSON(json: any): RemoteaccountAccountSyncResponse {
     return RemoteaccountAccountSyncResponseFromJSONTyped(json, false);
 }

package/src/models/RemoteaccountSyncStatus.ts

@@ -13,8 +13,8 @@
  */
 
 import { exists, mapValues } from '../runtime';
+import type { RemoteaccountSyncTaskStatus } from './RemoteaccountSyncTaskStatus';
 import {
-    RemoteaccountSyncTaskStatus,
     RemoteaccountSyncTaskStatusFromJSON,
     RemoteaccountSyncTaskStatusFromJSONTyped,
     RemoteaccountSyncTaskStatusToJSON,
@@ -40,6 +40,15 @@ export interface RemoteaccountSyncStatus {
     errors?: Array<string>;
 }
 
+/**
+ * Check if a given object implements the RemoteaccountSyncStatus interface.
+ */
+export function instanceOfRemoteaccountSyncStatus(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
 export function RemoteaccountSyncStatusFromJSON(json: any): RemoteaccountSyncStatus {
     return RemoteaccountSyncStatusFromJSONTyped(json, false);
 }

package/src/models/RemoteaccountSyncTaskStatus.ts

@@ -33,6 +33,15 @@ export interface RemoteaccountSyncTaskStatus {
     status?: string;
 }
 
+/**
+ * Check if a given object implements the RemoteaccountSyncTaskStatus interface.
+ */
+export function instanceOfRemoteaccountSyncTaskStatus(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
 export function RemoteaccountSyncTaskStatusFromJSON(json: any): RemoteaccountSyncTaskStatus {
     return RemoteaccountSyncTaskStatusFromJSONTyped(json, false);
 }

package/src/models/TasksCreateTaskPayload.ts

@@ -99,6 +99,16 @@ export interface TasksCreateTaskPayload {
     isCompleted?: boolean;
 }
 
+/**
+ * Check if a given object implements the TasksCreateTaskPayload interface.
+ */
+export function instanceOfTasksCreateTaskPayload(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "subject" in value;
+
+    return isInstance;
+}
+
 export function TasksCreateTaskPayloadFromJSON(json: any): TasksCreateTaskPayload {
     return TasksCreateTaskPayloadFromJSONTyped(json, false);
 }

package/src/models/TasksCreateTaskResponse.ts

@@ -27,6 +27,16 @@ export interface TasksCreateTaskResponse {
     id: string;
 }
 
+/**
+ * Check if a given object implements the TasksCreateTaskResponse interface.
+ */
+export function instanceOfTasksCreateTaskResponse(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+
+    return isInstance;
+}
+
 export function TasksCreateTaskResponseFromJSON(json: any): TasksCreateTaskResponse {
     return TasksCreateTaskResponseFromJSONTyped(json, false);
 }

package/src/models/TasksListTaskResponse.ts

@@ -13,8 +13,8 @@
  */
 
 import { exists, mapValues } from '../runtime';
+import type { TasksTask } from './TasksTask';
 import {
-    TasksTask,
     TasksTaskFromJSON,
     TasksTaskFromJSONTyped,
     TasksTaskToJSON,
@@ -40,6 +40,16 @@ export interface TasksListTaskResponse {
     items: Array<TasksTask>;
 }
 
+/**
+ * Check if a given object implements the TasksListTaskResponse interface.
+ */
+export function instanceOfTasksListTaskResponse(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "items" in value;
+
+    return isInstance;
+}
+
 export function TasksListTaskResponseFromJSON(json: any): TasksListTaskResponse {
     return TasksListTaskResponseFromJSONTyped(json, false);
 }

package/src/models/TasksPatchTaskPayload.ts

@@ -87,6 +87,15 @@ export interface TasksPatchTaskPayload {
     contactIds?: Array<number>;
 }
 
+/**
+ * Check if a given object implements the TasksPatchTaskPayload interface.
+ */
+export function instanceOfTasksPatchTaskPayload(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
 export function TasksPatchTaskPayloadFromJSON(json: any): TasksPatchTaskPayload {
     return TasksPatchTaskPayloadFromJSONTyped(json, false);
 }

package/src/models/TasksPatchTaskResponse.ts

@@ -27,6 +27,16 @@ export interface TasksPatchTaskResponse {
     id: string;
 }
 
+/**
+ * Check if a given object implements the TasksPatchTaskResponse interface.
+ */
+export function instanceOfTasksPatchTaskResponse(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+
+    return isInstance;
+}
+
 export function TasksPatchTaskResponseFromJSON(json: any): TasksPatchTaskResponse {
     return TasksPatchTaskResponseFromJSONTyped(json, false);
 }

package/src/models/TasksPutTaskLinkDocumentsPayload.ts

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Equisoft /connect API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: latest
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface TasksPutTaskLinkDocumentsPayload
+ */
+export interface TasksPutTaskLinkDocumentsPayload {
+    /**
+     * Ids of the documents to link to the task.
+     * @type {Array<number>}
+     * @memberof TasksPutTaskLinkDocumentsPayload
+     */
+    documentIds: Array<number>;
+}
+
+/**
+ * Check if a given object implements the TasksPutTaskLinkDocumentsPayload interface.
+ */
+export function instanceOfTasksPutTaskLinkDocumentsPayload(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "documentIds" in value;
+
+    return isInstance;
+}
+
+export function TasksPutTaskLinkDocumentsPayloadFromJSON(json: any): TasksPutTaskLinkDocumentsPayload {
+    return TasksPutTaskLinkDocumentsPayloadFromJSONTyped(json, false);
+}
+
+export function TasksPutTaskLinkDocumentsPayloadFromJSONTyped(json: any, ignoreDiscriminator: boolean): TasksPutTaskLinkDocumentsPayload {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'documentIds': json['documentIds'],
+    };
+}
+
+export function TasksPutTaskLinkDocumentsPayloadToJSON(value?: TasksPutTaskLinkDocumentsPayload | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'documentIds': value.documentIds,
+    };
+}
+

package/src/models/TasksTask.ts

@@ -13,14 +13,14 @@
  */
 
 import { exists, mapValues } from '../runtime';
+import type { AccessRights } from './AccessRights';
 import {
-    AccessRights,
     AccessRightsFromJSON,
     AccessRightsFromJSONTyped,
     AccessRightsToJSON,
 } from './AccessRights';
+import type { FieldValue } from './FieldValue';
 import {
-    FieldValue,
     FieldValueFromJSON,
     FieldValueFromJSONTyped,
     FieldValueToJSON,
@@ -128,6 +128,12 @@ export interface TasksTask {
      * @memberof TasksTask
      */
     contactIds?: Array<number>;
+    /**
+     * IDs of the documents linked to this Task
+     * @type {Array<number>}
+     * @memberof TasksTask
+     */
+    documentIds?: Array<number>;
     /**
      * 
      * @type {AccessRights}
@@ -136,6 +142,21 @@ export interface TasksTask {
     accessRights: AccessRights;
 }
 
+/**
+ * Check if a given object implements the TasksTask interface.
+ */
+export function instanceOfTasksTask(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "subject" in value;
+    isInstance = isInstance && "isCompleted" in value;
+    isInstance = isInstance && "priority" in value;
+    isInstance = isInstance && "visibility" in value;
+    isInstance = isInstance && "accessRights" in value;
+
+    return isInstance;
+}
+
 export function TasksTaskFromJSON(json: any): TasksTask {
     return TasksTaskFromJSONTyped(json, false);
 }
@@ -162,6 +183,7 @@ export function TasksTaskFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'updateTime': !exists(json, 'updateTime') ? undefined : (json['updateTime'] === null ? null : new Date(json['updateTime'])),
         'completionTime': !exists(json, 'completionTime') ? undefined : (json['completionTime'] === null ? null : new Date(json['completionTime'])),
         'contactIds': !exists(json, 'contactIds') ? undefined : json['contactIds'],
+        'documentIds': !exists(json, 'documentIds') ? undefined : json['documentIds'],
         'accessRights': AccessRightsFromJSON(json['accessRights']),
     };
 }
@@ -191,6 +213,7 @@ export function TasksTaskToJSON(value?: TasksTask | null): any {
         'updateTime': value.updateTime === undefined ? undefined : (value.updateTime === null ? null : value.updateTime.toISOString()),
         'completionTime': value.completionTime === undefined ? undefined : (value.completionTime === null ? null : value.completionTime.toISOString()),
         'contactIds': value.contactIds,
+        'documentIds': value.documentIds,
         'accessRights': AccessRightsToJSON(value.accessRights),
     };
 }

package/src/models/TasksTransferToCompletedResponse.ts

@@ -27,6 +27,16 @@ export interface TasksTransferToCompletedResponse {
     id: string;
 }
 
+/**
+ * Check if a given object implements the TasksTransferToCompletedResponse interface.
+ */
+export function instanceOfTasksTransferToCompletedResponse(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+
+    return isInstance;
+}
+
 export function TasksTransferToCompletedResponseFromJSON(json: any): TasksTransferToCompletedResponse {
     return TasksTransferToCompletedResponseFromJSONTyped(json, false);
 }

package/src/models/Translation.ts

@@ -33,6 +33,17 @@ export interface Translation {
     label: string;
 }
 
+/**
+ * Check if a given object implements the Translation interface.
+ */
+export function instanceOfTranslation(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "locale" in value;
+    isInstance = isInstance && "label" in value;
+
+    return isInstance;
+}
+
 export function TranslationFromJSON(json: any): Translation {
     return TranslationFromJSONTyped(json, false);
 }

package/src/models/UsersListUsersResponse.ts

@@ -13,8 +13,8 @@
  */
 
 import { exists, mapValues } from '../runtime';
+import type { UsersUser } from './UsersUser';
 import {
-    UsersUser,
     UsersUserFromJSON,
     UsersUserFromJSONTyped,
     UsersUserToJSON,
@@ -34,6 +34,16 @@ export interface UsersListUsersResponse {
     items: Array<UsersUser>;
 }
 
+/**
+ * Check if a given object implements the UsersListUsersResponse interface.
+ */
+export function instanceOfUsersListUsersResponse(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "items" in value;
+
+    return isInstance;
+}
+
 export function UsersListUsersResponseFromJSON(json: any): UsersListUsersResponse {
     return UsersListUsersResponseFromJSONTyped(json, false);
 }

package/src/models/UsersUpdateUserPayload.ts

@@ -27,6 +27,16 @@ export interface UsersUpdateUserPayload {
     role: string;
 }
 
+/**
+ * Check if a given object implements the UsersUpdateUserPayload interface.
+ */
+export function instanceOfUsersUpdateUserPayload(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "role" in value;
+
+    return isInstance;
+}
+
 export function UsersUpdateUserPayloadFromJSON(json: any): UsersUpdateUserPayload {
     return UsersUpdateUserPayloadFromJSONTyped(json, false);
 }

package/src/models/UsersUser.ts

@@ -69,6 +69,23 @@ export interface UsersUser {
     maxConcurrentAccess: number;
 }
 
+/**
+ * Check if a given object implements the UsersUser interface.
+ */
+export function instanceOfUsersUser(value: object): boolean {
+    let isInstance = true;
+    isInstance = isInstance && "id" in value;
+    isInstance = isInstance && "displayName" in value;
+    isInstance = isInstance && "email" in value;
+    isInstance = isInstance && "firstName" in value;
+    isInstance = isInstance && "lastName" in value;
+    isInstance = isInstance && "locale" in value;
+    isInstance = isInstance && "role" in value;
+    isInstance = isInstance && "maxConcurrentAccess" in value;
+
+    return isInstance;
+}
+
 export function UsersUserFromJSON(json: any): UsersUser {
     return UsersUserFromJSONTyped(json, false);
 }

package/src/models/index.ts

@@ -41,6 +41,7 @@ export * from './EventsListEventResponse';
 export * from './EventsOrderByType';
 export * from './EventsPatchEventPayload';
 export * from './EventsPatchEventResponse';
+export * from './EventsPutEventLinkDocumentsPayload';
 export * from './EventsTransferToCompletedResponse';
 export * from './EventsVisibilityType';
 export * from './FieldValue';
@@ -177,6 +178,7 @@ export * from './TasksListTaskResponse';
 export * from './TasksOrderByType';
 export * from './TasksPatchTaskPayload';
 export * from './TasksPatchTaskResponse';
+export * from './TasksPutTaskLinkDocumentsPayload';
 export * from './TasksTask';
 export * from './TasksTransferToCompletedResponse';
 export * from './TasksVisibilityType';

package/src/runtime.ts

@@ -113,7 +113,7 @@ export class BaseAPI {
         return this.withMiddleware<T>(...middlewares);
     }
 
-    protected async request(context: RequestOpts, initOverrides?: RequestInit | InitOverideFunction): Promise<Response> {
+    protected async request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response> {
         const { url, init } = await this.createFetchParams(context, initOverrides);
         const response = await this.fetchApi(url, init);
         if (response.status >= 200 && response.status < 300) {
@@ -122,7 +122,7 @@ export class BaseAPI {
         throw new ResponseError(response, 'Response returned an error code');
     }
 
-    private async createFetchParams(context: RequestOpts, initOverrides?: RequestInit | InitOverideFunction) {
+    private async createFetchParams(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction) {
         let url = this.configuration.basePath + context.path;
         if (context.query !== undefined && Object.keys(context.query).length !== 0) {
             // only add the querystring to the URL if there are query parameters.
@@ -177,7 +177,25 @@ export class BaseAPI {
                 }) || fetchParams;
             }
         }
-        let response = await (this.configuration.fetchApi || fetch)(fetchParams.url, fetchParams.init);
+        let response = undefined;
+        try {
+            response = await (this.configuration.fetchApi || fetch)(fetchParams.url, fetchParams.init);
+        } catch (e) {
+            for (const middleware of this.middleware) {
+                if (middleware.onError) {
+                    response = await middleware.onError({
+                        fetch: this.fetchApi,
+                        url: fetchParams.url,
+                        init: fetchParams.init,
+                        error: e,
+                        response: response ? response.clone() : undefined,
+                    }) || response;
+                }
+            }
+            if (response !== undefined) {
+                throw new FetchError(e, 'The request failed and the interceptors did not return an alternative response');
+            }
+        }
         for (const middleware of this.middleware) {
             if (middleware.post) {
                 response = await middleware.post({
@@ -218,6 +236,13 @@ export class ResponseError extends Error {
     }
 }
 
+export class FetchError extends Error {
+    name: "FetchError" = "FetchError";
+    constructor(public cause: unknown, msg?: string) {
+        super(msg);
+    }
+}
+
 export class RequiredError extends Error {
     name: "RequiredError" = "RequiredError";
     constructor(public field: string, msg?: string) {
@@ -242,7 +267,7 @@ export type HTTPBody = Json | FormData | URLSearchParams;
 export type HTTPRequestInit = { headers?: HTTPHeaders; method: HTTPMethod; credentials?: RequestCredentials; body?: HTTPBody }
 export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
 
-export type InitOverideFunction = (requestContext: { init: HTTPRequestInit, context: RequestOpts }) => Promise<RequestInit>
+export type InitOverrideFunction = (requestContext: { init: HTTPRequestInit, context: RequestOpts }) => Promise<RequestInit>
 
 export interface FetchParams {
     url: string;
@@ -269,7 +294,7 @@ export function querystring(params: HTTPQuery, prefix: string = ''): string {
         .join('&');
 }
 
-function querystringSingleKey(key: string, value: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery, keyPrefix: string = ''): string {
+function querystringSingleKey(key: string, value: string | number | null | undefined | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery, keyPrefix: string = ''): string {
     const fullKey = keyPrefix + (keyPrefix.length ? `[${key}]` : key);
     if (value instanceof Array) {
         const multiValue = value.map(singleValue => encodeURIComponent(String(singleValue)))
@@ -322,9 +347,18 @@ export interface ResponseContext {
     response: Response;
 }
 
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+
 export interface Middleware {
     pre?(context: RequestContext): Promise<FetchParams | void>;
     post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
 }
 
 export interface ApiResponse<T> {