@hyphen/sdk 1.12.0 → 1.12.1

package/dist/index.d.cts

@@ -1,252 +1,321 @@
-import { Hookified, HookifiedOptions } from 'hookified';
-import { EvaluationContext, Client } from '@openfeature/server-sdk';
+import { HookifiedOptions, Hookified } from 'hookified';
 import * as axios from 'axios';
 import { AxiosRequestConfig } from 'axios';
 import { Cacheable } from 'cacheable';
 import pino from 'pino';
+import { EvaluationContext, Client } from '@openfeature/server-sdk';
 
-type ToggleContext = EvaluationContext;
-declare enum ToggleHooks {
-    beforeGetBoolean = "beforeGetBoolean",
-    afterGetBoolean = "afterGetBoolean",
-    beforeGetString = "beforeGetString",
-    afterGetString = "afterGetString",
-    beforeGetNumber = "beforeGetNumber",
-    afterGetNumber = "afterGetNumber",
-    beforeGetObject = "beforeGetObject",
-    afterGetObject = "afterGetObject"
+type EnvOptions = {
+    path?: string;
+    environment?: string;
+    local?: boolean;
+};
+/**
+ * @description Helper function to load your environment variables based on your default .env file
+ * and the current environment.
+ * @param {EnvOptions} [options] - Options to customize the loading of environment variables.
+ * @returns {void}
+ * @example
+ * import { env } from '@hyphen/sdk';
+ * env();
+ */
+declare function env(options?: EnvOptions): void;
+declare const loadEnv: typeof env;
+type LoadEnvOptions = EnvOptions;
+
+type BaseServiceOptions = {
+    throwErrors?: boolean;
+} & HookifiedOptions;
+declare class BaseService extends Hookified {
+    private _log;
+    private _cache;
+    private _throwErrors;
+    constructor(options?: BaseServiceOptions);
+    get log(): pino.Logger;
+    set log(value: pino.Logger);
+    get cache(): Cacheable;
+    set cache(value: Cacheable);
+    get throwErrors(): boolean;
+    set throwErrors(value: boolean);
+    error(message: string, ...args: any[]): void;
+    warn(message: string, ...args: any[]): void;
+    info(message: string, ...args: any[]): void;
+    get<T>(url: string, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    post<T>(url: string, data: any, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    put<T>(url: string, data: any, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    delete<T>(url: string, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    patch<T>(url: string, data: any, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    createHeaders(apiKey?: string): Record<string, string>;
 }
-type ToggleCachingOptions = {
-    ttl?: number;
-    generateCacheKeyFn?: (context?: ToggleContext) => string;
+
+type ClickByDay = {
+    date: string;
+    total: number;
+    unique: number;
 };
-type ToggleOptions = {
+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 = {
     /**
-     * Your application name. If this is not set it will look for the HYPHEN_APPLICATION_ID environment variable.
-     * @type {string}
+     * The short code used for this link. If not provided, a random code will be generated.
+     * @default undefined
      */
-    applicationId?: string;
+    code?: string;
     /**
-     * Your Hyphen Public API key. If this is not set it will look for the HYPHEN_PUBLIC_API_KEY environment variable.
-     * @type {string}
+     * The title of the link. This is used for display purposes.
+     * @default undefined
      */
-    publicApiKey?: string;
+    title?: string;
     /**
-     * Your environment name such as development, production. Default is what is set at NODE_ENV
-     * @type {string}
-     * @example production
+     * The tags associated with the link. This is used for categorization purposes.
+     * @default undefined
      */
-    environment?: string;
+    tags?: string[];
+};
+type CreateShortCodeResponse = {
+    id: string;
+    code: string;
+    long_url: string;
+    domain: string;
+    createdAt: string;
+    title?: string;
+    tags?: string[];
+    organizationId: {
+        id: string;
+        name: string;
+    };
+};
+type UpdateShortCodeResponse = CreateShortCodeResponse;
+type UpdateShortCodeOptions = {
     /**
-     * The context to use for evaluating feature flags
-     * @type {ToggleContext}
+     * The long URL that the short code will redirect to.
+     * @default undefined
      */
-    context?: ToggleContext;
+    long_url?: string;
     /**
-     * Cache options to use for the request
-     * @type {ToggleCachingOptions}
+     * The title of the link. This is used for display purposes.
+     * @default undefined
      */
-    caching?: ToggleCachingOptions;
+    title?: string;
     /**
-     * Throw errors in addition to emitting them
-     * @type {boolean}
-     * @default false
+     * The tags associated with the link. This is used for categorization purposes.
+     * @default undefined
      */
-    throwErrors?: boolean;
+    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 = {
     /**
-     * Horizon URIs to use for talking to Toggle. You can use this to override
-     * the default URIs for testin or if you are using a self-hosted version.
-     * @type {Array<string>}
-     * @example ['https://toggle.hyphen.ai']
+     * The title of the QR code. This is used for display purposes.
+     * @default undefined
      */
-    uris?: string[];
-};
-type ToggleGetOptions = {
+    title?: string;
     /**
-     * The context to use for evaluating feature flags
-     * @type {ToggleContext}
+     * The background color of the QR code. This is a hex color code.
+     * @default '#ffffff'
      */
-    context?: ToggleContext;
+    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;
 };
-declare class Toggle extends Hookified {
-    private _applicationId;
-    private _publicApiKey;
-    private _environment;
-    private _client;
-    private _context;
-    private _throwErrors;
-    private _uris;
-    private _caching;
-    constructor(options?: ToggleOptions);
+type CreateQrCodeResponse = {
+    id: string;
+    title?: string;
+    qrCode: string;
+    qrCodeBytes: Uint16Array;
+    qrLink: string;
+};
+type GetQrCodesResponse = {
+    total: number;
+    pageNum: number;
+    pageSize: number;
+    data: CreateQrCodeResponse[];
+};
+type LinkOptions = {
     /**
-     * Get the application ID
-     * @returns {string | undefined}
+     * The URIs to access the link service.
+     * @default ["https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"]
      */
-    get applicationId(): string | undefined;
+    uris?: string[];
     /**
-     * Set the application ID
-     * @param {string | undefined} value
+     * The organization ID to use for the link service.
+     * @requires organizationId
      */
-    set applicationId(value: string | undefined);
+    organizationId?: string;
     /**
-     * Get the public API key
-     * @returns {string}
+     * The API key to use for the link service. This should be provided as the service requires authentication.
      */
-    get publicApiKey(): string | undefined;
+    apiKey?: string;
+} & BaseServiceOptions;
+declare class Link extends BaseService {
+    private _uris;
+    private _organizationId?;
+    private _apiKey?;
+    constructor(options?: LinkOptions);
     /**
-     * Set the public API key
-     * @param {string} value
+     * Get the URIs for the link service. The default is `["https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"]`.
+     * @returns {string[]} The URIs for the link service.
      */
-    set publicApiKey(value: string | undefined);
+    get uris(): string[];
     /**
-     * Get the environment
-     * @returns {string}
+     * Set the URIs for the link service. The default is `["https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"]`.
+     * @param {string[]} uris - The URIs to set.
      */
-    get environment(): string;
+    set uris(uris: string[]);
     /**
-     * Set the environment
-     * @param {string} value
+     * Get the organization ID for the link service. This is required to access the link service.
+     * @returns {string | undefined} The organization ID.
      */
-    set environment(value: string);
+    get organizationId(): string | undefined;
     /**
-     * Get the throwErrors. If true, errors will be thrown in addition to being emitted.
-     * @returns {boolean}
+     * Set the organization ID for the link service. This is required to access the link service.
+     * @param {string | undefined} organizationId - The organization ID to set.
      */
-    get throwErrors(): boolean;
+    set organizationId(organizationId: string | undefined);
     /**
-     * Set the throwErrors. If true, errors will be thrown in addition to being emitted.
-     * @param {boolean} value
+     * Get the API key for the link service. This is required to access the link service.
+     * @returns {string | undefined} The API key.
      */
-    set throwErrors(value: boolean);
+    get apiKey(): string | undefined;
     /**
-     * Get the current context. This is the default context used. You can override this at the get function level.
-     * @returns {ToggleContext}
+     * Set the API key for the link service. This is required to access the link service.
+     * @param {string | undefined} apiKey - The API key to set.
      */
-    get context(): ToggleContext | undefined;
+    set apiKey(apiKey: string | undefined);
     /**
-     * Set the context. This is the default context used. You can override this at the get function level.
-     * @param {ToggleContext} value
+     * Set the API key for the link service. If the API key starts with 'public_', an error is thrown.
+     * This is to ensure that the API key is not a public key, which should not be used for authenticated requests.
+     * @param {string} apiKey
      */
-    set context(value: ToggleContext | undefined);
+    setApiKey(apiKey: string | undefined): void;
     /**
-     * Get the URIs. This is used to override the default URIs for testing or if you are using a self-hosted version.
-     * @returns {Array<string>}
+     * 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.
      */
-    get uris(): string[] | undefined;
+    getUri(organizationId: string, prefix1?: string, prefix2?: string, prefix3?: string): string;
     /**
-     * Set the URIs. This is used to override the default URIs for testing or if you are using a self-hosted version.
-     * @param {Array<string>} value
+     * 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.
      */
-    set uris(value: string[] | undefined);
+    createShortCode(longUrl: string, domain: string, options?: CreateShortCodeOptions): Promise<CreateShortCodeResponse>;
     /**
-     * Get the caching options.
-     * @returns {ToggleCachingOptions | undefined}
+     * 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.
      */
-    get caching(): ToggleCachingOptions | undefined;
+    getShortCode(code: string): Promise<GetShortCodeResponse>;
     /**
-     * Set the caching options.
-     * @param {ToggleCachingOptions | undefined} value
+     * 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.
      */
-    set caching(value: ToggleCachingOptions | undefined);
+    getShortCodes(titleSearch: string, tags?: string[], pageNumber?: number, pageSize?: number): Promise<GetShortCodesResponse>;
     /**
-     * This is a helper function to set the public API key. It will check if the key starts with public_ and set it. If it
-     * does set it will also set the client to undefined to force a new one to be created. If it does not,
-     * it will emit an error and console warning and not set the key. Used by the constructor and publicApiKey setter.
-     * @param key
-     * @returns
+     * Get all tags associated with the organization's short codes.
+     * @returns {Promise<string[]>} A promise that resolves to an array of tags.
      */
-    setPublicApiKey(key: string): void;
+    getTags(): Promise<string[]>;
     /**
-     * Set the context. This is the default context used. You can override this at the get function level.
-     * @param {ToggleContext} context
+     * 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.
      */
-    setContext(context: ToggleContext): void;
+    getCodeStats(code: string, startDate: Date, endDate: Date): Promise<GetCodeStatsResponse>;
     /**
-     * Helper function to get the client. This will create a new client if one does not exist. It will also set the
-     * application ID, environment, and URIs if they are not set. This is used by the get function to get the client.
-     * This is normally only used internally.
-     * @returns {Promise<Client>}
+     * 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.
      */
-    getClient(): Promise<Client>;
+    updateShortCode(code: string, options: UpdateShortCodeOptions): Promise<UpdateShortCodeResponse>;
     /**
-     * This is the main function to get a feature flag value. It will check the type of the default value and call the
-     * appropriate function. It will also set the context if it is not set.
-     * @param {string} key - The key of the feature flag
-     * @param {T} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
-     * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
-     * @returns {Promise<T>}
+     * 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.
      */
-    get<T>(key: string, defaultValue: T, options?: ToggleGetOptions): Promise<T>;
+    deleteShortCode(code: string): Promise<boolean>;
     /**
-     * Get a boolean value from the feature flag. This will check the type of the default value and call the
-     * appropriate function. It will also set the context if it is not set.
-     * @param {string} key - The key of the feature flag
-     * @param {boolean} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
-     * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
-     * @returns {Promise<boolean>} - The value of the feature flag
+     * 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.
      */
-    getBoolean(key: string, defaultValue: boolean, options?: ToggleGetOptions): Promise<boolean>;
+    createQrCode(code: string, options?: CreateQrCodeOptions): Promise<CreateQrCodeResponse>;
     /**
-     * Get a string value from the feature flag.
-     * @param {string} key - The key of the feature flag
-     * @param {string} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
-     * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
-     * @returns {Promise<string>} - The value of the feature flag
+     * 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.
      */
-    getString(key: string, defaultValue: string, options?: ToggleGetOptions): Promise<string>;
-    getNumber(key: string, defaultValue: number, options?: ToggleGetOptions): Promise<number>;
+    getQrCode(code: string, qr: string): Promise<CreateQrCodeResponse>;
+    getQrCodes(code: string, pageNumber?: number, pageSize?: number): Promise<GetQrCodesResponse>;
     /**
-     * Get an object value from the feature flag. This will check the type of the default value and call the
-     * appropriate function. It will also set the context if it is not set.
-     * @param {string} key - The key of the feature flag
-     * @param {T} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
-     * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
-     * @returns {Promise<T>} - The value of the feature flag
+     * 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.
      */
-    getObject<T>(key: string, defaultValue: T, options?: ToggleGetOptions): Promise<T>;
-}
-
-type EnvOptions = {
-    path?: string;
-    environment?: string;
-    local?: boolean;
-};
-/**
- * @description Helper function to load your environment variables based on your default .env file
- * and the current environment.
- * @param {EnvOptions} [options] - Options to customize the loading of environment variables.
- * @returns {void}
- * @example
- * import { env } from '@hyphen/sdk';
- * env();
- */
-declare function env(options?: EnvOptions): void;
-declare const loadEnv: typeof env;
-type LoadEnvOptions = EnvOptions;
-
-type BaseServiceOptions = {
-    throwErrors?: boolean;
-} & HookifiedOptions;
-declare class BaseService extends Hookified {
-    private _log;
-    private _cache;
-    private _throwErrors;
-    constructor(options?: BaseServiceOptions);
-    get log(): pino.Logger;
-    set log(value: pino.Logger);
-    get cache(): Cacheable;
-    set cache(value: Cacheable);
-    get throwErrors(): boolean;
-    set throwErrors(value: boolean);
-    error(message: string, ...args: any[]): void;
-    warn(message: string, ...args: any[]): void;
-    info(message: string, ...args: any[]): void;
-    get<T>(url: string, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
-    post<T>(url: string, data: any, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
-    put<T>(url: string, data: any, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
-    delete<T>(url: string, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
-    patch<T>(url: string, data: any, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
-    createHeaders(apiKey?: string): Record<string, string>;
+    deleteQrCode(code: string, qr: string): Promise<boolean>;
 }
 
 type NetInfoOptions = {
@@ -317,274 +386,205 @@ 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.
-     * @default undefined
-     */
-    code?: 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 CreateShortCodeResponse = {
-    id: string;
-    code: string;
-    long_url: string;
-    domain: string;
-    createdAt: string;
-    title?: string;
-    tags?: string[];
-    organizationId: {
-        id: string;
-        name: string;
-    };
+type ToggleContext = EvaluationContext;
+declare enum ToggleHooks {
+    beforeGetBoolean = "beforeGetBoolean",
+    afterGetBoolean = "afterGetBoolean",
+    beforeGetString = "beforeGetString",
+    afterGetString = "afterGetString",
+    beforeGetNumber = "beforeGetNumber",
+    afterGetNumber = "afterGetNumber",
+    beforeGetObject = "beforeGetObject",
+    afterGetObject = "afterGetObject"
+}
+type ToggleCachingOptions = {
+    ttl?: number;
+    generateCacheKeyFn?: (context?: ToggleContext) => string;
 };
-type UpdateShortCodeResponse = CreateShortCodeResponse;
-type UpdateShortCodeOptions = {
+type ToggleOptions = {
     /**
-     * The long URL that the short code will redirect to.
-     * @default undefined
+     * Your application name. If this is not set it will look for the HYPHEN_APPLICATION_ID environment variable.
+     * @type {string}
      */
-    long_url?: string;
+    applicationId?: string;
     /**
-     * The title of the link. This is used for display purposes.
-     * @default undefined
+     * Your Hyphen Public API key. If this is not set it will look for the HYPHEN_PUBLIC_API_KEY environment variable.
+     * @type {string}
      */
-    title?: string;
+    publicApiKey?: string;
     /**
-     * The tags associated with the link. This is used for categorization purposes.
-     * @default undefined
+     * Your environment name such as development, production. Default is what is set at NODE_ENV
+     * @type {string}
+     * @example production
      */
-    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 = {
+    environment?: string;
     /**
-     * The title of the QR code. This is used for display purposes.
-     * @default undefined
+     * The context to use for evaluating feature flags
+     * @type {ToggleContext}
      */
-    title?: string;
+    context?: ToggleContext;
     /**
-     * The background color of the QR code. This is a hex color code.
-     * @default '#ffffff'
+     * Cache options to use for the request
+     * @type {ToggleCachingOptions}
      */
-    backgroundColor?: string;
+    caching?: ToggleCachingOptions;
     /**
-     * The color of the QR code. This is a hex color code.
-     * @default '#000000'
+     * Throw errors in addition to emitting them
+     * @type {boolean}
+     * @default false
      */
-    color?: string;
+    throwErrors?: boolean;
     /**
-     * The size of the QR code. This can be 'small', 'medium', or 'large'.
-     * @default QrSize.MEDIUM
+     * Horizon URIs to use for talking to Toggle. You can use this to override
+     * the default URIs for testin or if you are using a self-hosted version.
+     * @type {Array<string>}
+     * @example ['https://toggle.hyphen.ai']
      */
-    size?: QrSize;
+    uris?: string[];
+};
+type ToggleGetOptions = {
     /**
-     * The logo to include in the QR code. This should be a base64 encoded string.
-     * @default undefined
+     * The context to use for evaluating feature flags
+     * @type {ToggleContext}
      */
-    logo?: string;
-};
-type CreateQrCodeResponse = {
-    id: string;
-    title?: string;
-    qrCode: string;
-    qrCodeBytes: Uint16Array;
-    qrLink: string;
-};
-type GetQrCodesResponse = {
-    total: number;
-    pageNum: number;
-    pageSize: number;
-    data: CreateQrCodeResponse[];
+    context?: ToggleContext;
 };
-type LinkOptions = {
+declare class Toggle extends Hookified {
+    private _applicationId;
+    private _publicApiKey;
+    private _environment;
+    private _client;
+    private _context;
+    private _throwErrors;
+    private _uris;
+    private _caching;
+    constructor(options?: ToggleOptions);
     /**
-     * The URIs to access the link service.
-     * @default ["https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"]
+     * Get the application ID
+     * @returns {string | undefined}
      */
-    uris?: string[];
+    get applicationId(): string | undefined;
     /**
-     * The organization ID to use for the link service.
-     * @requires organizationId
+     * Set the application ID
+     * @param {string | undefined} value
      */
-    organizationId?: string;
+    set applicationId(value: string | undefined);
     /**
-     * The API key to use for the link service. This should be provided as the service requires authentication.
+     * Get the public API key
+     * @returns {string}
      */
-    apiKey?: string;
-} & BaseServiceOptions;
-declare class Link extends BaseService {
-    private _uris;
-    private _organizationId?;
-    private _apiKey?;
-    constructor(options?: LinkOptions);
+    get publicApiKey(): string | undefined;
     /**
-     * Get the URIs for the link service. The default is `["https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"]`.
-     * @returns {string[]} The URIs for the link service.
+     * Set the public API key
+     * @param {string} value
      */
-    get uris(): string[];
+    set publicApiKey(value: string | undefined);
     /**
-     * Set the URIs for the link service. The default is `["https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"]`.
-     * @param {string[]} uris - The URIs to set.
+     * Get the environment
+     * @returns {string}
      */
-    set uris(uris: string[]);
+    get environment(): string;
     /**
-     * Get the organization ID for the link service. This is required to access the link service.
-     * @returns {string | undefined} The organization ID.
+     * Set the environment
+     * @param {string} value
      */
-    get organizationId(): string | undefined;
+    set environment(value: string);
     /**
-     * Set the organization ID for the link service. This is required to access the link service.
-     * @param {string | undefined} organizationId - The organization ID to set.
+     * Get the throwErrors. If true, errors will be thrown in addition to being emitted.
+     * @returns {boolean}
      */
-    set organizationId(organizationId: string | undefined);
+    get throwErrors(): boolean;
     /**
-     * Get the API key for the link service. This is required to access the link service.
-     * @returns {string | undefined} The API key.
+     * Set the throwErrors. If true, errors will be thrown in addition to being emitted.
+     * @param {boolean} value
      */
-    get apiKey(): string | undefined;
+    set throwErrors(value: boolean);
     /**
-     * Set the API key for the link service. This is required to access the link service.
-     * @param {string | undefined} apiKey - The API key to set.
+     * Get the current context. This is the default context used. You can override this at the get function level.
+     * @returns {ToggleContext}
      */
-    set apiKey(apiKey: string | undefined);
+    get context(): ToggleContext | undefined;
     /**
-     * Set the API key for the link service. If the API key starts with 'public_', an error is thrown.
-     * This is to ensure that the API key is not a public key, which should not be used for authenticated requests.
-     * @param {string} apiKey
+     * Set the context. This is the default context used. You can override this at the get function level.
+     * @param {ToggleContext} value
      */
-    setApiKey(apiKey: string | undefined): void;
+    set context(value: ToggleContext | undefined);
     /**
-     * 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.
+     * Get the URIs. This is used to override the default URIs for testing or if you are using a self-hosted version.
+     * @returns {Array<string>}
      */
-    getUri(organizationId: string, prefix1?: string, prefix2?: string, prefix3?: string): string;
+    get uris(): string[] | undefined;
     /**
-     * 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.
+     * Set the URIs. This is used to override the default URIs for testing or if you are using a self-hosted version.
+     * @param {Array<string>} value
      */
-    createShortCode(longUrl: string, domain: string, options?: CreateShortCodeOptions): Promise<CreateShortCodeResponse>;
+    set uris(value: string[] | undefined);
     /**
-     * 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.
+     * Get the caching options.
+     * @returns {ToggleCachingOptions | undefined}
      */
-    getShortCode(code: string): Promise<GetShortCodeResponse>;
+    get caching(): ToggleCachingOptions | undefined;
     /**
-     * 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.
+     * Set the caching options.
+     * @param {ToggleCachingOptions | undefined} value
      */
-    getShortCodes(titleSearch: string, tags?: string[], pageNumber?: number, pageSize?: number): Promise<GetShortCodesResponse>;
+    set caching(value: ToggleCachingOptions | undefined);
     /**
-     * Get all tags associated with the organization's short codes.
-     * @returns {Promise<string[]>} A promise that resolves to an array of tags.
+     * This is a helper function to set the public API key. It will check if the key starts with public_ and set it. If it
+     * does set it will also set the client to undefined to force a new one to be created. If it does not,
+     * it will emit an error and console warning and not set the key. Used by the constructor and publicApiKey setter.
+     * @param key
+     * @returns
      */
-    getTags(): Promise<string[]>;
+    setPublicApiKey(key: string): void;
     /**
-     * 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.
+     * Set the context. This is the default context used. You can override this at the get function level.
+     * @param {ToggleContext} context
      */
-    getCodeStats(code: string, startDate: Date, endDate: Date): Promise<GetCodeStatsResponse>;
+    setContext(context: ToggleContext): void;
     /**
-     * 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.
+     * Helper function to get the client. This will create a new client if one does not exist. It will also set the
+     * application ID, environment, and URIs if they are not set. This is used by the get function to get the client.
+     * This is normally only used internally.
+     * @returns {Promise<Client>}
      */
-    updateShortCode(code: string, options: UpdateShortCodeOptions): Promise<UpdateShortCodeResponse>;
+    getClient(): Promise<Client>;
     /**
-     * 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.
+     * This is the main function to get a feature flag value. It will check the type of the default value and call the
+     * appropriate function. It will also set the context if it is not set.
+     * @param {string} key - The key of the feature flag
+     * @param {T} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+     * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+     * @returns {Promise<T>}
      */
-    deleteShortCode(code: string): Promise<boolean>;
+    get<T>(key: string, defaultValue: T, options?: ToggleGetOptions): Promise<T>;
     /**
-     * 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.
+     * Get a boolean value from the feature flag. This will check the type of the default value and call the
+     * appropriate function. It will also set the context if it is not set.
+     * @param {string} key - The key of the feature flag
+     * @param {boolean} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+     * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+     * @returns {Promise<boolean>} - The value of the feature flag
      */
-    createQrCode(code: string, options?: CreateQrCodeOptions): Promise<CreateQrCodeResponse>;
+    getBoolean(key: string, defaultValue: boolean, options?: ToggleGetOptions): Promise<boolean>;
     /**
-     * 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.
+     * Get a string value from the feature flag.
+     * @param {string} key - The key of the feature flag
+     * @param {string} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+     * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+     * @returns {Promise<string>} - The value of the feature flag
      */
-    getQrCode(code: string, qr: string): Promise<CreateQrCodeResponse>;
-    getQrCodes(code: string, pageNumber?: number, pageSize?: number): Promise<GetQrCodesResponse>;
+    getString(key: string, defaultValue: string, options?: ToggleGetOptions): Promise<string>;
+    getNumber(key: string, defaultValue: number, options?: ToggleGetOptions): Promise<number>;
     /**
-     * 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.
+     * Get an object value from the feature flag. This will check the type of the default value and call the
+     * appropriate function. It will also set the context if it is not set.
+     * @param {string} key - The key of the feature flag
+     * @param {T} defaultValue - The default value to return if the feature flag is not set or does not evaluate.
+     * @param {ToggleRequestOptions} options - The options to use for the request. This can be used to override the context.
+     * @returns {Promise<T>} - The value of the feature flag
      */
-    deleteQrCode(code: string, qr: string): Promise<boolean>;
+    getObject<T>(key: string, defaultValue: T, options?: ToggleGetOptions): Promise<T>;
 }
 
 type HyphenOptions = {
@@ -610,21 +610,21 @@ type HyphenOptions = {
      * @see ToggleOptions
      * @default {Toggle}
      */
-    toggle?: Omit<ToggleOptions, 'publicApiKey' | 'throwErrors'>;
+    toggle?: Omit<ToggleOptions, "publicApiKey" | "throwErrors">;
     /**
      * Options for the NetInfo service.
      * Excludes apiKey and throwErrors from NetInfoOptions.
      * @see NetInfoOptions
      * @default {NetInfo}
      */
-    netInfo?: Omit<NetInfoOptions, 'apiKey' | 'throwErrors'>;
+    netInfo?: Omit<NetInfoOptions, "apiKey" | "throwErrors">;
     /**
      * Options for the Link service.
      * Excludes apiKey and throwErrors from LinkOptions.
      * @see LinkOptions
      * @default {Link}
      */
-    link?: Omit<LinkOptions, 'apiKey' | 'throwErrors'>;
+    link?: Omit<LinkOptions, "apiKey" | "throwErrors">;
 } & HookifiedOptions;
 declare class Hyphen extends Hookified {
     private readonly _netInfo;