@venly/venly-core-sdk/dist/models/pay/VyModels.Pay.generated.d.ts

Javascrip/Typescript SDK for Venly's Web3 Services

import { Any } from '../../helpers/json';
import * as enums from '../enums/index';
/**
*
*/
export declare class VyPayApiHealthDto {
    /**
    * Indicates the status of API services as either `UP` or `DOWN`.
    * @type {string}
    */
    status?: string;
    constructor(initializer?: VyPayApiHealthDto);
}
/**
*
*/
export declare class VyFiatRampDto {
    /**
    * The name of fiat currency.
    * @type {string}
    */
    name?: string;
    /**
    * The fiat currency's symbol that can be passed as the `fiatCurrency` param to create on/off ramp URLs.
    * @type {string}
    */
    symbol?: string;
    /**
    * Indicates if the fiat currency is supported for an onramp and/or offramp.
    * @type {string[]}
    */
    rampType?: string[];
    constructor(initializer?: VyFiatRampDto);
}
/**
*
*/
export declare class VyCryptoDto {
    /**
    * Blockchain name.
    * @type {string}
    */
    name?: string;
    /**
    * The symbol of the crypto currency. The `symbol` param can be passed in the `cryptoCurrency` object when creating an on/off ramp URL
    * @type {string}
    */
    symbol?: string;
    /**
    * The network or blockchain. The `network` param can be passed in the `cryptoCurrency` object when creating an on/off ramp URL
    * @type {string}
    */
    network?: string;
    /**
    *
    * @type {string}
    */
    chainId?: string;
    /**
    * Indicates if the crypto currency is supported for an onramp and/or offramp.
    * @type {string[]}
    */
    rampType?: string[];
    constructor(initializer?: VyCryptoDto);
}
/**
*
*/
export declare class VyGetCurrenciesResultDto {
    /**
    * This array includes all the supported fiat currencies for the specific provider.
    * @type {VyFiatRampDto[]}
    */
    fiat?: VyFiatRampDto[];
    /**
    * This array includes all the supported crypto currencies for the specific provider indicates and indicates if the crypto currency is supported for an onramp and/or offramp.
    * @type {VyCryptoDto[]}
    */
    crypto?: VyCryptoDto[];
    constructor(initializer?: VyGetCurrenciesResultDto);
}
/**
*
*/
export declare class VyCryptoCurrency {
    /**
    * The crypto network such as `bitcoin` or `ethereum` that you would allow your customers to buy/sell. Can be obtained from response of the [**Get supported fiat and crypto currencies endpoint**](https://docs.venly.io/docs/on-ramp-off-ramp-supported-fiat-crypto-currencies).
    * @type {string}
    */
    network?: string;
    /**
    * The code/symbol of the cryptocurrency you want the user to buy/sell. Can be obtained from response of the [**Get supported fiat and crypto currencies endpoint**](https://docs.venly.io/docs/on-ramp-off-ramp-supported-fiat-crypto-currencies).
    * @type {string}
    */
    symbol?: string;
    constructor(initializer?: VyCryptoCurrency);
}
/**
*
*/
export declare class VyTransakOnRampUrlRequest {
    /**
    * The amount in fiat currency showing how much your user wants to spend or receive. If this is passed, the user can't change the fiat amount. This param will be skipped if `fiatCurrency` is not passed.
    * @type {BigInt}
    */
    fiatAmount?: BigInt;
    /**
    * The code of the fiat currency (_e.g. USD, AUD, GBP_) you want the user to purchase with
    * @type {string}
    */
    fiatCurrency?: string;
    /**
    * An integer amount showing how much crypto your user wants to buy. This parameter will be skipped if `cryptoCurrency.symbol` is not passed. This parameter will be skipped if a valid combination of `fiatCurrency` and `fiatAmount` is passed
    * @type {BigInt}
    */
    cryptoAmount?: BigInt;
    /**
    *
    * @type {VyCryptoCurrency}
    */
    cryptoCurrency?: VyCryptoCurrency;
    /**
    * Once the customer has completed the purchase/sell process, Transak will redirect back to this URL with additional order info appended to it as parameters.
    * @type {string}
    */
    redirectUrl?: string;
    /**
    * The email that will be used to identify your user and their order
    * @type {string}
    */
    email?: string;
    /**
    * The wallet address of your user where crypto will be sent to
    * @type {string}
    */
    walletAddress?: string;
    /**
    * If this is set to `true`, your user won't see a detailed breakdown of fees—they'll only see the total fee
    * @type {boolean}
    */
    isFeeCalculationHidden?: boolean;
    /**
    * When `true`, then the user will not see the menu options. This will hide the menu completely
    * @type {boolean}
    */
    hideMenu?: boolean;
    constructor(initializer?: VyTransakOnRampUrlRequest);
}
/**
*
*/
export declare class VyFiatRampUrlDto {
    /**
    * The generated on/off ramp URL.
    * @type {string}
    */
    url?: string;
    constructor(initializer?: VyFiatRampUrlDto);
}
/**
*
*/
export declare class VyTransakOffRampUrlRequest {
    /**
    * The code of the fiat currency you want your user to buy/sell cryptocurrency
    * @type {string}
    */
    fiatCurrency?: string;
    /**
    * The amount in crypto currency showing how much crypto your user wants to sell. If this is passed, the user can't change the crypto amount.
    * @type {BigInt}
    */
    cryptoAmount?: BigInt;
    /**
    *
    * @type {VyCryptoCurrency}
    */
    cryptoCurrency?: VyCryptoCurrency;
    /**
    * Once the customer has completed the purchase/sell process, Transak will redirect back to this URL with additional order info appended to it as parameters.
    * @type {string}
    */
    redirectUrl?: string;
    /**
    * The email that will be used to identify your user and their order
    * @type {string}
    */
    email?: string;
    /**
    * If this is set to `true`, your user won't see a detailed breakdown of fees—they'll only see the total fee
    * @type {boolean}
    */
    isFeeCalculationHidden?: boolean;
    /**
    * When `true`, then the user will not see the menu options. This will hide the menu completely.
    * @type {boolean}
    */
    hideMenu?: boolean;
    constructor(initializer?: VyTransakOffRampUrlRequest);
}
/**
*
*/
export declare class VyRampNetworkOnRampUrlRequest {
    /**
    * A positive integer representing how much fiat the user wants to spend. It will be overridden by `cryptoAmount`, if passed.
    * @type {BigInt}
    */
    fiatAmount?: BigInt;
    /**
    * The code of the fiat currency (_e.g. USD, AUD, GBP_) you want the user to purchase with. Mandatory if `fiatAmount` is passed.
    * @type {string}
    */
    fiatCurrency?: string;
    /**
    * A positive integer representing how much crypto the user wants to buy. If left blank, the user will choose the amount on their own.
    * @type {BigInt}
    */
    cryptoAmount?: BigInt;
    /**
    *
    * @type {VyCryptoCurrency}
    */
    cryptoCurrency?: VyCryptoCurrency;
    /**
    * The URL the user will be redirected to after completing the flow
    * @type {string}
    */
    redirectUrl?: string;
    /**
    * The email address for your user to make their onramping experience even quicker
    * @type {string}
    */
    email?: string;
    /**
    * The wallet address the crypto will be sent to
    * @type {string}
    */
    walletAddress?: string;
    /**
    * This param pre-selects the user's country. The value should be a two-letter country code (ISO 3166-1 alpha-2)
    * @type {string}
    */
    selectedCountryCode?: string;
    constructor(initializer?: VyRampNetworkOnRampUrlRequest);
}
/**
*
*/
export declare class VyRampNetworkOffRampUrlRequest {
    /**
    * The fiat amount the user wants to receive
    * @type {BigInt}
    */
    fiatAmount?: BigInt;
    /**
    * The fiat currency code that will pre-set the currency
    * @type {string}
    */
    fiatCurrency?: string;
    /**
    *
    * @type {VyCryptoCurrency}
    */
    cryptoCurrency?: VyCryptoCurrency;
    /**
    * The URL the user will be redirected to after completing the flow
    * @type {string}
    */
    redirectUrl?: string;
    /**
    * The email address for your user to make their onramping experience even quicker
    * @type {string}
    */
    email?: string;
    /**
    * The wallet address of your user where crypto will be sent to
    * @type {string}
    */
    userAddress?: string;
    /**
    * This param pre-selects user country. The value should be a two-letter country code (ISO 3166-1 alpha-2).
    * @type {string}
    */
    selectedCountryCode?: string;
    constructor(initializer?: VyRampNetworkOffRampUrlRequest);
}
/**
*
*/
export declare class VyCryptoCurrencySymbol {
    /**
    * The code/symbol of the cryptocurrency you want the user to buy/sell. Can be obtained from response of the [**Get supported fiat and crypto currencies endpoint**](https://docs.venly.io/docs/on-ramp-off-ramp-supported-fiat-crypto-currencies).
    * @type {string}
    */
    symbol?: string;
    constructor(initializer?: VyCryptoCurrencySymbol);
}
/**
*
*/
export declare class VyMoonpayOnRampUrlRequest {
    /**
    * A positive integer representing how much fiat the user wants to spend
    * @type {BigInt}
    */
    fiatAmount?: BigInt;
    /**
    * The code of the fiat currency (_e.g. usd, aud, gbp_) you want the user to purchase with
    * @type {string}
    */
    fiatCurrency?: string;
    /**
    * A positive integer representing how much crypto the user wants to buy. If you pass both `fiatAmount` and `cryptoAmount`, the `cryptoAmount` amount will take precedence.
    * @type {BigInt}
    */
    cryptoAmount?: BigInt;
    /**
    *
    * @type {VyCryptoCurrencySymbol}
    */
    cryptoCurrency?: VyCryptoCurrencySymbol;
    /**
    * This is the URL where you want to send the user after they finish the buying process. A transaction ID and status is added to the URL as query parameters.
    * @type {string}
    */
    redirectUrl?: string;
    /**
    * This is the user's email address. If you provide a valid email address, the user won't need to enter it
    * @type {string}
    */
    email?: string;
    /**
    * This is the cryptocurrency wallet address where the purchased funds will be sent. If a valid wallet address is passed, the user won't need to enter one.
    * @type {string}
    */
    walletAddress?: string;
    constructor(initializer?: VyMoonpayOnRampUrlRequest);
}
/**
*
*/
export declare class VyMoonpayOffRampUrlRequest {
    /**
    * The code of the fiat currency you want the user to be paid in. Possible values: _usd, eur, gbp_
    * @type {string}
    */
    fiatCurrency?: string;
    /**
    * A positive number representing how much crypto the user wants to sell. This parameter will be skipped if `cryptoCurrency.symbol` is not passed.
    * @type {BigInt}
    */
    cryptoAmount?: BigInt;
    /**
    *
    * @type {VyCryptoCurrencySymbol}
    */
    cryptoCurrency?: VyCryptoCurrencySymbol;
    /**
    * A URL you'd like to redirect the user to after they complete the sell flow
    * @type {string}
    */
    redirectUrl?: string;
    /**
    * The user's email address
    * @type {string}
    */
    email?: string;
    /**
    * The cryptocurrency wallet address the funds will be sent to in case of a refund. This parameter will be skipped if `cryptoCurrency.symbol` is not passed.
    * @type {string}
    */
    refundWalletAddress?: string;
    constructor(initializer?: VyMoonpayOffRampUrlRequest);
}
/**
*
*/
export declare class VyProductDataRequest {
    /**
    * The name of the product to be displayed to your end-user. Such as “Ring NFT”
    * @type {string}
    */
    name?: string;
    constructor(initializer?: VyProductDataRequest);
}
/**
*
*/
export declare class VyPriceDataRequest {
    /**
    *
    * @type {VyProductDataRequest}
    */
    productData?: VyProductDataRequest;
    /**
    * Non-negative integer in cents representing the price of your product.
    * @type {BigInt}
    */
    unitAmount?: BigInt;
    /**
    * Three-letter ISO currency code, in uppercase.
    * @type {string}
    */
    currency?: string;
    constructor(initializer?: VyPriceDataRequest);
}
/**
*
*/
export declare class VyLineItemRequest {
    /**
    *
    * @type {VyPriceDataRequest}
    */
    priceData?: VyPriceDataRequest;
    /**
    * The quantity of products you want to create a checkout for.
    * @type {BigInt}
    */
    quantity?: BigInt;
    constructor(initializer?: VyLineItemRequest);
}
/**
*
*/
export declare class VyCustomerRequest {
    /**
    * The unique ID of your customer for whom this checkout request is being created. This identifier, whether a customer ID, cart ID, or similar, can help you match the session with your internal systems.
    * @type {string}
    */
    id?: string;
    constructor(initializer?: VyCustomerRequest);
}
/**
*
*/
export declare class VyCheckoutSessionRequest {
    /**
    *
    * @type {VyLineItemRequest[]}
    */
    lineItems?: VyLineItemRequest[];
    /**
    * The URL where your user will be directed in case of successful checkout. (URLs must begin with http or https)
    * @type {string}
    */
    successUrl?: string;
    /**
    * The URL where your user will be directed in case they decide to cancel the payment. (URLs must begin with http or https)
    * @type {string}
    */
    cancelUrl?: string;
    /**
    * Only **payment** mode is allowed.
    * @type {string}
    */
    mode?: string;
    /**
    * The date-time at which the Checkout Session will expire. It can be set to expire anytime between 30 minutes to 24 hours after it's created. By default, it expires 24 hours after creation. This field accepts a date-time in ISO-8601 format.
    * @type {Date}
    */
    expiresAt?: Date;
    /**
    * A distinctive identifier for the Checkout Session. This might be a customer ID, cart ID, or something similar, and can be utilized to match the session with your internal systems.
    * @type {string}
    */
    clientReferenceId?: string;
    /**
    *
    * @type {VyCustomerRequest}
    */
    customer?: VyCustomerRequest;
    constructor(initializer?: VyCheckoutSessionRequest);
}
/**
*
*/
export declare class VyAutomaticTaxDto {
    /**
    *
    * @type {boolean}
    */
    enabled?: boolean;
    /**
    *
    * @type {string}
    */
    status?: string;
    constructor(initializer?: VyAutomaticTaxDto);
}
/**
*
*/
export declare class VyCustomTextDto {
    /**
    *
    * @type {Any}
    */
    afterSubmit?: Any;
    /**
    *
    * @type {Any}
    */
    shippingAddress?: Any;
    /**
    *
    * @type {Any}
    */
    submit?: Any;
    /**
    *
    * @type {Any}
    */
    termsOfServiceAcceptance?: Any;
    constructor(initializer?: VyCustomTextDto);
}
/**
*
*/
export declare class VyInvoiceDataDto {
    /**
    *
    * @type {Any[]}
    */
    accountTaxIds?: Any[];
    /**
    *
    * @type {Any[]}
    */
    customFields?: Any[];
    /**
    *
    * @type {string}
    */
    description?: string;
    /**
    *
    * @type {string}
    */
    footer?: string;
    /**
    *
    * @type {Any}
    */
    metadata?: Any;
    /**
    *
    * @type {Any}
    */
    renderingOptions?: Any;
    constructor(initializer?: VyInvoiceDataDto);
}
/**
*
*/
export declare class VyInvoiceCreationDto {
    /**
    *
    * @type {boolean}
    */
    enabled?: boolean;
    /**
    *
    * @type {VyInvoiceDataDto}
    */
    invoiceData?: VyInvoiceDataDto;
    constructor(initializer?: VyInvoiceCreationDto);
}
/**
*
*/
export declare class VyPhoneNumberCollectionDto {
    /**
    *
    * @type {boolean}
    */
    enabled?: boolean;
    constructor(initializer?: VyPhoneNumberCollectionDto);
}
/**
*
*/
export declare class VyTotalDetailsDto {
    /**
    *
    * @type {number}
    */
    amountDiscount?: number;
    /**
    *
    * @type {number}
    */
    amountShipping?: number;
    /**
    *
    * @type {number}
    */
    amountTax?: number;
    constructor(initializer?: VyTotalDetailsDto);
}
/**
*
*/
export declare class VyCheckoutSessionDto {
    /**
    *
    * @type {string}
    */
    id?: string;
    /**
    *
    * @type {string}
    */
    object?: string;
    /**
    *
    * @type {Any}
    */
    afterExpiration?: Any;
    /**
    *
    * @type {boolean}
    */
    allowPromotionCodes?: boolean;
    /**
    *
    * @type {number}
    */
    amountSubtotal?: number;
    /**
    *
    * @type {number}
    */
    amountTotal?: number;
    /**
    *
    * @type {VyAutomaticTaxDto}
    */
    automaticTax?: VyAutomaticTaxDto;
    /**
    *
    * @type {string}
    */
    billingAddressCollection?: string;
    /**
    *
    * @type {string}
    */
    cancelUrl?: string;
    /**
    *
    * @type {string}
    */
    clientReferenceId?: string;
    /**
    *
    * @type {string}
    */
    clientSecret?: string;
    /**
    *
    * @type {Any}
    */
    consent?: Any;
    /**
    *
    * @type {Any}
    */
    consentCollection?: Any;
    /**
    *
    * @type {number}
    */
    created?: number;
    /**
    *
    * @type {string}
    */
    currency?: string;
    /**
    *
    * @type {Any}
    */
    currencyConversion?: Any;
    /**
    *
    * @type {Any[]}
    */
    customFields?: Any[];
    /**
    *
    * @type {VyCustomTextDto}
    */
    customText?: VyCustomTextDto;
    /**
    *
    * @type {string}
    */
    customer?: string;
    /**
    *
    * @type {string}
    */
    customerCreation?: string;
    /**
    *
    * @type {Any}
    */
    customerDetails?: Any;
    /**
    *
    * @type {string}
    */
    customerEmail?: string;
    /**
    *
    * @type {number}
    */
    expiresAt?: number;
    /**
    *
    * @type {string}
    */
    invoice?: string;
    /**
    *
    * @type {VyInvoiceCreationDto}
    */
    invoiceCreation?: VyInvoiceCreationDto;
    /**
    *
    * @type {boolean}
    */
    livemode?: boolean;
    /**
    *
    * @type {string}
    */
    locale?: string;
    /**
    *
    * @type {Any}
    */
    metadata?: Any;
    /**
    *
    * @type {string}
    */
    mode?: string;
    /**
    *
    * @type {Any}
    */
    paymentIntent?: Any;
    /**
    *
    * @type {string}
    */
    paymentLink?: string;
    /**
    *
    * @type {string}
    */
    paymentMethodCollection?: string;
    /**
    *
    * @type {Any}
    */
    paymentMethodConfigurationDetails?: Any;
    /**
    *
    * @type {Any}
    */
    paymentMethodOptions?: Any;
    /**
    *
    * @type {string[]}
    */
    paymentMethodTypes?: string[];
    /**
    *
    * @type {string}
    */
    paymentStatus?: string;
    /**
    *
    * @type {VyPhoneNumberCollectionDto}
    */
    phoneNumberCollection?: VyPhoneNumberCollectionDto;
    /**
    *
    * @type {string}
    */
    recoveredFrom?: string;
    /**
    *
    * @type {string}
    */
    setupIntent?: string;
    /**
    *
    * @type {Any}
    */
    shippingAddressCollection?: Any;
    /**
    *
    * @type {Any}
    */
    shippingCost?: Any;
    /**
    *
    * @type {Any}
    */
    shippingDetails?: Any;
    /**
    *
    * @type {Any[]}
    */
    shippingOptions?: Any[];
    /**
    *
    * @type {string}
    */
    status?: string;
    /**
    *
    * @type {string}
    */
    submitType?: string;
    /**
    *
    * @type {string}
    */
    subscription?: string;
    /**
    *
    * @type {string}
    */
    successUrl?: string;
    /**
    *
    * @type {VyTotalDetailsDto}
    */
    totalDetails?: VyTotalDetailsDto;
    /**
    *
    * @type {string}
    */
    uiMode?: string;
    /**
    *
    * @type {string}
    */
    url?: string;
    constructor(initializer?: VyCheckoutSessionDto);
}
/**
*
*/
export declare class VyUploadIconRequest {
    /**
    *
    * @type {Buffer}
    */
    icon?: Buffer;
    constructor(initializer?: VyUploadIconRequest);
}
/**
*
*/
export declare class VyIconLinksDto {
    /**
    *
    * @type {string}
    */
    object?: string;
    /**
    *
    * @type {Any[]}
    */
    data?: Any[];
    /**
    *
    * @type {boolean}
    */
    hasMore?: boolean;
    /**
    *
    * @type {string}
    */
    url?: string;
    constructor(initializer?: VyIconLinksDto);
}
/**
*
*/
export declare class VyIconDetailsDto {
    /**
    *
    * @type {string}
    */
    id?: string;
    /**
    *
    * @type {string}
    */
    object?: string;
    /**
    *
    * @type {number}
    */
    created?: number;
    /**
    *
    * @type {string}
    */
    expiresAt?: string;
    /**
    *
    * @type {string}
    */
    filename?: string;
    /**
    *
    * @type {VyIconLinksDto}
    */
    links?: VyIconLinksDto;
    /**
    *
    * @type {string}
    */
    purpose?: string;
    /**
    *
    * @type {number}
    */
    size?: number;
    /**
    *
    * @type {string}
    */
    title?: string;
    /**
    *
    * @type {string}
    */
    type?: string;
    /**
    *
    * @type {string}
    */
    url?: string;
    constructor(initializer?: VyIconDetailsDto);
}
/**
*
*/
export declare class VyAccountBrandingSettingsDto {
    /**
    * A color hex code to customize your checkout page.
    * @type {string}
    */
    primaryColor?: string;
    /**
    * A color hex code to customize the PAY button.
    * @type {string}
    */
    secondaryColor?: string;
    /**
    * This is the id of your previously uploaded icon.
    * @type {string}
    */
    icon?: string;
    constructor(initializer?: VyAccountBrandingSettingsDto);
}
/**
*
*/
export declare class VyAccountSettingsDto {
    /**
    *
    * @type {VyAccountBrandingSettingsDto}
    */
    branding?: VyAccountBrandingSettingsDto;
    constructor(initializer?: VyAccountSettingsDto);
}
/**
*
*/
export declare class VyUpdateBrandingSettingsRequest {
    /**
    *
    * @type {VyAccountSettingsDto}
    */
    settings?: VyAccountSettingsDto;
    constructor(initializer?: VyUpdateBrandingSettingsRequest);
}
/**
*
*/
export declare class VyStripeDashboardResultDto {
    /**
    *
    * @type {string}
    */
    object?: string;
    /**
    *
    * @type {number}
    */
    created?: number;
    /**
    *
    * @type {string}
    */
    url?: string;
    constructor(initializer?: VyStripeDashboardResultDto);
}
/**
* This is the type of authentication for your endpoint. Authentication is to be set up by you so you can authenticate the incoming webhooks from Venly. We allow two types: `BASIC_AUTHENTICATION` and `API_KEY`
*/
export declare class VyWebhookAuthenticationMethodBase {
    constructor(initializer?: VyWebhookAuthenticationMethodBase);
}
/**
*
*/
export declare class VyUpdateWebhookRequest {
    /**
    * This is your endpoint URL which can accept `POST` calls.
    * @type {string}
    */
    url?: string;
    /**
    * Can be obtained from the [Portal](https://portal.venly.io/) clicking the❔icon on the top right. Use the **Company ID** when creating webhooks on production env, and use the **Sandbox Company ID** when creating webhooks on sandbox env.
    * @type {string}
    */
    companyId?: string;
    /**
    * Any name for the webhook you're about to create.
    * @type {string}
    */
    name?: string;
    /**
    * This is the type of authentication for your endpoint. Authentication is to be set up by you so you can authenticate the incoming webhooks from Venly. We allow two types: `BASIC_AUTHENTICATION` and `API_KEY`
    * @type {VyWebhookAuthenticationMethodBase}
    */
    authenticationMethod?: VyWebhookAuthenticationMethodBase;
    constructor(initializer?: VyUpdateWebhookRequest);
}
/**
*
*/
export declare class VyAuthenticationMethodRequestApiKey extends VyWebhookAuthenticationMethodBase {
    /**
    *
    * @type {string}
    */
    type?: string;
    /**
    * This is the name of your api key. (A custom API header name that you enter)
    * @type {string}
    */
    headerName?: string;
    /**
    * This is the value of your API key for your endpoint. (A custom value that you enter for your endpoint.)
    * @type {string}
    */
    apiKey?: string;
    constructor(initializer?: VyAuthenticationMethodRequestApiKey);
}
/**
*
*/
export declare class VyAuthenticationMethodRequestBasicAuth extends VyWebhookAuthenticationMethodBase {
    /**
    *
    * @type {string}
    */
    type?: string;
    /**
    * This is the username for your endpoint. (A custom username that you enter)
    * @type {string}
    */
    username?: string;
    /**
    * This is the password you enter for your endpoint.
    * @type {string}
    */
    password?: string;
    constructor(initializer?: VyAuthenticationMethodRequestBasicAuth);
}
/**
*
*/
export declare class VyBasicAuthCredentialsDto {
    /**
    *
    * @type {string}
    */
    username?: string;
    constructor(initializer?: VyBasicAuthCredentialsDto);
}
/**
*
*/
export declare class VyApiKeyAuthCredentialsDto {
    /**
    *
    * @type {string}
    */
    authenticationHeader?: string;
    constructor(initializer?: VyApiKeyAuthCredentialsDto);
}
/**
*
*/
export declare class VyWebhookDto {
    /**
    *
    * @type {string}
    */
    id?: string;
    /**
    *
    * @type {string}
    */
    targetId?: string;
    /**
    *
    * @type {string}
    */
    application?: string;
    /**
    *
    * @type {string}
    */
    url?: string;
    /**
    *
    * @type {VyPayWebhookAuthType}
    */
    authenticationType?: enums.VyPayWebhookAuthType;
    /**
    *
    * @type {VyBasicAuthCredentialsDto}
    */
    basicAuthCredentials?: VyBasicAuthCredentialsDto;
    /**
    *
    * @type {VyApiKeyAuthCredentialsDto}
    */
    apiKeyAuthCredentials?: VyApiKeyAuthCredentialsDto;
    constructor(initializer?: VyWebhookDto);
}
/**
*
*/
export declare class VyLineItemPriceDto {
    /**
    *
    * @type {string}
    */
    id?: string;
    /**
    *
    * @type {string}
    */
    object?: string;
    /**
    *
    * @type {boolean}
    */
    active?: boolean;
    /**
    *
    * @type {string}
    */
    billingScheme?: string;
    /**
    *
    * @type {number}
    */
    created?: number;
    /**
    *
    * @type {string}
    */
    currency?: string;
    /**
    *
    * @type {Any}
    */
    customUnitAmount?: Any;
    /**
    *
    * @type {boolean}
    */
    livemode?: boolean;
    /**
    *
    * @type {string}
    */
    lookupKey?: string;
    /**
    *
    * @type {Any}
    */
    metadata?: Any;
    /**
    *
    * @type {string}
    */
    nickname?: string;
    /**
    *
    * @type {string}
    */
    product?: string;
    /**
    *
    * @type {Any}
    */
    recurring?: Any;
    /**
    *
    * @type {string}
    */
    taxBehavior?: string;
    /**
    *
    * @type {string}
    */
    tiersMode?: string;
    /**
    *
    * @type {Any}
    */
    transformQuantity?: Any;
    /**
    *
    * @type {string}
    */
    type?: string;
    /**
    *
    * @type {number}
    */
    unitAmount?: number;
    /**
    *
    * @type {string}
    */
    unitAmountDecimal?: string;
    constructor(initializer?: VyLineItemPriceDto);
}
/**
*
*/
export declare class VyLineItemDto {
    /**
    *
    * @type {string}
    */
    id?: string;
    /**
    *
    * @type {string}
    */
    object?: string;
    /**
    *
    * @type {number}
    */
    amountDiscount?: number;
    /**
    *
    * @type {number}
    */
    amountSubtotal?: number;
    /**
    *
    * @type {number}
    */
    amountTax?: number;
    /**
    *
    * @type {number}
    */
    amountTotal?: number;
    /**
    *
    * @type {string}
    */
    currency?: string;
    /**
    *
    * @type {string}
    */
    description?: string;
    /**
    *
    * @type {VyLineItemPriceDto}
    */
    price?: VyLineItemPriceDto;
    /**
    *
    * @type {number}
    */
    quantity?: number;
    constructor(initializer?: VyLineItemDto);
}
/**
*
*/
export declare class VyLineItemsResponseDto {
    /**
    *
    * @type {string}
    */
    object?: string;
    /**
    *
    * @type {VyLineItemDto[]}
    */
    data?: VyLineItemDto[];
    /**
    *
    * @type {boolean}
    */
    hasMore?: boolean;
    /**
    *
    * @type {string}
    */
    url?: string;
    constructor(initializer?: VyLineItemsResponseDto);
}
//# sourceMappingURL=VyModels.Pay.generated.d.ts.map