connected-spaces-platform.web 4.26.1 → 4.27.0

package/connectedspacesplatform.d.ts

@@ -925,6 +925,16 @@ 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
@@ -4581,6 +4591,11 @@ 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;
         getSpaceEntitySystem(): Multiplayer.SpaceEntitySystem;
         getMultiplayerConnection(): Multiplayer.MultiplayerConnection;
     }
@@ -5215,6 +5230,85 @@ 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 description(): string;
+        set description(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
@@ -5618,6 +5712,8 @@ 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 {
@@ -7118,9 +7214,10 @@ export declare namespace Multiplayer {
     /**
   @ingroup GaussianSplatSpaceComponent
    * @description Data representation of a GaussianSplatSpaceComponent.
-   * Gaussian Splatting is a technique for real-time 3D reconstruction and rendering of an object or environment using images taken from multiple points of view.
-   * Rather than representing the object as a mesh of triangles, which has a surface but nothing inside, it is instead represented as a volume,
-   * comprising a point cloud of splats (like coloured dots), each of which has a position, colour (with alpha) and covariance (scale on 3 axis).
+   * Gaussian Splatting is a technique for real-time 3D reconstruction and rendering of an object or environment using images taken from multiple
+   * points of view. Rather than representing the object as a mesh of triangles, which has a surface but nothing inside, it is instead represented as a
+   * volume, comprising a point cloud of splats (like coloured dots), each of which has a position, colour (with alpha) and covariance (scale on 3
+   * axis).
    */
     class GaussianSplatSpaceComponent extends Multiplayer.ComponentBase implements Multiplayer.IExternalResourceComponent, Multiplayer.IShadowCasterComponent, Multiplayer.ITransformComponent, Multiplayer.IVisibleComponent, INativeResource {
         /** @internal */
@@ -7214,10 +7311,14 @@ export declare namespace Multiplayer {
         @{
         @copydoc IShadowCasterComponent::GetIsShadowCaster()
          */
+        /** @deprecated
+         */
         getIsShadowCaster(): boolean;
         /**
         @copydoc IShadowCasterComponent::SetIsShadowCaster()
          */
+        /** @deprecated
+         */
         setIsShadowCaster(value: boolean): void;
         /**
         @}
@@ -8672,6 +8773,19 @@ export declare namespace Systems {
         delete(): void;
     }
 }
+export declare namespace Systems {
+    class GetShopifyStoresResult extends Systems.ResultBase implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromResultBase(baseInstance: Systems.ResultBase): Systems.GetShopifyStoresResult;
+        /**
+         * @description Retrieves the ShopifyStoreInfo Array being stored.
+         * @return Reference to the shopifystoreinfos
+         */
+        getShopifyStores(): Common.Array<Systems.ShopifyStoreInfo>;
+        delete(): void;
+    }
+}
 export declare namespace Systems {
     class ValidateShopifyStoreResult extends Systems.ResultBase implements INativeResource {
         /** @internal */
@@ -8726,6 +8840,12 @@ export declare namespace Systems {
          * @param callback - Callback when asynchronous task finishes
          */
         getCart(spaceId: string, cartId: string): Promise<Systems.CartInfoResult>;
+        /**
+         * @description Gets all shopify stores for the given user.
+         * @param isActive - Optional bool for filtering returned stores by active status.
+         * @param callback - Callback when asynchronous task finishes
+         */
+        getShopifyStores(isActive: boolean | null): Promise<Systems.GetShopifyStoresResult>;
         /**
          * @description Adds a Shopify store to a space.
          * @param storeName - The store name (URL) to the Shopify store. Do not include the '.shopify.com' part of the url.
@@ -8864,13 +8984,13 @@ export declare namespace Systems {
          * existing values to be empty.
          * /// @param SpaceId csp::common::String : ID of the space the event belongs to.
          * @param eventId - ID of the Event to update.
-         * @param vendor - Enum representing the vendor that the event is created with.
-         * @param vendorEventId - Specifies the event ID in the vendors system.
-         * @param vendorEventUri - Specifies the URI for the event in the vendors system.
-         * @param isTicketingActive - Specifies whether ticketing is currently active for this event.
+         * @param vendor - Optional enum representing the vendor that the event should be updated with.
+         * @param vendorEventId - Optional value to update the event ID in the vendors system with.
+         * @param vendorEventUri - Optional value to update the URI for the event in the vendors system with.
+         * @param isTicketingActive - Optional value to update whether ticketing is currently active for this event.
          * @param callback - Callback providing the TicketedEvent once created.
          */
-        updateTicketedEvent(spaceId: string, eventId: string, vendor: Systems.EventTicketingVendor, vendorEventId: string, vendorEventUri: string, isTicketingActive: boolean): Promise<Systems.TicketedEventResult>;
+        updateTicketedEvent(spaceId: string, eventId: string, vendor: Systems.EventTicketingVendor | null, vendorEventId: string | null, vendorEventUri: string | null, isTicketingActive: boolean | null): Promise<Systems.TicketedEventResult>;
         /**
          * @description Creates a ticketed event for the given space.
          * @param spaceIds - IDs of the spaces to get the events for.
@@ -9001,6 +9121,103 @@ export declare namespace Systems {
         getMaintenanceInfo(): 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 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
@@ -10275,8 +10492,12 @@ export declare namespace Common {
         static ofcsp_systems_ProductMediaInfo(): Array<Systems.ProductMediaInfo>;
         static ofcsp_systems_CartLine(): Array<Systems.CartLine>;
         static ofcsp_systems_ProductInfo(): Array<Systems.ProductInfo>;
+        static ofcsp_systems_ShopifyStoreInfo(): Array<Systems.ShopifyStoreInfo>;
         static ofcsp_systems_TicketedEvent(): Array<Systems.TicketedEvent>;
         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>;
@@ -10311,8 +10532,12 @@ export declare namespace Common {
         static ofcsp_systems_ProductMediaInfo_number(size: number): Array<Systems.ProductMediaInfo>;
         static ofcsp_systems_CartLine_number(size: number): Array<Systems.CartLine>;
         static ofcsp_systems_ProductInfo_number(size: number): Array<Systems.ProductInfo>;
+        static ofcsp_systems_ShopifyStoreInfo_number(size: number): Array<Systems.ShopifyStoreInfo>;
         static ofcsp_systems_TicketedEvent_number(size: number): Array<Systems.TicketedEvent>;
         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>;