@firela/api-types 0.0.0-canary.614ff760 → 0.0.0-canary.6a42fd0e

package/src/generated/services.gen.ts

@@ -97,6 +97,18 @@ import type {
   CommodityControllerGetOrCreateResponse,
   CommodityControllerBulkCreateData,
   CommodityControllerBulkCreateResponse,
+  PriceControllerCreateData,
+  PriceControllerCreateResponse,
+  PriceControllerFindAllData,
+  PriceControllerFindAllResponse,
+  PriceControllerFindOneData,
+  PriceControllerFindOneResponse,
+  PriceControllerUpdateData,
+  PriceControllerUpdateResponse,
+  PriceControllerDeleteData,
+  PriceControllerDeleteResponse,
+  PriceControllerBulkCreateData,
+  PriceControllerBulkCreateResponse,
   RecurringRuleControllerCreateData,
   RecurringRuleControllerCreateResponse,
   RecurringRuleControllerFindAllData,
@@ -171,6 +183,26 @@ import type {
   PropertyControllerUpdateResponse,
   PropertyControllerDeleteData,
   PropertyControllerDeleteResponse,
+  EventControllerCreateData,
+  EventControllerCreateResponse,
+  EventControllerFindAllData,
+  EventControllerFindAllResponse,
+  EventControllerFindOneData,
+  EventControllerFindOneResponse,
+  EventControllerUpdateData,
+  EventControllerUpdateResponse,
+  EventControllerDeleteData,
+  EventControllerDeleteResponse,
+  EventControllerGetSliceData,
+  EventControllerGetSliceResponse,
+  ReconciliationControllerComputeData,
+  ReconciliationControllerComputeResponse,
+  ReconciliationControllerAssertData,
+  ReconciliationControllerAssertResponse,
+  ReconciliationControllerPadData,
+  ReconciliationControllerPadResponse,
+  ReconciliationControllerHistoryData,
+  ReconciliationControllerHistoryResponse,
   ExportControllerExportBeancountResponse,
   FileImportControllerImportFileData,
   FileImportControllerImportFileResponse,
@@ -202,6 +234,10 @@ import type {
   ProviderSyncControllerIsProviderSupportedResponse,
   TelemetryControllerReportTelemetryData,
   TelemetryControllerReportTelemetryResponse,
+  TelemetryControllerReportCoverageMissData,
+  TelemetryControllerReportCoverageMissResponse,
+  TelemetryControllerGetCoverageMetricsData,
+  TelemetryControllerGetCoverageMetricsResponse,
   NlpControllerProcessNaturalLanguageData,
   NlpControllerProcessNaturalLanguageResponse,
   NlpControllerClearSessionData,
@@ -214,8 +250,14 @@ import type {
   DashboardControllerGetAccountsResponse,
   DashboardControllerGetCashFlowData,
   DashboardControllerGetCashFlowResponse,
+  DashboardControllerGetExpensesData,
+  DashboardControllerGetExpensesResponse,
+  HoldingPnlControllerGetHoldingPnlData,
+  HoldingPnlControllerGetHoldingPnlResponse,
   ReportingControllerGetPortfolioTrendsData,
   ReportingControllerGetPortfolioTrendsResponse,
+  ReportingControllerGetCashFlowTrendsData,
+  ReportingControllerGetCashFlowTrendsResponse,
   ReportingControllerGenerateSnapshotData,
   ReportingControllerGenerateSnapshotResponse,
   ReportingControllerBackfillSnapshotsData,
@@ -551,6 +593,7 @@ export class BeanTransactionsService {
    * @param data.status Filter by transaction status
    * @param data.search Search in narration and payee fields (max 200 chars)
    * @param data.accountId Filter by account ID (transactions with postings to this account)
+   * @param data.category Filter by ADR-0075 functional category (Group segment); matches any posting to an Expenses/Income account whose derived Group segment equals this value
    * @returns TransactionListResponseDto Transaction list
    * @throws ApiError
    */
@@ -570,7 +613,8 @@ export class BeanTransactionsService {
         dateTo: data.dateTo,
         status: data.status,
         search: data.search,
-        accountId: data.accountId
+        accountId: data.accountId,
+        category: data.category
       },
       errors: {
         400: 'Validation failed',
@@ -1479,6 +1523,173 @@ export class BeanCommoditiesService {
   }
 }
 
+export class BeanPricesService {
+  /**
+   * Create a new price
+   * Creates a new price entry for the authenticated user
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context
+   * @param data.requestBody
+   * @returns PriceResponseDto Price created successfully
+   * @throws ApiError
+   */
+  public static priceControllerCreate(
+    data: PriceControllerCreateData
+  ): CancelablePromise<PriceControllerCreateResponse> {
+    return __request(OpenAPI, {
+      method: 'POST',
+      url: '/api/v1/{region}/bean/prices',
+      path: {
+        region: data.region
+      },
+      body: data.requestBody,
+      mediaType: 'application/json',
+      errors: {
+        404: 'Currency or quoteCurrency commodity not found',
+        409: 'Price already exists for this currency pair and date'
+      }
+    });
+  }
+
+  /**
+   * List user prices
+   * Returns all price entries for the authenticated user with optional filtering
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context
+   * @param data.currency Filter by currency (e.g., BTC, AAPL, USD)
+   * @param data.quoteCurrency Filter by quote currency (pricing currency, e.g., USD, CNY)
+   * @param data.dateFrom Filter prices from this date (ISO 8601 format)
+   * @param data.dateTo Filter prices to this date (ISO 8601 format)
+   * @param data.search Search term for currency or quoteCurrency (case-insensitive partial match)
+   * @param data.page Page number for pagination (default: 1)
+   * @param data.limit Number of items per page (default: 20, max: 100)
+   * @returns PriceListResponseDto Prices retrieved successfully
+   * @throws ApiError
+   */
+  public static priceControllerFindAll(
+    data: PriceControllerFindAllData
+  ): CancelablePromise<PriceControllerFindAllResponse> {
+    return __request(OpenAPI, {
+      method: 'GET',
+      url: '/api/v1/{region}/bean/prices',
+      path: {
+        region: data.region
+      },
+      query: {
+        currency: data.currency,
+        quoteCurrency: data.quoteCurrency,
+        dateFrom: data.dateFrom,
+        dateTo: data.dateTo,
+        search: data.search,
+        page: data.page,
+        limit: data.limit
+      }
+    });
+  }
+
+  /**
+   * Get price by ID
+   * Returns a single price entry by its ID
+   * @param data The data for the request.
+   * @param data.id Price ID
+   * @param data.region Region code for tenant context
+   * @returns PriceResponseDto Price retrieved successfully
+   * @throws ApiError
+   */
+  public static priceControllerFindOne(
+    data: PriceControllerFindOneData
+  ): CancelablePromise<PriceControllerFindOneResponse> {
+    return __request(OpenAPI, {
+      method: 'GET',
+      url: '/api/v1/{region}/bean/prices/{id}',
+      path: {
+        id: data.id,
+        region: data.region
+      },
+      errors: {
+        404: 'Price not found'
+      }
+    });
+  }
+
+  /**
+   * Update a price
+   * Updates an existing price entry
+   * @param data The data for the request.
+   * @param data.id Price ID
+   * @param data.region Region code for tenant context
+   * @param data.requestBody
+   * @returns PriceResponseDto Price updated successfully
+   * @throws ApiError
+   */
+  public static priceControllerUpdate(
+    data: PriceControllerUpdateData
+  ): CancelablePromise<PriceControllerUpdateResponse> {
+    return __request(OpenAPI, {
+      method: 'PUT',
+      url: '/api/v1/{region}/bean/prices/{id}',
+      path: {
+        id: data.id,
+        region: data.region
+      },
+      body: data.requestBody,
+      mediaType: 'application/json',
+      errors: {
+        404: 'Price not found',
+        409: 'Updated price conflicts with existing price'
+      }
+    });
+  }
+
+  /**
+   * Delete a price
+   * Deletes a price entry (hard delete)
+   * @param data The data for the request.
+   * @param data.id Price ID
+   * @param data.region Region code for tenant context
+   * @returns void Price deleted successfully
+   * @throws ApiError
+   */
+  public static priceControllerDelete(
+    data: PriceControllerDeleteData
+  ): CancelablePromise<PriceControllerDeleteResponse> {
+    return __request(OpenAPI, {
+      method: 'DELETE',
+      url: '/api/v1/{region}/bean/prices/{id}',
+      path: {
+        id: data.id,
+        region: data.region
+      },
+      errors: {
+        404: 'Price not found'
+      }
+    });
+  }
+
+  /**
+   * Bulk create prices
+   * Creates multiple price entries at once (skips duplicates)
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context
+   * @param data.requestBody
+   * @returns PriceResponseDto Prices created successfully
+   * @throws ApiError
+   */
+  public static priceControllerBulkCreate(
+    data: PriceControllerBulkCreateData
+  ): CancelablePromise<PriceControllerBulkCreateResponse> {
+    return __request(OpenAPI, {
+      method: 'POST',
+      url: '/api/v1/{region}/bean/prices/bulk',
+      path: {
+        region: data.region
+      },
+      body: data.requestBody,
+      mediaType: 'application/json'
+    });
+  }
+}
+
 export class RecurringRulesService {
   /**
    * Create a new recurring rule
@@ -2442,6 +2653,287 @@ export class PropertiesService {
   }
 }
 
+export class LifeEventsService {
+  /**
+   * Create a new life event
+   * Creates a new life event entry for the authenticated user. Returns ETag header carrying the row updatedAt.
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context (decorative for life events)
+   * @param data.requestBody
+   * @returns EventResponseDto Life event created successfully
+   * @throws ApiError
+   */
+  public static eventControllerCreate(
+    data: EventControllerCreateData
+  ): CancelablePromise<EventControllerCreateResponse> {
+    return __request(OpenAPI, {
+      method: 'POST',
+      url: '/api/v1/{region}/bean/events',
+      path: {
+        region: data.region
+      },
+      body: data.requestBody,
+      mediaType: 'application/json',
+      errors: {
+        409: 'Life event already exists for this (userId, type, date) combination'
+      }
+    });
+  }
+
+  /**
+   * List user life events
+   * Returns life events for the authenticated user with optional filtering by type, description search, and date range.
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context (decorative for life events)
+   * @param data.type Filter by life event type (exact match)
+   * @param data.q Search term for description (case-insensitive partial match)
+   * @param data.from Filter life events from this date (ISO 8601 format)
+   * @param data.to Filter life events to this date (ISO 8601 format)
+   * @param data.page Page number for pagination (default: 1)
+   * @param data.limit Number of items per page (default: 20, max: 100)
+   * @returns EventListResponseDto Life events retrieved successfully
+   * @throws ApiError
+   */
+  public static eventControllerFindAll(
+    data: EventControllerFindAllData
+  ): CancelablePromise<EventControllerFindAllResponse> {
+    return __request(OpenAPI, {
+      method: 'GET',
+      url: '/api/v1/{region}/bean/events',
+      path: {
+        region: data.region
+      },
+      query: {
+        type: data.type,
+        q: data.q,
+        from: data.from,
+        to: data.to,
+        page: data.page,
+        limit: data.limit
+      }
+    });
+  }
+
+  /**
+   * Get life event by ID
+   * Returns a single life event by its ID. Returns ETag header.
+   * @param data The data for the request.
+   * @param data.id Life event ID
+   * @param data.region Region code for tenant context (decorative for life events)
+   * @returns EventResponseDto Life event retrieved successfully
+   * @throws ApiError
+   */
+  public static eventControllerFindOne(
+    data: EventControllerFindOneData
+  ): CancelablePromise<EventControllerFindOneResponse> {
+    return __request(OpenAPI, {
+      method: 'GET',
+      url: '/api/v1/{region}/bean/events/{id}',
+      path: {
+        id: data.id,
+        region: data.region
+      },
+      errors: {
+        404: 'Life event not found'
+      }
+    });
+  }
+
+  /**
+   * Update a life event
+   * Updates an existing life event. If If-Match header is provided, performs optimistic concurrency check; mismatched updatedAt returns 412.
+   * @param data The data for the request.
+   * @param data.id Life event ID
+   * @param data.region Region code for tenant context (decorative for life events)
+   * @param data.requestBody
+   * @returns EventResponseDto Life event updated successfully
+   * @throws ApiError
+   */
+  public static eventControllerUpdate(
+    data: EventControllerUpdateData
+  ): CancelablePromise<EventControllerUpdateResponse> {
+    return __request(OpenAPI, {
+      method: 'PUT',
+      url: '/api/v1/{region}/bean/events/{id}',
+      path: {
+        id: data.id,
+        region: data.region
+      },
+      body: data.requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: 'If-Match header is not a valid ISO 8601 date',
+        404: 'Life event not found',
+        409: 'Updated event conflicts with an existing (userId, type, date) combination',
+        412: 'If-Match precondition failed (updatedAt mismatch)'
+      }
+    });
+  }
+
+  /**
+   * Delete a life event
+   * Deletes a life event entry (hard delete). Returns 204.
+   * @param data The data for the request.
+   * @param data.id Life event ID
+   * @param data.region Region code for tenant context (decorative for life events)
+   * @returns void Life event deleted successfully
+   * @throws ApiError
+   */
+  public static eventControllerDelete(
+    data: EventControllerDeleteData
+  ): CancelablePromise<EventControllerDeleteResponse> {
+    return __request(OpenAPI, {
+      method: 'DELETE',
+      url: '/api/v1/{region}/bean/events/{id}',
+      path: {
+        id: data.id,
+        region: data.region
+      },
+      errors: {
+        404: 'Life event not found'
+      }
+    });
+  }
+
+  /**
+   * Slice time-series by a life event (Phase 79)
+   * Returns aggregated time-series for postings matching accountPattern within the half-open date range of the given life event.
+   * @param data The data for the request.
+   * @param data.id Life event ID
+   * @param data.accountPattern
+   * @param data.granularity
+   * @param data.region Region code for tenant context (decorative for life events)
+   * @returns unknown Time-series sliced by the life event range
+   * @throws ApiError
+   */
+  public static eventControllerGetSlice(
+    data: EventControllerGetSliceData
+  ): CancelablePromise<EventControllerGetSliceResponse> {
+    return __request(OpenAPI, {
+      method: 'GET',
+      url: '/api/v1/{region}/bean/events/{id}/slice',
+      path: {
+        id: data.id,
+        region: data.region
+      },
+      query: {
+        accountPattern: data.accountPattern,
+        granularity: data.granularity
+      },
+      errors: {
+        400: 'accountPattern query param is empty',
+        404: 'Life event not found'
+      }
+    });
+  }
+}
+
+export class BalanceReconciliationService {
+  /**
+   * Preview reconciliation (book vs actual)
+   * Computes book balance, diff, Beancount-inferred tolerance, and suggested action without persisting.
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context (decorative for reconciliation)
+   * @param data.requestBody
+   * @returns ReconciliationComputeResultDto Reconciliation preview
+   * @throws ApiError
+   */
+  public static reconciliationControllerCompute(
+    data: ReconciliationControllerComputeData
+  ): CancelablePromise<ReconciliationControllerComputeResponse> {
+    return __request(OpenAPI, {
+      method: 'POST',
+      url: '/api/v1/{region}/bean/reconciliations',
+      path: {
+        region: data.region
+      },
+      body: data.requestBody,
+      mediaType: 'application/json',
+      errors: {
+        404: 'Account not found'
+      }
+    });
+  }
+
+  /**
+   * Record a balance assertion
+   * Persists the reconciliation as a BeanBalance assertion (amount = actual, diffAmount = book − actual). Re-reconciling the same day/currency upserts.
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context (decorative for reconciliation)
+   * @param data.requestBody
+   * @returns ReconciliationRecordDto Balance assertion recorded
+   * @throws ApiError
+   */
+  public static reconciliationControllerAssert(
+    data: ReconciliationControllerAssertData
+  ): CancelablePromise<ReconciliationControllerAssertResponse> {
+    return __request(OpenAPI, {
+      method: 'POST',
+      url: '/api/v1/{region}/bean/reconciliations/assert',
+      path: {
+        region: data.region
+      },
+      body: data.requestBody,
+      mediaType: 'application/json',
+      errors: {
+        404: 'Account not found'
+      }
+    });
+  }
+
+  /**
+   * Generate a pad adjusting entry
+   * When book is outside tolerance, synthesizes a Beancount pad transaction (flag P) booking the diff from source_account and persists it. Source defaults to Equity:Opening-Balances.
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context (decorative for reconciliation)
+   * @param data.requestBody
+   * @returns PadResultDto Pad adjusting entry generated
+   * @throws ApiError
+   */
+  public static reconciliationControllerPad(
+    data: ReconciliationControllerPadData
+  ): CancelablePromise<ReconciliationControllerPadResponse> {
+    return __request(OpenAPI, {
+      method: 'POST',
+      url: '/api/v1/{region}/bean/reconciliations/pad',
+      path: {
+        region: data.region
+      },
+      body: data.requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: 'Book already within tolerance — no pad needed',
+        404: 'Account not found'
+      }
+    });
+  }
+
+  /**
+   * List reconciliation history for an account
+   * Returns recorded balance assertions (most recent first). The latest drives the account-detail "Last <date>" badge.
+   * @param data The data for the request.
+   * @param data.accountId BeanAccount id
+   * @param data.region Region code for tenant context (decorative for reconciliation)
+   * @returns ReconciliationRecordDto Reconciliation history
+   * @throws ApiError
+   */
+  public static reconciliationControllerHistory(
+    data: ReconciliationControllerHistoryData
+  ): CancelablePromise<ReconciliationControllerHistoryResponse> {
+    return __request(OpenAPI, {
+      method: 'GET',
+      url: '/api/v1/{region}/bean/accounts/{accountId}/reconciliations',
+      path: {
+        accountId: data.accountId,
+        region: data.region
+      },
+      errors: {
+        404: 'Account not found'
+      }
+    });
+  }
+}
+
 export class BeanExportService {
   /**
    * Export Beancount ledger as ZIP
@@ -2761,7 +3253,7 @@ export class ProviderSyncService {
    *
    * @param data The data for the request.
    * @param data.providerName Provider name
-   * @param data.region Region code
+   * @param data.region Region code for tenant context
    * @param data.requestBody
    * @returns ProviderSyncResponseDto Sync completed successfully
    * @throws ApiError
@@ -2860,6 +3352,54 @@ export class ImportTelemetryService {
       }
     });
   }
+
+  /**
+   * Receive anonymous zero-hit coverage miss report
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context
+   * @param data.requestBody
+   * @returns unknown Coverage miss report received
+   * @throws ApiError
+   */
+  public static telemetryControllerReportCoverageMiss(
+    data: TelemetryControllerReportCoverageMissData
+  ): CancelablePromise<TelemetryControllerReportCoverageMissResponse> {
+    return __request(OpenAPI, {
+      method: 'POST',
+      url: '/api/v1/{region}/bean/import/parser-coverage-miss',
+      path: {
+        region: data.region
+      },
+      body: data.requestBody,
+      mediaType: 'application/json',
+      errors: {
+        401: 'Unauthorized'
+      }
+    });
+  }
+
+  /**
+   * Coverage metrics (uncovered format aggregation)
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context
+   * @param data.topN Top-N uncovered formats (default 10)
+   * @returns unknown Coverage metrics
+   * @throws ApiError
+   */
+  public static telemetryControllerGetCoverageMetrics(
+    data: TelemetryControllerGetCoverageMetricsData
+  ): CancelablePromise<TelemetryControllerGetCoverageMetricsResponse> {
+    return __request(OpenAPI, {
+      method: 'GET',
+      url: '/api/v1/{region}/bean/import/parser-coverage-metrics',
+      path: {
+        region: data.region
+      },
+      query: {
+        topN: data.topN
+      }
+    });
+  }
 }
 
 export class BeanNlpService {
@@ -2980,6 +3520,7 @@ export class DashboardService {
    * @param data.region Region code for tenant context
    * @param data.groupBy Grouping strategy
    * @param data.date Date for balance calculation (ISO 8601 format)
+   * @param data.accountId Scope to a single account (only valid with groupBy=holdingAssetClass, ADR-0105 §6)
    * @returns unknown Accounts retrieved successfully. Response type depends on groupBy parameter.
    * @throws ApiError
    */
@@ -2994,7 +3535,8 @@ export class DashboardService {
       },
       query: {
         groupBy: data.groupBy,
-        date: data.date
+        date: data.date,
+        accountId: data.accountId
       },
       errors: {
         401: 'User not authenticated'
@@ -3029,6 +3571,72 @@ export class DashboardService {
       }
     });
   }
+
+  /**
+   * Get expenses/income grouped by functional category
+   * Returns amounts pre-aggregated by functional category (account-path Group segment) with server-side multi-currency conversion. flow=expense (default) aggregates ^Expenses: accounts; flow=income aggregates ^Income: accounts (issue #518)
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context
+   * @param data.groupBy Grouping strategy
+   * @param data.period Time window (1m = current calendar month)
+   * @param data.flow Account root to aggregate (expense → ^Expenses:, income → ^Income:)
+   * @returns ExpensesByCategoryResponseDto Expenses retrieved successfully
+   * @throws ApiError
+   */
+  public static dashboardControllerGetExpenses(
+    data: DashboardControllerGetExpensesData
+  ): CancelablePromise<DashboardControllerGetExpensesResponse> {
+    return __request(OpenAPI, {
+      method: 'GET',
+      url: '/api/v1/{region}/dashboard/expenses',
+      path: {
+        region: data.region
+      },
+      query: {
+        groupBy: data.groupBy,
+        period: data.period,
+        flow: data.flow
+      },
+      errors: {
+        400: 'Invalid groupBy or period',
+        401: 'User not authenticated'
+      }
+    });
+  }
+}
+
+export class InvestmentService {
+  /**
+   * Get per-holding unrealized + realized P&L
+   * Average-cost unrealized P&L per account × commodity, plus cumulative realized P&L on sold lots (method = FIFO | average, default average).
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context
+   * @param data.asOf As-of date (ISO 8601), defaults to today
+   * @param data.accountId Scope to a single account
+   * @param data.method Realized-P&L lot-matching method (default average). Does not affect the average-cost unrealized basis.
+   * @returns HoldingPnlResponseDto Holding P&L retrieved successfully
+   * @throws ApiError
+   */
+  public static holdingPnlControllerGetHoldingPnl(
+    data: HoldingPnlControllerGetHoldingPnlData
+  ): CancelablePromise<HoldingPnlControllerGetHoldingPnlResponse> {
+    return __request(OpenAPI, {
+      method: 'GET',
+      url: '/api/v1/{region}/investment/holdings/pnl',
+      path: {
+        region: data.region
+      },
+      query: {
+        asOf: data.asOf,
+        accountId: data.accountId,
+        method: data.method
+      },
+      errors: {
+        400: 'Invalid asOf format/value/future date, invalid accountId format, or unsupported method',
+        401: 'User not authenticated'
+      }
+    });
+  }
 }
 
 export class ReportingService {
@@ -3072,6 +3680,42 @@ export class ReportingService {
     });
   }
 
+  /**
+   * Get cash-flow trends
+   *
+   * Monthly income / expense / netSavings over a fixed N-month window
+   * (current month + N−1 prior). Missing months are zero-filled (flow metric).
+   *
+   * **Parameters:**
+   * - `period`: 1m | 3m | 6m | 1y (default 6m)
+   * - `granularity`: accepted for API symmetry; v1 returns month buckets
+   *
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context
+   * @param data.period Time period
+   * @param data.granularity Data granularity (accepted for API symmetry; v1 returns month buckets)
+   * @returns CashFlowTrendsResponseDto Cash-flow trends retrieved successfully
+   * @throws ApiError
+   */
+  public static reportingControllerGetCashFlowTrends(
+    data: ReportingControllerGetCashFlowTrendsData
+  ): CancelablePromise<ReportingControllerGetCashFlowTrendsResponse> {
+    return __request(OpenAPI, {
+      method: 'GET',
+      url: '/api/v1/{region}/reporting/cash-flow/trends',
+      path: {
+        region: data.region
+      },
+      query: {
+        period: data.period,
+        granularity: data.granularity
+      },
+      errors: {
+        401: 'User not authenticated'
+      }
+    });
+  }
+
   /**
    * Generate portfolio snapshot
    *