@trakit/commands 0.0.21 → 0.0.23

package/Accounts/Users/Requests/PayUserStateGet.d.ts

@@ -0,0 +1,17 @@
+import { JsonObject } from "@trakit/objects";
+import { IPayDeletable } from "../../../API/Requests/IPayDeletable";
+import { Reply } from "../../../API/Responses/Reply";
+import { PayUser } from "./PayUser";
+/**
+ * Gets details of the specified {@link UserState}.
+ */
+export declare class PayUserStateGet extends PayUser implements IPayDeletable {
+    /**
+     * When true, the command will also return a deleted {@link UserState} (if it exists).
+     */
+    includeDeleted: boolean;
+    constructor(json?: JsonObject);
+    createReply(json: JsonObject): Reply;
+    toJSON(): JsonObject;
+}
+//# sourceMappingURL=PayUserStateGet.d.ts.map

package/Accounts/Users/Requests/PayUserStateList.d.ts

@@ -0,0 +1,42 @@
+import { JsonObject } from "@trakit/objects";
+import { IPayDeletable } from "../../../API/Requests/IPayDeletable";
+import { IPayListByCompany } from "../../../API/Requests/IPayListByCompany";
+import { ParamId } from "../../../API/Requests/Parameters/ParamId";
+import { Payload } from "../../../API/Requests/Payload";
+import { Reply } from "../../../API/Responses/Reply";
+/**
+ * Gets a list of {@link UserState}s.
+ */
+export declare abstract class PayUserStateList extends Payload implements IPayDeletable {
+    /**
+     * When true, the command will also return a deleted {@link UserState} (if it exists).
+     */
+    includeDeleted: boolean;
+    constructor(json?: JsonObject);
+    toJSON(): JsonObject;
+}
+/**
+ * Gets the list of {@link UserState}s for the specified {@link Company}.
+ */
+export declare class PayUserStateListByCompany extends PayUserStateList implements IPayListByCompany {
+    /**
+     * Identifier of the {@link Company} to which this collection belongs.
+     */
+    company: ParamId;
+    constructor(json?: JsonObject);
+    createReply(json: JsonObject): Reply;
+    toJSON(): JsonObject;
+}
+/**
+ * Gets the list of {@link UserState}s for the specified {@link UserGroup}.
+ */
+export declare class PayUserStateListByUserGroup extends PayUserStateList {
+    /**
+     * Identifier of the {@link UserGroup} to which this collection belongs.
+     */
+    userGroup: ParamId;
+    constructor(json?: JsonObject);
+    createReply(json: JsonObject): Reply;
+    toJSON(): JsonObject;
+}
+//# sourceMappingURL=PayUserStateList.d.ts.map

package/Accounts/Users/Responses/RepUserStateGet.d.ts

@@ -0,0 +1,16 @@
+import { JsonObject, nothing, ulong, User, UserState } from "@trakit/objects";
+import { ReplySyncGetPiece } from "../../../API/Responses/ReplySyncGet";
+/**
+ * A container for the {@link userGeneral}.
+ */
+export declare class RepUserStateGet extends ReplySyncGetPiece<UserState> {
+    /**
+     * The requested {@link UserState}.
+     */
+    userSetting: UserState | nothing;
+    constructor(json: JsonObject);
+    protected _createBlank(): User;
+    getObject(): UserState;
+    getCompanyId(): ulong;
+}
+//# sourceMappingURL=RepUserStateGet.d.ts.map

package/Accounts/Users/Responses/RepUserStateList.d.ts

@@ -0,0 +1,41 @@
+import { codified, email, guid, JsonObject, nothing, ulong, User, UserState } from "@trakit/objects";
+import { ContentId } from "../../../API/Responses/Content/ContentId";
+import { ContentIdCompany } from "../../../API/Responses/Content/ContentIdCompany";
+import { ReplySyncListPiece } from "../../../API/Responses/ReplySyncList";
+/**
+ * A container for the requested {@link UserState}s.
+ */
+export declare abstract class RepUserStateList extends ReplySyncListPiece<UserState> {
+    /**
+     * The list of requested {@link UserState}s.
+     */
+    userSetting: UserState[];
+    constructor(json: JsonObject);
+    getList(): UserState[];
+    protected _createBlank(): User;
+}
+/**
+ * A container owner {@link Company} of the collection.
+ */
+export declare class RepUserStateListByCompany extends RepUserStateList {
+    /**
+     * Identifier of the {@link Company} to which this collection belongs.
+     */
+    company: ContentId | nothing;
+    constructor(json: JsonObject);
+    _filterCollection(pair: [ulong | guid | email | codified | string, UserState], index: number): boolean;
+    getCompanyId(): ulong;
+}
+/**
+ * A container owner {@link UserGroup} of the collection.
+ */
+export declare class RepUserStateListByUserGroup extends RepUserStateList {
+    /**
+     * Identifier of the {@link UserGroup} to which this collection belongs.
+     */
+    userGroup: ContentIdCompany | nothing;
+    constructor(json: JsonObject);
+    _filterCollection(pair: [ulong | guid | email | codified | string, UserState], index: number): boolean;
+    getCompanyId(): ulong;
+}
+//# sourceMappingURL=RepUserStateList.d.ts.map

package/WebSocket/Requests/Parameters/SubscriptionType.d.ts

@@ -199,6 +199,16 @@ export declare enum SubscriptionType {
      * @see {@link UserAdvanced}
      */
     userAdvanced = "userAdvanced",
+    /**
+     * User information such as permissions and group membership.
+     * @see {@link UserAuthentication}
+     */
+    userAuthentication = "userAuthentication",
+    /**
+     * User information such as permissions and group membership.
+     * @see {@link UserState}
+     */
+    userState = "userState",
     /**
      * Group information for easy access control.
      * @see {@link UserGroup}

package/index.d.ts

@@ -82,8 +82,8 @@ import { PayUserGet } from "./Accounts/Users/Requests/PayUserGet";
 import { PayUserListByCompany } from "./Accounts/Users/Requests/PayUserList";
 import { PayUserMerge } from "./Accounts/Users/Requests/PayUserMerge";
 import { PayUserRestore } from "./Accounts/Users/Requests/PayUserRestore";
-import { PayUserSettingGet } from "./Accounts/Users/Requests/PayUserSettingGet";
-import { PayUserSettingListByCompany, PayUserSettingListByUserGroup } from "./Accounts/Users/Requests/PayUserSettingList";
+import { PayUserStateGet } from "./Accounts/Users/Requests/PayUserStateGet";
+import { PayUserStateListByCompany, PayUserStateListByUserGroup } from "./Accounts/Users/Requests/PayUserStateList";
 import { RepUserAdvancedGet } from "./Accounts/Users/Responses/RepUserAdvancedGet";
 import { RepUserAdvancedListByCompany, RepUserAdvancedListByUserGroup } from "./Accounts/Users/Responses/RepUserAdvancedList";
 import { RepUserAuthenticationGet } from "./Accounts/Users/Responses/RepUserAuthenticationGet";
@@ -96,8 +96,8 @@ import { RepUserGeneralListByCompany, RepUserGeneralListByUserGroup } from "./Ac
 import { RepUserGet } from "./Accounts/Users/Responses/RepUserGet";
 import { RepUserListByCompany } from "./Accounts/Users/Responses/RepUserList";
 import { RepUserMerge } from "./Accounts/Users/Responses/RepUserMerge";
-import { RepUserSettingGet } from "./Accounts/Users/Responses/RepUserSettingGet";
-import { RepUserSettingListByCompany, RepUserSettingListByUserGroup } from "./Accounts/Users/Responses/RepUserSettingList";
+import { RepUserStateGet } from "./Accounts/Users/Responses/RepUserStateGet";
+import { RepUserStateListByCompany, RepUserStateListByUserGroup } from "./Accounts/Users/Responses/RepUserStateList";
 import { IPayDeletable } from "./API/Requests/IPayDeletable";
 import { IPayListByAsset } from "./API/Requests/IPayListByAsset";
 import { IPayListByBillingProfile } from "./API/Requests/IPayListByBillingProfile";
@@ -580,7 +580,7 @@ import { RepSubscriptionList } from "./WebSocket/Responses/RepSubscriptionList";
 /**
  * Version number for this release.
  */
-export declare const version = "0.0.21";
+export declare const version = "0.0.23";
 /**
  * Command request payloads and parameter classes.
  */
@@ -593,7 +593,7 @@ export { ContentCode, ContentCodeCompany, ContentCodeDeleted, ContentId, Content
  * Error messages and details for responses.
  */
 export { ErrorCode, ErrorDetail, ErrorDetailBadIds, ErrorDetailBadIndexes, ErrorDetailBadKeys, ErrorDetailBatch, ErrorDetailContactInUse, ErrorDetailCount, ErrorDetailEnum, ErrorDetailEscalation, ErrorDetailExternals, ErrorDetailFormTemplateInUse, ErrorDetailInput, ErrorDetailLocked, ErrorDetailMinMax, ErrorDetailParent, ErrorDetailParse, ErrorDetailPhone, ErrorDetailSecret, ErrorDetailStack, ErrorDetailThrottled, ErrorDetailType, ErrorDetailUserGroupInUse };
-export { ParamContactMerge, ParamHandle, ParamMachineMerge, ParamPermission, ParamSelfContactMerge, ParamUserGroupMerge, ParamUserMerge, PayContact, PayContactBatchDelete, PayContactBatchMerge, PayContactDelete, PayContactGet, PayContactListByCompany, PayContactMerge, PayContactRestore, PayMachineBatchDelete, PayMachineBatchMerge, PayMachineDelete, PayMachineGet, PayMachineListByCompany, PayMachineMerge, PayMachineRestore, PaySelfContact, PaySelfGet, PaySelfLogin, PaySelfLogout, PaySelfPassword, PaySelfPreferences, PaySessionDelete, PaySessionGet, PaySessionListByCompany, PaySessionListByUser, PayUserAdvancedGet, PayUserAdvancedListByCompany, PayUserAdvancedListByUserGroup, PayUserAuthenticationGet, PayUserAuthenticationListByCompany, PayUserAuthenticationListByUserGroup, PayUserBatchDelete, PayUserBatchMerge, PayUserDelete, PayUserGeneralGet, PayUserGeneralListByCompany, PayUserGeneralListByUserGroup, PayUserGet, PayUserGroupBatchDelete, PayUserGroupBatchMerge, PayUserGroupDelete, PayUserGroupGet, PayUserGroupListByCompany, PayUserGroupMerge, PayUserGroupRestore, PayUserListByCompany, PayUserMerge, PayUserRestore, PayUserSettingGet, PayUserSettingListByCompany, PayUserSettingListByUserGroup, RepContactBatchDelete, RepContactBatchMerge, RepContactDelete, RepContactGet, RepContactListByCompany, RepContactMerge, RepMachineBatchDelete, RepMachineBatchMerge, RepMachineDelete, RepMachineGet, RepMachineListByCompany, RepMachineListByUserGroup, RepMachineMerge, RepSelfContact, RepSelfGet, RepSelfLogout, RepSelfPassword, RepSelfPreferences, RepSessionDelete, RepSessionGet, RepSessionListByCompany, RepSessionListByUser, RepUserAdvancedGet, RepUserAdvancedListByCompany, RepUserAdvancedListByUserGroup, RepUserAuthenticationGet, RepUserAuthenticationListByCompany, RepUserAuthenticationListByUserGroup, RepUserBatchDelete, RepUserBatchMerge, RepUserDelete, RepUserGeneralGet, RepUserGeneralListByCompany, RepUserGeneralListByUserGroup, RepUserGet, RepUserGroupBatchDelete, RepUserGroupBatchMerge, RepUserGroupDelete, RepUserGroupGet, RepUserGroupListByCompany, RepUserGroupMerge, RepUserListByCompany, RepUserMerge, RepUserSettingGet, RepUserSettingListByCompany, RepUserSettingListByUserGroup, SessionHandle };
+export { ParamContactMerge, ParamHandle, ParamMachineMerge, ParamPermission, ParamSelfContactMerge, ParamUserGroupMerge, ParamUserMerge, PayContact, PayContactBatchDelete, PayContactBatchMerge, PayContactDelete, PayContactGet, PayContactListByCompany, PayContactMerge, PayContactRestore, PayMachineBatchDelete, PayMachineBatchMerge, PayMachineDelete, PayMachineGet, PayMachineListByCompany, PayMachineMerge, PayMachineRestore, PaySelfContact, PaySelfGet, PaySelfLogin, PaySelfLogout, PaySelfPassword, PaySelfPreferences, PaySessionDelete, PaySessionGet, PaySessionListByCompany, PaySessionListByUser, PayUserAdvancedGet, PayUserAdvancedListByCompany, PayUserAdvancedListByUserGroup, PayUserAuthenticationGet, PayUserAuthenticationListByCompany, PayUserAuthenticationListByUserGroup, PayUserBatchDelete, PayUserBatchMerge, PayUserDelete, PayUserGeneralGet, PayUserGeneralListByCompany, PayUserGeneralListByUserGroup, PayUserGet, PayUserGroupBatchDelete, PayUserGroupBatchMerge, PayUserGroupDelete, PayUserGroupGet, PayUserGroupListByCompany, PayUserGroupMerge, PayUserGroupRestore, PayUserListByCompany, PayUserMerge, PayUserRestore, PayUserStateGet, PayUserStateListByCompany, PayUserStateListByUserGroup, RepContactBatchDelete, RepContactBatchMerge, RepContactDelete, RepContactGet, RepContactListByCompany, RepContactMerge, RepMachineBatchDelete, RepMachineBatchMerge, RepMachineDelete, RepMachineGet, RepMachineListByCompany, RepMachineListByUserGroup, RepMachineMerge, RepSelfContact, RepSelfGet, RepSelfLogout, RepSelfPassword, RepSelfPreferences, RepSessionDelete, RepSessionGet, RepSessionListByCompany, RepSessionListByUser, RepUserAdvancedGet, RepUserAdvancedListByCompany, RepUserAdvancedListByUserGroup, RepUserAuthenticationGet, RepUserAuthenticationListByCompany, RepUserAuthenticationListByUserGroup, RepUserBatchDelete, RepUserBatchMerge, RepUserDelete, RepUserGeneralGet, RepUserGeneralListByCompany, RepUserGeneralListByUserGroup, RepUserGet, RepUserGroupBatchDelete, RepUserGroupBatchMerge, RepUserGroupDelete, RepUserGroupGet, RepUserGroupListByCompany, RepUserGroupMerge, RepUserListByCompany, RepUserMerge, RepUserStateGet, RepUserStateListByCompany, RepUserStateListByUserGroup, SessionHandle };
 export { ParamAssetMerge, PayAsset, PayAssetAdvancedGet, PayAssetAdvancedListByCompany, PayAssetAdvancedListByCompanyAndLabels, PayAssetAdvancedListByCompanyAndRefPairs, PayAssetBatchDelete, PayAssetBatchMerge, PayAssetDelete, PayAssetDispatchGet, PayAssetDispatchListByCompany, PayAssetDispatchListByCompanyAndLabels, PayAssetDispatchListByCompanyAndRefPairs, PayAssetDispatchMerge, PayAssetGeneralGet, PayAssetGeneralListByCompany, PayAssetGeneralListByCompanyAndLabels, PayAssetGeneralListByCompanyAndRefPairs, PayAssetGet, PayAssetListByCompany, PayAssetListByCompanyAndLabels, PayAssetListByCompanyAndRefPairs, PayAssetMerge, PayAssetReactivate, PayAssetRestore, PayAssetSuspend, RepAssetAdvancedGet, RepAssetAdvancedListByCompany, RepAssetAdvancedListByCompanyAndLabels, RepAssetAdvancedListByCompanyAndRefPairs, RepAssetBatchMerge, RepAssetDelete, RepAssetDispatchGet, RepAssetDispatchListByCompany, RepAssetDispatchListByCompanyAndLabels, RepAssetDispatchListByCompanyAndRefPairs, RepAssetDispatchMerge, RepAssetGeneralGet, RepAssetGeneralListByCompany, RepAssetGeneralListByCompanyAndLabels, RepAssetGeneralListByCompanyAndRefPairs, RepAssetGet, RepAssetListByCompany, RepAssetListByCompanyAndLabels, RepAssetListByCompanyAndRefPairs, RepAssetMerge, RepAssetSuspend };
 export { ParamBehaviourMerge, ParamBehaviourScriptMerge, PayBehaviour, PayBehaviourBatchDelete, PayBehaviourBatchMerge, PayBehaviourDelete, PayBehaviourGet, PayBehaviourListByCompany, PayBehaviourLogBatchDeleteByAsset, PayBehaviourLogBatchDeleteByBehaviour, PayBehaviourLogBatchDeleteByScript, PayBehaviourLogListByAsset, PayBehaviourLogListByBehaviour, PayBehaviourLogListByScript, PayBehaviourMerge, PayBehaviourRestore, PayBehaviourScript, PayBehaviourScriptBatchDelete, PayBehaviourScriptBatchMerge, PayBehaviourScriptDelete, PayBehaviourScriptGet, PayBehaviourScriptListByCompany, PayBehaviourScriptMerge, PayBehaviourScriptRestore, RepBehaviourBatchDelete, RepBehaviourBatchMerge, RepBehaviourDelete, RepBehaviourGet, RepBehaviourListByCompany, RepBehaviourLogBatchDeleteByAsset, RepBehaviourLogBatchDeleteByBehaviour, RepBehaviourLogBatchDeleteByScript, RepBehaviourLogListByAsset, RepBehaviourLogListByBehaviour, RepBehaviourLogListByScript, RepBehaviourMerge, RepBehaviourScriptBatchDelete, RepBehaviourScriptBatchMerge, RepBehaviourScriptDelete, RepBehaviourScriptGet, RepBehaviourScriptListByCompany, RepBehaviourScriptMerge };
 export { PayCompany, PayCompanyBatchDelete, PayCompanyBatchMerge, PayCompanyDelete, PayCompanyDirectoryGet, PayCompanyDirectoryList, PayCompanyDirectoryListByCompany, PayCompanyGeneralGet, PayCompanyGeneralList, PayCompanyGeneralListByCompany, PayCompanyGet, PayCompanyMerge, PayCompanyPolicyGet, PayCompanyPolicyList, PayCompanyPolicyListByCompany, PayCompanyResellerDelete, PayCompanyResellerGet, PayCompanyResellerList, PayCompanyResellerListByCompany, PayCompanyResellerMerge, PayCompanyResellerRestore, PayCompanyRestore, PayCompanyStyleGet, PayCompanyStyleList, PayCompanyStyleListByCompany, RepCompanyBatchDelete, RepCompanyBatchMerge, RepCompanyDelete, RepCompanyDirectoryGet, RepCompanyDirectoryList, RepCompanyDirectoryListByCompany, RepCompanyGeneralGet, RepCompanyGeneralList, RepCompanyGeneralListByCompany, RepCompanyGet, RepCompanyMerge, RepCompanyPolicyGet, RepCompanyPolicyList, RepCompanyPolicyListByCompany, RepCompanyResellerDelete, RepCompanyResellerGet, RepCompanyResellerList, RepCompanyResellerListByCompany, RepCompanyResellerMerge, RepCompanyStyleGet, RepCompanyStyleList, RepCompanyStyleListByCompany };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@trakit/commands",
   "type": "module",
-  "version": "0.0.21",
+  "version": "0.0.23",
   "main": "./trakit-commands.min.js",
   "types": "./index.d.ts",
   "scripts": {
@@ -30,10 +30,10 @@
   "devDependencies": {
     "@rollup/plugin-terser": "^0.4.4",
     "rollup": "^4.36.0",
-    "rollup-plugin-typescript2": "^0.36.0",
+    "rollup-plugin-typescript2": "^0.37.0",
     "vitest": "^4.0.7"
   },
   "dependencies": {
-    "@trakit/objects": "^0.0.24"
+    "@trakit/objects": "^0.0.26"
   }
 }