npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

splitit-web-typescript-sdk

v4.0.9

Published

Client for splitit-web-api-v3

Downloads

383

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

konfig-publisherkonfig-publisher

Keywords

axiostypescriptkonfigsplitit-web-typescript-sdk

Readme

splitit-web-typescript-sdk

Splitit's Web API

npm

Table of Contents

Installation

npm i splitit-web-typescript-sdk
pnpm i splitit-web-typescript-sdk
yarn add splitit-web-typescript-sdk

Getting Started

import { Splitit } from "splitit-web-typescript-sdk";

const splitit = new Splitit({
  // Defining the base path is optional and defaults to https://web-api-v3.production.splitit.com
  // basePath: "https://web-api-v3.production.splitit.com",
  oauthClientId: "CLIENT_ID",
  oauthClientSecret: "CLIENT_SECRET",
});

const checkEligibilityResponse = await splitit.installmentplan.checkEligibility(
  {
    xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
    xSplititTouchPoint: "",
  }
);

console.log(checkEligibilityResponse);

Reference

splitit.installmentplan.checkEligibility

🛠️ Usage

const checkEligibilityResponse = await splitit.installmentplan.checkEligibility(
  {
    xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
    xSplititTouchPoint: "",
  }
);

⚙️ Parameters

xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

PlanData: PlanData
CardDetails: CardData
BillingAddress: AddressData
ShopperIdentifier: string

🔄 Return

InstallmentsEligibilityResponse

🌐 Endpoint

/api/installmentplans/check-eligibility POST

🔙 Back to Table of Contents

splitit.installmentplan.get

🛠️ Usage

const getResponse = await splitit.installmentplan.get({
  installmentPlanNumber: "installmentPlanNumber_example",
  xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
  xSplititTouchPoint: "",
});

⚙️ Parameters

installmentPlanNumber: string
xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

🔄 Return

InstallmentPlanGetResponse

🌐 Endpoint

/api/installmentplans/{installmentPlanNumber} GET

🔙 Back to Table of Contents

splitit.installmentplan.getEligibilityTermsAndCondition

🛠️ Usage

const getEligibilityTermsAndConditionResponse =
  await splitit.installmentplan.getEligibilityTermsAndCondition({
    ipn: "ipn_example",
    xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
    xSplititTouchPoint: "",
  });

⚙️ Parameters

ipn: string
xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

🔄 Return

EligibilityTermsAndConditionResponse

🌐 Endpoint

/api/installmentplans/{ipn}/legal GET

🔙 Back to Table of Contents

splitit.installmentplan.post

🛠️ Usage

const postResponse = await splitit.installmentplan.post({
  xSplititTestMode: "None",
  xSplititStrategy: "SecuredPlan",
  xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
  xSplititTouchPoint: "",
});

⚙️ Parameters

xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

AutoCapture: boolean
Attempt3dSecure: boolean
Shopper: ShopperData
PlanData: PlanDataModel
BillingAddress: AddressDataModel
RedirectUrls: InitiateRedirectionEndpointsModel
UxSettings: UxSettingsModel
EventsEndpoints: EventsEndpointsModel
ProcessingData: ProcessingData
xSplititTestMode: 'None' | 'Regular' | 'Fast' | 'Automation'
xSplititStrategy: 'SecuredPlan' | 'NonSecuredPlan' | 'SecuredPlanCaptureExistingSecurityAuth' | 'SecuredPlan3' | 'SinglePayment' | 'ExternalInstallmentProvider' | 'SecuredPlan3A' | 'SecuredPlan3B' | 'SecuredPlan2A' | 'SecuredPlan2' | 'SecuredPlan4' | 'SecuredPlan4A'
splititclientinfo: string

🔄 Return

InitiatePlanResponse

🌐 Endpoint

/api/installmentplans/initiate POST

🔙 Back to Table of Contents

splitit.installmentplan.post2

🛠️ Usage

const post2Response = await splitit.installmentplan.post2({
  xSplititTestMode: "None",
  xSplititStrategy: "SecuredPlan",
  xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
  xSplititTouchPoint: "",
  AutoCapture: true,
  TermsAndConditionsAccepted: true,
});

⚙️ Parameters

AutoCapture: boolean
TermsAndConditionsAccepted: boolean
xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

Attempt3dSecure: boolean
Shopper: ShopperData
PlanData: PlanDataModel
BillingAddress: AddressDataModel
PaymentMethod: PaymentMethodModel
RedirectUrls: RedirectionEndpointsModel
ProcessingData: ProcessingData
EventsEndpoints: EventsEndpointsModel
xSplititTestMode: 'None' | 'Regular' | 'Fast' | 'Automation'
xSplititStrategy: 'SecuredPlan' | 'NonSecuredPlan' | 'SecuredPlanCaptureExistingSecurityAuth' | 'SecuredPlan3' | 'SinglePayment' | 'ExternalInstallmentProvider' | 'SecuredPlan3A' | 'SecuredPlan3B' | 'SecuredPlan2A' | 'SecuredPlan2' | 'SecuredPlan4' | 'SecuredPlan4A'
splititclientinfo: string

🔄 Return

InstallmentPlanCreateResponse

🌐 Endpoint

/api/installmentplans POST

🔙 Back to Table of Contents

splitit.installmentplan.refund

🛠️ Usage

const refundResponse = await splitit.installmentplan.refund({
  installmentPlanNumber: "installmentPlanNumber_example",
  xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
  xSplititTouchPoint: "",
  Amount: 3.14,
  RefundStrategy: "FutureInstallmentsFirst",
});

⚙️ Parameters

Amount: number
installmentPlanNumber: string
xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

RefundStrategy: RefundStrategy
ReferenceId: string

🔄 Return

InstallmentPlanRefundResponse

🌐 Endpoint

/api/installmentplans/{installmentPlanNumber}/refund POST

🔙 Back to Table of Contents

splitit.installmentplan.search

🛠️ Usage

const searchResponse = await splitit.installmentplan.search({
  xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
  xSplititTouchPoint: "",
});

⚙️ Parameters

xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

installmentPlanNumber: string
refOrderNumber: string
extendedParams: Record<string, string>

🔄 Return

InstallmentPlanSearchResponse

🌐 Endpoint

/api/installmentplans/search GET

🔙 Back to Table of Contents

splitit.installmentplan.updateOrder

🛠️ Usage

const updateOrderResponse = await splitit.installmentplan.updateOrder({
  installmentPlanNumber: "installmentPlanNumber_example",
  xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
  xSplititTouchPoint: "",
  ShippingStatus: "Pending",
});

⚙️ Parameters

installmentPlanNumber: string
xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

RefOrderNumber: string
TrackingNumber: string
Capture: boolean
ShippingStatus: ShippingStatus
NewAmount: number

🔄 Return

InstallmentPlanUpdateResponse

🌐 Endpoint

/api/installmentplans/{installmentPlanNumber}/updateorder PUT

🔙 Back to Table of Contents

splitit.installmentplan.updateOrder2

🛠️ Usage

const updateOrder2Response = await splitit.installmentplan.updateOrder2({
  xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
  xSplititTouchPoint: "",
  ShippingStatus: "Pending",
});

⚙️ Parameters

xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

RefOrderNumber: string
TrackingNumber: string
Capture: boolean
ShippingStatus: ShippingStatus
NewAmount: number
Identifier: IdentifierContract

🔄 Return

InstallmentPlanUpdateResponse

🌐 Endpoint

/api/installmentplans/updateorder PUT

🔙 Back to Table of Contents

splitit.installmentplan.verifyAuthorization

🛠️ Usage

const verifyAuthorizationResponse =
  await splitit.installmentplan.verifyAuthorization({
    installmentPlanNumber: "installmentPlanNumber_example",
    xSplititIdempotencyKey: "xSplititIdempotencyKey_example",
    xSplititTouchPoint: "",
  });

⚙️ Parameters

installmentPlanNumber: string
xSplititIdempotencyKey: string
xSplititTouchPoint: string

TouchPoint

🔄 Return

VerifyAuthorizationResponse

🌐 Endpoint

/api/installmentplans/{installmentPlanNumber}/verifyauthorization GET

🔙 Back to Table of Contents

Author

This TypeScript package is automatically generated by Konfig