@emilgroup/accounting-sdk-node 1.18.1-beta.4 → 1.19.0

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

@@ -1,6 +1,6 @@
 /**
- * EMIL AccountingService
- * The EMIL AccountingService API description
+ * EMIL GdvService
+ * The EMIL GdvService API description
  *
  * The version of the OpenAPI document: 1.0
  * Contact: kontakt@emil.de
@@ -12,38 +12,27 @@
 import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 import { Configuration } from '../configuration';
 import { RequestArgs, BaseAPI } from '../base';
-import { CreateBookingEntryRequestDto } from '../models';
-import { CreateBookingEntryResponseClass } from '../models';
-import { GetBookingEntryResponseClass } from '../models';
-import { ListBookingEntriesResponseClass } from '../models';
+import { GetZipCodeResponseClass } from '../models';
+import { ListZipCodesResponseClass } from '../models';
+import { StoreZipCodesResponseClass } from '../models';
 /**
- * BookingEntriesApi - axios parameter creator
+ * ZipCodesApi - axios parameter creator
  * @export
  */
-export declare const BookingEntriesApiAxiosParamCreator: (configuration?: Configuration) => {
+export declare const ZipCodesApiAxiosParamCreator: (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.
+     * 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
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    createBookingEntry: (createBookingEntryRequestDto: CreateBookingEntryRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getZipCode: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * 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.
+     * 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
      * @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.
@@ -54,36 +43,34 @@ export declare const BookingEntriesApiAxiosParamCreator: (configuration?: Config
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    listBookingEntries: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * BookingEntriesApi - functional programming interface
- * @export
- */
-export declare const BookingEntriesApiFp: (configuration?: Configuration) => {
+    listZipCodes: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     * 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.
+     * 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}
      */
-    createBookingEntry(createBookingEntryRequestDto: CreateBookingEntryRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateBookingEntryResponseClass>>;
+    storeZipCodes: (authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ZipCodesApi - functional programming interface
+ * @export
+ */
+export declare const ZipCodesApiFp: (configuration?: Configuration) => {
     /**
-     * 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.
+     * 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
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getBookingEntry(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBookingEntryResponseClass>>;
+    getZipCode(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetZipCodeResponseClass>>;
     /**
-     * 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.
+     * 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
      * @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.
@@ -94,36 +81,34 @@ export declare const BookingEntriesApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    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>>;
-};
-/**
- * BookingEntriesApi - factory interface
- * @export
- */
-export declare const BookingEntriesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    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>>;
     /**
-     * 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.
+     * 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}
      */
-    createBookingEntry(createBookingEntryRequestDto: CreateBookingEntryRequestDto, authorization?: string, options?: any): AxiosPromise<CreateBookingEntryResponseClass>;
+    storeZipCodes(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StoreZipCodesResponseClass>>;
+};
+/**
+ * ZipCodesApi - factory interface
+ * @export
+ */
+export declare const ZipCodesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
-     * 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.
+     * 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
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getBookingEntry(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetBookingEntryResponseClass>;
+    getZipCode(code: string, authorization?: string, options?: any): AxiosPromise<GetZipCodeResponseClass>;
     /**
-     * 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.
+     * 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
      * @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.
@@ -134,139 +119,135 @@ export declare const BookingEntriesApiFactory: (configuration?: Configuration, b
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    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 {
-    /**
-     *
-     * @type {CreateBookingEntryRequestDto}
-     * @memberof BookingEntriesApiCreateBookingEntry
-     */
-    readonly createBookingEntryRequestDto: CreateBookingEntryRequestDto;
+    listZipCodes(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListZipCodesResponseClass>;
     /**
-     * Bearer Token: provided by the login endpoint under the name accessToken.
-     * @type {string}
-     * @memberof BookingEntriesApiCreateBookingEntry
+     * 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}
      */
-    readonly authorization?: string;
-}
+    storeZipCodes(authorization?: string, options?: any): AxiosPromise<StoreZipCodesResponseClass>;
+};
 /**
- * Request parameters for getBookingEntry operation in BookingEntriesApi.
+ * Request parameters for getZipCode operation in ZipCodesApi.
  * @export
- * @interface BookingEntriesApiGetBookingEntryRequest
+ * @interface ZipCodesApiGetZipCodeRequest
  */
-export interface BookingEntriesApiGetBookingEntryRequest {
+export interface ZipCodesApiGetZipCodeRequest {
     /**
-     *
+     * Unique identifier for the object.
      * @type {string}
-     * @memberof BookingEntriesApiGetBookingEntry
+     * @memberof ZipCodesApiGetZipCode
      */
     readonly code: string;
     /**
-     *
+     * Bearer Token
      * @type {string}
-     * @memberof BookingEntriesApiGetBookingEntry
-     */
-    readonly expand: string;
-    /**
-     * Bearer Token: provided by the login endpoint under the name accessToken.
-     * @type {string}
-     * @memberof BookingEntriesApiGetBookingEntry
+     * @memberof ZipCodesApiGetZipCode
      */
     readonly authorization?: string;
 }
 /**
- * Request parameters for listBookingEntries operation in BookingEntriesApi.
+ * Request parameters for listZipCodes operation in ZipCodesApi.
  * @export
- * @interface BookingEntriesApiListBookingEntriesRequest
+ * @interface ZipCodesApiListZipCodesRequest
  */
-export interface BookingEntriesApiListBookingEntriesRequest {
+export interface ZipCodesApiListZipCodesRequest {
     /**
-     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * Bearer Token
      * @type {string}
-     * @memberof BookingEntriesApiListBookingEntries
+     * @memberof ZipCodesApiListZipCodes
      */
     readonly authorization?: string;
     /**
      * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
      * @type {number}
-     * @memberof BookingEntriesApiListBookingEntries
+     * @memberof ZipCodesApiListZipCodes
      */
     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 BookingEntriesApiListBookingEntries
+     * @memberof ZipCodesApiListZipCodes
      */
     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 BookingEntriesApiListBookingEntries
+     * @memberof ZipCodesApiListZipCodes
      */
     readonly filter?: string;
     /**
      * To search the list by any field, pass search&#x3D;xxx to fetch the result.
      * @type {string}
-     * @memberof BookingEntriesApiListBookingEntries
+     * @memberof ZipCodesApiListZipCodes
      */
     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 BookingEntriesApiListBookingEntries
+     * @memberof ZipCodesApiListZipCodes
      */
     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 BookingEntriesApiListBookingEntries
+     * @memberof ZipCodesApiListZipCodes
      */
     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 BookingEntriesApiListBookingEntries
+     * @memberof ZipCodesApiListZipCodes
      */
     readonly filters?: string;
 }
 /**
- * BookingEntriesApi - object-oriented interface
+ * 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
  * @export
- * @class BookingEntriesApi
+ * @class ZipCodesApi
  * @extends {BaseAPI}
  */
-export declare class BookingEntriesApi extends BaseAPI {
+export declare class ZipCodesApi extends BaseAPI {
     /**
-     * This endpoint creates a new booking entry.  **Required Permissions**  \"accounting-management.accounts.create\"
-     * @summary Create the booking entry
-     * @param {BookingEntriesApiCreateBookingEntryRequest} requestParameters Request parameters.
+     * 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.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BookingEntriesApi
+     * @memberof ZipCodesApi
      */
-    createBookingEntry(requestParameters: BookingEntriesApiCreateBookingEntryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateBookingEntryResponseClass, any>>;
+    getZipCode(requestParameters: ZipCodesApiGetZipCodeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetZipCodeResponseClass, any>>;
     /**
-     * This endpoint gets a booking entry.  **Required Permissions**  \"accounting-management.accounts.view\"
-     * @summary Retrieve the booking entry
-     * @param {BookingEntriesApiGetBookingEntryRequest} requestParameters Request parameters.
+     * 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.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BookingEntriesApi
+     * @memberof ZipCodesApi
      */
-    getBookingEntry(requestParameters: BookingEntriesApiGetBookingEntryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBookingEntryResponseClass, any>>;
+    listZipCodes(requestParameters?: ZipCodesApiListZipCodesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListZipCodesResponseClass, any>>;
     /**
-     * This endpoint gets booking entries.  **Required Permissions**  \"accounting-management.accounts.view\"
-     * @summary List booking entries
-     * @param {BookingEntriesApiListBookingEntriesRequest} requestParameters Request parameters.
+     * Store zip codes from file.  **Required Permissions**  none
+     * @summary Create the zip codes
+     * @param {ZipCodesApiStoreZipCodesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof BookingEntriesApi
+     * @memberof ZipCodesApi
      */
-    listBookingEntries(requestParameters?: BookingEntriesApiListBookingEntriesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBookingEntriesResponseClass, any>>;
+    storeZipCodes(requestParameters?: ZipCodesApiStoreZipCodesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StoreZipCodesResponseClass, any>>;
 }