connected-spaces-platform.web 4.14.0 → 4.15.1

package/connectedspacesplatform.d.ts

@@ -848,6 +848,38 @@ export declare namespace Systems {
         All = 8
     }
 }
+export declare namespace Systems {
+    /**
+  @ingroup Quota System
+   * @description Data representation period of time.
+   */
+    enum PeriodEnum {
+        Total = 0,
+        CalendarMonth = 1,
+        Hours24 = 2
+    }
+}
+export declare namespace Systems {
+    enum TierFeatures {
+        SpaceOwner = 0,
+        ScopeConcurrentUsers = 1,
+        ObjectCaptureUpload = 2,
+        AudioVideoUpload = 3,
+        TotalUploadSizeInKilobytes = 4,
+        Agora = 5,
+        OpenAI = 6,
+        Shopify = 7,
+        TicketedSpace = 8
+    }
+}
+export declare namespace Systems {
+    enum TierNames {
+        Basic = 0,
+        Premium = 1,
+        Pro = 2,
+        Enterprise = 3
+    }
+}
 export declare namespace Systems {
     enum SpaceAttributes {
         None = 0,
@@ -1453,6 +1485,8 @@ export declare class EndpointURIs extends NativeClassWrapper implements INativeR
     set multiplayerServiceURI(value: string);
     get aggregationServiceURI(): string;
     set aggregationServiceURI(value: string);
+    get trackingServiceURI(): string;
+    set trackingServiceURI(value: string);
 }
 /**
  * @description Holds client data used in requests for all Magnopus Serives.
@@ -4554,6 +4588,11 @@ export declare namespace Systems {
          * @return Pointer to the ecommerce system class
          */
         getECommerceSystem(): Systems.ECommerceSystem;
+        /**
+         * @description Retrieves the Quota system.
+         * @return Pointer to the quota system class
+         */
+        getQuotaSystem(): Systems.QuotaSystem;
     }
 }
 export declare namespace Systems {
@@ -5122,6 +5161,66 @@ export declare namespace Systems {
         set endDateTimestamp(value: string);
     }
 }
+export declare namespace Systems {
+    /**
+  @ingroup Quota System
+   * @description Data representation of a progress of a specific feature.
+   * Limit Value of -1 means unlimited usage
+   */
+    class FeatureLimitInfo extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): FeatureLimitInfo;
+        delete(): void;
+        get featureName(): Systems.TierFeatures;
+        set featureName(value: Systems.TierFeatures);
+        get activityCount(): number;
+        set activityCount(value: number);
+        get limit(): number;
+        set limit(value: number);
+    }
+}
+export declare namespace Systems {
+    /**
+  @ingroup Quota System
+   * @description Data representation of a progress of a specific feature.
+   */
+    class UserTierInfo extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): UserTierInfo;
+        delete(): void;
+        get assignToType(): string;
+        set assignToType(value: string);
+        get assignToId(): string;
+        set assignToId(value: string);
+        get tierName(): Systems.TierNames;
+        set tierName(value: Systems.TierNames);
+    }
+}
+export declare namespace Systems {
+    /**
+  @ingroup Quota System
+   * @description Data representation of a progress of a specific feature.
+   * Limit Value of -1 means unlimited usage
+   */
+    class FeatureQuotaInfo extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): FeatureQuotaInfo;
+        delete(): void;
+        get featureName(): Systems.TierFeatures;
+        set featureName(value: Systems.TierFeatures);
+        get tierName(): Systems.TierNames;
+        set tierName(value: Systems.TierNames);
+        get limit(): number;
+        set limit(value: number);
+        get period(): Systems.PeriodEnum;
+        set period(value: Systems.PeriodEnum);
+        get allowReductions(): boolean;
+        set allowReductions(value: boolean);
+    }
+}
 export declare namespace Systems {
     /**
      * @description A JavaScript based scripting system that can be used to create advanced behaviours and interactions between entities in spaces.
@@ -8899,6 +8998,151 @@ export declare namespace Systems {
         getMaintenanceInfo(): Promise<Systems.MaintenanceInfoResult>;
     }
 }
+export declare namespace Systems {
+    /**
+  @ingroup Quota System
+   * @description Data class used to contain information when receiving an array of feature progress.
+   */
+    class FeaturesLimitResult extends Services.ResultBase implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromResultBase(baseInstance: Services.ResultBase): Systems.FeaturesLimitResult;
+        /**
+         * @description Retrieves the feature progress result.
+         * @return Const array of feature progress class
+         */
+        getFeaturesLimitInfo(): Common.Array<Systems.FeatureLimitInfo>;
+        delete(): void;
+    }
+}
+export declare namespace Systems {
+    /**
+  @ingroup Quota System
+   * @description Data class used to contain information when receiving an array of feature progresses.
+   */
+    class FeatureLimitResult extends Services.ResultBase implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromResultBase(baseInstance: Services.ResultBase): Systems.FeatureLimitResult;
+        /**
+         * @description Retrieves the feature progress result.
+        @returnFeatureProgress : const ref to feature progress class
+         */
+        getFeatureLimitInfo(): Systems.FeatureLimitInfo;
+        delete(): void;
+    }
+}
+export declare namespace Systems {
+    /**
+  @ingroup Quota System
+   * @description Data class used to contain information when receiving user tier information.
+   */
+    class UserTierResult extends Services.ResultBase implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromResultBase(baseInstance: Services.ResultBase): Systems.UserTierResult;
+        /**
+         * @description Retrieves the user tier result.
+        @returnFeatureProgress : const ref to user tier information class
+         */
+        getUserTierInfo(): Systems.UserTierInfo;
+        delete(): void;
+    }
+}
+export declare namespace Systems {
+    /**
+  @ingroup Quota System
+   * @description Data class used to contain information when receiving feature quota information.
+   */
+    class FeatureQuotaResult extends Services.ResultBase implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromResultBase(baseInstance: Services.ResultBase): Systems.FeatureQuotaResult;
+        /**
+         * @description Retrieves the feature quota result.
+        @returnFeatureProgress : const ref to feature quota class
+         */
+        getFeatureQuotaInfo(): Systems.FeatureQuotaInfo;
+        delete(): void;
+    }
+}
+export declare namespace Systems {
+    /**
+  @ingroup Quota System
+   * @description Data class used to contain information when receiving an array of feature quota information.
+   */
+    class FeaturesQuotaResult extends Services.ResultBase implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromResultBase(baseInstance: Services.ResultBase): Systems.FeaturesQuotaResult;
+        /**
+         * @description Retrieves an array of feature quota results.
+        @returnFeatureProgress : const ref to feature quota class
+         */
+        getFeaturesQuotaInfo(): Common.Array<Systems.FeatureQuotaInfo>;
+        delete(): void;
+    }
+}
+export declare namespace Systems {
+    /**
+  @ingroup Quota System
+   * @description Public facing system that allows interfacing with Magnopus Connect Services' Quota Server.
+   * Offers methods for receiving Quota Queries.
+   */
+    class QuotaSystem extends Systems.SystemBase {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static fromSystemBase(baseInstance: Systems.SystemBase): Systems.QuotaSystem;
+        /**
+         * @description Get the total number of Spaces owned by the current user and their tier space limit
+         * @param callback - Callback when asynchronous task finishes
+         */
+        getTotalSpacesOwnedByUser(): Promise<Systems.FeatureLimitResult>;
+        /**
+         * @description Gets total number of user inside of a space and its tier user limit
+         * @param spaceId - Id of the Space
+         * @param callback - Callback when asynchronous task finishes
+         */
+        getConcurrentUsersInSpace(spaceId: string): Promise<Systems.FeatureLimitResult>;
+        /**
+         * @description Get total size of all assets within a space and their tier space size limit
+         * @param spaceId - Id of the Space
+         * @param callback - Callback when asynchronous task finishes
+         */
+        getTotalSpaceSizeInKilobytes(spaceId: string): Promise<Systems.FeatureLimitResult>;
+        /**
+         * @description Get Array of feature progresses for a user and their tier feature limits
+         * @param featureNames - Array of feature names that will be retrieved
+         * @param callback - Callback when asynchronous task finishes
+         */
+        getTierFeatureProgressForUser(featureNames: Common.Array<Systems.TierFeatures>): Promise<Systems.FeaturesLimitResult>;
+        /**
+         * @description Get Array of feature progress for a user Space and its tier feature limits
+         * @param spaceId - Id of the Space
+         * @param featureNames - Array of feature names that will be retrieved
+         * @param callback - Callback when asynchronous task finishes
+         */
+        getTierFeatureProgressForSpace(spaceId: string, featureNames: Common.Array<Systems.TierFeatures>): Promise<Systems.FeaturesLimitResult>;
+        /**
+         * @description Get current users tier information
+         * @param callback - Callback when asynchronous task finishes
+         */
+        getCurrentUserTier(): Promise<Systems.UserTierResult>;
+        /**
+         * @description Get current feature quota information
+         * @param tierName - Name of the tier
+         * @param featureName - Name of the feature
+         * @param callback - Callback when asynchronous task finishes
+         */
+        getTierFeatureQuota(tierName: Systems.TierNames, featureName: Systems.TierFeatures): Promise<Systems.FeatureQuotaResult>;
+        /**
+         * @description Get current array of current feature quota information inside a tier
+         * @param tierName - Name of the tier
+         * @param callback - Callback when asynchronous task finishes
+         */
+        getTierFeaturesQuota(tierName: Systems.TierNames): Promise<Systems.FeaturesQuotaResult>;
+    }
+}
 export declare namespace Systems {
     /**
   @ingroup Settings System
@@ -10030,6 +10274,9 @@ export declare namespace Common {
         static ofcsp_systems_CartLine(): Array<Systems.CartLine>;
         static ofcsp_systems_TicketedEvent(): Array<Systems.TicketedEvent>;
         static ofcsp_systems_MaintenanceInfo(): Array<Systems.MaintenanceInfo>;
+        static ofcsp_systems_FeatureLimitInfo(): Array<Systems.FeatureLimitInfo>;
+        static ofcsp_systems_FeatureQuotaInfo(): Array<Systems.FeatureQuotaInfo>;
+        static ofcsp_systems_TierFeatures(): Array<Systems.TierFeatures>;
         static ofcsp_systems_Site(): Array<Systems.Site>;
         static ofcsp_systems_GeoLocation(): Array<Systems.GeoLocation>;
         static ofcsp_systems_Space(): Array<Systems.Space>;
@@ -10061,6 +10308,9 @@ export declare namespace Common {
         static ofcsp_systems_CartLine_number(size: number): Array<Systems.CartLine>;
         static ofcsp_systems_TicketedEvent_number(size: number): Array<Systems.TicketedEvent>;
         static ofcsp_systems_MaintenanceInfo_number(size: number): Array<Systems.MaintenanceInfo>;
+        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>;
         static ofcsp_systems_Site_number(size: number): Array<Systems.Site>;
         static ofcsp_systems_GeoLocation_number(size: number): Array<Systems.GeoLocation>;
         static ofcsp_systems_Space_number(size: number): Array<Systems.Space>;