@epilot/email-settings-client 0.6.0 → 0.7.0

package/dist/definition.js

@@ -1 +1 @@
-(()=>{"use strict";var e={390:function(e,t,o){var n=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var i=n(o(466));t.default=i.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v1/email-settings":{"get":{"operationId":"getSettings","parameters":[{"name":"type","in":"query","required":true},{"name":"id","in":"query"}]},"post":{"operationId":"addSetting","requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteSetting","requestBody":{"content":{"application/json":{}}}}},"/v1/email-settings/{id}":{"post":{"operationId":"updateSetting","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}}}},"/v1/email-settings/domain":{"post":{"operationId":"addDomain","requestBody":{"content":{"application/json":{}}}},"delete":{"operationId":"deleteDomain","requestBody":{"content":{"application/json":{}}}}},"/v1/email-settings/domain/name-servers:verify":{"post":{"operationId":"verifyNameServers","requestBody":{"content":{"application/json":{}}}}},"/v1/email-settings/domain:verify":{"post":{"operationId":"verifyDomain","requestBody":{"content":{"application/json":{}}}}}},"components":{},"servers":[{"url":"https://email-settings.sls.epilot.io"}]}')}},t={},o=function o(n){var i=t[n];if(void 0!==i)return i.exports;var r=t[n]={exports:{}};return e[n].call(r.exports,r,r.exports,o),r.exports}(390),n=exports;for(var i in o)n[i]=o[i];o.__esModule&&Object.defineProperty(n,"__esModule",{value:!0})})();
+(()=>{"use strict";var e={390:function(e,t,n){var o=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(t,"__esModule",{value:!0});var s=o(n(466));t.default=s.default},466:e=>{e.exports=JSON.parse('{"openapi":"3.0.3","info":{"title":"","version":""},"paths":{"/v2/email-settings/shared-inboxes/{id}":{"get":{"operationId":"getSharedInbox","parameters":[{"$ref":"#/components/parameters/SharedInboxId"}],"responses":{}},"delete":{"operationId":"deleteSharedInbox","parameters":[{"$ref":"#/components/parameters/SharedInboxId"}],"responses":{}},"put":{"operationId":"updateSharedInbox","parameters":[{"$ref":"#/components/parameters/SharedInboxId"}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v2/email-settings/shared-inboxes":{"get":{"operationId":"listSharedInboxes","responses":{}},"post":{"operationId":"addSharedInbox","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings":{"get":{"operationId":"getSettings","parameters":[{"name":"type","in":"query","required":true},{"name":"id","in":"query"}],"responses":{}},"post":{"operationId":"addSetting","requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteSetting","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings/{id}":{"post":{"operationId":"updateSetting","parameters":[{"name":"id","in":"path","required":true}],"requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings/domain":{"post":{"operationId":"addDomain","requestBody":{"content":{"application/json":{}}},"responses":{}},"delete":{"operationId":"deleteDomain","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings/domain/name-servers:verify":{"post":{"operationId":"verifyNameServers","requestBody":{"content":{"application/json":{}}},"responses":{}}},"/v1/email-settings/domain:verify":{"post":{"operationId":"verifyDomain","requestBody":{"content":{"application/json":{}}},"responses":{}}}},"components":{"responses":{"NoContent":{},"CreateSharedInboxSuccessResponse":{"content":{"application/json":{}}},"UpdateSharedInboxSuccessResponse":{"content":{"application/json":{}}},"GetSharedInboxSuccessResponse":{"content":{"application/json":{}}},"ListSharedInboxesSuccessResponse":{"content":{"application/json":{}}},"BadRequest":{"content":{"application/json":{}}},"Forbidden":{"content":{"application/json":{}}},"NotFound":{"content":{"application/json":{}}},"Conflict":{"content":{"application/json":{}}},"InternalServerError":{"content":{"application/json":{}}}},"parameters":{"SharedInboxId":{"name":"id","in":"path","required":true}}},"servers":[{"url":"https://email-settings.sls.epilot.io"}]}')}},t={},n=function n(o){var s=t[o];if(void 0!==s)return s.exports;var r=t[o]={exports:{}};return e[o].call(r.exports,r,r.exports,n),r.exports}(390),o=exports;for(var s in n)o[s]=n[s];n.__esModule&&Object.defineProperty(o,"__esModule",{value:!0})})();

package/dist/openapi.d.ts

@@ -9,7 +9,33 @@ import type {
 } from 'openapi-client-axios';
 
 declare namespace Components {
+    namespace Parameters {
+        export type SharedInboxId = string;
+    }
+    export interface PathParameters {
+        SharedInboxId?: Parameters.SharedInboxId;
+    }
+    namespace Responses {
+        export type BadRequest = Schemas.ErrorResponse;
+        export type Conflict = Schemas.ErrorResponse;
+        export type CreateSharedInboxSuccessResponse = Schemas.SharedInboxResponse;
+        export type Forbidden = Schemas.ErrorResponse;
+        export type GetSharedInboxSuccessResponse = Schemas.SharedInboxResponse;
+        export type InternalServerError = Schemas.ErrorResponse;
+        export type ListSharedInboxesSuccessResponse = Schemas.SharedInboxResponse[];
+        export interface NoContent {
+        }
+        export type NotFound = Schemas.ErrorResponse;
+        export type UpdateSharedInboxSuccessResponse = Schemas.SharedInboxResponse;
+    }
     namespace Schemas {
+        export interface CreateSharedInboxPayload {
+            id?: string;
+            color: string;
+            name: string;
+            assignees?: string[];
+            description?: string;
+        }
         export interface Domain {
             /**
              * example:
@@ -25,6 +51,10 @@ declare namespace Components {
          * Setting that allows to add a custom domain. For e.g; doe.com
          */
         export type EmailDomainSetting = "email_domain";
+        export interface ErrorResponse {
+            error: string;
+            status: number;
+        }
         /**
          * - Restrict duplicates within:
          *   * 10s
@@ -52,6 +82,13 @@ declare namespace Components {
             created_by?: string;
             updated_by?: string;
         }
+        export interface SettingMeta {
+            id: string;
+            created_at: string; // date-time
+            updated_at?: string; // date-time
+            created_by?: string;
+            updated_by?: string;
+        }
         export type SettingType = /* Setting that allows to add a signature. */ SignatureSetting | /* Setting that allows to add a custom domain. For e.g; doe.com */ EmailDomainSetting | /* Setting that allows to add an email address on the custom domain. For e.g; john@doe.com */ EmailAddressSetting | /**
          * - Setting that specifies a list of addresses exempt from being flagged as duplicate emails.
          * - An email will be flagged as a duplicate if it has the same content and is sent to the same recipient within the time frame specified in the RestrictDuplicatesWithinSetting.
@@ -72,10 +109,27 @@ declare namespace Components {
          */
         RestrictDuplicatesWithinSetting;
         export type SettingsResponse = Setting[] | Setting;
+        export interface SharedInboxResponse {
+            id: string;
+            created_at: string; // date-time
+            updated_at?: string; // date-time
+            created_by?: string;
+            updated_by?: string;
+            name: string;
+            color: string;
+            assignees: string[];
+            description?: string;
+        }
         /**
          * Setting that allows to add a signature.
          */
         export type SignatureSetting = "signature";
+        export interface UpdateSharedInboxPayload {
+            color?: string;
+            name?: string;
+            assignees?: string[];
+            description?: string;
+        }
         /**
          * - Setting that specifies a list of addresses exempt from being flagged as duplicate emails.
          * - An email will be flagged as a duplicate if it has the same content and is sent to the same recipient within the time frame specified in the RestrictDuplicatesWithinSetting.
@@ -105,6 +159,16 @@ declare namespace Paths {
             }
         }
     }
+    namespace AddSharedInbox {
+        export type RequestBody = Components.Schemas.CreateSharedInboxPayload;
+        namespace Responses {
+            export type $201 = Components.Responses.CreateSharedInboxSuccessResponse;
+            export type $400 = Components.Responses.BadRequest;
+            export type $403 = Components.Responses.Forbidden;
+            export type $409 = Components.Responses.Conflict;
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
     namespace DeleteDomain {
         export type RequestBody = Components.Schemas.Domain;
         namespace Responses {
@@ -134,6 +198,19 @@ declare namespace Paths {
             }
         }
     }
+    namespace DeleteSharedInbox {
+        namespace Parameters {
+            export type Id = string;
+        }
+        export interface PathParameters {
+            id: Parameters.Id;
+        }
+        namespace Responses {
+            export type $204 = Components.Responses.NoContent;
+            export type $403 = Components.Responses.Forbidden;
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
     namespace GetSettings {
         namespace Parameters {
             export type Id = string;
@@ -151,6 +228,27 @@ declare namespace Paths {
             }
         }
     }
+    namespace GetSharedInbox {
+        namespace Parameters {
+            export type Id = string;
+        }
+        export interface PathParameters {
+            id: Parameters.Id;
+        }
+        namespace Responses {
+            export type $200 = Components.Responses.GetSharedInboxSuccessResponse;
+            export type $403 = Components.Responses.Forbidden;
+            export type $404 = Components.Responses.NotFound;
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
+    namespace ListSharedInboxes {
+        namespace Responses {
+            export type $200 = Components.Responses.ListSharedInboxesSuccessResponse;
+            export type $403 = Components.Responses.Forbidden;
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
     namespace UpdateSetting {
         namespace Parameters {
             export type Id = string;
@@ -167,6 +265,23 @@ declare namespace Paths {
             }
         }
     }
+    namespace UpdateSharedInbox {
+        namespace Parameters {
+            export type Id = string;
+        }
+        export interface PathParameters {
+            id: Parameters.Id;
+        }
+        export type RequestBody = Components.Schemas.UpdateSharedInboxPayload;
+        namespace Responses {
+            export type $200 = Components.Responses.UpdateSharedInboxSuccessResponse;
+            export type $400 = Components.Responses.BadRequest;
+            export type $403 = Components.Responses.Forbidden;
+            export type $404 = Components.Responses.NotFound;
+            export type $409 = Components.Responses.Conflict;
+            export type $500 = Components.Responses.InternalServerError;
+        }
+    }
     namespace VerifyDomain {
         export type RequestBody = Components.Schemas.Domain;
         namespace Responses {
@@ -191,6 +306,56 @@ declare namespace Paths {
 
 
 export interface OperationMethods {
+  /**
+   * getSharedInbox - getSharedInbox
+   * 
+   * Get shared inbox
+   */
+  'getSharedInbox'(
+    parameters?: Parameters<Paths.GetSharedInbox.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.GetSharedInbox.Responses.$200>
+  /**
+   * updateSharedInbox - updateSharedInbox
+   * 
+   * Update shared inbox
+   */
+  'updateSharedInbox'(
+    parameters?: Parameters<Paths.UpdateSharedInbox.PathParameters> | null,
+    data?: Paths.UpdateSharedInbox.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.UpdateSharedInbox.Responses.$200>
+  /**
+   * deleteSharedInbox - deleteSharedInbox
+   * 
+   * Delete shared inbox
+   */
+  'deleteSharedInbox'(
+    parameters?: Parameters<Paths.DeleteSharedInbox.PathParameters> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.DeleteSharedInbox.Responses.$204>
+  /**
+   * listSharedInboxes - listSharedInboxes
+   * 
+   * List shared inboxes
+   */
+  'listSharedInboxes'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.ListSharedInboxes.Responses.$200>
+  /**
+   * addSharedInbox - addSharedInbox
+   * 
+   * Add shared inbox
+   */
+  'addSharedInbox'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.AddSharedInbox.RequestBody,
+    config?: AxiosRequestConfig  
+  ): OperationResponse<Paths.AddSharedInbox.Responses.$201>
   /**
    * getSettings - getSettings
    * 
@@ -274,6 +439,60 @@ export interface OperationMethods {
 }
 
 export interface PathsDictionary {
+  ['/v2/email-settings/shared-inboxes/{id}']: {
+    /**
+     * getSharedInbox - getSharedInbox
+     * 
+     * Get shared inbox
+     */
+    'get'(
+      parameters?: Parameters<Paths.GetSharedInbox.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.GetSharedInbox.Responses.$200>
+    /**
+     * deleteSharedInbox - deleteSharedInbox
+     * 
+     * Delete shared inbox
+     */
+    'delete'(
+      parameters?: Parameters<Paths.DeleteSharedInbox.PathParameters> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.DeleteSharedInbox.Responses.$204>
+    /**
+     * updateSharedInbox - updateSharedInbox
+     * 
+     * Update shared inbox
+     */
+    'put'(
+      parameters?: Parameters<Paths.UpdateSharedInbox.PathParameters> | null,
+      data?: Paths.UpdateSharedInbox.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.UpdateSharedInbox.Responses.$200>
+  }
+  ['/v2/email-settings/shared-inboxes']: {
+    /**
+     * listSharedInboxes - listSharedInboxes
+     * 
+     * List shared inboxes
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.ListSharedInboxes.Responses.$200>
+    /**
+     * addSharedInbox - addSharedInbox
+     * 
+     * Add shared inbox
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.AddSharedInbox.RequestBody,
+      config?: AxiosRequestConfig  
+    ): OperationResponse<Paths.AddSharedInbox.Responses.$201>
+  }
   ['/v1/email-settings']: {
     /**
      * getSettings - getSettings
@@ -369,12 +588,17 @@ export interface PathsDictionary {
 export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
 
 
+export type CreateSharedInboxPayload = Components.Schemas.CreateSharedInboxPayload;
 export type Domain = Components.Schemas.Domain;
 export type EmailAddressSetting = Components.Schemas.EmailAddressSetting;
 export type EmailDomainSetting = Components.Schemas.EmailDomainSetting;
+export type ErrorResponse = Components.Schemas.ErrorResponse;
 export type RestrictDuplicatesWithinSetting = Components.Schemas.RestrictDuplicatesWithinSetting;
 export type Setting = Components.Schemas.Setting;
+export type SettingMeta = Components.Schemas.SettingMeta;
 export type SettingType = Components.Schemas.SettingType;
 export type SettingsResponse = Components.Schemas.SettingsResponse;
+export type SharedInboxResponse = Components.Schemas.SharedInboxResponse;
 export type SignatureSetting = Components.Schemas.SignatureSetting;
+export type UpdateSharedInboxPayload = Components.Schemas.UpdateSharedInboxPayload;
 export type WhitelistEmailAddressSetting = Components.Schemas.WhitelistEmailAddressSetting;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@epilot/email-settings-client",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "API Client for epilot Email Settings API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -60,10 +60,10 @@
     "@types/jest": "^26.0.20",
     "axios": "^1.11.0",
     "copy-webpack-plugin": "^7.0.0",
-    "jest": "^26.6.3",
+    "jest": "^29.6.2",
     "json-loader": "^0.5.7",
     "openapicmd": "^2.7.0",
-    "ts-jest": "^26.5.0",
+    "ts-jest": "^29.4.1",
     "ts-loader": "^8.0.14",
     "ts-node": "^10.9.1",
     "typescript": "^4.1.3",