connected-spaces-platform.web 5.9.4 → 5.11.0

package/connectedspacesplatform.d.ts

@@ -1032,16 +1032,6 @@ export declare namespace Systems {
         All = 8
     }
 }
-export declare namespace Systems {
-    /**
-     * @description Data representation of User Role in Organization.
-     */
-    enum EOrganizationRole {
-        Member = 0,
-        Administrator = 1,
-        Owner = 2
-    }
-}
 export declare namespace Systems {
     /**
   @ingroup Quota System
@@ -4878,11 +4868,6 @@ export declare namespace Systems {
          * @return Pointer to the quota system class
          */
         getQuotaSystem(): Systems.QuotaSystem;
-        /**
-         * @description Retrieves the Organization system.
-         * @return Pointer to the organization system class
-         */
-        getOrganizationSystem(): Systems.OrganizationSystem;
         /**
          * @description Retrieves the Sequence system.
          * @return Pointer to the sequence system class
@@ -5138,8 +5123,6 @@ export declare namespace Systems {
         set isUnique(value: boolean);
         get version(): string;
         set version(value: string);
-        get organizationId(): string;
-        set organizationId(value: string);
     }
 }
 export declare namespace Systems {
@@ -5679,83 +5662,6 @@ export declare namespace Systems {
         set endDateTimestamp(value: string);
     }
 }
-export declare namespace Systems {
-    /**
-  @ingroup Organization System
-   * @description Data representation of a User's Organization invite.
-   */
-    class InviteOrganizationRoleInfo extends NativeClassWrapper implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        static create(): InviteOrganizationRoleInfo;
-        delete(): void;
-        get userEmail(): string;
-        set userEmail(value: string);
-        get organizationRoles(): Common.Array<Systems.EOrganizationRole>;
-        set organizationRoles(value: Common.Array<Systems.EOrganizationRole>);
-    }
-}
-export declare namespace Systems {
-    /**
-  @ingroup Organization System
-   * @description Data representation of a collection of User Organization invites.
-   */
-    class InviteOrganizationRoleCollection extends NativeClassWrapper implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        static create(): InviteOrganizationRoleCollection;
-        delete(): void;
-        get emailLinkUrl(): string;
-        set emailLinkUrl(value: string);
-        get signupUrl(): string;
-        set signupUrl(value: string);
-        get invitedUserRoles(): Common.Array<Systems.InviteOrganizationRoleInfo>;
-        set invitedUserRoles(value: Common.Array<Systems.InviteOrganizationRoleInfo>);
-    }
-}
-export declare namespace Systems {
-    /**
-  @ingroup Organization System
-   * @description Data representation of a User's role within an Organization.
-   */
-    class OrganizationRoleInfo extends NativeClassWrapper implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        static create(): OrganizationRoleInfo;
-        delete(): void;
-        get userId(): string;
-        set userId(value: string);
-        get organizationRoles(): Common.Array<Systems.EOrganizationRole>;
-        set organizationRoles(value: Common.Array<Systems.EOrganizationRole>);
-    }
-}
-export declare namespace Systems {
-    /**
-  @ingroup Organization System
-   * @description Data representation of an Organization.
-   */
-    class Organization extends NativeClassWrapper implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        static create(): Organization;
-        static create_other(other: Systems.Organization): Organization;
-        delete(): void;
-        get id(): string;
-        set id(value: string);
-        get ownerId(): string;
-        set ownerId(value: string);
-        get createdAt(): string;
-        set createdAt(value: string);
-        get createdBy(): string;
-        set createdBy(value: string);
-        get name(): string;
-        set name(value: string);
-        get members(): Common.Array<Systems.OrganizationRoleInfo>;
-        set members(value: Common.Array<Systems.OrganizationRoleInfo>);
-        get spaceCount(): number;
-        set spaceCount(value: number);
-    }
-}
 export declare namespace Systems {
     /**
   @ingroup Quota System
@@ -5925,6 +5831,8 @@ export declare namespace Systems {
         set description(value: string);
         get attributes(): Systems.SpaceAttributes;
         set attributes(value: Systems.SpaceAttributes);
+        get tags(): Common.Array<string>;
+        set tags(value: Common.Array<string>);
     }
 }
 export declare namespace Systems {
@@ -6183,8 +6091,6 @@ export declare namespace Systems {
         set userId(value: string);
         get deviceId(): string;
         set deviceId(value: string);
-        get organizationIds(): Common.Array<string>;
-        set organizationIds(value: Common.Array<string>);
     }
 }
 export declare namespace Systems {
@@ -6251,8 +6157,6 @@ export declare namespace Systems {
         set displayName(value: string);
         get avatarId(): string;
         set avatarId(value: string);
-        get lastPlatform(): string;
-        set lastPlatform(value: string);
     }
 }
 export declare namespace Systems {
@@ -10542,146 +10446,6 @@ export declare namespace Systems {
         getMaintenanceInfo(maintenanceURL: string): Promise<Systems.MaintenanceInfoResult>;
     }
 }
-export declare namespace Systems {
-    /**
-  @ingroup Organization System
-   * @description Data class used to contain Organization object.
-   */
-    class OrganizationResult extends Systems.ResultBase implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        static fromResultBase(baseInstance: Systems.ResultBase): Systems.OrganizationResult;
-        /**
-         * @description Retrieves the Organization result.
-         * @return Organization object.
-         */
-        getOrganization(): Systems.Organization;
-        delete(): void;
-    }
-}
-export declare namespace Systems {
-    /**
-  @ingroup Organization System
-   * @description Data class used to contain a Users Organization Role Info object.
-   */
-    class OrganizationRolesResult extends Systems.ResultBase implements INativeResource {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        static fromResultBase(baseInstance: Systems.ResultBase): Systems.OrganizationRolesResult;
-        /**
-         * @description Retrieves the Organization Role Info result.
-         * @return Array of Organization Role Info objects.
-         */
-        getOrganizationRoleInfo(): Common.Array<Systems.OrganizationRoleInfo>;
-        delete(): void;
-    }
-}
-export declare namespace Systems {
-    /**
-  @ingroup Quota System
-   * @description Public facing system that allows interfacing with the Organization System.
-   * .
-   */
-    class OrganizationSystem extends Systems.SystemBase {
-        /** @internal */
-        constructor(pointer: NativePointer);
-        static fromSystemBase(baseInstance: Systems.SystemBase): Systems.OrganizationSystem;
-        /**
-         * @description Sets a callback to be executed when a member joins an Organization.
-         * Only one callback may be registered, calling this function again will override whatever was previously set.
-         * @param callback - The callback to execute.
-         */
-        setMemberJoinedOrganizationCallback(callback: (arg1: string) => void): void;
-        /**
-         * @description Create a new Organization.
-         * Only a User with tenant admin permissions can create an Organization.
-         * If the user does not have the required permissions their call will be rejected.
-         * @param organizationOwnerId - Id of the Organization owner.
-         * @param organizationName - The Organization name
-         * @param callback - Callback when asynchronous task finishes.
-         */
-        createOrganization(organizationOwnerId: string, organizationName: string): Promise<Systems.OrganizationResult>;
-        /**
-         * @description Retrieves Organization info for the specified Organization.
-         * If this request is made by a User with an Owner or Admin Organization role, the resultant Organization object will contain an array of
-         * OrganizationRoleInfo objects for each Organization member. If the request is made by a User who does not have the Owner or Admin role, the
-         * resultant Organization object will contain an array with a single OrganizationRoleInfo object which represents them.
-         * @param organizationId - Id of the Organization to retrieve information on. If no Id is specified,
-         * the Id of the Organization the user is currently authenticated against will be used.
-         * @param callback - Callback when asynchronous task finishes.
-         */
-        getOrganization(organizationId: string | null): Promise<Systems.OrganizationResult>;
-        /**
-         * @description Get the Id of the Organization the user is authenticated against.
-         * @return The Id of the Organization the User belongs to.
-         */
-        getCurrentOrganizationId(): string;
-        /**
-         * @description Updates the name and/or the description of the specified Organization.
-         * Only a User with an Organization Owner role can update an Organization. If the user does not have the required Organization role
-         * their call will be rejected.
-         * @param organizationId - Id of the Organization to update. If no Id is specified,
-         * the Id of the Organization the user is currently authenticated against will be used.
-         * @param name - The new Organization name
-         * @param callback - Callback when asynchronous task finishes.
-         */
-        updateOrganization(organizationId: string | null, name: string): Promise<Systems.OrganizationResult>;
-        /**
-         * @description Deactivates the specified Organization.
-         * This call performs a soft-delete of the Organization and will allow for Organization reactivation in the future.
-         * Only A User with owner-level permissions can deactivate an Organization. If the user does not have the required role their call will be
-         * rejected.
-         * @param organizationId - Id of the Organization to deactivate.
-         * @param callback - Callback when asynchronous task finishes.
-         */
-        deactivateOrganization(organizationId: string): Promise<Systems.NullResult>;
-        /**
-         * @description Invites a given email to the User's Organization.
-         * Only a User with an Admin or Owner Organization role can invite people to the organization. If the User does not have the required role their
-         * call will be rejected.
-         * @param organizationId - Id of the Organization the user should be added to. If no Id is specified,
-         * the Id of the Organization the user is currently authenticated against will be used.
-         * @param email - Email to invite to the Organization.
-         * @param organizationRoles - The role/s in the Organization the invited User is to have.
-         * @param emailLinkUrl - Link that will be provided in the invite email
-         * @param signupUrl - Destination link that will be provided in the invite email
-         * @param callback - Callback when asynchronous task finishes.
-         */
-        inviteToOrganization(organizationId: string | null, email: string, organizationRoles: Common.Array<Systems.EOrganizationRole>, emailLinkUrl: string | null, signupUrl: string | null): Promise<Systems.NullResult>;
-        /**
-         * @description Invites all the given emails to the User's Organization.
-         * Only a User with an Admin or Owner Organization role can invite people to the organization. If the User does not have the required role their
-         * call will be rejected.
-         * @param organizationId - Id of the Organization the users should be added to. If no Id is specified,
-         * the Id of the Organization the user is currently authenticated against will be used.
-         * @param inviteUsers - Collection containing the EmailLinkUrl and SignupUrl as well as the emails and
-         * Organization role/s of the Users to be invited.
-         * @param callback - Callback when asynchronous task finishes.
-         */
-        bulkInviteToOrganization(organizationId: string | null, inviteUsers: Systems.InviteOrganizationRoleCollection): Promise<Systems.NullResult>;
-        /**
-         * @description Retrieves the Organisation User Role information for the User Ids that have been passed in.
-         * Only a User with an Admin or Owner Organization role can request the role information for other Organization members.
-         * A User without these roles can only request information about their own Organization role and should pass an array containing only their own
-         * User Id.
-         * @param organizationId - Id of the Organization you want to get user roles for. If no Id is
-         * specified, the Id of the Organization the user is currently authenticated against will be used.
-         * @param userIds - Array of User Ids for which the Organization User Roles will be retrieved.
-         * @param callback - Callback when asynchronous task finishes.
-         */
-        getUserRolesInOrganization(organizationId: string | null, userIds: Common.Array<string>): Promise<Systems.OrganizationRolesResult>;
-        /**
-         * @description Removes a User from the Organization.
-         * Only a User with an Admin or Owner Organization role can remove other Users from the Organization. If the user does not have the required role
-         * their call will be rejected. Anyone can remove themselves from an Organization.
-         * @param organizationId - Id of the Organization you want to remove a user from. If no Id is
-         * specified, the Id of the Organization the user is currently authenticated against will be used.
-         * @param userId - Unique ID of User.
-         * @param callback - Callback when asynchronous task finishes.
-         */
-        removeUserFromOrganization(organizationId: string | null, userId: string): Promise<Systems.NullResult>;
-    }
-}
 export declare namespace Systems {
     /**
   @ingroup Quota System
@@ -11144,8 +10908,6 @@ export declare namespace Systems {
         set moderatorIds(value: Common.Array<string>);
         get bannedUserIds(): Common.Array<string>;
         set bannedUserIds(value: Common.Array<string>);
-        get organizationId(): string;
-        set organizationId(value: string);
     }
 }
 export declare namespace Systems {
@@ -11234,7 +10996,6 @@ export declare namespace Systems {
         constructor(pointer: NativePointer);
         static fromResultBase(baseInstance: Systems.ResultBase): Systems.SpaceMetadataResult;
         getMetadata(): Common.Map<string, string>;
-        getTags(): Common.Array<string>;
         delete(): void;
     }
 }
@@ -11376,9 +11137,10 @@ export declare namespace Systems {
          * @param description - If a new description is provided it will be used to update the space
          * description
          * @param type - If a new type is provided it will be used to update the space type
+         * @param tags - If new tags are provided they will be used to update the Space
          * @param callback - Callback when asynchronous task finishes
          */
-        updateSpace(spaceId: string, name: string | null, description: string | null, type: Systems.SpaceAttributes | null): Promise<Systems.BasicSpaceResult>;
+        updateSpace(spaceId: string, name: string | null, description: string | null, type: Systems.SpaceAttributes | null, tags: Common.Array<string> | null): Promise<Systems.BasicSpaceResult>;
         /**
          * @description Deletes a given space and the corresponding UserService group.
          * @param space - Space to delete
@@ -11399,9 +11161,14 @@ export declare namespace Systems {
          * @param resultsSkip - Number of result entries that will be skipped from the result. for no skip pass nullptr.
          * @param resultsMax - Maximum number of result entries to be retrieved. for all available result entries pass
          * nullptr.
+         * @param mustContainTags - Array of tags that must be present in retrieved
+         * spaces. For no mandatory tags pass nullptr.
+         * @param mustExcludeTags - Array of tags that must not be present in retrieved
+         * spaces. For no excluded tags pass nullptr.
+         * @param mustIncludeAllTags - Whether all tags in @param MustContainTags must be present in retrieved spaces.
          * @param callback - Callback when asynchronous task finishes
          */
-        getSpacesByAttributes(isDiscoverable: boolean | null, isArchived: boolean | null, requiresInvite: boolean | null, resultsSkip: number | null, resultsMax: number | null): Promise<Systems.BasicSpacesResult>;
+        getSpacesByAttributes(isDiscoverable: boolean | null, isArchived: boolean | null, requiresInvite: boolean | null, resultsSkip: number | null, resultsMax: number | null, mustContainTags: Common.Array<string> | null, mustExcludeTags: Common.Array<string> | null, mustIncludeAllTags: boolean | null): Promise<Systems.BasicSpacesResult>;
         /**
          * @description Retrieves space details corresponding to the provided Space IDs
          * @param requestedSpaceIDs - Array of space ids for which the space details will be retrieved
@@ -11502,11 +11269,9 @@ export declare namespace Systems {
          * @description Updates the Space metadata information with the new one provided
          * @param spaceId - ID of Space for which the metadata will be updated
          * @param newMetadata - New metadata information that will replace the previous one
-         * @param tags - Array of strings that will replace the tags on the space. If unset, the existing tags on
-         * the AssetCollection will be unmodified.
          * @param callback - Callback when asynchronous task finishes
          */
-        updateSpaceMetadata(spaceId: string, newMetadata: Common.Map<string, string>, tags: Common.Array<string> | null): Promise<Systems.NullResult>;
+        updateSpaceMetadata(spaceId: string, newMetadata: Common.Map<string, string>): Promise<Systems.NullResult>;
         /**
          * @description Retrieves Spaces metadata information
          * @param spaces - Spaces for which metadata will be retrieved
@@ -11945,6 +11710,8 @@ export declare namespace Systems {
          * @param password - Csp::common::string
          * @param userHasVerifiedAge - An optional bool to specify whether or not the user has verified that they are over 18
          * @param callback - Callback to call when a response is received
+        @pre One of either UserName or Email must not be empty.
+        @pre Password must not be empty.
          */
         login(userName: string, email: string, password: string, userHasVerifiedAge: boolean | null): Promise<Systems.LoginStateResult>;
         /**
@@ -11953,6 +11720,7 @@ export declare namespace Systems {
          * @param userId - User ID for the previous session
          * @param refreshToken - Refresh token to be used for refreshing the authentication token
          * @param callback - Callback when asynchronous task finishes
+        @pre UserId must not be empty.
          */
         loginWithRefreshToken(userId: string, refreshToken: string): Promise<Systems.LoginStateResult>;
         /**
@@ -12141,9 +11909,6 @@ export declare namespace Common {
         static ofcsp_systems_TicketedEvent(): Array<Systems.TicketedEvent>;
         static ofcsp_systems_HotspotGroup(): Array<Systems.HotspotGroup>;
         static ofcsp_systems_MaintenanceInfo(): Array<Systems.MaintenanceInfo>;
-        static ofcsp_systems_EOrganizationRole(): Array<Systems.EOrganizationRole>;
-        static ofcsp_systems_InviteOrganizationRoleInfo(): Array<Systems.InviteOrganizationRoleInfo>;
-        static ofcsp_systems_OrganizationRoleInfo(): Array<Systems.OrganizationRoleInfo>;
         static ofcsp_systems_FeatureLimitInfo(): Array<Systems.FeatureLimitInfo>;
         static ofcsp_systems_FeatureQuotaInfo(): Array<Systems.FeatureQuotaInfo>;
         static ofcsp_systems_TierFeatures(): Array<Systems.TierFeatures>;
@@ -12185,9 +11950,6 @@ export declare namespace Common {
         static ofcsp_systems_TicketedEvent_number(size: number): Array<Systems.TicketedEvent>;
         static ofcsp_systems_HotspotGroup_number(size: number): Array<Systems.HotspotGroup>;
         static ofcsp_systems_MaintenanceInfo_number(size: number): Array<Systems.MaintenanceInfo>;
-        static ofcsp_systems_EOrganizationRole_number(size: number): Array<Systems.EOrganizationRole>;
-        static ofcsp_systems_InviteOrganizationRoleInfo_number(size: number): Array<Systems.InviteOrganizationRoleInfo>;
-        static ofcsp_systems_OrganizationRoleInfo_number(size: number): Array<Systems.OrganizationRoleInfo>;
         static ofcsp_systems_FeatureLimitInfo_number(size: number): Array<Systems.FeatureLimitInfo>;
         static ofcsp_systems_FeatureQuotaInfo_number(size: number): Array<Systems.FeatureQuotaInfo>;
         static ofcsp_systems_TierFeatures_number(size: number): Array<Systems.TierFeatures>;