@placeos/ts-client 4.6.0 → 4.7.1

package/dist/ldap-sources/functions.d.ts

@@ -1,5 +1,4 @@
 import { PlaceAuthSourceQueryOptions } from '../auth-sources/interfaces';
-import { HashMap } from '../utilities/types';
 import { PlaceLDAPSource } from './ldap-source';
 /**
  * Query the available LDAP sources
@@ -9,9 +8,8 @@ export declare function queryLDAPSources(query_params?: PlaceAuthSourceQueryOpti
 /**
  * Get the data for an LDAP source
  * @param id ID of the LDAP source to retrieve
- * @param query_params Query parameters to add the to request URL
  */
-export declare function showLDAPSource(id: string, query_params?: HashMap): import('rxjs').Observable<PlaceLDAPSource>;
+export declare function showLDAPSource(id: string): import('rxjs').Observable<PlaceLDAPSource>;
 /**
  * Update the LDAP source in the database
  * @param id ID of the LDAP source
@@ -29,6 +27,5 @@ export declare function addLDAPSource(form_data: Partial<PlaceLDAPSource>): impo
 /**
  * Remove an LDAP source from the database
  * @param id ID of the LDAP source
- * @param query_params Query parameters to add the to request URL
  */
-export declare function removeLDAPSource(id: string, query_params?: HashMap): import('rxjs').Observable<HashMap<any>>;
+export declare function removeLDAPSource(id: string): import('rxjs').Observable<import('../utilities/types').HashMap<any>>;

package/dist/metadata/functions.d.ts

@@ -1,6 +1,6 @@
 import { Observable } from 'rxjs';
 import { HashMap } from '../utilities/types';
-import { PlaceZoneMetadataOptions } from './interfaces';
+import { PlaceMetadataDeleteOptions, PlaceMetadataHistoryOptions, PlaceMetadataOptions, PlaceZoneMetadataOptions } from './interfaces';
 import { PlaceMetadata } from './metadata';
 import { PlaceZoneMetadata } from './zone-metadata';
 /**
@@ -8,20 +8,19 @@ import { PlaceZoneMetadata } from './zone-metadata';
  * @param id ID of the item to retrieve metadata
  * @param query_params Query parameters to add the to request URL.
  */
-export declare function listMetadata(id: string, query_params?: HashMap): Observable<PlaceMetadata[]>;
+export declare function listMetadata(id: string, query_params?: PlaceMetadataOptions): Observable<PlaceMetadata[]>;
 /**
  * List the metadata history for a database item
  * @param id ID of the item to retrieve metadata
- * @param form_data Data to pass to the request URL.
+ * @param query_params Query parameters to add to the request URL.
  */
-export declare function listMetadataHistory(id: string, query_params?: HashMap): Observable<PlaceMetadata[]>;
+export declare function listMetadataHistory(id: string, query_params?: PlaceMetadataHistoryOptions): Observable<PlaceMetadata[]>;
 /**
  * Get a metadata field for a database item
  * @param id ID of the item to retrieve metadata
  * @param name Name of the metadata field to retrieve
- * @param query_params Query parameters to add the to request URL.
  */
-export declare function showMetadata(id: string, name: string, query_params?: HashMap): Observable<PlaceMetadata>;
+export declare function showMetadata(id: string, name: string): Observable<PlaceMetadata>;
 /**
  * Update the metadata in the database
  * @param id ID of the item associated with the metadata
@@ -32,11 +31,11 @@ export declare function showMetadata(id: string, name: string, query_params?: Ha
 export declare function updateMetadata(id: string, form_data: Partial<PlaceMetadata>, method?: 'put' | 'patch'): Observable<PlaceMetadata>;
 export declare function addMetadata(form_data: Partial<PlaceMetadata>): Observable<PlaceMetadata>;
 /**
- * Remove an metadata from the database
+ * Remove metadata from the database
  * @param id ID of the item associated with the metadata
- * @param query_params Query parameters to add the to request URL
+ * @param query_params Query parameters including the metadata key name (required)
  */
-export declare function removeMetadata(id: string, query_params?: HashMap): Observable<HashMap<any>>;
+export declare function removeMetadata(id: string, query_params: PlaceMetadataDeleteOptions): Observable<HashMap<any>>;
 /**
  * Query metadata of associated child items
  * @param id ID of the item to get associated child metadata

package/dist/metadata/interfaces.d.ts

@@ -1,10 +1,24 @@
-/** Query param options for getting  metadata */
+/** Query param options for getting metadata */
 export interface PlaceMetadataOptions {
-    /** Specify key to return, i.e. catering */
+    /** The name of the metadata key to return */
     name?: string;
 }
+/** Query param options for deleting metadata */
+export interface PlaceMetadataDeleteOptions {
+    /** The name of the metadata key to delete (required) */
+    name: string;
+}
 /** Query param options for getting child metadata */
 export interface PlaceZoneMetadataOptions extends PlaceMetadataOptions {
-    /** Only return metadata from s with tags. Comma seperated string */
-    tags?: string;
+    /** Include parent metadata in the results (included by default) */
+    include_parent?: boolean;
+}
+/** Query param options for getting metadata history */
+export interface PlaceMetadataHistoryOptions {
+    /** The name of the metadata key */
+    name?: string;
+    /** Maximum number of results to return */
+    limit?: number;
+    /** Starting offset of the result set for pagination */
+    offset?: number;
 }

package/dist/modules/functions.d.ts

@@ -1,6 +1,6 @@
 import { Observable } from 'rxjs';
 import { HashMap } from '../utilities/types';
-import { PlaceModulePingOptions, PlaceModuleQueryOptions } from './interfaces';
+import { PlaceModulePingOptions, PlaceModuleQueryOptions, PlaceModuleShowOptions } from './interfaces';
 import { PlaceModule } from './module';
 /**
  * Query the available moduels
@@ -12,7 +12,7 @@ export declare function queryModules(query_params?: PlaceModuleQueryOptions): im
  * @param id ID of the module to retrieve
  * @param query_params Query parameters to add the to request URL
  */
-export declare function showModule(id: string, query_params?: HashMap): Observable<PlaceModule>;
+export declare function showModule(id: string, query_params?: PlaceModuleShowOptions): Observable<PlaceModule>;
 /**
  * Update the module in the database
  * @param id ID of the module
@@ -30,9 +30,8 @@ export declare function addModule(form_data: Partial<PlaceModule>): Observable<P
 /**
  * Remove a module from the database
  * @param id ID of the module
- * @param query_params Query parameters to add the to request URL
  */
-export declare function removeModule(id: string, query_params?: HashMap): Observable<HashMap<any>>;
+export declare function removeModule(id: string): Observable<HashMap<any>>;
 /**
  * Starts the module with the given ID and clears any existing caches
  * @param id Module ID
@@ -75,3 +74,10 @@ export declare function moduleSettings(id: string): Observable<any>;
  * @param id Module ID
  */
 export declare function moduleRuntimeError(id: string): Observable<string[]>;
+/**
+ * Execute a command on a module
+ * @param id Module ID
+ * @param method Name of the method to execute
+ * @param args Array of arguments to pass to the executed method
+ */
+export declare function executeOnModule(id: string, method: string, args?: any[]): Observable<HashMap>;

package/dist/modules/interfaces.d.ts

@@ -1,21 +1,23 @@
 import { PlaceResourceQueryOptions } from '../resources/interface';
-/** Mapping of available query paramters for the modules index */
+/** Mapping of available query parameters for the modules index endpoint */
 export interface PlaceModuleQueryOptions extends PlaceResourceQueryOptions {
-    /** Returns modules that are in the given system */
+    /** Only return modules updated before this time (unix epoch) */
+    as_of?: number;
+    /** Only return modules running in this system (query params are ignored if this is provided) */
     control_system_id?: string;
-    /** Returns modules with the given dependency */
-    driver_id?: string;
     /** Return results that connected state matches this value */
     connected?: boolean;
-    /** Return modules that are running or not stopped */
-    running?: boolean;
-    /** Returns modules that are not logic modules (i.e. they connect to a device or service) */
+    /** Only return instances of this driver */
+    driver_id?: string;
+    /** Do not return logic modules (return only modules that can exist in multiple systems) */
     no_logic?: boolean;
-    /**
-     * Returns modules that have not been updated since the
-     * value defined as seconds since UTC epoch
-     */
-    as_of?: number;
+    /** Return only running modules */
+    running?: boolean;
+}
+/** Mapping of available query parameters for the modules show endpoint */
+export interface PlaceModuleShowOptions {
+    /** Return the driver details along with the module */
+    complete?: boolean;
 }
 /** Place response from `ping` module task endpoint `/api/engine/v2/<mod_id>/ping` */
 export interface PlaceModulePingOptions {

package/dist/oauth-sources/functions.d.ts

@@ -1,5 +1,4 @@
 import { PlaceAuthSourceQueryOptions } from '../auth-sources/interfaces';
-import { HashMap } from '../utilities/types';
 import { PlaceOAuthSource } from './oauth-source';
 /**
  * Query the available OAuth sources
@@ -9,9 +8,8 @@ export declare function queryOAuthSources(query_params?: PlaceAuthSourceQueryOpt
 /**
  * Get the data for an OAuth source
  * @param id ID of the OAuth source to retrieve
- * @param query_params Query parameters to add the to request URL
  */
-export declare function showOAuthSource(id: string, query_params?: HashMap): import('rxjs').Observable<PlaceOAuthSource>;
+export declare function showOAuthSource(id: string): import('rxjs').Observable<PlaceOAuthSource>;
 /**
  * Update the OAuth source in the database
  * @param id ID of the OAuth source
@@ -29,6 +27,5 @@ export declare function addOAuthSource(form_data: Partial<PlaceOAuthSource>): im
 /**
  * Remove an OAuth source from the database
  * @param id ID of the OAuth source
- * @param query_params Query parameters to add the to request URL
  */
-export declare function removeOAuthSource(id: string, query_params?: HashMap): import('rxjs').Observable<HashMap<any>>;
+export declare function removeOAuthSource(id: string): import('rxjs').Observable<import('../utilities/types').HashMap<any>>;

package/dist/repositories/functions.d.ts

@@ -1,20 +1,18 @@
 import { Observable } from 'rxjs';
 import { PlaceDriverDetails } from '../drivers/interfaces';
-import { PlaceResourceQueryOptions } from '../resources/interface';
 import { HashMap } from '../utilities/types';
-import { GitCommitDetails, PlaceRepositoryCommitQuery, PlaceRepositoryDetailsQuery, PlaceRepositoryPullQuery } from './interfaces';
+import { GitCommitDetails, PlaceRemoteRepositoryCommitsQuery, PlaceRemoteRepositoryQuery, PlaceRepositoryCommitQuery, PlaceRepositoryDetailsQuery, PlaceRepositoryFoldersQuery, PlaceRepositoryPullQuery, PlaceRepositoryQueryOptions } from './interfaces';
 import { PlaceRepository } from './repository';
 /**
  * Query the available repositories
  * @param query_params Query parameters to add the to request URL
  */
-export declare function queryRepositories(query_params?: PlaceResourceQueryOptions): import('..').QueryResponse<PlaceRepository>;
+export declare function queryRepositories(query_params?: PlaceRepositoryQueryOptions): import('..').QueryResponse<PlaceRepository>;
 /**
  * Get the data for a repository
  * @param id ID of the repository to retrieve
- * @param query_params Query parameters to add the to request URL
  */
-export declare function showRepository(id: string, query_params?: HashMap): Observable<PlaceRepository>;
+export declare function showRepository(id: string): Observable<PlaceRepository>;
 /**
  * Update the repository in the database
  * @param id ID of the repository
@@ -30,50 +28,34 @@ export declare function updateRepository(id: string, form_data: Partial<PlaceRep
  */
 export declare function addRepository(form_data: Partial<PlaceRepository>): Observable<PlaceRepository>;
 /**
- * Remove an repository from the database
+ * Remove a repository from the database
  * @param id ID of the repository
- * @param query_params Query parameters to add the to request URL
  */
-export declare function removeRepository(id: string, query_params?: HashMap): Observable<HashMap<any>>;
+export declare function removeRepository(id: string): Observable<HashMap<any>>;
 /**
  * Get a list of all the interfaces
- * @param query_params Addition query parameters to pass to the request
  */
-export declare function listInterfaceRepositories(query_params?: HashMap): Observable<string[]>;
+export declare function listInterfaceRepositories(): Observable<string[]>;
 /**
- * Get name of the default branches for a new repository
+ * Get name of the default branch for a new repository
  * @param query_params Details about the repository
  */
-export declare function listRemoteRepositoryDefaultBranch(query_params: RepositoryDetails): Observable<string>;
-export interface RepositoryDetails {
-    /** Git URL of the remote repository */
-    repository_url: string;
-    /** Username required to access the repository */
-    username?: string;
-    /** Password for the required user */
-    password?: string;
-}
+export declare function listRemoteRepositoryDefaultBranch(query_params: PlaceRemoteRepositoryQuery): Observable<string>;
 /**
  * Get a list of branches for a new repository
  * @param query_params Details about the repository
  */
-export declare function listRemoteRepositoryBranches(query_params: RepositoryDetails): Observable<string[]>;
-export interface RepositoryBranchDetails extends RepositoryDetails {
-    /** Branch to grab details for. Defaults to the default branch */
-    branch?: string;
-    /** Number of commits to retrieve from the remote. Defaults to `50` */
-    depth?: number;
-}
+export declare function listRemoteRepositoryBranches(query_params: PlaceRemoteRepositoryQuery): Observable<string[]>;
 /**
  * Get a list of branch commits for a new repository
  * @param query_params Details about the repository
  */
-export declare function listRemoteRepositoryCommits(query_params: RepositoryBranchDetails): Observable<GitCommitDetails[]>;
+export declare function listRemoteRepositoryCommits(query_params: PlaceRemoteRepositoryCommitsQuery): Observable<GitCommitDetails[]>;
 /**
  * Get a list of tags for a new repository
  * @param query_params Details about the repository
  */
-export declare function listRemoteRepositoryTags(query_params: RepositoryDetails): Observable<string[]>;
+export declare function listRemoteRepositoryTags(query_params: PlaceRemoteRepositoryQuery): Observable<string[]>;
 /**
  * Get a list of all the drivers for a repository
  * @param id ID of the repository
@@ -119,3 +101,9 @@ export declare function listRepositoryDriverDetails(id: string, query_params: Pl
  * @param query Addition query parameters to pass to the request
  */
 export declare function pullRepositoryChanges(id: string, query_params?: PlaceRepositoryPullQuery): Observable<GitCommitDetails>;
+/**
+ * Get the folder tree structure of a repository
+ * @param id ID of the repository
+ * @param query_params Query parameters to add to the request
+ */
+export declare function listRepositoryFolders(id: string, query_params?: PlaceRepositoryFoldersQuery): Observable<string[]>;

package/dist/repositories/interfaces.d.ts

@@ -1,3 +1,4 @@
+import { PlaceResourceQueryOptions } from '../resources/interface';
 /** Type of repository */
 export declare enum PlaceRepositoryType {
     /** Repository is a collection of Driver logic */
@@ -5,6 +6,10 @@ export declare enum PlaceRepositoryType {
     /** Repository is a collection of interfaces */
     Interface = "interface"
 }
+/** Mapping of available query parameters for the repositories index endpoint */
+export interface PlaceRepositoryQueryOptions extends PlaceResourceQueryOptions {
+}
+/** Query parameters for repository commit listing */
 export interface PlaceRepositoryCommitQuery {
     /** URL encoded name of the branch being requested */
     branch?: string;
@@ -18,21 +23,44 @@ export interface GitCommitDetails {
     author: string;
     /** Short hash of the commit */
     commit: string;
-    /** ISO datetime string for commit  */
+    /** ISO datetime string for commit */
     date: string;
     /** Commit summary */
     subject: string;
 }
+/** Query parameters for repository driver details */
 export interface PlaceRepositoryDetailsQuery {
-    /** URL encoded name of the driver being requested */
+    /** URL encoded name of the driver being requested (required) */
     driver: string;
-    /** Hash of the commit being requested for the driver */
+    /** Hash of the commit being requested for the driver (required) */
     commit: string;
 }
+/** Query parameters for repository pull */
 export interface PlaceRepositoryPullQuery {
     /** Hash of the commit being requested */
     commit: string;
 }
+/** Query parameters for remote repository operations */
+export interface PlaceRemoteRepositoryQuery {
+    /** The git URL that represents the repository (required) */
+    repository_url: string;
+    /** A username for access if required */
+    username?: string;
+    /** The password or access token as required */
+    password?: string;
+}
+/** Query parameters for remote repository commits */
+export interface PlaceRemoteRepositoryCommitsQuery extends PlaceRemoteRepositoryQuery {
+    /** The branch to grab commits from */
+    branch?: string;
+    /** The number of commits to return */
+    depth?: number;
+}
+/** Query parameters for repository folders listing */
+export interface PlaceRepositoryFoldersQuery {
+    /** Include dot files and folders */
+    include_dots?: boolean;
+}
 /** Metadata for a repository commit */
 export interface PlaceRepositoryCommit {
     /** Hash associated with the commit */

package/dist/resources/interface.d.ts

@@ -4,15 +4,20 @@ import { HashMap } from '../utilities/types';
 export interface PlaceResourceQueryOptions {
     /**
      * Search filter supporting the following syntax
-     * https://www.elastic.co/guide/en/elasticsearch/reference/5.5/query-dsl-simple-query-string-query.html
+     * https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html
      */
     q?: string;
-    /** Comma seperated list of fields to apply the query to */
+    /**
+     * Comma separated list of fields to search.
+     * Accepts wildcard expressions and boost relevance scores using caret ^ operator.
+     */
     fields?: string;
     /** Number of results to return. Defaults to `20`. Max `500` */
     limit?: number;
-    /** Offsets of the results to return. Max `10000` */
+    /** @deprecated Use `ref` for pagination. Offset of the results to return. Max `10000` */
     offset?: number;
+    /** Token for accessing the next page of results, provided in the `Link` header */
+    ref?: string;
     /** Number of milliseconds to cache the query response */
     cache?: number;
     /** Whether the request is a API poll request */
@@ -59,7 +64,7 @@ export interface TaskParameters<T> {
     id: string;
     task_name: string;
     form_data?: any;
-    method?: 'post' | 'get' | 'del' | 'put';
+    method?: 'post' | 'get' | 'del' | 'put' | 'patch';
     callback?: (_: any) => T;
     path: string;
 }

package/dist/saml-sources/functions.d.ts

@@ -1,5 +1,4 @@
 import { PlaceAuthSourceQueryOptions } from '../auth-sources/interfaces';
-import { HashMap } from '../utilities/types';
 import { PlaceSAMLSource } from './saml-source';
 /**
  * Query the available SAML sources
@@ -7,11 +6,10 @@ import { PlaceSAMLSource } from './saml-source';
  */
 export declare function querySAMLSources(query_params?: PlaceAuthSourceQueryOptions): import('..').QueryResponse<PlaceSAMLSource>;
 /**
- * Get the data for an SAML source
+ * Get the data for a SAML source
  * @param id ID of the SAML source to retrieve
- * @param query_params Query parameters to add the to request URL
  */
-export declare function showSAMLSource(id: string, query_params?: HashMap): import('rxjs').Observable<PlaceSAMLSource>;
+export declare function showSAMLSource(id: string): import('rxjs').Observable<PlaceSAMLSource>;
 /**
  * Update the SAML source in the database
  * @param id ID of the SAML source
@@ -27,8 +25,7 @@ export declare function updateSAMLSource(id: string, form_data: Partial<PlaceSAM
  */
 export declare function addSAMLSource(form_data: Partial<PlaceSAMLSource>): import('rxjs').Observable<PlaceSAMLSource>;
 /**
- * Remove an SAML source from the database
+ * Remove a SAML source from the database
  * @param id ID of the SAML source
- * @param query_params Query parameters to add the to request URL
  */
-export declare function removeSAMLSource(id: string, query_params?: HashMap): import('rxjs').Observable<HashMap<any>>;
+export declare function removeSAMLSource(id: string): import('rxjs').Observable<import('../utilities/types').HashMap<any>>;

package/dist/settings/functions.d.ts

@@ -1,5 +1,5 @@
 import { HashMap } from '../utilities/types';
-import { PlaceSettingsQueryOptions } from './interfaces';
+import { PlaceSettingsHistoryOptions, PlaceSettingsQueryOptions } from './interfaces';
 import { PlaceSettings } from './settings';
 /**
  * Query the available settings
@@ -9,9 +9,8 @@ export declare function querySettings(query_params?: PlaceSettingsQueryOptions):
 /**
  * Get the data for settings
  * @param id ID of the settings to retrieve
- * @param query_params Query parameters to add the to request URL
  */
-export declare function showSettings(id: string, query_params?: HashMap): import('rxjs').Observable<PlaceSettings>;
+export declare function showSettings(id: string): import('rxjs').Observable<PlaceSettings>;
 /**
  * Update the settings in the database
  * @param id ID of the settings
@@ -27,14 +26,13 @@ export declare function updateSettings(id: string, form_data: Partial<PlaceSetti
  */
 export declare function addSettings(form_data: Partial<PlaceSettings>, query_params?: HashMap): import('rxjs').Observable<PlaceSettings>;
 /**
- * Remove an settings from the database
+ * Remove settings from the database
  * @param id ID of the settings
- * @param query_params Query parameters to add the to request URL
  */
-export declare function removeSettings(id: string, query_params?: HashMap): import('rxjs').Observable<HashMap<any>>;
+export declare function removeSettings(id: string): import('rxjs').Observable<HashMap<any>>;
 /**
- * Get historical version of settings
+ * Get historical versions of settings
  * @param id ID of the settings to retrieve
  * @param query_params Query parameters to add the to request URL
  */
-export declare function settingsHistory(id: string, query_params?: HashMap): import('rxjs').Observable<PlaceSettings[]>;
+export declare function settingsHistory(id: string, query_params?: PlaceSettingsHistoryOptions): import('rxjs').Observable<PlaceSettings[]>;

package/dist/settings/interfaces.d.ts

@@ -15,3 +15,10 @@ export interface PlaceSettingsQueryOptions extends PlaceResourceQueryOptions {
     /** ID of the parent zone, system, module or driver to grab settings for */
     parent_id?: string;
 }
+/** Allowable query parameters for settings history endpoint */
+export interface PlaceSettingsHistoryOptions {
+    /** Maximum number of results to return */
+    limit?: number;
+    /** Starting offset of the result set for pagination */
+    offset?: number;
+}

package/dist/short-url/functions.d.ts

@@ -0,0 +1,60 @@
+import { PlaceShortUrl } from './short-url.class';
+import { PlaceQrCodeOptions, PlaceShortUrlPngQrOptions, PlaceShortUrlQueryOptions } from './interfaces';
+/**
+ * Query the available short URLs
+ * @param query_params Query parameters to add to the request URL
+ */
+export declare function queryShortUrls(query_params?: PlaceShortUrlQueryOptions): import('..').QueryResponse<PlaceShortUrl>;
+/**
+ * Get the data for a short URL
+ * @param id ID of the short URL to retrieve
+ * @param query_params Query parameters to add to the request URL
+ */
+export declare function showShortUrl(id: string, query_params?: Record<string, any>): import('rxjs').Observable<PlaceShortUrl>;
+/**
+ * Update a short URL in the database
+ * @param id ID of the short URL
+ * @param form_data New values for the short URL
+ * @param method HTTP verb to use on request. Defaults to `patch`
+ */
+export declare function updateShortUrl(id: string, form_data: Partial<PlaceShortUrl>, method?: 'put' | 'patch'): import('rxjs').Observable<PlaceShortUrl>;
+/**
+ * Add a new short URL to the database
+ * @param form_data Short URL data
+ */
+export declare function addShortUrl(form_data: Partial<PlaceShortUrl>): import('rxjs').Observable<PlaceShortUrl>;
+/**
+ * Remove a short URL from the database
+ * @param id ID of the short URL
+ * @param query_params Query parameters to add to the request URL
+ */
+export declare function removeShortUrl(id: string, query_params?: Record<string, any>): import('rxjs').Observable<import('../utilities/types').HashMap<any>>;
+/**
+ * Get the redirect URL for a short URL.
+ * Returns the full redirect URL that can be used to navigate to the short URL destination.
+ * @param id ID of the short URL
+ */
+export declare function shortUrlRedirectUrl(id: string): string;
+/**
+ * Get an SVG QR code for a short URL
+ * @param id ID of the short URL
+ */
+export declare function getShortUrlQrCodeSvg(id: string): import('rxjs').Observable<string>;
+/**
+ * Get the URL for a PNG QR code for a short URL.
+ * Use this URL directly in an img tag or fetch it separately.
+ * @param id ID of the short URL
+ * @param options Options including size (between 72px and 512px)
+ */
+export declare function shortUrlQrCodePngUrl(id: string, options?: PlaceShortUrlPngQrOptions): string;
+/**
+ * Get the URL for generating a QR code with user-defined content.
+ * @param options Options for QR code generation including content, format, and size
+ */
+export declare function qrCodeUrl(options: PlaceQrCodeOptions): string;
+/**
+ * Generate an SVG QR code with user-defined content.
+ * For PNG format, use qrCodeUrl() and fetch the URL directly.
+ * @param options Options for QR code generation including content and size
+ */
+export declare function generateQrCode(options: Omit<PlaceQrCodeOptions, 'format'>): import('rxjs').Observable<string>;

package/dist/short-url/interfaces.d.ts

@@ -0,0 +1,22 @@
+import { PlaceResourceQueryOptions } from '../resources/interface';
+/** Mapping of available query parameters for the short_url index endpoint */
+export interface PlaceShortUrlQueryOptions extends PlaceResourceQueryOptions {
+}
+/** Format options for QR code generation */
+export type QrCodeFormat = 'svg' | 'png';
+/** Options for generating a QR code with custom content */
+export interface PlaceQrCodeOptions {
+    /** The contents of the QR code (required) */
+    content: string;
+    /** Identifier for the QR code (required) */
+    id: string;
+    /** File format of the response */
+    format?: QrCodeFormat;
+    /** Size of the QR code in pixels (between 72px and 512px) */
+    size?: number;
+}
+/** Options for generating a PNG QR code for a short URL */
+export interface PlaceShortUrlPngQrOptions {
+    /** Size of the QR code in pixels (between 72px and 512px) */
+    size?: number;
+}

package/dist/short-url/short-url.class.d.ts

@@ -0,0 +1,17 @@
+export declare class PlaceShortUrl {
+    readonly id: string;
+    readonly name: string;
+    readonly uri: string;
+    readonly description: string;
+    readonly user_id: string;
+    readonly user_email: string;
+    readonly user_name: string;
+    readonly redirect_count: number;
+    readonly enabled: boolean;
+    readonly valid_from: string;
+    readonly valid_until: string;
+    readonly authority_id: string;
+    readonly created_at: number;
+    readonly updated_at: number;
+    constructor(data: Partial<PlaceShortUrl>);
+}

package/dist/signage/interfaces.d.ts

@@ -4,8 +4,16 @@ export interface SignageMetrics {
     playlist_counts: Record<string, number>;
     media_counts: Record<string, number>;
 }
-/** Allowable query parameters for systems index endpoint */
+/** Allowable query parameters for signage media index endpoint */
 export interface SignageMediaQueryOptions extends PlaceResourceQueryOptions {
     /** ID of the authority to filter the returned values on */
     authority_id?: string;
 }
+/** Allowable query parameters for signage playlists index endpoint */
+export interface SignagePlaylistQueryOptions extends PlaceResourceQueryOptions {
+}
+/** Allowable query parameters for signage playlist media revisions endpoint */
+export interface SignagePlaylistRevisionsOptions {
+    /** Maximum number of revisions to return */
+    limit?: number;
+}

package/dist/storages/functions.d.ts

@@ -0,0 +1,31 @@
+import { PlaceStorage } from './storage.class';
+import { PlaceStorageQueryOptions } from './interfaces';
+/**
+ * Query the available storages
+ * @param query_params Query parameters to add to the request URL
+ */
+export declare function queryStorages(query_params?: PlaceStorageQueryOptions): import('..').QueryResponse<PlaceStorage>;
+/**
+ * Get the data for a storage
+ * @param id ID of the storage to retrieve
+ * @param query_params Query parameters to add to the request URL
+ */
+export declare function showStorage(id: string, query_params?: Record<string, any>): import('rxjs').Observable<PlaceStorage>;
+/**
+ * Update a storage in the database
+ * @param id ID of the storage
+ * @param form_data New values for the storage
+ * @param method HTTP verb to use on request. Defaults to `patch`
+ */
+export declare function updateStorage(id: string, form_data: Partial<PlaceStorage>, method?: 'put' | 'patch'): import('rxjs').Observable<PlaceStorage>;
+/**
+ * Add a new storage to the database
+ * @param form_data Storage data
+ */
+export declare function addStorage(form_data: Partial<PlaceStorage>): import('rxjs').Observable<PlaceStorage>;
+/**
+ * Remove a storage from the database
+ * @param id ID of the storage
+ * @param query_params Query parameters to add to the request URL
+ */
+export declare function removeStorage(id: string, query_params?: Record<string, any>): import('rxjs').Observable<import('../utilities/types').HashMap<any>>;

package/dist/storages/interfaces.d.ts

@@ -0,0 +1,6 @@
+import { PlaceResourceQueryOptions } from '../resources/interface';
+/** Mapping of available query parameters for the storages index endpoint */
+export interface PlaceStorageQueryOptions extends PlaceResourceQueryOptions {
+    /** Return storages which are in the authority provided */
+    auth_id?: string;
+}