@brifle/brifle-sdk 0.0.4 → 0.1.0

package/dist/esm/index.mjs

@@ -305,6 +305,108 @@ class MailboxEndpoints {
     }
 }
 
+class TenantsEndpoints {
+    constructor(api) {
+        this.VERSION = "v1";
+        this.endpoint = api.endpoint;
+        this.state = api.apiState;
+    }
+    getPath(path) {
+        return `${this.endpoint}/${this.VERSION}/tenants/${path}`;
+    }
+    /**
+     * Gets a tenant by its ID
+     */
+    getById(tenantId) {
+        const path = this.getPath(`id/${tenantId}`);
+        return axios.get(path, {
+            headers: {
+                "Authorization": `Bearer ${this.state.auth_token}`,
+                "Content-Type": "application/json"
+            }
+        })
+            .then((response) => {
+            return ApiResponse.success(response.data);
+        })
+            .catch((error) => {
+            return ApiResponse.errorAxios(error);
+        });
+    }
+    /**
+     * Gets all tenants owned by the account id
+     */
+    getMy() {
+        const path = this.getPath(`my`);
+        return axios.get(path, {
+            headers: {
+                "Authorization": `Bearer ${this.state.auth_token}`,
+                "Content-Type": "application/json"
+            }
+        })
+            .then((response) => {
+            return ApiResponse.success(response.data);
+        })
+            .catch((error) => {
+            return ApiResponse.errorAxios(error);
+        });
+    }
+}
+
+class AccountsEndpoints {
+    constructor(api) {
+        this.VERSION = "v1";
+        this.endpoint = api.endpoint;
+        this.state = api.apiState;
+    }
+    getPath(path) {
+        return `${this.endpoint}/${this.VERSION}/accounts/${path}`;
+    }
+    /**
+     * Gets a tenant by its ID
+     */
+    getById(accountId) {
+        const path = this.getPath(`${accountId}`);
+        console.log(path, path);
+        return axios.get(path, {
+            headers: {
+                "Authorization": `Bearer ${this.state.auth_token}`,
+                "Content-Type": "application/json"
+            }
+        })
+            .then((response) => {
+            return ApiResponse.success(response.data);
+        })
+            .catch((error) => {
+            return ApiResponse.errorAxios(error);
+        });
+    }
+}
+
+class StatusEndpoint {
+    constructor(api) {
+        this.VERSION = "v1";
+        this.endpoint = api.endpoint;
+        this.state = api.apiState;
+    }
+    getPath(path) {
+        return `${this.endpoint}/${this.VERSION}/status/${path}`;
+    }
+    /**
+     *
+     * @returns the
+     */
+    getStatus() {
+        const path = this.getPath("");
+        return axios.get(path)
+            .then((response) => {
+            return ApiResponse.success(response.data);
+        })
+            .catch((error) => {
+            return ApiResponse.errorAxios(error);
+        });
+    }
+}
+
 var ENDPOINTS;
 (function (ENDPOINTS) {
     ENDPOINTS["SANDBOX"] = "https://sandbox-api.brifle.de";
@@ -347,6 +449,20 @@ class ApiV1 {
     signature() {
         return new SignaturesEndpoint(this);
     }
+    /**
+     * gets an instance of the TenantsEndpoints
+     * @returns TenantsEndpoints
+     */
+    tenants() {
+        return new TenantsEndpoints(this);
+    }
+    /**
+     * gets an instance of the AccountsEndpoints
+     * @returns AccountsEndpoints
+     */
+    accounts() {
+        return new AccountsEndpoints(this);
+    }
     /**
      * gets an instance of the MailboxEndpoints
      * @returns MailboxEndpoints
@@ -354,7 +470,14 @@ class ApiV1 {
     mailbox() {
         return new MailboxEndpoints(this);
     }
+    /**
+     * gets an instance of the StatusEndpoint
+     * @returns StatusEndpoint
+     */
+    status() {
+        return new StatusEndpoint(this);
+    }
 }
 
-export { ApiResponse, ApiV1, AuthenticationEndpoints, ContentEndpoints, MailboxEndpoints, SignaturesEndpoint };
+export { AccountsEndpoints, ApiResponse, ApiV1, AuthenticationEndpoints, ContentEndpoints, MailboxEndpoints, SignaturesEndpoint, TenantsEndpoints };
 //# 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

@@ -99,14 +99,16 @@ interface ContentMeta {
     size: number;
     subject: string;
     type: string;
+    size_responsive?: number;
 }
 interface ContentResponse {
-    content: {
-        content: string;
-        type: string;
-    };
+    content: Content[];
     meta: ContentMeta;
 }
+interface Content {
+    content: string;
+    type: string;
+}
 interface ContentActionsPaymentResponse {
     details: {
         amount: number;
@@ -119,31 +121,34 @@ interface ContentActionsPaymentResponse {
     };
     link: string;
 }
+interface EmbbededSignatureResponse {
+    id: string;
+    created_by: string;
+    created_date: string;
+    document_signature_id: string;
+    due_date: string;
+    field_name: string;
+    history?: string;
+    purpose: string;
+    request_date: string;
+    requested_to: string;
+    signature_date: string;
+    signed_by: string;
+    signed_for: string;
+    value: string;
+    status: 'pending' | 'signed' | 'rejected';
+}
 interface ContentActionsSignatureResponse {
     document_signatures: {
         signature_ids: string[];
         signature_reference: string;
     };
-    embedded_signatures: {
-        created_by: string;
-        created_date: string;
-        document_signature_id: string;
-        due_date: string;
-        field_name: string;
-        history?: string;
-        purpose: string;
-        request_date: string;
-        requested_to: string;
-        signature_date: string;
-        signed_by: string;
-        signed_for: string;
-        value: string;
-    }[];
+    embedded_signatures: EmbbededSignatureResponse[];
     signature_reference: string;
 }
 interface ContentActionsResponse {
-    payments: ContentActionsPaymentResponse[];
-    signatures: ContentActionsSignatureResponse[];
+    payments: ContentActionsPaymentResponse;
+    signatures: ContentActionsSignatureResponse;
 }
 
 interface ReceiverRequest {
@@ -183,6 +188,7 @@ interface SendContentRequest {
         type: 'application/pdf';
         content: string;
     }[];
+    fallback?: FallbackOptions;
     payment_info?: {
         details?: PaymentDetails;
         payable: boolean;
@@ -195,6 +201,23 @@ interface SendContentRequest {
         }[];
     };
 }
+interface FallbackOptions {
+    enabled_physical_delivery: boolean;
+    paper_mail: {
+        recipient: {
+            address_line1: string;
+            address_line2?: string;
+            address_line3?: string;
+            postal_code: string;
+            city: string;
+            country: string;
+        };
+        test_mode: {
+            email: string;
+            enabled: boolean;
+        };
+    };
+}
 
 declare class ContentEndpoints {
     private endpoint;
@@ -286,6 +309,8 @@ interface InboxFilter {
 }
 interface OutboxFilter {
     state?: Array<'active' | 'trashed'>;
+    subject?: string;
+    type?: 'letter' | 'invoice' | 'contract';
 }
 
 interface MailboxResponse {
@@ -323,6 +348,75 @@ declare class MailboxEndpoints {
     getOutbox(tenant: string, filter: OutboxFilter, page?: number): Promise<ApiResponse<MailboxResponse>>;
 }
 
+interface Tenant {
+    account_id: string;
+    name: string;
+    image?: string;
+    private: boolean;
+    id: string;
+}
+interface TenantsResponse {
+    total: number;
+    tenants: Tenant[];
+}
+
+declare class TenantsEndpoints {
+    private endpoint;
+    private readonly VERSION;
+    private state;
+    constructor(api: ApiV1);
+    private getPath;
+    /**
+     * Gets a tenant by its ID
+     */
+    getById(tenantId: string): Promise<ApiResponse<Tenant>>;
+    /**
+     * Gets all tenants owned by the account id
+     */
+    getMy(): Promise<ApiResponse<TenantsResponse>>;
+}
+
+interface AccountInfo {
+    company_name: string;
+    first_name: string;
+    last_name: string;
+    middle_name: string;
+    type: 'private' | 'business';
+}
+
+declare class AccountsEndpoints {
+    private endpoint;
+    private readonly VERSION;
+    private state;
+    constructor(api: ApiV1);
+    private getPath;
+    /**
+     * Gets a tenant by its ID
+     */
+    getById(accountId: string): Promise<ApiResponse<AccountInfo>>;
+}
+
+interface StatusResponse {
+    status: string;
+    timestamp: string;
+    version: string;
+    service: string;
+    features: string[];
+}
+
+declare class StatusEndpoint {
+    private endpoint;
+    private readonly VERSION;
+    private state;
+    constructor(api: ApiV1);
+    private getPath;
+    /**
+     *
+     * @returns the
+     */
+    getStatus(): Promise<ApiResponse<StatusResponse>>;
+}
+
 declare class ApiV1 {
     readonly endpoint: string;
     readonly apiState: ApiV1State;
@@ -344,16 +438,31 @@ declare class ApiV1 {
      * @returns ContentEndpoints
      */
     signature(): SignaturesEndpoint;
+    /**
+     * gets an instance of the TenantsEndpoints
+     * @returns TenantsEndpoints
+     */
+    tenants(): TenantsEndpoints;
+    /**
+     * gets an instance of the AccountsEndpoints
+     * @returns AccountsEndpoints
+     */
+    accounts(): AccountsEndpoints;
     /**
      * gets an instance of the MailboxEndpoints
      * @returns MailboxEndpoints
      */
     mailbox(): MailboxEndpoints;
+    /**
+     * gets an instance of the StatusEndpoint
+     * @returns StatusEndpoint
+     */
+    status(): StatusEndpoint;
 }
 interface ApiV1State {
     auth_token?: string;
     auth_token_expire_date?: Date;
 }
 
-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 };
+export { AccountsEndpoints, ApiResponse, ApiV1, AuthenticationEndpoints, ContentEndpoints, MailboxEndpoints, SignaturesEndpoint, TenantsEndpoints };
+export type { AccountInfo, ApiV1State, BirthInformation, CheckReceiverResponse, Content, ContentActionsPaymentResponse, ContentActionsResponse, ContentActionsSignatureResponse, ContentMeta, ContentResponse, CreateSignatureReferenceRequest, CreateSignatureReferenceResponse, EmbbededSignatureResponse, ErrorResponse, FallbackOptions, InboxFilter, LoginRequest, LoginResponse, LogoutRequest, MailboxResponse, Meta, OutboxFilter, PaymentDetails, ReceiverRequest, SendContentRequest, SendContentResponse, Tenant, TenantsResponse };

package/dist/index.js

@@ -0,0 +1,18 @@
+export * from "./api/api";
+export * from "./endpoints/v1/requests/authentication";
+export * from "./endpoints/v1/responses/authentication";
+export * from "./endpoints/v1/requests/content";
+export * from "./endpoints/v1/responses/content";
+export * from "./endpoints/v1/requests/signatures";
+export * from "./endpoints/v1/responses/signatures";
+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";
+export * from "./endpoints/v1/tenant";
+export * from "./endpoints/v1/responses/tenant";
+export * from "./endpoints/v1/accounts";
+export * from "./endpoints/v1/responses/accounts";

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

@@ -2,6 +2,9 @@ import { AuthenticationEndpoints } from "../endpoints/v1/authentication";
 import { ContentEndpoints } from "../endpoints/v1/content";
 import { SignaturesEndpoint } from "../endpoints/v1/signatures";
 import { MailboxEndpoints } from "../endpoints/v1/mailbox";
+import { TenantsEndpoints } from "../endpoints/v1/tenant";
+import { AccountsEndpoints } from "../endpoints/v1/accounts";
+import { StatusEndpoint } from "../endpoints/v1/status";
 declare class ApiV1 {
     readonly endpoint: string;
     readonly apiState: ApiV1State;
@@ -23,11 +26,26 @@ declare class ApiV1 {
      * @returns ContentEndpoints
      */
     signature(): SignaturesEndpoint;
+    /**
+     * gets an instance of the TenantsEndpoints
+     * @returns TenantsEndpoints
+     */
+    tenants(): TenantsEndpoints;
+    /**
+     * gets an instance of the AccountsEndpoints
+     * @returns AccountsEndpoints
+     */
+    accounts(): AccountsEndpoints;
     /**
      * gets an instance of the MailboxEndpoints
      * @returns MailboxEndpoints
      */
     mailbox(): MailboxEndpoints;
+    /**
+     * gets an instance of the StatusEndpoint
+     * @returns StatusEndpoint
+     */
+    status(): StatusEndpoint;
 }
 export interface ApiV1State {
     auth_token?: string;

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

@@ -0,0 +1,15 @@
+import { ApiV1 } from "../../api/api";
+import { AccountInfo } from "./responses/accounts";
+import { ApiResponse } from "./apiResponse";
+declare class AccountsEndpoints {
+    private endpoint;
+    private readonly VERSION;
+    private state;
+    constructor(api: ApiV1);
+    private getPath;
+    /**
+     * Gets a tenant by its ID
+     */
+    getById(accountId: string): Promise<ApiResponse<AccountInfo>>;
+}
+export { AccountsEndpoints };

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

@@ -35,6 +35,7 @@ interface SendContentRequest {
         type: 'application/pdf';
         content: string;
     }[];
+    fallback?: FallbackOptions;
     payment_info?: {
         details?: PaymentDetails;
         payable: boolean;
@@ -47,4 +48,21 @@ interface SendContentRequest {
         }[];
     };
 }
-export type { SendContentRequest, ReceiverRequest, BirthInformation, PaymentDetails };
+interface FallbackOptions {
+    enabled_physical_delivery: boolean;
+    paper_mail: {
+        recipient: {
+            address_line1: string;
+            address_line2?: string;
+            address_line3?: string;
+            postal_code: string;
+            city: string;
+            country: string;
+        };
+        test_mode: {
+            email: string;
+            enabled: boolean;
+        };
+    };
+}
+export type { SendContentRequest, ReceiverRequest, BirthInformation, PaymentDetails, FallbackOptions };

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

@@ -6,5 +6,7 @@ interface InboxFilter {
 }
 interface OutboxFilter {
     state?: Array<'active' | 'trashed'>;
+    subject?: string;
+    type?: 'letter' | 'invoice' | 'contract';
 }
 export type { InboxFilter, OutboxFilter };

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

@@ -0,0 +1,8 @@
+interface AccountInfo {
+    company_name: string;
+    first_name: string;
+    last_name: string;
+    middle_name: string;
+    type: 'private' | 'business';
+}
+export type { AccountInfo };

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

@@ -19,14 +19,16 @@ interface ContentMeta {
     size: number;
     subject: string;
     type: string;
+    size_responsive?: number;
 }
 interface ContentResponse {
-    content: {
-        content: string;
-        type: string;
-    };
+    content: Content[];
     meta: ContentMeta;
 }
+interface Content {
+    content: string;
+    type: string;
+}
 interface ContentActionsPaymentResponse {
     details: {
         amount: number;
@@ -39,30 +41,33 @@ interface ContentActionsPaymentResponse {
     };
     link: string;
 }
+interface EmbbededSignatureResponse {
+    id: string;
+    created_by: string;
+    created_date: string;
+    document_signature_id: string;
+    due_date: string;
+    field_name: string;
+    history?: string;
+    purpose: string;
+    request_date: string;
+    requested_to: string;
+    signature_date: string;
+    signed_by: string;
+    signed_for: string;
+    value: string;
+    status: 'pending' | 'signed' | 'rejected';
+}
 interface ContentActionsSignatureResponse {
     document_signatures: {
         signature_ids: string[];
         signature_reference: string;
     };
-    embedded_signatures: {
-        created_by: string;
-        created_date: string;
-        document_signature_id: string;
-        due_date: string;
-        field_name: string;
-        history?: string;
-        purpose: string;
-        request_date: string;
-        requested_to: string;
-        signature_date: string;
-        signed_by: string;
-        signed_for: string;
-        value: string;
-    }[];
+    embedded_signatures: EmbbededSignatureResponse[];
     signature_reference: string;
 }
 interface ContentActionsResponse {
-    payments: ContentActionsPaymentResponse[];
-    signatures: ContentActionsSignatureResponse[];
+    payments: ContentActionsPaymentResponse;
+    signatures: ContentActionsSignatureResponse;
 }
-export type { SendContentResponse, CheckReceiverResponse, ContentMeta, ContentResponse, ContentActionsResponse };
+export type { EmbbededSignatureResponse, Content, ContentActionsSignatureResponse, ContentActionsPaymentResponse, SendContentResponse, CheckReceiverResponse, ContentMeta, ContentResponse, ContentActionsResponse };

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

@@ -0,0 +1,8 @@
+interface StatusResponse {
+    status: string;
+    timestamp: string;
+    version: string;
+    service: string;
+    features: string[];
+}
+export type { StatusResponse };

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

@@ -0,0 +1,12 @@
+interface Tenant {
+    account_id: string;
+    name: string;
+    image?: string;
+    private: boolean;
+    id: string;
+}
+interface TenantsResponse {
+    total: number;
+    tenants: Tenant[];
+}
+export type { Tenant, TenantsResponse };

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

@@ -0,0 +1,16 @@
+import { ApiV1 } from "../../api/api";
+import { ApiResponse } from "./apiResponse";
+import { StatusResponse } from "./responses/status";
+declare class StatusEndpoint {
+    private endpoint;
+    private readonly VERSION;
+    private state;
+    constructor(api: ApiV1);
+    private getPath;
+    /**
+     *
+     * @returns the
+     */
+    getStatus(): Promise<ApiResponse<StatusResponse>>;
+}
+export { StatusEndpoint };

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

@@ -0,0 +1,19 @@
+import { ApiV1 } from "../../api/api";
+import { Tenant, TenantsResponse } from "./responses/tenant";
+import { ApiResponse } from "./apiResponse";
+declare class TenantsEndpoints {
+    private endpoint;
+    private readonly VERSION;
+    private state;
+    constructor(api: ApiV1);
+    private getPath;
+    /**
+     * Gets a tenant by its ID
+     */
+    getById(tenantId: string): Promise<ApiResponse<Tenant>>;
+    /**
+     * Gets all tenants owned by the account id
+     */
+    getMy(): Promise<ApiResponse<TenantsResponse>>;
+}
+export { TenantsEndpoints };

package/dist/types/index.d.ts

@@ -12,3 +12,7 @@ export * from "./endpoints/v1/signatures";
 export * from "./endpoints/v1/mailbox";
 export * from "./endpoints/v1/requests/mailbox";
 export * from "./endpoints/v1/responses/mailbox";
+export * from "./endpoints/v1/tenant";
+export * from "./endpoints/v1/responses/tenant";
+export * from "./endpoints/v1/accounts";
+export * from "./endpoints/v1/responses/accounts";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brifle/brifle-sdk",
-  "version": "0.0.4",
+  "version": "0.1.0",
   "description": "The JavaScript SDK to interact with the API of Brifle",
   "files": [
     "dist",
@@ -21,6 +21,7 @@
   "scripts": {
     "test": "jest --setupFiles dotenv/config",
     "test-jest": "jest",
+    "test-only": "jest",
     "rollup": "tsc --project tsconfig.types.json && rollup -c",
     "build": "tsc",
     "publish": "npm run rollup && npm publish --access public"