@cuenca-mx/cuenca-js 0.0.1-dev.7 → 0.0.2

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/data-69952249.mjs

@@ -0,0 +1,330 @@
+class CardErrorType {
+  static Blocked = new CardErrorType('blocked');
+
+  static Comunication = new CardErrorType('comunication');
+
+  static ContactlesAmountLimit = new CardErrorType('contactles_amount_limit');
+
+  static FraudDetection = new CardErrorType('fraud_detection');
+
+  static FraudDetectionUncertain = new CardErrorType(
+    'fraud_detection_uncertain',
+  );
+
+  static InsufficientFounds = new CardErrorType('insufficient_founds');
+
+  static InvalidPin = new CardErrorType('invalid_pin');
+
+  static Notification = new CardErrorType('notification');
+
+  static NotificationDeactivatedCard = new CardErrorType(
+    'notification_deactivated_card',
+  );
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class CardFundingType {
+  static Credit = new CardFundingType('credit');
+
+  static Debit = new CardFundingType('debit');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class CardIssuer {
+  static Accendo = new CardIssuer('accendo');
+
+  static Cuenca = new CardIssuer('cuenca');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class CardStatus {
+  static Active = new CardStatus('active');
+
+  static Blocked = new CardStatus('blocked');
+
+  static Created = new CardStatus('created');
+
+  static Deactivated = new CardStatus('deactivated');
+
+  static Printing = new CardStatus('printing');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class CardTransactionType {
+  static Auth = new CardTransactionType('auth');
+
+  static Capture = new CardTransactionType('capture');
+
+  static Chargeback = new CardTransactionType('chargeback');
+
+  static Expiration = new CardTransactionType('expiration');
+
+  static Refund = new CardTransactionType('refund');
+
+  static Void = new CardTransactionType('void');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class CardType {
+  static Physical = new CardType('physical');
+
+  static Virtual = new CardType('virtual');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class CommissionType {
+  static CardRequest = new CommissionType('card_request');
+
+  static CashDeposit = new CommissionType('cash_deposit');
+
+  static OutgoingSpei = new CommissionType('outgoing_spei');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class DepositNetwork {
+  static Cash = new DepositNetwork('cash');
+
+  static Internal = new DepositNetwork('internal');
+
+  static Spei = new DepositNetwork('spei');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class EntryType {
+  static Credit = new EntryType('credit');
+
+  static Debit = new EntryType('debit');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class FileFormat {
+  static Pdf = new FileFormat('pdf');
+
+  static Xml = new FileFormat('xml');
+
+  static Json = new FileFormat('json');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class KYCFileType {
+  static Ine = new KYCFileType('ine');
+
+  static Passport = new KYCFileType('passport');
+
+  static Residency = new KYCFileType('residency');
+
+  static MatriculaConsular = new KYCFileType('matricula_consular');
+
+  static ProofOfLiveness = new KYCFileType('proof_of_liveness');
+
+  static ProofOfAddress = new KYCFileType('proof_of_address');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class KYCStatus {
+  static UploadAgain = new KYCStatus('upload_again');
+
+  static ReviewNeeded = new KYCStatus('review_needed');
+
+  static Submitted = new KYCStatus('submitted');
+
+  static Succeeded = new KYCStatus('succeeded');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class Phase {
+  static Sandbox = new Phase('sandbox');
+
+  static Stage = new Phase('stage');
+
+  static Api = new Phase('api');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class ServiceProviderCategory {
+  static Cable = new ServiceProviderCategory('cable');
+
+  static CreditCard = new ServiceProviderCategory('credit_card');
+
+  static Electricity = new ServiceProviderCategory('electricity');
+
+  static Gas = new ServiceProviderCategory('gas');
+
+  static Internet = new ServiceProviderCategory('internet');
+
+  static LandlineTelephone = new ServiceProviderCategory('landline_telephone');
+
+  static MobileTelephonePostpaid = new ServiceProviderCategory(
+    'mobile_telephone_postpaid',
+  );
+
+  static MobileTelephonePrepaid = new ServiceProviderCategory(
+    'mobile_telephone_prepaid',
+  );
+
+  static SateliteTelevision = new ServiceProviderCategory(
+    'satelite_television',
+  );
+
+  static Water = new ServiceProviderCategory('water');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class SavingCategory {
+  static General = new SavingCategory('general');
+
+  static Home = new SavingCategory('home');
+
+  static Vehicle = new SavingCategory('vehicle');
+
+  static Travel = new SavingCategory('travel');
+
+  static Clothing = new SavingCategory('clothing');
+
+  static Other = new SavingCategory('other');
+
+  static Medical = new SavingCategory('medical');
+
+  static Accident = new SavingCategory('accident');
+
+  static Education = new SavingCategory('education');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class TrackDataMethod {
+  static NotSet = new TrackDataMethod('not_set');
+
+  static Terminal = new TrackDataMethod('terminal');
+
+  static Manual = new TrackDataMethod('manual');
+
+  static Unknown = new TrackDataMethod('unknown');
+
+  static Contactless = new TrackDataMethod('contactless');
+
+  static FallBack = new TrackDataMethod('fall_back');
+
+  static MagneticStripe = new TrackDataMethod('magnetic_stripe');
+
+  static RecurringCharge = new TrackDataMethod('recurring_charge');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class TransactionStatus {
+  static Created = new TransactionStatus('created');
+
+  static Failed = new TransactionStatus('failed');
+
+  static InReview = new TransactionStatus('in_review');
+
+  static Submitted = new TransactionStatus('submitted');
+
+  static Succeeded = new TransactionStatus('succeeded');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class TransferNetwork {
+  static Internal = new TransferNetwork('internal');
+
+  static Spei = new TransferNetwork('spei');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class UserStatus {
+  static Active = new UserStatus('active');
+
+  static Deactivated = new UserStatus('deactivated');
+
+  static Fraud = new UserStatus('fraud');
+
+  static PldBlocked = new UserStatus('pld_blocked');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class VerificationType {
+  static Phone = new VerificationType('phone');
+
+  static Email = new VerificationType('email');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+class WalletTransactionType {
+  static Deposit = new WalletTransactionType('deposit');
+
+  static Withdrawal = new WalletTransactionType('withdrawal');
+
+  constructor(value) {
+    this.value = value;
+  }
+}
+
+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);
+
+export { CardFundingType as C, DepositNetwork as D, EntryType as E, FileFormat as F, KYCFileType as K, Phase as P, SavingCategory as S, TransactionStatus as T, UserStatus as U, VerificationType as V, WalletTransactionType as W, CardIssuer as a, CardStatus as b, CardType as c, dateToUTC as d, enumValueFromString as e, CardErrorType as f, CardTransactionType as g, CommissionType as h, ServiceProviderCategory as i, TransferNetwork as j, KYCStatus as k, TrackDataMethod as l };