splitit-payments-sdk 1.0.5

package/src/models/planData.ts

@@ -0,0 +1,55 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  array,
+  dict,
+  lazy,
+  number,
+  object,
+  optional,
+  Schema,
+  string,
+} from '../schema.js';
+import { ProcessingData, processingDataSchema } from './processingData.js';
+import {
+  PurchaseMethodEnum,
+  purchaseMethodEnumSchema,
+} from './purchaseMethodEnum.js';
+
+export interface PlanData {
+  terminalId?: string;
+  totalAmount: string;
+  firstInstallmentAmount?: number;
+  currency?: string;
+  numberOfInstallments: number;
+  purchaseMethod: PurchaseMethodEnum;
+  refOrderNumber?: string;
+  allowedInstallmentOptions?: number[];
+  tags?: Record<string, string>;
+  processingData?: ProcessingData;
+  firstInstallmentDate?: string;
+}
+
+export const planDataSchema: Schema<PlanData> = object({
+  terminalId: ['TerminalId', optional(string())],
+  totalAmount: ['TotalAmount', string()],
+  firstInstallmentAmount: ['FirstInstallmentAmount', optional(number())],
+  currency: ['Currency', optional(string())],
+  numberOfInstallments: ['NumberOfInstallments', number()],
+  purchaseMethod: ['PurchaseMethod', purchaseMethodEnumSchema],
+  refOrderNumber: ['RefOrderNumber', optional(string())],
+  allowedInstallmentOptions: [
+    'AllowedInstallmentOptions',
+    optional(array(number())),
+  ],
+  tags: ['Tags', optional(dict(string()))],
+  processingData: [
+    'ProcessingData',
+    optional(lazy(() => processingDataSchema)),
+  ],
+  firstInstallmentDate: ['FirstInstallmentDate', optional(string())],
+});

package/src/models/planDataModel.ts

@@ -0,0 +1,43 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  dict,
+  nullable,
+  number,
+  object,
+  optional,
+  Schema,
+  string,
+} from '../schema.js';
+import {
+  PurchaseMethodEnum,
+  purchaseMethodEnumSchema,
+} from './purchaseMethodEnum.js';
+
+export interface PlanDataModel {
+  totalAmount: string;
+  currency?: string;
+  numberOfInstallments?: number | null;
+  terminalId?: string;
+  purchaseMethod: PurchaseMethodEnum;
+  refOrderNumber?: string;
+  extendedParams?: Record<string, string>;
+  firstInstallmentAmount?: string;
+  firstInstallmentDate?: string;
+}
+
+export const planDataModelSchema: Schema<PlanDataModel> = object({
+  totalAmount: ['TotalAmount', string()],
+  currency: ['Currency', optional(string())],
+  numberOfInstallments: ['NumberOfInstallments', optional(nullable(number()))],
+  terminalId: ['TerminalId', optional(string())],
+  purchaseMethod: ['PurchaseMethod', purchaseMethodEnumSchema],
+  refOrderNumber: ['RefOrderNumber', optional(string())],
+  extendedParams: ['ExtendedParams', optional(dict(string()))],
+  firstInstallmentAmount: ['FirstInstallmentAmount', optional(string())],
+  firstInstallmentDate: ['FirstInstallmentDate', optional(string())],
+});

package/src/models/planStatusEnum.ts

@@ -0,0 +1,25 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for PlanStatusEnum
+ */
+export enum PlanStatusEnum {
+  Initialized = 'Initialized',
+  PendingCapture = 'PendingCapture',
+  Active = 'Active',
+  Cleared = 'Cleared',
+  Canceled = 'Canceled',
+}
+
+/**
+ * Schema for PlanStatusEnum
+ */
+export const planStatusEnumSchema: Schema<PlanStatusEnum> = stringEnum(
+  PlanStatusEnum
+);

package/src/models/processingData.ts

@@ -0,0 +1,20 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { boolean, lazy, object, optional, Schema, string } from '../schema.js';
+import { ThreeDSData, threeDSDataSchema } from './threeDSData.js';
+
+export interface ProcessingData {
+  attemptThreeDSecured?: boolean;
+  softDescriptor?: string;
+  threeDSData?: ThreeDSData;
+}
+
+export const processingDataSchema: Schema<ProcessingData> = object({
+  attemptThreeDSecured: ['AttemptThreeDSecured', optional(boolean())],
+  softDescriptor: ['SoftDescriptor', optional(string())],
+  threeDSData: ['ThreeDSData', optional(lazy(() => threeDSDataSchema))],
+});

package/src/models/purchaseMethodEnum.ts

@@ -0,0 +1,23 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for PurchaseMethodEnum
+ */
+export enum PurchaseMethodEnum {
+  InStore = 'InStore',
+  PhoneOrder = 'PhoneOrder',
+  ECommerce = 'ECommerce',
+}
+
+/**
+ * Schema for PurchaseMethodEnum
+ */
+export const purchaseMethodEnumSchema: Schema<PurchaseMethodEnum> = stringEnum(
+  PurchaseMethodEnum
+);

package/src/models/redirectionEndpointsModel.ts

@@ -0,0 +1,23 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { object, optional, Schema, string } from '../schema.js';
+
+export interface RedirectionEndpointsModel {
+  authorizeSucceeded?: string;
+  succeeded?: string;
+  authorizeFailed?: string;
+  failed?: string;
+}
+
+export const redirectionEndpointsModelSchema: Schema<RedirectionEndpointsModel> = object(
+  {
+    authorizeSucceeded: ['AuthorizeSucceeded', optional(string())],
+    succeeded: ['Succeeded', optional(string())],
+    authorizeFailed: ['AuthorizeFailed', optional(string())],
+    failed: ['Failed', optional(string())],
+  }
+);

package/src/models/refundModel.ts

@@ -0,0 +1,31 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { number, object, optional, Schema, string } from '../schema.js';
+import {
+  RefundStatusEnum,
+  refundStatusEnumSchema,
+} from './refundStatusEnum.js';
+
+export interface RefundModel {
+  refundId?: string;
+  submitDate: string;
+  totalAmount: number;
+  status: RefundStatusEnum;
+  nonCreditRefundAmount: number;
+  creditRefundAmount: number;
+  referenceId?: string;
+}
+
+export const refundModelSchema: Schema<RefundModel> = object({
+  refundId: ['RefundId', optional(string())],
+  submitDate: ['SubmitDate', string()],
+  totalAmount: ['TotalAmount', number()],
+  status: ['Status', refundStatusEnumSchema],
+  nonCreditRefundAmount: ['NonCreditRefundAmount', number()],
+  creditRefundAmount: ['CreditRefundAmount', number()],
+  referenceId: ['ReferenceId', optional(string())],
+});

package/src/models/refundStatusEnum.ts

@@ -0,0 +1,23 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for RefundStatusEnum
+ */
+export enum RefundStatusEnum {
+  Pending = 'Pending',
+  Succeeded = 'Succeeded',
+  Failed = 'Failed',
+}
+
+/**
+ * Schema for RefundStatusEnum
+ */
+export const refundStatusEnumSchema: Schema<RefundStatusEnum> = stringEnum(
+  RefundStatusEnum
+);

package/src/models/refundStrategyEnum.ts

@@ -0,0 +1,24 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for RefundStrategyEnum
+ */
+export enum RefundStrategyEnum {
+  FutureInstallmentsFirst = 'FutureInstallmentsFirst',
+  FutureInstallmentsLast = 'FutureInstallmentsLast',
+  FutureInstallmentsNotAllowed = 'FutureInstallmentsNotAllowed',
+  ReduceFromLastInstallment = 'ReduceFromLastInstallment',
+}
+
+/**
+ * Schema for RefundStrategyEnum
+ */
+export const refundStrategyEnumSchema: Schema<RefundStrategyEnum> = stringEnum(
+  RefundStrategyEnum
+);

package/src/models/refundSummary.ts

@@ -0,0 +1,21 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { number, object, optional, Schema } from '../schema.js';
+
+export interface RefundSummary {
+  totalAmount?: number;
+  failedAmount?: number;
+  succeededAmount?: number;
+  pendingAmount?: number;
+}
+
+export const refundSummarySchema: Schema<RefundSummary> = object({
+  totalAmount: ['TotalAmount', optional(number())],
+  failedAmount: ['FailedAmount', optional(number())],
+  succeededAmount: ['SucceededAmount', optional(number())],
+  pendingAmount: ['PendingAmount', optional(number())],
+});

package/src/models/searchInstallmentPlanResponseItem.ts

@@ -0,0 +1,83 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  array,
+  dict,
+  lazy,
+  number,
+  object,
+  optional,
+  Schema,
+  string,
+} from '../schema.js';
+import { AddressData, addressDataSchema } from './addressData.js';
+import {
+  AuthorizationModel,
+  authorizationModelSchema,
+} from './authorizationModel.js';
+import { Installment, installmentSchema } from './installment.js';
+import { LinksData, linksDataSchema } from './linksData.js';
+import {
+  PaymentMethodModel,
+  paymentMethodModelSchema,
+} from './paymentMethodModel.js';
+import { PlanStatusEnum, planStatusEnumSchema } from './planStatusEnum.js';
+import {
+  PurchaseMethodEnum,
+  purchaseMethodEnumSchema,
+} from './purchaseMethodEnum.js';
+import { RefundModel, refundModelSchema } from './refundModel.js';
+import { ShopperData, shopperDataSchema } from './shopperData.js';
+
+export interface SearchInstallmentPlanResponseItem {
+  installmentPlanNumber?: string;
+  dateCreated: string;
+  refOrderNumber?: string;
+  purchaseMethod?: PurchaseMethodEnum;
+  status: PlanStatusEnum;
+  currency?: string;
+  originalAmount?: number;
+  amount?: number;
+  authorization?: AuthorizationModel;
+  shopper?: ShopperData;
+  billingAddress?: AddressData;
+  paymentMethod?: PaymentMethodModel;
+  extendedParams?: Record<string, string>;
+  installments?: Installment[];
+  refunds?: RefundModel[];
+  links?: LinksData;
+}
+
+export const searchInstallmentPlanResponseItemSchema: Schema<SearchInstallmentPlanResponseItem> = object(
+  {
+    installmentPlanNumber: ['InstallmentPlanNumber', optional(string())],
+    dateCreated: ['DateCreated', string()],
+    refOrderNumber: ['RefOrderNumber', optional(string())],
+    purchaseMethod: ['PurchaseMethod', optional(purchaseMethodEnumSchema)],
+    status: ['Status', planStatusEnumSchema],
+    currency: ['Currency', optional(string())],
+    originalAmount: ['OriginalAmount', optional(number())],
+    amount: ['Amount', optional(number())],
+    authorization: [
+      'Authorization',
+      optional(lazy(() => authorizationModelSchema)),
+    ],
+    shopper: ['Shopper', optional(lazy(() => shopperDataSchema))],
+    billingAddress: ['BillingAddress', optional(lazy(() => addressDataSchema))],
+    paymentMethod: [
+      'PaymentMethod',
+      optional(lazy(() => paymentMethodModelSchema)),
+    ],
+    extendedParams: ['ExtendedParams', optional(dict(string()))],
+    installments: [
+      'Installments',
+      optional(array(lazy(() => installmentSchema))),
+    ],
+    refunds: ['Refunds', optional(array(lazy(() => refundModelSchema)))],
+    links: ['Links', optional(lazy(() => linksDataSchema))],
+  }
+);

package/src/models/shippingStatusEnum.ts

@@ -0,0 +1,23 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for ShippingStatusEnum
+ */
+export enum ShippingStatusEnum {
+  Pending = 'Pending',
+  Shipped = 'Shipped',
+  Delivered = 'Delivered',
+}
+
+/**
+ * Schema for ShippingStatusEnum
+ */
+export const shippingStatusEnumSchema: Schema<ShippingStatusEnum> = stringEnum(
+  ShippingStatusEnum
+);

package/src/models/shopperData.ts

@@ -0,0 +1,23 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { object, optional, Schema, string } from '../schema.js';
+
+export interface ShopperData {
+  fullName?: string;
+  email?: string;
+  phoneNumber?: string;
+  culture?: string;
+  externalId?: string;
+}
+
+export const shopperDataSchema: Schema<ShopperData> = object({
+  fullName: ['FullName', optional(string())],
+  email: ['Email', optional(string())],
+  phoneNumber: ['PhoneNumber', optional(string())],
+  culture: ['Culture', optional(string())],
+  externalId: ['ExternalId', optional(string())],
+});

package/src/models/spreedlyToken.ts

@@ -0,0 +1,17 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { object, optional, Schema, string } from '../schema.js';
+
+export interface SpreedlyToken {
+  token?: string;
+  last4Digit?: string;
+}
+
+export const spreedlyTokenSchema: Schema<SpreedlyToken> = object({
+  token: ['Token', optional(string())],
+  last4Digit: ['Last4Digit', optional(string())],
+});

package/src/models/testModesEnum.ts

@@ -0,0 +1,24 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for TestModesEnum
+ */
+export enum TestModesEnum {
+  None = 'None',
+  Regular = 'Regular',
+  Fast = 'Fast',
+  Automation = 'Automation',
+}
+
+/**
+ * Schema for TestModesEnum
+ */
+export const testModesEnumSchema: Schema<TestModesEnum> = stringEnum(
+  TestModesEnum
+);

package/src/models/threeDSData.ts

@@ -0,0 +1,25 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { object, optional, Schema, string } from '../schema.js';
+
+export interface ThreeDSData {
+  eCI?: string;
+  cAVV?: string;
+  xID?: string;
+  directoryServerTxnId?: string;
+  threeDSVersion?: string;
+  transactionId?: string;
+}
+
+export const threeDSDataSchema: Schema<ThreeDSData> = object({
+  eCI: ['ECI', optional(string())],
+  cAVV: ['CAVV', optional(string())],
+  xID: ['XID', optional(string())],
+  directoryServerTxnId: ['DirectoryServerTxnId', optional(string())],
+  threeDSVersion: ['ThreeDSVersion', optional(string())],
+  transactionId: ['TransactionId', optional(string())],
+});

package/src/models/threeDsRedirectDataV3.ts

@@ -0,0 +1,23 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { dict, object, optional, Schema, string } from '../schema.js';
+
+export interface ThreeDsRedirectDataV3 {
+  url?: string;
+  verb?: string;
+  params?: Record<string, string>;
+  clientRedirectUrl?: string;
+}
+
+export const threeDsRedirectDataV3Schema: Schema<ThreeDsRedirectDataV3> = object(
+  {
+    url: ['Url', optional(string())],
+    verb: ['Verb', optional(string())],
+    params: ['Params', optional(dict(string()))],
+    clientRedirectUrl: ['ClientRedirectUrl', optional(string())],
+  }
+);

package/src/models/uxSettingsModel.ts

@@ -0,0 +1,18 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { array, number, object, optional, Schema } from '../schema.js';
+
+export interface UxSettingsModel {
+  displayedInstallmentOptions?: number[];
+}
+
+export const uxSettingsModelSchema: Schema<UxSettingsModel> = object({
+  displayedInstallmentOptions: [
+    'DisplayedInstallmentOptions',
+    optional(array(number())),
+  ],
+});

package/src/models/verifyAuthorizationResponse.ts

@@ -0,0 +1,28 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { boolean, lazy, number, object, optional, Schema } from '../schema.js';
+import {
+  AuthorizationModel,
+  authorizationModelSchema,
+} from './authorizationModel.js';
+
+export interface VerifyAuthorizationResponse {
+  isAuthorized: boolean;
+  authorizationAmount?: number;
+  authorization?: AuthorizationModel;
+}
+
+export const verifyAuthorizationResponseSchema: Schema<VerifyAuthorizationResponse> = object(
+  {
+    isAuthorized: ['IsAuthorized', boolean()],
+    authorizationAmount: ['AuthorizationAmount', optional(number())],
+    authorization: [
+      'Authorization',
+      optional(lazy(() => authorizationModelSchema)),
+    ],
+  }
+);

package/src/oAuth2ProductionManager.ts

@@ -0,0 +1,85 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { isExpired, isValid } from './authentication.js';
+import { OAuthToken } from './models/oAuthToken.js';
+import { ClientInterface } from './clientInterface.js';
+import { OAuthAuthorizationController } from './controllers/oAuthAuthorizationController.js';
+import { OAuthScopeOAuth2ProductionEnum } from './models/oAuthScopeOAuth2ProductionEnum.js';
+
+export class OAuth2ProductionManager {
+  private _oAuthClientId: string;
+  private _oAuthClientSecret: string;
+  private _oAuthScopes?: OAuthScopeOAuth2ProductionEnum[];
+  private _oAuthClockSkew?: number;
+  private _oAuthController: OAuthAuthorizationController;
+
+  constructor(
+    {
+      oAuthClientId,
+      oAuthClientSecret,
+      oAuthScopes,
+      oAuthClockSkew,
+    }: {
+      oAuthClientId: string;
+      oAuthClientSecret: string;
+      oAuthScopes?: OAuthScopeOAuth2ProductionEnum[];
+      oAuthClockSkew?: number;
+    },
+    client: ClientInterface
+  ) {
+    this._oAuthClientId = oAuthClientId;
+    this._oAuthClientSecret = oAuthClientSecret;
+    this._oAuthScopes = oAuthScopes;
+    this._oAuthClockSkew = oAuthClockSkew;
+    this._oAuthController = new OAuthAuthorizationController(client);
+  }
+
+  public async updateToken(oAuthToken?: OAuthToken): Promise<OAuthToken> {
+    if (!this.isValid(oAuthToken) || this.isExpired(oAuthToken)) {
+      oAuthToken = await this.fetchToken();
+    }
+    return oAuthToken;
+  }
+
+  public isValid(oAuthToken: OAuthToken | undefined): oAuthToken is OAuthToken {
+    return isValid(oAuthToken);
+  }
+
+  public isExpired(oAuthToken: OAuthToken) {
+    return isExpired(oAuthToken, this._oAuthClockSkew);
+  }
+
+  public async fetchToken(
+    additionalParams?: Record<string, unknown>
+  ): Promise<OAuthToken> {
+    const authorization = this.getClientBasicAuth(
+      this._oAuthClientId,
+      this._oAuthClientSecret
+    );
+    const { result } = await this._oAuthController.requestTokenOAuth2Production(
+      authorization,
+      this._oAuthScopes?.join(' '),
+      additionalParams
+    );
+    return this.setExpiry(result);
+  }
+
+  private getClientBasicAuth(clientId: string, clientSecret: string): string {
+    return `Basic ${Buffer.from(clientId + ':' + clientSecret).toString(
+      'base64'
+    )}`;
+  }
+
+  private async setExpiry(token: OAuthToken) {
+    const newToken = token;
+    if (newToken.expiresIn) {
+      newToken.expiry =
+        BigInt(Math.round(Date.now() / 1000)) + newToken.expiresIn;
+    }
+    return newToken;
+  }
+}