splitit-payments-sdk 1.0.5

package/dist/types/oAuth2SandboxManager.d.ts

@@ -0,0 +1,28 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+import { OAuthToken } from './models/oAuthToken.js';
+import { ClientInterface } from './clientInterface.js';
+import { OAuthScopeOAuth2SandboxEnum } from './models/oAuthScopeOAuth2SandboxEnum.js';
+export declare class OAuth2SandboxManager {
+    private _oAuthClientId;
+    private _oAuthClientSecret;
+    private _oAuthScopes?;
+    private _oAuthClockSkew?;
+    private _oAuthController;
+    constructor({ oAuthClientId, oAuthClientSecret, oAuthScopes, oAuthClockSkew, }: {
+        oAuthClientId: string;
+        oAuthClientSecret: string;
+        oAuthScopes?: OAuthScopeOAuth2SandboxEnum[];
+        oAuthClockSkew?: number;
+    }, client: ClientInterface);
+    updateToken(oAuthToken?: OAuthToken): Promise<OAuthToken>;
+    isValid(oAuthToken: OAuthToken | undefined): oAuthToken is OAuthToken;
+    isExpired(oAuthToken: OAuthToken): boolean;
+    fetchToken(additionalParams?: Record<string, unknown>): Promise<OAuthToken>;
+    private getClientBasicAuth;
+    private setExpiry;
+}
+//# sourceMappingURL=oAuth2SandboxManager.d.ts.map

package/dist/types/oAuth2SandboxManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"oAuth2SandboxManager.d.ts","sourceRoot":"","sources":["../../src/oAuth2SandboxManager.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AAEtF,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,YAAY,CAAC,CAAgC;IACrD,OAAO,CAAC,eAAe,CAAC,CAAS;IACjC,OAAO,CAAC,gBAAgB,CAA+B;gBAGrD,EACE,aAAa,EACb,iBAAiB,EACjB,WAAW,EACX,cAAc,GACf,EAAE;QACD,aAAa,EAAE,MAAM,CAAC;QACtB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,WAAW,CAAC,EAAE,2BAA2B,EAAE,CAAC;QAC5C,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB,EACD,MAAM,EAAE,eAAe;IASZ,WAAW,CAAC,UAAU,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IAO/D,OAAO,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS,GAAG,UAAU,IAAI,UAAU;IAIrE,SAAS,CAAC,UAAU,EAAE,UAAU;IAI1B,UAAU,CACrB,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACzC,OAAO,CAAC,UAAU,CAAC;IAatB,OAAO,CAAC,kBAAkB;YAMZ,SAAS;CAQxB"}

package/dist/types/schema.d.ts

@@ -0,0 +1,7 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+export * from '@apimatic/schema';
+//# sourceMappingURL=schema.d.ts.map

package/dist/types/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/schema.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,kBAAkB,CAAC"}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "version": "1.0.5",
+  "license": "MIT",
+  "sideEffects": false,
+  "main": "dist/cjs/index.js",
+  "typings": "dist/types/index.d.ts",
+  "module": "dist/esm/index.js",
+  "files": [
+    "dist",
+    "src",
+    "test"
+  ],
+  "engines": {
+    "node": ">=14.17.0"
+  },
+  "scripts": {
+    "build": "rimraf dist && tsc -p tsconfig.esm.json & tsc -p tsconfig.cjs.json",
+    "prepare": "rimraf dist && tsc -p tsconfig.esm.json & tsc -p tsconfig.cjs.json",
+    "test": "jest --passWithNoTests",
+    "test:coverage": "jest --coverage --passWithNoTests",
+    "lint": "eslint **/*.ts --ignore-path .eslintignore",
+    "lint:fix": "eslint **/*.ts --ignore-path .eslintignore --fix"
+  },
+  "peerDependencies": {},
+  "prettier": {
+    "printWidth": 80,
+    "semi": true,
+    "singleQuote": true,
+    "trailingComma": "es5",
+    "quoteProps": "preserve"
+  },
+  "name": "splitit-payments-sdk",
+  "description": "Splitit's Installments API is the primary Splitit tool for establishing and maintaining installment plans. Use it to verify shopper eligibility, create plans with or without immediate authorization, get plan information, update plan status, and process refunds and cancellations.",
+  "author": {
+    "name": "Splitit Dev",
+    "email": "support@splitit.com"
+  },
+  "devDependencies": {
+    "@apimatic/test-utilities": "^0.1.1",
+    "@types/jest": "^29.4.0",
+    "@typescript-eslint/eslint-plugin": "^5.52.0",
+    "@typescript-eslint/parser": "^5.52.0",
+    "eslint": "^8.34.0",
+    "jest": "^29.4.3",
+    "rimraf": "^3.0.2",
+    "ts-jest": "29.2.6",
+    "tslib": "^2.5.0",
+    "typescript": "^5.2.0"
+  },
+  "dependencies": {
+    "@apimatic/authentication-adapters": "^0.5.13",
+    "@apimatic/axios-client-adapter": "^0.3.19",
+    "@apimatic/core": "^0.10.27",
+    "@apimatic/oauth-adapters": "^0.4.17",
+    "@apimatic/schema": "^0.7.21"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Splitit/TypeScript-SDK.git"
+  },
+  "bugs": {
+    "email": "support@apimatic.io"
+  },
+  "homepage": "https://splitit.com/",
+  "keywords": [
+    "splitit",
+    "sdk",
+    "api v3",
+    "payments",
+    "installments",
+    "bnpl"
+  ],
+  "contributors": []
+}

package/src/authProvider.ts

@@ -0,0 +1,97 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  compositeAuthenticationProvider,
+  OAuthConfiguration,
+  requestAuthenticationProvider,
+} from './authentication.js';
+import { Configuration } from './configuration.js';
+import { OAuthToken } from './models/oAuthToken.js';
+import { OAuth2ProductionManager } from './oAuth2ProductionManager.js';
+import { OAuth2SandboxManager } from './oAuth2SandboxManager.js';
+
+export function createAuthProviderFromConfig(
+  config: Partial<Configuration>,
+  oAuth2Sandbox: () => OAuth2SandboxManager | undefined,
+  oAuth2Production: () => OAuth2ProductionManager | undefined
+) {
+  const authConfig = {
+    oAuth2Sandbox:
+      config.oAuth2SandboxCredentials &&
+      requestAuthenticationProvider(
+        config.oAuth2SandboxCredentials.oAuthToken,
+        oAuth2SandboxTokenProvider(
+          oAuth2Sandbox,
+          config.oAuth2SandboxCredentials.oAuthTokenProvider
+        ),
+        config.oAuth2SandboxCredentials.oAuthOnTokenUpdate,
+        {
+          clockSkew: config.oAuth2SandboxCredentials.oAuthClockSkew,
+        } as OAuthConfiguration
+      ),
+    oAuth2Production:
+      config.oAuth2ProductionCredentials &&
+      requestAuthenticationProvider(
+        config.oAuth2ProductionCredentials.oAuthToken,
+        oAuth2ProductionTokenProvider(
+          oAuth2Production,
+          config.oAuth2ProductionCredentials.oAuthTokenProvider
+        ),
+        config.oAuth2ProductionCredentials.oAuthOnTokenUpdate,
+        {
+          clockSkew: config.oAuth2ProductionCredentials.oAuthClockSkew,
+        } as OAuthConfiguration
+      ),
+  };
+
+  return compositeAuthenticationProvider<
+    keyof typeof authConfig,
+    typeof authConfig
+  >(authConfig);
+}
+
+function oAuth2SandboxTokenProvider(
+  oAuth2Sandbox: () => OAuth2SandboxManager | undefined,
+  defaultProvider:
+    | ((
+        lastOAuthToken: OAuthToken | undefined,
+        authManager: OAuth2SandboxManager
+      ) => Promise<OAuthToken>)
+    | undefined
+): ((token: OAuthToken | undefined) => Promise<OAuthToken>) | undefined {
+  return (token: OAuthToken | undefined) => {
+    const manager = oAuth2Sandbox();
+    if (manager === undefined) {
+      throw Error('Unable to find the OAuthManager instance');
+    }
+    if (defaultProvider === undefined) {
+      return manager.updateToken(token);
+    }
+    return defaultProvider(token, manager);
+  };
+}
+
+function oAuth2ProductionTokenProvider(
+  oAuth2Production: () => OAuth2ProductionManager | undefined,
+  defaultProvider:
+    | ((
+        lastOAuthToken: OAuthToken | undefined,
+        authManager: OAuth2ProductionManager
+      ) => Promise<OAuthToken>)
+    | undefined
+): ((token: OAuthToken | undefined) => Promise<OAuthToken>) | undefined {
+  return (token: OAuthToken | undefined) => {
+    const manager = oAuth2Production();
+    if (manager === undefined) {
+      throw Error('Unable to find the OAuthManager instance');
+    }
+    if (defaultProvider === undefined) {
+      return manager.updateToken(token);
+    }
+    return defaultProvider(token, manager);
+  };
+}

package/src/authentication.ts

@@ -0,0 +1,8 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+export * from '@apimatic/oauth-adapters';
+export * from '@apimatic/authentication-adapters';

package/src/client.ts

@@ -0,0 +1,169 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { createAuthProviderFromConfig } from './authProvider.js';
+import { OAuth2ProductionManager } from './oAuth2ProductionManager.js';
+import { OAuth2SandboxManager } from './oAuth2SandboxManager.js';
+import {
+  AuthParams,
+  ClientInterface,
+  SdkRequestBuilder,
+  SdkRequestBuilderFactory,
+  Server,
+} from './clientInterface.js';
+import { Configuration, Environment } from './configuration.js';
+import {
+  DEFAULT_CONFIGURATION,
+  DEFAULT_RETRY_CONFIG,
+} from './defaultConfiguration.js';
+import { ApiError } from './core.js';
+import {
+  AbortError,
+  AuthenticatorInterface,
+  createRequestBuilderFactory,
+  HttpClientInterface,
+  RetryConfiguration,
+} from './core.js';
+import { HttpClient } from './clientAdapter.js';
+
+const USER_AGENT = 'APIMATIC 3.0';
+
+export class Client implements ClientInterface {
+  private _config: Readonly<Configuration>;
+  private _timeout: number;
+  private _retryConfig: RetryConfiguration;
+  private _requestBuilderFactory: SdkRequestBuilderFactory;
+  public oAuth2SandboxManager?: OAuth2SandboxManager;
+  public oAuth2ProductionManager?: OAuth2ProductionManager;
+
+  constructor(config?: Partial<Configuration>) {
+    this._config = {
+      ...DEFAULT_CONFIGURATION,
+      ...config,
+    };
+    this._retryConfig = {
+      ...DEFAULT_RETRY_CONFIG,
+      ...this._config.httpClientOptions?.retryConfig,
+    };
+    this._timeout =
+      typeof this._config.httpClientOptions?.timeout != 'undefined'
+        ? this._config.httpClientOptions.timeout
+        : this._config.timeout;
+    this._requestBuilderFactory = createRequestHandlerFactory(
+      (server) => getBaseUri(server, this._config),
+      createAuthProviderFromConfig(
+        this._config,
+        () => this.oAuth2SandboxManager,
+        () => this.oAuth2ProductionManager
+      ),
+      new HttpClient(AbortError, {
+        timeout: this._timeout,
+        clientConfigOverrides: this._config.unstable_httpClientOptions,
+        httpAgent: this._config.httpClientOptions?.httpAgent,
+        httpsAgent: this._config.httpClientOptions?.httpsAgent,
+        proxySettings: this._config.httpClientOptions?.proxySettings,
+      }),
+      [withErrorHandlers, withUserAgent, withAuthenticationByDefault],
+      this._retryConfig
+    );
+    if (this._config.oAuth2SandboxCredentials) {
+      this.oAuth2SandboxManager = new OAuth2SandboxManager(
+        this._config.oAuth2SandboxCredentials,
+        this
+      );
+    }
+    if (this._config.oAuth2ProductionCredentials) {
+      this.oAuth2ProductionManager = new OAuth2ProductionManager(
+        this._config.oAuth2ProductionCredentials,
+        this
+      );
+    }
+  }
+
+  public getRequestBuilderFactory(): SdkRequestBuilderFactory {
+    return this._requestBuilderFactory;
+  }
+
+  /**
+   * Clone this client and override given configuration options
+   */
+  public withConfiguration(config: Partial<Configuration>) {
+    return new Client({ ...this._config, ...config });
+  }
+}
+
+function createHttpClientAdapter(client: HttpClient): HttpClientInterface {
+  return async (request, requestOptions) => {
+    return await client.executeRequest(request, requestOptions);
+  };
+}
+
+function getBaseUri(server: Server = 'default', config: Configuration): string {
+  if (config.environment === Environment.Production) {
+    if (server === 'default') {
+      return 'https://web-api-v3.sandbox.splitit.com/';
+    }
+    if (server === 'access token server') {
+      return 'https://id.sandbox.splitit.com/connect';
+    }
+    if (server === 'access token server1') {
+      return 'https://id.splitit.com/connect';
+    }
+  }
+  if (config.environment === Environment.Environment2) {
+    if (server === 'default') {
+      return 'https://web-api-v3.splitit.com/';
+    }
+    if (server === 'access token server') {
+      return 'https://id.sandbox.splitit.com/connect';
+    }
+    if (server === 'access token server1') {
+      return 'https://id.splitit.com/connect';
+    }
+  }
+  throw new Error('Could not get Base URL. Invalid environment or server.');
+}
+
+function createRequestHandlerFactory(
+  baseUrlProvider: (server?: Server) => string,
+  authProvider: AuthenticatorInterface<AuthParams>,
+  httpClient: HttpClient,
+  addons: ((rb: SdkRequestBuilder) => void)[],
+  retryConfig: RetryConfiguration
+): SdkRequestBuilderFactory {
+  const requestBuilderFactory = createRequestBuilderFactory(
+    createHttpClientAdapter(httpClient),
+    baseUrlProvider,
+    ApiError,
+    authProvider,
+    retryConfig
+  );
+
+  return tap(requestBuilderFactory, ...addons);
+}
+
+function tap(
+  requestBuilderFactory: SdkRequestBuilderFactory,
+  ...callback: ((requestBuilder: SdkRequestBuilder) => void)[]
+): SdkRequestBuilderFactory {
+  return (...args) => {
+    const requestBuilder = requestBuilderFactory(...args);
+    callback.forEach((c) => c(requestBuilder));
+    return requestBuilder;
+  };
+}
+
+function withErrorHandlers(rb: SdkRequestBuilder) {
+  rb.defaultToError(ApiError);
+}
+
+function withUserAgent(rb: SdkRequestBuilder) {
+  rb.header('user-agent', USER_AGENT);
+}
+
+function withAuthenticationByDefault(rb: SdkRequestBuilder) {
+  rb.authenticate([{ oAuth2Sandbox: true }, { oAuth2Production: true }]);
+}

package/src/clientAdapter.ts

@@ -0,0 +1,7 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+export * from '@apimatic/axios-client-adapter';

package/src/clientInterface.ts

@@ -0,0 +1,27 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { createAuthProviderFromConfig } from './authProvider.js';
+import { AuthenticatorInterface, RequestBuilderFactory } from './core.js';
+
+export interface ClientInterface {
+  getRequestBuilderFactory(): SdkRequestBuilderFactory;
+}
+
+export type SdkRequestBuilderFactory = RequestBuilderFactory<
+  Server,
+  AuthParams
+>;
+
+export type SdkRequestBuilder = ReturnType<SdkRequestBuilderFactory>;
+
+export type Server = 'default' | 'access token server' | 'access token server1';
+
+export type AuthParams = ReturnType<
+  typeof createAuthProviderFromConfig
+> extends AuthenticatorInterface<infer X>
+  ? X
+  : never;

package/src/configuration.ts

@@ -0,0 +1,50 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import { HttpClientOptions } from './clientAdapter.js';
+import { OAuthScopeOAuth2ProductionEnum } from './models/oAuthScopeOAuth2ProductionEnum.js';
+import { OAuthScopeOAuth2SandboxEnum } from './models/oAuthScopeOAuth2SandboxEnum.js';
+import { OAuthToken } from './models/oAuthToken.js';
+import { OAuth2ProductionManager } from './oAuth2ProductionManager.js';
+import { OAuth2SandboxManager } from './oAuth2SandboxManager.js';
+
+/** An interface for all configuration parameters required by the SDK. */
+export interface Configuration {
+  timeout: number;
+  environment: Environment;
+  oAuth2SandboxCredentials?: {
+    oAuthClientId: string;
+    oAuthClientSecret: string;
+    oAuthToken?: OAuthToken;
+    oAuthScopes?: OAuthScopeOAuth2SandboxEnum[];
+    oAuthTokenProvider?: (
+      lastOAuthToken: OAuthToken | undefined,
+      authManager: OAuth2SandboxManager
+    ) => Promise<OAuthToken>;
+    oAuthOnTokenUpdate?: (token: OAuthToken) => void;
+    oAuthClockSkew?: number;
+  };
+  oAuth2ProductionCredentials?: {
+    oAuthClientId: string;
+    oAuthClientSecret: string;
+    oAuthToken?: OAuthToken;
+    oAuthScopes?: OAuthScopeOAuth2ProductionEnum[];
+    oAuthTokenProvider?: (
+      lastOAuthToken: OAuthToken | undefined,
+      authManager: OAuth2ProductionManager
+    ) => Promise<OAuthToken>;
+    oAuthOnTokenUpdate?: (token: OAuthToken) => void;
+    oAuthClockSkew?: number;
+  };
+  httpClientOptions?: Partial<HttpClientOptions>;
+  unstable_httpClientOptions?: any;
+}
+
+/** Environments available for API */
+export enum Environment {
+  Production = 'production',
+  Environment2 = 'environment2',
+}

package/src/controllers/baseController.ts

@@ -0,0 +1,20 @@
+/**
+ * splitit-web-api-v3Lib
+ *
+ * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
+ */
+
+import {
+  ClientInterface,
+  SdkRequestBuilderFactory,
+} from '../clientInterface.js';
+
+/** Base class for all controllers */
+export class BaseController {
+  /** Create a request builder */
+  protected createRequest: SdkRequestBuilderFactory;
+
+  constructor(client: ClientInterface) {
+    this.createRequest = client.getRequestBuilderFactory();
+  }
+}