@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 shared from '../shared/index';
/**
*
*/
export declare class VyHealthCheckPayResponse {
    /**
    * Indicates the status of API services as either `UP` or `DOWN`.
    * @type {string}
    */
    status?: string;
    constructor(initializer?: VyHealthCheckPayResponse);
}
/**
*
*/
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}
    */
    readonly 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;
    /**
    *
    * @type {VyCustomerRequest}
    */
    customer?: VyCustomerRequest;
    constructor(initializer?: VyCheckoutSessionRequest);
}
/**
*
*/
export declare class VyCreateCheckoutLinkResponse {
    /**
    *
    * @type {boolean}
    */
    success?: boolean;
    /**
    *
    * @type {Any}
    */
    result?: Any;
    constructor(initializer?: VyCreateCheckoutLinkResponse);
}
/**
*
*/
export declare class VyUploadIconRequest {
    /**
    *
    * @type {Buffer}
    */
    icon?: Buffer;
    constructor(initializer?: VyUploadIconRequest);
}
/**
*
*/
export declare class VyUploadIconResponse {
    /**
    *
    * @type {boolean}
    */
    success?: boolean;
    /**
    *
    * @type {Any}
    */
    result?: Any;
    constructor(initializer?: VyUploadIconResponse);
}
/**
*
*/
export declare class VyAccountSettingsBrandingRequest {
    /**
    * 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?: VyAccountSettingsBrandingRequest);
}
/**
*
*/
export declare class VyAccountSettingsRequest {
    /**
    *
    * @type {VyAccountSettingsBrandingRequest}
    */
    branding?: VyAccountSettingsBrandingRequest;
    constructor(initializer?: VyAccountSettingsRequest);
}
/**
*
*/
export declare class VyAccountRequest {
    /**
    *
    * @type {VyAccountSettingsRequest}
    */
    settings?: VyAccountSettingsRequest;
    constructor(initializer?: VyAccountRequest);
}
/**
*
*/
export declare class VyStripeDashboardResponse {
    /**
    *
    * @type {boolean}
    */
    success?: boolean;
    /**
    *
    * @type {Any}
    */
    result?: Any;
    constructor(initializer?: VyStripeDashboardResponse);
}
/**
*
*/
export declare class VyGetCheckoutStatusResponse {
    /**
    *
    * @type {boolean}
    */
    success?: boolean;
    /**
    *
    * @type {Any}
    */
    result?: Any;
    constructor(initializer?: VyGetCheckoutStatusResponse);
}
/**
*
*/
export declare class VyPayWebhookRequest {
    /**
    * This is your endpoint URL which can accept `POST` calls.
    * @type {string}
    */
    url?: string;
    /**
    *
    * @type {VyAuthenticationMethodRequest}
    */
    authenticationMethod?: shared.VyAuthenticationMethodRequest;
    constructor(initializer?: VyPayWebhookRequest);
}
/**
*
*/
export declare class VyResponseEnvelopeWebhookDto {
    /**
    *
    * @type {boolean}
    */
    success?: boolean;
    /**
    *
    * @type {VyWebhookDto}
    */
    result?: shared.VyWebhookDto;
    /**
    *
    * @type {VyErrorBody[]}
    */
    errors?: shared.VyErrorBody[];
    constructor(initializer?: VyResponseEnvelopeWebhookDto);
}
/**
*
*/
export declare class VyResponseEnvelopeListWebhookDto {
    /**
    *
    * @type {boolean}
    */
    success?: boolean;
    /**
    *
    * @type {VyWebhookDto[]}
    */
    result?: shared.VyWebhookDto[];
    /**
    *
    * @type {VyErrorBody[]}
    */
    errors?: shared.VyErrorBody[];
    constructor(initializer?: VyResponseEnvelopeListWebhookDto);
}
/**
*
*/
export declare class VyGetLineItemsResponse {
    /**
    *
    * @type {boolean}
    */
    success?: boolean;
    /**
    *
    * @type {Any}
    */
    result?: Any;
    constructor(initializer?: VyGetLineItemsResponse);
}
//# sourceMappingURL=VyModels.Pay.generated.d.ts.map