flinks-api 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jeremy Cox
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -0,0 +1,2 @@
+var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},s=(n,r,a)=>(a=n==null?{}:e(i(n)),o(r||!n||!n.__esModule?t(a,`default`,{value:n,enumerable:!0}):a,n));let c=require(`axios`);c=s(c);let l=function(e){return e.cad=`CAD`,e.usd=`USD`,e}({}),u=function(e){return e.Alberta=`AB`,e[`British Columbia`]=`BC`,e.Manitoba=`MB`,e[`New Brunswick`]=`NB`,e[`Newfoundland and Labrador`]=`NL`,e[`Northwest Territories`]=`NT`,e[`Nova Scotia`]=`NS`,e.Ontario=`ON`,e[`Prince Edward Island`]=`PE`,e.Quebec=`QC`,e.Saskatchewan=`SK`,e.Yukon=`YT`,e.Nunavut=`NU`,e}({}),d=function(e){return e.Alabama=`AL`,e.Alaska=`AK`,e.Arizona=`AZ`,e.Arkansas=`AR`,e.California=`CA`,e.Colorado=`CO`,e.Connecticut=`CT`,e.Delaware=`DE`,e.Florida=`FL`,e.Georgia=`GA`,e.Hawaii=`HI`,e.Idaho=`ID`,e.Illinois=`IL`,e.Indiana=`IN`,e.Iowa=`IA`,e.Kansas=`KS`,e.Kentucky=`KY`,e.Louisiana=`LA`,e.Maine=`ME`,e.Maryland=`MD`,e.Massachusetts=`MA`,e.Michigan=`MI`,e.Minnesota=`MN`,e.Mississippi=`MS`,e.Missouri=`MO`,e.Montana=`MT`,e.Nebraska=`NE`,e.Nevada=`NV`,e.NewHampshire=`NH`,e.NewJersey=`NJ`,e.NewMexico=`NM`,e.NewYork=`NY`,e.NorthCarolina=`NC`,e.NorthDakota=`ND`,e.Ohio=`OH`,e.Oklahoma=`OK`,e.Oregon=`OR`,e.Pennsylvania=`PA`,e.RhodeIsland=`RI`,e.SouthCarolina=`SC`,e.SouthDakota=`SD`,e.Tennessee=`TN`,e.Texas=`TX`,e.Utah=`UT`,e.Vermont=`VT`,e.Virginia=`VA`,e.Washington=`WA`,e.WestVirginia=`WV`,e.Wisconsin=`WI`,e.Wyoming=`WY`,e}({}),f=function(e){return e.Canada=`CA`,e[`United States`]=`US`,e}({}),p=function(e){return e.Days90=`Days90`,e.Days365=`Days365`,e}({}),m=function(e){return e[`Most Recent`]=`MostRecent`,e[`Months 3`]=`Months3`,e[`Months 12`]=`Months12`,e}({}),h=function(e){return e.AuthKey=`AuthKey`,e.ApiKey=`ApiKey`,e.BearerToken=`BearerToken`,e}({}),g=function(e){return e.QuestionAndAnswer=`QuestionAndAnswer`,e.ImageSelection=`ImageSelection`,e.MultipleChoice=`MultipleChoice`,e.TextOrCall=`TextOrCall`,e.WaitUntilEUAccept=`WaitUntilEUAccept`,e.MultipleChoiceMultipleAnswers=`MultipleChoiceMultipleAnswers`,e}({}),_=function(e){return e.INVALID_LOGIN=`INVALID_LOGIN`,e.METHOD_NOT_AVAILABLE=`METHOD_NOT_AVAILABLE`,e.INVALID_SECURITY_RESPONSE=`INVALID_SECURITY_RESPONSE`,e.UNKNOWN_CHALLENGE_KEY=`UNKNOWN_CHALLENGE_KEY`,e}({}),v=function(e){return e.Cached=`Cached`,e.ActionRequired=`ActionRequired`,e}({}),y=function(e){return e.GetAccountsDetail=`GetAccountsDetail`,e.KYC=`KYC`,e}({});const b=20;var x=class{static{this.interceptorInstalled=!1}constructor(e){this.REQUEST_TIMEOUT=3e4,this.country=e.country,this.customerId=e.customerId,this.url=e.url,this.apiKey=e.apiKey,this.authKey=e.authKey,this.bearerToken=e.bearerToken,this.axios=e.axiosInstance??c.default.create({baseURL:`${this.url}/${this.customerId}`,headers:{accept:`application/json`,"content-type":`application/json`,...this.authKey?{"flinks-auth-key":this.authKey}:{}}}),this.logger={log:e.logger?.log??console.log,error:e.logger?.error??console.error,info:e.logger?.info??console.info,warn:e.logger?.warn??console.warn,debug:e.logger?.debug??console.debug}}getFlinksUrl(){return`${this.url}/${this.customerId}`}flinksApiUrlBuilder(e,t){let n=``;t?.pathParams?.map(e=>{n=`${n}/${e}`});let r=new URLSearchParams;return Object.entries(t?.queryParams||[]).map(e=>{r.append(e[0],e[1])}),`${this.url}/${this.customerId}/${e}${n}${r.size>0?`?${r.toString()}`:``}`}async getAuthorizeToken(){let e=await this.post(`BankingServices/GenerateAuthorizeToken`,{includeHeaders:[h.AuthKey]});if(e.HttpStatusCode!==200){let t=`Status ${e.HttpStatusCode}: ${e.FlinksCode} | ${e.Message}`;throw Error(`Failed to generate authorize token! \n ${t}`)}return{token:e.Token,timestamp:Date.now()}}async getRequestId(e,t){if(!this.country)throw Error(`No locale provided for flinks!!`);let n=t?.mfaResponse,r={LoginId:e,MostRecentCached:t?.mostRecentCached===void 0?!0:t?.mostRecentCached,Save:t?.save,Tag:t?.tag,SecurityResponses:n,requestId:t?.requestId},i=await this.getAuthorizeToken(),a=await this.post(`BankingServices/Authorize`,{headers:{"flinks-auth-key":i.token},body:r,customTimeout:t?.customTimeout||18e4});if(a?.Message===`Request source is unsupported. (Parameter 'requestSource')
+Actual value was Unknown.`)return this.logger.log(`Flinks Account with login ID ${e} no longer exists! This account should be disabled!`),a;if(!a?.RequestId)throw Error(`Response does not contain RequestId!`);return a}async receivePendingData(e){let t=e=>new Promise(t=>setTimeout(t,e));await t(2e3);for(let n=1;n<=20;n++){let r;try{r=await this.axios.get(`${this.url}/${this.customerId}/${e.PathParam}Async/${e.requestId}`,{headers:e.headers,timeout:this.REQUEST_TIMEOUT})}catch(e){throw Error(`Absolute failure when attempting async fetch.`)}switch(r.status){case 200:return r.data;case 202:await t(1e4),this.logger.log(`still waiting 202: `,n);break;default:this.logger.error(`Flinks async request failed with status ${r.status}, Status text: ${r.statusText}`),r.data&&this.logger.error(`Additional information from Flinks: Flinks Code: ${r.data.FlinksCode}, Message: ${r.data.Message}`),await t(1e4)}}throw Error(`Failed to retrieve pending data`)}async post(e,t){if(!this.country)throw Error(`No locale set for Flinks API!`);let n={...t.headers,...t.includeHeaders?.includes(h.ApiKey)&&{"x-api-key":this.apiKey},...t.includeHeaders?.includes(h.AuthKey)&&{"flinks-auth-key":this.authKey},...t.includeHeaders?.includes(h.BearerToken)&&{Authorization:this.bearerToken}},r=await this.axios.post(this.flinksApiUrlBuilder(e,t),t.body||{},{headers:n,timeout:t?.customTimeout||this.REQUEST_TIMEOUT,validateStatus:()=>!0});if(!(r.status>=200&&r.status<300))if(r.data&&r.data.Message)this.logger.error(`Flinks Post had status: ${r.status} and returned message ${r.data.Message}`);else throw Error(`Flinks Post failed with status ${r.status}: ${r.statusText}`);if(r.data.HttpStatusCode===202){let t={PathParam:e,requestId:r.data.RequestId,HttpStatusCode:202,headers:n};return await this.receivePendingData(t)}return r.data}async patch(e,t){if(!this.country)throw Error(`No locale set for Flinks API!`);let n={...t.headers,...t.includeHeaders?.includes(h.ApiKey)&&{"x-api-key":this.apiKey},...t.includeHeaders?.includes(h.AuthKey)&&{"flinks-auth-key":this.authKey},...t.includeHeaders?.includes(h.BearerToken)&&{Authorization:this.bearerToken}},r=``;t.pathParams?.map(e=>{r=`${r}/${e}`});let i=await this.axios.patch(`${this.url}/${this.customerId}/${e}${r}`,t.body||{},{headers:n,timeout:t?.customTimeout||this.REQUEST_TIMEOUT});if(!(i.status>=200&&i.status<300))if(i.data)this.logger.error(`Flinks Patch had status: ${i.status} and returned message ${i.data.Message}`);else throw Error(`Flinks Patch failed with status ${i.status}: ${i.statusText}`);if(i.data.HttpStatusCode===202){let r={PathParam:e,requestId:t.requestId,HttpStatusCode:202,headers:n};return await this.receivePendingData(r)}return i.data}async get(e,t){if(!this.country)throw Error(`No locale set for Flinks API!`);let n={...t.headers,...t.includeHeaders?.includes(h.ApiKey)&&{"x-api-key":this.apiKey},...t.includeHeaders?.includes(h.AuthKey)&&{"flinks-auth-key":this.authKey},...t.includeHeaders?.includes(h.BearerToken)&&{Authorization:this.bearerToken}},r=await this.axios.get(this.flinksApiUrlBuilder(e,t),{headers:n,timeout:t?.customTimeout||this.REQUEST_TIMEOUT});if(!(r.status>=200&&r.status<300))if(r.data)this.logger.error(`Flinks Get had status: ${r.status} and returned message ${r.data.Message}`);else throw Error(`Flinks Get failed with status ${r.status}: ${r.statusText}`);if(r.data.HttpStatusCode===202){let r={PathParam:e,requestId:t.requestId,HttpStatusCode:202,headers:n};return await this.receivePendingData(r)}return r.data}async delete(e,t){if(!this.country)throw Error(`No locale set for Flinks API!`);let n={...t.headers,...t.includeHeaders?.includes(h.ApiKey)&&{"x-api-key":this.apiKey},...t.includeHeaders?.includes(h.AuthKey)&&{"flinks-auth-key":this.authKey},...t.includeHeaders?.includes(h.BearerToken)&&{Authorization:this.bearerToken}},r=await this.axios.delete(this.flinksApiUrlBuilder(e,t),{headers:n,timeout:t?.customTimeout||this.REQUEST_TIMEOUT});if(!(r.status>=200&&r.status<300))if(r.data)this.logger.error(`Flinks Delete had status: ${r.status} and returned message ${r.data.Message}`);else throw Error(`Flinks Delete failed with status ${r.status}: ${r.statusText}`);if(r.data.HttpStatusCode===202){let r={PathParam:e,requestId:t.requestId,HttpStatusCode:202,headers:n};return await this.receivePendingData(r)}return r.data}};exports.AllowedCurrencyTypes=l,exports.CountryShortcode=f,exports.DaysOfTransactionsOptions=p,exports.EFlinksCodes=_,exports.FlinksApi=x,exports.FlinksHeaderOptions=h,exports.FlinksSecurityType=g,exports.MFAType=v,exports.NumberOfStatements=m,exports.ProvincesShortcode=u,exports.ResponseType=y,exports.StatesShortcode=d;

package/dist/index.d.cts

@@ -0,0 +1,563 @@
+import { AxiosInstance, AxiosRequestConfig } from "axios";
+
+//#region src/types.d.ts
+interface Logger {
+  log(message: string, ...optionalParams: any[]): void;
+  error(message: string, ...optionalParams: any[]): void;
+  info?(message: string, ...optionalParams: any[]): void;
+  warn?(message: string, ...optionalParams: any[]): void;
+  debug?(message: string, ...optionalParams: any[]): void;
+}
+interface FlinksApiConfiguration {
+  country: CountryShortcode;
+  customerId: string;
+  url: string;
+  apiKey: string;
+  authKey: string;
+  bearerToken: string;
+  axiosInstance?: AxiosInstance;
+  logger?: Logger;
+}
+declare enum AllowedCurrencyTypes {
+  "cad" = "CAD",
+  "usd" = "USD",
+}
+declare enum ProvincesShortcode {
+  "Alberta" = "AB",
+  "British Columbia" = "BC",
+  "Manitoba" = "MB",
+  "New Brunswick" = "NB",
+  "Newfoundland and Labrador" = "NL",
+  "Northwest Territories" = "NT",
+  "Nova Scotia" = "NS",
+  "Ontario" = "ON",
+  "Prince Edward Island" = "PE",
+  "Quebec" = "QC",
+  "Saskatchewan" = "SK",
+  "Yukon" = "YT",
+  "Nunavut" = "NU",
+}
+declare enum StatesShortcode {
+  Alabama = "AL",
+  Alaska = "AK",
+  Arizona = "AZ",
+  Arkansas = "AR",
+  California = "CA",
+  Colorado = "CO",
+  Connecticut = "CT",
+  Delaware = "DE",
+  Florida = "FL",
+  Georgia = "GA",
+  Hawaii = "HI",
+  Idaho = "ID",
+  Illinois = "IL",
+  Indiana = "IN",
+  Iowa = "IA",
+  Kansas = "KS",
+  Kentucky = "KY",
+  Louisiana = "LA",
+  Maine = "ME",
+  Maryland = "MD",
+  Massachusetts = "MA",
+  Michigan = "MI",
+  Minnesota = "MN",
+  Mississippi = "MS",
+  Missouri = "MO",
+  Montana = "MT",
+  Nebraska = "NE",
+  Nevada = "NV",
+  NewHampshire = "NH",
+  NewJersey = "NJ",
+  NewMexico = "NM",
+  NewYork = "NY",
+  NorthCarolina = "NC",
+  NorthDakota = "ND",
+  Ohio = "OH",
+  Oklahoma = "OK",
+  Oregon = "OR",
+  Pennsylvania = "PA",
+  RhodeIsland = "RI",
+  SouthCarolina = "SC",
+  SouthDakota = "SD",
+  Tennessee = "TN",
+  Texas = "TX",
+  Utah = "UT",
+  Vermont = "VT",
+  Virginia = "VA",
+  Washington = "WA",
+  WestVirginia = "WV",
+  Wisconsin = "WI",
+  Wyoming = "WY",
+}
+declare enum CountryShortcode {
+  "Canada" = "CA",
+  "United States" = "US",
+}
+type CaAddress = {
+  CivicAddress: string;
+  City: string;
+  Province: ProvincesShortcode;
+  PostalCode: string;
+  POBox?: string;
+  Country: CountryShortcode;
+};
+interface WordLists {
+  adjectives: string[];
+  verbs: string[];
+  nouns: string[];
+}
+interface PendingPackage {
+  requestId?: string;
+  headers: Record<string, string>;
+  PathParam: string;
+  FlinksCode?: string;
+  Body?: string;
+  Config?: AxiosRequestConfig;
+  Links?: [{
+    rel: string;
+    href: string;
+    example: string;
+  }];
+  HttpStatusCode: number;
+  Message?: string;
+  RequestId?: string;
+}
+interface SecurityChallenge {
+  Type: FlinksSecurityType;
+  Prompt: string;
+  Iterables: string[];
+}
+interface SecurityResponses {
+  [key: string]: string[];
+}
+declare enum DaysOfTransactionsOptions {
+  "Days90" = "Days90",
+  "Days365" = "Days365",
+}
+interface BankInfoOptions {
+  /**
+   * Contains a valid Authorize Token and represents a successful call to the /Authorize endpoint.
+   */
+  requestId?: string;
+  /**
+   * Enable Instant Bank Verification (IBV).
+   * Defaults to false.
+   */
+  WithAccountIdentity?: boolean;
+  /**
+   * Include customer (KYC) information in account details.
+   * Defaults to false.
+   */
+  WithKYC?: boolean;
+  /**
+   * Include transactions in account details.
+   * Defaults to false.
+   */
+  WithTransactions?: boolean;
+  /**
+   * Include balances in account details.
+   * Defaults to false.
+   */
+  WithBalance?: boolean;
+  /**
+   * Limit the session to specific account IDs.
+   */
+  AccountsFilter?: string[];
+  /**
+   * Number of days of transaction history.
+   * Defaults to "Days90".
+   * - "Days90"
+   * - "Days365"
+   */
+  DaysOfTransactions?: DaysOfTransactionsOptions;
+  /**
+   * Enable PDF banking statements (Base64).
+   * Defaults to false.
+   * Must be enabled by Flinks support.
+   */
+  WithDetailsAndBankingStatements?: boolean;
+  /**
+   * Number of PDF banking statements to return.
+   */
+  NumberOfBankingStatements?: number;
+}
+interface FlinksTransactionDetails {
+  transactionId: string;
+  AccountID: string;
+  Key: string;
+  Signature: string;
+  FlinksAccountID: string;
+  FlinksLoginID: string;
+  Amount: number;
+}
+interface MFAQuestions {
+  Question: string;
+  Answer?: string;
+}
+interface Transaction {
+  Date: string;
+  Code: string | null;
+  Description: string;
+  Debit: number;
+  Credit: number;
+  Balance: number;
+  Id: string;
+}
+interface TransactionHistory {
+  Accounts: {
+    Transactions: Transaction[];
+  }[];
+}
+declare enum NumberOfStatements {
+  "Most Recent" = "MostRecent",
+  "Months 3" = "Months3",
+  "Months 12" = "Months12",
+}
+type StatementsByAccount = {
+  AccountNumber: string;
+  Statements: [{
+    UniqueId: string;
+    FileType: string;
+    Base64Bytes: string;
+  }];
+};
+type AccountFromSummary = {
+  EftEligibleRatio: number;
+  ETransferEligibleRatio: number;
+  Title: string;
+  AccountNumber: string;
+  LastFourDigits?: string;
+  Balance: Balance;
+  Category: string;
+  Type: string;
+  Currency: AllowedCurrencyTypes;
+  Holder: {
+    Name: string;
+    Address: CaAddress;
+    Email: string;
+    Id: string;
+  };
+};
+interface BankAccountDetails {
+  FinancialInstitutionNumber: string;
+  BranchTransitNumber: string;
+  AccountNumber: string;
+}
+interface FlinksDataOptions {
+  includeHeaders?: FlinksHeaderOptions[];
+  headers?: Record<string, string>;
+  requestId?: string;
+  pathParams?: string[];
+  queryParams?: Record<string, string>;
+  customTimeout?: number;
+}
+interface FlinksPostOptions extends FlinksDataOptions {
+  body?: unknown;
+}
+interface FlinksPatchOptions extends FlinksDataOptions {
+  body?: unknown;
+}
+interface FlinksGetOptions extends FlinksDataOptions {}
+interface FlinksDeleteOptions extends FlinksDataOptions {}
+declare enum FlinksHeaderOptions {
+  AuthKey = "AuthKey",
+  ApiKey = "ApiKey",
+  BearerToken = "BearerToken",
+}
+/**
+ * This could probably be extensible, for the different Security Types
+ */
+interface FlinksAuthorizeOptions extends BankInfoOptions {
+  mostRecentCached?: boolean;
+  save?: boolean;
+  mfaResponse?: SecurityResponses[];
+  tag?: string;
+  customTimeout?: number;
+  requestId?: string;
+}
+declare enum FlinksSecurityType {
+  "QuestionAndAnswer" = "QuestionAndAnswer",
+  "ImageSelection" = "ImageSelection",
+  "MultipleChoice" = "MultipleChoice",
+  "TextOrCall" = "TextOrCall",
+  "WaitUntilEUAccept" = "WaitUntilEUAccept",
+  "MultipleChoiceMultipleAnswers" = "MultipleChoiceMultipleAnswers",
+}
+type Balance = {
+  Available?: number;
+  Current?: number;
+  Limit?: number;
+};
+interface IFlinksBankAccountDetails {
+  Transactions: IFlinksTransaction[];
+  TransitNumber: string;
+  InstitutionNumber: string;
+  OverdraftLimit: number;
+  Title: string;
+  AccountNumber: string;
+  LastFourDigits: string;
+  Balance: IFlinksBalance;
+  Category: string;
+  Type: string;
+  Currency: AllowedCurrencyTypes;
+  Holder: IFlinksHolder;
+  AccountType: string;
+  Id: string;
+}
+interface IFlinksHolder {
+  Name: string;
+  Address: IFlinksAddress;
+  Email: string;
+  PhoneNumber: string;
+}
+interface IFlinksBalance {
+  Available?: number;
+  Current?: number;
+  Limit?: number;
+}
+interface IFlinksAddress {
+  CivicAddress: string;
+  City: string;
+  Province: ProvincesShortcode | StatesShortcode;
+  PostalCode: string;
+  POBox?: string;
+  Country: CountryShortcode;
+}
+interface IFlinksLogin {
+  Username: string;
+  IsScheduledRefresh: boolean;
+  LastRefresh: string;
+  Type: string;
+  Id: string;
+}
+interface IFlinksTransaction {
+  Date: string;
+  Code?: string | null;
+  Description: string;
+  Debit?: number | null;
+  Credit?: number | null;
+  Balance: number;
+  Id: string;
+}
+interface IFlinksAccountCredential {
+  loginId: string;
+  accountId: string;
+  institution: string;
+  country: CountryShortcode;
+  securityType?: FlinksSecurityType;
+}
+interface IFlinksLink {
+  rel: string;
+  href: string;
+  example: string;
+}
+interface FlinksResponse {
+  HttpStatusCode: number;
+  StatusCode?: number;
+  Message?: string;
+  FlinksCode?: string;
+  RequestId?: string;
+  [key: string]: any;
+  PathParam?: string;
+  ApiKeyNeeded?: boolean;
+}
+interface OnboardEditOrganizationDto {
+  organizationId: string;
+  organizationName: string;
+  organizationCountry: CountryShortcode;
+  organizationPlan: string;
+}
+interface OnboardEditUserDto {
+  userId: string;
+  firstName: string;
+  lastName?: string;
+  email: string;
+  country: CountryShortcode;
+}
+interface IFlinksResponse {
+  HttpStatusCode: number;
+  Links?: IFlinksLink[];
+  Login?: {
+    Username: string;
+    IsScheduledRefresh: boolean;
+    LastRefresh: string;
+    Type: string;
+    Id: string;
+  };
+  StatementsByAccount?: IFlinksStatementsByAccount[];
+  SecurityChallenges?: SecurityChallenge[];
+  InstitutionName?: string;
+  InstitutionId?: number;
+  Institution?: string;
+  RequestId?: string;
+  Accounts?: IFlinksBankAccountDetails[];
+  Message?: string;
+  Tag?: string;
+  FlinksCode?: EFlinksCodes;
+}
+interface IFlinksStatementsByAccount {
+  AccountNumber: string;
+  Statements: IFlinksStatement[];
+}
+interface IFlinksStatement {
+  UniqueId: string;
+  FileType: string;
+  Base64Bytes: string;
+}
+interface IFlinksToken extends IFlinksResponse {
+  Token: string;
+}
+interface IFlinksAuthorize extends IFlinksResponse {
+  RequestId: string;
+  Institution: string;
+  Links: IFlinksLink[];
+}
+interface IFlinksDetails extends IFlinksResponse {
+  HttpStatusCode: number;
+  Accounts: IFlinksBankAccountDetails[];
+  Links: IFlinksLink[];
+  Tag: string;
+  InstitutionName: string;
+  Login: IFlinksLogin;
+  InstitutionId: number;
+  Institution: string;
+  RequestId: string;
+}
+interface IFlinksSummary extends IFlinksResponse {
+  Login: IFlinksLogin;
+  Tag: string;
+  InstitutionName: string;
+  InstitutionId: number;
+  Institution: string;
+  RequestId: string;
+  Accounts: IFlinksBankAccountDetails[];
+  Links: IFlinksLink[];
+}
+interface FlinksAuthorizeToken {
+  token: string;
+  timestamp: number;
+}
+declare enum EFlinksCodes {
+  "INVALID_LOGIN" = "INVALID_LOGIN",
+  "METHOD_NOT_AVAILABLE" = "METHOD_NOT_AVAILABLE",
+  "INVALID_SECURITY_RESPONSE" = "INVALID_SECURITY_RESPONSE",
+  "UNKNOWN_CHALLENGE_KEY" = "UNKNOWN_CHALLENGE_KEY",
+}
+declare enum MFAType {
+  "Cached" = "Cached",
+  "ActionRequired" = "ActionRequired",
+}
+declare enum ResponseType {
+  GetAccountsDetail = "GetAccountsDetail",
+  KYC = "KYC",
+}
+interface ICachedFlinksWebhook {
+  ResponseType: ResponseType;
+  HttpStatusCode: number;
+  Accounts?: IFlinksBankAccountDetails[];
+  Login: IFlinksLogin;
+  Institution: string;
+  RequestId: string;
+  Tag?: string;
+}
+interface IFlinksWebhookTag {
+  origin: string;
+  [key: string]: string;
+}
+interface IUniqueLogin {
+  institution: string;
+  flinksId: string;
+  title?: string;
+  lastRefresh: Date;
+  authorizedAccountIds: string[];
+}
+//#endregion
+//#region src/FlinksApi.d.ts
+/**
+ * This is our Flinks API class, which aims to standardize the way we:
+ *  - Post
+ *  - Patch
+ *  - Get
+ *  - Delete
+ *  Data when integrating with the Flinks Backend.
+ *
+ *  Calling the API class itself will not work, instead you must call the "useCountry" factory method
+ *  to get an Instance of the FlinksApi specific to the provided CountryCode.
+ *
+ */
+declare class FlinksApi {
+  private static interceptorInstalled;
+  constructor(config: FlinksApiConfiguration);
+  protected country: CountryShortcode;
+  protected customerId: string;
+  protected url: string;
+  protected apiKey: string;
+  protected authKey: string;
+  protected bearerToken: string;
+  protected axios: AxiosInstance;
+  protected logger: Required<Logger>;
+  private REQUEST_TIMEOUT;
+  /**
+   * Returns a Flinks URL for being registered under a VoPay account,
+   * based on the Country this class is registered to return
+   */
+  getFlinksUrl(): string;
+  private flinksApiUrlBuilder;
+  getAuthorizeToken(): Promise<FlinksAuthorizeToken>;
+  /**
+   * Generates an Authorize token & turns it into a Request ID
+   * associated with the provided Login ID
+   *
+   * Only returns the RequestID
+   *
+   * @param loginId
+   */
+  getRequestId(loginId: string, options?: FlinksAuthorizeOptions): Promise<IFlinksAuthorize>;
+  receivePendingData<T extends IFlinksResponse>(pendingPackage: PendingPackage): Promise<T>;
+  /**
+   * This function will create a POST request to flinks, and manage any 202 status responses received.
+   *
+   *     Additional allowed options:
+   *     Body - JSON body object
+   *
+   *     !! Path should omit the first "/" !!
+   *
+   *
+   * @param path
+   * @param body
+   */
+  post<T extends IFlinksResponse>(path: string, options: FlinksPostOptions): Promise<T>;
+  /**
+   *  Patch method of the Flinks API.
+   *
+   *     Additional allowed options:
+   *     Body - JSON body object
+   *
+   *     !! Path should omit the first "/" !!
+   *
+   * @param path
+   * @param options
+   */
+  patch<T extends IFlinksResponse>(path: string, options: FlinksPatchOptions): Promise<T>;
+  /**
+   * Get method for the Flinks API
+   *
+   *
+   *  !! Path should omit the first "/" !!
+   *
+   * @param path
+   * @param options
+   */
+  get(path: string, options: FlinksGetOptions): Promise<IFlinksResponse | FlinksResponse>;
+  /**
+   *  Delete method for our Flinks API
+   *
+   *    !! Path should omit the first "/" !!
+   *
+   * @param path
+   * @param options
+   */
+  delete(path: string, options: FlinksDeleteOptions): Promise<FlinksResponse>;
+}
+//#endregion
+export { AccountFromSummary, AllowedCurrencyTypes, Balance, BankAccountDetails, BankInfoOptions, CaAddress, CountryShortcode, DaysOfTransactionsOptions, EFlinksCodes, FlinksApi, FlinksApiConfiguration, FlinksAuthorizeOptions, FlinksAuthorizeToken, FlinksDataOptions, FlinksDeleteOptions, FlinksGetOptions, FlinksHeaderOptions, FlinksPatchOptions, FlinksPostOptions, FlinksResponse, FlinksSecurityType, FlinksTransactionDetails, ICachedFlinksWebhook, IFlinksAccountCredential, IFlinksAddress, IFlinksAuthorize, IFlinksBalance, IFlinksBankAccountDetails, IFlinksDetails, IFlinksHolder, IFlinksLink, IFlinksLogin, IFlinksResponse, IFlinksStatement, IFlinksStatementsByAccount, IFlinksSummary, IFlinksToken, IFlinksTransaction, IFlinksWebhookTag, IUniqueLogin, Logger, MFAQuestions, MFAType, NumberOfStatements, OnboardEditOrganizationDto, OnboardEditUserDto, PendingPackage, ProvincesShortcode, ResponseType, SecurityChallenge, SecurityResponses, StatementsByAccount, StatesShortcode, Transaction, TransactionHistory, WordLists };

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "flinks-api",
+  "version": "1.0.2",
+  "description": "TypeScript wrapper for Flinks API, designed primarily for Nest.js Integration. Developed to work for Clove-Financial, but expanded personally by Jeremy Cox.",
+  "keywords": ["flinks", "api", "typescript", "nestjs", "banking"],
+  "homepage": "https://github.com/JeremyCCox/Flinks-api",
+  "engines": {
+  "node": ">=22.12.0"
+  },
+  "repository": {
+    "type": "git",
+   "url": "git+https://github.com/JeremyCCox/Flinks-api.git"
+  },
+  "author": {
+    "url": "https://github.com/JeremyCCox",
+    "name": "Jeremy Cox",
+    "email": "jchristophercox@gmail.com"
+  },
+  "license": "MIT",
+  "main": "dist/index.cjs",
+  "types": "dist/index.d.cts",
+  "type": "module",
+  "scripts": {
+    "build": "tsdown",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "axios": "1.12.0"
+  },
+  "devDependencies": {
+    "tsdown": "0.15.0",
+    "typescript": "5.5.3"
+  },
+  "private": false
+}