@hyphen/sdk 1.11.0 → 1.12.1

package/README.md

@@ -1,6 +1,7 @@
 ![Hyphen AI](https://github.com/Hyphen/nodejs-sdk/raw/main/logo.png)
 
 [![tests](https://github.com/Hyphen/nodejs-sdk/actions/workflows/tests.yaml/badge.svg)](https://github.com/Hyphen/nodejs-sdk/actions/workflows/tests.yaml)
+[![codecov](https://codecov.io/gh/Hyphen/nodejs-sdk/graph/badge.svg?token=7SZ2hbuPR3)](https://codecov.io/gh/Hyphen/nodejs-sdk)
 [![npm](https://img.shields.io/npm/v/@hyphen/sdk)](https://www.npmjs.com/package/@hyphen/sdk)
 [![npm](https://img.shields.io/npm/dm/@hyphen/sdk)](https://www.npmjs.com/package/@hyphen/sdk)
 [![license](https://img.shields.io/github/license/Hyphen/nodejs-sdk)](https://github.com/hyphen/nodejs-sdk/blob/main/LICENSE)
@@ -25,9 +26,15 @@ The Hyphen Node.js SDK is a JavaScript library that allows developers to easily
 - [Net Info - Geo Information Service](#net-info---geo-information-service)
 - [Link - Short Code Service](#link---short-code-service)
 	- [Creating a Short Code](#creating-a-short-code)
+	- [Updating a Short Code](#updating-a-short-code)
 	- [Getting a Short Code](#getting-a-short-code)
 	- [Getting Short Codes](#getting-short-codes)
+	- [Getting all Organization Tags](#getting-all-organization-tags)
+	- [Getting Short Code Stats](#getting-short-code-stats)
 	- [Deleting a Short Code](#deleting-a-short-code)
+	- [Creating a QR Code from a Short Code](#creating-a-qr-code-from-a-short-code)
+	- [Get QR Codes for a Short Code](#get-qr-codes-for-a-short-code)
+	- [Deleting a QR Code](#deleting-a-qr-code)
 - [Contributing](#contributing)
 - [Testing Your Changes](#testing-your-changes)
 - [License and Copyright](#license-and-copyright)
@@ -581,44 +588,44 @@ console.log('Boolean toggle value:', result); // true
 Hyphens secret management service known as [ENV](https://hyphen.ai/env) allows you to manage your environment variables in a secure way. The Hyphen Node.js SDK provides a simple way to access your environment variables.
 
 ## Loading Environment Variables
-To load your environment variables, you can use the `loadEnv` function from the SDK. This function will automatically load your environment variables from the `.env` file and then override them with the environment based environment file if it exists (ex: `.env.development`). This is useful for managing different environments such as development, staging, and production. 
+To load your environment variables, you can use the `env()` function from the SDK. This function will automatically load your environment variables from the `.env` file and then override them with the environment based environment file if it exists (ex: `.env.development`). This is useful for managing different environments such as development, staging, and production. 
 
 The following override path is:
 ```
 .env -> .env.local -> .env.<environment> -> .env.<environment>.local
 ```
 
-Here is an example of how to use the `loadEnv` function:
+Here is an example of how to use the `env()` function:
 
 ```javascript
-import { loadEnv } from '@hyphen/sdk';
+import { env } from '@hyphen/sdk';
 
 //load your default environment variables and envrionment variables
-loadEnv();
+env();
 ```
 
 If your environment variables are not stored in the root of your project you can specify the path to your `.env` file:
 
 ```javascript
-import { loadEnv } from '@hyphen/sdk';
+import { env } from '@hyphen/sdk';
 //load your default environment variables and envrionment variables
-loadEnv({ path: '/path/to/your/env/files/' });
+env({ path: '/path/to/your/env/files/' });
 ```
 
 You can also specify the environment variables to load by passing an array of variable names:
 
 ```javascript
-import { loadEnv } from '@hyphen/sdk';
+import { env } from '@hyphen/sdk';
 //load your default environment variables and envrionment variables
-loadEnv({ environment: 'development' });
+env({ environment: 'development' });
 ```
 
 if you want to turn off the local environment variables you can do it like this:
 
 ```javascript
-import { loadEnv } from '@hyphen/sdk';
+import { env } from '@hyphen/sdk';
 //load your default environment variables and envrionment variables
-loadEnv({ local: false });
+env({ local: false });
 ```
 
 # Net Info - Geo Information Service
@@ -681,6 +688,27 @@ const response = await link.createShortCode(longUrl, domain, options);
 console.log('Short Code Response:', response);
 ```
 
+## Updating a Short Code
+To update a short code, you can use the `updateShortCode` method:
+
+```javascript
+import { Link } from '@hyphen/sdk';
+const link = new Link({
+  organizationId: 'your_organization_id',
+  apiKey: 'your_api_key',
+});
+const code = 'code_1234567890'; // It is the code identifier for the short code you want to update
+const longUrl = 'https://hyphen.ai/updated';
+const options = {
+  title: 'Updated Short Code',
+  tags: ['sdk-test', 'unit-test'],
+  long_url: longUrl,
+};
+
+const updateResponse = await link.updateShortCode(code, options);
+console.log('Update Short Code Response:', updateResponse);
+```
+
 ## Getting a Short Code
 To get a short code, you can use the `getShortCode` method:
 
@@ -710,6 +738,37 @@ const response = await link.getShortCodes(title, tags);
 console.log('Get Short Codes Response:', response);
 ```
 
+## Getting all Organization Tags
+
+To get all tags for your organization, you can use the `getTags` method:
+
+```javascript
+import { Link } from '@hyphen/sdk';
+const link = new Link({
+  organizationId: 'your_organization_id',
+  apiKey: 'your_api_key',
+});
+const response = await link.getTags();
+console.log('Get Tags Response:', response);
+```
+
+## Get Short Code Stats
+
+To get the stats for a short code, you can use the `getShortCodeStats` method:
+
+```javascript
+import { Link } from '@hyphen/sdk';
+const link = new Link({
+  organizationId: 'your_organization_id',
+  apiKey: 'your_api_key',
+});
+const code = 'code_1234567890'; // It is the code identifier for the short code
+const startDate = new Date('2023-01-01'); // Optional start date for the stats
+const endDate = new Date('2023-12-31'); // Optional end date for the stats
+const response = await link.getShortCodeStats(code, startDate, endDate);
+console.log('Get Short Code Stats Response:', response);
+```
+
 ## Deleting a Short Code
 if you want to delete a short code you can do it like this:
 
@@ -724,6 +783,100 @@ const response = await link.deleteShortCode(code);
 console.log('Delete Short Code Response:', response);
 ```
 
+## Creating a QR Code from a Short Code
+
+To create a QR code from a short code, you can use the `createQrCode` method:
+
+```javascript
+import { Link } from '@hyphen/sdk';
+const link = new Link({
+  organizationId: 'your_organization_id',
+  apiKey: 'your_api_key',
+});
+const code = 'code_1234567890'; // It is the code identifier for the short code you want to create a QR code for
+const response = await link.createQrCode(code);
+console.log('Create QR Code Response:', response);
+```
+
+There are options that you can pass in to the `createQrCode` method to customize the QR code:
+
+```typescript
+export type CreateQrCodeOptions = {
+	/**
+	 * The title of the QR code. This is used for display purposes.
+	 * @default undefined
+	 */
+	title?: string;
+	/**
+	 * The background color of the QR code. This is a hex color code.
+	 * @default '#ffffff'
+	 */
+	backgroundColor?: string;
+	/**
+	 * The color of the QR code. This is a hex color code.
+	 * @default '#000000'
+	 */
+	color?: string;
+	/**
+	 * The size of the QR code. This can be 'small', 'medium', or 'large'.
+	 * @default QrSize.MEDIUM
+	 */
+	size?: QrSize;
+	/**
+	 * The logo to include in the QR code. This should be a base64 encoded string.
+	 * @default undefined
+	 */
+	logo?: string;
+};
+```
+
+## Get a QR Code By Id
+
+To get a specific QR code by its ID, you can use the `getQrCode` method:
+
+```javascript
+import { Link } from '@hyphen/sdk';
+const link = new Link({
+  organizationId: 'your_organization_id',
+  apiKey: 'your_api_key',
+});
+const code = 'code_1234567890'; // It is the code identifier for the short code
+const qr = 'qr_1234567890'; // It is the ID of the QR code you want to retrieve
+const response = await link.getQrCode(code, qr);
+console.log('Get QR Code Response:', response);
+```
+
+## Get QR Codes for a Short Code
+
+To get all QR codes for a short code, you can use the `getQrCodes` method:
+
+```javascript
+import { Link } from '@hyphen/sdk';
+const link = new Link({
+  organizationId: 'your_organization_id',
+  apiKey: 'your_api_key',
+});
+const code = 'code_1234567890'; // It is the code identifier for the short code
+const response = await link.getQrCodes(code);
+console.log('Get QR Codes Response:', response);
+```
+
+## Deleting a QR Code
+
+To delete a QR code, you can use the `deleteQrCode` method:
+
+```javascript
+import { Link } from '@hyphen/sdk';
+const link = new Link({
+  organizationId: 'your_organization_id',
+  apiKey: 'your_api_key',
+});
+const code = 'code_1234567890'; // It is the code identifier for the short code
+const qr = 'qr_1234567890'; // It is the ID of the QR code you want to delete
+const response = await link.deleteQrCode(code, qr);
+console.log('Delete QR Code Response:', response);
+```
+
 # Contributing
 
 We welcome contributions to the Hyphen Node.js SDK! If you have an idea for a new feature, bug fix, or improvement, please follow these steps: