From 81e50fc3e2510f64d99afdba58fcb0735bed4df4 Mon Sep 17 00:00:00 2001 From: konfig-publisher Date: Wed, 8 May 2024 10:49:16 -0700 Subject: [PATCH] Regenerate SDK --- .konfig/generate-id.txt | 2 +- README.md | 23 ++++++++++--------- lib/Api/ConnectionsApi.php | 16 ++++++------- lib/Api/OptionsApi.php | 40 ++++++++++++++++----------------- test/Api/ConnectionsApiTest.php | 4 ++-- test/Api/OptionsApiTest.php | 10 ++++----- 6 files changed, 49 insertions(+), 46 deletions(-) diff --git a/.konfig/generate-id.txt b/.konfig/generate-id.txt index 66599a4..e280c53 100644 --- a/.konfig/generate-id.txt +++ b/.konfig/generate-id.txt @@ -1 +1 @@ -cc239da8-3943-462c-9745-ce075ed483c7 \ No newline at end of file +d75caf17-dbdc-47f9-80bc-e595fd794650 \ No newline at end of file diff --git a/README.md b/README.md index 7459be9..8584d31 100644 --- a/README.md +++ b/README.md @@ -295,7 +295,7 @@ Number of days in the past to fetch the most recent orders. Defaults to the last ### `snaptrade.accountInformation.getUserAccountPositions` -Returns a list of positions in the the specified account. +Returns a list of positions in the specified account. #### 🛠️ Usage @@ -705,7 +705,7 @@ SnapTrade User Secret randomly generated by SnapTrade. This should be considered ### `snaptrade.connections.detailBrokerageAuthorization` -Get brokerage authorization details +Returns a single brokerage authorization object for the specified ID. #### 🛠️ Usage @@ -744,7 +744,7 @@ The ID of a brokerage authorization object. ### `snaptrade.connections.listBrokerageAuthorizations` -List all brokerage authorizations for the user +Returns a list of Brokerage Autherization objects for the specified userId. #### 🛠️ Usage @@ -778,7 +778,7 @@ $result = $snaptrade->connections->listBrokerageAuthorizations( ### `snaptrade.connections.removeBrokerageAuthorization` -Delete brokerage authorization +Deletes a specified brokerage authorization given by the ID. #### 🛠️ Usage @@ -817,7 +817,7 @@ void (empty response body) ### `snaptrade.connections.sessionEvents` -List all session events for the partner +Returns a list of session events associated with a user. #### 🛠️ Usage @@ -858,7 +858,8 @@ Optional comma seperated list of session IDs used to filter the request on speci ### `snaptrade.options.getOptionStrategy` -Creates an option strategy object that will be used to place an option strategy order +Creates an option strategy object that will be used to place an option strategy order. + #### 🛠️ Usage @@ -912,7 +913,7 @@ The ID of the account to create the option strategy object in. ### `snaptrade.options.getOptionsChain` -Get the options chain +Returns the option chain for the specified symbol in the specified account. #### 🛠️ Usage @@ -956,7 +957,8 @@ Universal symbol ID if symbol ### `snaptrade.options.getOptionsStrategyQuote` -Get latest market data of option strategy +Returns a Strategy Quotes object which has latest market data of the specified option strategy. + #### 🛠️ Usage @@ -1000,7 +1002,8 @@ Option strategy id obtained from response when creating option strategy object ### `snaptrade.options.listOptionHoldings` -Get the options holdings in the account +Returns a list of Options Positions. + #### 🛠️ Usage @@ -1039,7 +1042,7 @@ The ID of the account to fetch options holdings for. ### `snaptrade.options.placeOptionStrategy` -Place an option strategy order on the brokerage +Places the option strategy order and returns the order record received from the brokerage. #### 🛠️ Usage diff --git a/lib/Api/ConnectionsApi.php b/lib/Api/ConnectionsApi.php index c105e1f..8e220af 100644 --- a/lib/Api/ConnectionsApi.php +++ b/lib/Api/ConnectionsApi.php @@ -545,7 +545,7 @@ public function detailBrokerageAuthorizationRequest($authorization_id, $user_id, /** * Operation listBrokerageAuthorizations * - * List all brokerage authorizations for the user + * List all brokerage authorizations for the User * * @param string $user_id user_id (required) * @param string $user_secret user_secret (required) @@ -570,7 +570,7 @@ public function listBrokerageAuthorizations( /** * Operation listBrokerageAuthorizationsWithHttpInfo * - * List all brokerage authorizations for the user + * List all brokerage authorizations for the User * * @param string $user_id (required) * @param string $user_secret (required) @@ -689,7 +689,7 @@ public function listBrokerageAuthorizationsWithHttpInfo($user_id, $user_secret, /** * Operation listBrokerageAuthorizationsAsync * - * List all brokerage authorizations for the user + * List all brokerage authorizations for the User * * @param string $user_id (required) * @param string $user_secret (required) @@ -718,7 +718,7 @@ function ($response) { /** * Operation listBrokerageAuthorizationsAsyncWithHttpInfo * - * List all brokerage authorizations for the user + * List all brokerage authorizations for the User * * @param string $user_id (required) * @param string $user_secret (required) @@ -1261,7 +1261,7 @@ public function removeBrokerageAuthorizationRequest($authorization_id, $user_id, /** * Operation sessionEvents * - * List all session events for the partner + * Get all session events for a user * * @param string $partner_client_id partner_client_id (required) * @param string $user_id Optional comma seperated list of user IDs used to filter the request on specific users (optional) @@ -1288,7 +1288,7 @@ public function sessionEvents( /** * Operation sessionEventsWithHttpInfo * - * List all session events for the partner + * Get all session events for a user * * @param string $partner_client_id (required) * @param string $user_id Optional comma seperated list of user IDs used to filter the request on specific users (optional) @@ -1409,7 +1409,7 @@ public function sessionEventsWithHttpInfo($partner_client_id, $user_id = null, $ /** * Operation sessionEventsAsync * - * List all session events for the partner + * Get all session events for a user * * @param string $partner_client_id (required) * @param string $user_id Optional comma seperated list of user IDs used to filter the request on specific users (optional) @@ -1440,7 +1440,7 @@ function ($response) { /** * Operation sessionEventsAsyncWithHttpInfo * - * List all session events for the partner + * Get all session events for a user * * @param string $partner_client_id (required) * @param string $user_id Optional comma seperated list of user IDs used to filter the request on specific users (optional) diff --git a/lib/Api/OptionsApi.php b/lib/Api/OptionsApi.php index 4046fb4..81a70bc 100644 --- a/lib/Api/OptionsApi.php +++ b/lib/Api/OptionsApi.php @@ -150,7 +150,7 @@ private function setRequestBodyProperty(&$body, $property, $value) { /** * Operation getOptionStrategy * - * Creates an option strategy object that will be used to place an option strategy order + * Create options strategy * * @param string $user_id user_id (required) * @param string $user_secret user_secret (required) @@ -186,7 +186,7 @@ public function getOptionStrategy( /** * Operation getOptionStrategyWithHttpInfo * - * Creates an option strategy object that will be used to place an option strategy order + * Create options strategy * * @param string $user_id (required) * @param string $user_secret (required) @@ -332,7 +332,7 @@ public function getOptionStrategyWithHttpInfo($user_id, $user_secret, $account_i /** * Operation getOptionStrategyAsync * - * Creates an option strategy object that will be used to place an option strategy order + * Create options strategy * * @param string $user_id (required) * @param string $user_secret (required) @@ -372,7 +372,7 @@ function ($response) { /** * Operation getOptionStrategyAsyncWithHttpInfo * - * Creates an option strategy object that will be used to place an option strategy order + * Create options strategy * * @param string $user_id (required) * @param string $user_secret (required) @@ -614,7 +614,7 @@ public function getOptionStrategyRequest($user_id, $user_secret, $account_id, $o /** * Operation getOptionsChain * - * Get the options chain + * Get the options chain for a symbol * * @param string $user_id user_id (required) * @param string $user_secret user_secret (required) @@ -643,7 +643,7 @@ public function getOptionsChain( /** * Operation getOptionsChainWithHttpInfo * - * Get the options chain + * Get the options chain for a symbol * * @param string $user_id (required) * @param string $user_secret (required) @@ -789,7 +789,7 @@ public function getOptionsChainWithHttpInfo($user_id, $user_secret, $account_id, /** * Operation getOptionsChainAsync * - * Get the options chain + * Get the options chain for a symbol * * @param string $user_id (required) * @param string $user_secret (required) @@ -822,7 +822,7 @@ function ($response) { /** * Operation getOptionsChainAsyncWithHttpInfo * - * Get the options chain + * Get the options chain for a symbol * * @param string $user_id (required) * @param string $user_secret (required) @@ -1064,7 +1064,7 @@ public function getOptionsChainRequest($user_id, $user_secret, $account_id, $sym /** * Operation getOptionsStrategyQuote * - * Get latest market data of option strategy + * Get options strategy quotes * * @param string $user_id user_id (required) * @param string $user_secret user_secret (required) @@ -1093,7 +1093,7 @@ public function getOptionsStrategyQuote( /** * Operation getOptionsStrategyQuoteWithHttpInfo * - * Get latest market data of option strategy + * Get options strategy quotes * * @param string $user_id (required) * @param string $user_secret (required) @@ -1239,7 +1239,7 @@ public function getOptionsStrategyQuoteWithHttpInfo($user_id, $user_secret, $acc /** * Operation getOptionsStrategyQuoteAsync * - * Get latest market data of option strategy + * Get options strategy quotes * * @param string $user_id (required) * @param string $user_secret (required) @@ -1272,7 +1272,7 @@ function ($response) { /** * Operation getOptionsStrategyQuoteAsyncWithHttpInfo * - * Get latest market data of option strategy + * Get options strategy quotes * * @param string $user_id (required) * @param string $user_secret (required) @@ -1511,7 +1511,7 @@ public function getOptionsStrategyQuoteRequest($user_id, $user_secret, $account_ /** * Operation listOptionHoldings * - * Get the options holdings in the account + * Get account option holdings * * @param string $user_id user_id (required) * @param string $user_secret user_secret (required) @@ -1538,7 +1538,7 @@ public function listOptionHoldings( /** * Operation listOptionHoldingsWithHttpInfo * - * Get the options holdings in the account + * Get account option holdings * * @param string $user_id (required) * @param string $user_secret (required) @@ -1682,7 +1682,7 @@ public function listOptionHoldingsWithHttpInfo($user_id, $user_secret, $account_ /** * Operation listOptionHoldingsAsync * - * Get the options holdings in the account + * Get account option holdings * * @param string $user_id (required) * @param string $user_secret (required) @@ -1713,7 +1713,7 @@ function ($response) { /** * Operation listOptionHoldingsAsyncWithHttpInfo * - * Get the options holdings in the account + * Get account option holdings * * @param string $user_id (required) * @param string $user_secret (required) @@ -1932,7 +1932,7 @@ public function listOptionHoldingsRequest($user_id, $user_secret, $account_id, s /** * Operation placeOptionStrategy * - * Place an option strategy order on the brokerage + * Place an option strategy order * * @param string $user_id user_id (required) * @param string $user_secret user_secret (required) @@ -1970,7 +1970,7 @@ public function placeOptionStrategy( /** * Operation placeOptionStrategyWithHttpInfo * - * Place an option strategy order on the brokerage + * Place an option strategy order * * @param string $user_id (required) * @param string $user_secret (required) @@ -2118,7 +2118,7 @@ public function placeOptionStrategyWithHttpInfo($user_id, $user_secret, $account /** * Operation placeOptionStrategyAsync * - * Place an option strategy order on the brokerage + * Place an option strategy order * * @param string $user_id (required) * @param string $user_secret (required) @@ -2160,7 +2160,7 @@ function ($response) { /** * Operation placeOptionStrategyAsyncWithHttpInfo * - * Place an option strategy order on the brokerage + * Place an option strategy order * * @param string $user_id (required) * @param string $user_secret (required) diff --git a/test/Api/ConnectionsApiTest.php b/test/Api/ConnectionsApiTest.php index 0aa945e..8c80230 100644 --- a/test/Api/ConnectionsApiTest.php +++ b/test/Api/ConnectionsApiTest.php @@ -73,7 +73,7 @@ public function testDetailBrokerageAuthorization() /** * Test case for listBrokerageAuthorizations * - * List all brokerage authorizations for the user. + * List all brokerage authorizations for the User. * */ public function testListBrokerageAuthorizations() @@ -97,7 +97,7 @@ public function testRemoveBrokerageAuthorization() /** * Test case for sessionEvents * - * List all session events for the partner. + * Get all session events for a user. * */ public function testSessionEvents() diff --git a/test/Api/OptionsApiTest.php b/test/Api/OptionsApiTest.php index c92ca00..62e1c76 100644 --- a/test/Api/OptionsApiTest.php +++ b/test/Api/OptionsApiTest.php @@ -61,7 +61,7 @@ public static function tearDownAfterClass(): void /** * Test case for getOptionStrategy * - * Creates an option strategy object that will be used to place an option strategy order. + * Create options strategy. * */ public function testGetOptionStrategy() @@ -73,7 +73,7 @@ public function testGetOptionStrategy() /** * Test case for getOptionsChain * - * Get the options chain. + * Get the options chain for a symbol. * */ public function testGetOptionsChain() @@ -85,7 +85,7 @@ public function testGetOptionsChain() /** * Test case for getOptionsStrategyQuote * - * Get latest market data of option strategy. + * Get options strategy quotes. * */ public function testGetOptionsStrategyQuote() @@ -97,7 +97,7 @@ public function testGetOptionsStrategyQuote() /** * Test case for listOptionHoldings * - * Get the options holdings in the account. + * Get account option holdings. * */ public function testListOptionHoldings() @@ -109,7 +109,7 @@ public function testListOptionHoldings() /** * Test case for placeOptionStrategy * - * Place an option strategy order on the brokerage. + * Place an option strategy order. * */ public function testPlaceOptionStrategy()