@emilgroup/payment-sdk 1.14.1-beta.50 → 1.14.1-beta.52

package/dist/api/credit-allocation-api.d.ts

@@ -0,0 +1,263 @@
+/**
+ * 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 { CreateCreditAllocationRequestDto } from '../models';
+import { CreateCreditAllocationResponseClass } from '../models';
+import { GetCreditAllocationResponseClass } from '../models';
+import { ListCreditAllocationsResponseClass } from '../models';
+/**
+ * CreditAllocationApi - axios parameter creator
+ * @export
+ */
+export declare const CreditAllocationApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Create a credit allocation for existing exceeding credits.  **Required Permissions**  \"payment-management.payments.create\", \"accounting-management.financial-accounts.view\"
+     * @summary Create the credit allocation
+     * @param {CreateCreditAllocationRequestDto} createCreditAllocationRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAllocateCredit: (createCreditAllocationRequestDto: CreateCreditAllocationRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get a credit allocation entry by code.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary Retrieve the credit allocation entry
+     * @param {string} code Code of the credit allocation to get
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCreditAllocation: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of credit allocations you have previously created.          The credit allocations 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 credit allocations
+     * @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: code, id, policyCode, 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: code, policyCode&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, 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: exceedingCredits&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: code, id, policyCode, createdAt, updatedAt&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCreditAllocations: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * CreditAllocationApi - functional programming interface
+ * @export
+ */
+export declare const CreditAllocationApiFp: (configuration?: Configuration) => {
+    /**
+     * Create a credit allocation for existing exceeding credits.  **Required Permissions**  \"payment-management.payments.create\", \"accounting-management.financial-accounts.view\"
+     * @summary Create the credit allocation
+     * @param {CreateCreditAllocationRequestDto} createCreditAllocationRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAllocateCredit(createCreditAllocationRequestDto: CreateCreditAllocationRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCreditAllocationResponseClass>>;
+    /**
+     * Get a credit allocation entry by code.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary Retrieve the credit allocation entry
+     * @param {string} code Code of the credit allocation to get
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCreditAllocation(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCreditAllocationResponseClass>>;
+    /**
+     * Returns a list of credit allocations you have previously created.          The credit allocations 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 credit allocations
+     * @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: code, id, policyCode, 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: code, policyCode&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, 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: exceedingCredits&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: code, id, policyCode, createdAt, updatedAt&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCreditAllocations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCreditAllocationsResponseClass>>;
+};
+/**
+ * CreditAllocationApi - factory interface
+ * @export
+ */
+export declare const CreditAllocationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Create a credit allocation for existing exceeding credits.  **Required Permissions**  \"payment-management.payments.create\", \"accounting-management.financial-accounts.view\"
+     * @summary Create the credit allocation
+     * @param {CreateCreditAllocationRequestDto} createCreditAllocationRequestDto
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createAllocateCredit(createCreditAllocationRequestDto: CreateCreditAllocationRequestDto, authorization?: string, options?: any): AxiosPromise<CreateCreditAllocationResponseClass>;
+    /**
+     * Get a credit allocation entry by code.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary Retrieve the credit allocation entry
+     * @param {string} code Code of the credit allocation to get
+     * @param {string} [authorization] Bearer Token
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCreditAllocation(code: string, authorization?: string, options?: any): AxiosPromise<GetCreditAllocationResponseClass>;
+    /**
+     * Returns a list of credit allocations you have previously created.          The credit allocations 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 credit allocations
+     * @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: code, id, policyCode, 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: code, policyCode&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, 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: exceedingCredits&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: code, id, policyCode, createdAt, updatedAt&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listCreditAllocations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCreditAllocationsResponseClass>;
+};
+/**
+ * Request parameters for createAllocateCredit operation in CreditAllocationApi.
+ * @export
+ * @interface CreditAllocationApiCreateAllocateCreditRequest
+ */
+export interface CreditAllocationApiCreateAllocateCreditRequest {
+    /**
+     *
+     * @type {CreateCreditAllocationRequestDto}
+     * @memberof CreditAllocationApiCreateAllocateCredit
+     */
+    readonly createCreditAllocationRequestDto: CreateCreditAllocationRequestDto;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof CreditAllocationApiCreateAllocateCredit
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for getCreditAllocation operation in CreditAllocationApi.
+ * @export
+ * @interface CreditAllocationApiGetCreditAllocationRequest
+ */
+export interface CreditAllocationApiGetCreditAllocationRequest {
+    /**
+     * Code of the credit allocation to get
+     * @type {string}
+     * @memberof CreditAllocationApiGetCreditAllocation
+     */
+    readonly code: string;
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof CreditAllocationApiGetCreditAllocation
+     */
+    readonly authorization?: string;
+}
+/**
+ * Request parameters for listCreditAllocations operation in CreditAllocationApi.
+ * @export
+ * @interface CreditAllocationApiListCreditAllocationsRequest
+ */
+export interface CreditAllocationApiListCreditAllocationsRequest {
+    /**
+     * Bearer Token
+     * @type {string}
+     * @memberof CreditAllocationApiListCreditAllocations
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof CreditAllocationApiListCreditAllocations
+     */
+    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 CreditAllocationApiListCreditAllocations
+     */
+    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: code, id, policyCode, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof CreditAllocationApiListCreditAllocations
+     */
+    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: code, policyCode&lt;/i&gt;
+     * @type {string}
+     * @memberof CreditAllocationApiListCreditAllocations
+     */
+    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, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof CreditAllocationApiListCreditAllocations
+     */
+    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: exceedingCredits&lt;i&gt;
+     * @type {string}
+     * @memberof CreditAllocationApiListCreditAllocations
+     */
+    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: code, id, policyCode, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof CreditAllocationApiListCreditAllocations
+     */
+    readonly filters?: string;
+}
+/**
+ * CreditAllocationApi - object-oriented interface
+ * @export
+ * @class CreditAllocationApi
+ * @extends {BaseAPI}
+ */
+export declare class CreditAllocationApi extends BaseAPI {
+    /**
+     * Create a credit allocation for existing exceeding credits.  **Required Permissions**  \"payment-management.payments.create\", \"accounting-management.financial-accounts.view\"
+     * @summary Create the credit allocation
+     * @param {CreditAllocationApiCreateAllocateCreditRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CreditAllocationApi
+     */
+    createAllocateCredit(requestParameters: CreditAllocationApiCreateAllocateCreditRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateCreditAllocationResponseClass, any, {}>>;
+    /**
+     * Get a credit allocation entry by code.  **Required Permissions**  \"payment-management.payments.view\"
+     * @summary Retrieve the credit allocation entry
+     * @param {CreditAllocationApiGetCreditAllocationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CreditAllocationApi
+     */
+    getCreditAllocation(requestParameters: CreditAllocationApiGetCreditAllocationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCreditAllocationResponseClass, any, {}>>;
+    /**
+     * Returns a list of credit allocations you have previously created.          The credit allocations 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 credit allocations
+     * @param {CreditAllocationApiListCreditAllocationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CreditAllocationApi
+     */
+    listCreditAllocations(requestParameters?: CreditAllocationApiListCreditAllocationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCreditAllocationsResponseClass, any, {}>>;
+}