pnz-payments-sdk
Version:
PNZ Payments Account and Transaction API
127 lines (123 loc) • 6.93 kB
text/typescript
/**
* Account and Transaction API SpecificationLib
*
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { ApiResponse, RequestOptions } from '../core';
import {
BeneficiariesResponse,
beneficiariesResponseSchema,
} from '../models/beneficiariesResponse';
import { optional, string } from '../schema';
import { BaseController } from './baseController';
import { ApiError } from '@apimatic/core';
import { AccountsBeneficiaries400Error } from '../errors/accountsBeneficiaries400Error';
import { AccountsBeneficiaries403Error } from '../errors/accountsBeneficiaries403Error';
import { AccountsBeneficiaries500Error } from '../errors/accountsBeneficiaries500Error';
import { AccountsBeneficiaries503Error } from '../errors/accountsBeneficiaries503Error';
import { Beneficiaries400Error } from '../errors/beneficiaries400Error';
import { Beneficiaries403Error } from '../errors/beneficiaries403Error';
import { Beneficiaries500Error } from '../errors/beneficiaries500Error';
import { Beneficiaries503Error } from '../errors/beneficiaries503Error';
export class BeneficiariesController extends BaseController {
/**
* Get Beneficiaries related to an account
*
* @param accountId A unique identifier used to identify the account resource.
* @param xFapiAuthDate The time when the Customer last logged in with the Third Party. All
* dates in the HTTP headers are represented as RFC 7231 Full Dates. An
* example is below: Sun, 10 Sep 2017 19:43:31 UTC
* @param xFapiCustomerIpAddress The Customer's IP address if the Customer is currently logged in with
* the Third Party.
* @param xFapiInteractionId An RFC4122 UID used as a correlation id.
* @param xMerchantIpAddress The IP address of the merchant when making account information
* requests through a Third Party.
* @param xCustomerUserAgent The User-Agent of the application on the customer device that is used
* to make the account information request
* @return Response from the API call
*/
async getAccountBeneficiaries(
accountId: string,
xFapiAuthDate?: string,
xFapiCustomerIpAddress?: string,
xFapiInteractionId?: string,
xMerchantIpAddress?: string,
xCustomerUserAgent?: string,
requestOptions?: RequestOptions
): Promise<ApiResponse<BeneficiariesResponse>> {
const req = this.createRequest('GET');
const mapped = req.prepareArgs({
accountId: [accountId, string()],
xFapiAuthDate: [xFapiAuthDate, optional(string())],
xFapiCustomerIpAddress: [xFapiCustomerIpAddress, optional(string())],
xFapiInteractionId: [xFapiInteractionId, optional(string())],
xMerchantIpAddress: [xMerchantIpAddress, optional(string())],
xCustomerUserAgent: [xCustomerUserAgent, optional(string())],
});
req.header('x-fapi-auth-date', mapped.xFapiAuthDate);
req.header('x-fapi-customer-ip-address', mapped.xFapiCustomerIpAddress);
req.header('x-fapi-interaction-id', mapped.xFapiInteractionId);
req.header('x-merchant-ip-address', mapped.xMerchantIpAddress);
req.header('x-customer-user-agent', mapped.xCustomerUserAgent);
req.appendTemplatePath`/accounts/${mapped.accountId}/beneficiaries`;
req.throwOn(400, AccountsBeneficiaries400Error, 'Bad Request');
req.throwOn(401, ApiError, 'Unauthorized');
req.throwOn(403, AccountsBeneficiaries403Error, 'Forbidden');
req.throwOn(405, ApiError, 'Method Not Allowed');
req.throwOn(406, ApiError, 'Not Acceptable');
req.throwOn(429, ApiError, 'Too Many Requests');
req.throwOn(500, AccountsBeneficiaries500Error, 'Internal Server Error');
req.throwOn(501, ApiError, 'Not Implemented');
req.throwOn(503, AccountsBeneficiaries503Error, 'Service Unavailable');
req.authenticate([{ hTTPBearerAuthentication: true }]);
return req.callAsJson(beneficiariesResponseSchema, requestOptions);
}
/**
* Get Beneficiaries
*
* @param xFapiAuthDate The time when the Customer last logged in with the Third Party. All
* dates in the HTTP headers are represented as RFC 7231 Full Dates. An
* example is below: Sun, 10 Sep 2017 19:43:31 UTC
* @param xFapiCustomerIpAddress The Customer's IP address if the Customer is currently logged in with
* the Third Party.
* @param xFapiInteractionId An RFC4122 UID used as a correlation id.
* @param xMerchantIpAddress The IP address of the merchant when making account information
* requests through a Third Party.
* @param xCustomerUserAgent The User-Agent of the application on the customer device that is used
* to make the account information request
* @return Response from the API call
*/
async getBeneficiaries(
xFapiAuthDate?: string,
xFapiCustomerIpAddress?: string,
xFapiInteractionId?: string,
xMerchantIpAddress?: string,
xCustomerUserAgent?: string,
requestOptions?: RequestOptions
): Promise<ApiResponse<BeneficiariesResponse>> {
const req = this.createRequest('GET', '/beneficiaries');
const mapped = req.prepareArgs({
xFapiAuthDate: [xFapiAuthDate, optional(string())],
xFapiCustomerIpAddress: [xFapiCustomerIpAddress, optional(string())],
xFapiInteractionId: [xFapiInteractionId, optional(string())],
xMerchantIpAddress: [xMerchantIpAddress, optional(string())],
xCustomerUserAgent: [xCustomerUserAgent, optional(string())],
});
req.header('x-fapi-auth-date', mapped.xFapiAuthDate);
req.header('x-fapi-customer-ip-address', mapped.xFapiCustomerIpAddress);
req.header('x-fapi-interaction-id', mapped.xFapiInteractionId);
req.header('x-merchant-ip-address', mapped.xMerchantIpAddress);
req.header('x-customer-user-agent', mapped.xCustomerUserAgent);
req.throwOn(400, Beneficiaries400Error, 'Bad Request');
req.throwOn(401, ApiError, 'Unauthorized');
req.throwOn(403, Beneficiaries403Error, 'Forbidden');
req.throwOn(405, ApiError, 'Method Not Allowed');
req.throwOn(406, ApiError, 'Not Acceptable');
req.throwOn(429, ApiError, 'Too Many Requests');
req.throwOn(500, Beneficiaries500Error, 'Internal Server Error');
req.throwOn(501, ApiError, 'Not Implemented');
req.throwOn(503, Beneficiaries503Error, 'Service Unavailable');
req.authenticate([{ hTTPBearerAuthentication: true }]);
return req.callAsJson(beneficiariesResponseSchema, requestOptions);
}
}