@venly/venly-core-sdk
Version:
Javascrip/Typescript SDK for Venly's Web3 Services
162 lines • 7.57 kB
JavaScript
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.VyPayAPI_Gen = void 0;
const core_1 = require("../core");
const json_1 = require("../helpers/json");
const pay = __importStar(require("../models/pay/index"));
const shared = __importStar(require("../models/shared/index"));
const enums = __importStar(require("../models/enums/index"));
class VyPayAPI_Gen {
constructor(_apiBase) {
this._apiBase = _apiBase;
this._apiEndpoint = enums.VyApiEndpoint.Pay;
}
/**
* 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 {VyHealthCheckPayResponse}
*/
healthCheckPay() {
var reqData = core_1.VyRequestData.get("/actuator/health", this._apiEndpoint)
.setEnveloped(false)
.setAuth_OAuth2(true);
return this._apiBase.makeRequest(reqData, pay.VyHealthCheckPayResponse);
}
/**
* 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 {VyCreateCheckoutLinkResponse}
*/
checkoutSession(reqParams) {
var reqData = core_1.VyRequestData.post("/checkout/sessions", this._apiEndpoint)
.setEnveloped(false)
.setAuth_OAuth2(true)
.addJsonContent(reqParams, pay.VyCheckoutSessionRequest);
return this._apiBase.makeRequest(reqData, pay.VyCreateCheckoutLinkResponse);
}
/**
* 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 {VyUploadIconResponse}
*/
uploadIcon(reqParams) {
var reqData = core_1.VyRequestData.post("/account/settings/branding/icon", this._apiEndpoint)
.setEnveloped(false)
.setAuth_OAuth2(true)
.addJsonContent(reqParams, pay.VyUploadIconRequest);
return this._apiBase.makeRequest(reqData, pay.VyUploadIconResponse);
}
/**
* 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 {VyAccountRequest} reqParams - Request data for the operation
* @returns {Any}
*/
updateSettingsBranding(reqParams) {
var reqData = core_1.VyRequestData.post("/account/settings/branding", this._apiEndpoint)
.setEnveloped(false)
.setAuth_OAuth2(true)
.addJsonContent(reqParams, pay.VyAccountRequest);
return this._apiBase.makeRequest(reqData, json_1.Any);
}
/**
* This endpoint allows you to fetch a login link for your Stripe dashboard.
* @returns {VyStripeDashboardResponse}
*/
getDashboardLink() {
var reqData = core_1.VyRequestData.get("/stripe-dashboard", this._apiEndpoint)
.setEnveloped(false)
.setAuth_OAuth2(true);
return this._apiBase.makeRequest(reqData, pay.VyStripeDashboardResponse);
}
/**
* 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 {VyGetCheckoutStatusResponse}
*/
getSession(sessionId) {
var reqData = core_1.VyRequestData.get(`/checkout/sessions/${sessionId}`, this._apiEndpoint)
.setEnveloped(false)
.setAuth_OAuth2(true);
return this._apiBase.makeRequest(reqData, pay.VyGetCheckoutStatusResponse);
}
/**
* This endpoint is used to create a webhook, to receive updates of your user's payments (_successful/cancelled_).
* @param {VyPayWebhookRequest} reqParams - Request data for the operation
* @returns {VyResponseEnvelopeWebhookDto}
*/
createWebhook(reqParams) {
var reqData = core_1.VyRequestData.post("/webhooks", this._apiEndpoint)
.setEnveloped(false)
.setAuth_OAuth2(true)
.addJsonContent(reqParams, pay.VyPayWebhookRequest);
return this._apiBase.makeRequest(reqData, pay.VyResponseEnvelopeWebhookDto);
}
/**
* This endpoint is used to get all of your webhooks.
* @returns {VyResponseEnvelopeListWebhookDto}
*/
findAll() {
var reqData = core_1.VyRequestData.get("/webhooks", this._apiEndpoint)
.setEnveloped(false)
.setAuth_OAuth2(true);
return this._apiBase.makeRequest(reqData, pay.VyResponseEnvelopeListWebhookDto);
}
/**
*
* @param {string} webhookId - This is the `ID` of the webhook you want to update.
* @param {VyPayWebhookRequest} reqParams - Request data for the operation
* @returns {VyWebhookDto}
*/
update(webhookId, reqParams) {
var reqData = core_1.VyRequestData.put(`/webhooks/${webhookId}`, this._apiEndpoint)
.setEnveloped(false)
.setAuth_OAuth2(true)
.addJsonContent(reqParams, pay.VyPayWebhookRequest);
return this._apiBase.makeRequest(reqData, shared.VyWebhookDto);
}
/**
*
* @param {string} webhookId - This is the `ID` of the webhook you want to delete.
*/
delete(webhookId) {
var reqData = core_1.VyRequestData.delete(`/webhooks/${webhookId}`, this._apiEndpoint)
.setEnveloped(false)
.setAuth_OAuth2(true);
return this._apiBase.makeRequest(reqData, json_1.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 {VyGetLineItemsResponse}
*/
getLineItems(sessionId) {
var reqData = core_1.VyRequestData.get(`/checkout/sessions/${sessionId}/line_items`, this._apiEndpoint)
.setEnveloped(false)
.setAuth_OAuth2(false);
return this._apiBase.makeRequest(reqData, pay.VyGetLineItemsResponse);
}
}
exports.VyPayAPI_Gen = VyPayAPI_Gen;
//# sourceMappingURL=VyPayAPI.generated.js.map