pingram 1.0.34-alpha.1559 → 1.0.34-alpha.1561

package/dist/generated/src/apis/AccountApi.d.ts

@@ -17,6 +17,7 @@ export interface ConfigureSupabaseSMTPRequest {
 export interface GetUsageHistoryRequest {
     startDate: string;
     endDate: string;
+    groupBy?: string;
 }
 export interface ListInvoicesRequest {
     limit?: number;
@@ -92,18 +93,19 @@ export interface AccountApiInterface {
     getUsage(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUsageResponse>;
     /**
      *
-     * @summary Get historical usage for the authenticated account over a date range.
+     * @summary Get historical usage for the authenticated account over a date range, summed by UTC calendar month or billing cycle from daily counts.
      * @param {string} startDate Start date (YYYY-MM-DD) for the range
      * @param {string} endDate End date (YYYY-MM-DD) for the range
+     * @param {string} [groupBy] calendar (UTC months, default) or billing (account billing cycles)
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AccountApiInterface
      */
     getUsageHistoryRaw(requestParameters: GetUsageHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUsageHistoryResponse>>;
     /**
-     * Get historical usage for the authenticated account over a date range.
+     * Get historical usage for the authenticated account over a date range, summed by UTC calendar month or billing cycle from daily counts.
      */
-    getUsageHistory(startDate: string, endDate: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUsageHistoryResponse>;
+    getUsageHistory(startDate: string, endDate: string, groupBy?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUsageHistoryResponse>;
     /**
      *
      * @summary List Stripe invoices for the authenticated account, newest first.
@@ -222,13 +224,13 @@ export declare class AccountApi extends runtime.BaseAPI implements AccountApiInt
      */
     getUsage(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUsageResponse>;
     /**
-     * Get historical usage for the authenticated account over a date range.
+     * Get historical usage for the authenticated account over a date range, summed by UTC calendar month or billing cycle from daily counts.
      */
     getUsageHistoryRaw(requestParameters: GetUsageHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUsageHistoryResponse>>;
     /**
-     * Get historical usage for the authenticated account over a date range.
+     * Get historical usage for the authenticated account over a date range, summed by UTC calendar month or billing cycle from daily counts.
      */
-    getUsageHistory(startDate: string, endDate: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUsageHistoryResponse>;
+    getUsageHistory(startDate: string, endDate: string, groupBy?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUsageHistoryResponse>;
     /**
      * List Stripe invoices for the authenticated account, newest first.
      */

package/dist/generated/src/apis/AccountApi.js

@@ -259,7 +259,7 @@ class AccountApi extends runtime.BaseAPI {
         return await response.value();
     }
     /**
-     * Get historical usage for the authenticated account over a date range.
+     * Get historical usage for the authenticated account over a date range, summed by UTC calendar month or billing cycle from daily counts.
      */
     async getUsageHistoryRaw(requestParameters, initOverrides) {
         if (requestParameters['startDate'] == null) {
@@ -275,6 +275,9 @@ class AccountApi extends runtime.BaseAPI {
         if (requestParameters['endDate'] != null) {
             queryParameters['endDate'] = requestParameters['endDate'];
         }
+        if (requestParameters['groupBy'] != null) {
+            queryParameters['groupBy'] = requestParameters['groupBy'];
+        }
         const headerParameters = {};
         if (this.configuration &&
             (this.configuration.username !== undefined ||
@@ -314,10 +317,10 @@ class AccountApi extends runtime.BaseAPI {
         return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetUsageHistoryResponseFromJSON)(jsonValue));
     }
     /**
-     * Get historical usage for the authenticated account over a date range.
+     * Get historical usage for the authenticated account over a date range, summed by UTC calendar month or billing cycle from daily counts.
      */
-    async getUsageHistory(startDate, endDate, initOverrides) {
-        const response = await this.getUsageHistoryRaw({ startDate: startDate, endDate: endDate }, initOverrides);
+    async getUsageHistory(startDate, endDate, groupBy, initOverrides) {
+        const response = await this.getUsageHistoryRaw({ startDate: startDate, endDate: endDate, groupBy: groupBy }, initOverrides);
         return await response.value();
     }
     /**

package/dist/generated/src/models/GetUsageHistoryQuery.d.ts

@@ -27,6 +27,12 @@ export interface GetUsageHistoryQuery {
      * @memberof GetUsageHistoryQuery
      */
     endDate: string;
+    /**
+     * calendar = UTC calendar months (YYYY-MM). billing = account billing cycles (YYYY-MM-DD period start). Defaults to calendar.
+     * @type {string}
+     * @memberof GetUsageHistoryQuery
+     */
+    groupBy?: string;
 }
 /**
  * Check if a given object implements the GetUsageHistoryQuery interface.

package/dist/generated/src/models/GetUsageHistoryQuery.js

@@ -37,7 +37,8 @@ function GetUsageHistoryQueryFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         startDate: json['startDate'],
-        endDate: json['endDate']
+        endDate: json['endDate'],
+        groupBy: json['groupBy'] == null ? undefined : json['groupBy']
     };
 }
 function GetUsageHistoryQueryToJSON(json) {
@@ -49,6 +50,7 @@ function GetUsageHistoryQueryToJSONTyped(value, ignoreDiscriminator = false) {
     }
     return {
         startDate: value['startDate'],
-        endDate: value['endDate']
+        endDate: value['endDate'],
+        groupBy: value['groupBy']
     };
 }

package/dist/generated/src/models/GetUsageHistoryResponse.d.ts

@@ -17,7 +17,7 @@ import type { GetUsageHistoryResponseItemsInner } from './GetUsageHistoryRespons
  */
 export interface GetUsageHistoryResponse {
     /**
-     * Array of usage items, one per month in the requested range
+     * Array of usage items, one per calendar month or billing cycle in the range
      * @type {Array<GetUsageHistoryResponseItemsInner>}
      * @memberof GetUsageHistoryResponse
      */

package/dist/generated/src/models/GetUsageHistoryResponseItemsInner.d.ts

@@ -17,7 +17,7 @@ import type { GetUsageHistoryResponseItemsInnerCounts } from './GetUsageHistoryR
  */
 export interface GetUsageHistoryResponseItemsInner {
     /**
-     * Year-month (YYYY-MM) for this usage period
+     * YYYY-MM for calendar months, or YYYY-MM-DD billing-period start.
      * @type {string}
      * @memberof GetUsageHistoryResponseItemsInner
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pingram",
-  "version": "1.0.34-alpha.1559",
+  "version": "1.0.34-alpha.1561",
   "description": "Official Node.js SDK for Pingram - Send notifications via Email, SMS, Push, In-App, and more",
   "main": "dist/index.js",
   "module": "dist/index.js",