package
0.0.0-20240630234109-2a8940cfaaf3
Repository: https://github.com/jkoelker/cotton.git
Documentation: pkg.go.dev

# Functions

AccountCashEquivalentAsAccountsInstrument is a convenience function that returns AccountCashEquivalent wrapped in AccountsInstrument.
AccountEquityAsAccountsInstrument is a convenience function that returns AccountEquity wrapped in AccountsInstrument.
AccountFixedIncomeAsAccountsInstrument is a convenience function that returns AccountFixedIncome wrapped in AccountsInstrument.
AccountMutualFundAsAccountsInstrument is a convenience function that returns AccountMutualFund wrapped in AccountsInstrument.
AccountOptionAsAccountsInstrument is a convenience function that returns AccountOption wrapped in AccountsInstrument.
CacheExpires helper function to determine remaining time before repeating a request.
CollectiveInvestmentAsTransactionInstrument is a convenience function that returns CollectiveInvestment wrapped in TransactionInstrument.
CurrencyAsTransactionInstrument is a convenience function that returns Currency wrapped in TransactionInstrument.
ForexAsTransactionInstrument is a convenience function that returns Forex wrapped in TransactionInstrument.
FutureAsTransactionInstrument is a convenience function that returns Future wrapped in TransactionInstrument.
IndexAsTransactionInstrument is a convenience function that returns Index wrapped in TransactionInstrument.
IsNil checks if an input is nil.
NewAccount instantiates a new Account object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountAPIOptionDeliverable instantiates a new AccountAPIOptionDeliverable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountAPIOptionDeliverableWithDefaults instantiates a new AccountAPIOptionDeliverable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccountCashEquivalent instantiates a new AccountCashEquivalent object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountCashEquivalentWithDefaults instantiates a new AccountCashEquivalent object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccountEquity instantiates a new AccountEquity object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountEquityWithDefaults instantiates a new AccountEquity object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccountFixedIncome instantiates a new AccountFixedIncome object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountFixedIncomeWithDefaults instantiates a new AccountFixedIncome object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccountMutualFund instantiates a new AccountMutualFund object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountMutualFundWithDefaults instantiates a new AccountMutualFund object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccountNumberHash instantiates a new AccountNumberHash object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountNumberHashWithDefaults instantiates a new AccountNumberHash object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccountOption instantiates a new AccountOption object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountOptionWithDefaults instantiates a new AccountOption object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccountsBaseInstrument instantiates a new AccountsBaseInstrument object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccountsBaseInstrumentWithDefaults instantiates a new AccountsBaseInstrument object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccountWithDefaults instantiates a new Account object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAmountIndicatorFromValue returns a pointer to a valid AmountIndicator for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewAPIClient creates a new API client.
NewApiOrderStatusFromValue returns a pointer to a valid ApiOrderStatus for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewAPIRuleActionFromValue returns a pointer to a valid APIRuleAction for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewAssetTypeFromValue returns a pointer to a valid AssetType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewCollectiveInvestment instantiates a new CollectiveInvestment object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCollectiveInvestmentWithDefaults instantiates a new CollectiveInvestment object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCommission instantiates a new Commission object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCommissionAndFee instantiates a new CommissionAndFee object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCommissionAndFeeWithDefaults instantiates a new CommissionAndFee object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCommissionLeg instantiates a new CommissionLeg object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCommissionLegWithDefaults instantiates a new CommissionLeg object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCommissionValue instantiates a new CommissionValue object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCommissionValueWithDefaults instantiates a new CommissionValue object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCommissionWithDefaults instantiates a new Commission object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewComplexOrderStrategyTypeFromValue returns a pointer to a valid ComplexOrderStrategyType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewConfiguration returns a new Configuration object.
NewCurrency instantiates a new Currency object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCurrencyWithDefaults instantiates a new Currency object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDateParam instantiates a new DateParam object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDateParamWithDefaults instantiates a new DateParam object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDurationFromValue returns a pointer to a valid Duration for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewExecutionLeg instantiates a new ExecutionLeg object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewExecutionLegWithDefaults instantiates a new ExecutionLeg object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFeeLeg instantiates a new FeeLeg object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFeeLegWithDefaults instantiates a new FeeLeg object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFees instantiates a new Fees object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFeesWithDefaults instantiates a new Fees object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFeeTypeFromValue returns a pointer to a valid FeeType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewFeeValue instantiates a new FeeValue object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFeeValueWithDefaults instantiates a new FeeValue object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewForex instantiates a new Forex object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewForexWithDefaults instantiates a new Forex object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewFuture instantiates a new Future object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewFutureWithDefaults instantiates a new Future object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewIndex instantiates a new Index object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewIndexWithDefaults instantiates a new Index object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInstructionFromValue returns a pointer to a valid Instruction for the value passed as argument, or an error if the value passed is not allowed by the enum.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewOffer instantiates a new Offer object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOfferWithDefaults instantiates a new Offer object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOrder instantiates a new Order object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOrderActivity instantiates a new OrderActivity object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOrderActivityWithDefaults instantiates a new OrderActivity object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOrderBalance instantiates a new OrderBalance object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOrderBalanceWithDefaults instantiates a new OrderBalance object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOrderLeg instantiates a new OrderLeg object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOrderLegCollection instantiates a new OrderLegCollection object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOrderLegCollectionWithDefaults instantiates a new OrderLegCollection object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOrderLegWithDefaults instantiates a new OrderLeg object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOrderRequest instantiates a new OrderRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOrderRequestWithDefaults instantiates a new OrderRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOrderStrategy instantiates a new OrderStrategy object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOrderStrategyTypeFromValue returns a pointer to a valid OrderStrategyType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewOrderStrategyWithDefaults instantiates a new OrderStrategy object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOrderTypeFromValue returns a pointer to a valid OrderType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewOrderTypeRequestFromValue returns a pointer to a valid OrderTypeRequest for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewOrderValidationDetail instantiates a new OrderValidationDetail object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOrderValidationDetailWithDefaults instantiates a new OrderValidationDetail object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOrderValidationResult instantiates a new OrderValidationResult object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewOrderValidationResultWithDefaults instantiates a new OrderValidationResult object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewOrderWithDefaults instantiates a new Order object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPosition instantiates a new Position object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPositionWithDefaults instantiates a new Position object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPreviewOrder instantiates a new PreviewOrder object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPreviewOrderWithDefaults instantiates a new PreviewOrder object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPriceLinkBasisFromValue returns a pointer to a valid PriceLinkBasis for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewPriceLinkTypeFromValue returns a pointer to a valid PriceLinkType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewProduct instantiates a new Product object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewProductWithDefaults instantiates a new Product object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRequestedDestinationFromValue returns a pointer to a valid RequestedDestination for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewSecuritiesAccount instantiates a new SecuritiesAccount object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSecuritiesAccountWithDefaults instantiates a new SecuritiesAccount object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewServiceError instantiates a new ServiceError object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewServiceErrorWithDefaults instantiates a new ServiceError object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSessionFromValue returns a pointer to a valid Session for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewSettlementInstructionFromValue returns a pointer to a valid SettlementInstruction for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewSpecialInstructionFromValue returns a pointer to a valid SpecialInstruction for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewStatusFromValue returns a pointer to a valid Status for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewStopPriceLinkBasisFromValue returns a pointer to a valid StopPriceLinkBasis for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewStopPriceLinkTypeFromValue returns a pointer to a valid StopPriceLinkType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewStopTypeFromValue returns a pointer to a valid StopType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewStreamerInfo instantiates a new StreamerInfo object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewStreamerInfoWithDefaults instantiates a new StreamerInfo object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTaxLotMethodFromValue returns a pointer to a valid TaxLotMethod for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewTransaction instantiates a new Transaction object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransactionAPIOptionDeliverable instantiates a new TransactionAPIOptionDeliverable object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransactionAPIOptionDeliverableWithDefaults instantiates a new TransactionAPIOptionDeliverable object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransactionBaseInstrument instantiates a new TransactionBaseInstrument object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransactionBaseInstrumentWithDefaults instantiates a new TransactionBaseInstrument object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransactionCashEquivalent instantiates a new TransactionCashEquivalent object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransactionCashEquivalentWithDefaults instantiates a new TransactionCashEquivalent object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransactionEquity instantiates a new TransactionEquity object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransactionEquityWithDefaults instantiates a new TransactionEquity object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransactionFixedIncome instantiates a new TransactionFixedIncome object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransactionFixedIncomeWithDefaults instantiates a new TransactionFixedIncome object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransactionMutualFund instantiates a new TransactionMutualFund object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransactionMutualFundWithDefaults instantiates a new TransactionMutualFund object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransactionOption instantiates a new TransactionOption object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransactionOptionWithDefaults instantiates a new TransactionOption object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransactionTypeFromValue returns a pointer to a valid TransactionType for the value passed as argument, or an error if the value passed is not allowed by the enum.
NewTransactionWithDefaults instantiates a new Transaction object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTransferItem instantiates a new TransferItem object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTransferItemWithDefaults instantiates a new TransferItem object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserDetails instantiates a new UserDetails object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserDetailsWithDefaults instantiates a new UserDetails object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserPreference instantiates a new UserPreference object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserPreferenceWithDefaults instantiates a new UserPreference object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUserProferenceAccount instantiates a new UserProferenceAccount object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUserProferenceAccountWithDefaults instantiates a new UserProferenceAccount object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
ProductAsTransactionInstrument is a convenience function that returns Product wrapped in TransactionInstrument.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.
TransactionCashEquivalentAsTransactionInstrument is a convenience function that returns TransactionCashEquivalent wrapped in TransactionInstrument.
TransactionEquityAsTransactionInstrument is a convenience function that returns TransactionEquity wrapped in TransactionInstrument.
TransactionFixedIncomeAsTransactionInstrument is a convenience function that returns TransactionFixedIncome wrapped in TransactionInstrument.
TransactionMutualFundAsTransactionInstrument is a convenience function that returns TransactionMutualFund wrapped in TransactionInstrument.
TransactionOptionAsTransactionInstrument is a convenience function that returns TransactionOption wrapped in TransactionInstrument.

# Constants

List of amountIndicator.
List of amountIndicator.
List of amountIndicator.
List of amountIndicator.
List of amountIndicator.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of apiOrderStatus.
List of APIRuleAction.
List of APIRuleAction.
List of APIRuleAction.
List of APIRuleAction.
List of APIRuleAction.
List of assetType.
List of assetType.
List of assetType.
List of assetType.
List of assetType.
List of assetType.
List of assetType.
List of assetType.
List of assetType.
List of assetType.
List of assetType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of complexOrderStrategyType.
List of duration.
List of duration.
List of duration.
List of duration.
List of duration.
List of duration.
List of duration.
List of duration.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of FeeType.
List of instruction.
List of instruction.
List of instruction.
List of instruction.
List of instruction.
List of instruction.
List of instruction.
List of instruction.
List of instruction.
List of instruction.
List of orderStrategyType.
List of orderStrategyType.
List of orderStrategyType.
List of orderStrategyType.
List of orderStrategyType.
List of orderStrategyType.
List of orderStrategyType.
List of orderStrategyType.
List of orderStrategyType.
List of orderType.
List of orderType.
List of orderType.
List of orderType.
List of orderType.
List of orderType.
List of orderType.
List of orderType.
List of orderType.
List of orderType.
List of orderType.
List of orderType.
List of orderType.
List of orderType.
List of orderType.
List of orderTypeRequest.
List of orderTypeRequest.
List of orderTypeRequest.
List of orderTypeRequest.
List of orderTypeRequest.
List of orderTypeRequest.
List of orderTypeRequest.
List of orderTypeRequest.
List of orderTypeRequest.
List of orderTypeRequest.
List of orderTypeRequest.
List of orderTypeRequest.
List of orderTypeRequest.
List of orderTypeRequest.
List of priceLinkBasis.
List of priceLinkBasis.
List of priceLinkBasis.
List of priceLinkBasis.
List of priceLinkBasis.
List of priceLinkBasis.
List of priceLinkBasis.
List of priceLinkBasis.
List of priceLinkBasis.
List of priceLinkType.
List of priceLinkType.
List of priceLinkType.
List of requestedDestination.
List of requestedDestination.
List of requestedDestination.
List of requestedDestination.
List of requestedDestination.
List of requestedDestination.
List of requestedDestination.
List of requestedDestination.
List of requestedDestination.
List of requestedDestination.
List of requestedDestination.
List of requestedDestination.
List of session.
List of session.
List of session.
List of session.
List of settlementInstruction.
List of settlementInstruction.
List of settlementInstruction.
List of settlementInstruction.
List of specialInstruction.
List of specialInstruction.
List of specialInstruction.
List of status.
List of status.
List of status.
List of status.
List of status.
List of status.
List of status.
List of status.
List of status.
List of status.
List of status.
List of status.
List of status.
List of status.
List of status.
List of status.
List of status.
List of status.
List of status.
List of status.
List of status.
List of stopPriceLinkBasis.
List of stopPriceLinkBasis.
List of stopPriceLinkBasis.
List of stopPriceLinkBasis.
List of stopPriceLinkBasis.
List of stopPriceLinkBasis.
List of stopPriceLinkBasis.
List of stopPriceLinkBasis.
List of stopPriceLinkBasis.
List of stopPriceLinkType.
List of stopPriceLinkType.
List of stopPriceLinkType.
List of stopType.
List of stopType.
List of stopType.
List of stopType.
List of stopType.
List of taxLotMethod.
List of taxLotMethod.
List of taxLotMethod.
List of taxLotMethod.
List of taxLotMethod.
List of taxLotMethod.
List of taxLotMethod.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.
List of TransactionType.

# Variables

All allowed values of AmountIndicator enum.
All allowed values of ApiOrderStatus enum.
All allowed values of APIRuleAction enum.
All allowed values of AssetType enum.
All allowed values of ComplexOrderStrategyType enum.
All allowed values of Duration enum.
All allowed values of FeeType enum.
All allowed values of Instruction enum.
All allowed values of OrderStrategyType enum.
All allowed values of OrderType enum.
All allowed values of OrderTypeRequest enum.
All allowed values of PriceLinkBasis enum.
All allowed values of PriceLinkType enum.
All allowed values of RequestedDestination enum.
All allowed values of Session enum.
All allowed values of SettlementInstruction enum.
All allowed values of SpecialInstruction enum.
All allowed values of Status enum.
All allowed values of StopPriceLinkBasis enum.
All allowed values of StopPriceLinkType enum.
All allowed values of StopType enum.
All allowed values of TaxLotMethod enum.
All allowed values of TransactionType enum.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.
No description provided by the author
No description provided by the author

# Structs

Account struct for Account.
AccountAPIOptionDeliverable struct for AccountAPIOptionDeliverable.
AccountCashEquivalent struct for AccountCashEquivalent.
AccountEquity struct for AccountEquity.
AccountFixedIncome struct for AccountFixedIncome.
AccountMutualFund struct for AccountMutualFund.
AccountNumberHash struct for AccountNumberHash.
AccountOption struct for AccountOption.
AccountsBaseInstrument struct for AccountsBaseInstrument.
AccountsInstrument - struct for AccountsInstrument.
No description provided by the author
APIClient manages communication with the Trader API - Account Access and User Preferences API v1.0.0 In most cases there should be only one, shared, APIClient.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
No description provided by the author
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
CollectiveInvestment struct for CollectiveInvestment.
Commission struct for Commission.
CommissionAndFee struct for CommissionAndFee.
CommissionLeg struct for CommissionLeg.
CommissionValue struct for CommissionValue.
Configuration stores the configuration of the API client.
Currency struct for Currency.
DateParam struct for DateParam.
ExecutionLeg struct for ExecutionLeg.
FeeLeg struct for FeeLeg.
Fees struct for Fees.
FeeValue struct for FeeValue.
Forex struct for Forex.
Future struct for Future.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
Index struct for Index.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Offer struct for Offer.
Order struct for Order.
OrderActivity struct for OrderActivity.
OrderBalance struct for OrderBalance.
OrderLeg struct for OrderLeg.
OrderLegCollection struct for OrderLegCollection.
OrderRequest struct for OrderRequest.
OrderStrategy struct for OrderStrategy.
OrderValidationDetail struct for OrderValidationDetail.
OrderValidationResult struct for OrderValidationResult.
Position struct for Position.
PreviewOrder struct for PreviewOrder.
Product struct for Product.
SecuritiesAccount struct for SecuritiesAccount.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
ServiceError struct for ServiceError.
StreamerInfo struct for StreamerInfo.
Transaction struct for Transaction.
TransactionAPIOptionDeliverable struct for TransactionAPIOptionDeliverable.
TransactionBaseInstrument struct for TransactionBaseInstrument.
TransactionCashEquivalent struct for TransactionCashEquivalent.
TransactionEquity struct for TransactionEquity.
TransactionFixedIncome struct for TransactionFixedIncome.
TransactionInstrument - struct for TransactionInstrument.
TransactionMutualFund struct for TransactionMutualFund.
TransactionOption struct for TransactionOption.
TransferItem struct for TransferItem.
UserDetails struct for UserDetails.
UserPreference struct for UserPreference.
UserProferenceAccount struct for UserProferenceAccount.

# Interfaces

No description provided by the author

# Type aliases

AccountsAPIService AccountsAPI service.
AmountIndicator the model 'AmountIndicator'.
ApiOrderStatus the model 'ApiOrderStatus'.
APIRuleAction the model 'APIRuleAction'.
AssetType the model 'AssetType'.
ComplexOrderStrategyType the model 'ComplexOrderStrategyType'.
Duration the model 'Duration'.
FeeType the model 'FeeType'.
Instruction the model 'Instruction'.
OrdersAPIService OrdersAPI service.
OrderStrategyType the model 'OrderStrategyType'.
OrderType the model 'OrderType'.
OrderTypeRequest Same as orderType, but does not have UNKNOWN since this type is not allowed as an input.
PriceLinkBasis the model 'PriceLinkBasis'.
PriceLinkType the model 'PriceLinkType'.
RequestedDestination the model 'RequestedDestination'.
ServerConfigurations stores multiple ServerConfiguration items.
Session the model 'Session'.
SettlementInstruction the model 'SettlementInstruction'.
SpecialInstruction the model 'SpecialInstruction'.
Status the model 'Status'.
StopPriceLinkBasis the model 'StopPriceLinkBasis'.
StopPriceLinkType the model 'StopPriceLinkType'.
StopType the model 'StopType'.
TaxLotMethod the model 'TaxLotMethod'.
TransactionsAPIService TransactionsAPI service.
TransactionType the model 'TransactionType'.
UserPreferenceAPIService UserPreferenceAPI service.