sonatype-guide-api-client 0.0.2__tar.gz

sonatype_guide_api_client-0.0.2/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sonatype_guide_api_client-0.0.2/PKG-INFO

@@ -0,0 +1,227 @@
+Metadata-Version: 2.4
+Name: sonatype_guide_api_client
+Version: 0.0.2
+Summary: Sonatype Guide API
+Home-page: 
+Author: Sonatype Community Maintainers
+Author-email: Sonatype Community Maintainers <community@sonatype.com>
+License: Apache 2.0
+Project-URL: Repository, https://github.com/sonatype-nexus-community/sonatype-guide-api-client
+Keywords: OpenAPI,OpenAPI-Generator,Sonatype Guide API
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: license-file
+
+# sonatype-guide-api-client
+REST API into [Sonatype Guide](https://guide.sonatype.com).
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 202601
+- Package version: 1.0.0
+- Generator version: 7.16.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+For more information, please visit [https://github.com/sonatype-nexus-community](https://github.com/sonatype-nexus-community)
+
+## Requirements.
+
+Python 3.9+
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on a repository, you can install directly using:
+
+```sh
+pip install git+https://github.com/sonatype-nexus-community/sonatype-guide-api-client.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/sonatype-nexus-community/sonatype-guide-api-client.git`)
+
+Then import the package:
+```python
+import sonatype_guide_api_client
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import sonatype_guide_api_client
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import sonatype_guide_api_client
+from sonatype_guide_api_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://api.guide.sonatype.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = sonatype_guide_api_client.Configuration(
+    host = "http://api.guide.sonatype.com"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (JWT): bearer-jwt
+configuration = sonatype_guide_api_client.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+
+# Enter a context with an instance of the API client
+with sonatype_guide_api_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = sonatype_guide_api_client.BillingApi(api_client)
+
+    try:
+        # Get billing information (v2)
+        api_response = api_instance.get_billing_v2()
+        print("The response of BillingApi->get_billing_v2:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling BillingApi->get_billing_v2: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://api.guide.sonatype.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*BillingApi* | [**get_billing_v2**](docs/BillingApi.md#get_billing_v2) | **GET** /billing/v2 | Get billing information (v2)
+*BillingApi* | [**get_customer_info**](docs/BillingApi.md#get_customer_info) | **GET** /billing/customer | Get customer information
+*BillingApi* | [**get_plans**](docs/BillingApi.md#get_plans) | **GET** /billing/plans | Get all available plans with current plan marked
+*BillingApi* | [**get_plans_v2**](docs/BillingApi.md#get_plans_v2) | **GET** /billing/v2/plans | Get all available plans (v2)
+*BillingApi* | [**get_user_invoice_history**](docs/BillingApi.md#get_user_invoice_history) | **GET** /billing/invoices | Get user invoice history
+*BillingApi* | [**get_user_subscription**](docs/BillingApi.md#get_user_subscription) | **GET** /billing/subscription | Get user subscription details
+*ComponentsApi* | [**get_component_dependencies_by_purl_query_param**](docs/ComponentsApi.md#get_component_dependencies_by_purl_query_param) | **GET** /components/dependencies | Get dependencies for a component by coordinates (query parameters)
+*ComponentsApi* | [**get_component_detail_by_purl_query_param**](docs/ComponentsApi.md#get_component_detail_by_purl_query_param) | **GET** /components/detail | Get component detail by coordinates (query parameters)
+*ComponentsApi* | [**get_component_versions_by_purl_query_param**](docs/ComponentsApi.md#get_component_versions_by_purl_query_param) | **GET** /components/versions | Get all component versions by coordinates (query parameters)
+*ComponentsApi* | [**get_component_vulnerabilities_by_purl_query_param**](docs/ComponentsApi.md#get_component_vulnerabilities_by_purl_query_param) | **GET** /components/vulnerabilities | Get vulnerabilities for a component by coordinates (query parameters)
+*CreditsApi* | [**get_credit_usage_breakdown**](docs/CreditsApi.md#get_credit_usage_breakdown) | **GET** /credits/usage/breakdown | Get credit usage breakdown
+*CreditsApi* | [**get_credit_usage_history**](docs/CreditsApi.md#get_credit_usage_history) | **GET** /credits/usage/history | Get credit usage history
+*CurrentUserOrganizationApi* | [**accept_invitation**](docs/CurrentUserOrganizationApi.md#accept_invitation) | **POST** /users/me/organization/invitations/{invitationToken}/accept | Accept organization invitation
+*CurrentUserOrganizationApi* | [**bulk_remove_members_or_invitations**](docs/CurrentUserOrganizationApi.md#bulk_remove_members_or_invitations) | **DELETE** /users/me/organization/members | Bulk remove members or invitations from organization
+*CurrentUserOrganizationApi* | [**get_current_user_organization**](docs/CurrentUserOrganizationApi.md#get_current_user_organization) | **GET** /users/me/organization | Get current user&#39;s organization
+*CurrentUserOrganizationApi* | [**get_current_user_organization_v2**](docs/CurrentUserOrganizationApi.md#get_current_user_organization_v2) | **GET** /users/me/organization/v2 | Get current user&#39;s organization (v2)
+*CurrentUserOrganizationApi* | [**invite_users**](docs/CurrentUserOrganizationApi.md#invite_users) | **POST** /users/me/organization/members/invite | Invite users to current user&#39;s an organization
+*CurrentUserOrganizationApi* | [**remove_member_or_invitation**](docs/CurrentUserOrganizationApi.md#remove_member_or_invitation) | **DELETE** /users/me/organization/members/{email} | Remove member or invitation from organization
+*CurrentUserOrganizationApi* | [**retrieve_organization_members_as_csv**](docs/CurrentUserOrganizationApi.md#retrieve_organization_members_as_csv) | **GET** /users/me/organization/members | Retrieve current user&#39;s organization members and invitees
+*CurrentUserOrganizationApi* | [**update_organization**](docs/CurrentUserOrganizationApi.md#update_organization) | **PUT** /users/me/organization | Update current user&#39;s organization
+*CurrentUserTokensApi* | [**create_token**](docs/CurrentUserTokensApi.md#create_token) | **POST** /users/me/tokens | Create a new Personal Access Token
+*CurrentUserTokensApi* | [**get_token_by_id**](docs/CurrentUserTokensApi.md#get_token_by_id) | **GET** /users/me/tokens/{tokenId} | Get a Personal Access Token by ID
+*CurrentUserTokensApi* | [**list_tokens**](docs/CurrentUserTokensApi.md#list_tokens) | **GET** /users/me/tokens | List all Personal Access Tokens
+*CurrentUserTokensApi* | [**revoke_token**](docs/CurrentUserTokensApi.md#revoke_token) | **DELETE** /users/me/tokens/{tokenId} | Revoke a Personal Access Token
+*RecommendationsApi* | [**get_recommendations**](docs/RecommendationsApi.md#get_recommendations) | **POST** /recommendations | Get version upgrade recommendations
+*UsageApi* | [**get_billing_periods**](docs/UsageApi.md#get_billing_periods) | **GET** /usage/billing-periods | Get billing periods for user
+*UsageApi* | [**get_credit_balance**](docs/UsageApi.md#get_credit_balance) | **GET** /usage | Get credit balance
+*UsageApi* | [**get_credit_periods_v2**](docs/UsageApi.md#get_credit_periods_v2) | **GET** /usage/v2/credit-periods | Get credit periods (v2)
+*UsageApi* | [**get_cumulative_usage**](docs/UsageApi.md#get_cumulative_usage) | **GET** /usage/cumulative | Get cumulative credit usage for a billing period
+*UsageApi* | [**get_usage_v2**](docs/UsageApi.md#get_usage_v2) | **GET** /usage/v2 | Get usage information (v2)
+*VulnerabilitiesApi* | [**get_vulnerability_affected_components**](docs/VulnerabilitiesApi.md#get_vulnerability_affected_components) | **GET** /vulnerabilities/{id}/components | Get affected components for a vulnerability
+*VulnerabilitiesApi* | [**get_vulnerability_by_ref_id**](docs/VulnerabilitiesApi.md#get_vulnerability_by_ref_id) | **GET** /vulnerabilities/{id} | Get vulnerability by ID
+*OssiControllerApi* | [**get_component_report**](docs/OssiControllerApi.md#get_component_report) | **GET** /api/v3/authorized/component-report/** | 
+*OssiControllerApi* | [**get_component_report1**](docs/OssiControllerApi.md#get_component_report1) | **GET** /api/v3/component-report/** | 
+*OssiControllerApi* | [**get_component_reports**](docs/OssiControllerApi.md#get_component_reports) | **POST** /api/v3/component-report | 
+*OssiControllerApi* | [**get_component_reports1**](docs/OssiControllerApi.md#get_component_reports1) | **POST** /api/v3/authorized/component-report | 
+*OssiControllerApi* | [**get_version**](docs/OssiControllerApi.md#get_version) | **GET** /api/v3/version | 
+
+
+## Documentation For Models
+
+ - [AffectedComponentVersion](docs/AffectedComponentVersion.md)
+ - [ApiSearchResponse](docs/ApiSearchResponse.md)
+ - [ApiSearchResponseAffectedComponentVersion](docs/ApiSearchResponseAffectedComponentVersion.md)
+ - [ApiSearchResponseComponentDetailDocument](docs/ApiSearchResponseComponentDetailDocument.md)
+ - [ApiSearchResponseComponentDocument](docs/ApiSearchResponseComponentDocument.md)
+ - [ApiSearchResponseVulnerabilityDocument](docs/ApiSearchResponseVulnerabilityDocument.md)
+ - [BillingDTO](docs/BillingDTO.md)
+ - [BillingPeriod](docs/BillingPeriod.md)
+ - [BillingPeriodsResponse](docs/BillingPeriodsResponse.md)
+ - [BulkRemoveMembersRequest](docs/BulkRemoveMembersRequest.md)
+ - [ComponentArtifact](docs/ComponentArtifact.md)
+ - [ComponentDetailDocument](docs/ComponentDetailDocument.md)
+ - [ComponentDocument](docs/ComponentDocument.md)
+ - [ComponentLicense](docs/ComponentLicense.md)
+ - [ComponentReportGet](docs/ComponentReportGet.md)
+ - [ComponentReportPost](docs/ComponentReportPost.md)
+ - [CreateTokenRequest](docs/CreateTokenRequest.md)
+ - [CreditBalance](docs/CreditBalance.md)
+ - [CreditUsage](docs/CreditUsage.md)
+ - [CumulativeCreditUsage](docs/CumulativeCreditUsage.md)
+ - [CurrentUserOrganizationResponse](docs/CurrentUserOrganizationResponse.md)
+ - [CustomerInfo](docs/CustomerInfo.md)
+ - [DailyCreditUsage](docs/DailyCreditUsage.md)
+ - [FromVersion](docs/FromVersion.md)
+ - [InviteUsersRequest](docs/InviteUsersRequest.md)
+ - [Invoice](docs/Invoice.md)
+ - [OrganizationBillingDTO](docs/OrganizationBillingDTO.md)
+ - [OrganizationDTOv2](docs/OrganizationDTOv2.md)
+ - [OrganizationMembersResponse](docs/OrganizationMembersResponse.md)
+ - [OrganizationPlanDTO](docs/OrganizationPlanDTO.md)
+ - [OrganizationResponse](docs/OrganizationResponse.md)
+ - [OrganizationUsageDTO](docs/OrganizationUsageDTO.md)
+ - [OssiVulnerabilityPost](docs/OssiVulnerabilityPost.md)
+ - [PeriodDTO](docs/PeriodDTO.md)
+ - [Plan](docs/Plan.md)
+ - [PlanDTOv2](docs/PlanDTOv2.md)
+ - [PlanInfo](docs/PlanInfo.md)
+ - [PlansResponse](docs/PlansResponse.md)
+ - [PurlRequestPost](docs/PurlRequestPost.md)
+ - [RecommendationRequest](docs/RecommendationRequest.md)
+ - [RecommendationResponse](docs/RecommendationResponse.md)
+ - [RecommendedVersion](docs/RecommendedVersion.md)
+ - [Reference](docs/Reference.md)
+ - [Refid](docs/Refid.md)
+ - [SubscriptionDetailsResponse](docs/SubscriptionDetailsResponse.md)
+ - [UpdateOrganizationRequest](docs/UpdateOrganizationRequest.md)
+ - [UsageDTO](docs/UsageDTO.md)
+ - [UserTokenDTO](docs/UserTokenDTO.md)
+ - [UserTokenWithPlaintextDTO](docs/UserTokenWithPlaintextDTO.md)
+ - [VulnerabilityDetailDocument](docs/VulnerabilityDetailDocument.md)
+ - [VulnerabilityDocument](docs/VulnerabilityDocument.md)
+ - [VulnerableMethod](docs/VulnerableMethod.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="bearer-jwt"></a>
+### bearer-jwt
+
+- **Type**: Bearer authentication (JWT)
+
+
+## Author
+
+community@sonatype.com
+
+

sonatype_guide_api_client-0.0.2/README.md

@@ -0,0 +1,207 @@
+# sonatype-guide-api-client
+REST API into [Sonatype Guide](https://guide.sonatype.com).
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 202601
+- Package version: 1.0.0
+- Generator version: 7.16.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+For more information, please visit [https://github.com/sonatype-nexus-community](https://github.com/sonatype-nexus-community)
+
+## Requirements.
+
+Python 3.9+
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on a repository, you can install directly using:
+
+```sh
+pip install git+https://github.com/sonatype-nexus-community/sonatype-guide-api-client.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/sonatype-nexus-community/sonatype-guide-api-client.git`)
+
+Then import the package:
+```python
+import sonatype_guide_api_client
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import sonatype_guide_api_client
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import sonatype_guide_api_client
+from sonatype_guide_api_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://api.guide.sonatype.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = sonatype_guide_api_client.Configuration(
+    host = "http://api.guide.sonatype.com"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (JWT): bearer-jwt
+configuration = sonatype_guide_api_client.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+
+# Enter a context with an instance of the API client
+with sonatype_guide_api_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = sonatype_guide_api_client.BillingApi(api_client)
+
+    try:
+        # Get billing information (v2)
+        api_response = api_instance.get_billing_v2()
+        print("The response of BillingApi->get_billing_v2:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling BillingApi->get_billing_v2: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://api.guide.sonatype.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*BillingApi* | [**get_billing_v2**](docs/BillingApi.md#get_billing_v2) | **GET** /billing/v2 | Get billing information (v2)
+*BillingApi* | [**get_customer_info**](docs/BillingApi.md#get_customer_info) | **GET** /billing/customer | Get customer information
+*BillingApi* | [**get_plans**](docs/BillingApi.md#get_plans) | **GET** /billing/plans | Get all available plans with current plan marked
+*BillingApi* | [**get_plans_v2**](docs/BillingApi.md#get_plans_v2) | **GET** /billing/v2/plans | Get all available plans (v2)
+*BillingApi* | [**get_user_invoice_history**](docs/BillingApi.md#get_user_invoice_history) | **GET** /billing/invoices | Get user invoice history
+*BillingApi* | [**get_user_subscription**](docs/BillingApi.md#get_user_subscription) | **GET** /billing/subscription | Get user subscription details
+*ComponentsApi* | [**get_component_dependencies_by_purl_query_param**](docs/ComponentsApi.md#get_component_dependencies_by_purl_query_param) | **GET** /components/dependencies | Get dependencies for a component by coordinates (query parameters)
+*ComponentsApi* | [**get_component_detail_by_purl_query_param**](docs/ComponentsApi.md#get_component_detail_by_purl_query_param) | **GET** /components/detail | Get component detail by coordinates (query parameters)
+*ComponentsApi* | [**get_component_versions_by_purl_query_param**](docs/ComponentsApi.md#get_component_versions_by_purl_query_param) | **GET** /components/versions | Get all component versions by coordinates (query parameters)
+*ComponentsApi* | [**get_component_vulnerabilities_by_purl_query_param**](docs/ComponentsApi.md#get_component_vulnerabilities_by_purl_query_param) | **GET** /components/vulnerabilities | Get vulnerabilities for a component by coordinates (query parameters)
+*CreditsApi* | [**get_credit_usage_breakdown**](docs/CreditsApi.md#get_credit_usage_breakdown) | **GET** /credits/usage/breakdown | Get credit usage breakdown
+*CreditsApi* | [**get_credit_usage_history**](docs/CreditsApi.md#get_credit_usage_history) | **GET** /credits/usage/history | Get credit usage history
+*CurrentUserOrganizationApi* | [**accept_invitation**](docs/CurrentUserOrganizationApi.md#accept_invitation) | **POST** /users/me/organization/invitations/{invitationToken}/accept | Accept organization invitation
+*CurrentUserOrganizationApi* | [**bulk_remove_members_or_invitations**](docs/CurrentUserOrganizationApi.md#bulk_remove_members_or_invitations) | **DELETE** /users/me/organization/members | Bulk remove members or invitations from organization
+*CurrentUserOrganizationApi* | [**get_current_user_organization**](docs/CurrentUserOrganizationApi.md#get_current_user_organization) | **GET** /users/me/organization | Get current user's organization
+*CurrentUserOrganizationApi* | [**get_current_user_organization_v2**](docs/CurrentUserOrganizationApi.md#get_current_user_organization_v2) | **GET** /users/me/organization/v2 | Get current user's organization (v2)
+*CurrentUserOrganizationApi* | [**invite_users**](docs/CurrentUserOrganizationApi.md#invite_users) | **POST** /users/me/organization/members/invite | Invite users to current user's an organization
+*CurrentUserOrganizationApi* | [**remove_member_or_invitation**](docs/CurrentUserOrganizationApi.md#remove_member_or_invitation) | **DELETE** /users/me/organization/members/{email} | Remove member or invitation from organization
+*CurrentUserOrganizationApi* | [**retrieve_organization_members_as_csv**](docs/CurrentUserOrganizationApi.md#retrieve_organization_members_as_csv) | **GET** /users/me/organization/members | Retrieve current user's organization members and invitees
+*CurrentUserOrganizationApi* | [**update_organization**](docs/CurrentUserOrganizationApi.md#update_organization) | **PUT** /users/me/organization | Update current user's organization
+*CurrentUserTokensApi* | [**create_token**](docs/CurrentUserTokensApi.md#create_token) | **POST** /users/me/tokens | Create a new Personal Access Token
+*CurrentUserTokensApi* | [**get_token_by_id**](docs/CurrentUserTokensApi.md#get_token_by_id) | **GET** /users/me/tokens/{tokenId} | Get a Personal Access Token by ID
+*CurrentUserTokensApi* | [**list_tokens**](docs/CurrentUserTokensApi.md#list_tokens) | **GET** /users/me/tokens | List all Personal Access Tokens
+*CurrentUserTokensApi* | [**revoke_token**](docs/CurrentUserTokensApi.md#revoke_token) | **DELETE** /users/me/tokens/{tokenId} | Revoke a Personal Access Token
+*RecommendationsApi* | [**get_recommendations**](docs/RecommendationsApi.md#get_recommendations) | **POST** /recommendations | Get version upgrade recommendations
+*UsageApi* | [**get_billing_periods**](docs/UsageApi.md#get_billing_periods) | **GET** /usage/billing-periods | Get billing periods for user
+*UsageApi* | [**get_credit_balance**](docs/UsageApi.md#get_credit_balance) | **GET** /usage | Get credit balance
+*UsageApi* | [**get_credit_periods_v2**](docs/UsageApi.md#get_credit_periods_v2) | **GET** /usage/v2/credit-periods | Get credit periods (v2)
+*UsageApi* | [**get_cumulative_usage**](docs/UsageApi.md#get_cumulative_usage) | **GET** /usage/cumulative | Get cumulative credit usage for a billing period
+*UsageApi* | [**get_usage_v2**](docs/UsageApi.md#get_usage_v2) | **GET** /usage/v2 | Get usage information (v2)
+*VulnerabilitiesApi* | [**get_vulnerability_affected_components**](docs/VulnerabilitiesApi.md#get_vulnerability_affected_components) | **GET** /vulnerabilities/{id}/components | Get affected components for a vulnerability
+*VulnerabilitiesApi* | [**get_vulnerability_by_ref_id**](docs/VulnerabilitiesApi.md#get_vulnerability_by_ref_id) | **GET** /vulnerabilities/{id} | Get vulnerability by ID
+*OssiControllerApi* | [**get_component_report**](docs/OssiControllerApi.md#get_component_report) | **GET** /api/v3/authorized/component-report/** | 
+*OssiControllerApi* | [**get_component_report1**](docs/OssiControllerApi.md#get_component_report1) | **GET** /api/v3/component-report/** | 
+*OssiControllerApi* | [**get_component_reports**](docs/OssiControllerApi.md#get_component_reports) | **POST** /api/v3/component-report | 
+*OssiControllerApi* | [**get_component_reports1**](docs/OssiControllerApi.md#get_component_reports1) | **POST** /api/v3/authorized/component-report | 
+*OssiControllerApi* | [**get_version**](docs/OssiControllerApi.md#get_version) | **GET** /api/v3/version | 
+
+
+## Documentation For Models
+
+ - [AffectedComponentVersion](docs/AffectedComponentVersion.md)
+ - [ApiSearchResponse](docs/ApiSearchResponse.md)
+ - [ApiSearchResponseAffectedComponentVersion](docs/ApiSearchResponseAffectedComponentVersion.md)
+ - [ApiSearchResponseComponentDetailDocument](docs/ApiSearchResponseComponentDetailDocument.md)
+ - [ApiSearchResponseComponentDocument](docs/ApiSearchResponseComponentDocument.md)
+ - [ApiSearchResponseVulnerabilityDocument](docs/ApiSearchResponseVulnerabilityDocument.md)
+ - [BillingDTO](docs/BillingDTO.md)
+ - [BillingPeriod](docs/BillingPeriod.md)
+ - [BillingPeriodsResponse](docs/BillingPeriodsResponse.md)
+ - [BulkRemoveMembersRequest](docs/BulkRemoveMembersRequest.md)
+ - [ComponentArtifact](docs/ComponentArtifact.md)
+ - [ComponentDetailDocument](docs/ComponentDetailDocument.md)
+ - [ComponentDocument](docs/ComponentDocument.md)
+ - [ComponentLicense](docs/ComponentLicense.md)
+ - [ComponentReportGet](docs/ComponentReportGet.md)
+ - [ComponentReportPost](docs/ComponentReportPost.md)
+ - [CreateTokenRequest](docs/CreateTokenRequest.md)
+ - [CreditBalance](docs/CreditBalance.md)
+ - [CreditUsage](docs/CreditUsage.md)
+ - [CumulativeCreditUsage](docs/CumulativeCreditUsage.md)
+ - [CurrentUserOrganizationResponse](docs/CurrentUserOrganizationResponse.md)
+ - [CustomerInfo](docs/CustomerInfo.md)
+ - [DailyCreditUsage](docs/DailyCreditUsage.md)
+ - [FromVersion](docs/FromVersion.md)
+ - [InviteUsersRequest](docs/InviteUsersRequest.md)
+ - [Invoice](docs/Invoice.md)
+ - [OrganizationBillingDTO](docs/OrganizationBillingDTO.md)
+ - [OrganizationDTOv2](docs/OrganizationDTOv2.md)
+ - [OrganizationMembersResponse](docs/OrganizationMembersResponse.md)
+ - [OrganizationPlanDTO](docs/OrganizationPlanDTO.md)
+ - [OrganizationResponse](docs/OrganizationResponse.md)
+ - [OrganizationUsageDTO](docs/OrganizationUsageDTO.md)
+ - [OssiVulnerabilityPost](docs/OssiVulnerabilityPost.md)
+ - [PeriodDTO](docs/PeriodDTO.md)
+ - [Plan](docs/Plan.md)
+ - [PlanDTOv2](docs/PlanDTOv2.md)
+ - [PlanInfo](docs/PlanInfo.md)
+ - [PlansResponse](docs/PlansResponse.md)
+ - [PurlRequestPost](docs/PurlRequestPost.md)
+ - [RecommendationRequest](docs/RecommendationRequest.md)
+ - [RecommendationResponse](docs/RecommendationResponse.md)
+ - [RecommendedVersion](docs/RecommendedVersion.md)
+ - [Reference](docs/Reference.md)
+ - [Refid](docs/Refid.md)
+ - [SubscriptionDetailsResponse](docs/SubscriptionDetailsResponse.md)
+ - [UpdateOrganizationRequest](docs/UpdateOrganizationRequest.md)
+ - [UsageDTO](docs/UsageDTO.md)
+ - [UserTokenDTO](docs/UserTokenDTO.md)
+ - [UserTokenWithPlaintextDTO](docs/UserTokenWithPlaintextDTO.md)
+ - [VulnerabilityDetailDocument](docs/VulnerabilityDetailDocument.md)
+ - [VulnerabilityDocument](docs/VulnerabilityDocument.md)
+ - [VulnerableMethod](docs/VulnerableMethod.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="bearer-jwt"></a>
+### bearer-jwt
+
+- **Type**: Bearer authentication (JWT)
+
+
+## Author
+
+community@sonatype.com
+
+