@munchi_oy/core 1.9.99 → 1.9.101

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -9915,6 +9915,135 @@ export interface MunchiGiftCardDataItemDto {
9915
9915
  */
9916
9916
  'createdAt': string;
9917
9917
  }
9918
+ /**
9919
+ *
9920
+ * @export
9921
+ * @interface MunchiPayCardDetailDto
9922
+ */
9923
+ export interface MunchiPayCardDetailDto {
9924
+ /**
9925
+ * Card scheme/brand (e.g. \'Visa Debit\').
9926
+ * @type {string}
9927
+ * @memberof MunchiPayCardDetailDto
9928
+ */
9929
+ 'brand': string;
9930
+ /**
9931
+ * Last 4 digits of the card.
9932
+ * @type {string}
9933
+ * @memberof MunchiPayCardDetailDto
9934
+ */
9935
+ 'last4': string;
9936
+ }
9937
+ /**
9938
+ *
9939
+ * @export
9940
+ * @interface MunchiPaySessionDto
9941
+ */
9942
+ export interface MunchiPaySessionDto {
9943
+ /**
9944
+ * PaymentSession primary key.
9945
+ * @type {string}
9946
+ * @memberof MunchiPaySessionDto
9947
+ */
9948
+ 'id': string;
9949
+ /**
9950
+ * Internal session ID.
9951
+ * @type {string}
9952
+ * @memberof MunchiPaySessionDto
9953
+ */
9954
+ 'sessionId': string;
9955
+ /**
9956
+ *
9957
+ * @type {ProviderEnum}
9958
+ * @memberof MunchiPaySessionDto
9959
+ */
9960
+ 'channel': ProviderEnum;
9961
+ /**
9962
+ * Business ID (string form of a BigInt).
9963
+ * @type {string}
9964
+ * @memberof MunchiPaySessionDto
9965
+ */
9966
+ 'businessId': string;
9967
+ /**
9968
+ * Order reference. A standalone Munchi Pay charge with no POS order carries a fixed placeholder value.
9969
+ * @type {string}
9970
+ * @memberof MunchiPaySessionDto
9971
+ */
9972
+ 'orderId': string;
9973
+ /**
9974
+ * SALE or REFUND.
9975
+ * @type {string}
9976
+ * @memberof MunchiPaySessionDto
9977
+ */
9978
+ 'purpose': string;
9979
+ /**
9980
+ * Amount in cents.
9981
+ * @type {number}
9982
+ * @memberof MunchiPaySessionDto
9983
+ */
9984
+ 'amount': number;
9985
+ /**
9986
+ * Currency.
9987
+ * @type {string}
9988
+ * @memberof MunchiPaySessionDto
9989
+ */
9990
+ 'currency': string;
9991
+ /**
9992
+ * Session status (state machine).
9993
+ * @type {string}
9994
+ * @memberof MunchiPaySessionDto
9995
+ */
9996
+ 'status': string;
9997
+ /**
9998
+ * Viva transaction ID.
9999
+ * @type {string}
10000
+ * @memberof MunchiPaySessionDto
10001
+ */
10002
+ 'providerTransactionId'?: string | null;
10003
+ /**
10004
+ *
10005
+ * @type {MunchiPaySessionDtoCardDetail}
10006
+ * @memberof MunchiPaySessionDto
10007
+ */
10008
+ 'cardDetail'?: MunchiPaySessionDtoCardDetail | null;
10009
+ /**
10010
+ * Provider-specific metadata.
10011
+ * @type {object}
10012
+ * @memberof MunchiPaySessionDto
10013
+ */
10014
+ 'metadata'?: object;
10015
+ /**
10016
+ *
10017
+ * @type {string}
10018
+ * @memberof MunchiPaySessionDto
10019
+ */
10020
+ 'createdAt': string;
10021
+ /**
10022
+ *
10023
+ * @type {string}
10024
+ * @memberof MunchiPaySessionDto
10025
+ */
10026
+ 'updatedAt': string;
10027
+ }
10028
+ /**
10029
+ * Card brand and last 4 digits, once captured from Viva (webhook or poll).
10030
+ * @export
10031
+ * @interface MunchiPaySessionDtoCardDetail
10032
+ */
10033
+ export interface MunchiPaySessionDtoCardDetail {
10034
+ /**
10035
+ * Card scheme/brand (e.g. \'Visa Debit\').
10036
+ * @type {string}
10037
+ * @memberof MunchiPaySessionDtoCardDetail
10038
+ */
10039
+ 'brand': string;
10040
+ /**
10041
+ * Last 4 digits of the card.
10042
+ * @type {string}
10043
+ * @memberof MunchiPaySessionDtoCardDetail
10044
+ */
10045
+ 'last4': string;
10046
+ }
9918
10047
  /**
9919
10048
  *
9920
10049
  * @export
@@ -24839,6 +24968,69 @@ export interface VideoBackgroundConfig {
24839
24968
  */
24840
24969
  'loop'?: boolean;
24841
24970
  }
24971
+ /**
24972
+ *
24973
+ * @export
24974
+ * @interface VivaA2aRefundDto
24975
+ */
24976
+ export interface VivaA2aRefundDto {
24977
+ /**
24978
+ * The internal business ID.
24979
+ * @type {number}
24980
+ * @memberof VivaA2aRefundDto
24981
+ */
24982
+ 'businessId': number;
24983
+ /**
24984
+ * The Viva transaction ID of the charge to refund.
24985
+ * @type {string}
24986
+ * @memberof VivaA2aRefundDto
24987
+ */
24988
+ 'transactionId': string;
24989
+ /**
24990
+ * Refund amount in the smallest currency unit (e.g., cents).
24991
+ * @type {number}
24992
+ * @memberof VivaA2aRefundDto
24993
+ */
24994
+ 'amount': number;
24995
+ }
24996
+ /**
24997
+ *
24998
+ * @export
24999
+ * @interface VivaA2aSessionDetailResponseDto
25000
+ */
25001
+ export interface VivaA2aSessionDetailResponseDto {
25002
+ /**
25003
+ *
25004
+ * @type {MunchiPaySessionDto}
25005
+ * @memberof VivaA2aSessionDetailResponseDto
25006
+ */
25007
+ 'session': MunchiPaySessionDto;
25008
+ /**
25009
+ * REFUND rows linked back to this session\'s Viva transaction ID.
25010
+ * @type {Array<MunchiPaySessionDto>}
25011
+ * @memberof VivaA2aSessionDetailResponseDto
25012
+ */
25013
+ 'refunds': Array<MunchiPaySessionDto>;
25014
+ }
25015
+ /**
25016
+ *
25017
+ * @export
25018
+ * @interface VivaA2aSessionListResponseDto
25019
+ */
25020
+ export interface VivaA2aSessionListResponseDto {
25021
+ /**
25022
+ *
25023
+ * @type {Array<MunchiPaySessionDto>}
25024
+ * @memberof VivaA2aSessionListResponseDto
25025
+ */
25026
+ 'sessions': Array<MunchiPaySessionDto>;
25027
+ /**
25028
+ *
25029
+ * @type {PaginationDto}
25030
+ * @memberof VivaA2aSessionListResponseDto
25031
+ */
25032
+ 'pagination': PaginationDto;
25033
+ }
24842
25034
  /**
24843
25035
  *
24844
25036
  * @export
@@ -39680,6 +39872,36 @@ export declare const VivaApiAxiosParamCreator: (configuration?: Configuration) =
39680
39872
  * @throws {RequiredError}
39681
39873
  */
39682
39874
  createVivaAppToAppPayment: (createTerminalPaymentDto: CreateTerminalPaymentDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
39875
+ /**
39876
+ *
39877
+ * @summary Get a single Viva payment session, with linked refunds
39878
+ * @param {string} id
39879
+ * @param {*} [options] Override http request option.
39880
+ * @throws {RequiredError}
39881
+ */
39882
+ getVivaSession: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
39883
+ /**
39884
+ *
39885
+ * @summary List Viva payment sessions for a business
39886
+ * @param {number} businessId The internal business ID.
39887
+ * @param {number} [page] Page number
39888
+ * @param {number} [rowPerPage] Number of rows per page
39889
+ * @param {string} [terminalId] Optional terminal identifier filter (same concept as ConnectedTerminal.terminalId).
39890
+ * @param {string} [start] Only sessions created on or after this date (ISO 8601).
39891
+ * @param {string} [end] Only sessions created on or before this date (ISO 8601).
39892
+ * @param {string} [search] Free-text search, matched against the provider transaction ID and the card\&#39;s last 4 digits.
39893
+ * @param {*} [options] Override http request option.
39894
+ * @throws {RequiredError}
39895
+ */
39896
+ listVivaSessions: (businessId: number, page?: number, rowPerPage?: number, terminalId?: string, start?: string, end?: string, search?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
39897
+ /**
39898
+ *
39899
+ * @summary Refund a Viva transaction
39900
+ * @param {VivaA2aRefundDto} vivaA2aRefundDto
39901
+ * @param {*} [options] Override http request option.
39902
+ * @throws {RequiredError}
39903
+ */
39904
+ refundVivaPayment: (vivaA2aRefundDto: VivaA2aRefundDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
39683
39905
  };
39684
39906
  /**
39685
39907
  * VivaApi - functional programming interface
@@ -39694,6 +39916,36 @@ export declare const VivaApiFp: (configuration?: Configuration) => {
39694
39916
  * @throws {RequiredError}
39695
39917
  */
39696
39918
  createVivaAppToAppPayment(createTerminalPaymentDto: CreateTerminalPaymentDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VivaAppToAppInitResponseDto>>;
39919
+ /**
39920
+ *
39921
+ * @summary Get a single Viva payment session, with linked refunds
39922
+ * @param {string} id
39923
+ * @param {*} [options] Override http request option.
39924
+ * @throws {RequiredError}
39925
+ */
39926
+ getVivaSession(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VivaA2aSessionDetailResponseDto>>;
39927
+ /**
39928
+ *
39929
+ * @summary List Viva payment sessions for a business
39930
+ * @param {number} businessId The internal business ID.
39931
+ * @param {number} [page] Page number
39932
+ * @param {number} [rowPerPage] Number of rows per page
39933
+ * @param {string} [terminalId] Optional terminal identifier filter (same concept as ConnectedTerminal.terminalId).
39934
+ * @param {string} [start] Only sessions created on or after this date (ISO 8601).
39935
+ * @param {string} [end] Only sessions created on or before this date (ISO 8601).
39936
+ * @param {string} [search] Free-text search, matched against the provider transaction ID and the card\&#39;s last 4 digits.
39937
+ * @param {*} [options] Override http request option.
39938
+ * @throws {RequiredError}
39939
+ */
39940
+ listVivaSessions(businessId: number, page?: number, rowPerPage?: number, terminalId?: string, start?: string, end?: string, search?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VivaA2aSessionListResponseDto>>;
39941
+ /**
39942
+ *
39943
+ * @summary Refund a Viva transaction
39944
+ * @param {VivaA2aRefundDto} vivaA2aRefundDto
39945
+ * @param {*} [options] Override http request option.
39946
+ * @throws {RequiredError}
39947
+ */
39948
+ refundVivaPayment(vivaA2aRefundDto: VivaA2aRefundDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MunchiPaySessionDto>>;
39697
39949
  };
39698
39950
  /**
39699
39951
  * VivaApi - factory interface
@@ -39708,6 +39960,36 @@ export declare const VivaApiFactory: (configuration?: Configuration, basePath?:
39708
39960
  * @throws {RequiredError}
39709
39961
  */
39710
39962
  createVivaAppToAppPayment(createTerminalPaymentDto: CreateTerminalPaymentDto, options?: any): AxiosPromise<VivaAppToAppInitResponseDto>;
39963
+ /**
39964
+ *
39965
+ * @summary Get a single Viva payment session, with linked refunds
39966
+ * @param {string} id
39967
+ * @param {*} [options] Override http request option.
39968
+ * @throws {RequiredError}
39969
+ */
39970
+ getVivaSession(id: string, options?: any): AxiosPromise<VivaA2aSessionDetailResponseDto>;
39971
+ /**
39972
+ *
39973
+ * @summary List Viva payment sessions for a business
39974
+ * @param {number} businessId The internal business ID.
39975
+ * @param {number} [page] Page number
39976
+ * @param {number} [rowPerPage] Number of rows per page
39977
+ * @param {string} [terminalId] Optional terminal identifier filter (same concept as ConnectedTerminal.terminalId).
39978
+ * @param {string} [start] Only sessions created on or after this date (ISO 8601).
39979
+ * @param {string} [end] Only sessions created on or before this date (ISO 8601).
39980
+ * @param {string} [search] Free-text search, matched against the provider transaction ID and the card\&#39;s last 4 digits.
39981
+ * @param {*} [options] Override http request option.
39982
+ * @throws {RequiredError}
39983
+ */
39984
+ listVivaSessions(businessId: number, page?: number, rowPerPage?: number, terminalId?: string, start?: string, end?: string, search?: string, options?: any): AxiosPromise<VivaA2aSessionListResponseDto>;
39985
+ /**
39986
+ *
39987
+ * @summary Refund a Viva transaction
39988
+ * @param {VivaA2aRefundDto} vivaA2aRefundDto
39989
+ * @param {*} [options] Override http request option.
39990
+ * @throws {RequiredError}
39991
+ */
39992
+ refundVivaPayment(vivaA2aRefundDto: VivaA2aRefundDto, options?: any): AxiosPromise<MunchiPaySessionDto>;
39711
39993
  };
39712
39994
  /**
39713
39995
  * VivaApi - interface
@@ -39724,6 +40006,39 @@ export interface VivaApiInterface {
39724
40006
  * @memberof VivaApiInterface
39725
40007
  */
39726
40008
  createVivaAppToAppPayment(createTerminalPaymentDto: CreateTerminalPaymentDto, options?: AxiosRequestConfig): AxiosPromise<VivaAppToAppInitResponseDto>;
40009
+ /**
40010
+ *
40011
+ * @summary Get a single Viva payment session, with linked refunds
40012
+ * @param {string} id
40013
+ * @param {*} [options] Override http request option.
40014
+ * @throws {RequiredError}
40015
+ * @memberof VivaApiInterface
40016
+ */
40017
+ getVivaSession(id: string, options?: AxiosRequestConfig): AxiosPromise<VivaA2aSessionDetailResponseDto>;
40018
+ /**
40019
+ *
40020
+ * @summary List Viva payment sessions for a business
40021
+ * @param {number} businessId The internal business ID.
40022
+ * @param {number} [page] Page number
40023
+ * @param {number} [rowPerPage] Number of rows per page
40024
+ * @param {string} [terminalId] Optional terminal identifier filter (same concept as ConnectedTerminal.terminalId).
40025
+ * @param {string} [start] Only sessions created on or after this date (ISO 8601).
40026
+ * @param {string} [end] Only sessions created on or before this date (ISO 8601).
40027
+ * @param {string} [search] Free-text search, matched against the provider transaction ID and the card\&#39;s last 4 digits.
40028
+ * @param {*} [options] Override http request option.
40029
+ * @throws {RequiredError}
40030
+ * @memberof VivaApiInterface
40031
+ */
40032
+ listVivaSessions(businessId: number, page?: number, rowPerPage?: number, terminalId?: string, start?: string, end?: string, search?: string, options?: AxiosRequestConfig): AxiosPromise<VivaA2aSessionListResponseDto>;
40033
+ /**
40034
+ *
40035
+ * @summary Refund a Viva transaction
40036
+ * @param {VivaA2aRefundDto} vivaA2aRefundDto
40037
+ * @param {*} [options] Override http request option.
40038
+ * @throws {RequiredError}
40039
+ * @memberof VivaApiInterface
40040
+ */
40041
+ refundVivaPayment(vivaA2aRefundDto: VivaA2aRefundDto, options?: AxiosRequestConfig): AxiosPromise<MunchiPaySessionDto>;
39727
40042
  }
39728
40043
  /**
39729
40044
  * VivaApi - object-oriented interface
@@ -39741,6 +40056,39 @@ export declare class VivaApi extends BaseAPI implements VivaApiInterface {
39741
40056
  * @memberof VivaApi
39742
40057
  */
39743
40058
  createVivaAppToAppPayment(createTerminalPaymentDto: CreateTerminalPaymentDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VivaAppToAppInitResponseDto, any, {}>>;
40059
+ /**
40060
+ *
40061
+ * @summary Get a single Viva payment session, with linked refunds
40062
+ * @param {string} id
40063
+ * @param {*} [options] Override http request option.
40064
+ * @throws {RequiredError}
40065
+ * @memberof VivaApi
40066
+ */
40067
+ getVivaSession(id: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VivaA2aSessionDetailResponseDto, any, {}>>;
40068
+ /**
40069
+ *
40070
+ * @summary List Viva payment sessions for a business
40071
+ * @param {number} businessId The internal business ID.
40072
+ * @param {number} [page] Page number
40073
+ * @param {number} [rowPerPage] Number of rows per page
40074
+ * @param {string} [terminalId] Optional terminal identifier filter (same concept as ConnectedTerminal.terminalId).
40075
+ * @param {string} [start] Only sessions created on or after this date (ISO 8601).
40076
+ * @param {string} [end] Only sessions created on or before this date (ISO 8601).
40077
+ * @param {string} [search] Free-text search, matched against the provider transaction ID and the card\&#39;s last 4 digits.
40078
+ * @param {*} [options] Override http request option.
40079
+ * @throws {RequiredError}
40080
+ * @memberof VivaApi
40081
+ */
40082
+ listVivaSessions(businessId: number, page?: number, rowPerPage?: number, terminalId?: string, start?: string, end?: string, search?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VivaA2aSessionListResponseDto, any, {}>>;
40083
+ /**
40084
+ *
40085
+ * @summary Refund a Viva transaction
40086
+ * @param {VivaA2aRefundDto} vivaA2aRefundDto
40087
+ * @param {*} [options] Override http request option.
40088
+ * @throws {RequiredError}
40089
+ * @memberof VivaApi
40090
+ */
40091
+ refundVivaPayment(vivaA2aRefundDto: VivaA2aRefundDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<MunchiPaySessionDto, any, {}>>;
39744
40092
  }
39745
40093
  /**
39746
40094
  * WebhookApi - axios parameter creator