@emilgroup/public-api-sdk-node 1.0.2 → 1.1.0

package/.openapi-generator/FILES

@@ -1,10 +1,12 @@
 .gitignore
 .npmignore
+.openapi-generator-ignore
 README.md
 api.ts
 api/documents-api.ts
+api/leads-api.ts
 api/notifications-api.ts
-api/payment-setup-api.ts
+api/payments-setup-api.ts
 api/products-api.ts
 base.ts
 common.ts
@@ -13,22 +15,49 @@ git_push.sh
 index.ts
 models/complete-braintree-payment-setup-request-dto.ts
 models/complete-payment-setup-request-dto.ts
+models/complete-payment-setup-response-class.ts
 models/complete-stripe-payment-setup-request-dto.ts
 models/create-account-request-dto.ts
 models/create-bank-account-request-dto.ts
 models/create-custom-application-request-dto.ts
+models/create-custom-application-response-class.ts
 models/create-document-request-dto.ts
 models/create-estimated-invoice-request-dto.ts
+models/create-estimated-invoice-response-class.ts
 models/create-lead-request-dto.ts
+models/create-lead-response-class.ts
+models/document-class.ts
+models/get-custom-css-response-class.ts
+models/get-lead-response-class.ts
 models/index.ts
 models/initiate-braintree-payment-setup-request-dto.ts
+models/initiate-braintree-payment-setup-response-class.ts
+models/initiate-lead-response-class.ts
 models/initiate-payment-setup-request-dto.ts
+models/initiate-payment-setup-response-class.ts
 models/initiate-stripe-payment-setup-request-dto.ts
+models/initiate-stripe-payment-setup-response-class.ts
+models/insured-object-class.ts
+models/insured-object-type-class.ts
+models/invoice-class.ts
+models/invoice-item-class.ts
+models/invoice-status-class.ts
+models/lead-account-class.ts
+models/lead-bank-account-class.ts
+models/lead-class.ts
+models/lead-policy-class.ts
+models/lead-policy-object-class.ts
+models/list-documents-response-class.ts
+models/payment-method-class.ts
 models/policy-object-request-dto.ts
 models/premium-override-dto.ts
 models/premium-override-request-dto.ts
+models/product-factor-class.ts
+models/product-field-class.ts
 models/send-notification-request-dto.ts
+models/send-notification-response-class.ts
 models/update-lead-request-dto.ts
+models/update-lead-response-class.ts
 models/uploaded-document-dto.ts
 package.json
 tsconfig.json

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/public-api-sdk-node@1.0.1 --save
+npm install @emilgroup/public-api-sdk-node@1.1.0 --save
 ```
 or 
 ```
-yarn add @emilgroup/public-api-sdk-node@1.0.1
+yarn add @emilgroup/public-api-sdk-node@1.1.0
 ```
 
 And then you can import `PublicApi`.
@@ -56,9 +56,7 @@ async function listDocuments(): Promise<Void> {
     try {
         const publicApi = new PublicApi();
 
-        await publicApi.initialize(); // should be called only once per Api.
-
-        const { data: { items } } = await publicApi.listDocuments();
+        const { data: { items } } = await publicApi.listDocuments('tenantSlug');
 
         console.log(items);
     } catch(error) {

package/api/documents-api.ts

@@ -1,11 +1,11 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * EMIL PublicAPI
- * The EMIL Public API description
+ * Emil PublicAPI
+ * The Emil Public API description
  *
  * The version of the OpenAPI document: 1.0
- * 
+ * Contact: kontakt@emil.de
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
@@ -22,6 +22,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
 // @ts-ignore
 import { CreateDocumentRequestDto } from '../models';
+// @ts-ignore
+import { ListDocumentsResponseClass } from '../models';
 // URLSearchParams not necessarily used
 // @ts-ignore
 import { URL, URLSearchParams } from 'url';
@@ -33,7 +35,8 @@ const FormData = require('form-data');
 export const DocumentsApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
         /**
-         * 
+         * This will create a temporary document.
+         * @summary Create the temporary document
          * @param {CreateDocumentRequestDto} createDocumentRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -79,7 +82,8 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
             };
         },
         /**
-         * 
+         * Retrieves the details of the specific document that was previously created. Supply the unique document code that was returned when you created it and Emil Api will return the corresponding document file to download.
+         * @summary Download a document
          * @param {string} code 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -123,7 +127,8 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
             };
         },
         /**
-         * 
+         * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List documents
          * @param {string} [authorization] Bearer Token
          * @param {any} [pageSize] A limit on the number of objects to be returned.      Limit ranges between 1 and 100. Default: 10.
          * @param {any} [pageToken] A cursor for use in pagination.      pageToken is an ID that defines your place in the list.      For instance, if you make a list request and receive 100 objects and pageToken=1,      your subsequent call can include pageToken=2 in order to fetch the next page of the list.
@@ -203,7 +208,8 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = DocumentsApiAxiosParamCreator(configuration)
     return {
         /**
-         * 
+         * This will create a temporary document.
+         * @summary Create the temporary document
          * @param {CreateDocumentRequestDto} createDocumentRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -214,7 +220,8 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * 
+         * Retrieves the details of the specific document that was previously created. Supply the unique document code that was returned when you created it and Emil Api will return the corresponding document file to download.
+         * @summary Download a document
          * @param {string} code 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -225,7 +232,8 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
         /**
-         * 
+         * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List documents
          * @param {string} [authorization] Bearer Token
          * @param {any} [pageSize] A limit on the number of objects to be returned.      Limit ranges between 1 and 100. Default: 10.
          * @param {any} [pageToken] A cursor for use in pagination.      pageToken is an ID that defines your place in the list.      For instance, if you make a list request and receive 100 objects and pageToken=1,      your subsequent call can include pageToken=2 in order to fetch the next page of the list.
@@ -236,7 +244,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listDocuments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
+        async listDocuments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListDocumentsResponseClass>> {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
@@ -251,7 +259,8 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
     const localVarFp = DocumentsApiFp(configuration)
     return {
         /**
-         * 
+         * This will create a temporary document.
+         * @summary Create the temporary document
          * @param {CreateDocumentRequestDto} createDocumentRequestDto 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -261,7 +270,8 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
             return localVarFp.createTemporaryDocument(createDocumentRequestDto, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * 
+         * Retrieves the details of the specific document that was previously created. Supply the unique document code that was returned when you created it and Emil Api will return the corresponding document file to download.
+         * @summary Download a document
          * @param {string} code 
          * @param {string} [authorization] Bearer Token
          * @param {*} [options] Override http request option.
@@ -271,7 +281,8 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
             return localVarFp.downloadDocument(code, authorization, options).then((request) => request(axios, basePath));
         },
         /**
-         * 
+         * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+         * @summary List documents
          * @param {string} [authorization] Bearer Token
          * @param {any} [pageSize] A limit on the number of objects to be returned.      Limit ranges between 1 and 100. Default: 10.
          * @param {any} [pageToken] A cursor for use in pagination.      pageToken is an ID that defines your place in the list.      For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1,      your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
@@ -282,7 +293,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listDocuments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<void> {
+        listDocuments(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, options?: any): AxiosPromise<ListDocumentsResponseClass> {
             return localVarFp.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
         },
     };
@@ -394,7 +405,8 @@ export interface DocumentsApiListDocumentsRequest {
  */
 export class DocumentsApi extends BaseAPI {
     /**
-     * 
+     * This will create a temporary document.
+     * @summary Create the temporary document
      * @param {DocumentsApiCreateTemporaryDocumentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -405,7 +417,8 @@ export class DocumentsApi extends BaseAPI {
     }
 
     /**
-     * 
+     * Retrieves the details of the specific document that was previously created. Supply the unique document code that was returned when you created it and Emil Api will return the corresponding document file to download.
+     * @summary Download a document
      * @param {DocumentsApiDownloadDocumentRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -416,7 +429,8 @@ export class DocumentsApi extends BaseAPI {
     }
 
     /**
-     * 
+     * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
+     * @summary List documents
      * @param {DocumentsApiListDocumentsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}