Metadata-Version: 2.1
Name: robustintelligence
Version: 2.10.0rc8
Summary: Robust Intelligence REST API SDK
Maintainer-email: Robust Intelligence <support@robustintelligence.com>
Keywords: Robust Intelligence REST API SDK,Robust Intelligence SDK
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: deprecated <2.0.0,>=1.0.0
Requires-Dist: python-dateutil ==2.9.0.post0
Requires-Dist: pydantic <3,>=2
Requires-Dist: urllib3 <2.1.0,>=1.25.3

# ri.fwclient
API methods for Robust Intelligence. Users must authenticate using the `X-Firewall-Auth-Token` header.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0
- Package version: 1.0.0
- Generator version: 7.6.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://www.robustintelligence.com](https://www.robustintelligence.com)

## Requirements.

Python 3.7+

## 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/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import ri.fwclient
```

### 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 ri.fwclient
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import ri.fwclient
from ri.fwclient.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://https://<ai-firewall-domain>.rbst.io
# See configuration.py for a list of all supported configuration parameters.
configuration = ri.fwclient.Configuration(
    host = "http://https://<ai-firewall-domain>.rbst.io"
)

# 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 API key authorization: X-Firewall-Auth-Token
configuration.api_key['X-Firewall-Auth-Token'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['X-Firewall-Auth-Token'] = 'Bearer'


# Enter a context with an instance of the API client
with ri.fwclient.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ri.fwclient.FirewallApi(api_client)
    firewall_instance_id_uuid = 'firewall_instance_id_uuid_example' # str | Unique object ID.

    try:
        # GetFirewallEffectiveConfig
        api_response = api_instance.effective_config(firewall_instance_id_uuid)
        print("The response of FirewallApi->effective_config:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FirewallApi->effective_config: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://https://<ai-firewall-domain>.rbst.io*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*FirewallApi* | [**effective_config**](docs/FirewallApi.md#effective_config) | **GET** /v1-beta/firewall/{firewallInstanceId.uuid}/effective-config | GetFirewallEffectiveConfig
*FirewallApi* | [**validate**](docs/FirewallApi.md#validate) | **PUT** /v1-beta/firewall/{firewallInstanceId.uuid}/validate | Validate
*FirewallInstanceManagerApi* | [**create_instance**](docs/FirewallInstanceManagerApi.md#create_instance) | **POST** /v1-beta/firewall-instance | CreateFirewallInstance
*FirewallInstanceManagerApi* | [**delete_instance**](docs/FirewallInstanceManagerApi.md#delete_instance) | **DELETE** /v1-beta/firewall-instance/{firewallInstanceId.uuid} | DeleteFirewallInstance
*FirewallInstanceManagerApi* | [**get_instance**](docs/FirewallInstanceManagerApi.md#get_instance) | **GET** /v1-beta/firewall-instance/{firewallInstanceId.uuid} | GetFirewallInstance
*FirewallInstanceManagerApi* | [**list_instances**](docs/FirewallInstanceManagerApi.md#list_instances) | **GET** /v1-beta/firewall-instance | ListFirewallInstances
*FirewallInstanceManagerApi* | [**update_instance**](docs/FirewallInstanceManagerApi.md#update_instance) | **PATCH** /v1-beta/firewall-instance/{firewallInstance.firewallInstanceId.uuid} | UpdateFirewallInstance


## Documentation For Models

 - [CodeDetectionDetailsCodeSubstring](docs/CodeDetectionDetailsCodeSubstring.md)
 - [FlaggedSubstringRequestBodyComponent](docs/FlaggedSubstringRequestBodyComponent.md)
 - [GenerativefirewallCodeDetectionDetails](docs/GenerativefirewallCodeDetectionDetails.md)
 - [GenerativefirewallCodeDetectionRuleConfig](docs/GenerativefirewallCodeDetectionRuleConfig.md)
 - [GenerativefirewallCreateFirewallInstanceRequest](docs/GenerativefirewallCreateFirewallInstanceRequest.md)
 - [GenerativefirewallCreateFirewallInstanceResponse](docs/GenerativefirewallCreateFirewallInstanceResponse.md)
 - [GenerativefirewallCustomPiiEntity](docs/GenerativefirewallCustomPiiEntity.md)
 - [GenerativefirewallFirewallAction](docs/GenerativefirewallFirewallAction.md)
 - [GenerativefirewallFirewallInstanceDeploymentConfig](docs/GenerativefirewallFirewallInstanceDeploymentConfig.md)
 - [GenerativefirewallFirewallInstanceInfo](docs/GenerativefirewallFirewallInstanceInfo.md)
 - [GenerativefirewallFirewallInstanceStatus](docs/GenerativefirewallFirewallInstanceStatus.md)
 - [GenerativefirewallFirewallRuleConfig](docs/GenerativefirewallFirewallRuleConfig.md)
 - [GenerativefirewallFirewallRuleType](docs/GenerativefirewallFirewallRuleType.md)
 - [GenerativefirewallFirewallTokenizer](docs/GenerativefirewallFirewallTokenizer.md)
 - [GenerativefirewallFlaggedSubstring](docs/GenerativefirewallFlaggedSubstring.md)
 - [GenerativefirewallGetFirewallEffectiveConfigResponse](docs/GenerativefirewallGetFirewallEffectiveConfigResponse.md)
 - [GenerativefirewallGetFirewallInstanceResponse](docs/GenerativefirewallGetFirewallInstanceResponse.md)
 - [GenerativefirewallIndividualRulesConfig](docs/GenerativefirewallIndividualRulesConfig.md)
 - [GenerativefirewallLanguageDetectionDetails](docs/GenerativefirewallLanguageDetectionDetails.md)
 - [GenerativefirewallLanguageDetectionRuleConfig](docs/GenerativefirewallLanguageDetectionRuleConfig.md)
 - [GenerativefirewallListFirewallInstancesResponse](docs/GenerativefirewallListFirewallInstancesResponse.md)
 - [GenerativefirewallOffTopicRuleConfig](docs/GenerativefirewallOffTopicRuleConfig.md)
 - [GenerativefirewallPiiDetectionDetails](docs/GenerativefirewallPiiDetectionDetails.md)
 - [GenerativefirewallPiiDetectionRuleConfig](docs/GenerativefirewallPiiDetectionRuleConfig.md)
 - [GenerativefirewallPiiEntityType](docs/GenerativefirewallPiiEntityType.md)
 - [GenerativefirewallPromptInjectionDetails](docs/GenerativefirewallPromptInjectionDetails.md)
 - [GenerativefirewallPromptInjectionRuleConfig](docs/GenerativefirewallPromptInjectionRuleConfig.md)
 - [GenerativefirewallRawModelPrediction](docs/GenerativefirewallRawModelPrediction.md)
 - [GenerativefirewallRuleOutput](docs/GenerativefirewallRuleOutput.md)
 - [GenerativefirewallRuleSensitivity](docs/GenerativefirewallRuleSensitivity.md)
 - [GenerativefirewallStandardInfo](docs/GenerativefirewallStandardInfo.md)
 - [GenerativefirewallTokenCounterRuleConfig](docs/GenerativefirewallTokenCounterRuleConfig.md)
 - [GenerativefirewallToxicityDetectionDetails](docs/GenerativefirewallToxicityDetectionDetails.md)
 - [GenerativefirewallToxicityRuleConfig](docs/GenerativefirewallToxicityRuleConfig.md)
 - [GenerativefirewallToxicityRuleMode](docs/GenerativefirewallToxicityRuleMode.md)
 - [GenerativefirewallUnknownExternalSourceRuleConfig](docs/GenerativefirewallUnknownExternalSourceRuleConfig.md)
 - [GenerativefirewallUpdateFirewallInstanceResponse](docs/GenerativefirewallUpdateFirewallInstanceResponse.md)
 - [GenerativefirewallValidateResponse](docs/GenerativefirewallValidateResponse.md)
 - [GooglerpcStatus](docs/GooglerpcStatus.md)
 - [LanguageDetectionDetailsLanguageSubstring](docs/LanguageDetectionDetailsLanguageSubstring.md)
 - [PiiDetectionDetailsFlaggedEntity](docs/PiiDetectionDetailsFlaggedEntity.md)
 - [ProtobufAny](docs/ProtobufAny.md)
 - [RawModelPredictionTextClassificationPred](docs/RawModelPredictionTextClassificationPred.md)
 - [RimeAttackObjective](docs/RimeAttackObjective.md)
 - [RimeAttackTechnique](docs/RimeAttackTechnique.md)
 - [RimeLanguage](docs/RimeLanguage.md)
 - [RimeToxicityThreatCategory](docs/RimeToxicityThreatCategory.md)
 - [RimeUUID](docs/RimeUUID.md)
 - [RiskscoreRiskCategoryType](docs/RiskscoreRiskCategoryType.md)
 - [RuleEvaluationMetadataModelInfo](docs/RuleEvaluationMetadataModelInfo.md)
 - [RuleEvaluationMetadataYaraInfo](docs/RuleEvaluationMetadataYaraInfo.md)
 - [RuleOutputRuleEvaluationMetadata](docs/RuleOutputRuleEvaluationMetadata.md)
 - [UpdateInstanceRequest](docs/UpdateInstanceRequest.md)
 - [ValidateRequest](docs/ValidateRequest.md)
 - [ValidateResponseProcessedRequest](docs/ValidateResponseProcessedRequest.md)
 - [ValidateResponseProductMetadata](docs/ValidateResponseProductMetadata.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="X-Firewall-Auth-Token"></a>
### X-Firewall-Auth-Token

- **Type**: API key
- **API key parameter name**: X-Firewall-Auth-Token
- **Location**: HTTP header


## Author

dev@robustintelligence.com
