connected-spaces-platform.web 5.9.2 → 5.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1032,16 +1032,6 @@ export declare namespace Systems {
1032
1032
  All = 8
1033
1033
  }
1034
1034
  }
1035
- export declare namespace Systems {
1036
- /**
1037
- * @description Data representation of User Role in Organization.
1038
- */
1039
- enum EOrganizationRole {
1040
- Member = 0,
1041
- Administrator = 1,
1042
- Owner = 2
1043
- }
1044
- }
1045
1035
  export declare namespace Systems {
1046
1036
  /**
1047
1037
  @ingroup Quota System
@@ -4878,11 +4868,6 @@ export declare namespace Systems {
4878
4868
  * @return Pointer to the quota system class
4879
4869
  */
4880
4870
  getQuotaSystem(): Systems.QuotaSystem;
4881
- /**
4882
- * @description Retrieves the Organization system.
4883
- * @return Pointer to the organization system class
4884
- */
4885
- getOrganizationSystem(): Systems.OrganizationSystem;
4886
4871
  /**
4887
4872
  * @description Retrieves the Sequence system.
4888
4873
  * @return Pointer to the sequence system class
@@ -5138,8 +5123,6 @@ export declare namespace Systems {
5138
5123
  set isUnique(value: boolean);
5139
5124
  get version(): string;
5140
5125
  set version(value: string);
5141
- get organizationId(): string;
5142
- set organizationId(value: string);
5143
5126
  }
5144
5127
  }
5145
5128
  export declare namespace Systems {
@@ -5679,83 +5662,6 @@ export declare namespace Systems {
5679
5662
  set endDateTimestamp(value: string);
5680
5663
  }
5681
5664
  }
5682
- export declare namespace Systems {
5683
- /**
5684
- @ingroup Organization System
5685
- * @description Data representation of a User's Organization invite.
5686
- */
5687
- class InviteOrganizationRoleInfo extends NativeClassWrapper implements INativeResource {
5688
- /** @internal */
5689
- constructor(pointer: NativePointer);
5690
- static create(): InviteOrganizationRoleInfo;
5691
- delete(): void;
5692
- get userEmail(): string;
5693
- set userEmail(value: string);
5694
- get organizationRoles(): Common.Array<Systems.EOrganizationRole>;
5695
- set organizationRoles(value: Common.Array<Systems.EOrganizationRole>);
5696
- }
5697
- }
5698
- export declare namespace Systems {
5699
- /**
5700
- @ingroup Organization System
5701
- * @description Data representation of a collection of User Organization invites.
5702
- */
5703
- class InviteOrganizationRoleCollection extends NativeClassWrapper implements INativeResource {
5704
- /** @internal */
5705
- constructor(pointer: NativePointer);
5706
- static create(): InviteOrganizationRoleCollection;
5707
- delete(): void;
5708
- get emailLinkUrl(): string;
5709
- set emailLinkUrl(value: string);
5710
- get signupUrl(): string;
5711
- set signupUrl(value: string);
5712
- get invitedUserRoles(): Common.Array<Systems.InviteOrganizationRoleInfo>;
5713
- set invitedUserRoles(value: Common.Array<Systems.InviteOrganizationRoleInfo>);
5714
- }
5715
- }
5716
- export declare namespace Systems {
5717
- /**
5718
- @ingroup Organization System
5719
- * @description Data representation of a User's role within an Organization.
5720
- */
5721
- class OrganizationRoleInfo extends NativeClassWrapper implements INativeResource {
5722
- /** @internal */
5723
- constructor(pointer: NativePointer);
5724
- static create(): OrganizationRoleInfo;
5725
- delete(): void;
5726
- get userId(): string;
5727
- set userId(value: string);
5728
- get organizationRoles(): Common.Array<Systems.EOrganizationRole>;
5729
- set organizationRoles(value: Common.Array<Systems.EOrganizationRole>);
5730
- }
5731
- }
5732
- export declare namespace Systems {
5733
- /**
5734
- @ingroup Organization System
5735
- * @description Data representation of an Organization.
5736
- */
5737
- class Organization extends NativeClassWrapper implements INativeResource {
5738
- /** @internal */
5739
- constructor(pointer: NativePointer);
5740
- static create(): Organization;
5741
- static create_other(other: Systems.Organization): Organization;
5742
- delete(): void;
5743
- get id(): string;
5744
- set id(value: string);
5745
- get ownerId(): string;
5746
- set ownerId(value: string);
5747
- get createdAt(): string;
5748
- set createdAt(value: string);
5749
- get createdBy(): string;
5750
- set createdBy(value: string);
5751
- get name(): string;
5752
- set name(value: string);
5753
- get members(): Common.Array<Systems.OrganizationRoleInfo>;
5754
- set members(value: Common.Array<Systems.OrganizationRoleInfo>);
5755
- get spaceCount(): number;
5756
- set spaceCount(value: number);
5757
- }
5758
- }
5759
5665
  export declare namespace Systems {
5760
5666
  /**
5761
5667
  @ingroup Quota System
@@ -5925,6 +5831,8 @@ export declare namespace Systems {
5925
5831
  set description(value: string);
5926
5832
  get attributes(): Systems.SpaceAttributes;
5927
5833
  set attributes(value: Systems.SpaceAttributes);
5834
+ get tags(): Common.Array<string>;
5835
+ set tags(value: Common.Array<string>);
5928
5836
  }
5929
5837
  }
5930
5838
  export declare namespace Systems {
@@ -6183,8 +6091,6 @@ export declare namespace Systems {
6183
6091
  set userId(value: string);
6184
6092
  get deviceId(): string;
6185
6093
  set deviceId(value: string);
6186
- get organizationIds(): Common.Array<string>;
6187
- set organizationIds(value: Common.Array<string>);
6188
6094
  }
6189
6095
  }
6190
6096
  export declare namespace Systems {
@@ -10542,146 +10448,6 @@ export declare namespace Systems {
10542
10448
  getMaintenanceInfo(maintenanceURL: string): Promise<Systems.MaintenanceInfoResult>;
10543
10449
  }
10544
10450
  }
10545
- export declare namespace Systems {
10546
- /**
10547
- @ingroup Organization System
10548
- * @description Data class used to contain Organization object.
10549
- */
10550
- class OrganizationResult extends Systems.ResultBase implements INativeResource {
10551
- /** @internal */
10552
- constructor(pointer: NativePointer);
10553
- static fromResultBase(baseInstance: Systems.ResultBase): Systems.OrganizationResult;
10554
- /**
10555
- * @description Retrieves the Organization result.
10556
- * @return Organization object.
10557
- */
10558
- getOrganization(): Systems.Organization;
10559
- delete(): void;
10560
- }
10561
- }
10562
- export declare namespace Systems {
10563
- /**
10564
- @ingroup Organization System
10565
- * @description Data class used to contain a Users Organization Role Info object.
10566
- */
10567
- class OrganizationRolesResult extends Systems.ResultBase implements INativeResource {
10568
- /** @internal */
10569
- constructor(pointer: NativePointer);
10570
- static fromResultBase(baseInstance: Systems.ResultBase): Systems.OrganizationRolesResult;
10571
- /**
10572
- * @description Retrieves the Organization Role Info result.
10573
- * @return Array of Organization Role Info objects.
10574
- */
10575
- getOrganizationRoleInfo(): Common.Array<Systems.OrganizationRoleInfo>;
10576
- delete(): void;
10577
- }
10578
- }
10579
- export declare namespace Systems {
10580
- /**
10581
- @ingroup Quota System
10582
- * @description Public facing system that allows interfacing with the Organization System.
10583
- * .
10584
- */
10585
- class OrganizationSystem extends Systems.SystemBase {
10586
- /** @internal */
10587
- constructor(pointer: NativePointer);
10588
- static fromSystemBase(baseInstance: Systems.SystemBase): Systems.OrganizationSystem;
10589
- /**
10590
- * @description Sets a callback to be executed when a member joins an Organization.
10591
- * Only one callback may be registered, calling this function again will override whatever was previously set.
10592
- * @param callback - The callback to execute.
10593
- */
10594
- setMemberJoinedOrganizationCallback(callback: (arg1: string) => void): void;
10595
- /**
10596
- * @description Create a new Organization.
10597
- * Only a User with tenant admin permissions can create an Organization.
10598
- * If the user does not have the required permissions their call will be rejected.
10599
- * @param organizationOwnerId - Id of the Organization owner.
10600
- * @param organizationName - The Organization name
10601
- * @param callback - Callback when asynchronous task finishes.
10602
- */
10603
- createOrganization(organizationOwnerId: string, organizationName: string): Promise<Systems.OrganizationResult>;
10604
- /**
10605
- * @description Retrieves Organization info for the specified Organization.
10606
- * If this request is made by a User with an Owner or Admin Organization role, the resultant Organization object will contain an array of
10607
- * OrganizationRoleInfo objects for each Organization member. If the request is made by a User who does not have the Owner or Admin role, the
10608
- * resultant Organization object will contain an array with a single OrganizationRoleInfo object which represents them.
10609
- * @param organizationId - Id of the Organization to retrieve information on. If no Id is specified,
10610
- * the Id of the Organization the user is currently authenticated against will be used.
10611
- * @param callback - Callback when asynchronous task finishes.
10612
- */
10613
- getOrganization(organizationId: string | null): Promise<Systems.OrganizationResult>;
10614
- /**
10615
- * @description Get the Id of the Organization the user is authenticated against.
10616
- * @return The Id of the Organization the User belongs to.
10617
- */
10618
- getCurrentOrganizationId(): string;
10619
- /**
10620
- * @description Updates the name and/or the description of the specified Organization.
10621
- * Only a User with an Organization Owner role can update an Organization. If the user does not have the required Organization role
10622
- * their call will be rejected.
10623
- * @param organizationId - Id of the Organization to update. If no Id is specified,
10624
- * the Id of the Organization the user is currently authenticated against will be used.
10625
- * @param name - The new Organization name
10626
- * @param callback - Callback when asynchronous task finishes.
10627
- */
10628
- updateOrganization(organizationId: string | null, name: string): Promise<Systems.OrganizationResult>;
10629
- /**
10630
- * @description Deactivates the specified Organization.
10631
- * This call performs a soft-delete of the Organization and will allow for Organization reactivation in the future.
10632
- * Only A User with owner-level permissions can deactivate an Organization. If the user does not have the required role their call will be
10633
- * rejected.
10634
- * @param organizationId - Id of the Organization to deactivate.
10635
- * @param callback - Callback when asynchronous task finishes.
10636
- */
10637
- deactivateOrganization(organizationId: string): Promise<Systems.NullResult>;
10638
- /**
10639
- * @description Invites a given email to the User's Organization.
10640
- * 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
10641
- * call will be rejected.
10642
- * @param organizationId - Id of the Organization the user should be added to. If no Id is specified,
10643
- * the Id of the Organization the user is currently authenticated against will be used.
10644
- * @param email - Email to invite to the Organization.
10645
- * @param organizationRoles - The role/s in the Organization the invited User is to have.
10646
- * @param emailLinkUrl - Link that will be provided in the invite email
10647
- * @param signupUrl - Destination link that will be provided in the invite email
10648
- * @param callback - Callback when asynchronous task finishes.
10649
- */
10650
- inviteToOrganization(organizationId: string | null, email: string, organizationRoles: Common.Array<Systems.EOrganizationRole>, emailLinkUrl: string | null, signupUrl: string | null): Promise<Systems.NullResult>;
10651
- /**
10652
- * @description Invites all the given emails to the User's Organization.
10653
- * 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
10654
- * call will be rejected.
10655
- * @param organizationId - Id of the Organization the users should be added to. If no Id is specified,
10656
- * the Id of the Organization the user is currently authenticated against will be used.
10657
- * @param inviteUsers - Collection containing the EmailLinkUrl and SignupUrl as well as the emails and
10658
- * Organization role/s of the Users to be invited.
10659
- * @param callback - Callback when asynchronous task finishes.
10660
- */
10661
- bulkInviteToOrganization(organizationId: string | null, inviteUsers: Systems.InviteOrganizationRoleCollection): Promise<Systems.NullResult>;
10662
- /**
10663
- * @description Retrieves the Organisation User Role information for the User Ids that have been passed in.
10664
- * Only a User with an Admin or Owner Organization role can request the role information for other Organization members.
10665
- * A User without these roles can only request information about their own Organization role and should pass an array containing only their own
10666
- * User Id.
10667
- * @param organizationId - Id of the Organization you want to get user roles for. If no Id is
10668
- * specified, the Id of the Organization the user is currently authenticated against will be used.
10669
- * @param userIds - Array of User Ids for which the Organization User Roles will be retrieved.
10670
- * @param callback - Callback when asynchronous task finishes.
10671
- */
10672
- getUserRolesInOrganization(organizationId: string | null, userIds: Common.Array<string>): Promise<Systems.OrganizationRolesResult>;
10673
- /**
10674
- * @description Removes a User from the Organization.
10675
- * 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
10676
- * their call will be rejected. Anyone can remove themselves from an Organization.
10677
- * @param organizationId - Id of the Organization you want to remove a user from. If no Id is
10678
- * specified, the Id of the Organization the user is currently authenticated against will be used.
10679
- * @param userId - Unique ID of User.
10680
- * @param callback - Callback when asynchronous task finishes.
10681
- */
10682
- removeUserFromOrganization(organizationId: string | null, userId: string): Promise<Systems.NullResult>;
10683
- }
10684
- }
10685
10451
  export declare namespace Systems {
10686
10452
  /**
10687
10453
  @ingroup Quota System
@@ -11144,8 +10910,6 @@ export declare namespace Systems {
11144
10910
  set moderatorIds(value: Common.Array<string>);
11145
10911
  get bannedUserIds(): Common.Array<string>;
11146
10912
  set bannedUserIds(value: Common.Array<string>);
11147
- get organizationId(): string;
11148
- set organizationId(value: string);
11149
10913
  }
11150
10914
  }
11151
10915
  export declare namespace Systems {
@@ -11234,7 +10998,6 @@ export declare namespace Systems {
11234
10998
  constructor(pointer: NativePointer);
11235
10999
  static fromResultBase(baseInstance: Systems.ResultBase): Systems.SpaceMetadataResult;
11236
11000
  getMetadata(): Common.Map<string, string>;
11237
- getTags(): Common.Array<string>;
11238
11001
  delete(): void;
11239
11002
  }
11240
11003
  }
@@ -11376,9 +11139,10 @@ export declare namespace Systems {
11376
11139
  * @param description - If a new description is provided it will be used to update the space
11377
11140
  * description
11378
11141
  * @param type - If a new type is provided it will be used to update the space type
11142
+ * @param tags - If new tags are provided they will be used to update the Space
11379
11143
  * @param callback - Callback when asynchronous task finishes
11380
11144
  */
11381
- updateSpace(spaceId: string, name: string | null, description: string | null, type: Systems.SpaceAttributes | null): Promise<Systems.BasicSpaceResult>;
11145
+ updateSpace(spaceId: string, name: string | null, description: string | null, type: Systems.SpaceAttributes | null, tags: Common.Array<string> | null): Promise<Systems.BasicSpaceResult>;
11382
11146
  /**
11383
11147
  * @description Deletes a given space and the corresponding UserService group.
11384
11148
  * @param space - Space to delete
@@ -11399,9 +11163,14 @@ export declare namespace Systems {
11399
11163
  * @param resultsSkip - Number of result entries that will be skipped from the result. for no skip pass nullptr.
11400
11164
  * @param resultsMax - Maximum number of result entries to be retrieved. for all available result entries pass
11401
11165
  * nullptr.
11166
+ * @param mustContainTags - Array of tags that must be present in retrieved
11167
+ * spaces. For no mandatory tags pass nullptr.
11168
+ * @param mustExcludeTags - Array of tags that must not be present in retrieved
11169
+ * spaces. For no excluded tags pass nullptr.
11170
+ * @param mustIncludeAllTags - Whether all tags in @param MustContainTags must be present in retrieved spaces.
11402
11171
  * @param callback - Callback when asynchronous task finishes
11403
11172
  */
11404
- getSpacesByAttributes(isDiscoverable: boolean | null, isArchived: boolean | null, requiresInvite: boolean | null, resultsSkip: number | null, resultsMax: number | null): Promise<Systems.BasicSpacesResult>;
11173
+ 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>;
11405
11174
  /**
11406
11175
  * @description Retrieves space details corresponding to the provided Space IDs
11407
11176
  * @param requestedSpaceIDs - Array of space ids for which the space details will be retrieved
@@ -11502,11 +11271,9 @@ export declare namespace Systems {
11502
11271
  * @description Updates the Space metadata information with the new one provided
11503
11272
  * @param spaceId - ID of Space for which the metadata will be updated
11504
11273
  * @param newMetadata - New metadata information that will replace the previous one
11505
- * @param tags - Array of strings that will replace the tags on the space. If unset, the existing tags on
11506
- * the AssetCollection will be unmodified.
11507
11274
  * @param callback - Callback when asynchronous task finishes
11508
11275
  */
11509
- updateSpaceMetadata(spaceId: string, newMetadata: Common.Map<string, string>, tags: Common.Array<string> | null): Promise<Systems.NullResult>;
11276
+ updateSpaceMetadata(spaceId: string, newMetadata: Common.Map<string, string>): Promise<Systems.NullResult>;
11510
11277
  /**
11511
11278
  * @description Retrieves Spaces metadata information
11512
11279
  * @param spaces - Spaces for which metadata will be retrieved
@@ -12141,9 +11908,6 @@ export declare namespace Common {
12141
11908
  static ofcsp_systems_TicketedEvent(): Array<Systems.TicketedEvent>;
12142
11909
  static ofcsp_systems_HotspotGroup(): Array<Systems.HotspotGroup>;
12143
11910
  static ofcsp_systems_MaintenanceInfo(): Array<Systems.MaintenanceInfo>;
12144
- static ofcsp_systems_EOrganizationRole(): Array<Systems.EOrganizationRole>;
12145
- static ofcsp_systems_InviteOrganizationRoleInfo(): Array<Systems.InviteOrganizationRoleInfo>;
12146
- static ofcsp_systems_OrganizationRoleInfo(): Array<Systems.OrganizationRoleInfo>;
12147
11911
  static ofcsp_systems_FeatureLimitInfo(): Array<Systems.FeatureLimitInfo>;
12148
11912
  static ofcsp_systems_FeatureQuotaInfo(): Array<Systems.FeatureQuotaInfo>;
12149
11913
  static ofcsp_systems_TierFeatures(): Array<Systems.TierFeatures>;
@@ -12185,9 +11949,6 @@ export declare namespace Common {
12185
11949
  static ofcsp_systems_TicketedEvent_number(size: number): Array<Systems.TicketedEvent>;
12186
11950
  static ofcsp_systems_HotspotGroup_number(size: number): Array<Systems.HotspotGroup>;
12187
11951
  static ofcsp_systems_MaintenanceInfo_number(size: number): Array<Systems.MaintenanceInfo>;
12188
- static ofcsp_systems_EOrganizationRole_number(size: number): Array<Systems.EOrganizationRole>;
12189
- static ofcsp_systems_InviteOrganizationRoleInfo_number(size: number): Array<Systems.InviteOrganizationRoleInfo>;
12190
- static ofcsp_systems_OrganizationRoleInfo_number(size: number): Array<Systems.OrganizationRoleInfo>;
12191
11952
  static ofcsp_systems_FeatureLimitInfo_number(size: number): Array<Systems.FeatureLimitInfo>;
12192
11953
  static ofcsp_systems_FeatureQuotaInfo_number(size: number): Array<Systems.FeatureQuotaInfo>;
12193
11954
  static ofcsp_systems_TierFeatures_number(size: number): Array<Systems.TierFeatures>;