@munchi_oy/core 1.9.114 → 1.9.117

package/dist/generated/api.d.ts

@@ -3483,6 +3483,12 @@ export interface CreateManualSessionDto {
      * @memberof CreateManualSessionDto
      */
     'businessId': number;
+    /**
+     * The gateway session this payment stands in for, when the till settles a card charge it could not confirm. Honoured only for a manual card entry.
+     * @type {string}
+     * @memberof CreateManualSessionDto
+     */
+    'settlesSessionId'?: string;
     /**
      * The POS order ID this payment session is for.
      * @type {string}
@@ -4668,6 +4674,17 @@ export interface DeliveryDtoLocation {
      */
     'coordinates': LocationDtoCoordinates | null;
 }
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export declare const DeliveryIntentStatus: {
+    readonly Pending: "pending";
+    readonly Dispatched: "dispatched";
+    readonly Failed: "failed";
+};
+export type DeliveryIntentStatus = typeof DeliveryIntentStatus[keyof typeof DeliveryIntentStatus];
 /**
  *
  * @export
@@ -13310,6 +13327,7 @@ export interface PaymentErrorDto {
 export declare const PaymentEventType: {
     readonly StatusChanged: "payment:status-changed";
     readonly RefundStatusChanged: "payment:refund-status-changed";
+    readonly Outcome: "payment:outcome";
 };
 export type PaymentEventType = typeof PaymentEventType[keyof typeof PaymentEventType];
 /**
@@ -14203,6 +14221,17 @@ export interface PaymentMethodsResponseDto {
      */
     'minimumCheckoutAmount'?: number;
 }
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export declare const PaymentOutcomeStatus: {
+    readonly Uncertain: "Uncertain";
+    readonly Success: "Success";
+    readonly Failed: "Failed";
+};
+export type PaymentOutcomeStatus = typeof PaymentOutcomeStatus[keyof typeof PaymentOutcomeStatus];
 /**
  *
  * @export
@@ -14463,6 +14492,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
@@ -14657,6 +14791,12 @@ export interface PaymentStatusDtoTransaction {
      * @memberof PaymentStatusDtoTransaction
      */
     'type': PaymentMethod;
+    /**
+     *
+     * @type {PaymentOutcomeStatus}
+     * @memberof PaymentStatusDtoTransaction
+     */
+    'paymentOutcomeStatus'?: PaymentOutcomeStatus;
     /**
      * Amount paid in cents
      * @type {number}
@@ -22424,6 +22564,12 @@ export interface TransactionDto {
      * @memberof TransactionDto
      */
     'type': PaymentMethod;
+    /**
+     *
+     * @type {PaymentOutcomeStatus}
+     * @memberof TransactionDto
+     */
+    'paymentOutcomeStatus'?: PaymentOutcomeStatus;
     /**
      * Amount paid in cents
      * @type {number}
@@ -24134,6 +24280,37 @@ export interface UpdateChannelInventoryDto {
      */
     'channels': Array<ChannelInventoryUpdateDto>;
 }
+/**
+ *
+ * @export
+ * @interface UpdateDeliveryIntentDto
+ */
+export interface UpdateDeliveryIntentDto {
+    /**
+     *
+     * @type {DeliveryIntentStatus}
+     * @memberof UpdateDeliveryIntentDto
+     */
+    'status': DeliveryIntentStatus;
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateDeliveryIntentDto
+     */
+    'providerDeliveryId'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateDeliveryIntentDto
+     */
+    'trackingUrl'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof UpdateDeliveryIntentDto
+     */
+    'failureReason'?: string;
+}
 /**
  *
  * @export
@@ -27150,10 +27327,10 @@ export interface WalletItemDto {
     'id': number;
     /**
      *
-     * @type {string}
+     * @type {WalletItemStatus}
      * @memberof WalletItemDto
      */
-    'status': StatusEnum;
+    'status': WalletItemStatus;
     /**
      *
      * @type {object}
@@ -27167,11 +27344,16 @@ export interface WalletItemDto {
      */
     'catalog': WalletCatalogDto;
 }
-export declare const StatusEnum: {
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export declare const WalletItemStatus: {
     readonly Claimed: "Claimed";
     readonly Redeemed: "Redeemed";
 };
-export type StatusEnum = typeof StatusEnum[keyof typeof StatusEnum];
+export type WalletItemStatus = typeof WalletItemStatus[keyof typeof WalletItemStatus];
 /**
  *
  * @export
@@ -30612,6 +30794,128 @@ export declare class CoursesApi extends BaseAPI implements CoursesApiInterface {
      */
     getCourses(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CourseDto[], any, {}>>;
 }
+/**
+ * DeliveryIntentApi - axios parameter creator
+ * @export
+ */
+export declare const DeliveryIntentApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Internal service-to-service call, requires the `x-internal-token` header.
+     * @summary Fetch a delivery intent for courier execution
+     * @param {string} intentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findIntent: (intentId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Internal service-to-service call, requires the `x-internal-token` header.
+     * @summary Report the courier execution outcome of a delivery intent
+     * @param {string} intentId
+     * @param {UpdateDeliveryIntentDto} updateDeliveryIntentDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateIntent: (intentId: string, updateDeliveryIntentDto: UpdateDeliveryIntentDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * DeliveryIntentApi - functional programming interface
+ * @export
+ */
+export declare const DeliveryIntentApiFp: (configuration?: Configuration) => {
+    /**
+     * Internal service-to-service call, requires the `x-internal-token` header.
+     * @summary Fetch a delivery intent for courier execution
+     * @param {string} intentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findIntent(intentId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Internal service-to-service call, requires the `x-internal-token` header.
+     * @summary Report the courier execution outcome of a delivery intent
+     * @param {string} intentId
+     * @param {UpdateDeliveryIntentDto} updateDeliveryIntentDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateIntent(intentId: string, updateDeliveryIntentDto: UpdateDeliveryIntentDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+};
+/**
+ * DeliveryIntentApi - factory interface
+ * @export
+ */
+export declare const DeliveryIntentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Internal service-to-service call, requires the `x-internal-token` header.
+     * @summary Fetch a delivery intent for courier execution
+     * @param {string} intentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findIntent(intentId: string, options?: any): AxiosPromise<void>;
+    /**
+     * Internal service-to-service call, requires the `x-internal-token` header.
+     * @summary Report the courier execution outcome of a delivery intent
+     * @param {string} intentId
+     * @param {UpdateDeliveryIntentDto} updateDeliveryIntentDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    updateIntent(intentId: string, updateDeliveryIntentDto: UpdateDeliveryIntentDto, options?: any): AxiosPromise<void>;
+};
+/**
+ * DeliveryIntentApi - interface
+ * @export
+ * @interface DeliveryIntentApi
+ */
+export interface DeliveryIntentApiInterface {
+    /**
+     * Internal service-to-service call, requires the `x-internal-token` header.
+     * @summary Fetch a delivery intent for courier execution
+     * @param {string} intentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DeliveryIntentApiInterface
+     */
+    findIntent(intentId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Internal service-to-service call, requires the `x-internal-token` header.
+     * @summary Report the courier execution outcome of a delivery intent
+     * @param {string} intentId
+     * @param {UpdateDeliveryIntentDto} updateDeliveryIntentDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DeliveryIntentApiInterface
+     */
+    updateIntent(intentId: string, updateDeliveryIntentDto: UpdateDeliveryIntentDto, options?: AxiosRequestConfig): AxiosPromise<void>;
+}
+/**
+ * DeliveryIntentApi - object-oriented interface
+ * @export
+ * @class DeliveryIntentApi
+ * @extends {BaseAPI}
+ */
+export declare class DeliveryIntentApi extends BaseAPI implements DeliveryIntentApiInterface {
+    /**
+     * Internal service-to-service call, requires the `x-internal-token` header.
+     * @summary Fetch a delivery intent for courier execution
+     * @param {string} intentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DeliveryIntentApi
+     */
+    findIntent(intentId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Internal service-to-service call, requires the `x-internal-token` header.
+     * @summary Report the courier execution outcome of a delivery intent
+     * @param {string} intentId
+     * @param {UpdateDeliveryIntentDto} updateDeliveryIntentDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DeliveryIntentApi
+     */
+    updateIntent(intentId: string, updateDeliveryIntentDto: UpdateDeliveryIntentDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+}
 /**
  * DisplayApi - axios parameter creator
  * @export
@@ -36482,6 +36786,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 +36960,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 +37134,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 +37312,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 +37508,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
@@ -41042,7 +41403,8 @@ export declare const WebhookApiAxiosParamCreator: (configuration?: Configuration
      */
     handleVivaSessionEvents: (vivaWebhookPayloadDto: VivaWebhookPayloadDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * Requires the shared secret from SHIPDAY_WEBHOOK_SECRET, sent as the `token` query parameter, the `x-shipday-token` header, or `token` in the body.
+     * @summary Handle Shipday delivery webhook events
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -41188,7 +41550,8 @@ export declare const WebhookApiFp: (configuration?: Configuration) => {
      */
     handleVivaSessionEvents(vivaWebhookPayloadDto: VivaWebhookPayloadDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     *
+     * Requires the shared secret from SHIPDAY_WEBHOOK_SECRET, sent as the `token` query parameter, the `x-shipday-token` header, or `token` in the body.
+     * @summary Handle Shipday delivery webhook events
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -41334,7 +41697,8 @@ export declare const WebhookApiFactory: (configuration?: Configuration, basePath
      */
     handleVivaSessionEvents(vivaWebhookPayloadDto: VivaWebhookPayloadDto, options?: any): AxiosPromise<void>;
     /**
-     *
+     * Requires the shared secret from SHIPDAY_WEBHOOK_SECRET, sent as the `token` query parameter, the `x-shipday-token` header, or `token` in the body.
+     * @summary Handle Shipday delivery webhook events
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
@@ -41493,7 +41857,8 @@ export interface WebhookApiInterface {
      */
     handleVivaSessionEvents(vivaWebhookPayloadDto: VivaWebhookPayloadDto, options?: AxiosRequestConfig): AxiosPromise<void>;
     /**
-     *
+     * Requires the shared secret from SHIPDAY_WEBHOOK_SECRET, sent as the `token` query parameter, the `x-shipday-token` header, or `token` in the body.
+     * @summary Handle Shipday delivery webhook events
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof WebhookApiInterface
@@ -41662,7 +42027,8 @@ export declare class WebhookApi extends BaseAPI implements WebhookApiInterface {
      */
     handleVivaSessionEvents(vivaWebhookPayloadDto: VivaWebhookPayloadDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
     /**
-     *
+     * Requires the shared secret from SHIPDAY_WEBHOOK_SECRET, sent as the `token` query parameter, the `x-shipday-token` header, or `token` in the body.
+     * @summary Handle Shipday delivery webhook events
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof WebhookApi