Merge pull request #20 from MarketDataApp/update-php-docs

Update PHP documentation
MarketDataApp · Sep 17, 2024 · cc6adbd · cc6adbd
2 parents 65d3932 + 9285d0c
commit cc6adbd
Show file tree

Hide file tree

Showing 206 changed files with 58,609 additions and 0 deletions.
diff --git a/.docs/classes/MarketDataApp-Client.html b/.docs/classes/MarketDataApp-Client.html
diff --git a/.docs/classes/MarketDataApp-ClientBase.html b/.docs/classes/MarketDataApp-ClientBase.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Indices.html b/.docs/classes/MarketDataApp-Endpoints-Indices.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Markets.html b/.docs/classes/MarketDataApp-Endpoints-Markets.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-MutualFunds.html b/.docs/classes/MarketDataApp-Endpoints-MutualFunds.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Options.html b/.docs/classes/MarketDataApp-Endpoints-Options.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Requests-Parameters.html b/.docs/classes/MarketDataApp-Endpoints-Requests-Parameters.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Indices-Candle.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Indices-Candle.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Indices-Candles.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Indices-Candles.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Indices-Quote.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Indices-Quote.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Indices-Quotes.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Indices-Quotes.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Markets-Status.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Markets-Status.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Markets-Statuses.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Markets-Statuses.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-MutualFunds-Candle.html b/.docs/classes/MarketDataApp-Endpoints-Responses-MutualFunds-Candle.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-MutualFunds-Candles.html b/.docs/classes/MarketDataApp-Endpoints-Responses-MutualFunds-Candles.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Options-Expirations.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Options-Expirations.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Options-Lookup.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Options-Lookup.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Options-OptionChainStrike.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Options-OptionChainStrike.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Options-OptionChains.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Options-OptionChains.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Options-Quote.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Options-Quote.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Options-Quotes.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Options-Quotes.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Options-Strikes.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Options-Strikes.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-ResponseBase.html b/.docs/classes/MarketDataApp-Endpoints-Responses-ResponseBase.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-BulkCandles.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-BulkCandles.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-BulkQuote.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-BulkQuote.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-BulkQuotes.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-BulkQuotes.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-Candle.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-Candle.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-Candles.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-Candles.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-Earning.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-Earning.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-Earnings.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-Earnings.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-News.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-News.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-Quote.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-Quote.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-Quotes.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Stocks-Quotes.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Utilities-ApiStatus.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Utilities-ApiStatus.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Utilities-Headers.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Utilities-Headers.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Responses-Utilities-ServiceStatus.html b/.docs/classes/MarketDataApp-Endpoints-Responses-Utilities-ServiceStatus.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Stocks.html b/.docs/classes/MarketDataApp-Endpoints-Stocks.html
diff --git a/.docs/classes/MarketDataApp-Endpoints-Utilities.html b/.docs/classes/MarketDataApp-Endpoints-Utilities.html
diff --git a/.docs/classes/MarketDataApp-Enums-Expiration.html b/.docs/classes/MarketDataApp-Enums-Expiration.html
@@ -0,0 +1,359 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+            <title>Documentation</title>
+
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <base href="../">
+    <link rel="icon" href="images/favicon.ico"/>
+    <link rel="stylesheet" href="css/normalize.css">
+    <link rel="stylesheet" href="css/base.css">
+            <link rel="preconnect" href="https://fonts.gstatic.com">
+        <link href="https://fonts.googleapis.com/css2?family=Open+Sans:wght@100;200;300;400;600;700&display=swap" rel="stylesheet">
+        <link href="https://fonts.googleapis.com/css2?family=Source+Code+Pro:wght@400;600;700&display=swap" rel="stylesheet">
+        <link rel="stylesheet" href="css/template.css">
+        <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.0/css/all.min.css" integrity="sha256-ybRkN9dBjhcS2qrW1z+hfCxq+1aBdwyQM5wlQoQVt/0=" crossorigin="anonymous" />
+        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/themes/prism-okaidia.css">
+        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.css">
+        <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.css">
+                <script src="https://cdn.jsdelivr.net/npm/fuse.js@3.4.6"></script>
+        <script src="https://cdn.jsdelivr.net/npm/css-vars-ponyfill@2"></script>
+        <script src="js/template.js"></script>
+        <script src="js/search.js"></script>
+        <script defer src="js/searchIndex.js"></script>
+    </head>
+<body id="top">
+    <header class="phpdocumentor-header phpdocumentor-section">
+    <h1 class="phpdocumentor-title"><a href="" class="phpdocumentor-title__link">Documentation</a></h1>
+    <input class="phpdocumentor-header__menu-button" type="checkbox" id="menu-button" name="menu-button" />
+    <label class="phpdocumentor-header__menu-icon" for="menu-button">
+        <i class="fas fa-bars"></i>
+    </label>
+    <section data-search-form class="phpdocumentor-search">
+    <label>
+        <span class="visually-hidden">Search for</span>
+        <svg class="phpdocumentor-search__icon" width="21" height="20" viewBox="0 0 21 20" fill="none" xmlns="http://www.w3.org/2000/svg">
+            <circle cx="7.5" cy="7.5" r="6.5" stroke="currentColor" stroke-width="2"/>
+            <line x1="12.4892" y1="12.2727" x2="19.1559" y2="18.9393" stroke="currentColor" stroke-width="3"/>
+        </svg>
+        <input type="search" class="phpdocumentor-field phpdocumentor-search__field" placeholder="Loading .." disabled />
+    </label>
+</section>
+
+    <nav class="phpdocumentor-topnav">
+    <ul class="phpdocumentor-topnav__menu">
+        </ul>
+</nav>
+</header>
+
+    <main class="phpdocumentor">
+        <div class="phpdocumentor-section">
+            <input class="phpdocumentor-sidebar__menu-button" type="checkbox" id="sidebar-button" name="sidebar-button" />
+<label class="phpdocumentor-sidebar__menu-icon" for="sidebar-button">
+    Menu
+</label>
+<aside class="phpdocumentor-column -three phpdocumentor-sidebar">
+                    <section class="phpdocumentor-sidebar__category -namespaces">
+            <h2 class="phpdocumentor-sidebar__category-header">Namespaces</h2>
+                                    <h4 class="phpdocumentor-sidebar__root-namespace">
+    <a href="namespaces/marketdataapp.html" class="">MarketDataApp</a>
+</h4>
+    <ul class="phpdocumentor-list">
+                    <li>
+                <a href="namespaces/marketdataapp-endpoints.html" class="">Endpoints</a>
+
+            </li>
+                    <li>
+                <a href="namespaces/marketdataapp-enums.html" class="">Enums</a>
+
+            </li>
+                    <li>
+                <a href="namespaces/marketdataapp-exceptions.html" class="">Exceptions</a>
+
+            </li>
+                    <li>
+                <a href="namespaces/marketdataapp-traits.html" class="">Traits</a>
+
+            </li>
+            </ul>
+
+                        </section>
+                <section class="phpdocumentor-sidebar__category -packages">
+            <h2 class="phpdocumentor-sidebar__category-header">Packages</h2>
+                                    <h4 class="phpdocumentor-sidebar__root-namespace">
+    <a href="packages/Application.html" class="">Application</a>
+</h4>
+
+                        </section>
+
+    <section class="phpdocumentor-sidebar__category -reports">
+        <h2 class="phpdocumentor-sidebar__category-header">Reports</h2>
+                <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/deprecated.html">Deprecated</a></h3>
+        <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/errors.html">Errors</a></h3>
+        <h3 class="phpdocumentor-sidebar__root-package"><a href="reports/markers.html">Markers</a></h3>
+    </section>
+
+    <section class="phpdocumentor-sidebar__category -indices">
+        <h2 class="phpdocumentor-sidebar__category-header">Indices</h2>
+        <h3 class="phpdocumentor-sidebar__root-package"><a href="indices/files.html">Files</a></h3>
+    </section>
+</aside>
+
+            <div class="phpdocumentor-column -nine phpdocumentor-content">
+                                <section>
+                                        <ul class="phpdocumentor-breadcrumbs">
+            <li class="phpdocumentor-breadcrumb"><a href="namespaces/marketdataapp.html">MarketDataApp</a></li>
+            <li class="phpdocumentor-breadcrumb"><a href="namespaces/marketdataapp-enums.html">Enums</a></li>
+    </ul>
+
+    <article class="phpdocumentor-element -class">
+        <h2 class="phpdocumentor-content__title">
+    Expiration
+
+            <span class="phpdocumentor-element__extends">
+        : string
+    </span>
+
+            <div class="phpdocumentor-element__package">
+            in package
+            <ul class="phpdocumentor-breadcrumbs">
+                                    <li class="phpdocumentor-breadcrumb"><a href="packages/Application.html">Application</a></li>
+                            </ul>
+        </div>
+
+
+    </h2>
+
+        <aside class="phpdocumentor-element-found-in">
+    <abbr class="phpdocumentor-element-found-in__file" title="src/Enums/Expiration.php"><a href="files/src-enums-expiration.html"><abbr title="src/Enums/Expiration.php">Expiration.php</abbr></a></abbr>
+    :
+    <span class="phpdocumentor-element-found-in__line">10</span>
+
+    </aside>
+
+            <p class="phpdocumentor-summary">Enum Expiration</p>
+
+
+    <section class="phpdocumentor-description"><p>Represents expiration options for market data queries.</p>
+</section>
+
+
+
+
+
+
+
+<h3 id="toc">
+    Table of Contents
+    <a href="classes/MarketDataApp-Enums-Expiration.html#toc" class="headerlink"><i class="fas fa-link"></i></a>
+
+</h3>
+
+
+
+
+
+
+
+
+<h4 id="toc-cases">
+    Cases
+    <a href="classes/MarketDataApp-Enums-Expiration.html#toc-cases" class="headerlink"><i class="fas fa-link"></i></a>
+
+</h4>
+<dl class="phpdocumentor-table-of-contents">
+            <dt class="phpdocumentor-table-of-contents__entry -case -">
+    <a class="" href="classes/MarketDataApp-Enums-Expiration.html#enumcase_ALL">ALL</a>
+    <span>
+                &nbsp;= &#039;all&#039;                    </span>
+</dt>
+<dd>Represents all expirations.</dd>
+
+    </dl>
+
+
+
+
+
+
+            <section class="phpdocumentor-cases">
+        <h3 class="phpdocumentor-elements__header" id="cases">
+            Cases
+            <a href="classes/MarketDataApp-Enums-Expiration.html#cases" class="headerlink"><i class="fas fa-link"></i></a>
+
+        </h3>
+                    <article
+        class="
+            phpdocumentor-element
+            -enum-case
+        "
+>
+    <h4 class="phpdocumentor-element__name" id="enumcase_ALL">
+        ALL
+        <a href="classes/MarketDataApp-Enums-Expiration.html#enumcase_ALL" class="headerlink"><i class="fas fa-link"></i></a>
+
+    </h4>
+    <aside class="phpdocumentor-element-found-in">
+    <abbr class="phpdocumentor-element-found-in__file" title="src/Enums/Expiration.php"><a href="files/src-enums-expiration.html"><abbr title="src/Enums/Expiration.php">Expiration.php</abbr></a></abbr>
+    :
+    <span class="phpdocumentor-element-found-in__line">16</span>
+
+    </aside>
+
+        <p class="phpdocumentor-summary">Represents all expirations.</p>
+
+
+
+
+
+
+
+
+</article>
+            </section>
+
+
+        <div class="phpdocumentor-modal" id="source-view">
+    <div class="phpdocumentor-modal-bg" data-exit-button></div>
+    <div class="phpdocumentor-modal-container">
+        <div class="phpdocumentor-modal-content">
+            <pre style="max-height: 500px; overflow-y: scroll" data-src="files/src/Enums/Expiration.php.txt" class="language-php line-numbers linkable-line-numbers"></pre>
+        </div>
+        <button data-exit-button class="phpdocumentor-modal__close">&times;</button>
+    </div>
+</div>
+
+    <script type="text/javascript">
+        (function () {
+            function loadExternalCodeSnippet(el, url, line) {
+                Array.prototype.slice.call(el.querySelectorAll('pre[data-src]')).forEach((pre) => {
+                    const src = url || pre.getAttribute('data-src').replace(/\\/g, '/');
+                    const language = 'php';
+
+                    const code = document.createElement('code');
+                    code.className = 'language-' + language;
+                    pre.textContent = '';
+                    pre.setAttribute('data-line', line)
+                    code.textContent = 'Loading…';
+                    pre.appendChild(code);
+
+                    var xhr = new XMLHttpRequest();
+
+                    xhr.open('GET', src, true);
+
+                    xhr.onreadystatechange = function () {
+                        if (xhr.readyState !== 4) {
+                            return;
+                        }
+
+                        if (xhr.status < 400 && xhr.responseText) {
+                            code.textContent = xhr.responseText;
+                            Prism.highlightElement(code);
+                            return;
+                        }
+
+                        if (xhr.status === 404) {
+                            code.textContent = '✖ Error: File could not be found';
+                            return;
+                        }
+
+                        if (xhr.status >= 400) {
+                            code.textContent = '✖ Error ' + xhr.status + ' while fetching file: ' + xhr.statusText;
+                            return;
+                        }
+
+                        code.textContent = '✖ Error: An unknown error occurred';
+                    };
+
+                    xhr.send(null);
+                });
+            }
+
+            const modalButtons = document.querySelectorAll("[data-modal]");
+            const openedAsLocalFile = window.location.protocol === 'file:';
+            if (modalButtons.length > 0 && openedAsLocalFile) {
+                console.warn(
+                    'Viewing the source code is unavailable because you are opening this page from the file:// scheme; ' +
+                    'browsers block XHR requests when a page is opened this way'
+                );
+            }
+
+            modalButtons.forEach(function (trigger) {
+                if (openedAsLocalFile) {
+                    trigger.setAttribute("hidden", "hidden");
+                }
+
+                trigger.addEventListener("click", function (event) {
+                    event.preventDefault();
+                    const modal = document.getElementById(trigger.dataset.modal);
+                    if (!modal) {
+                        console.error(`Modal with id "${trigger.dataset.modal}" could not be found`);
+                        return;
+                    }
+                    modal.classList.add("phpdocumentor-modal__open");
+
+                    loadExternalCodeSnippet(modal, trigger.dataset.src || null, trigger.dataset.line)
+                    const exits = modal.querySelectorAll("[data-exit-button]");
+                    exits.forEach(function (exit) {
+                        exit.addEventListener("click", function (event) {
+                            event.preventDefault();
+                            modal.classList.remove("phpdocumentor-modal__open");
+                        });
+                    });
+                });
+            });
+        })();
+    </script>
+
+    </article>
+                                </section>
+                <section class="phpdocumentor-on-this-page__sidebar">
+
+    <section class="phpdocumentor-on-this-page__content">
+        <strong class="phpdocumentor-on-this-page__title">On this page</strong>
+
+        <ul class="phpdocumentor-list -clean">
+            <li class="phpdocumentor-on-this-page-section__title">Table Of Contents</li>
+            <li>
+                <ul class="phpdocumentor-list -clean">
+                                            <li><a href="classes/MarketDataApp-Enums-Expiration.html#toc-cases">Cases</a></li>
+                                                        </ul>
+            </li>
+                            <li class="phpdocumentor-on-this-page-section__title">Cases</li>
+                <li>
+                    <ul class="phpdocumentor-list -clean">
+                                                    <li class=""><a href="classes/MarketDataApp-Enums-Expiration.html#enumcase_ALL">ALL</a></li>
+                                            </ul>
+                </li>
+
+                    </ul>
+    </section>
+
+                </section>
+                            </div>
+            <section data-search-results class="phpdocumentor-search-results phpdocumentor-search-results--hidden">
+    <section class="phpdocumentor-search-results__dialog">
+        <header class="phpdocumentor-search-results__header">
+            <h2 class="phpdocumentor-search-results__title">Search results</h2>
+            <button class="phpdocumentor-search-results__close"><i class="fas fa-times"></i></button>
+        </header>
+        <section class="phpdocumentor-search-results__body">
+            <ul class="phpdocumentor-search-results__entries"></ul>
+        </section>
+    </section>
+</section>
+        </div>
+        <a href="classes/MarketDataApp-Enums-Expiration.html#top" class="phpdocumentor-back-to-top"><i class="fas fa-chevron-circle-up"></i></a>
+
+    </main>
+
+    <script>
+        cssVars({});
+    </script>
+    <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/prism.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/autoloader/prism-autoloader.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-numbers/prism-line-numbers.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/prismjs@1.23.0/plugins/line-highlight/prism-line-highlight.min.js"></script>
+</body>
+</html>