@gewis/sudosos-client 0.0.0-develop.6e7fadc → 0.0.0-develop.e05135a

package/dist/api.d.ts

@@ -5605,6 +5605,73 @@ export interface TransferResponse {
      */
     'sellerPayout'?: SellerPayoutResponse;
 }
+/**
+ *
+ * @export
+ * @interface TransferSummaryResponse
+ */
+export interface TransferSummaryResponse {
+    /**
+     *
+     * @type {TransferAggregateResponse}
+     * @memberof TransferSummaryResponse
+     */
+    'total': TransferAggregateResponse;
+    /**
+     *
+     * @type {TransferAggregateResponse}
+     * @memberof TransferSummaryResponse
+     */
+    'deposits': TransferAggregateResponse;
+    /**
+     *
+     * @type {TransferAggregateResponse}
+     * @memberof TransferSummaryResponse
+     */
+    'payoutRequests': TransferAggregateResponse;
+    /**
+     *
+     * @type {TransferAggregateResponse}
+     * @memberof TransferSummaryResponse
+     */
+    'sellerPayouts': TransferAggregateResponse;
+    /**
+     *
+     * @type {TransferAggregateResponse}
+     * @memberof TransferSummaryResponse
+     */
+    'invoices': TransferAggregateResponse;
+    /**
+     *
+     * @type {TransferAggregateResponse}
+     * @memberof TransferSummaryResponse
+     */
+    'creditInvoices': TransferAggregateResponse;
+    /**
+     *
+     * @type {TransferAggregateResponse}
+     * @memberof TransferSummaryResponse
+     */
+    'fines': TransferAggregateResponse;
+    /**
+     *
+     * @type {TransferAggregateResponse}
+     * @memberof TransferSummaryResponse
+     */
+    'waivedFines': TransferAggregateResponse;
+    /**
+     *
+     * @type {TransferAggregateResponse}
+     * @memberof TransferSummaryResponse
+     */
+    'writeOffs': TransferAggregateResponse;
+    /**
+     *
+     * @type {TransferAggregateResponse}
+     * @memberof TransferSummaryResponse
+     */
+    'inactiveAdministrativeCosts': TransferAggregateResponse;
+}
 /**
  *
  * @export
@@ -14980,7 +15047,7 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
      * @param {string} [tillDate] End date for selected transfers (exclusive)
      * @param {number} [fromId] Filter transfers from this user ID
      * @param {number} [toId] Filter transfers to this user ID
-     * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
+     * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -14993,6 +15060,17 @@ export declare const TransfersApiAxiosParamCreator: (configuration?: Configurati
      * @throws {RequiredError}
      */
     getTransferPdf: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
+     * @param {string} [fromDate] Start date for selected transfers (inclusive)
+     * @param {string} [tillDate] End date for selected transfers (exclusive)
+     * @param {number} [fromId] Filter transfers from this user ID
+     * @param {number} [toId] Filter transfers to this user ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTransferSummary: (fromDate?: string, tillDate?: string, fromId?: number, toId?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * TransfersApi - functional programming interface
@@ -15041,7 +15119,7 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
      * @param {string} [tillDate] End date for selected transfers (exclusive)
      * @param {number} [fromId] Filter transfers from this user ID
      * @param {number} [toId] Filter transfers to this user ID
-     * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
+     * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -15054,6 +15132,17 @@ export declare const TransfersApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getTransferPdf(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
+    /**
+     *
+     * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
+     * @param {string} [fromDate] Start date for selected transfers (inclusive)
+     * @param {string} [tillDate] End date for selected transfers (exclusive)
+     * @param {number} [fromId] Filter transfers from this user ID
+     * @param {number} [toId] Filter transfers to this user ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTransferSummary(fromDate?: string, tillDate?: string, fromId?: number, toId?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransferSummaryResponse>>;
 };
 /**
  * TransfersApi - factory interface
@@ -15108,6 +15197,14 @@ export declare const TransfersApiFactory: (configuration?: Configuration, basePa
      * @throws {RequiredError}
      */
     getTransferPdf(requestParameters: TransfersApiGetTransferPdfRequest, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+    /**
+     *
+     * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
+     * @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getTransferSummary(requestParameters?: TransfersApiGetTransferSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransferSummaryResponse>;
 };
 /**
  * Request parameters for createTransfer operation in TransfersApi.
@@ -15210,7 +15307,7 @@ export interface TransfersApiGetTransferAggregateRequest {
      */
     readonly toId?: number;
     /**
-     * Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
+     * Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
      * @type {string}
      * @memberof TransfersApiGetTransferAggregate
      */
@@ -15229,6 +15326,37 @@ export interface TransfersApiGetTransferPdfRequest {
      */
     readonly id: number;
 }
+/**
+ * Request parameters for getTransferSummary operation in TransfersApi.
+ * @export
+ * @interface TransfersApiGetTransferSummaryRequest
+ */
+export interface TransfersApiGetTransferSummaryRequest {
+    /**
+     * Start date for selected transfers (inclusive)
+     * @type {string}
+     * @memberof TransfersApiGetTransferSummary
+     */
+    readonly fromDate?: string;
+    /**
+     * End date for selected transfers (exclusive)
+     * @type {string}
+     * @memberof TransfersApiGetTransferSummary
+     */
+    readonly tillDate?: string;
+    /**
+     * Filter transfers from this user ID
+     * @type {number}
+     * @memberof TransfersApiGetTransferSummary
+     */
+    readonly fromId?: number;
+    /**
+     * Filter transfers to this user ID
+     * @type {number}
+     * @memberof TransfersApiGetTransferSummary
+     */
+    readonly toId?: number;
+}
 /**
  * TransfersApi - object-oriented interface
  * @export
@@ -15290,6 +15418,15 @@ export declare class TransfersApi extends BaseAPI {
      * @memberof TransfersApi
      */
     getTransferPdf(requestParameters: TransfersApiGetTransferPdfRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
+    /**
+     *
+     * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
+     * @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TransfersApi
+     */
+    getTransferSummary(requestParameters?: TransfersApiGetTransferSummaryRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<TransferSummaryResponse, any, {}>>;
 }
 /**
  * UserNotificationPreferencesApi - axios parameter creator

package/dist/api.js

@@ -11260,7 +11260,7 @@ const TransfersApiAxiosParamCreator = function (configuration) {
          * @param {string} [tillDate] End date for selected transfers (exclusive)
          * @param {number} [fromId] Filter transfers from this user ID
          * @param {number} [toId] Filter transfers to this user ID
-         * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
+         * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -11333,6 +11333,50 @@ const TransfersApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         *
+         * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
+         * @param {string} [fromDate] Start date for selected transfers (inclusive)
+         * @param {string} [tillDate] End date for selected transfers (exclusive)
+         * @param {number} [fromId] Filter transfers from this user ID
+         * @param {number} [toId] Filter transfers to this user ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getTransferSummary: async (fromDate, tillDate, fromId, toId, options = {}) => {
+            const localVarPath = `/transfers/summary`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication JWT required
+            // http bearer authentication required
+            await (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            if (fromDate !== undefined) {
+                localVarQueryParameter['fromDate'] = fromDate;
+            }
+            if (tillDate !== undefined) {
+                localVarQueryParameter['tillDate'] = tillDate;
+            }
+            if (fromId !== undefined) {
+                localVarQueryParameter['fromId'] = fromId;
+            }
+            if (toId !== undefined) {
+                localVarQueryParameter['toId'] = toId;
+            }
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
     };
 };
 exports.TransfersApiAxiosParamCreator = TransfersApiAxiosParamCreator;
@@ -11405,7 +11449,7 @@ const TransfersApiFp = function (configuration) {
          * @param {string} [tillDate] End date for selected transfers (exclusive)
          * @param {number} [fromId] Filter transfers from this user ID
          * @param {number} [toId] Filter transfers to this user ID
-         * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, invoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
+         * @param {string} [category] Restrict to a specific transfer category: deposit, payoutRequest, sellerPayout, invoice, creditInvoice, fine, waivedFines, writeOff, inactiveAdministrativeCost
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
@@ -11428,6 +11472,22 @@ const TransfersApiFp = function (configuration) {
             const operationBasePath = base_1.operationServerMap['TransfersApi.getTransferPdf']?.[index]?.url;
             return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
         },
+        /**
+         *
+         * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
+         * @param {string} [fromDate] Start date for selected transfers (inclusive)
+         * @param {string} [tillDate] End date for selected transfers (exclusive)
+         * @param {number} [fromId] Filter transfers from this user ID
+         * @param {number} [toId] Filter transfers to this user ID
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getTransferSummary(fromDate, tillDate, fromId, toId, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getTransferSummary(fromDate, tillDate, fromId, toId, options);
+            const index = configuration?.serverIndex ?? 0;
+            const operationBasePath = base_1.operationServerMap['TransfersApi.getTransferSummary']?.[index]?.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, operationBasePath || basePath);
+        },
     };
 };
 exports.TransfersApiFp = TransfersApiFp;
@@ -11498,6 +11558,16 @@ const TransfersApiFactory = function (configuration, basePath, axios) {
         getTransferPdf(requestParameters, options) {
             return localVarFp.getTransferPdf(requestParameters.id, options).then((request) => request(axios, basePath));
         },
+        /**
+         *
+         * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
+         * @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getTransferSummary(requestParameters = {}, options) {
+            return localVarFp.getTransferSummary(requestParameters.fromDate, requestParameters.tillDate, requestParameters.fromId, requestParameters.toId, options).then((request) => request(axios, basePath));
+        },
     };
 };
 exports.TransfersApiFactory = TransfersApiFactory;
@@ -11574,6 +11644,17 @@ class TransfersApi extends base_1.BaseAPI {
     getTransferPdf(requestParameters, options) {
         return (0, exports.TransfersApiFp)(this.configuration).getTransferPdf(requestParameters.id, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     *
+     * @summary Returns an aggregate breakdown of transfers for every category plus an overall total
+     * @param {TransfersApiGetTransferSummaryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TransfersApi
+     */
+    getTransferSummary(requestParameters = {}, options) {
+        return (0, exports.TransfersApiFp)(this.configuration).getTransferSummary(requestParameters.fromDate, requestParameters.tillDate, requestParameters.fromId, requestParameters.toId, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 exports.TransfersApi = TransfersApi;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gewis/sudosos-client",
-  "version": "0.0.0-develop.6e7fadc",
+  "version": "0.0.0-develop.e05135a",
   "description": "Auto-generated TypeScript-Axios client for the SudoSOS API",
   "license": "AGPL-3.0-or-later",
   "main": "dist/index.js",