@pax2pay/client 0.9.2 → 0.9.4

package/model/Report/ReportFileDestination.ts

@@ -0,0 +1,23 @@
+import { isly } from "isly"
+import { DestinationType } from "../DestinationType"
+import { EmailReportFileDestination } from "../EmailReportFileDestination"
+import { SftpReportFileDestination } from "../SftpReportFileDestination"
+
+export type ReportFileDestination = (EmailReportFileDestination | SftpReportFileDestination) & {
+	destinationType: DestinationType
+}
+
+export namespace ReportFileDestination {
+	export type Type = {
+		destinationType: DestinationType
+	}
+	export const type = isly.intersection<
+		ReportFileDestination,
+		Type,
+		EmailReportFileDestination | SftpReportFileDestination
+	>(
+		isly.object<Type>({ destinationType: DestinationType.type }),
+		isly.union(EmailReportFileDestination.type, SftpReportFileDestination.type)
+	)
+	export const is = type.is
+}

package/model/Report/ReportSubscriptionFrequencyRequest.ts

@@ -0,0 +1,17 @@
+import { isly } from "isly"
+import { DayOfWeek } from "../DayOfWeek"
+import { ReportSubscriptionFrequencyType } from "./ReportSubscriptionFrequencyType"
+
+export interface ReportSubscriptionFrequencyRequest {
+	type: ReportSubscriptionFrequencyType
+	dayOfWeek?: DayOfWeek
+	dayOfMonth?: number
+}
+export namespace ReportSubscriptionFrequencyRequest {
+	export const type = isly.object<ReportSubscriptionFrequencyRequest>({
+		type: ReportSubscriptionFrequencyType.type,
+		dayOfWeek: DayOfWeek.type.optional(),
+		dayOfMonth: isly.number("integer").optional(),
+	})
+	export const is = type.is
+}

package/model/Report/ReportSubscriptionFrequencyType.ts

@@ -0,0 +1,9 @@
+import { isly } from "isly"
+
+export type ReportSubscriptionFrequencyType = typeof ReportSubscriptionFrequencyType.values[number]
+
+export namespace ReportSubscriptionFrequencyType {
+	export const values = ["DAILY", "WEEKLY", "MONTHLY"] as const
+	export const type = isly.string<ReportSubscriptionFrequencyType>(values)
+	export const is = type.is
+}

package/model/Report/ReportSubscriptionInvocationOutcome.ts

@@ -0,0 +1,9 @@
+import { isly } from "isly"
+
+export type ReportSubscriptionInvocationOutcome = typeof ReportSubscriptionInvocationOutcome.values[number]
+
+export namespace ReportSubscriptionInvocationOutcome {
+	export const values = ["SUCCESS", "FAILURE"] as const
+	export const type = isly.string<ReportSubscriptionInvocationOutcome>(values)
+	export const is = type.is
+}

package/model/Report/ReportSubscriptionInvocationResponse.ts

@@ -0,0 +1,17 @@
+import { DateTime } from "isoly"
+import { isly } from "isly"
+import { ReportSubscriptionInvocationOutcome } from "./ReportSubscriptionInvocationOutcome"
+
+export interface ReportSubscriptionInvocationResponse {
+	createdAt: DateTime
+	outcome: ReportSubscriptionInvocationOutcome
+	errorMessage?: string
+}
+export namespace ReportSubscriptionInvocationResponse {
+	export const type = isly.object<ReportSubscriptionInvocationResponse>({
+		createdAt: isly.fromIs("DateTime", DateTime.is),
+		outcome: ReportSubscriptionInvocationOutcome.type,
+		errorMessage: isly.string().optional(),
+	})
+	export const is = type.is
+}

package/model/Report/ReportSubscriptionRequest.ts

@@ -0,0 +1,24 @@
+import { isly } from "isly"
+import { DestinationType } from "../DestinationType"
+import { DownloadFileFormat } from "../DownloadFileFormat"
+import { ReportSubscriptionFrequencyRequest } from "./ReportSubscriptionFrequencyRequest"
+import { ReportType } from "./ReportType"
+export interface ReportSubscriptionRequest {
+	name?: string
+	reportType: ReportType
+	fileFormat: DownloadFileFormat
+	request?: Record<string, any>
+	frequency: ReportSubscriptionFrequencyRequest
+	destination: DestinationType
+}
+export namespace ReportSubscriptionRequest {
+	export const type = isly.object<ReportSubscriptionRequest>({
+		name: isly.string().optional(),
+		reportType: ReportType.type,
+		fileFormat: DownloadFileFormat.type,
+		request: isly.record(isly.string(), isly.any()).optional(),
+		frequency: isly.fromIs("ReportSubscriptionFrequencyRequest", ReportSubscriptionFrequencyRequest.is),
+		destination: DestinationType.type,
+	})
+	export const is = type.is
+}

package/model/Report/ReportSubscriptionResponse.ts

@@ -0,0 +1,34 @@
+import { isly } from "isly"
+import { DownloadFileFormat } from "../DownloadFileFormat"
+import { ReportFileDestination } from "./ReportFileDestination"
+import { ReportSubscriptionFrequencyRequest } from "./ReportSubscriptionFrequencyRequest"
+import { ReportSubscriptionInvocationResponse } from "./ReportSubscriptionInvocationResponse"
+import { ReportSubscriptionStatus } from "./ReportSubscriptionStatus"
+import { ReportType } from "./ReportType"
+
+export interface ReportSubscriptionResponse {
+	id: string
+	name: string
+	reportType: ReportType
+	fileFormat: DownloadFileFormat
+	status: ReportSubscriptionStatus
+	request: Record<string, any>
+	frequency: ReportSubscriptionFrequencyRequest
+	destination: ReportFileDestination
+	lastInvocation?: ReportSubscriptionInvocationResponse
+}
+
+export namespace ReportSubscriptionResponse {
+	export const type = isly.object<ReportSubscriptionResponse>({
+		id: isly.string(),
+		name: isly.string(),
+		reportType: ReportType.type,
+		fileFormat: DownloadFileFormat.type,
+		status: ReportSubscriptionStatus.type,
+		request: isly.record(isly.string(), isly.any()),
+		frequency: isly.fromIs("ReportSubscriptionFrequencyRequest", ReportSubscriptionFrequencyRequest.is),
+		destination: isly.fromIs("ReportFileDestination", ReportFileDestination.is),
+		lastInvocation: ReportSubscriptionInvocationResponse.type.optional(),
+	})
+	export const is = type.is
+}

package/model/Report/ReportSubscriptionStatus.ts

@@ -0,0 +1,9 @@
+import { isly } from "isly"
+
+export type ReportSubscriptionStatus = typeof ReportSubscriptionStatus.values[number]
+
+export namespace ReportSubscriptionStatus {
+	export const values = ["ACTIVE", "DELETED"] as const
+	export const type = isly.string<ReportSubscriptionStatus>(values)
+	export const is = type.is
+}

package/model/Report/ReportType.ts

@@ -0,0 +1,8 @@
+import { isly } from "isly"
+
+export type ReportType = typeof ReportType.values[number]
+export namespace ReportType {
+	export const values = ["RECONCILIATION", "STATEMENT"] as const
+	export const type = isly.string<ReportType>(values)
+	export const is = type.is
+}

package/model/Role.ts

@@ -0,0 +1,115 @@
+import { isly } from "isly"
+
+export type Role = typeof Role.values[number]
+
+export namespace Role {
+	export const values = [
+		"user.create", // users
+		"user.list",
+		"user.list.own-category",
+		"user.view.other",
+		"user.edit.self",
+		"user.edit.other",
+		"user.edit-status",
+		"user.change-password.other",
+		"user.2fa.remove",
+		"api-key.create",
+		"api-key.edit",
+		"api-key.view",
+		"funding-account.view", // funding accounts
+		"funding-account.list",
+		"funding-account.summary",
+		"funding-account.edit",
+		"funding-account.add",
+		"funding-account.create-new",
+		"card.create", // cards
+		"card.list",
+		"card.view",
+		"card.cancel",
+		"card.freeze-thaw",
+		"card.amend.balance",
+		"card.statements",
+		"card.create.find-and-amend",
+		"card.create.batch",
+		"card.create.delivery.email",
+		"card.reverse-authorisation",
+		"card-options.view",
+		"card-options.edit",
+		"card-type.edit",
+		"card-type.profile.view",
+		"card-type.profile.edit",
+		"card-type.profile.edit-shared",
+		"card-type.profile.edit-default",
+		"card-type.profile.set",
+		"beneficiary.view", // transfers & beneficiaries
+		"beneficiary.list",
+		"beneficiary.create",
+		"beneficiary.edit",
+		"beneficiary.create.rebate",
+		"transfer.create",
+		"transfer.create.delivery.email",
+		"transfer.create.beneficiary",
+		"transfer.create.non-beneficiary",
+		"transfer.create.funding-account",
+		"transfer.view",
+		"transfer.list",
+		"transfer.edit",
+		"transfer.cancel",
+		"booking-info.create", // transactions & find and amend
+		"booking-info.update",
+		"booking-info.update.overwrite",
+		"booking-info.update.add",
+		"transaction.create",
+		"transaction.view",
+		"transaction.list",
+		"transaction.list.card",
+		"provider-transaction.insert", // provider transactions
+		"provider.modulr", // providers
+		"provider.ixaris",
+		"provider.wex",
+		"provider.conferma",
+		"provider.pax2pay",
+		"limit.edit.individual", // limits
+		"limit.edit.category",
+		"limit.edit-category-on-user",
+		"pending.request", // pending stuff
+		"pending.approve.card",
+		"pending.approve.transfer",
+		"pending.approve.payment",
+		"pending.approve.card-amendment",
+		"assume", // admin stuff
+		"indefinite-password",
+		"ops-tasks",
+		"omnisetup",
+		"credentials.view",
+		"credentials.edit",
+		"config.view.internal", // config
+		"config.edit.organisation",
+		"config.edit.internal",
+		"roles.view-internal", // Roles
+		"roles.edit-rolesets",
+		"user-roles.edit",
+		"roles.edit-rolesets.shared",
+		"roles.edit-rolesets.default",
+		"reports.statement", // reports
+		"reports.reconciliation",
+		"reports.chargeback",
+		"reports.automated",
+		"reports.rebate",
+		"reports.subscription.view",
+		"reports.subscription.edit",
+		"schedule.create", // schedules
+		"schedule.view",
+		"schedule.edit",
+		"schedule.cancel",
+		"payment.plan", // payments
+		"payment.create",
+		"payment.view",
+		"payment.freeze-thaw",
+		"payment.cancel",
+		"payment.amend.balance",
+		"confirm-payee", // confirmation of payee
+	] as const
+	export const type = isly.string(values)
+	export const is = type.is
+}

package/model/RoleResponse.ts

@@ -1,8 +1,10 @@
+import { Role } from "./Role"
+
 /**
  * All roles that this user has, from all rolesets and individual roles
  */
 export interface RoleResponse {
-	name?: string
+	name?: Role
 	description?: string
 	internal?: boolean
 }

package/model/SftpReportFileDestination.ts

@@ -0,0 +1,23 @@
+import { isly } from "isly"
+
+export interface SftpReportFileDestination {
+	host: string
+	user: string
+	port?: number
+	password?: string
+	privateKey?: string
+	fingerPrint?: string
+	path: string
+}
+export namespace SftpReportFileDestination {
+	export const type = isly.object<SftpReportFileDestination>({
+		host: isly.string(),
+		user: isly.string(),
+		port: isly.number("integer").optional(),
+		password: isly.string().optional(),
+		privateKey: isly.string().optional(),
+		fingerPrint: isly.string().optional(),
+		path: isly.string(),
+	})
+	export const is = type.is
+}

package/model/index.ts

@@ -80,7 +80,9 @@ import { CredentialResponse } from "./CredentialResponse"
 import { Criteria } from "./Criteria"
 import { CurrencyConversionRequest } from "./CurrencyConversionRequest"
 import { CurrencyConversionResponse } from "./CurrencyConversionResponse"
+import { DayOfWeek } from "./DayOfWeek"
 import { DeliveryStatus } from "./DeliveryStatus"
+import { DestinationType } from "./DestinationType"
 import { DownloadableResponse } from "./DownloadableResponse"
 import { DownloadCardReportRequest } from "./DownloadCardReportRequest"
 import { DownloadFileFormat } from "./DownloadFileFormat"
@@ -94,6 +96,7 @@ import { EditPaymentAmountScheduleRequest } from "./EditPaymentAmountScheduleReq
 import { EditPaymentCloseDateRequest } from "./EditPaymentCloseDateRequest"
 import { EditPaymentMetadataRequest } from "./EditPaymentMetadataRequest"
 import { EditPaymentScheduleRequest } from "./EditPaymentScheduleRequest"
+import { EmailReportFileDestination } from "./EmailReportFileDestination"
 import { EmailValidationResponse } from "./EmailValidationResponse"
 import { ErrorMessageDto } from "./ErrorMessageDto"
 import { ErrorResponse } from "./ErrorResponse"
@@ -193,6 +196,16 @@ import { Range } from "./Range"
 import { References } from "./References"
 import { RelogWithNewSessionDetailsRequest } from "./RelogWithNewSessionDetailsRequest"
 import { Report } from "./Report"
+import { ReportFileDestination } from "./Report/ReportFileDestination"
+import { ReportSubscriptionFrequencyRequest } from "./Report/ReportSubscriptionFrequencyRequest"
+import { ReportSubscriptionFrequencyType } from "./Report/ReportSubscriptionFrequencyType"
+import { ReportSubscriptionInvocationOutcome } from "./Report/ReportSubscriptionInvocationOutcome"
+import { ReportSubscriptionInvocationResponse } from "./Report/ReportSubscriptionInvocationResponse"
+import { ReportSubscriptionRequest } from "./Report/ReportSubscriptionRequest"
+import { ReportSubscriptionResponse } from "./Report/ReportSubscriptionResponse"
+import { ReportSubscriptionStatus } from "./Report/ReportSubscriptionStatus"
+import { ReportType } from "./Report/ReportType"
+import { Role } from "./Role"
 import { RoleResponse } from "./RoleResponse"
 import { RolesetResponse } from "./RolesetResponse"
 import { Room } from "./Room"
@@ -204,6 +217,7 @@ import { SearchRolesetsRequest } from "./SearchRolesetsRequest"
 import { SecurityConfig } from "./SecurityConfig"
 import { Segment } from "./Segment"
 import { SetAvailableCardTypesRequest } from "./SetAvailableCardTypesRequest"
+import { SftpReportFileDestination } from "./SftpReportFileDestination"
 import { SsoLoginRequest } from "./SsoLoginRequest"
 import { SsoProviderConfig } from "./SsoProviderConfig"
 import { SsoProviderType } from "./SsoProviderType"
@@ -327,7 +341,6 @@ export {
 	CardTypeFlag,
 	CardUsage,
 	CategoryFundingAccountAccessRequest,
-	UpdateCategoryRequest,
 	CategoryLimitResponse,
 	CategoryResponse,
 	CategoryStatus,
@@ -345,7 +358,10 @@ export {
 	Criteria,
 	CurrencyConversionRequest,
 	CurrencyConversionResponse,
+	DayOfWeek,
 	DeliveryStatus,
+	DestinationType,
+	DownloadableResponse,
 	DownloadCardReportRequest,
 	DownloadFileFormat,
 	DownloadOrganisationSearchRequest,
@@ -358,6 +374,7 @@ export {
 	EditPaymentCloseDateRequest,
 	EditPaymentMetadataRequest,
 	EditPaymentScheduleRequest,
+	EmailReportFileDestination,
 	EmailValidationResponse,
 	ErrorMessageDto,
 	ErrorResponse,
@@ -456,8 +473,17 @@ export {
 	Range,
 	References,
 	RelogWithNewSessionDetailsRequest,
+	Role,
 	Report,
-	DownloadableResponse,
+	ReportFileDestination,
+	ReportSubscriptionFrequencyRequest,
+	ReportSubscriptionFrequencyType,
+	ReportSubscriptionInvocationOutcome,
+	ReportSubscriptionInvocationResponse,
+	ReportSubscriptionResponse,
+	ReportSubscriptionStatus,
+	ReportType,
+	ReportSubscriptionRequest,
 	RoleResponse,
 	RolesetResponse,
 	Room,
@@ -467,6 +493,7 @@ export {
 	SearchRolesetsRequest,
 	SecurityConfig,
 	SetAvailableCardTypesRequest,
+	SftpReportFileDestination,
 	Segment,
 	SsoLoginRequest,
 	SsoProviderConfig,
@@ -509,6 +536,7 @@ export {
 	TwoFactorAuthenticationRegistrationResponse,
 	UpdateAccountRequest,
 	UpdateBeneficiaryRequest,
+	UpdateCategoryRequest,
 	UpdateMerchantRequest,
 	UpdateRolesetRequest,
 	Usage,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pax2pay/client",
-	"version": "0.9.2",
+	"version": "0.9.4",
 	"description": "Client library for the Pax2Pay API",
 	"author": "Pax2Pay Ltd.",
 	"license": "MIT",

package/model/Report/ChargeBackItem.ts

@@ -1,33 +0,0 @@
-import * as isoly from "isoly"
-/**
- * An item in the charge-back report
- */
-export interface ChargeBackItem {
-	fullRefunds: Refund[]
-	partialRefunds: Refund[]
-}
-
-export interface Refund {
-	bookingReference: string //not necessary? / change name?
-	agentBookingReference: string //not necessary? / change name?
-	supplierCode: string
-	cardId: string
-	leadPassengerName: string //not necessary?
-	totalPassengers: number //not necessary?
-	bookingDate: isoly.Date
-	departureDate: isoly.Date
-	departureAirport: string //not necessary?
-	arrivalAirport: string //not necessary?
-	outboundFlightNumbers: any[] //not necessary?
-	homeboundFlightNumbers: any[] //not necessary?
-	modularTransactionInfo: ModularTransactionInfo
-	claimAmount: number
-}
-
-export interface ModularTransactionInfo {
-	bookingReference: string
-	settlementId: string
-	cardId: string
-	transactionAmount: number
-	transactionCurrency: isoly.Currency
-}