clip-sdk v0.0.20

SDK clip

Table of Contents

• Installation
• Branching
• Committing Changes
• Committing Rules
• Project Structure
• API Documentation
• Possible Statuses
• Methods Reference - Initialization - Instantiation - Authentication - Create Checkout - Get Checkout

Installation

# npm install clip-sdk --registry https://npm-registry.conexa.ai

Branching

We use GitFlow branching model.

Your branch name should follow one of the following formats:

• feature/feature-name for new features
• fix/fix-name for bug fixes
• chore/chore-name for chores
• docs/docs-name for documentation
• refactor/refactor-name for refactors
• release/release-name for releases
• revert/revert-name for reverts
• test/test-name for tests
• wip/wip-name for work in progress
• ci/ci-name for continuous integration

Making Changes

Run yarn dev so you can compile Typescript(.ts) files in watch mode

yarn dev

Add your changes to TypeScript(.ts) files which are in the src folder. The files will be automatically compiled to JS if you are in watch mode.

Add tests for the new feature

Run yarn test:ts to make sure all Typescript tests pass.

yarn test:ts

Committing Changes

Run yarn commit to commit your changes. This will run commitizen which will guide you through the commit process.

yarn commit

Releasing

Run yarn release to release a new version of the package. This will automatically do the following:

• Run yarn build to compile the Typescript files to JS
• Run standard-version to generate a changelog and bump the version in package.json
  • If you ran yarn release:major it will bump the major version
  • If you ran yarn release:minor it will bump the minor version
  • If you ran yarn release:patch it will bump the patch version
• Run git push to push the changes to the remote repository
• Run git push --tags to push the changes to the remote repository
• Run npm publish to publish the package to the npm registry

Committing Rules

We use The Conventional Commits specification. It is a convention that provides an easy set of rules for creating an explicit commit history; which makes it easier to write automated tools on top of. This convention dovetails with SemVer, by describing the features, fixes, and breaking changes made in commit messages.

Commit types required lowercase

feat – a new feature is introduced with the changes

fix – a bug fix has occurred

chore – changes that do not relate to a fix or feature and don't modify src or test files (for example updating dependencies)

refactor – refactored code that neither fixes a bug nor adds a feature

docs – updates to documentation such as a the README or other markdown files

style – changes that do not affect the meaning of the code, likely related to code formatting such as white-space, missing semi-colons, and so on.

test – including new or correcting previous tests

perf – performance improvements

ci – continuous integration related

build – changes that affect the build system or external dependencies

revert – reverts a previous commit

echo ": some message"    # fails
echo "foo: some message" # fails
echo "FIX: some message" # fails
echo "fix: some message" # passes

Scope optional lowercase

echo "fix(SCOPE): some message" # fails
echo "fix(scope): some message" # passes

Description required start in lowercase not ending in "."

echo "fix:" # fails
echo "fix: some message." # fails
echo "fix(scope): Some message" # fails
echo "fix(scope): some message" # passes
echo "fix(scope): some Message" # passes

Examples:

echo "fix(.gitignore): added node_modules folder" 
echo "fix(controllers/auth): added frontend redirect params"
echo "revert(services/email): nodemailer version update"

Project Structure

.
├── src                               # Source files
│   ├── services                      # Services
│   │   ├── auth.service              # Authentication
│   │   ├── ....                      # Other services, for ex. checkout
│   ├── lib                           # General purpose utils and helpers
│   ├── index.ts                      # Package entry file
├── package.json
└── README.md

Possible Statuses

Methods Reference

Initialization

The SDK exports a function called setAppConfig. Is used to initialize the API SDK and set global variables that will be used throughout the SDK. It takes an object with the following properties as input:

import { setAppConfig } from 'clip-sdk';

setAppConfig({
	env: process.env.NODE_ENV,
	debug: true,
	userAgent: 'Tiendanube Client v1.0.0',
});

Instantiation

The main exported class of the API SDK is ClipSDK. This class provides access to the various services and functionality provided by the SDK, such as creating checkouts and retrieving transaction information.

To use the ClipSDK class, you will need to instantiate it with a token that is used to authenticate API requests. You can obtain a token by calling the authenticate function described below.

Once you have a token, you can create an instance of the ClipSDK class by calling the constructor with the token as an argument. For example:

import { ClipSDK, authenticate } from 'clip-sdk';

const token = await authenticate(apiKey, apiSecret);

const client = new ClipSDK(token);

// Now you can use the client to access the services
const transactions = await client.Transaction.getTransactions();

Authentication

The authenticate function returns a Promise that resolves with a string representing the token if the authentication is successful. If the authentication fails, the Promise will reject with an error.

Parameters

import { authenticate } from 'clip-sdk';

try {
	const token = await authenticate(apiKey, apiSecret);
} catch (error) {
	throw new Error(httpStatus.UNAUTHORIZED)
}

Create Checkout

This method is used to create a new checkout, which is a payment request that can be used to process a payment.

The createCheckout function takes the following arguments as input:

Parameters

Parameters Checkout Data

Response

import { ClipSDK } from 'clip-sdk';

const client = new ClipSDK(token);

const checkoutData = {
  "amount": 3,
  "currency": "MXN",
  "purchase_description": "Hamburguesas 2x1 + 50% descuento",
  "redirection_url": {
     "success": "https://merchant_ecoomerce.com/redirection/success",
     "error": "https://merchant_ecoomerce.com/redirection/error",
     "default": "https://merchant_ecoomerce.com/redirection/default"
  },
  "metadata": {
    "me_reference_id": "OID123456789",
    "customer_info": {
      "name": "Alejandro Lee",
      "email": "buyer@hotmail.com",
      "phone": 5520686868
    }
    "billing_address": {
      "street": "streetTest",
      "outdoor_number": "23a",
      "interior_number": "1234",
      "locality": "colonyTest",
      "city": "cityTest",
      "state": "stateTest",
      "zip_code": "54117",
      "country": "cuntryTest",
      "reference": "referenceTest",
      "between_streets": "street 1 and street 2",
      "floor": "floorTest"
    },
    "shipping_address": {
      "street": "streetTest",
      "outdoor_number": "23a",
      "interior_number": "1234",
      "locality": "colonyTest",
      "city": "cityTest",
      "state": "stateTest",
      "zip_code": "54117",
      "country": "cuntryTest",
      "reference": "referenceTest",
      "between_streets": "street 1 and street 2",
      "floor": "floorTest"
    },
    "source": "tiendanube"
   },
   "webhook_url": "https://merchant_ecoomerce.com/api/v1/webhooks/ipn";
}

const checkout = await client.Checkout.createCheckout(checkoutData);

Get Checkout

This method is used to retrieve information about a checkout that was previously created. The getCheckout function takes the following arguments as input:

Parameters

Response

import { ClipSDK } from 'clip-sdk';

const client = new ClipSDK(token);

const checkout = await client.Checkout.getCheckout(paymentRequestId);