@brifle/brifle-sdk 0.1.0 → 0.2.0

package/dist/cjs/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/cjs/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;

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

@@ -41,6 +41,14 @@ 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;
@@ -70,4 +78,4 @@ interface ContentActionsResponse {
     payments: ContentActionsPaymentResponse;
     signatures: ContentActionsSignatureResponse;
 }
-export type { EmbbededSignatureResponse, Content, ContentActionsSignatureResponse, ContentActionsPaymentResponse, SendContentResponse, CheckReceiverResponse, ContentMeta, ContentResponse, ContentActionsResponse };
+export type { EmbbededSignatureResponse, Content, CoverLetterOverviewResponse, CoverLetterOverviewItem, ContentActionsSignatureResponse, ContentActionsPaymentResponse, SendContentResponse, CheckReceiverResponse, ContentMeta, ContentResponse, ContentActionsResponse };

package/dist/cjs/index.js

@@ -199,6 +199,42 @@ class ContentEndpoints {
             return ApiResponse.errorAxios(error);
         });
     }
+    /**
+     * list all cover letters for a tenant
+     * @param tenantId - The tenant id
+     * @returns
+     */
+    listCoverLetters(tenantId) {
+        const path = this.getPath(`cover_letters/${tenantId}/list`);
+        return axios.get(path, {
+            headers: {
+                "Authorization": `Bearer ${this.state.auth_token}`
+            }
+        })
+            .then((response) => {
+            return ApiResponse.success(response.data);
+        })
+            .catch((error) => {
+            return ApiResponse.errorAxios(error);
+        });
+    }
+    /**
+     * 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, type, name, encoding) {
+        const path = this.getPath(`cover_letter/${tenantId}/${type}/${name}/${encoding}`);
+        return axios.get(path, {
+            headers: {
+                "Authorization": `Bearer ${this.state.auth_token}`
+            },
+            responseType: 'blob'
+        });
+    }
 }
 
 class SignaturesEndpoint {

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/endpoints/v1/content.js

@@ -91,5 +91,41 @@ class ContentEndpoints {
             return ApiResponse.errorAxios(error);
         });
     }
+    /**
+     * list all cover letters for a tenant
+     * @param tenantId - The tenant id
+     * @returns
+     */
+    listCoverLetters(tenantId) {
+        const path = this.getPath(`cover_letters/${tenantId}/list`);
+        return axios.get(path, {
+            headers: {
+                "Authorization": `Bearer ${this.state.auth_token}`
+            }
+        })
+            .then((response) => {
+            return ApiResponse.success(response.data);
+        })
+            .catch((error) => {
+            return ApiResponse.errorAxios(error);
+        });
+    }
+    /**
+     * 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, type, name, encoding) {
+        const path = this.getPath(`cover_letter/${tenantId}/${type}/${name}/${encoding}`);
+        return axios.get(path, {
+            headers: {
+                "Authorization": `Bearer ${this.state.auth_token}`
+            },
+            responseType: 'blob'
+        });
+    }
 }
 export { ContentEndpoints };

package/dist/esm/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/esm/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;

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

@@ -41,6 +41,14 @@ 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;
@@ -70,4 +78,4 @@ interface ContentActionsResponse {
     payments: ContentActionsPaymentResponse;
     signatures: ContentActionsSignatureResponse;
 }
-export type { EmbbededSignatureResponse, Content, ContentActionsSignatureResponse, ContentActionsPaymentResponse, SendContentResponse, CheckReceiverResponse, ContentMeta, ContentResponse, ContentActionsResponse };
+export type { EmbbededSignatureResponse, Content, CoverLetterOverviewResponse, CoverLetterOverviewItem, ContentActionsSignatureResponse, ContentActionsPaymentResponse, SendContentResponse, CheckReceiverResponse, ContentMeta, ContentResponse, ContentActionsResponse };

package/dist/esm/index.mjs

@@ -197,6 +197,42 @@ class ContentEndpoints {
             return ApiResponse.errorAxios(error);
         });
     }
+    /**
+     * list all cover letters for a tenant
+     * @param tenantId - The tenant id
+     * @returns
+     */
+    listCoverLetters(tenantId) {
+        const path = this.getPath(`cover_letters/${tenantId}/list`);
+        return axios.get(path, {
+            headers: {
+                "Authorization": `Bearer ${this.state.auth_token}`
+            }
+        })
+            .then((response) => {
+            return ApiResponse.success(response.data);
+        })
+            .catch((error) => {
+            return ApiResponse.errorAxios(error);
+        });
+    }
+    /**
+     * 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, type, name, encoding) {
+        const path = this.getPath(`cover_letter/${tenantId}/${type}/${name}/${encoding}`);
+        return axios.get(path, {
+            headers: {
+                "Authorization": `Bearer ${this.state.auth_token}`
+            },
+            responseType: 'blob'
+        });
+    }
 }
 
 class SignaturesEndpoint {

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

@@ -1,3 +1,4 @@
+import * as axios from 'axios';
 import { AxiosError } from 'axios';
 
 declare class ApiResponse<ResponseType> {
@@ -121,6 +122,14 @@ 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;
@@ -162,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;
@@ -170,7 +190,7 @@ interface BirthInformation {
     nationality?: string;
     given_names?: string;
     last_name?: string;
-    postaL_address?: string;
+    postal_address?: string;
 }
 interface PaymentDetails {
     amount: number;
@@ -255,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 {
@@ -465,4 +500,4 @@ interface ApiV1State {
 }
 
 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 };
+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/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;

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

@@ -41,6 +41,14 @@ 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;
@@ -70,4 +78,4 @@ interface ContentActionsResponse {
     payments: ContentActionsPaymentResponse;
     signatures: ContentActionsSignatureResponse;
 }
-export type { EmbbededSignatureResponse, Content, ContentActionsSignatureResponse, ContentActionsPaymentResponse, SendContentResponse, CheckReceiverResponse, ContentMeta, ContentResponse, ContentActionsResponse };
+export type { EmbbededSignatureResponse, Content, CoverLetterOverviewResponse, CoverLetterOverviewItem, ContentActionsSignatureResponse, ContentActionsPaymentResponse, SendContentResponse, CheckReceiverResponse, ContentMeta, ContentResponse, ContentActionsResponse };

package/package.json

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