@venly/venly-core-sdk/dist/api/VyPayAPI.generated.d.ts

Javascrip/Typescript SDK for Venly's Web3 Services

import { VyPromise } from '../core';
import { Any } from '../helpers/json';
import * as pay from '../models/pay/index';
import * as enums from '../models/enums/index';
import { VyApiBase } from './VyApiBase';
export declare abstract class VyPayAPI_Gen {
    protected _apiBase: VyApiBase;
    protected _apiEndpoint: enums.VyApiEndpoint;
    constructor(_apiBase: VyApiBase);
    /**
    * This endpoint is used to check the current health of the **PAY-API**. It returns the API health status as either **UP** or **DOWN**.
    * @returns {VyPayApiHealthDto}
    */
    checkHealthPayAPI(): VyPromise<pay.VyPayApiHealthDto>;
    /**
    * Get all supported fiat currencies and crypto currencies for a specific provider. The response includes the `fiat` and `crypto` arrays. The `fiat[]` array includes all the supported fiat currencies for the specific provider, and the `crypto[]` array includes all the supported crypto currencies for the specific provider.
    * @param {VyRampProviderType} provider -
    * @returns {VyGetCurrenciesResultDto}
    */
    getCurrencies(provider: enums.VyRampProviderType): VyPromise<pay.VyGetCurrenciesResultDto>;
    /**
    * This endpoint is used to create a Transak onramp URL.
    * @param {VyTransakOnRampUrlRequest} reqParams - Request data for the operation
    * @returns {VyFiatRampUrlDto}
    */
    getTransakFiatOnRampUrl(reqParams: pay.VyTransakOnRampUrlRequest): VyPromise<pay.VyFiatRampUrlDto>;
    /**
    * This endpoint is used to create a Transak offramp URL.
    * @param {VyTransakOffRampUrlRequest} reqParams - Request data for the operation
    * @returns {VyFiatRampUrlDto}
    */
    getTransakFiatOffRampUrl(reqParams: pay.VyTransakOffRampUrlRequest): VyPromise<pay.VyFiatRampUrlDto>;
    /**
    * This endpoint is used to create a Ramp Network onramp URL.
    * @param {VyRampNetworkOnRampUrlRequest} reqParams - Request data for the operation
    * @returns {VyFiatRampUrlDto}
    */
    getRampNetworkFiatOnRampUrl(reqParams: pay.VyRampNetworkOnRampUrlRequest): VyPromise<pay.VyFiatRampUrlDto>;
    /**
    * This endpoint is used to create a Ramp Network offramp URL.
    * @param {VyRampNetworkOffRampUrlRequest} reqParams - Request data for the operation
    * @returns {VyFiatRampUrlDto}
    */
    getRampNetworkFiatOffRampUrl(reqParams: pay.VyRampNetworkOffRampUrlRequest): VyPromise<pay.VyFiatRampUrlDto>;
    /**
    * This endpoint is used to create a Moonpay onramp URL.
    * @param {VyMoonpayOnRampUrlRequest} reqParams - Request data for the operation
    * @returns {VyFiatRampUrlDto}
    */
    getMoonpayFiatOnRampUrl(reqParams: pay.VyMoonpayOnRampUrlRequest): VyPromise<pay.VyFiatRampUrlDto>;
    /**
    * This endpoint is used to create a Moonpay offramp URL.
    * @param {VyMoonpayOffRampUrlRequest} reqParams - Request data for the operation
    * @returns {VyFiatRampUrlDto}
    */
    getMoonpayFiatOffRampUrl(reqParams: pay.VyMoonpayOffRampUrlRequest): VyPromise<pay.VyFiatRampUrlDto>;
    /**
    * Initiate the checkout process for a single payment by calling this endpoint. Save the `id` and `url` from response body. The `id` parameter is the sessionId (Used when checking status of this checkout), and the `url` parameter is the checkout URL (You pass this to your end-user).
    * @param {VyCheckoutSessionRequest} reqParams - Request data for the operation
    * @returns {VyCheckoutSessionDto}
    */
    checkoutSession(reqParams: pay.VyCheckoutSessionRequest): VyPromise<pay.VyCheckoutSessionDto>;
    /**
    * Personalize your checkout page by adding your business' icon or logo. The icon must be a square image and have a minimum size of **128px x 128px**.
    * @param {VyUploadIconRequest} reqParams - Request data for the operation
    * @returns {VyIconDetailsDto}
    */
    uploadIcon(reqParams: pay.VyUploadIconRequest): VyPromise<pay.VyIconDetailsDto>;
    /**
    * You can select a primary color for the left side of the checkout page, and a secondary color for the PAY button. The checkout page will also feature your icon.
    * @param {VyUpdateBrandingSettingsRequest} reqParams - Request data for the operation
    */
    updateBrandingSettings(reqParams: pay.VyUpdateBrandingSettingsRequest): VyPromise<Any>;
    /**
    * This endpoint allows you to fetch a login link for your Stripe dashboard.
    * @returns {VyStripeDashboardResultDto}
    */
    getDashboardLink(): VyPromise<pay.VyStripeDashboardResultDto>;
    /**
    * To retrieve the details of a completed or canceled checkout, call this endpoint using the corresponding session `ID`.
    * @param {string} sessionId - This is the session `ID` to check the status of a specific checkout payment. It's in the response body when you create a checkout link.
    * @returns {VyCheckoutSessionDto}
    */
    getSession(sessionId: string): VyPromise<pay.VyCheckoutSessionDto>;
    /**
    * This endpoint is used to create a webhook, to receive updates of your user's payments (_successful/cancelled_).
    * @param {VyUpdateWebhookRequest} reqParams - Request data for the operation
    * @returns {VyWebhookDto}
    */
    createWebhook(reqParams: pay.VyUpdateWebhookRequest): VyPromise<pay.VyWebhookDto>;
    /**
    * This endpoint is used to get all of your webhooks.
    * @returns {VyWebhookDto[]}
    */
    findWebhooks(): VyPromise<pay.VyWebhookDto[]>;
    /**
    *
    * @param {string} webhookId - This is the `ID` of the webhook you want to update.
    * @param {VyUpdateWebhookRequest} reqParams - Request data for the operation
    * @returns {VyWebhookDto}
    */
    updateWebhook(webhookId: string, reqParams: pay.VyUpdateWebhookRequest): VyPromise<pay.VyWebhookDto>;
    /**
    *
    * @param {string} webhookId - This is the `ID` of the webhook you want to delete.
    */
    deleteWebhook(webhookId: string): VyPromise<Any>;
    /**
    * This endpoint retrieves a checkout session's line items.
    * @param {string} sessionId - This is the session `ID`. It's in the response body when you create a checkout link.
    * @returns {VyLineItemsResponseDto}
    */
    getLineItems(sessionId: string): VyPromise<pay.VyLineItemsResponseDto>;
}
//# sourceMappingURL=VyPayAPI.generated.d.ts.map