sonatype-guide-api-client 0.0.2
Sonatype Guide API
License: Apache 2.0
Requires Python: >=3.9
Keywords: OpenAPI, OpenAPI-Generator, Sonatype Guide API

# 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