@cuenca-mx/cuenca-js 0.0.1-dev.3 → 0.0.1-dev.30

package/README.md

@@ -2,6 +2,161 @@
 
 `cuenca-js` is a Javascript library client to use Cuenca's services.
 
-## Installation
 
-## Documentation
+## 💻 Installation
+
+Using `npm`:
+```bash
+npm install --save @cuenca-mx/cuenca-js
+```
+
+Using `yarn`:
+```bash
+yarn add @cuenca-mx/cuenca-js
+```
+
+
+## 🚀 Getting Started
+
+### Configure the client
+
+To start using the library, the client must be configured with your credentials. Some configurations can be changed to further improve the use of the library:
+
+- Configuring the client on constructor
+    The credentials and environment can be set when instantiating the client:
+    ```js
+    import { Cuenca } from '@cuenca-mx/cuenca-js';
+    import { Phase } from '@cuenca-mx/cuenca-js/types';
+
+    const cuenca = new Cuenca(
+        'SOME_API_KEY',
+        'SOME_API_SECRET',
+        Phase.Stage,
+    );
+    ```
+
+- Client's configuration
+    The configuration can be changed after creating it using the `configure` method:
+    ```js
+    import { Cuenca } from '@cuenca-mx/cuenca-js';
+    import { Phase } from '@cuenca-mx/cuenca-js/types';
+
+    const cuenca = new Client();
+    // The method will require await if `useJwt` is setted to `true`
+    // because a request is made to Cuenca to create the JWT.
+    await cuenca.client.configure({
+        apiKey: 'SOME_API_KEY',
+        apiSecret: 'SOME_API_SECRET',
+        loginToken: 'LOGIN_TOKEN',
+        sessionId: 'SESSION_ID',
+        phase: Phase.Api, // Production environment
+        useJwt: true,
+    });
+    ```
+
+#### Client's configuration values
+
+| Configuration Name | Description | Default Value |
+| :---------- | :------------------ | :------: |
+| apiKey | API Key credential | `undefined` |
+| apiSecret | Secret for the API Key | `undefined` |
+| phase | Used to change the environment for the client (production, stage or sandbox) | `Phase.Sandbox` |
+| loginToken | Login Token, sets `X-Cuenca-LoginToken` on each request  | `undefined` |
+| sessionId | Session Id, sets `X-Cuenca-SessionId` on each request  | `undefined` |
+| useJwt | If `true`, it will create a JWT for authentification | `false` |
+
+### Login
+
+After configuring the client, you should login to your user before performing requests on resources:
+
+```js
+const login = await cuenca.userLogins.create('111111'); // Use 6 digit password to login
+console.log(login); // UserLogin model { id: string, lastLoginAt: Date, success: bool }
+```
+
+### Use Resources
+
+Different actions may be performed on each resource depending on which of the following classes they implement:
+
+#### Action Classes
+| Name | methods | Description
+| :--- | -----: | ---------: |
+| `Retrievable` | `.retrieve(id)` | Retrieves the resource's model given an ID |
+| `Creatable` | Implementation varies* | Creates the resource from a given data |
+| `Updateable` | Implementation varies* | Updates a resource given its ID and data |
+| `Deactivable` | Implementation varies* | Deactivates the resource given its ID |
+| `Downloadable` | `.pdf()`, `.xml()` | Returns the byte string of a document given its ID |
+| `Queryable` | `.one()`, `.first()`, `.count()`, `.all()` | Perform different types of queries on resources |
+
+*  *Some resources may have a different implementation of some actions, for more detail check the source code (better documentation is a WIP).
+
+#### Resources
+| Name | Actions |
+| :---- | ---------: |
+| accounts | `Queryable`, `Retrievable` |
+| apiKeys | `Creatable`, `Deactivable`, `Queryable`, `Retrievable`, `Updateable` |
+| arpc | `Creatable` |
+| accounts | `Queryable`, `Retrievable` |
+| balanceEntries | `Queryable`, `Retrievable` |
+| billPayments | `Queryable`, `Retrievable` |
+| cardActivations | `Creatable` |
+| cards | `Creatable`, `Deactivable`, `Queryable`, `Retrievable`, `Updateable` |
+| cardTransactions | `Queryable`, `Retrievable` |
+| cardValidations | `Creatable` |
+| commissions | `Queryable`, `Retrievable` |
+| deposits | `Queryable`, `Retrievable` |
+| loginTokens | `Creatable` |
+| savings | `Creatable`, `Deactivable`, `Queryable`, `Retrievable`, `Updateable` |
+| serviceProviders | `Queryable`, `Retrievable` |
+| statements | `Downloadable`, `Queryable` |
+| transfers | `Creatable`, `Queryable`, `Retrievable` |
+| userCredentials | `Creatable`, `Updateable` |
+| userLogins | `Creatable`, `Deactivable` |
+| walletTransactions | `Creatable`, `Queryable`, `Retrievable` |
+| whatsAppTransfers | `Queryable`, `Retrievable` |
+
+### Example:
+```js
+import { AccountQuery } from '@cuenca-mx/cuenca-js/types';
+
+let account;
+account = await cuenca.accounts.first(); // Returns the first value found on the query
+
+try {
+    // Throws an error if no result was found or if more than one result were found.
+    account = await cuenca.accounts.one(
+        new AccountQuery({
+            accountNumber: 'SOME_ACCOUNT_NUMBER',
+        }),
+    );
+} catch (error) {
+    console.log(error);
+}
+```
+
+## 💡 Contribute
+
+### Found a bug?
+
+Please submit an issue and how to replicate it.
+
+### Want to contribute?
+
+Fork the repo and send your PR so we can review it! Any and all help is welcomed, just keep in mind:
+
+#### Testing
+
+Be sure to keep coverage at least 99%
+
+
+## Contact
+
+dev@cuenca.com
+
+---
+Developed and maintained with 💙 by [Cuenca](https://github.com/cuenca-mx)
+<p align="center">
+    <a href="https://cuenca.com/">
+        <img alt="Cuenca Logo" src="https://user-images.githubusercontent.com/23020655/150851002-0de97274-117b-4da4-93b7-e89d7c699793.svg" width="200" />
+    </a>
+</p>

package/build/base-80b9a673.cjs

@@ -0,0 +1,28 @@
+'use strict';
+
+const dateToUTC = (date) => {
+  if (!date) return null;
+  const dateObj = new Date(date);
+  return new Date(dateObj.getTime());
+};
+
+const enumValueFromString = (enumValue, value) =>
+  Object.values(enumValue).find((enumV) => enumV.value === value);
+
+class BaseRequest {
+  toObject() {
+    return {};
+  }
+
+  toCleanObject() {
+    const obj = this.toObject();
+    Object.keys(obj).forEach((k) => {
+      if (obj[k] == null) delete obj[k];
+    });
+    return obj;
+  }
+}
+
+exports.BaseRequest = BaseRequest;
+exports.dateToUTC = dateToUTC;
+exports.enumValueFromString = enumValueFromString;

package/build/base-c1f04b51.mjs

@@ -0,0 +1,24 @@
+const dateToUTC = (date) => {
+  if (!date) return null;
+  const dateObj = new Date(date);
+  return new Date(dateObj.getTime());
+};
+
+const enumValueFromString = (enumValue, value) =>
+  Object.values(enumValue).find((enumV) => enumV.value === value);
+
+class BaseRequest {
+  toObject() {
+    return {};
+  }
+
+  toCleanObject() {
+    const obj = this.toObject();
+    Object.keys(obj).forEach((k) => {
+      if (obj[k] == null) delete obj[k];
+    });
+    return obj;
+  }
+}
+
+export { BaseRequest as B, dateToUTC as d, enumValueFromString as e };

package/build/{queries-f146b91b.js → identities-122c79fd.mjs}

@@ -1,5 +1,5 @@
 import { ValidationError } from './errors/index.mjs';
-import { d as dateToUTC } from './data-7d3d5fcc.js';
+import { d as dateToUTC, B as BaseRequest } from './base-c1f04b51.mjs';
 
 class CardErrorType {
   static Blocked = new CardErrorType('blocked');
@@ -255,6 +255,20 @@ class TransferNetwork {
   }
 }
 
+class UserStatus {
+  static Active = new UserStatus('active');
+
+  static Deactivated = new UserStatus('deactivated');
+
+  static fraud = new UserStatus('fraud');
+
+  static pld_blocked = new UserStatus('pld_blocked');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
 class WalletTransactionType {
   static Deposit = new WalletTransactionType('deposit');
 
@@ -496,6 +510,23 @@ class WalletTransactionQuery extends QueryParams {
   }
 }
 
+class UserQuery extends QueryParams {
+  constructor({ emailAddress, phoneNumber, status, ...args }) {
+    super(args);
+    this.emailAddress = emailAddress;
+    this.phoneNumber = phoneNumber;
+    this.status = status;
+  }
+
+  toObject() {
+    return Object.assign(super.toObject(), {
+      email_address: this.emailAddress,
+      phone_number: this.phoneNumber,
+      status: this.status,
+    });
+  }
+}
+
 class WalletQuery extends QueryParams {
   constructor({ active, ...args }) {
     super(args);
@@ -543,4 +574,20 @@ class StatementQuery extends QueryParams {
   }
 }
 
-export { AccountQuery as A, BalanceEntryQuery as B, CardIssuer as C, DepositNetwork as D, EntryType as E, FileFormat as F, Phase as P, QueryParams as Q, SavingCategory as S, TransactionStatus as T, WalletTransactionType as W, CardStatus as a, CardType as b, CardFundingType as c, CardErrorType as d, CardTransactionType as e, CommissionType as f, ServiceProviderCategory as g, TransferNetwork as h, ApiKeyQuery as i, BillPaymentQuery as j, CardsQuery as k, CardTransactionQuery as l, DepositQuery as m, WalletQuery as n, StatementQuery as o, TransferQuery as p, WalletTransactionQuery as q, TrackDataMethod as r, PageSize as s };
+class TOSAgreements extends BaseRequest {
+  constructor({ ip, location, version }) {
+    super();
+    this.ip = ip;
+    this.location = location;
+    this.version = version;
+  }
+
+  static fromObject = ({ ip, location, version }) =>
+    new TOSAgreements({
+      ip,
+      location,
+      version,
+    });
+}
+
+export { AccountQuery as A, BalanceEntryQuery as B, CardIssuer as C, DepositNetwork as D, EntryType as E, FileFormat as F, Phase as P, QueryParams as Q, SavingCategory as S, TransactionStatus as T, UserStatus as U, WalletTransactionType as W, CardStatus as a, CardType as b, CardFundingType as c, CardErrorType as d, CardTransactionType as e, CommissionType as f, ServiceProviderCategory as g, TransferNetwork as h, TOSAgreements as i, ApiKeyQuery as j, BillPaymentQuery as k, CardsQuery as l, CardTransactionQuery as m, DepositQuery as n, WalletQuery as o, StatementQuery as p, TransferQuery as q, UserQuery as r, WalletTransactionQuery as s, TrackDataMethod as t, PageSize as u };

package/build/{queries-b8f29837.js → identities-d9bd3846.cjs}

@@ -1,7 +1,7 @@
 'use strict';
 
-var errors_index = require('./errors/index.js');
-var data = require('./data-c53f1052.js');
+var errors_index = require('./errors/index.cjs');
+var base = require('./base-80b9a673.cjs');
 
 class CardErrorType {
   static Blocked = new CardErrorType('blocked');
@@ -257,6 +257,20 @@ class TransferNetwork {
   }
 }
 
+class UserStatus {
+  static Active = new UserStatus('active');
+
+  static Deactivated = new UserStatus('deactivated');
+
+  static fraud = new UserStatus('fraud');
+
+  static pld_blocked = new UserStatus('pld_blocked');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
 class WalletTransactionType {
   static Deposit = new WalletTransactionType('deposit');
 
@@ -498,6 +512,23 @@ class WalletTransactionQuery extends QueryParams {
   }
 }
 
+class UserQuery extends QueryParams {
+  constructor({ emailAddress, phoneNumber, status, ...args }) {
+    super(args);
+    this.emailAddress = emailAddress;
+    this.phoneNumber = phoneNumber;
+    this.status = status;
+  }
+
+  toObject() {
+    return Object.assign(super.toObject(), {
+      email_address: this.emailAddress,
+      phone_number: this.phoneNumber,
+      status: this.status,
+    });
+  }
+}
+
 class WalletQuery extends QueryParams {
   constructor({ active, ...args }) {
     super(args);
@@ -526,9 +557,9 @@ class StatementQuery extends QueryParams {
   }
 
   set d({ month, year }) {
-    const now = data.dateToUTC(Date.now());
+    const now = base.dateToUTC(Date.now());
     now.setUTCDate(1);
-    const date = data.dateToUTC(`${year}-${month}-01`);
+    const date = base.dateToUTC(`${year}-${month}-01`);
     if (date.getTime() >= now.getTime()) {
       throw new errors_index.ValidationError(
         `${year}-${month} is not a valid year-month pair`,
@@ -545,6 +576,22 @@ class StatementQuery extends QueryParams {
   }
 }
 
+class TOSAgreements extends base.BaseRequest {
+  constructor({ ip, location, version }) {
+    super();
+    this.ip = ip;
+    this.location = location;
+    this.version = version;
+  }
+
+  static fromObject = ({ ip, location, version }) =>
+    new TOSAgreements({
+      ip,
+      location,
+      version,
+    });
+}
+
 exports.AccountQuery = AccountQuery;
 exports.ApiKeyQuery = ApiKeyQuery;
 exports.BalanceEntryQuery = BalanceEntryQuery;
@@ -568,10 +615,13 @@ exports.QueryParams = QueryParams;
 exports.SavingCategory = SavingCategory;
 exports.ServiceProviderCategory = ServiceProviderCategory;
 exports.StatementQuery = StatementQuery;
+exports.TOSAgreements = TOSAgreements;
 exports.TrackDataMethod = TrackDataMethod;
 exports.TransactionStatus = TransactionStatus;
 exports.TransferNetwork = TransferNetwork;
 exports.TransferQuery = TransferQuery;
+exports.UserQuery = UserQuery;
+exports.UserStatus = UserStatus;
 exports.WalletQuery = WalletQuery;
 exports.WalletTransactionQuery = WalletTransactionQuery;
 exports.WalletTransactionType = WalletTransactionType;