@emilgroup/accounting-sdk-node 1.1.0 → 1.2.0

package/dist/api/zip-codes-api.d.ts

@@ -0,0 +1,253 @@
+/**
+ * EMIL GdvService
+ * The EMIL GdvService 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
+ * Do not edit the class manually.
+ */
+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';
+/**
+ * ZipCodesApi - axios parameter creator
+ * @export
+ */
+export declare const ZipCodesApiAxiosParamCreator: (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.
+     * @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}
+     */
+    getZipCode: (code: string, 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.
+     * @summary List zip codes
+     * @param {string} [authorization] Bearer Token
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. 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.
+     * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {any} [order] 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.
+     * @param {any} [expand] 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.
+     * @param {any} [filters] 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.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listZipCodes: (authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Store zip codes from file.
+     * @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>;
+};
+/**
+ * ZipCodesApi - functional programming interface
+ * @export
+ */
+export declare const ZipCodesApiFp: (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.
+     * @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}
+     */
+    getZipCode(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetZipCodeResponseClass>>;
+    /**
+     * 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.
+     * @summary List zip codes
+     * @param {string} [authorization] Bearer Token
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. 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.
+     * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {any} [order] 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.
+     * @param {any} [expand] 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.
+     * @param {any} [filters] 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.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listZipCodes(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListZipCodesResponseClass>>;
+    /**
+     * Store zip codes from file.
+     * @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>>;
+};
+/**
+ * ZipCodesApi - factory interface
+ * @export
+ */
+export declare const ZipCodesApiFactory: (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.
+     * @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}
+     */
+    getZipCode(code: string, authorization?: string, options?: any): AxiosPromise<GetZipCodeResponseClass>;
+    /**
+     * 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.
+     * @summary List zip codes
+     * @param {string} [authorization] Bearer Token
+     * @param {any} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. 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.
+     * @param {any} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @param {any} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @param {any} [order] 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.
+     * @param {any} [expand] 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.
+     * @param {any} [filters] 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.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listZipCodes(authorization?: string, pageSize?: any, pageToken?: any, filter?: any, search?: any, order?: any, expand?: any, filters?: any, options?: any): AxiosPromise<ListZipCodesResponseClass>;
+    /**
+     * Store zip codes from file.
+     * @summary Create the zip codes
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    storeZipCodes(authorization?: string, options?: any): AxiosPromise<StoreZipCodesResponseClass>;
+};
+/**
+ * Request parameters for getZipCode operation in ZipCodesApi.
+ * @export
+ * @interface ZipCodesApiGetZipCodeRequest
+ */
+export interface ZipCodesApiGetZipCodeRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof ZipCodesApiGetZipCode
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ZipCodesApiGetZipCode
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listZipCodes operation in ZipCodesApi.
+ * @export
+ * @interface ZipCodesApiListZipCodesRequest
+ */
+export interface ZipCodesApiListZipCodesRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof ZipCodesApiListZipCodes
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {any}
+     * @memberof ZipCodesApiListZipCodes
+     */
+    readonly pageSize?: any;
+    /**
+     * 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 {any}
+     * @memberof ZipCodesApiListZipCodes
+     */
+    readonly pageToken?: any;
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @type {any}
+     * @memberof ZipCodesApiListZipCodes
+     */
+    readonly filter?: any;
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {any}
+     * @memberof ZipCodesApiListZipCodes
+     */
+    readonly search?: any;
+    /**
+     * 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 {any}
+     * @memberof ZipCodesApiListZipCodes
+     */
+    readonly order?: any;
+    /**
+     * 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 {any}
+     * @memberof ZipCodesApiListZipCodes
+     */
+    readonly expand?: any;
+    /**
+     * 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 {any}
+     * @memberof ZipCodesApiListZipCodes
+     */
+    readonly filters?: any;
+}
+/**
+ * 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 ZipCodesApi
+ * @extends {BaseAPI}
+ */
+export declare class ZipCodesApi 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.
+     * @summary Retrieve the zip code
+     * @param {ZipCodesApiGetZipCodeRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ZipCodesApi
+     */
+    getZipCode(requestParameters: ZipCodesApiGetZipCodeRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetZipCodeResponseClass, 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.
+     * @summary List zip codes
+     * @param {ZipCodesApiListZipCodesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ZipCodesApi
+     */
+    listZipCodes(requestParameters?: ZipCodesApiListZipCodesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListZipCodesResponseClass, any>>;
+    /**
+     * Store zip codes from file.
+     * @summary Create the zip codes
+     * @param {ZipCodesApiStoreZipCodesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ZipCodesApi
+     */
+    storeZipCodes(requestParameters?: ZipCodesApiStoreZipCodesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StoreZipCodesResponseClass, any>>;
+}