import * as z from "zod"; import { OpenEnum } from "../../types/enums.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; /** * The percentage used to determine the proportion of the deliverable asset(s) or cash assigned to each option contract in a settlement or corporate action scenario. */ export type AllocationPercentage = { /** * The decimal value, as a string; Refer to [Google’s Decimal type protocol buffer](https://github.com/googleapis/googleapis/blob/40203ca1880849480bbff7b8715491060bbccdf1/google/type/decimal.proto#L33) for details */ value?: string | undefined; }; /** * The cash amount of the deliverable */ export type CashAmount = { /** * The decimal value, as a string; Refer to [Google’s Decimal type protocol buffer](https://github.com/googleapis/googleapis/blob/40203ca1880849480bbff7b8715491060bbccdf1/google/type/decimal.proto#L33) for details */ value?: string | undefined; }; /** * The cash type of the deliverable */ export declare enum CashType { CashTypeUnspecified = "CASH_TYPE_UNSPECIFIED", CashDifferential = "CASH_DIFFERENTIAL", CashFixed = "CASH_FIXED" } /** * The cash type of the deliverable */ export type CashTypeOpen = OpenEnum; /** * The quantity of the deliverable */ export type OptionDeliverableQuantity = { /** * The decimal value, as a string; Refer to [Google’s Decimal type protocol buffer](https://github.com/googleapis/googleapis/blob/40203ca1880849480bbff7b8715491060bbccdf1/google/type/decimal.proto#L33) for details */ value?: string | undefined; }; /** * Specifies the timeline for settling a transaction */ export declare enum SettlementConvention { SettlementConventionUnspecified = "SETTLEMENT_CONVENTION_UNSPECIFIED", TPlus0 = "T_PLUS_0", TPlus1 = "T_PLUS_1" } /** * Specifies the timeline for settling a transaction */ export type SettlementConventionOpen = OpenEnum; /** * Indicates the current status of the settlement process for the deliverable asset(s) tied to an option, such as regular settlement or delayed. */ export declare enum SettlementStatus { SettlementStatusUnspecified = "SETTLEMENT_STATUS_UNSPECIFIED", Regular = "REGULAR", Delayed = "DELAYED" } /** * Indicates the current status of the settlement process for the deliverable asset(s) tied to an option, such as regular settlement or delayed. */ export type SettlementStatusOpen = OpenEnum; /** * OptionDeliverable */ export type OptionDeliverable = { /** * The percentage used to determine the proportion of the deliverable asset(s) or cash assigned to each option contract in a settlement or corporate action scenario. */ allocationPercentage?: AllocationPercentage | null | undefined; /** * The Ascend asset id associated with this deliverable, populated when we are able to find an asset with a matching cusip in the US */ assetId?: string | undefined; /** * The cash amount of the deliverable */ cashAmount?: CashAmount | null | undefined; /** * The cash type of the deliverable */ cashType?: CashTypeOpen | undefined; /** * The cusip of the deliverable, if provided by OCC */ cusip?: string | undefined; /** * When a deliverable is pending a NameChange or SymbolChange, the pending_cusip field may be populated with the new cusip */ pendingCusip?: string | undefined; /** * The quantity of the deliverable */ quantity?: OptionDeliverableQuantity | null | undefined; /** * Specifies the timeline for settling a transaction */ settlementConvention?: SettlementConventionOpen | undefined; /** * Indicates the current status of the settlement process for the deliverable asset(s) tied to an option, such as regular settlement or delayed. */ settlementStatus?: SettlementStatusOpen | undefined; }; /** @internal */ export declare const AllocationPercentage$inboundSchema: z.ZodType; /** @internal */ export type AllocationPercentage$Outbound = { value?: string | undefined; }; /** @internal */ export declare const AllocationPercentage$outboundSchema: z.ZodType; /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ export declare namespace AllocationPercentage$ { /** @deprecated use `AllocationPercentage$inboundSchema` instead. */ const inboundSchema: z.ZodType; /** @deprecated use `AllocationPercentage$outboundSchema` instead. */ const outboundSchema: z.ZodType; /** @deprecated use `AllocationPercentage$Outbound` instead. */ type Outbound = AllocationPercentage$Outbound; } export declare function allocationPercentageToJSON(allocationPercentage: AllocationPercentage): string; export declare function allocationPercentageFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const CashAmount$inboundSchema: z.ZodType; /** @internal */ export type CashAmount$Outbound = { value?: string | undefined; }; /** @internal */ export declare const CashAmount$outboundSchema: z.ZodType; /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ export declare namespace CashAmount$ { /** @deprecated use `CashAmount$inboundSchema` instead. */ const inboundSchema: z.ZodType; /** @deprecated use `CashAmount$outboundSchema` instead. */ const outboundSchema: z.ZodType; /** @deprecated use `CashAmount$Outbound` instead. */ type Outbound = CashAmount$Outbound; } export declare function cashAmountToJSON(cashAmount: CashAmount): string; export declare function cashAmountFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const CashType$inboundSchema: z.ZodType; /** @internal */ export declare const CashType$outboundSchema: z.ZodType; /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ export declare namespace CashType$ { /** @deprecated use `CashType$inboundSchema` instead. */ const inboundSchema: z.ZodType; /** @deprecated use `CashType$outboundSchema` instead. */ const outboundSchema: z.ZodType; } /** @internal */ export declare const OptionDeliverableQuantity$inboundSchema: z.ZodType; /** @internal */ export type OptionDeliverableQuantity$Outbound = { value?: string | undefined; }; /** @internal */ export declare const OptionDeliverableQuantity$outboundSchema: z.ZodType; /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ export declare namespace OptionDeliverableQuantity$ { /** @deprecated use `OptionDeliverableQuantity$inboundSchema` instead. */ const inboundSchema: z.ZodType; /** @deprecated use `OptionDeliverableQuantity$outboundSchema` instead. */ const outboundSchema: z.ZodType; /** @deprecated use `OptionDeliverableQuantity$Outbound` instead. */ type Outbound = OptionDeliverableQuantity$Outbound; } export declare function optionDeliverableQuantityToJSON(optionDeliverableQuantity: OptionDeliverableQuantity): string; export declare function optionDeliverableQuantityFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const SettlementConvention$inboundSchema: z.ZodType; /** @internal */ export declare const SettlementConvention$outboundSchema: z.ZodType; /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ export declare namespace SettlementConvention$ { /** @deprecated use `SettlementConvention$inboundSchema` instead. */ const inboundSchema: z.ZodType; /** @deprecated use `SettlementConvention$outboundSchema` instead. */ const outboundSchema: z.ZodType; } /** @internal */ export declare const SettlementStatus$inboundSchema: z.ZodType; /** @internal */ export declare const SettlementStatus$outboundSchema: z.ZodType; /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ export declare namespace SettlementStatus$ { /** @deprecated use `SettlementStatus$inboundSchema` instead. */ const inboundSchema: z.ZodType; /** @deprecated use `SettlementStatus$outboundSchema` instead. */ const outboundSchema: z.ZodType; } /** @internal */ export declare const OptionDeliverable$inboundSchema: z.ZodType; /** @internal */ export type OptionDeliverable$Outbound = { allocation_percentage?: AllocationPercentage$Outbound | null | undefined; asset_id?: string | undefined; cash_amount?: CashAmount$Outbound | null | undefined; cash_type?: string | undefined; cusip?: string | undefined; pending_cusip?: string | undefined; quantity?: OptionDeliverableQuantity$Outbound | null | undefined; settlement_convention?: string | undefined; settlement_status?: string | undefined; }; /** @internal */ export declare const OptionDeliverable$outboundSchema: z.ZodType; /** * @internal * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module. */ export declare namespace OptionDeliverable$ { /** @deprecated use `OptionDeliverable$inboundSchema` instead. */ const inboundSchema: z.ZodType; /** @deprecated use `OptionDeliverable$outboundSchema` instead. */ const outboundSchema: z.ZodType; /** @deprecated use `OptionDeliverable$Outbound` instead. */ type Outbound = OptionDeliverable$Outbound; } export declare function optionDeliverableToJSON(optionDeliverable: OptionDeliverable): string; export declare function optionDeliverableFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=optiondeliverable.d.ts.map