@emilgroup/accounting-sdk-node 1.22.0 → 1.22.1-beta.0

package/configuration.ts

@@ -1,8 +1,8 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * EMIL GdvService
- * The EMIL GdvService API description
+ * EMIL AccountingService
+ * The EMIL AccountingService API description
  *
  * The version of the OpenAPI document: 1.0
  * Contact: kontakt@emil.de

package/dist/api/{zip-codes-api.d.ts → booking-entries-api.d.ts}

@@ -1,6 +1,6 @@
 /**
- * EMIL GdvService
- * The EMIL GdvService API description
+ * EMIL AccountingService
+ * The EMIL AccountingService API description
  *
  * The version of the OpenAPI document: 1.0
  * Contact: kontakt@emil.de
@@ -12,27 +12,38 @@
 import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 import { Configuration } from '../configuration';
 import { RequestArgs, BaseAPI } from '../base';
-import { GetZipCodeResponseClass } from '../models';
-import { ListZipCodesResponseClass } from '../models';
-import { StoreZipCodesResponseClass } from '../models';
+import { CreateBookingEntryRequestDto } from '../models';
+import { CreateBookingEntryResponseClass } from '../models';
+import { GetBookingEntryResponseClass } from '../models';
+import { ListBookingEntriesResponseClass } from '../models';
 /**
- * ZipCodesApi - axios parameter creator
+ * BookingEntriesApi - axios parameter creator
  * @export
  */
-export declare const ZipCodesApiAxiosParamCreator: (configuration?: Configuration) => {
+export declare const BookingEntriesApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
-     * Retrieves the details of the zip code that was previously created. Supply the unique zip code code      that was returned when you created it and Emil Api will return the corresponding zip code information.  **Required Permissions**  \"gdv-management.operations.view\"
-     * @summary Retrieve the zip code
-     * @param {string} code Unique identifier for the object.
-     * @param {string} [authorization] Bearer Token
+     * This endpoint creates a new booking entry.  **Required Permissions**  \"accounting-management.accounts.create\"
+     * @summary Create the booking entry
+     * @param {CreateBookingEntryRequestDto} createBookingEntryRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getZipCode: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    createBookingEntry: (createBookingEntryRequestDto: CreateBookingEntryRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * Returns a list of zip codes you have previously created.        The zip codes are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"gdv-management.operations.view\"
-     * @summary List zip codes
-     * @param {string} [authorization] Bearer Token
+     * This endpoint gets a booking entry.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary Retrieve the booking entry
+     * @param {string} code
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBookingEntry: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * This endpoint gets booking entries.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary List booking entries
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
      * @param {string} [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.
      * @param {string} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
@@ -43,34 +54,36 @@ export declare const ZipCodesApiAxiosParamCreator: (configuration?: Configuratio
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listZipCodes: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Store zip codes from file.  **Required Permissions**  none
-     * @summary Create the zip codes
-     * @param {string} [authorization] Bearer Token
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    storeZipCodes: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    listBookingEntries: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
- * ZipCodesApi - functional programming interface
+ * BookingEntriesApi - functional programming interface
  * @export
  */
-export declare const ZipCodesApiFp: (configuration?: Configuration) => {
+export declare const BookingEntriesApiFp: (configuration?: Configuration) => {
+    /**
+     * This endpoint creates a new booking entry.  **Required Permissions**  \"accounting-management.accounts.create\"
+     * @summary Create the booking entry
+     * @param {CreateBookingEntryRequestDto} createBookingEntryRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBookingEntry(createBookingEntryRequestDto: CreateBookingEntryRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateBookingEntryResponseClass>>;
     /**
-     * Retrieves the details of the zip code that was previously created. Supply the unique zip code code      that was returned when you created it and Emil Api will return the corresponding zip code information.  **Required Permissions**  \"gdv-management.operations.view\"
-     * @summary Retrieve the zip code
-     * @param {string} code Unique identifier for the object.
-     * @param {string} [authorization] Bearer Token
+     * This endpoint gets a booking entry.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary Retrieve the booking entry
+     * @param {string} code
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getZipCode(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetZipCodeResponseClass>>;
+    getBookingEntry(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBookingEntryResponseClass>>;
     /**
-     * Returns a list of zip codes you have previously created.        The zip codes are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"gdv-management.operations.view\"
-     * @summary List zip codes
-     * @param {string} [authorization] Bearer Token
+     * This endpoint gets booking entries.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary List booking entries
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
      * @param {string} [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.
      * @param {string} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
@@ -81,34 +94,36 @@ export declare const ZipCodesApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listZipCodes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListZipCodesResponseClass>>;
-    /**
-     * Store zip codes from file.  **Required Permissions**  none
-     * @summary Create the zip codes
-     * @param {string} [authorization] Bearer Token
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    storeZipCodes(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StoreZipCodesResponseClass>>;
+    listBookingEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBookingEntriesResponseClass>>;
 };
 /**
- * ZipCodesApi - factory interface
+ * BookingEntriesApi - factory interface
  * @export
  */
-export declare const ZipCodesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+export declare const BookingEntriesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * Retrieves the details of the zip code that was previously created. Supply the unique zip code code      that was returned when you created it and Emil Api will return the corresponding zip code information.  **Required Permissions**  \"gdv-management.operations.view\"
-     * @summary Retrieve the zip code
-     * @param {string} code Unique identifier for the object.
-     * @param {string} [authorization] Bearer Token
+     * This endpoint creates a new booking entry.  **Required Permissions**  \"accounting-management.accounts.create\"
+     * @summary Create the booking entry
+     * @param {CreateBookingEntryRequestDto} createBookingEntryRequestDto
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getZipCode(code: string, authorization?: string, options?: any): AxiosPromise<GetZipCodeResponseClass>;
+    createBookingEntry(createBookingEntryRequestDto: CreateBookingEntryRequestDto, authorization?: string, options?: any): AxiosPromise<CreateBookingEntryResponseClass>;
     /**
-     * Returns a list of zip codes you have previously created.        The zip codes are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"gdv-management.operations.view\"
-     * @summary List zip codes
-     * @param {string} [authorization] Bearer Token
+     * This endpoint gets a booking entry.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary Retrieve the booking entry
+     * @param {string} code
+     * @param {string} expand
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBookingEntry(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetBookingEntryResponseClass>;
+    /**
+     * This endpoint gets booking entries.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary List booking entries
+     * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
      * @param {string} [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.
      * @param {string} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
@@ -119,135 +134,139 @@ export declare const ZipCodesApiFactory: (configuration?: Configuration, basePat
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listZipCodes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListZipCodesResponseClass>;
+    listBookingEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListBookingEntriesResponseClass>;
+};
+/**
+ * Request parameters for createBookingEntry operation in BookingEntriesApi.
+ * @export
+ * @interface BookingEntriesApiCreateBookingEntryRequest
+ */
+export interface BookingEntriesApiCreateBookingEntryRequest {
     /**
-     * Store zip codes from file.  **Required Permissions**  none
-     * @summary Create the zip codes
-     * @param {string} [authorization] Bearer Token
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
+     *
+     * @type {CreateBookingEntryRequestDto}
+     * @memberof BookingEntriesApiCreateBookingEntry
      */
-    storeZipCodes(authorization?: string, options?: any): AxiosPromise<StoreZipCodesResponseClass>;
-};
+    readonly createBookingEntryRequestDto: CreateBookingEntryRequestDto;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof BookingEntriesApiCreateBookingEntry
+     */
+    readonly authorization?: string;
+}
 /**
- * Request parameters for getZipCode operation in ZipCodesApi.
+ * Request parameters for getBookingEntry operation in BookingEntriesApi.
  * @export
- * @interface ZipCodesApiGetZipCodeRequest
+ * @interface BookingEntriesApiGetBookingEntryRequest
  */
-export interface ZipCodesApiGetZipCodeRequest {
+export interface BookingEntriesApiGetBookingEntryRequest {
     /**
-     * Unique identifier for the object.
+     *
      * @type {string}
-     * @memberof ZipCodesApiGetZipCode
+     * @memberof BookingEntriesApiGetBookingEntry
      */
     readonly code: string;
     /**
-     * Bearer Token
+     *
      * @type {string}
-     * @memberof ZipCodesApiGetZipCode
+     * @memberof BookingEntriesApiGetBookingEntry
+     */
+    readonly expand: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof BookingEntriesApiGetBookingEntry
      */
     readonly authorization?: string;
 }
 /**
- * Request parameters for listZipCodes operation in ZipCodesApi.
+ * Request parameters for listBookingEntries operation in BookingEntriesApi.
  * @export
- * @interface ZipCodesApiListZipCodesRequest
+ * @interface BookingEntriesApiListBookingEntriesRequest
  */
-export interface ZipCodesApiListZipCodesRequest {
+export interface BookingEntriesApiListBookingEntriesRequest {
     /**
-     * Bearer Token
+     * Bearer Token: provided by the login endpoint under the name accessToken.
      * @type {string}
-     * @memberof ZipCodesApiListZipCodes
+     * @memberof BookingEntriesApiListBookingEntries
      */
     readonly authorization?: string;
     /**
      * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
      * @type {number}
-     * @memberof ZipCodesApiListZipCodes
+     * @memberof BookingEntriesApiListBookingEntries
      */
     readonly pageSize?: number;
     /**
      * 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.
      * @type {string}
-     * @memberof ZipCodesApiListZipCodes
+     * @memberof BookingEntriesApiListBookingEntries
      */
     readonly pageToken?: string;
     /**
      * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
      * @type {string}
-     * @memberof ZipCodesApiListZipCodes
+     * @memberof BookingEntriesApiListBookingEntries
      */
     readonly filter?: string;
     /**
      * To search the list by any field, pass search&#x3D;xxx to fetch the result.
      * @type {string}
-     * @memberof ZipCodesApiListZipCodes
+     * @memberof BookingEntriesApiListBookingEntries
      */
     readonly search?: string;
     /**
      * The order parameter determines how the results should be sorted according to a specified field.     It functions similarly to an SQL ORDER BY.     Sorting can be performed in either ascending (ASC) or descending (DESC) order.     Default: ASC.
      * @type {string}
-     * @memberof ZipCodesApiListZipCodes
+     * @memberof BookingEntriesApiListBookingEntries
      */
     readonly order?: string;
     /**
      * Use this parameter to fetch additional information about the list items.     The expand query parameter increases the set of fields that appear in the response in addition to the default ones.     Expanding resources can reduce the number of API calls required to accomplish a task.     However, use this with parsimony as some expanded fields can drastically increase payload size.
      * @type {string}
-     * @memberof ZipCodesApiListZipCodes
+     * @memberof BookingEntriesApiListBookingEntries
      */
     readonly expand?: string;
     /**
      * Filters the response by one or multiple fields.          Advanced filter functionality allows you to perform more complex filtering operations.          In general, fetching filtered responses conserves bandwidth and reduces response time.
      * @type {string}
-     * @memberof ZipCodesApiListZipCodes
+     * @memberof BookingEntriesApiListBookingEntries
      */
     readonly filters?: string;
 }
 /**
- * Request parameters for storeZipCodes operation in ZipCodesApi.
- * @export
- * @interface ZipCodesApiStoreZipCodesRequest
- */
-export interface ZipCodesApiStoreZipCodesRequest {
-    /**
-     * Bearer Token
-     * @type {string}
-     * @memberof ZipCodesApiStoreZipCodes
-     */
-    readonly authorization?: string;
-}
-/**
- * ZipCodesApi - object-oriented interface
+ * BookingEntriesApi - object-oriented interface
  * @export
- * @class ZipCodesApi
+ * @class BookingEntriesApi
  * @extends {BaseAPI}
  */
-export declare class ZipCodesApi extends BaseAPI {
+export declare class BookingEntriesApi extends BaseAPI {
     /**
-     * Retrieves the details of the zip code that was previously created. Supply the unique zip code code      that was returned when you created it and Emil Api will return the corresponding zip code information.  **Required Permissions**  \"gdv-management.operations.view\"
-     * @summary Retrieve the zip code
-     * @param {ZipCodesApiGetZipCodeRequest} requestParameters Request parameters.
+     * This endpoint creates a new booking entry.  **Required Permissions**  \"accounting-management.accounts.create\"
+     * @summary Create the booking entry
+     * @param {BookingEntriesApiCreateBookingEntryRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ZipCodesApi
+     * @memberof BookingEntriesApi
      */
-    getZipCode(requestParameters: ZipCodesApiGetZipCodeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetZipCodeResponseClass, any>>;
+    createBookingEntry(requestParameters: BookingEntriesApiCreateBookingEntryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateBookingEntryResponseClass, any>>;
     /**
-     * Returns a list of zip codes you have previously created.        The zip codes are returned in sorted order, with the oldest one appearing first.        For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"gdv-management.operations.view\"
-     * @summary List zip codes
-     * @param {ZipCodesApiListZipCodesRequest} requestParameters Request parameters.
+     * This endpoint gets a booking entry.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary Retrieve the booking entry
+     * @param {BookingEntriesApiGetBookingEntryRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ZipCodesApi
+     * @memberof BookingEntriesApi
      */
-    listZipCodes(requestParameters?: ZipCodesApiListZipCodesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListZipCodesResponseClass, any>>;
+    getBookingEntry(requestParameters: BookingEntriesApiGetBookingEntryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBookingEntryResponseClass, any>>;
     /**
-     * Store zip codes from file.  **Required Permissions**  none
-     * @summary Create the zip codes
-     * @param {ZipCodesApiStoreZipCodesRequest} requestParameters Request parameters.
+     * This endpoint gets booking entries.  **Required Permissions**  \"accounting-management.accounts.view\"
+     * @summary List booking entries
+     * @param {BookingEntriesApiListBookingEntriesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ZipCodesApi
+     * @memberof BookingEntriesApi
      */
-    storeZipCodes(requestParameters?: ZipCodesApiStoreZipCodesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StoreZipCodesResponseClass, any>>;
+    listBookingEntries(requestParameters?: BookingEntriesApiListBookingEntriesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBookingEntriesResponseClass, any>>;
 }