splitit-payments-sdk 1.0.7 → 2.0.11

package/src/models/installmentItem.ts

@@ -0,0 +1,28 @@
+/**
+ * splitit-web-api-v4Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { lazy, number, object, optional, Schema, string } from '../schema.js';
+import { AmountData, amountDataSchema } from './amountData.js';
+import {
+  InstallmentStatusEnum,
+  installmentStatusEnumSchema,
+} from './installmentStatusEnum.js';
+
+export interface InstallmentItem {
+  installmentNumber: number;
+  amount?: AmountData;
+  status: InstallmentStatusEnum;
+  processDateTime?: string;
+}
+
+export const installmentItemSchema: Schema<InstallmentItem> = lazy(() =>
+  object({
+    installmentNumber: ['InstallmentNumber', number()],
+    amount: ['Amount', optional(amountDataSchema)],
+    status: ['Status', installmentStatusEnumSchema],
+    processDateTime: ['ProcessDateTime', optional(string())],
+  })
+);

package/src/models/installmentPlanDetailsResponse.ts

@@ -0,0 +1,92 @@
+/**
+ * splitit-web-api-v4Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  array,
+  lazy,
+  number,
+  object,
+  optional,
+  Schema,
+  string,
+} from '../schema.js';
+import { AprData, aprDataSchema } from './aprData.js';
+import {
+  ExternalProviderTypesEnum,
+  externalProviderTypesEnumSchema,
+} from './externalProviderTypesEnum.js';
+import { InstallmentItem, installmentItemSchema } from './installmentItem.js';
+import {
+  InstallmentPlanStatusEnum,
+  installmentPlanStatusEnumSchema,
+} from './installmentPlanStatusEnum.js';
+import { MetadataItem, metadataItemSchema } from './metadataItem.js';
+import {
+  PaymentMethodData,
+  paymentMethodDataSchema,
+} from './paymentMethodData.js';
+import {
+  PlanAuthorizationData,
+  planAuthorizationDataSchema,
+} from './planAuthorizationData.js';
+import { PlanLinksData, planLinksDataSchema } from './planLinksData.js';
+import {
+  PurchaseMethodEnum,
+  purchaseMethodEnumSchema,
+} from './purchaseMethodEnum.js';
+import { RefundItem, refundItemSchema } from './refundItem.js';
+import {
+  ShopperDetailsData,
+  shopperDetailsDataSchema,
+} from './shopperDetailsData.js';
+
+export interface InstallmentPlanDetailsResponse {
+  dateCreated: string;
+  status: InstallmentPlanStatusEnum;
+  installmentPlanNumber?: string;
+  merchantOrderReference?: string;
+  installmentProvider: ExternalProviderTypesEnum;
+  purchaseMethod: PurchaseMethodEnum;
+  currency?: string;
+  purchaseAmount: number;
+  totalAmount: number;
+  totalFees: number;
+  apr?: AprData;
+  authorization?: PlanAuthorizationData;
+  shopperDetails?: ShopperDetailsData;
+  paymentMethod?: PaymentMethodData;
+  installments?: InstallmentItem[];
+  refunds?: RefundItem[];
+  links?: PlanLinksData[];
+  metadata?: MetadataItem[];
+}
+
+export const installmentPlanDetailsResponseSchema: Schema<InstallmentPlanDetailsResponse> = lazy(
+  () =>
+    object({
+      dateCreated: ['DateCreated', string()],
+      status: ['Status', installmentPlanStatusEnumSchema],
+      installmentPlanNumber: ['InstallmentPlanNumber', optional(string())],
+      merchantOrderReference: ['MerchantOrderReference', optional(string())],
+      installmentProvider: [
+        'InstallmentProvider',
+        externalProviderTypesEnumSchema,
+      ],
+      purchaseMethod: ['PurchaseMethod', purchaseMethodEnumSchema],
+      currency: ['Currency', optional(string())],
+      purchaseAmount: ['PurchaseAmount', number()],
+      totalAmount: ['TotalAmount', number()],
+      totalFees: ['TotalFees', number()],
+      apr: ['Apr', optional(aprDataSchema)],
+      authorization: ['Authorization', optional(planAuthorizationDataSchema)],
+      shopperDetails: ['ShopperDetails', optional(shopperDetailsDataSchema)],
+      paymentMethod: ['PaymentMethod', optional(paymentMethodDataSchema)],
+      installments: ['Installments', optional(array(installmentItemSchema))],
+      refunds: ['Refunds', optional(array(refundItemSchema))],
+      links: ['Links', optional(array(planLinksDataSchema))],
+      metadata: ['Metadata', optional(array(metadataItemSchema))],
+    })
+);

package/src/models/installmentPlanSearchDetailsResponse.ts

@@ -0,0 +1,25 @@
+/**
+ * splitit-web-api-v4Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { array, lazy, object, optional, Schema } from '../schema.js';
+import {
+  InstallmentPlanDetailsResponse,
+  installmentPlanDetailsResponseSchema,
+} from './installmentPlanDetailsResponse.js';
+
+export interface InstallmentPlanSearchDetailsResponse {
+  planList?: InstallmentPlanDetailsResponse[];
+}
+
+export const installmentPlanSearchDetailsResponseSchema: Schema<InstallmentPlanSearchDetailsResponse> = lazy(
+  () =>
+    object({
+      planList: [
+        'PlanList',
+        optional(array(installmentPlanDetailsResponseSchema)),
+      ],
+    })
+);

package/src/models/installmentPlanSearchRequest.ts

@@ -0,0 +1,25 @@
+/**
+ * splitit-web-api-v4Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { array, object, optional, Schema, string } from '../schema.js';
+
+export interface InstallmentPlanSearchRequest {
+  installmentPlanNumbers?: string[];
+  merchantOrderReferenceIds?: string[];
+}
+
+export const installmentPlanSearchRequestSchema: Schema<InstallmentPlanSearchRequest> = object(
+  {
+    installmentPlanNumbers: [
+      'InstallmentPlanNumbers',
+      optional(array(string())),
+    ],
+    merchantOrderReferenceIds: [
+      'MerchantOrderReferenceIds',
+      optional(array(string())),
+    ],
+  }
+);

package/src/models/installmentPlanStatusEnum.ts

@@ -0,0 +1,31 @@
+/**
+ * splitit-web-api-v4Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for InstallmentPlanStatusEnum
+ */
+export enum InstallmentPlanStatusEnum {
+  None = 'None',
+  PendingApproval = 'PendingApproval',
+  PendingMerchantShipmentNotice = 'PendingMerchantShipmentNotice',
+  InProgress = 'InProgress',
+  Deleted = 'Deleted',
+  Cleared = 'Cleared',
+  PendingPaymentUpdate = 'PendingPaymentUpdate',
+  Canceled = 'Canceled',
+  Delayed = 'Delayed',
+  Initializing = 'Initializing',
+  AllStatuses = 'AllStatuses',
+}
+
+/**
+ * Schema for InstallmentPlanStatusEnum
+ */
+export const installmentPlanStatusEnumSchema: Schema<InstallmentPlanStatusEnum> = stringEnum(
+  InstallmentPlanStatusEnum
+);

package/src/models/installmentStatusEnum.ts

@@ -1,5 +1,5 @@
 /**
- * splitit-web-api-v3Lib
+ * splitit-web-api-v4Lib
  *
  * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
  */
@@ -10,9 +10,14 @@ import { Schema, stringEnum } from '../schema.js';
  * Enum for InstallmentStatusEnum
  */
 export enum InstallmentStatusEnum {
-  Pending = 'Pending',
-  Processed = 'Processed',
+  None = 'None',
+  WaitingForProcessDate = 'WaitingForProcessDate',
+  Finished = 'Finished',
+  Deleted = 'Deleted',
+  Stopped = 'Stopped',
   Canceled = 'Canceled',
+  AwaitingCapture = 'AwaitingCapture',
+  AwaitingVoid = 'AwaitingVoid',
 }
 
 /**

package/src/models/maskedCardDetails.ts

@@ -0,0 +1,19 @@
+/**
+ * splitit-web-api-v4Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { object, optional, Schema, string } from '../schema.js';
+
+export interface MaskedCardDetails {
+  last4Digits?: string;
+  bIN?: string;
+  issuerName?: string;
+}
+
+export const maskedCardDetailsSchema: Schema<MaskedCardDetails> = object({
+  last4Digits: ['Last4Digits', optional(string())],
+  bIN: ['BIN', optional(string())],
+  issuerName: ['IssuerName', optional(string())],
+});

package/src/models/metadataItem.ts

@@ -0,0 +1,17 @@
+/**
+ * splitit-web-api-v4Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { object, optional, Schema, string } from '../schema.js';
+
+export interface MetadataItem {
+  key?: string;
+  value?: string;
+}
+
+export const metadataItemSchema: Schema<MetadataItem> = object({
+  key: ['Key', optional(string())],
+  value: ['Value', optional(string())],
+});

package/src/models/oAuthProviderErrorEnum.ts

@@ -1,5 +1,5 @@
 /**
- * splitit-web-api-v3Lib
+ * splitit-web-api-v4Lib
  *
  * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
  */

package/src/models/oAuthScopeOAuth2Enum.ts

@@ -0,0 +1,21 @@
+/**
+ * splitit-web-api-v4Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { Schema, stringEnum } from '../schema.js';
+
+/**
+ * Enum for OAuthScopeOAuth2Enum
+ */
+export enum OAuthScopeOAuth2Enum {
+  ApiV4 = 'api.v4',
+}
+
+/**
+ * Schema for OAuthScopeOAuth2Enum
+ */
+export const oAuthScopeOAuth2EnumSchema: Schema<OAuthScopeOAuth2Enum> = stringEnum(
+  OAuthScopeOAuth2Enum
+);

package/src/models/oAuthToken.ts

@@ -1,5 +1,5 @@
 /**
- * splitit-web-api-v3Lib
+ * splitit-web-api-v4Lib
  *
  * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
  */

package/src/models/offerItem.ts

@@ -0,0 +1,43 @@
+/**
+ * splitit-web-api-v4Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { lazy, number, object, optional, Schema, string } from '../schema.js';
+import { AmountData, amountDataSchema } from './amountData.js';
+import { AprData, aprDataSchema } from './aprData.js';
+import { InlineContent, inlineContentSchema } from './inlineContent.js';
+
+export interface OfferItem {
+  offerId?: string;
+  apr?: AprData;
+  currency?: string;
+  totalAmount: number;
+  totalFees: number;
+  numberOfInstallments: number;
+  frequency?: string;
+  installmentAmount: number;
+  firstInstallmentAmount: number;
+  lastInstallmentAmount?: AmountData;
+  inlineContent?: InlineContent;
+}
+
+export const offerItemSchema: Schema<OfferItem> = lazy(() =>
+  object({
+    offerId: ['OfferId', optional(string())],
+    apr: ['Apr', optional(aprDataSchema)],
+    currency: ['Currency', optional(string())],
+    totalAmount: ['TotalAmount', number()],
+    totalFees: ['TotalFees', number()],
+    numberOfInstallments: ['NumberOfInstallments', number()],
+    frequency: ['Frequency', optional(string())],
+    installmentAmount: ['InstallmentAmount', number()],
+    firstInstallmentAmount: ['FirstInstallmentAmount', number()],
+    lastInstallmentAmount: [
+      'LastInstallmentAmount',
+      optional(amountDataSchema),
+    ],
+    inlineContent: ['InlineContent', optional(inlineContentSchema)],
+  })
+);

package/src/models/offersBillingAddress.ts

@@ -0,0 +1,25 @@
+/**
+ * splitit-web-api-v4Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { object, optional, Schema, string } from '../schema.js';
+
+export interface OffersBillingAddress {
+  line1: string;
+  line2?: string;
+  city?: string;
+  state?: string;
+  postalCode: string;
+  country: string;
+}
+
+export const offersBillingAddressSchema: Schema<OffersBillingAddress> = object({
+  line1: ['Line1', string()],
+  line2: ['Line2', optional(string())],
+  city: ['City', optional(string())],
+  state: ['State', optional(string())],
+  postalCode: ['PostalCode', string()],
+  country: ['Country', string()],
+});

package/src/models/offersCardDetails.ts

@@ -0,0 +1,25 @@
+/**
+ * splitit-web-api-v4Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { number, object, optional, Schema, string } from '../schema.js';
+
+export interface OffersCardDetails {
+  firstName?: string;
+  lastName?: string;
+  cardNumber: string;
+  expMonth: number;
+  expYear: number;
+  cvv?: string;
+}
+
+export const offersCardDetailsSchema: Schema<OffersCardDetails> = object({
+  firstName: ['FirstName', optional(string())],
+  lastName: ['LastName', optional(string())],
+  cardNumber: ['CardNumber', string()],
+  expMonth: ['ExpMonth', number()],
+  expYear: ['ExpYear', number()],
+  cvv: ['Cvv', optional(string())],
+});

package/src/models/offersMerchantDetails.ts

@@ -0,0 +1,26 @@
+/**
+ * splitit-web-api-v4Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { lazy, object, optional, Schema, string } from '../schema.js';
+import {
+  OffersStoreLocation,
+  offersStoreLocationSchema,
+} from './offersStoreLocation.js';
+
+export interface OffersMerchantDetails {
+  storeName?: string;
+  storeId?: string;
+  storeLocation: OffersStoreLocation;
+}
+
+export const offersMerchantDetailsSchema: Schema<OffersMerchantDetails> = lazy(
+  () =>
+    object({
+      storeName: ['StoreName', optional(string())],
+      storeId: ['StoreId', optional(string())],
+      storeLocation: ['StoreLocation', offersStoreLocationSchema],
+    })
+);

package/src/models/offersPaymentMethod.ts

@@ -0,0 +1,23 @@
+/**
+ * splitit-web-api-v4Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { lazy, object, Schema, string } from '../schema.js';
+import {
+  OffersCardDetails,
+  offersCardDetailsSchema,
+} from './offersCardDetails.js';
+
+export interface OffersPaymentMethod {
+  type: string;
+  cardDetails: OffersCardDetails;
+}
+
+export const offersPaymentMethodSchema: Schema<OffersPaymentMethod> = lazy(() =>
+  object({
+    type: ['Type', string()],
+    cardDetails: ['CardDetails', offersCardDetailsSchema],
+  })
+);

package/src/models/offersPaymentMethodResponse.ts

@@ -0,0 +1,23 @@
+/**
+ * splitit-web-api-v4Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { object, optional, Schema, string } from '../schema.js';
+
+export interface OffersPaymentMethodResponse {
+  last4Digits?: string;
+  bIN?: string;
+  issuerName?: string;
+  type: string;
+}
+
+export const offersPaymentMethodResponseSchema: Schema<OffersPaymentMethodResponse> = object(
+  {
+    last4Digits: ['Last4Digits', optional(string())],
+    bIN: ['BIN', optional(string())],
+    issuerName: ['IssuerName', optional(string())],
+    type: ['Type', string()],
+  }
+);

package/src/models/offersRequest.ts

@@ -0,0 +1,48 @@
+/**
+ * splitit-web-api-v4Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { array, lazy, object, optional, Schema, string } from '../schema.js';
+import { MetadataItem, metadataItemSchema } from './metadataItem.js';
+import {
+  OffersMerchantDetails,
+  offersMerchantDetailsSchema,
+} from './offersMerchantDetails.js';
+import {
+  OffersPaymentMethod,
+  offersPaymentMethodSchema,
+} from './offersPaymentMethod.js';
+import {
+  OffersShopperDetails,
+  offersShopperDetailsSchema,
+} from './offersShopperDetails.js';
+import {
+  PurchaseMethodEnum,
+  purchaseMethodEnumSchema,
+} from './purchaseMethodEnum.js';
+
+export interface OffersRequest {
+  merchantOrderReference?: string;
+  purchaseMethod: PurchaseMethodEnum;
+  purchaseAmount: string;
+  currency: string;
+  shopperDetails: OffersShopperDetails;
+  paymentMethod: OffersPaymentMethod;
+  merchantDetails?: OffersMerchantDetails;
+  metadata?: MetadataItem[];
+}
+
+export const offersRequestSchema: Schema<OffersRequest> = lazy(() =>
+  object({
+    merchantOrderReference: ['MerchantOrderReference', optional(string())],
+    purchaseMethod: ['PurchaseMethod', purchaseMethodEnumSchema],
+    purchaseAmount: ['PurchaseAmount', string()],
+    currency: ['Currency', string()],
+    shopperDetails: ['ShopperDetails', offersShopperDetailsSchema],
+    paymentMethod: ['PaymentMethod', offersPaymentMethodSchema],
+    merchantDetails: ['MerchantDetails', optional(offersMerchantDetailsSchema)],
+    metadata: ['Metadata', optional(array(metadataItemSchema))],
+  })
+);

package/src/models/offersResponse.ts

@@ -0,0 +1,51 @@
+/**
+ * splitit-web-api-v4Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  array,
+  lazy,
+  number,
+  object,
+  optional,
+  Schema,
+  string,
+} from '../schema.js';
+import { OfferItem, offerItemSchema } from './offerItem.js';
+import {
+  OffersPaymentMethodResponse,
+  offersPaymentMethodResponseSchema,
+} from './offersPaymentMethodResponse.js';
+import {
+  PurchaseMethodEnum,
+  purchaseMethodEnumSchema,
+} from './purchaseMethodEnum.js';
+
+export interface OffersResponse {
+  installmentPlanNumber?: string;
+  merchantOrderReference?: string;
+  purchaseMethod: PurchaseMethodEnum;
+  purchaseAmount: number;
+  currency?: string;
+  paymentMethod?: OffersPaymentMethodResponse;
+  offers?: OfferItem[];
+  validUntil?: string;
+}
+
+export const offersResponseSchema: Schema<OffersResponse> = lazy(() =>
+  object({
+    installmentPlanNumber: ['InstallmentPlanNumber', optional(string())],
+    merchantOrderReference: ['MerchantOrderReference', optional(string())],
+    purchaseMethod: ['PurchaseMethod', purchaseMethodEnumSchema],
+    purchaseAmount: ['PurchaseAmount', number()],
+    currency: ['Currency', optional(string())],
+    paymentMethod: [
+      'PaymentMethod',
+      optional(offersPaymentMethodResponseSchema),
+    ],
+    offers: ['Offers', optional(array(offerItemSchema))],
+    validUntil: ['ValidUntil', optional(string())],
+  })
+);

package/src/models/offersShopperDetails.ts

@@ -0,0 +1,32 @@
+/**
+ * splitit-web-api-v4Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { lazy, object, optional, Schema, string } from '../schema.js';
+import {
+  OffersBillingAddress,
+  offersBillingAddressSchema,
+} from './offersBillingAddress.js';
+
+export interface OffersShopperDetails {
+  firstName?: string;
+  lastName: string;
+  email: string;
+  phoneNumber?: string;
+  shopperLocale?: string;
+  billingAddress?: OffersBillingAddress;
+}
+
+export const offersShopperDetailsSchema: Schema<OffersShopperDetails> = lazy(
+  () =>
+    object({
+      firstName: ['FirstName', optional(string())],
+      lastName: ['LastName', string()],
+      email: ['Email', string()],
+      phoneNumber: ['PhoneNumber', optional(string())],
+      shopperLocale: ['ShopperLocale', optional(string())],
+      billingAddress: ['BillingAddress', optional(offersBillingAddressSchema)],
+    })
+);

package/src/models/offersStoreLocation.ts

@@ -0,0 +1,25 @@
+/**
+ * splitit-web-api-v4Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { object, optional, Schema, string } from '../schema.js';
+
+export interface OffersStoreLocation {
+  line1: string;
+  line2?: string;
+  city?: string;
+  state?: string;
+  postalCode: string;
+  country: string;
+}
+
+export const offersStoreLocationSchema: Schema<OffersStoreLocation> = object({
+  line1: ['Line1', string()],
+  line2: ['Line2', optional(string())],
+  city: ['City', optional(string())],
+  state: ['State', optional(string())],
+  postalCode: ['PostalCode', string()],
+  country: ['Country', string()],
+});