@munchi_oy/core 1.9.114 → 1.9.116

package/dist/generated/api.d.ts

@@ -14463,6 +14463,111 @@ export declare const PaymentReportingBucket: {
     readonly Other: "other";
 };
 export type PaymentReportingBucket = typeof PaymentReportingBucket[keyof typeof PaymentReportingBucket];
+/**
+ *
+ * @export
+ * @interface PaymentSessionAnalyticsMethodBreakdownDto
+ */
+export interface PaymentSessionAnalyticsMethodBreakdownDto {
+    /**
+     * Paymethod code, e.g. Card / Debit / Credit / Edenred.
+     * @type {string}
+     * @memberof PaymentSessionAnalyticsMethodBreakdownDto
+     */
+    'paymethod': string;
+    /**
+     *
+     * @type {number}
+     * @memberof PaymentSessionAnalyticsMethodBreakdownDto
+     */
+    'count': number;
+    /**
+     * Minor units (e.g. cents).
+     * @type {number}
+     * @memberof PaymentSessionAnalyticsMethodBreakdownDto
+     */
+    'amount': number;
+}
+/**
+ *
+ * @export
+ * @interface PaymentSessionAnalyticsResolvedRangeDto
+ */
+export interface PaymentSessionAnalyticsResolvedRangeDto {
+    /**
+     * Schedule-resolved range start. Not calendar midnight for DAY timeSpan.
+     * @type {string}
+     * @memberof PaymentSessionAnalyticsResolvedRangeDto
+     */
+    'start': string;
+    /**
+     * Schedule-resolved range end. Not calendar midnight for DAY timeSpan.
+     * @type {string}
+     * @memberof PaymentSessionAnalyticsResolvedRangeDto
+     */
+    'end': string;
+}
+/**
+ *
+ * @export
+ * @interface PaymentSessionAnalyticsResponseDto
+ */
+export interface PaymentSessionAnalyticsResponseDto {
+    /**
+     *
+     * @type {number}
+     * @memberof PaymentSessionAnalyticsResponseDto
+     */
+    'orderCount': number;
+    /**
+     * Minor units (e.g. cents).
+     * @type {number}
+     * @memberof PaymentSessionAnalyticsResponseDto
+     */
+    'grossSales': number;
+    /**
+     * Minor units (e.g. cents).
+     * @type {number}
+     * @memberof PaymentSessionAnalyticsResponseDto
+     */
+    'tips': number;
+    /**
+     * Minor units (e.g. cents).
+     * @type {number}
+     * @memberof PaymentSessionAnalyticsResponseDto
+     */
+    'surcharges': number;
+    /**
+     *
+     * @type {number}
+     * @memberof PaymentSessionAnalyticsResponseDto
+     */
+    'refundCount': number;
+    /**
+     * Minor units (e.g. cents).
+     * @type {number}
+     * @memberof PaymentSessionAnalyticsResponseDto
+     */
+    'refundAmount': number;
+    /**
+     * grossSales - refundAmount, computed server-side.
+     * @type {number}
+     * @memberof PaymentSessionAnalyticsResponseDto
+     */
+    'netSales': number;
+    /**
+     *
+     * @type {Array<PaymentSessionAnalyticsMethodBreakdownDto>}
+     * @memberof PaymentSessionAnalyticsResponseDto
+     */
+    'byPaymentMethod': Array<PaymentSessionAnalyticsMethodBreakdownDto>;
+    /**
+     *
+     * @type {PaymentSessionAnalyticsResolvedRangeDto}
+     * @memberof PaymentSessionAnalyticsResponseDto
+     */
+    'resolvedRange': PaymentSessionAnalyticsResolvedRangeDto;
+}
 /**
  *
  * @export
@@ -36482,6 +36587,17 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
      * @throws {RequiredError}
      */
     getPaymentSession: (clientToken: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Scoped to whatever channel the caller authenticates as (e.g. a paired Munchi Pay terminal only ever sees its own channel=MunchiPay charges — the same population as its Transactions tab). DAY timeSpan is resolved against the business\'s real opening-hours schedule, not calendar midnight; resolvedRange in the response reflects the actual window used, so the UI and any printed reconciliation can display/print the same period the query ran against.
+     * @summary Sales/tips/surcharges/refunds summary, scoped to the calling app channel
+     * @param {number} businessId The internal business ID.
+     * @param {TimeSpan} timeSpan Time span, required. DAY is resolved against the business\&#39;s actual opening-hours schedule (e.g. 08:00–08:00 next day), not calendar midnight — omitting it would silently fall back to a naive UTC-midnight range.
+     * @param {string} [start] Start date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {string} [end] End date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPaymentSessionAnalytics: (businessId: number, timeSpan: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Creates a PaymentSession row, pushes the transaction to the station\'s Nets terminal (async — the result arrives via the Nets webhook), returns a client-facing token to poll. Idempotent via X-Idempotency-Key header.
      * @summary Initiate a Nets terminal payment session
@@ -36645,6 +36761,17 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getPaymentSession(clientToken: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
+    /**
+     * Scoped to whatever channel the caller authenticates as (e.g. a paired Munchi Pay terminal only ever sees its own channel=MunchiPay charges — the same population as its Transactions tab). DAY timeSpan is resolved against the business\'s real opening-hours schedule, not calendar midnight; resolvedRange in the response reflects the actual window used, so the UI and any printed reconciliation can display/print the same period the query ran against.
+     * @summary Sales/tips/surcharges/refunds summary, scoped to the calling app channel
+     * @param {number} businessId The internal business ID.
+     * @param {TimeSpan} timeSpan Time span, required. DAY is resolved against the business\&#39;s actual opening-hours schedule (e.g. 08:00–08:00 next day), not calendar midnight — omitting it would silently fall back to a naive UTC-midnight range.
+     * @param {string} [start] Start date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {string} [end] End date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPaymentSessionAnalytics(businessId: number, timeSpan: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionAnalyticsResponseDto>>;
     /**
      * Creates a PaymentSession row, pushes the transaction to the station\'s Nets terminal (async — the result arrives via the Nets webhook), returns a client-facing token to poll. Idempotent via X-Idempotency-Key header.
      * @summary Initiate a Nets terminal payment session
@@ -36808,6 +36935,17 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
      * @throws {RequiredError}
      */
     getPaymentSession(clientToken: string, options?: any): AxiosPromise<PaymentSessionViewDto>;
+    /**
+     * Scoped to whatever channel the caller authenticates as (e.g. a paired Munchi Pay terminal only ever sees its own channel=MunchiPay charges — the same population as its Transactions tab). DAY timeSpan is resolved against the business\'s real opening-hours schedule, not calendar midnight; resolvedRange in the response reflects the actual window used, so the UI and any printed reconciliation can display/print the same period the query ran against.
+     * @summary Sales/tips/surcharges/refunds summary, scoped to the calling app channel
+     * @param {number} businessId The internal business ID.
+     * @param {TimeSpan} timeSpan Time span, required. DAY is resolved against the business\&#39;s actual opening-hours schedule (e.g. 08:00–08:00 next day), not calendar midnight — omitting it would silently fall back to a naive UTC-midnight range.
+     * @param {string} [start] Start date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {string} [end] End date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPaymentSessionAnalytics(businessId: number, timeSpan: TimeSpan, start?: string, end?: string, options?: any): AxiosPromise<PaymentSessionAnalyticsResponseDto>;
     /**
      * Creates a PaymentSession row, pushes the transaction to the station\'s Nets terminal (async — the result arrives via the Nets webhook), returns a client-facing token to poll. Idempotent via X-Idempotency-Key header.
      * @summary Initiate a Nets terminal payment session
@@ -36975,6 +37113,18 @@ export interface PaymentSessionApiInterface {
      * @memberof PaymentSessionApiInterface
      */
     getPaymentSession(clientToken: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
+    /**
+     * Scoped to whatever channel the caller authenticates as (e.g. a paired Munchi Pay terminal only ever sees its own channel=MunchiPay charges — the same population as its Transactions tab). DAY timeSpan is resolved against the business\'s real opening-hours schedule, not calendar midnight; resolvedRange in the response reflects the actual window used, so the UI and any printed reconciliation can display/print the same period the query ran against.
+     * @summary Sales/tips/surcharges/refunds summary, scoped to the calling app channel
+     * @param {number} businessId The internal business ID.
+     * @param {TimeSpan} timeSpan Time span, required. DAY is resolved against the business\&#39;s actual opening-hours schedule (e.g. 08:00–08:00 next day), not calendar midnight — omitting it would silently fall back to a naive UTC-midnight range.
+     * @param {string} [start] Start date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {string} [end] End date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentSessionApiInterface
+     */
+    getPaymentSessionAnalytics(businessId: number, timeSpan: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionAnalyticsResponseDto>;
     /**
      * Creates a PaymentSession row, pushes the transaction to the station\'s Nets terminal (async — the result arrives via the Nets webhook), returns a client-facing token to poll. Idempotent via X-Idempotency-Key header.
      * @summary Initiate a Nets terminal payment session
@@ -37159,6 +37309,18 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
      * @memberof PaymentSessionApi
      */
     getPaymentSession(clientToken: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
+    /**
+     * Scoped to whatever channel the caller authenticates as (e.g. a paired Munchi Pay terminal only ever sees its own channel=MunchiPay charges — the same population as its Transactions tab). DAY timeSpan is resolved against the business\'s real opening-hours schedule, not calendar midnight; resolvedRange in the response reflects the actual window used, so the UI and any printed reconciliation can display/print the same period the query ran against.
+     * @summary Sales/tips/surcharges/refunds summary, scoped to the calling app channel
+     * @param {number} businessId The internal business ID.
+     * @param {TimeSpan} timeSpan Time span, required. DAY is resolved against the business\&#39;s actual opening-hours schedule (e.g. 08:00–08:00 next day), not calendar midnight — omitting it would silently fall back to a naive UTC-midnight range.
+     * @param {string} [start] Start date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {string} [end] End date (ISO 8601). Required when timeSpan is CUSTOM.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PaymentSessionApi
+     */
+    getPaymentSessionAnalytics(businessId: number, timeSpan: TimeSpan, start?: string, end?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionAnalyticsResponseDto, any, {}>>;
     /**
      * Creates a PaymentSession row, pushes the transaction to the station\'s Nets terminal (async — the result arrives via the Nets webhook), returns a client-facing token to poll. Idempotent via X-Idempotency-Key header.
      * @summary Initiate a Nets terminal payment session