@brifle/brifle-sdk 0.0.5 → 0.2.0

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import * as axios from 'axios';
 import { AxiosError } from 'axios';
 
 declare class ApiResponse<ResponseType> {
@@ -99,14 +100,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 +122,42 @@ interface ContentActionsPaymentResponse {
     };
     link: string;
 }
+interface CoverLetterOverviewItem {
+    type: string;
+    name: string;
+    display_name: string;
+}
+interface CoverLetterOverviewResponse {
+    cover_letters: CoverLetterOverviewItem[];
+}
+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 {
@@ -157,6 +171,17 @@ interface ReceiverRequest {
     last_name?: string;
     full_name?: string;
     date_of_birth?: string;
+    postal_address?: PostalAddress;
+}
+interface PostalAddress {
+    city: string;
+    country: string;
+    date_of_birth?: string;
+    first_name: string;
+    house_number: string;
+    last_name: string;
+    postcode: string;
+    street: string;
 }
 interface BirthInformation {
     birth_name?: string;
@@ -165,7 +190,7 @@ interface BirthInformation {
     nationality?: string;
     given_names?: string;
     last_name?: string;
-    postaL_address?: string;
+    postal_address?: string;
 }
 interface PaymentDetails {
     amount: number;
@@ -183,6 +208,7 @@ interface SendContentRequest {
         type: 'application/pdf';
         content: string;
     }[];
+    fallback?: FallbackOptions;
     payment_info?: {
         details?: PaymentDetails;
         payable: boolean;
@@ -195,6 +221,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;
@@ -232,6 +275,21 @@ declare class ContentEndpoints {
      * @returns
      */
     sendContent(tenantId: string, request: SendContentRequest): Promise<ApiResponse<SendContentResponse>>;
+    /**
+     * list all cover letters for a tenant
+     * @param tenantId - The tenant id
+     * @returns
+     */
+    listCoverLetters(tenantId: string): Promise<ApiResponse<CoverLetterOverviewResponse>>;
+    /**
+     * get the content of a cover letter
+     * @param tenantId - The tenant id
+     * @param type - The type of the cover letter (custom | default)
+     * @param name - The name of the cover letter
+     * @param encoding - The encoding of the cover letter (base64 | pdf)
+     * @returns
+     */
+    getCoverLetterContent(tenantId: string, type: 'custom' | 'default', name: string, encoding: 'base64' | 'pdf'): Promise<axios.AxiosResponse<Blob, any>>;
 }
 
 interface CreateSignatureReferenceRequest {
@@ -286,6 +344,8 @@ interface InboxFilter {
 }
 interface OutboxFilter {
     state?: Array<'active' | 'trashed'>;
+    subject?: string;
+    type?: 'letter' | 'invoice' | 'contract';
 }
 
 interface MailboxResponse {
@@ -371,6 +431,27 @@ declare class AccountsEndpoints {
     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;
@@ -407,6 +488,11 @@ declare class ApiV1 {
      * @returns MailboxEndpoints
      */
     mailbox(): MailboxEndpoints;
+    /**
+     * gets an instance of the StatusEndpoint
+     * @returns StatusEndpoint
+     */
+    status(): StatusEndpoint;
 }
 interface ApiV1State {
     auth_token?: string;
@@ -414,4 +500,4 @@ interface ApiV1State {
 }
 
 export { AccountsEndpoints, ApiResponse, ApiV1, AuthenticationEndpoints, ContentEndpoints, MailboxEndpoints, SignaturesEndpoint, TenantsEndpoints };
-export type { AccountInfo, ApiV1State, BirthInformation, CheckReceiverResponse, ContentActionsResponse, ContentMeta, ContentResponse, CreateSignatureReferenceRequest, CreateSignatureReferenceResponse, ErrorResponse, InboxFilter, LoginRequest, LoginResponse, LogoutRequest, MailboxResponse, Meta, OutboxFilter, PaymentDetails, ReceiverRequest, SendContentRequest, SendContentResponse, Tenant, TenantsResponse };
+export type { AccountInfo, ApiV1State, BirthInformation, CheckReceiverResponse, Content, ContentActionsPaymentResponse, ContentActionsResponse, ContentActionsSignatureResponse, ContentMeta, ContentResponse, CoverLetterOverviewItem, CoverLetterOverviewResponse, 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

@@ -4,6 +4,7 @@ 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;
@@ -40,6 +41,11 @@ declare class ApiV1 {
      * @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/content.d.ts

@@ -1,5 +1,5 @@
 import { ApiResponse } from "./apiResponse";
-import { CheckReceiverResponse, ContentActionsResponse, ContentResponse, SendContentResponse } from "./responses/content";
+import { CheckReceiverResponse, ContentActionsResponse, ContentResponse, CoverLetterOverviewResponse, SendContentResponse } from "./responses/content";
 import { ApiV1 } from "../../api/api";
 import { ReceiverRequest, SendContentRequest } from "./requests/content";
 declare class ContentEndpoints {
@@ -38,5 +38,20 @@ declare class ContentEndpoints {
      * @returns
      */
     sendContent(tenantId: string, request: SendContentRequest): Promise<ApiResponse<SendContentResponse>>;
+    /**
+     * list all cover letters for a tenant
+     * @param tenantId - The tenant id
+     * @returns
+     */
+    listCoverLetters(tenantId: string): Promise<ApiResponse<CoverLetterOverviewResponse>>;
+    /**
+     * get the content of a cover letter
+     * @param tenantId - The tenant id
+     * @param type - The type of the cover letter (custom | default)
+     * @param name - The name of the cover letter
+     * @param encoding - The encoding of the cover letter (base64 | pdf)
+     * @returns
+     */
+    getCoverLetterContent(tenantId: string, type: 'custom' | 'default', name: string, encoding: 'base64' | 'pdf'): Promise<import("axios").AxiosResponse<Blob, any>>;
 }
 export { ContentEndpoints };

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

@@ -9,6 +9,17 @@ interface ReceiverRequest {
     last_name?: string;
     full_name?: string;
     date_of_birth?: string;
+    postal_address?: PostalAddress;
+}
+interface PostalAddress {
+    city: string;
+    country: string;
+    date_of_birth?: string;
+    first_name: string;
+    house_number: string;
+    last_name: string;
+    postcode: string;
+    street: string;
 }
 interface BirthInformation {
     birth_name?: string;
@@ -17,7 +28,7 @@ interface BirthInformation {
     nationality?: string;
     given_names?: string;
     last_name?: string;
-    postaL_address?: string;
+    postal_address?: string;
 }
 interface PaymentDetails {
     amount: number;
@@ -35,6 +46,7 @@ interface SendContentRequest {
         type: 'application/pdf';
         content: string;
     }[];
+    fallback?: FallbackOptions;
     payment_info?: {
         details?: PaymentDetails;
         payable: boolean;
@@ -47,4 +59,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/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,41 @@ interface ContentActionsPaymentResponse {
     };
     link: string;
 }
+interface CoverLetterOverviewItem {
+    type: string;
+    name: string;
+    display_name: string;
+}
+interface CoverLetterOverviewResponse {
+    cover_letters: CoverLetterOverviewItem[];
+}
+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, CoverLetterOverviewResponse, CoverLetterOverviewItem, 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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brifle/brifle-sdk",
-  "version": "0.0.5",
+  "version": "0.2.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"