@alpaca-open-api/core 0.1.0-rc.0

package/dist/generated/broker/model/reverseSplitActivityV2.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { CommonSplitStockActivityV2 } from './commonSplitStockActivityV2.js';
+/**
+ * Reverse stock split
+ */
+export type ReverseSplitActivityV2 = CommonSplitStockActivityV2 & {
+    /**
+       * The ex_date for this corporate action
+       * @minLength 1
+       */
+    ex_date?: string;
+    /** Symbol of the new security after the split */
+    new_symbol?: string;
+    /**
+       * The record_date for this corporate action
+       * @minLength 1
+       */
+    record_date?: string;
+    /** The symbol of the security involved with the activity */
+    symbol: string;
+};

package/dist/generated/broker/model/rightsDistributionActivityV2.d.ts

@@ -0,0 +1,44 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { CommonCaActivityV2 } from './commonCaActivityV2.js';
+/**
+ * Rights distribution
+ */
+export type RightsDistributionActivityV2 = CommonCaActivityV2 & {
+    /**
+       * The ex_date for this corporate action
+       * @minLength 1
+       */
+    ex_date?: string;
+    /** The expiration date for the rights distribution */
+    expiration_date?: string;
+    /** The new CUSIP */
+    new_cusip: string;
+    /** The new quantity */
+    new_qty: string;
+    /** The new symbol */
+    new_symbol: string;
+    /**
+       * The payable_date for this corporate action
+       * @minLength 1
+       */
+    payable_date?: string;
+    /** The rate for the rights distribution */
+    rate: string;
+    /**
+       * The record_date for this corporate action
+       * @minLength 1
+       */
+    record_date?: string;
+    /** The source CUSIP */
+    source_cusip: string;
+    /** The source quantity */
+    source_qty: string;
+    /** The source symbol */
+    source_symbol: string;
+};

package/dist/generated/broker/model/rightsSubscriptionElectionActivityV2.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { CommonNTAActivityV2 } from './commonNTAActivityV2.js';
+import type { CommonVOFSubtypeActivityV2 } from './commonVOFSubtypeActivityV2.js';
+export type RightsSubscriptionElectionActivityV2 = CommonNTAActivityV2 & CommonVOFSubtypeActivityV2;

package/dist/generated/broker/model/sDIVActivityV2.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { CommonCaActivityV2 } from './commonCaActivityV2.js';
+import type { CommonSDIVActivityV2 } from './commonSDIVActivityV2.js';
+/**
+ * Stock dividend
+ */
+export type SDIVActivityV2 = CommonCaActivityV2 & CommonSDIVActivityV2 & {
+    /** Quantity of shares entitled to receive the dividend */
+    entitled_qty: string;
+    /** The total number of shares after the dividend */
+    new_qty: string;
+    /** The paid quantity */
+    paid_qty: string;
+};

package/dist/generated/broker/model/settlementAccount.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { TransmitterInfo } from './transmitterInfo.js';
+export interface SettlementAccount {
+    /** The account number of the client account to settle */
+    account_number: string;
+    amount: string;
+    transmitter_info: TransmitterInfo;
+}

package/dist/generated/broker/model/settlementResponse.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { JITAssetClass } from './jITAssetClass.js';
+import type { SettlementStatus } from './settlementStatus.js';
+/**
+ * A settlement response, either from creation or retrieval
+ */
+export interface SettlementResponse {
+    additional_info?: string;
+    asset_class?: JITAssetClass;
+    completed_at?: string;
+    created_at: string;
+    /** The currency of the settlement. Only applicable to JIT settlements. */
+    currency?: string;
+    id: string;
+    /** The total interest amount accrued on the transfers included in this settlement. Only applicable for instant funding settlements. */
+    interest_amount?: string;
+    /** The reason for failure, if applicable */
+    reason?: string;
+    source_account_number?: string;
+    status: SettlementStatus;
+    total_amount: string;
+    updated_at: string;
+}

package/dist/generated/broker/model/settlementStatus.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * Values:
+ *  * `PENDING`: Created and waiting to be processed
+ *  * `AWAITING_ADDITIONAL_FUNDS`: Waiting for additional funds to be deposited
+ *  * `COMPLETED`: All transactions are reconciled
+ *  * `FAILED`: Attempt to process this settlement has failed. If this is observed
+ *   additional remittance information may be required, or one of the transfers being settled
+ *   accrued additional interest since the settlement was created.
+ */
+export type SettlementStatus = typeof SettlementStatus[keyof typeof SettlementStatus];
+export declare const SettlementStatus: {
+    readonly PENDING: "PENDING";
+    readonly AWAITING_ADDITIONAL_FUNDS: "AWAITING_ADDITIONAL_FUNDS";
+    readonly COMPLETED: "COMPLETED";
+    readonly FAILED: "FAILED";
+};

package/dist/generated/broker/model/settlementTransfer.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { TransmitterInfo } from './transmitterInfo.js';
+export interface SettlementTransfer {
+    instant_transfer_id: string;
+    transmitter_info: TransmitterInfo;
+}

package/dist/generated/broker/model/settlementsResponse.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { SettlementResponse } from './settlementResponse.js';
+/**
+ * Response to a successful settlements request
+ */
+export interface SettlementsResponse {
+    settlements: SettlementResponse[];
+}

package/dist/generated/broker/model/skippedOrder.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * Skipped orders model contains information for such orders that the rebalancing engine didn't send to our order system due to some validation issues.
+ */
+export interface SkippedOrder {
+    /** Currency of the order */
+    currency?: string;
+    /** Notional value of the order */
+    notional?: string;
+    /** Reason for the order being skipped */
+    reason: string;
+    /** Formatted error message with the cause of the skip */
+    reason_details: string;
+    /** Side of the order (buy, sell, sell_short) */
+    side?: string;
+    /** Symbol for which the adjustment was skipped */
+    symbol: string;
+}

package/dist/generated/broker/model/sortOrder.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export type SortOrder = typeof SortOrder[keyof typeof SortOrder];
+export declare const SortOrder: {
+    readonly ASC: "ASC";
+    readonly DESC: "DESC";
+};

package/dist/generated/broker/model/sortParameter.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export type SortParameter = typeof SortParameter[keyof typeof SortParameter];
+export declare const SortParameter: {
+    readonly asc: "asc";
+    readonly desc: "desc";
+};

package/dist/generated/broker/model/spOutlook.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * A Standard & Poor's rating outlook indicates S&P's view regarding the potential direction of a long-term credit rating over the intermediate term (2 years for investment grade, 1 year for speculative grade)
+ */
+export type SpOutlook = typeof SpOutlook[keyof typeof SpOutlook];
+export declare const SpOutlook: {
+    readonly positive: "positive";
+    readonly negative: "negative";
+    readonly developing: "developing";
+    readonly stable: "stable";
+    readonly not_rated: "not_rated";
+    readonly not_meaningful: "not_meaningful";
+};

package/dist/generated/broker/model/spinoffActivityV2.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+import type { CommonCaActivityV2 } from './commonCaActivityV2.js';
+import type { CommonSpinoffActivityV2 } from './commonSpinoffActivityV2.js';
+/**
+ * Spinoff
+ */
+export type SpinoffActivityV2 = CommonCaActivityV2 & CommonSpinoffActivityV2 & {
+    /** The new quantity */
+    new_qty: string;
+    /** The source quantity */
+    source_qty: string;
+};

package/dist/generated/broker/model/startParameter.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * The first date to retrieve data for (inclusive). Default: today.
+ */
+export type StartParameter = string;

package/dist/generated/broker/model/statusFundingEvent.d.ts

@@ -0,0 +1,112 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+/**
+ * Represents a change in a Funding entity's status, sent over the events streaming api. Currently, the suppported entities are: bank relationships, bank wires, transfers and funding wallets.
+ */
+export interface StatusFundingEvent {
+    /**
+       * Account UUID
+       * @minLength 1
+       */
+    account_id: string;
+    /**
+       * Timestamp of when the transfer status changed
+       * @minLength 1
+       */
+    at: string;
+    /**
+       * Correspondent's code
+       * @minLength 1
+       * @maxLength 4
+       */
+    correspondent: string;
+    /**
+       * Entity's UUID
+       * @minLength 1
+       */
+    entity_id: string;
+    /**
+       * Valid values are BankRelationship, WireBank, Transfer and FundingWallet.
+       * @minLength 1
+       */
+    entity_type: string;
+    /**
+       * lexically sortable, monotonically increasing character array
+       * @minLength 1
+       */
+    event_id: string;
+    /** Used when an a bank relationship is rejected, a wire bank is canceled, etc. */
+    reason?: string;
+    /**
+       * Valid values are based on entity type:
+       * - BankRelationship:
+       *   - QUEUED
+       *   - CANCEL_REQUESTED
+       *   - CANCEL_SENT
+       *   - CANCEL_FAILED
+       *   - PENDING
+       *   - SENT_TO_CLEARING
+       *   - APPROVED
+       *   - CANCELED
+       *   - REJECTED
+       * - WireBank:
+       *   - QUEUED
+       *   - SENT_TO_CLEARING
+       *   - APPROVED
+       *   - CANCELED
+       *   - REJECTED
+       * - Transfer:
+       *   - QUEUED
+       *   - APPROVAL_PENDING
+       *   - CANCELED
+       *   - EXPIRED
+       *   - APPROVED
+       *   - REJECTED
+       *   - SENT_TO_CLEARING
+       *   - COMPLETE
+       *   - RETURNED
+       * - FundingWallet:
+       *   - active
+       *   - pending
+       */
+    status_from?: string;
+    /**
+       * Valid values are based on entity type:
+       * - BankRelationship:
+       *   - QUEUED
+       *   - CANCEL_REQUESTED
+       *   - CANCEL_SENT
+       *   - CANCEL_FAILED
+       *   - PENDING
+       *   - SENT_TO_CLEARING
+       *   - APPROVED
+       *   - CANCELED
+       *   - REJECTED
+       * - WireBank:
+       *   - QUEUED
+       *   - SENT_TO_CLEARING
+       *   - APPROVED
+       *   - CANCELED
+       *   - REJECTED
+       * - Transfer:
+       *   - QUEUED
+       *   - APPROVAL_PENDING
+       *   - CANCELED
+       *   - EXPIRED
+       *   - APPROVED
+       *   - REJECTED
+       *   - SENT_TO_CLEARING
+       *   - COMPLETE
+       *   - RETURNED
+       * - FundingWallet:
+       *   - active
+       *   - pending
+       * @minLength 1
+       */
+    status_to: string;
+}

package/dist/generated/broker/model/streetAddress.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export type StreetAddress = string;

package/dist/generated/broker/model/subscribeToActivitiesSSEParams.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export type SubscribeToActivitiesSSEParams = {
+    /**
+     * Format: RFC3339 or YYYY-MM-DD
+     */
+    since?: string;
+    /**
+     * Format: RFC3339 or YYYY-MM-DD
+     */
+    until?: string;
+    since_id?: string;
+    until_id?: string;
+};

package/dist/generated/broker/model/subscribeToAdminActionSSEParams.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export type SubscribeToAdminActionSSEParams = {
+    /**
+     * Format: RFC3339 or YYYY-MM-DD
+     */
+    since?: string;
+    /**
+     * Format: RFC3339 or YYYY-MM-DD
+     */
+    until?: string;
+    since_id?: string;
+    until_id?: string;
+};

package/dist/generated/broker/model/subscribeToFundingStatusSSEParams.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export type SubscribeToFundingStatusSSEParams = {
+    /**
+     * Format: YYYY-MM-DD
+     */
+    since?: string;
+    /**
+     * Format: YYYY-MM-DD
+     */
+    until?: string;
+    since_id?: string;
+    until_id?: string;
+};

package/dist/generated/broker/model/subscribeToIPOEventsSSEParams.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export type SubscribeToIPOEventsSSEParams = {
+    /**
+     * Format: RFC3339 or YYYY-MM-DD
+     */
+    since?: string;
+    /**
+     * Format: RFC3339 or YYYY-MM-DD
+     */
+    until?: string;
+    /**
+     * ULID `event_id` to resume the stream from. The first event returned will be the one immediately after `since_id`.
+     */
+    since_id?: string;
+    /**
+     * ULID `event_id` at which the stream will end (inclusive). Useful for backfills.
+     */
+    until_id?: string;
+};

package/dist/generated/broker/model/subscribeToJournalStatusSSEParams.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export type SubscribeToJournalStatusSSEParams = {
+    /**
+     * Format: YYYY-MM-DD
+     */
+    since?: string;
+    /**
+     * Format: YYYY-MM-DD
+     */
+    until?: string;
+    since_id?: number;
+    until_id?: number;
+    since_ulid?: string;
+    until_ulid?: string;
+    id?: string;
+};

package/dist/generated/broker/model/subscribeToJournalStatusV2SSEParams.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export type SubscribeToJournalStatusV2SSEParams = {
+    /**
+     * Format: YYYY-MM-DD
+     */
+    since?: string;
+    /**
+     * Format: YYYY-MM-DD
+     */
+    until?: string;
+    since_id?: string;
+    until_id?: string;
+    id?: string;
+};

package/dist/generated/broker/model/subscribeToSystemEventV2SSEParams.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export type SubscribeToSystemEventV2SSEParams = {
+    /**
+     * Format: YYYY-MM-DD
+     */
+    since?: string;
+    /**
+     * Format: YYYY-MM-DD
+     */
+    until?: string;
+    since_id?: string;
+    until_id?: string;
+};

package/dist/generated/broker/model/subscribeToTradeSSEParams.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export type SubscribeToTradeSSEParams = {
+    /**
+     * Format: YYYY-MM-DD
+     */
+    since?: string;
+    /**
+     * Format: YYYY-MM-DD
+     */
+    until?: string;
+    since_id?: number;
+    until_id?: number;
+    since_ulid?: string;
+    until_ulid?: string;
+};

package/dist/generated/broker/model/subscribeToTradeV2SSEParams.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export type SubscribeToTradeV2SSEParams = {
+    /**
+     * Format: YYYY-MM-DD
+     */
+    since?: string;
+    /**
+     * Format: YYYY-MM-DD
+     */
+    until?: string;
+    since_id?: string;
+    until_id?: string;
+};

package/dist/generated/broker/model/subscribeToTransferStatusSSEParams.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export type SubscribeToTransferStatusSSEParams = {
+    /**
+     * Format: YYYY-MM-DD
+     */
+    since?: string;
+    /**
+     * Format: YYYY-MM-DD
+     */
+    until?: string;
+    since_id?: number;
+    until_id?: number;
+    since_ulid?: string;
+    until_ulid?: string;
+};

package/dist/generated/broker/model/suscribeToAccountStatusSSEParams.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Generated by orval v8.18.0 🍺
+ * Do not edit manually.
+ * Broker API
+ * Open brokerage accounts, enable stock, options and crypto trading. Manage the ongoing user experience and brokerage customer lifecycle with the Alpaca Broker API
+ * OpenAPI spec version: 1.1.1
+ */
+export type SuscribeToAccountStatusSSEParams = {
+    /**
+     * Format: YYYY-MM-DD
+     */
+    since?: string;
+    /**
+     * Format: YYYY-MM-DD
+     */
+    until?: string;
+    since_id?: number;
+    until_id?: number;
+    since_ulid?: string;
+    until_ulid?: string;
+    id?: string;
+};