Add support for querying daily usages by year and monts

datocms · Mar 26, 2024 · e809e54 · e809e54
1 parent 817185f
commit e809e54
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 3 deletions.
diff --git a/packages/dashboard-client/resources.json b/packages/dashboard-client/resources.json
@@ -835,6 +835,7 @@
         "method": "GET",
         "comment": "Retrieve daily usage info for either an account or an organization",
         "optionalRequestBody": false,
+        "queryParamsType": "DailyUsageInstancesHrefSchema",
         "queryParamsRequired": false,
         "responseType": "DailyUsageInstancesTargetSchema",
         "name": "list",

diff --git a/packages/dashboard-client/src/generated/SchemaTypes.ts b/packages/dashboard-client/src/generated/SchemaTypes.ts
@@ -357,6 +357,21 @@ export type DailyUsageType = 'daily_usage';
  * via the `definition` "id".
  */
 export type DailyUsageIdentity = string;
+/**
+ * This interface was referenced by `DailyUsage`'s JSON-Schema
+ * via the `instances.hrefSchema` link.
+ */
+export type DailyUsageInstancesHrefSchema = {
+  /**
+   * Year of the daily usages to retrieve. Defaults to current year.
+   */
+  year?: string;
+  /**
+   * Monthof the daily usages to retrieve. Defaults to current month.
+   */
+  month?: string;
+  [k: string]: unknown;
+};
 /**
  * This interface was referenced by `JobResult`'s JSON-Schema
  * via the `definition` "type".

diff --git a/packages/dashboard-client/src/generated/SimpleSchemaTypes.ts b/packages/dashboard-client/src/generated/SimpleSchemaTypes.ts
@@ -465,6 +465,21 @@ export type DailyUsageType = 'daily_usage';
  * via the `instances.targetSchema` link.
  */
 export type DailyUsageInstancesTargetSchema = DailyUsage[];
+/**
+ * This interface was referenced by `DailyUsage`'s JSON-Schema
+ * via the `instances.hrefSchema` link.
+ */
+export type DailyUsageInstancesHrefSchema = {
+  /**
+   * Year of the daily usages to retrieve. Defaults to current year.
+   */
+  year?: string;
+  /**
+   * Monthof the daily usages to retrieve. Defaults to current month.
+   */
+  month?: string;
+  [k: string]: unknown;
+};
 /**
  * ID of job result
  *

diff --git a/packages/dashboard-client/src/generated/resources/DailyUsage.ts b/packages/dashboard-client/src/generated/resources/DailyUsage.ts
@@ -12,8 +12,8 @@ export default class DailyUsage extends BaseResource {
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
-  list() {
-    return this.rawList().then((body) =>
+  list(queryParams?: SimpleSchemaTypes.DailyUsageInstancesHrefSchema) {
+    return this.rawList(queryParams).then((body) =>
       Utils.deserializeResponseBody<SimpleSchemaTypes.DailyUsageInstancesTargetSchema>(
         body,
       ),
@@ -26,10 +26,13 @@ export default class DailyUsage extends BaseResource {
    * @throws {ApiError}
    * @throws {TimeoutError}
    */
-  rawList(): Promise<SchemaTypes.DailyUsageInstancesTargetSchema> {
+  rawList(
+    queryParams?: SchemaTypes.DailyUsageInstancesHrefSchema,
+  ): Promise<SchemaTypes.DailyUsageInstancesTargetSchema> {
     return this.client.request<SchemaTypes.DailyUsageInstancesTargetSchema>({
       method: 'GET',
       url: '/daily-site-usages',
+      queryParams,
     });
   }
 }