@brifle/brifle-sdk 0.0.3 → 0.0.4

package/dist/cjs/api/api.d.ts

@@ -1,6 +1,7 @@
 import { AuthenticationEndpoints } from "../endpoints/v1/authentication";
 import { ContentEndpoints } from "../endpoints/v1/content";
 import { SignaturesEndpoint } from "../endpoints/v1/signatures";
+import { MailboxEndpoints } from "../endpoints/v1/mailbox";
 declare class ApiV1 {
     readonly endpoint: string;
     readonly apiState: ApiV1State;
@@ -22,6 +23,11 @@ declare class ApiV1 {
      * @returns ContentEndpoints
      */
     signature(): SignaturesEndpoint;
+    /**
+     * gets an instance of the MailboxEndpoints
+     * @returns MailboxEndpoints
+     */
+    mailbox(): MailboxEndpoints;
 }
 export interface ApiV1State {
     auth_token?: string;

package/dist/cjs/endpoints/v1/mailbox.d.ts

@@ -0,0 +1,18 @@
+import { ApiV1 } from "../../api/api";
+import { InboxFilter, OutboxFilter } from "./requests/mailbox";
+import { MailboxResponse } from "./responses/mailbox";
+import { ApiResponse } from "./apiResponse";
+declare class MailboxEndpoints {
+    private endpoint;
+    private readonly VERSION;
+    private state;
+    constructor(api: ApiV1);
+    private getPath;
+    /**
+     * Get the inbox of an account
+     * @returns the mailbox response object
+     */
+    getInbox(filter: InboxFilter, page?: number): Promise<ApiResponse<MailboxResponse>>;
+    getOutbox(tenant: string, filter: OutboxFilter, page?: number): Promise<ApiResponse<MailboxResponse>>;
+}
+export { MailboxEndpoints };

package/dist/cjs/endpoints/v1/requests/mailbox.d.ts

@@ -0,0 +1,10 @@
+interface InboxFilter {
+    state?: Array<'read' | 'unread' | 'trashed'>;
+    subject?: string;
+    sub_mailbox?: string;
+    type?: 'letter' | 'invoice' | 'contract';
+}
+interface OutboxFilter {
+    state?: Array<'active' | 'trashed'>;
+}
+export type { InboxFilter, OutboxFilter };

package/dist/cjs/endpoints/v1/responses/mailbox.d.ts

@@ -0,0 +1,21 @@
+interface MailboxResponse {
+    total: number;
+    results: Meta[];
+}
+interface Meta {
+    id: string;
+    sender: string;
+    receiver: string;
+    read: boolean;
+    read_date: string;
+    size: number;
+    type: string;
+    delivered: boolean;
+    delivered_date: string;
+    sent_date: string;
+    subject: string;
+    sender_state?: string;
+    receiver_state?: string;
+    size_responsive?: number;
+}
+export type { MailboxResponse, Meta };

package/dist/cjs/index.d.ts

@@ -9,3 +9,6 @@ export * from "./endpoints/v1/apiResponse";
 export * from "./endpoints/v1/authentication";
 export * from "./endpoints/v1/content";
 export * from "./endpoints/v1/signatures";
+export * from "./endpoints/v1/mailbox";
+export * from "./endpoints/v1/requests/mailbox";
+export * from "./endpoints/v1/responses/mailbox";

package/dist/cjs/index.js

@@ -254,6 +254,59 @@ class SignaturesEndpoint {
     }
 }
 
+class MailboxEndpoints {
+    constructor(api) {
+        this.VERSION = "v1";
+        this.endpoint = api.endpoint;
+        this.state = api.apiState;
+    }
+    getPath(path) {
+        return `${this.endpoint}/${this.VERSION}/mailbox/${path}`;
+    }
+    /**
+     * Get the inbox of an account
+     * @returns the mailbox response object
+     */
+    getInbox(filter, page = 1) {
+        const path = this.getPath(`inbox`);
+        const body = {
+            filter: filter,
+            page: page
+        };
+        return axios.post(path, body, {
+            headers: {
+                "Authorization": `Bearer ${this.state.auth_token}`,
+                "Content-Type": "application/json"
+            }
+        })
+            .then((response) => {
+            return ApiResponse.success(response.data);
+        })
+            .catch((error) => {
+            return ApiResponse.errorAxios(error);
+        });
+    }
+    getOutbox(tenant, filter, page = 1) {
+        const path = this.getPath(`outbox/${tenant}`);
+        const body = {
+            filter: filter,
+            page: page
+        };
+        return axios.post(path, body, {
+            headers: {
+                "Authorization": `Bearer ${this.state.auth_token}`,
+                "Content-Type": "application/json"
+            }
+        })
+            .then((response) => {
+            return ApiResponse.success(response.data);
+        })
+            .catch((error) => {
+            return ApiResponse.errorAxios(error);
+        });
+    }
+}
+
 var ENDPOINTS;
 (function (ENDPOINTS) {
     ENDPOINTS["SANDBOX"] = "https://sandbox-api.brifle.de";
@@ -296,11 +349,19 @@ class ApiV1 {
     signature() {
         return new SignaturesEndpoint(this);
     }
+    /**
+     * gets an instance of the MailboxEndpoints
+     * @returns MailboxEndpoints
+     */
+    mailbox() {
+        return new MailboxEndpoints(this);
+    }
 }
 
 exports.ApiResponse = ApiResponse;
 exports.ApiV1 = ApiV1;
 exports.AuthenticationEndpoints = AuthenticationEndpoints;
 exports.ContentEndpoints = ContentEndpoints;
+exports.MailboxEndpoints = MailboxEndpoints;
 exports.SignaturesEndpoint = SignaturesEndpoint;
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/esm/api/api.d.ts

@@ -1,6 +1,7 @@
 import { AuthenticationEndpoints } from "../endpoints/v1/authentication";
 import { ContentEndpoints } from "../endpoints/v1/content";
 import { SignaturesEndpoint } from "../endpoints/v1/signatures";
+import { MailboxEndpoints } from "../endpoints/v1/mailbox";
 declare class ApiV1 {
     readonly endpoint: string;
     readonly apiState: ApiV1State;
@@ -22,6 +23,11 @@ declare class ApiV1 {
      * @returns ContentEndpoints
      */
     signature(): SignaturesEndpoint;
+    /**
+     * gets an instance of the MailboxEndpoints
+     * @returns MailboxEndpoints
+     */
+    mailbox(): MailboxEndpoints;
 }
 export interface ApiV1State {
     auth_token?: string;

package/dist/esm/endpoints/v1/mailbox.d.ts

@@ -0,0 +1,18 @@
+import { ApiV1 } from "../../api/api";
+import { InboxFilter, OutboxFilter } from "./requests/mailbox";
+import { MailboxResponse } from "./responses/mailbox";
+import { ApiResponse } from "./apiResponse";
+declare class MailboxEndpoints {
+    private endpoint;
+    private readonly VERSION;
+    private state;
+    constructor(api: ApiV1);
+    private getPath;
+    /**
+     * Get the inbox of an account
+     * @returns the mailbox response object
+     */
+    getInbox(filter: InboxFilter, page?: number): Promise<ApiResponse<MailboxResponse>>;
+    getOutbox(tenant: string, filter: OutboxFilter, page?: number): Promise<ApiResponse<MailboxResponse>>;
+}
+export { MailboxEndpoints };

package/dist/esm/endpoints/v1/requests/mailbox.d.ts

@@ -0,0 +1,10 @@
+interface InboxFilter {
+    state?: Array<'read' | 'unread' | 'trashed'>;
+    subject?: string;
+    sub_mailbox?: string;
+    type?: 'letter' | 'invoice' | 'contract';
+}
+interface OutboxFilter {
+    state?: Array<'active' | 'trashed'>;
+}
+export type { InboxFilter, OutboxFilter };

package/dist/esm/endpoints/v1/responses/mailbox.d.ts

@@ -0,0 +1,21 @@
+interface MailboxResponse {
+    total: number;
+    results: Meta[];
+}
+interface Meta {
+    id: string;
+    sender: string;
+    receiver: string;
+    read: boolean;
+    read_date: string;
+    size: number;
+    type: string;
+    delivered: boolean;
+    delivered_date: string;
+    sent_date: string;
+    subject: string;
+    sender_state?: string;
+    receiver_state?: string;
+    size_responsive?: number;
+}
+export type { MailboxResponse, Meta };

package/dist/esm/index.d.ts

@@ -9,3 +9,6 @@ export * from "./endpoints/v1/apiResponse";
 export * from "./endpoints/v1/authentication";
 export * from "./endpoints/v1/content";
 export * from "./endpoints/v1/signatures";
+export * from "./endpoints/v1/mailbox";
+export * from "./endpoints/v1/requests/mailbox";
+export * from "./endpoints/v1/responses/mailbox";

package/dist/esm/index.mjs

@@ -252,6 +252,59 @@ class SignaturesEndpoint {
     }
 }
 
+class MailboxEndpoints {
+    constructor(api) {
+        this.VERSION = "v1";
+        this.endpoint = api.endpoint;
+        this.state = api.apiState;
+    }
+    getPath(path) {
+        return `${this.endpoint}/${this.VERSION}/mailbox/${path}`;
+    }
+    /**
+     * Get the inbox of an account
+     * @returns the mailbox response object
+     */
+    getInbox(filter, page = 1) {
+        const path = this.getPath(`inbox`);
+        const body = {
+            filter: filter,
+            page: page
+        };
+        return axios.post(path, body, {
+            headers: {
+                "Authorization": `Bearer ${this.state.auth_token}`,
+                "Content-Type": "application/json"
+            }
+        })
+            .then((response) => {
+            return ApiResponse.success(response.data);
+        })
+            .catch((error) => {
+            return ApiResponse.errorAxios(error);
+        });
+    }
+    getOutbox(tenant, filter, page = 1) {
+        const path = this.getPath(`outbox/${tenant}`);
+        const body = {
+            filter: filter,
+            page: page
+        };
+        return axios.post(path, body, {
+            headers: {
+                "Authorization": `Bearer ${this.state.auth_token}`,
+                "Content-Type": "application/json"
+            }
+        })
+            .then((response) => {
+            return ApiResponse.success(response.data);
+        })
+            .catch((error) => {
+            return ApiResponse.errorAxios(error);
+        });
+    }
+}
+
 var ENDPOINTS;
 (function (ENDPOINTS) {
     ENDPOINTS["SANDBOX"] = "https://sandbox-api.brifle.de";
@@ -294,7 +347,14 @@ class ApiV1 {
     signature() {
         return new SignaturesEndpoint(this);
     }
+    /**
+     * gets an instance of the MailboxEndpoints
+     * @returns MailboxEndpoints
+     */
+    mailbox() {
+        return new MailboxEndpoints(this);
+    }
 }
 
-export { ApiResponse, ApiV1, AuthenticationEndpoints, ContentEndpoints, SignaturesEndpoint };
+export { ApiResponse, ApiV1, AuthenticationEndpoints, ContentEndpoints, MailboxEndpoints, SignaturesEndpoint };
 //# sourceMappingURL=index.mjs.map

package/dist/esm/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}
+{"version":3,"file":"index.mjs","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;"}

package/dist/index.d.ts

@@ -278,6 +278,51 @@ declare class SignaturesEndpoint {
     exportSignature(signatureId: string, format: 'xml'): Promise<ApiResponse<any>>;
 }
 
+interface InboxFilter {
+    state?: Array<'read' | 'unread' | 'trashed'>;
+    subject?: string;
+    sub_mailbox?: string;
+    type?: 'letter' | 'invoice' | 'contract';
+}
+interface OutboxFilter {
+    state?: Array<'active' | 'trashed'>;
+}
+
+interface MailboxResponse {
+    total: number;
+    results: Meta[];
+}
+interface Meta {
+    id: string;
+    sender: string;
+    receiver: string;
+    read: boolean;
+    read_date: string;
+    size: number;
+    type: string;
+    delivered: boolean;
+    delivered_date: string;
+    sent_date: string;
+    subject: string;
+    sender_state?: string;
+    receiver_state?: string;
+    size_responsive?: number;
+}
+
+declare class MailboxEndpoints {
+    private endpoint;
+    private readonly VERSION;
+    private state;
+    constructor(api: ApiV1);
+    private getPath;
+    /**
+     * Get the inbox of an account
+     * @returns the mailbox response object
+     */
+    getInbox(filter: InboxFilter, page?: number): Promise<ApiResponse<MailboxResponse>>;
+    getOutbox(tenant: string, filter: OutboxFilter, page?: number): Promise<ApiResponse<MailboxResponse>>;
+}
+
 declare class ApiV1 {
     readonly endpoint: string;
     readonly apiState: ApiV1State;
@@ -299,11 +344,16 @@ declare class ApiV1 {
      * @returns ContentEndpoints
      */
     signature(): SignaturesEndpoint;
+    /**
+     * gets an instance of the MailboxEndpoints
+     * @returns MailboxEndpoints
+     */
+    mailbox(): MailboxEndpoints;
 }
 interface ApiV1State {
     auth_token?: string;
     auth_token_expire_date?: Date;
 }
 
-export { ApiResponse, ApiV1, AuthenticationEndpoints, ContentEndpoints, SignaturesEndpoint };
-export type { ApiV1State, BirthInformation, CheckReceiverResponse, ContentActionsResponse, ContentMeta, ContentResponse, CreateSignatureReferenceRequest, CreateSignatureReferenceResponse, ErrorResponse, LoginRequest, LoginResponse, LogoutRequest, PaymentDetails, ReceiverRequest, SendContentRequest, SendContentResponse };
+export { ApiResponse, ApiV1, AuthenticationEndpoints, ContentEndpoints, MailboxEndpoints, SignaturesEndpoint };
+export type { ApiV1State, BirthInformation, CheckReceiverResponse, ContentActionsResponse, ContentMeta, ContentResponse, CreateSignatureReferenceRequest, CreateSignatureReferenceResponse, ErrorResponse, InboxFilter, LoginRequest, LoginResponse, LogoutRequest, MailboxResponse, Meta, OutboxFilter, PaymentDetails, ReceiverRequest, SendContentRequest, SendContentResponse };

package/dist/types/api/api.d.ts

@@ -1,6 +1,7 @@
 import { AuthenticationEndpoints } from "../endpoints/v1/authentication";
 import { ContentEndpoints } from "../endpoints/v1/content";
 import { SignaturesEndpoint } from "../endpoints/v1/signatures";
+import { MailboxEndpoints } from "../endpoints/v1/mailbox";
 declare class ApiV1 {
     readonly endpoint: string;
     readonly apiState: ApiV1State;
@@ -22,6 +23,11 @@ declare class ApiV1 {
      * @returns ContentEndpoints
      */
     signature(): SignaturesEndpoint;
+    /**
+     * gets an instance of the MailboxEndpoints
+     * @returns MailboxEndpoints
+     */
+    mailbox(): MailboxEndpoints;
 }
 export interface ApiV1State {
     auth_token?: string;

package/dist/types/endpoints/v1/mailbox.d.ts

@@ -0,0 +1,18 @@
+import { ApiV1 } from "../../api/api";
+import { InboxFilter, OutboxFilter } from "./requests/mailbox";
+import { MailboxResponse } from "./responses/mailbox";
+import { ApiResponse } from "./apiResponse";
+declare class MailboxEndpoints {
+    private endpoint;
+    private readonly VERSION;
+    private state;
+    constructor(api: ApiV1);
+    private getPath;
+    /**
+     * Get the inbox of an account
+     * @returns the mailbox response object
+     */
+    getInbox(filter: InboxFilter, page?: number): Promise<ApiResponse<MailboxResponse>>;
+    getOutbox(tenant: string, filter: OutboxFilter, page?: number): Promise<ApiResponse<MailboxResponse>>;
+}
+export { MailboxEndpoints };

package/dist/types/endpoints/v1/requests/mailbox.d.ts

@@ -0,0 +1,10 @@
+interface InboxFilter {
+    state?: Array<'read' | 'unread' | 'trashed'>;
+    subject?: string;
+    sub_mailbox?: string;
+    type?: 'letter' | 'invoice' | 'contract';
+}
+interface OutboxFilter {
+    state?: Array<'active' | 'trashed'>;
+}
+export type { InboxFilter, OutboxFilter };

package/dist/types/endpoints/v1/responses/mailbox.d.ts

@@ -0,0 +1,21 @@
+interface MailboxResponse {
+    total: number;
+    results: Meta[];
+}
+interface Meta {
+    id: string;
+    sender: string;
+    receiver: string;
+    read: boolean;
+    read_date: string;
+    size: number;
+    type: string;
+    delivered: boolean;
+    delivered_date: string;
+    sent_date: string;
+    subject: string;
+    sender_state?: string;
+    receiver_state?: string;
+    size_responsive?: number;
+}
+export type { MailboxResponse, Meta };

package/dist/types/index.d.ts

@@ -9,3 +9,6 @@ export * from "./endpoints/v1/apiResponse";
 export * from "./endpoints/v1/authentication";
 export * from "./endpoints/v1/content";
 export * from "./endpoints/v1/signatures";
+export * from "./endpoints/v1/mailbox";
+export * from "./endpoints/v1/requests/mailbox";
+export * from "./endpoints/v1/responses/mailbox";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brifle/brifle-sdk",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "The JavaScript SDK to interact with the API of Brifle",
   "files": [
     "dist",