@hyphen/sdk 1.10.0 → 1.12.0

package/dist/index.d.cts

@@ -206,7 +206,7 @@ declare class Toggle extends Hookified {
     getObject<T>(key: string, defaultValue: T, options?: ToggleGetOptions): Promise<T>;
 }
 
-type LoadEnvOptions = {
+type EnvOptions = {
     path?: string;
     environment?: string;
     local?: boolean;
@@ -214,13 +214,15 @@ type LoadEnvOptions = {
 /**
  * @description Helper function to load your environment variables based on your default .env file
  * and the current environment.
- * @param {LoadEnvOptions} [options] - Options to customize the loading of environment variables.
+ * @param {EnvOptions} [options] - Options to customize the loading of environment variables.
  * @returns {void}
  * @example
- * import { loadEnv } from '@hyphen/sdk';
- * loadEnv();
+ * import { env } from '@hyphen/sdk';
+ * env();
  */
-declare function loadEnv(options?: LoadEnvOptions): void;
+declare function env(options?: EnvOptions): void;
+declare const loadEnv: typeof env;
+type LoadEnvOptions = EnvOptions;
 
 type BaseServiceOptions = {
     throwErrors?: boolean;
@@ -315,6 +317,41 @@ declare class NetInfo extends BaseService {
     getIpInfos(ips: string[]): Promise<Array<ipInfo | ipInfoError>>;
 }
 
+type ClickByDay = {
+    date: string;
+    total: number;
+    unique: number;
+};
+type Clicks = {
+    total: number;
+    unique: number;
+    byDay: ClickByDay[];
+};
+type Referral = {
+    url: string;
+    total: number;
+};
+type Browser = {
+    name: string;
+    total: number;
+};
+type Device = {
+    name: string;
+    total: number;
+};
+type Location = {
+    country: string;
+    total: number;
+    unique: number;
+};
+type GetCodeStatsResponse = {
+    clicks: Clicks;
+    referrals: Referral[];
+    browsers: Browser[];
+    devices: Device[];
+    locations: Location[];
+};
+
 type CreateShortCodeOptions = {
     /**
      * The short code used for this link. If not provided, a random code will be generated.
@@ -345,6 +382,76 @@ type CreateShortCodeResponse = {
         name: string;
     };
 };
+type UpdateShortCodeResponse = CreateShortCodeResponse;
+type UpdateShortCodeOptions = {
+    /**
+     * The long URL that the short code will redirect to.
+     * @default undefined
+     */
+    long_url?: string;
+    /**
+     * The title of the link. This is used for display purposes.
+     * @default undefined
+     */
+    title?: string;
+    /**
+     * The tags associated with the link. This is used for categorization purposes.
+     * @default undefined
+     */
+    tags?: string[];
+};
+type GetShortCodesResponse = {
+    total: number;
+    pageNum: number;
+    pageSize: number;
+    data: GetShortCodeResponse[];
+};
+type GetShortCodeResponse = CreateShortCodeResponse;
+declare enum QrSize {
+    SMALL = "small",
+    MEDIUM = "medium",
+    LARGE = "large"
+}
+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;
+};
+type CreateQrCodeResponse = {
+    id: string;
+    title?: string;
+    qrCode: string;
+    qrCodeBytes: Uint16Array;
+    qrLink: string;
+};
+type GetQrCodesResponse = {
+    total: number;
+    pageNum: number;
+    pageSize: number;
+    data: CreateQrCodeResponse[];
+};
 type LinkOptions = {
     /**
      * The URIs to access the link service.
@@ -402,13 +509,82 @@ declare class Link extends BaseService {
      * @param {string} apiKey
      */
     setApiKey(apiKey: string | undefined): void;
+    /**
+     * Get the URI for a specific organization and code. This is used internally to construct the URI for the link service.
+     * @param {string} organizationId The ID of the organization.
+     * @param {string} code The code to include in the URI.
+     * @returns {string} The constructed URI.
+     */
+    getUri(organizationId: string, prefix1?: string, prefix2?: string, prefix3?: string): string;
+    /**
+     * Create a short code for a long URL.
+     * @param {string} longUrl The long URL to shorten.
+     * @param {string} domain The domain to use for the short code.
+     * @param {CreateShortCodeOptions} options Optional parameters for creating the short code.
+     * @returns {Promise<CreateShortCodeResponse>} A promise that resolves to the created short code details.
+     */
     createShortCode(longUrl: string, domain: string, options?: CreateShortCodeOptions): Promise<CreateShortCodeResponse>;
+    /**
+     * Get a short code by its code.
+     * @param {string} code The short code to retrieve. Example: 'code_686bed403c3991bd676bba4d'
+     * @returns {Promise<GetShortCodeResponse>} A promise that resolves to the short code details.
+     */
+    getShortCode(code: string): Promise<GetShortCodeResponse>;
+    /**
+     * Get all short codes for the organization.
+     * @param {string} titleSearch Optional search term to filter short codes by title.
+     * @param {string[]} tags Optional tags to filter short codes.
+     * @param {number} pageNumber The page number to retrieve. Default is 1.
+     * @param {number} pageSize The number of short codes per page. Default is 100.
+     * @returns {Promise<GetShortCodesResponse>} A promise that resolves to the list of short codes.
+     */
+    getShortCodes(titleSearch: string, tags?: string[], pageNumber?: number, pageSize?: number): Promise<GetShortCodesResponse>;
+    /**
+     * Get all tags associated with the organization's short codes.
+     * @returns {Promise<string[]>} A promise that resolves to an array of tags.
+     */
+    getTags(): Promise<string[]>;
+    /**
+     * Get statistics for a specific short code.
+     * @param code The short code to retrieve statistics for.
+     * @returns {Promise<GetCodeStatsResponse>} A promise that resolves to the code statistics.
+     */
+    getCodeStats(code: string, startDate: Date, endDate: Date): Promise<GetCodeStatsResponse>;
+    /**
+     * Update a short code.
+     * @param {string} code The short code to update. Example: 'code_686bed403c3991bd676bba4d'
+     * @param {UpdateShortCodeOptions} options The options to update the short code with.
+     * @returns {Promise<UpdateShortCodeResponse>} A promise that resolves to the updated short code details.
+     */
+    updateShortCode(code: string, options: UpdateShortCodeOptions): Promise<UpdateShortCodeResponse>;
     /**
      * Delete a short code.
      * @param {string} code The short code to delete. Example: 'code_686bed403c3991bd676bba4d'
      * @returns {Promise<boolean>} A promise that resolves to true if the short code was deleted successfully, or false if it was not.
      */
     deleteShortCode(code: string): Promise<boolean>;
+    /**
+     * Create a QR code for a specific short code.
+     * @param {string} code The short code to create a QR code for.
+     * @param {CreateQrCodeOptions} options The options for creating the QR code.
+     * @returns {Promise<CreateQrCodeResponse>} A promise that resolves to the created QR code details.
+     */
+    createQrCode(code: string, options?: CreateQrCodeOptions): Promise<CreateQrCodeResponse>;
+    /**
+     * Get a QR code by its ID.
+     * @param code The short code associated with the QR code.
+     * @param qr The ID of the QR code to retrieve.
+     * @returns The details of the requested QR code.
+     */
+    getQrCode(code: string, qr: string): Promise<CreateQrCodeResponse>;
+    getQrCodes(code: string, pageNumber?: number, pageSize?: number): Promise<GetQrCodesResponse>;
+    /**
+     * Delete a QR code by its ID.
+     * @param {string} code The short code associated with the QR code.
+     * @param {string} qr The ID of the QR code to delete.
+     * @returns {Promise<boolean>} A promise that resolves to true if the QR code was deleted successfully, or false if it was not.
+     */
+    deleteQrCode(code: string, qr: string): Promise<boolean>;
 }
 
 type HyphenOptions = {
@@ -510,4 +686,4 @@ declare class Hyphen extends Hookified {
     set throwErrors(value: boolean);
 }
 
-export { Hyphen, type HyphenOptions, Toggle, type ToggleCachingOptions, type ToggleContext, type ToggleGetOptions, ToggleHooks, type ToggleOptions, loadEnv };
+export { type EnvOptions, Hyphen, type HyphenOptions, type LoadEnvOptions, Toggle, type ToggleCachingOptions, type ToggleContext, type ToggleGetOptions, ToggleHooks, type ToggleOptions, env, loadEnv };

package/dist/index.d.ts

@@ -206,7 +206,7 @@ declare class Toggle extends Hookified {
     getObject<T>(key: string, defaultValue: T, options?: ToggleGetOptions): Promise<T>;
 }
 
-type LoadEnvOptions = {
+type EnvOptions = {
     path?: string;
     environment?: string;
     local?: boolean;
@@ -214,13 +214,15 @@ type LoadEnvOptions = {
 /**
  * @description Helper function to load your environment variables based on your default .env file
  * and the current environment.
- * @param {LoadEnvOptions} [options] - Options to customize the loading of environment variables.
+ * @param {EnvOptions} [options] - Options to customize the loading of environment variables.
  * @returns {void}
  * @example
- * import { loadEnv } from '@hyphen/sdk';
- * loadEnv();
+ * import { env } from '@hyphen/sdk';
+ * env();
  */
-declare function loadEnv(options?: LoadEnvOptions): void;
+declare function env(options?: EnvOptions): void;
+declare const loadEnv: typeof env;
+type LoadEnvOptions = EnvOptions;
 
 type BaseServiceOptions = {
     throwErrors?: boolean;
@@ -315,6 +317,41 @@ declare class NetInfo extends BaseService {
     getIpInfos(ips: string[]): Promise<Array<ipInfo | ipInfoError>>;
 }
 
+type ClickByDay = {
+    date: string;
+    total: number;
+    unique: number;
+};
+type Clicks = {
+    total: number;
+    unique: number;
+    byDay: ClickByDay[];
+};
+type Referral = {
+    url: string;
+    total: number;
+};
+type Browser = {
+    name: string;
+    total: number;
+};
+type Device = {
+    name: string;
+    total: number;
+};
+type Location = {
+    country: string;
+    total: number;
+    unique: number;
+};
+type GetCodeStatsResponse = {
+    clicks: Clicks;
+    referrals: Referral[];
+    browsers: Browser[];
+    devices: Device[];
+    locations: Location[];
+};
+
 type CreateShortCodeOptions = {
     /**
      * The short code used for this link. If not provided, a random code will be generated.
@@ -345,6 +382,76 @@ type CreateShortCodeResponse = {
         name: string;
     };
 };
+type UpdateShortCodeResponse = CreateShortCodeResponse;
+type UpdateShortCodeOptions = {
+    /**
+     * The long URL that the short code will redirect to.
+     * @default undefined
+     */
+    long_url?: string;
+    /**
+     * The title of the link. This is used for display purposes.
+     * @default undefined
+     */
+    title?: string;
+    /**
+     * The tags associated with the link. This is used for categorization purposes.
+     * @default undefined
+     */
+    tags?: string[];
+};
+type GetShortCodesResponse = {
+    total: number;
+    pageNum: number;
+    pageSize: number;
+    data: GetShortCodeResponse[];
+};
+type GetShortCodeResponse = CreateShortCodeResponse;
+declare enum QrSize {
+    SMALL = "small",
+    MEDIUM = "medium",
+    LARGE = "large"
+}
+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;
+};
+type CreateQrCodeResponse = {
+    id: string;
+    title?: string;
+    qrCode: string;
+    qrCodeBytes: Uint16Array;
+    qrLink: string;
+};
+type GetQrCodesResponse = {
+    total: number;
+    pageNum: number;
+    pageSize: number;
+    data: CreateQrCodeResponse[];
+};
 type LinkOptions = {
     /**
      * The URIs to access the link service.
@@ -402,13 +509,82 @@ declare class Link extends BaseService {
      * @param {string} apiKey
      */
     setApiKey(apiKey: string | undefined): void;
+    /**
+     * Get the URI for a specific organization and code. This is used internally to construct the URI for the link service.
+     * @param {string} organizationId The ID of the organization.
+     * @param {string} code The code to include in the URI.
+     * @returns {string} The constructed URI.
+     */
+    getUri(organizationId: string, prefix1?: string, prefix2?: string, prefix3?: string): string;
+    /**
+     * Create a short code for a long URL.
+     * @param {string} longUrl The long URL to shorten.
+     * @param {string} domain The domain to use for the short code.
+     * @param {CreateShortCodeOptions} options Optional parameters for creating the short code.
+     * @returns {Promise<CreateShortCodeResponse>} A promise that resolves to the created short code details.
+     */
     createShortCode(longUrl: string, domain: string, options?: CreateShortCodeOptions): Promise<CreateShortCodeResponse>;
+    /**
+     * Get a short code by its code.
+     * @param {string} code The short code to retrieve. Example: 'code_686bed403c3991bd676bba4d'
+     * @returns {Promise<GetShortCodeResponse>} A promise that resolves to the short code details.
+     */
+    getShortCode(code: string): Promise<GetShortCodeResponse>;
+    /**
+     * Get all short codes for the organization.
+     * @param {string} titleSearch Optional search term to filter short codes by title.
+     * @param {string[]} tags Optional tags to filter short codes.
+     * @param {number} pageNumber The page number to retrieve. Default is 1.
+     * @param {number} pageSize The number of short codes per page. Default is 100.
+     * @returns {Promise<GetShortCodesResponse>} A promise that resolves to the list of short codes.
+     */
+    getShortCodes(titleSearch: string, tags?: string[], pageNumber?: number, pageSize?: number): Promise<GetShortCodesResponse>;
+    /**
+     * Get all tags associated with the organization's short codes.
+     * @returns {Promise<string[]>} A promise that resolves to an array of tags.
+     */
+    getTags(): Promise<string[]>;
+    /**
+     * Get statistics for a specific short code.
+     * @param code The short code to retrieve statistics for.
+     * @returns {Promise<GetCodeStatsResponse>} A promise that resolves to the code statistics.
+     */
+    getCodeStats(code: string, startDate: Date, endDate: Date): Promise<GetCodeStatsResponse>;
+    /**
+     * Update a short code.
+     * @param {string} code The short code to update. Example: 'code_686bed403c3991bd676bba4d'
+     * @param {UpdateShortCodeOptions} options The options to update the short code with.
+     * @returns {Promise<UpdateShortCodeResponse>} A promise that resolves to the updated short code details.
+     */
+    updateShortCode(code: string, options: UpdateShortCodeOptions): Promise<UpdateShortCodeResponse>;
     /**
      * Delete a short code.
      * @param {string} code The short code to delete. Example: 'code_686bed403c3991bd676bba4d'
      * @returns {Promise<boolean>} A promise that resolves to true if the short code was deleted successfully, or false if it was not.
      */
     deleteShortCode(code: string): Promise<boolean>;
+    /**
+     * Create a QR code for a specific short code.
+     * @param {string} code The short code to create a QR code for.
+     * @param {CreateQrCodeOptions} options The options for creating the QR code.
+     * @returns {Promise<CreateQrCodeResponse>} A promise that resolves to the created QR code details.
+     */
+    createQrCode(code: string, options?: CreateQrCodeOptions): Promise<CreateQrCodeResponse>;
+    /**
+     * Get a QR code by its ID.
+     * @param code The short code associated with the QR code.
+     * @param qr The ID of the QR code to retrieve.
+     * @returns The details of the requested QR code.
+     */
+    getQrCode(code: string, qr: string): Promise<CreateQrCodeResponse>;
+    getQrCodes(code: string, pageNumber?: number, pageSize?: number): Promise<GetQrCodesResponse>;
+    /**
+     * Delete a QR code by its ID.
+     * @param {string} code The short code associated with the QR code.
+     * @param {string} qr The ID of the QR code to delete.
+     * @returns {Promise<boolean>} A promise that resolves to true if the QR code was deleted successfully, or false if it was not.
+     */
+    deleteQrCode(code: string, qr: string): Promise<boolean>;
 }
 
 type HyphenOptions = {
@@ -510,4 +686,4 @@ declare class Hyphen extends Hookified {
     set throwErrors(value: boolean);
 }
 
-export { Hyphen, type HyphenOptions, Toggle, type ToggleCachingOptions, type ToggleContext, type ToggleGetOptions, ToggleHooks, type ToggleOptions, loadEnv };
+export { type EnvOptions, Hyphen, type HyphenOptions, type LoadEnvOptions, Toggle, type ToggleCachingOptions, type ToggleContext, type ToggleGetOptions, ToggleHooks, type ToggleOptions, env, loadEnv };