Skip to content

Commit b34c894

Browse files
Version Bump SDKs
1 parent aff795e commit b34c894

File tree

91 files changed

+677
-20192
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+677
-20192
lines changed

.konfig/generate-id.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
91597193-8d71-4b24-b49e-33d571495054
1+
69782d51-2bae-4ff6-9aa2-bfd8d6484b99

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
Connect brokerage accounts to your app for live positions and trading
88

9-
[![Packagist](https://img.shields.io/badge/Packagist-v2.0.30-blue)](https://packagist.org/packages/konfig/snaptrade-php-7-sdk)
9+
[![Packagist](https://img.shields.io/badge/Packagist-v2.0.31-blue)](https://packagist.org/packages/konfig/snaptrade-php-7-sdk)
1010
[![More Info](https://img.shields.io/badge/More%20Info-Click%20Here-orange)](https://snaptrade.com/)
1111

1212
</div>
@@ -86,7 +86,7 @@ To install the bindings via [Composer](https://getcomposer.org/), add the follow
8686
}
8787
],
8888
"require": {
89-
"konfig/snaptrade-php-7-sdk": "2.0.30"
89+
"konfig/snaptrade-php-7-sdk": "2.0.31"
9090
}
9191
}
9292
```
@@ -340,6 +340,8 @@ The ID of the account to get positions.
340340

341341
Lists balances, positions, option positions, and recent orders for the specified account. The data returned is similar to the data returned over the more fine-grained [balances](/reference/Account%20Information/AccountInformation_getUserAccountBalance), [positions](/reference/Account%20Information/AccountInformation_getUserAccountPositions) and [orders](/reference/Account%20Information/AccountInformation_getUserAccountOrders) endpoints. __The finer-grained APIs are preferred. They are easier to work with, faster, and have better error handling than this coarse-grained API.__
342342

343+
The data returned here is cached. How long the data is cached for varies by brokerage. Check the [brokerage integrations doc](https://snaptrade.notion.site/66793431ad0b416489eaabaf248d0afb?v=d16c4c97b8d5438bbb2d8581ac53b11e) and look for "Cache Expiry Time" to see the exact value for a specific brokerage. **If you need real-time data, please use the [manual refresh](/reference/Connections/Connections_refreshBrokerageAuthorization) endpoint**.
344+
343345

344346

345347
#### 🛠️ Usage<a id="🛠️-usage"></a>

lib/Configuration.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ class Configuration
9797
*
9898
* @var string
9999
*/
100-
protected $userAgent = 'Konfig/2.0.30/PHP';
100+
protected $userAgent = 'Konfig/2.0.31/PHP';
101101

102102
/**
103103
* Debug switch (default set to false)
@@ -487,7 +487,7 @@ public static function toDebugReport()
487487
$report .= ' OS: ' . php_uname() . PHP_EOL;
488488
$report .= ' PHP Version: ' . PHP_VERSION . PHP_EOL;
489489
$report .= ' The version of the OpenAPI document: 1.0.0' . PHP_EOL;
490-
$report .= ' SDK Package Version: 2.0.30' . PHP_EOL;
490+
$report .= ' SDK Package Version: 2.0.31' . PHP_EOL;
491491
$report .= ' Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL;
492492

493493
return $report;

lib/Model/AccountHoldingsAccount.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
* AccountHoldingsAccount Class Doc Comment
3131
*
3232
* @category Class
33-
* @description A wrapper object containing holdings information for a single account
33+
* @description A wrapper object containing holdings information for a single account.
3434
* @package SnapTrade
3535
* @implements \ArrayAccess<string, mixed>
3636
*/

lib/Model/AccountOrderRecord.php

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
* AccountOrderRecord Class Doc Comment
3131
*
3232
* @category Class
33-
* @description Record of order in brokerageaccount
33+
* @description Describes a single recent order in an account.
3434
* @package SnapTrade
3535
* @implements \ArrayAccess<string, mixed>
3636
*/
@@ -422,7 +422,7 @@ public function getBrokerageOrderId()
422422
/**
423423
* Sets brokerage_order_id
424424
*
425-
* @param string|null $brokerage_order_id Order id returned by brokerage
425+
* @param string|null $brokerage_order_id Order ID returned by brokerage. This is the unique identifier for the order in the brokerage system.
426426
*
427427
* @return self
428428
*/
@@ -471,6 +471,7 @@ public function setStatus($status)
471471
* Gets symbol
472472
*
473473
* @return string|null
474+
* @deprecated
474475
*/
475476
public function getSymbol()
476477
{
@@ -480,9 +481,10 @@ public function getSymbol()
480481
/**
481482
* Sets symbol
482483
*
483-
* @param string|null $symbol symbol
484+
* @param string|null $symbol A unique ID for the security within SnapTrade, scoped to the brokerage account that the security belongs to. This is a legacy field and should not be used. Do not rely on this being a stable ID as it can change.
484485
*
485486
* @return self
487+
* @deprecated
486488
*/
487489
public function setSymbol($symbol)
488490
{

lib/Model/AccountOrderRecordStatus.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
* AccountOrderRecordStatus Class Doc Comment
2929
*
3030
* @category Class
31+
* @description Indicates the status of an order. SnapTrade does a best effort to map brokerage statuses to statuses in this enum.
3132
* @package SnapTrade
3233
*/
3334
class AccountOrderRecordStatus

0 commit comments

Comments
 (0)