@emilgroup/payment-sdk 1.14.1-beta.54 → 1.14.1-beta.56

package/dist/api/billing-addresses-api.d.ts

@@ -0,0 +1,327 @@
+/**
+ * Emil Payment Service
+ * This service directly communicates with the various Payment Service Providers (PSPs)   in order to charge or refund customers. This service will automatically connect to the PSP linked   in your admin configuration; meaning if you configured Stripe, it will automatically create a payment   on Stripe when you create it in Emil.
+ *
+ * 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 { CreateBillingAddressRequestDto } from '../models';
+import { CreateBillingAddressResponseClass } from '../models';
+import { GetBillingAddressResponseClass } from '../models';
+import { ListBillingAddressesResponseClass } from '../models';
+/**
+ * BillingAddressesApi - axios parameter creator
+ * @export
+ */
+export declare const BillingAddressesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * This will create a new billing address for a specified account or partner  **Required Permissions**  \"payment-management.payments.create\"
+     * @summary Create the Billing Address
+     * @param {CreateBillingAddressRequestDto} createBillingAddressRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBillingAddress: (createBillingAddressRequestDto: CreateBillingAddressRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Deletes a billing address by code  **Required Permissions**  \"payment-management.payments.delete\"
+     * @summary Delete the Billing Address
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteBillingAddress: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Retrieves the details of the Billing Address that was previously created. Supply the unique Billing Address code      that was returned when you created it and Emil Api will return the corresponding Billing Address information.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary Retrieve the Billing Address
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: &lt;i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBillingAddress: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of Billing Addresses you have previously created.          The Billing Addresses are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary List Billing Addresses
+     * @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.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: firstName, lastName, accountCode, partnerCode&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: &lt;i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode, createdAt, updatedAt&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBillingAddresses: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * BillingAddressesApi - functional programming interface
+ * @export
+ */
+export declare const BillingAddressesApiFp: (configuration?: Configuration) => {
+    /**
+     * This will create a new billing address for a specified account or partner  **Required Permissions**  \"payment-management.payments.create\"
+     * @summary Create the Billing Address
+     * @param {CreateBillingAddressRequestDto} createBillingAddressRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBillingAddress(createBillingAddressRequestDto: CreateBillingAddressRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateBillingAddressResponseClass>>;
+    /**
+     * Deletes a billing address by code  **Required Permissions**  \"payment-management.payments.delete\"
+     * @summary Delete the Billing Address
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteBillingAddress(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
+    /**
+     * Retrieves the details of the Billing Address that was previously created. Supply the unique Billing Address code      that was returned when you created it and Emil Api will return the corresponding Billing Address information.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary Retrieve the Billing Address
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: &lt;i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBillingAddress(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBillingAddressResponseClass>>;
+    /**
+     * Returns a list of Billing Addresses you have previously created.          The Billing Addresses are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary List Billing Addresses
+     * @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.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: firstName, lastName, accountCode, partnerCode&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: &lt;i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode, createdAt, updatedAt&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBillingAddresses(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBillingAddressesResponseClass>>;
+};
+/**
+ * BillingAddressesApi - factory interface
+ * @export
+ */
+export declare const BillingAddressesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * This will create a new billing address for a specified account or partner  **Required Permissions**  \"payment-management.payments.create\"
+     * @summary Create the Billing Address
+     * @param {CreateBillingAddressRequestDto} createBillingAddressRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createBillingAddress(createBillingAddressRequestDto: CreateBillingAddressRequestDto, authorization?: string, options?: any): AxiosPromise<CreateBillingAddressResponseClass>;
+    /**
+     * Deletes a billing address by code  **Required Permissions**  \"payment-management.payments.delete\"
+     * @summary Delete the Billing Address
+     * @param {string} code Unique identifier for the object.
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    deleteBillingAddress(code: string, authorization?: string, options?: any): AxiosPromise<object>;
+    /**
+     * Retrieves the details of the Billing Address that was previously created. Supply the unique Billing Address code      that was returned when you created it and Emil Api will return the corresponding Billing Address information.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary Retrieve the Billing Address
+     * @param {string} code
+     * @param {string} [authorization] Bearer Token
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: &lt;i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBillingAddress(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetBillingAddressResponseClass>;
+    /**
+     * Returns a list of Billing Addresses you have previously created.          The Billing Addresses are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary List Billing Addresses
+     * @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.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: firstName, lastName, accountCode, partnerCode&lt;/i&gt;
+     * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, createdAt, updatedAt&lt;/i&gt;
+     * @param {string} [expand] Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: &lt;i&gt;
+     * @param {string} [filters] Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode, createdAt, updatedAt&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listBillingAddresses(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListBillingAddressesResponseClass>;
+};
+/**
+ * Request parameters for createBillingAddress operation in BillingAddressesApi.
+ * @export
+ * @interface BillingAddressesApiCreateBillingAddressRequest
+ */
+export interface BillingAddressesApiCreateBillingAddressRequest {
+    /**
+     *
+     * @type {CreateBillingAddressRequestDto}
+     * @memberof BillingAddressesApiCreateBillingAddress
+     */
+    readonly createBillingAddressRequestDto: CreateBillingAddressRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BillingAddressesApiCreateBillingAddress
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for deleteBillingAddress operation in BillingAddressesApi.
+ * @export
+ * @interface BillingAddressesApiDeleteBillingAddressRequest
+ */
+export interface BillingAddressesApiDeleteBillingAddressRequest {
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof BillingAddressesApiDeleteBillingAddress
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BillingAddressesApiDeleteBillingAddress
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getBillingAddress operation in BillingAddressesApi.
+ * @export
+ * @interface BillingAddressesApiGetBillingAddressRequest
+ */
+export interface BillingAddressesApiGetBillingAddressRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof BillingAddressesApiGetBillingAddress
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BillingAddressesApiGetBillingAddress
+     */
+    readonly authorization?: string;
+    /**
+     * Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: &lt;i&gt;
+     * @type {string}
+     * @memberof BillingAddressesApiGetBillingAddress
+     */
+    readonly expand?: string;
+}
+/**
+ * Request parameters for listBillingAddresses operation in BillingAddressesApi.
+ * @export
+ * @interface BillingAddressesApiListBillingAddressesRequest
+ */
+export interface BillingAddressesApiListBillingAddressesRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof BillingAddressesApiListBillingAddresses
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof BillingAddressesApiListBillingAddresses
+     */
+    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 BillingAddressesApiListBillingAddresses
+     */
+    readonly pageToken?: string;
+    /**
+     * Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof BillingAddressesApiListBillingAddresses
+     */
+    readonly filter?: string;
+    /**
+     * Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: firstName, lastName, accountCode, partnerCode&lt;/i&gt;
+     * @type {string}
+     * @memberof BillingAddressesApiListBillingAddresses
+     */
+    readonly search?: string;
+    /**
+     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof BillingAddressesApiListBillingAddresses
+     */
+    readonly order?: string;
+    /**
+     * Expand to fetch additional information about the list items.       Expanding resources can reduce the number of API calls required to accomplish a task.       Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt;       &lt;br/&gt;       &lt;i&gt;Allowed values: &lt;i&gt;
+     * @type {string}
+     * @memberof BillingAddressesApiListBillingAddresses
+     */
+    readonly expand?: string;
+    /**
+     * Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, city, zipCode, countryCode, accountCode, partnerCode, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof BillingAddressesApiListBillingAddresses
+     */
+    readonly filters?: string;
+}
+/**
+ * BillingAddressesApi - object-oriented interface
+ * @export
+ * @class BillingAddressesApi
+ * @extends {BaseAPI}
+ */
+export declare class BillingAddressesApi extends BaseAPI {
+    /**
+     * This will create a new billing address for a specified account or partner  **Required Permissions**  \"payment-management.payments.create\"
+     * @summary Create the Billing Address
+     * @param {BillingAddressesApiCreateBillingAddressRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingAddressesApi
+     */
+    createBillingAddress(requestParameters: BillingAddressesApiCreateBillingAddressRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateBillingAddressResponseClass, any, {}>>;
+    /**
+     * Deletes a billing address by code  **Required Permissions**  \"payment-management.payments.delete\"
+     * @summary Delete the Billing Address
+     * @param {BillingAddressesApiDeleteBillingAddressRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingAddressesApi
+     */
+    deleteBillingAddress(requestParameters: BillingAddressesApiDeleteBillingAddressRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any, {}>>;
+    /**
+     * Retrieves the details of the Billing Address that was previously created. Supply the unique Billing Address code      that was returned when you created it and Emil Api will return the corresponding Billing Address information.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary Retrieve the Billing Address
+     * @param {BillingAddressesApiGetBillingAddressRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingAddressesApi
+     */
+    getBillingAddress(requestParameters: BillingAddressesApiGetBillingAddressRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBillingAddressResponseClass, any, {}>>;
+    /**
+     * Returns a list of Billing Addresses you have previously created.          The Billing Addresses are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary List Billing Addresses
+     * @param {BillingAddressesApiListBillingAddressesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingAddressesApi
+     */
+    listBillingAddresses(requestParameters?: BillingAddressesApiListBillingAddressesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBillingAddressesResponseClass, any, {}>>;
+}