feat: update types and documentation for usage statistics [SDK-23]

src/modules/Account/Profile.ts

@@ -115,9 +115,25 @@ class Profile extends TagoIOModule<GenericModuleParams> {
   }
 
   /**
-   * List all the usage statistics of your profile
+   * List all the usage statistics of a profile.
+   *
+   * Usage statistics are cumulative: if a service was not used in a time period,
+   * the statistics for that time period will not be in the object.
+   *
    * @param profileID Profile identification
    * @param dateObj Object with date and their timezone
+   *
+   * @returns Array of cumulative usage statistics.
+   *
+   * @example
+   *
+   * ```json
+   * [
+   *   { "time": "2022-01-01T00:00:00.000Z", "input": 5 },
+   *   { "time": "2022-01-01T00:00:00.000Z", "input": 5, "output": 10 },
+   *   { "time": "2022-01-01T00:00:00.000Z", "input": 10, "output": 15 },
+   * ]
+   * ```
    */
   public async usageStatisticList(
     profileID: GenericID,

src/modules/Account/profile.types.ts

@@ -1,4 +1,5 @@
 import { GenericID } from "../../common/common.types";
+import { BillingService } from "./billing.types";
 
 interface ProfileListInfo {
   id: GenericID;
@@ -66,16 +67,17 @@ interface ProfileSummary {
   };
 }
 
-interface UsageStatistic {
-  input: number;
-  input_peak: number;
-  output: number;
-  analysis: number;
-  data_records: number;
+/**
+ * Type for a single usage statistic with timestamp.
+ *
+ * Not all of the services will be present for every statistic, only if for the usage period the service was used.
+ */
+type UsageStatistic = Partial<Record<BillingService, number>> & {
+  /**
+   * Timestamp for the usage statistic.
+   */
   time: Date;
-  sms: number;
-  email: number;
-}
+};
 
 interface AuditLog {
   events?: {