@placeos/ts-client 4.5.0 → 4.6.0

package/dist/api.d.ts

@@ -76,3 +76,5 @@ export { SurveyQuestion } from './staff/questions/model';
 export { addSurvey, querySurveys, removeSurvey, showSurvey, updateSurvey, } from './staff/surveys/functions';
 export type { SurveyQueryOptions, SurveyShowOptions, } from './staff/surveys/interfaces';
 export { Survey, type SurveyPage } from './staff/surveys/model';
+export { PlaceAsset, PlaceAssetCategory, PlaceAssetPurchaseOrder, PlaceAssetType, } from './assets/assets.class';
+export { addAsset, addAssetCategory, addAssetPurchaseOrder, addAssetType, addAssets, queryAssetCategories, queryAssetPurchaseOrders, queryAssetTypes, queryAssets, removeAsset, removeAssetCategory, removeAssetPurchaseOrder, removeAssetType, removeAssets, showAsset, showAssetCategory, showAssetPurchaseOrder, showAssetType, updateAsset, updateAssetCategory, updateAssetPurchaseOrder, updateAssetType, updateAssets, } from './assets/functions';

package/dist/assets/assets.class.d.ts

@@ -0,0 +1,62 @@
+export declare class PlaceAssetCategory {
+    readonly id: string;
+    readonly parent_category_id: string;
+    readonly name: string;
+    readonly description: string;
+    readonly hidden: boolean;
+    readonly created_at: number;
+    readonly updated_at: number;
+    constructor(data: Partial<PlaceAssetCategory>);
+}
+export declare class PlaceAssetPurchaseOrder {
+    readonly id: string;
+    readonly purchase_order_number: string;
+    readonly invoice_number: string;
+    readonly supplier_details: Record<string, string>;
+    readonly purchase_date: number;
+    readonly unit_price: number;
+    readonly expected_service_start_date: number;
+    readonly expected_service_end_date: number;
+    readonly created_at: number;
+    readonly updated_at: number;
+    constructor(data: Partial<PlaceAssetPurchaseOrder>);
+}
+export declare class PlaceAssetType {
+    readonly id: string;
+    readonly category_id: string;
+    readonly name: string;
+    readonly brand: string;
+    readonly description: string;
+    readonly model_number: string;
+    readonly images: string[];
+    readonly created_at: number;
+    readonly updated_at: number;
+    constructor(data: Partial<PlaceAssetType>);
+}
+export declare class PlaceAsset {
+    readonly id: string;
+    readonly parent_id: string;
+    readonly asset_type_id: string;
+    readonly purchase_order_id: string;
+    readonly zone_id: string;
+    readonly identifier: string;
+    readonly serial_number: string;
+    readonly other_data: Record<string, string>;
+    readonly barcode: string;
+    readonly name: string;
+    readonly client_ids: Record<string, string>;
+    readonly map_id: string;
+    readonly bookable: boolean;
+    readonly accessible: boolean;
+    readonly zones: string[];
+    readonly place_groups: string[];
+    readonly assigned_to: string;
+    readonly assigned_name: string;
+    readonly features: string[];
+    readonly images: string[];
+    readonly notes: string;
+    readonly security_system_groups: string[];
+    readonly created_at: number;
+    readonly updated_at: number;
+    constructor(data: Partial<PlaceAsset>);
+}

package/dist/assets/functions.d.ts

@@ -0,0 +1,146 @@
+import { PlaceResourceQueryOptions } from '../resources/interface';
+import { PlaceAsset, PlaceAssetCategory, PlaceAssetPurchaseOrder, PlaceAssetType } from './assets.class';
+/**
+ * Query the available assets
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function queryAssets(query_params?: PlaceResourceQueryOptions): import('..').QueryResponse<PlaceAsset>;
+/**
+ * Get the data for an asset
+ * @param id ID of the asset to retrieve
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function showAsset(id: string, query_params?: Record<string, any>): import('rxjs').Observable<PlaceAsset>;
+/**
+ * Update the asset in the database
+ * @param id ID of the asset
+ * @param form_data New values for the asset
+ * @param query_params Query parameters to add the to request URL
+ * @param method HTTP verb to use on request. Defaults to `patch`
+ */
+export declare function updateAsset(id: string, form_data: Partial<PlaceAsset>, method?: 'put' | 'patch'): import('rxjs').Observable<PlaceAsset>;
+/**
+ * Add a new asset to the database
+ * @param form_data Application data
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function addAsset(form_data: Partial<PlaceAsset>): import('rxjs').Observable<PlaceAsset>;
+/**
+ * Remove an asset from the database
+ * @param id ID of the asset
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function removeAsset(id: string, query_params?: Record<string, any>): import('rxjs').Observable<import('../utilities/types').HashMap<any>>;
+/**
+ * Add a list of new assets to the database
+ * @param form_data List of asset data
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function addAssets(form_data: Partial<PlaceAsset>[]): import('rxjs').Observable<any>;
+/**
+ * Update a list of assets in the database
+ * @param id ID of the asset
+ * @param form_data New values for the asset
+ * @param query_params Query parameters to add the to request URL
+ * @param method HTTP verb to use on request. Defaults to `patch`
+ */
+export declare function updateAssets(form_data: Partial<PlaceAsset>[], method?: 'put' | 'patch'): import('rxjs').Observable<any>;
+/**
+ * Remove an asset from the database
+ * @param id ID of the asset
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function removeAssets(id_list: string[], query_params?: Record<string, any>): import('rxjs').Observable<any>;
+/**
+ * Query the available asset types
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function queryAssetTypes(query_params?: PlaceResourceQueryOptions): import('..').QueryResponse<PlaceAssetType>;
+/**
+ * Get the data for an asset type
+ * @param id ID of the asset type to retrieve
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function showAssetType(id: string, query_params?: Record<string, any>): import('rxjs').Observable<PlaceAssetType>;
+/**
+ * Update the asset type in the database
+ * @param id ID of the asset type
+ * @param form_data New values for the asset
+ * @param query_params Query parameters to add the to request URL
+ * @param method HTTP verb to use on request. Defaults to `patch`
+ */
+export declare function updateAssetType(id: string, form_data: Partial<PlaceAssetType>, method?: 'put' | 'patch'): import('rxjs').Observable<PlaceAssetType>;
+/**
+ * Add a new asset type to the database
+ * @param form_data Application data
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function addAssetType(form_data: Partial<PlaceAssetType>): import('rxjs').Observable<PlaceAssetType>;
+/**
+ * Remove an asset type from the database
+ * @param id ID of the asset type
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function removeAssetType(id: string, query_params?: Record<string, any>): import('rxjs').Observable<import('../utilities/types').HashMap<any>>;
+/**
+ * Query the available asset categories
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function queryAssetCategories(query_params?: PlaceResourceQueryOptions): import('..').QueryResponse<PlaceAssetCategory>;
+/**
+ * Get the data for an asset category
+ * @param id ID of the asset category to retrieve
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function showAssetCategory(id: string, query_params?: Record<string, any>): import('rxjs').Observable<PlaceAssetCategory>;
+/**
+ * Update the asset category in the database
+ * @param id ID of the asset category
+ * @param form_data New values for the asset category
+ * @param query_params Query parameters to add the to request URL
+ * @param method HTTP verb to use on request. Defaults to `patch`
+ */
+export declare function updateAssetCategory(id: string, form_data: Partial<PlaceAssetCategory>, method?: 'put' | 'patch'): import('rxjs').Observable<PlaceAssetCategory>;
+/**
+ * Add a new asset category to the database
+ * @param form_data Asset category data
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function addAssetCategory(form_data: Partial<PlaceAssetCategory>): import('rxjs').Observable<PlaceAssetCategory>;
+/**
+ * Remove an asset category from the database
+ * @param id ID of the asset category
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function removeAssetCategory(id: string, query_params?: Record<string, any>): import('rxjs').Observable<import('../utilities/types').HashMap<any>>;
+/**
+ * Query the available asset purchase orders
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function queryAssetPurchaseOrders(query_params?: PlaceResourceQueryOptions): import('..').QueryResponse<PlaceAssetPurchaseOrder>;
+/**
+ * Get the data for an asset purchase order
+ * @param id ID of the asset purchase order to retrieve
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function showAssetPurchaseOrder(id: string, query_params?: Record<string, any>): import('rxjs').Observable<PlaceAssetPurchaseOrder>;
+/**
+ * Update the asset purchase order in the database
+ * @param id ID of the asset purchase order
+ * @param form_data New values for the asset purchase order
+ * @param query_params Query parameters to add the to request URL
+ * @param method HTTP verb to use on request. Defaults to `patch`
+ */
+export declare function updateAssetPurchaseOrder(id: string, form_data: Partial<PlaceAssetPurchaseOrder>, method?: 'put' | 'patch'): import('rxjs').Observable<PlaceAssetPurchaseOrder>;
+/**
+ * Add a new asset purchase order to the database
+ * @param form_data Asset purchase order data
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function addAssetPurchaseOrder(form_data: Partial<PlaceAssetPurchaseOrder>): import('rxjs').Observable<PlaceAssetPurchaseOrder>;
+/**
+ * Remove an asset purchase order from the database
+ * @param id ID of the asset purchase order
+ * @param query_params Query parameters to add the to request URL
+ */
+export declare function removeAssetPurchaseOrder(id: string, query_params?: Record<string, any>): import('rxjs').Observable<import('../utilities/types').HashMap<any>>;

package/dist/assets/types.d.ts

@@ -0,0 +1 @@
+export {};