Merge pull request #24 from ranjanrak/add-ttl-iceberg

feat: add iceberg & TTL orders with phpUnit test run in github workflow

Author: vividvilla

.github/workflows/php-test.yml

@@ -0,0 +1,29 @@
+name: Run Tests
+
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      matrix:
+        php-versions: ["8.0", "8.1"]
+        os: ["ubuntu-latest", "macos-latest"]
+        phpunit-versions: ["9.5.4"]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+
+      - name: Install composer dependencies
+        run: composer install --no-scripts
+
+      - name: Install PHPUnit
+        run: composer global require "phpunit/phpunit=${{ matrix.phpunit-versions }}"
+
+      - name: PHPUnit tests
+        run: ~/.composer/vendor/bin/phpunit tests

README.md

@@ -1,31 +1,38 @@
 # The Kite Connect API PHP client - v3
+
 The Official PHP client for communicating with the [Kite Connect API](https://kite.trade).<br />
 
-Note: For PHP version < 7.3. You can refer to our [previous version](https://github.com/zerodha/phpkiteconnect/releases/tag/v3.0.0).  
+Note: For PHP version < 8.0. You can refer to our [previous version](https://github.com/zerodha/phpkiteconnect/releases/tag/v3.0.0).  
 Kite Connect is a set of REST-like APIs that expose many capabilities required to build a complete investment and trading platform. Execute orders in real time, manage user portfolio and more, with the simple HTTP API collection.
 
 [Zerodha Technology](http://zerodha.com) (c) 2021. Licensed under the MIT License.
 
 ## Documentation
+
 - [PHP client documentation](https://kite.trade/docs/phpkiteconnect/v3)
 - [Kite Connect HTTP API documentation](https://kite.trade/docs/connect/v3)
 
 ## Installing
+
 ### Requirements
-1. Install [PHP](https://www.php.net/manual/en/install.php) version 7.3 or higher.
+
+1. Install [PHP](https://www.php.net/manual/en/install.php) version 8.0 or higher.
 2. Install [Composer](https://getcomposer.org/download/), which is used to install PHP packages.
 
 You can install the package via composer:
+
 ```bash
 composer require zerodha/phpkiteconnect
 ```
-Note: You can refer to our previous version [here](https://github.com/zerodha/phpkiteconnect/releases/tag/v3.0.0) for PHP version < 7.3.
+
+Note: You can refer to our previous version [here](https://github.com/zerodha/phpkiteconnect/releases/tag/v3.0.0) for PHP version < 8.0.
 
 ## Usage
+
 ```php
 <?php
     require_once __DIR__ . '/vendor/autoload.php';
-    
+
     use KiteConnect\KiteConnect;
 
     // Initialise.
@@ -71,9 +78,11 @@ Check [examples folder](https://github.com/zerodha/phpkiteconnect/tree/master/ex
 Refer to the [PHP client documentation](https://kite.trade/docs/phpkiteconnect/v3) for the complete list of supported methods.
 
 ## Run unit tests
+
 ```
 phpunit tests/KiteConnectTest.php
 ```
 
 ## Changelog
-[Check CHANGELOG.md](CHANGELOG.md)
+
+[Check CHANGELOG.md](CHANGELOG.md)

src/KiteConnect.php

@@ -85,6 +85,7 @@ class KiteConnect
     public const VARIETY_BO = "bo";
     public const VARIETY_CO = "co";
     public const VARIETY_AMO = "amo";
+    public const VARIETY_ICEBERG = "iceberg";
 
     // Transaction type
     public const TRANSACTION_TYPE_BUY = "BUY";
@@ -93,6 +94,7 @@ class KiteConnect
     // Validity
     public const VALIDITY_DAY = "DAY";
     public const VALIDITY_IOC = "IOC";
+    public const VALIDITY_TTL = "TTL";
 
     // Margins segments
     public const MARGIN_EQUITY = "equity";
@@ -449,6 +451,9 @@ public function getMargins(?string $segment = null): mixed
      *                $params float|null  "squareoff" (Mandatory only for bracker orders) Square off value
      *                $params float|null  "stoploss" (Mandatory only for bracker orders) Stoploss value
      *                $params float|null  "trailing_stoploss" (Optional) Trailing stoploss value (only for bracket orders)
+     *                $params int|null    "validity_ttl" Order validity in minutes for TTL validity orders
+     *                $params int|null    "iceberg_legs" Total number of legs for iceberg order variety
+     *                $params int|null    "iceberg_quantity" Split quantity for each iceberg leg order
      *                $params float|null  "tag" (Optional) Order tag
      *                $params string|null "validity" (Optional) Order validity (DAY, IOC).
      * @return mixed|null