kandji-python-sdk/setup.py at main · MScottBlake/kandji-python-sdk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# coding: utf-8

"""
    Iru Endpoint Management API

    <html><head></head><body><h1 id=&quot;welcome-to-the-iru-endpoint-management-api-documentation&quot;>Welcome to the Iru Endpoint Management API Documentation</h1> <p><strong>Note:</strong> Kandji is now Iru, but many URLs and notes within this documentation will continue to reference Kandji for some time.</p> <p>You can find your API URL in Settings &gt; Access. The API URL will follow the below formats.</p> <ul> <li><p>US - <code>https://SubDomain.api.kandji.io</code></p> </li> <li><p>EU - <code>https://SubDomain.api.eu.kandji.io</code></p> </li> </ul> <p>For information on how to obtain an API token, please refer to the following support article.</p> <p><a href=&quot;https://support.kandji.io/api&quot;>https://support.kandji.io/api</a></p> <h4 id=&quot;rate-limit&quot;>Rate Limit</h4> <p>The Iru Endpoint Management API currently has an API rate limit of 10,000 requests per hour per customer.</p> <h4 id=&quot;request-methods&quot;>Request Methods</h4> <p>HTTP request methods supported by the API.</p> <div class=&quot;click-to-expand-wrapper is-table-wrapper&quot;><table> <thead> <tr> <th>Method</th> <th>Definition</th> </tr> </thead> <tbody> <tr> <td>GET</td> <td>The <code>GET</code> method requests a representation of the specified resource.</td> </tr> <tr> <td>POST</td> <td>The <code>POST</code> method submits an entity to the specified resource.</td> </tr> <tr> <td>PATCH</td> <td>The <code>PATCH</code> method applies partial modifications to a resource.</td> </tr> <tr> <td>DELETE</td> <td>The <code>DELETE</code> method deletes the specified resource.</td> </tr> </tbody> </table> </div><h4 id=&quot;response-codes&quot;>Response codes</h4> <p>Not all response codes apply to every endpoint.</p> <div class=&quot;click-to-expand-wrapper is-table-wrapper&quot;><table> <thead> <tr> <th>Code</th> <th>Response</th> </tr> </thead> <tbody> <tr> <td>200</td> <td>OK</td> </tr> <tr> <td>201</td> <td>Created</td> </tr> <tr> <td>204</td> <td>No content</td> </tr> <tr> <td></td> <td>Typical response when sending the DELETE method.</td> </tr> <tr> <td>400</td> <td>Bad Request</td> </tr> <tr> <td></td> <td>&quot;Command already running&quot; - The command may already be running in a <em>Pending</em> state waiting on the device.</td> </tr> <tr> <td></td> <td>&quot;Command is not allowed for current device&quot; - The command may not be compatible with the target device.</td> </tr> <tr> <td></td> <td>&quot;JSON parse error - Expecting ',' delimiter: line 3 column 2 (char 65)&quot;</td> </tr> <tr> <td>401</td> <td>Unauthorized</td> </tr> <tr> <td></td> <td>This error can occur if the token is incorrect, was revoked, or the token has expired.</td> </tr> <tr> <td>403</td> <td>Forbidden</td> </tr> <tr> <td></td> <td>The request was understood but cannot be authorized.</td> </tr> <tr> <td>404</td> <td>Not found</td> </tr> <tr> <td></td> <td>Unable to locate the resource in the Iru tenant.</td> </tr> <tr> <td>415</td> <td>Unsupported Media Type</td> </tr> <tr> <td></td> <td>The request contains a media type which the server or resource does not support.</td> </tr> <tr> <td>500</td> <td>Internal server error</td> </tr> <tr> <td>503</td> <td>Service unavailable</td> </tr> <tr> <td></td> <td>This error can occur if a file upload is still being processed via the custom apps API.</td> </tr> </tbody> </table> </div><h4 id=&quot;data-structure&quot;>Data structure</h4> <p>The API returns all structured responses in JSON schema format.</p> <h4 id=&quot;examples&quot;>Examples</h4> <p>Code examples using the API can be found in the Iru Endpoint Management support <a href=&quot;https://github.com/kandji-inc/support/tree/main/api-tools&quot;>GitHub</a>.</p> </body></html>

    The version of the OpenAPI document: 1.0.0
    Contact: mitchelsblake@gmail.com
    Generated by OpenAPI Generator (https://openapi-generator.tech)

    Do not edit the class manually.
"""  # noqa: E501


from setuptools import setup, find_packages  # noqa: H301

# To install the library, run the following
#
# python setup.py install
#
# prerequisite: setuptools
# http://pypi.python.org/pypi/setuptools
NAME = "kandji"
VERSION = "1.0.0"
PYTHON_REQUIRES = ">= 3.9"
REQUIRES = [
    "urllib3 >= 2.1.0, < 3.0.0",
    "python-dateutil >= 2.8.2",
    "pydantic >= 2",
    "typing-extensions >= 4.7.1",
]

setup(
    name=NAME,
    version=VERSION,
    description="Iru Endpoint Management API",
    author="Scott Blake",
    author_email="mitchelsblake@gmail.com",
    url="",
    keywords=["OpenAPI", "OpenAPI-Generator", "Iru Endpoint Management API"],
    install_requires=REQUIRES,
    packages=find_packages(exclude=["test", "tests"]),
    include_package_data=True,
    license="MIT License",
    long_description_content_type='text/markdown',
    long_description="""\
    &lt;html&gt;&lt;head&gt;&lt;/head&gt;&lt;body&gt;&lt;h1 id&#x3D;&amp;quot;welcome-to-the-iru-endpoint-management-api-documentation&amp;quot;&gt;Welcome to the Iru Endpoint Management API Documentation&lt;/h1&gt; &lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt; Kandji is now Iru, but many URLs and notes within this documentation will continue to reference Kandji for some time.&lt;/p&gt; &lt;p&gt;You can find your API URL in Settings &amp;gt; Access. The API URL will follow the below formats.&lt;/p&gt; &lt;ul&gt; &lt;li&gt;&lt;p&gt;US - &lt;code&gt;https://SubDomain.api.kandji.io&lt;/code&gt;&lt;/p&gt; &lt;/li&gt; &lt;li&gt;&lt;p&gt;EU - &lt;code&gt;https://SubDomain.api.eu.kandji.io&lt;/code&gt;&lt;/p&gt; &lt;/li&gt; &lt;/ul&gt; &lt;p&gt;For information on how to obtain an API token, please refer to the following support article.&lt;/p&gt; &lt;p&gt;&lt;a href&#x3D;&amp;quot;https://support.kandji.io/api&amp;quot;&gt;https://support.kandji.io/api&lt;/a&gt;&lt;/p&gt; &lt;h4 id&#x3D;&amp;quot;rate-limit&amp;quot;&gt;Rate Limit&lt;/h4&gt; &lt;p&gt;The Iru Endpoint Management API currently has an API rate limit of 10,000 requests per hour per customer.&lt;/p&gt; &lt;h4 id&#x3D;&amp;quot;request-methods&amp;quot;&gt;Request Methods&lt;/h4&gt; &lt;p&gt;HTTP request methods supported by the API.&lt;/p&gt; &lt;div class&#x3D;&amp;quot;click-to-expand-wrapper is-table-wrapper&amp;quot;&gt;&lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;Method&lt;/th&gt; &lt;th&gt;Definition&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;GET&lt;/td&gt; &lt;td&gt;The &lt;code&gt;GET&lt;/code&gt; method requests a representation of the specified resource.&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;POST&lt;/td&gt; &lt;td&gt;The &lt;code&gt;POST&lt;/code&gt; method submits an entity to the specified resource.&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;PATCH&lt;/td&gt; &lt;td&gt;The &lt;code&gt;PATCH&lt;/code&gt; method applies partial modifications to a resource.&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;DELETE&lt;/td&gt; &lt;td&gt;The &lt;code&gt;DELETE&lt;/code&gt; method deletes the specified resource.&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;/div&gt;&lt;h4 id&#x3D;&amp;quot;response-codes&amp;quot;&gt;Response codes&lt;/h4&gt; &lt;p&gt;Not all response codes apply to every endpoint.&lt;/p&gt; &lt;div class&#x3D;&amp;quot;click-to-expand-wrapper is-table-wrapper&amp;quot;&gt;&lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;Code&lt;/th&gt; &lt;th&gt;Response&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;200&lt;/td&gt; &lt;td&gt;OK&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;201&lt;/td&gt; &lt;td&gt;Created&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;204&lt;/td&gt; &lt;td&gt;No content&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;/td&gt; &lt;td&gt;Typical response when sending the DELETE method.&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;400&lt;/td&gt; &lt;td&gt;Bad Request&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;/td&gt; &lt;td&gt;&amp;quot;Command already running&amp;quot; - The command may already be running in a &lt;em&gt;Pending&lt;/em&gt; state waiting on the device.&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;/td&gt; &lt;td&gt;&amp;quot;Command is not allowed for current device&amp;quot; - The command may not be compatible with the target device.&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;/td&gt; &lt;td&gt;&amp;quot;JSON parse error - Expecting &#39;,&#39; delimiter: line 3 column 2 (char 65)&amp;quot;&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;401&lt;/td&gt; &lt;td&gt;Unauthorized&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;/td&gt; &lt;td&gt;This error can occur if the token is incorrect, was revoked, or the token has expired.&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;403&lt;/td&gt; &lt;td&gt;Forbidden&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;/td&gt; &lt;td&gt;The request was understood but cannot be authorized.&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;404&lt;/td&gt; &lt;td&gt;Not found&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;/td&gt; &lt;td&gt;Unable to locate the resource in the Iru tenant.&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;415&lt;/td&gt; &lt;td&gt;Unsupported Media Type&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;/td&gt; &lt;td&gt;The request contains a media type which the server or resource does not support.&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;500&lt;/td&gt; &lt;td&gt;Internal server error&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;503&lt;/td&gt; &lt;td&gt;Service unavailable&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;/td&gt; &lt;td&gt;This error can occur if a file upload is still being processed via the custom apps API.&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;/div&gt;&lt;h4 id&#x3D;&amp;quot;data-structure&amp;quot;&gt;Data structure&lt;/h4&gt; &lt;p&gt;The API returns all structured responses in JSON schema format.&lt;/p&gt; &lt;h4 id&#x3D;&amp;quot;examples&amp;quot;&gt;Examples&lt;/h4&gt; &lt;p&gt;Code examples using the API can be found in the Iru Endpoint Management support &lt;a href&#x3D;&amp;quot;https://github.com/kandji-inc/support/tree/main/api-tools&amp;quot;&gt;GitHub&lt;/a&gt;.&lt;/p&gt; &lt;/body&gt;&lt;/html&gt;
    """,  # noqa: E501
    package_data={"kandji": ["py.typed"]},
)