Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 30 additions & 6 deletions generated/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ docs/AllNotes.md
docs/AnnotationsRequestedEnum.md
docs/ApiToken.md
docs/ApiTokenCreateResponse.md
docs/ApiTokenRequest.md
docs/ApiTokenCreationInputRequest.md
docs/ApiTokensApi.md
docs/BBoxGeometry.md
docs/BBoxGeometryRequest.md
Expand All @@ -29,25 +29,31 @@ docs/DetectorGroupRequest.md
docs/DetectorGroupsApi.md
docs/DetectorModeEnum.md
docs/DetectorResetApi.md
docs/DetectorStatusEnum.md
docs/DetectorTypeEnum.md
docs/DetectorsApi.md
docs/EdgeApi.md
docs/EdgeModelInfo.md
docs/EscalationTypeEnum.md
docs/GLLEngineInfo.md
docs/GLLEngineInfoRequest.md
docs/GLLModelInfo.md
docs/GLLPipelineInfo.md
docs/Group.md
docs/ImageQueriesApi.md
docs/ImageQuery.md
docs/ImageQueryTypeEnum.md
docs/InlineResponse200.md
docs/InlineResponse2001.md
docs/InlineResponse2001EvaluationResults.md
docs/InlineResponse2002.md
docs/InlineResponse200Summary.md
docs/InlineResponse200SummaryClassCounts.md
docs/Label.md
docs/LabelValue.md
docs/LabelValueRequest.md
docs/LabelsApi.md
docs/MLPipeline.md
docs/Me.md
docs/ModeEnum.md
docs/MonthToDateAccountInfoApi.md
docs/MultiClassModeConfiguration.md
Expand Down Expand Up @@ -76,7 +82,8 @@ docs/RuleRequest.md
docs/SnoozeTimeUnitEnum.md
docs/Source.md
docs/SourceEnum.md
docs/StatusEnum.md
docs/StaleFromStatusEnum.md
docs/Status638Enum.md
docs/TextModeConfiguration.md
docs/TextRecognitionResult.md
docs/UserApi.md
Expand Down Expand Up @@ -116,7 +123,7 @@ groundlight_openapi_client/model/all_notes.py
groundlight_openapi_client/model/annotations_requested_enum.py
groundlight_openapi_client/model/api_token.py
groundlight_openapi_client/model/api_token_create_response.py
groundlight_openapi_client/model/api_token_request.py
groundlight_openapi_client/model/api_token_creation_input_request.py
groundlight_openapi_client/model/b_box_geometry.py
groundlight_openapi_client/model/b_box_geometry_request.py
groundlight_openapi_client/model/binary_classification_result.py
Expand All @@ -134,20 +141,26 @@ groundlight_openapi_client/model/detector_creation_input_request.py
groundlight_openapi_client/model/detector_group.py
groundlight_openapi_client/model/detector_group_request.py
groundlight_openapi_client/model/detector_mode_enum.py
groundlight_openapi_client/model/detector_status_enum.py
groundlight_openapi_client/model/detector_type_enum.py
groundlight_openapi_client/model/edge_model_info.py
groundlight_openapi_client/model/escalation_type_enum.py
groundlight_openapi_client/model/gll_engine_info.py
groundlight_openapi_client/model/gll_engine_info_request.py
groundlight_openapi_client/model/gll_model_info.py
groundlight_openapi_client/model/gll_pipeline_info.py
groundlight_openapi_client/model/group.py
groundlight_openapi_client/model/image_query.py
groundlight_openapi_client/model/image_query_type_enum.py
groundlight_openapi_client/model/inline_response200.py
groundlight_openapi_client/model/inline_response2001.py
groundlight_openapi_client/model/inline_response2001_evaluation_results.py
groundlight_openapi_client/model/inline_response2002.py
groundlight_openapi_client/model/inline_response200_summary.py
groundlight_openapi_client/model/inline_response200_summary_class_counts.py
groundlight_openapi_client/model/label.py
groundlight_openapi_client/model/label_value.py
groundlight_openapi_client/model/label_value_request.py
groundlight_openapi_client/model/me.py
groundlight_openapi_client/model/ml_pipeline.py
groundlight_openapi_client/model/mode_enum.py
groundlight_openapi_client/model/multi_class_mode_configuration.py
Expand All @@ -174,7 +187,8 @@ groundlight_openapi_client/model/rule_request.py
groundlight_openapi_client/model/snooze_time_unit_enum.py
groundlight_openapi_client/model/source.py
groundlight_openapi_client/model/source_enum.py
groundlight_openapi_client/model/status_enum.py
groundlight_openapi_client/model/stale_from_status_enum.py
groundlight_openapi_client/model/status638_enum.py
groundlight_openapi_client/model/text_mode_configuration.py
groundlight_openapi_client/model/text_recognition_result.py
groundlight_openapi_client/model/verb_enum.py
Expand All @@ -192,4 +206,14 @@ setup.cfg
setup.py
test-requirements.txt
test/__init__.py
test/test_api_token_creation_input_request.py
test/test_detector_status_enum.py
test/test_gll_engine_info.py
test/test_gll_engine_info_request.py
test/test_gll_model_info.py
test/test_gll_pipeline_info.py
test/test_group.py
test/test_me.py
test/test_stale_from_status_enum.py
test/test_status638_enum.py
tox.ini
18 changes: 15 additions & 3 deletions generated/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,12 @@ Class | Method | HTTP request | Description
*DetectorsApi* | [**list_detectors**](docs/DetectorsApi.md#list_detectors) | **GET** /v1/detectors |
*DetectorsApi* | [**update_detector**](docs/DetectorsApi.md#update_detector) | **PATCH** /v1/detectors/{id} |
*EdgeApi* | [**edge_report_metrics_create**](docs/EdgeApi.md#edge_report_metrics_create) | **POST** /v1/edge/report-metrics |
*EdgeApi* | [**get_gll_model_info**](docs/EdgeApi.md#get_gll_model_info) | **GET** /v1/edge/model-info/{detector_id}/ |
*EdgeApi* | [**get_gll_pipeline**](docs/EdgeApi.md#get_gll_pipeline) | **GET** /v1/edge/gll-pipeline/{detector_id}/ |
*EdgeApi* | [**get_gll_tensor_rt_engine_build**](docs/EdgeApi.md#get_gll_tensor_rt_engine_build) | **GET** /v1/edge/gll-engine/{detector_id}/ |
*EdgeApi* | [**get_model_urls**](docs/EdgeApi.md#get_model_urls) | **GET** /v1/edge/fetch-model-urls/{detector_id}/ |
*EdgeApi* | [**initiate_gll_pipeline_build**](docs/EdgeApi.md#initiate_gll_pipeline_build) | **POST** /v1/edge/gll-pipeline/{detector_id}/ |
*EdgeApi* | [**initiate_gll_tensor_rt_engine_build**](docs/EdgeApi.md#initiate_gll_tensor_rt_engine_build) | **POST** /v1/edge/gll-engine/{detector_id}/ |
*ImageQueriesApi* | [**get_image**](docs/ImageQueriesApi.md#get_image) | **GET** /v1/image-queries/{id}/image |
*ImageQueriesApi* | [**get_image_query**](docs/ImageQueriesApi.md#get_image_query) | **GET** /v1/image-queries/{id} |
*ImageQueriesApi* | [**list_image_queries**](docs/ImageQueriesApi.md#list_image_queries) | **GET** /v1/image-queries |
Expand All @@ -162,7 +167,7 @@ Class | Method | HTTP request | Description
- [AnnotationsRequestedEnum](docs/AnnotationsRequestedEnum.md)
- [ApiToken](docs/ApiToken.md)
- [ApiTokenCreateResponse](docs/ApiTokenCreateResponse.md)
- [ApiTokenRequest](docs/ApiTokenRequest.md)
- [ApiTokenCreationInputRequest](docs/ApiTokenCreationInputRequest.md)
- [BBoxGeometry](docs/BBoxGeometry.md)
- [BBoxGeometryRequest](docs/BBoxGeometryRequest.md)
- [BinaryClassificationResult](docs/BinaryClassificationResult.md)
Expand All @@ -180,21 +185,27 @@ Class | Method | HTTP request | Description
- [DetectorGroup](docs/DetectorGroup.md)
- [DetectorGroupRequest](docs/DetectorGroupRequest.md)
- [DetectorModeEnum](docs/DetectorModeEnum.md)
- [DetectorStatusEnum](docs/DetectorStatusEnum.md)
- [DetectorTypeEnum](docs/DetectorTypeEnum.md)
- [EdgeModelInfo](docs/EdgeModelInfo.md)
- [EscalationTypeEnum](docs/EscalationTypeEnum.md)
- [GLLEngineInfo](docs/GLLEngineInfo.md)
- [GLLEngineInfoRequest](docs/GLLEngineInfoRequest.md)
- [GLLModelInfo](docs/GLLModelInfo.md)
- [GLLPipelineInfo](docs/GLLPipelineInfo.md)
- [Group](docs/Group.md)
- [ImageQuery](docs/ImageQuery.md)
- [ImageQueryTypeEnum](docs/ImageQueryTypeEnum.md)
- [InlineResponse200](docs/InlineResponse200.md)
- [InlineResponse2001](docs/InlineResponse2001.md)
- [InlineResponse2001EvaluationResults](docs/InlineResponse2001EvaluationResults.md)
- [InlineResponse2002](docs/InlineResponse2002.md)
- [InlineResponse200Summary](docs/InlineResponse200Summary.md)
- [InlineResponse200SummaryClassCounts](docs/InlineResponse200SummaryClassCounts.md)
- [Label](docs/Label.md)
- [LabelValue](docs/LabelValue.md)
- [LabelValueRequest](docs/LabelValueRequest.md)
- [MLPipeline](docs/MLPipeline.md)
- [Me](docs/Me.md)
- [ModeEnum](docs/ModeEnum.md)
- [MultiClassModeConfiguration](docs/MultiClassModeConfiguration.md)
- [MultiClassificationResult](docs/MultiClassificationResult.md)
Expand All @@ -220,7 +231,8 @@ Class | Method | HTTP request | Description
- [SnoozeTimeUnitEnum](docs/SnoozeTimeUnitEnum.md)
- [Source](docs/Source.md)
- [SourceEnum](docs/SourceEnum.md)
- [StatusEnum](docs/StatusEnum.md)
- [StaleFromStatusEnum](docs/StaleFromStatusEnum.md)
- [Status638Enum](docs/Status638Enum.md)
- [TextModeConfiguration](docs/TextModeConfiguration.md)
- [TextRecognitionResult](docs/TextRecognitionResult.md)
- [VerbEnum](docs/VerbEnum.md)
Expand Down
4 changes: 2 additions & 2 deletions generated/docs/ApiToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ Name | Type | Description | Notes
**name** | **str** | An nickname for the API token. This name must be unique for this user. |
**raw_key_snippet** | **str** | Since we're storing hashed keys, it can be useful to see the raw prefix snippet of the token. | [readonly]
**created_at** | **datetime** | When was this token created? | [readonly]
**last_used_at** | **datetime, none_type** | The most recent time this API token was used. (Helpful for detecting suspicious activity). Null if the token has never been used. | [readonly]
**last_used_at** | **datetime, none_type** | The most recent time this API token was used for authentication. Null until first use. | [readonly]
**expires_at** | **datetime, none_type** | When does this token expire? If Null, the token never expires. | [optional]
**token_ttl** | **int, none_type** | Identity token lifetime policy in whole seconds. Null means tokens minted under this identity never expire (no rotation). | [optional] [readonly]
**token_ttl** | **int, none_type** | Identity token lifetime policy in whole seconds. Null means tokens minted under this identity never expire. Omitted only by older servers that do not yet expose this field. | [optional] [readonly]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
4 changes: 2 additions & 2 deletions generated/docs/ApiTokenCreateResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@ Name | Type | Description | Notes
**name** | **str** | An nickname for the API token. This name must be unique for this user. |
**raw_key_snippet** | **str** | Since we're storing hashed keys, it can be useful to see the raw prefix snippet of the token. | [readonly]
**created_at** | **datetime** | When was this token created? | [readonly]
**last_used_at** | **datetime, none_type** | The most recent time this API token was used. (Helpful for detecting suspicious activity). Null if the token has never been used. | [readonly]
**last_used_at** | **datetime, none_type** | The most recent time this API token was used for authentication. Null until first use. | [readonly]
**raw_key** | **str** | The full API token secret. Returned only once, when the token is created. | [readonly]
**expires_at** | **datetime, none_type** | When does this token expire? If Null, the token never expires. | [optional]
**token_ttl** | **int, none_type** | Identity token lifetime policy in whole seconds. Null means tokens minted under this identity never expire (no rotation). | [optional] [readonly]
**token_ttl** | **int, none_type** | Identity token lifetime policy in whole seconds. Null means tokens minted under this identity never expire. Omitted only by older servers that do not yet expose this field. | [optional] [readonly]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
13 changes: 13 additions & 0 deletions generated/docs/ApiTokenCreationInputRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# ApiTokenCreationInputRequest

Public create-token body (name only).

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | An nickname for the API token. This name must be unique for this user. |
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


13 changes: 6 additions & 7 deletions generated/docs/ApiTokensApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Method | HTTP request | Description


# **create_api_token**
> ApiTokenCreateResponse create_api_token(api_token_request)
> ApiTokenCreateResponse create_api_token(api_token_creation_input_request)



Expand All @@ -25,8 +25,8 @@ Create a new API token, returning the raw_key exactly once in the response.
import time
import groundlight_openapi_client
from groundlight_openapi_client.api import api_tokens_api
from groundlight_openapi_client.model.api_token_request import ApiTokenRequest
from groundlight_openapi_client.model.api_token_create_response import ApiTokenCreateResponse
from groundlight_openapi_client.model.api_token_creation_input_request import ApiTokenCreationInputRequest
from pprint import pprint
# Defining the host is optional and defaults to https://api.groundlight.ai/device-api
# See configuration.py for a list of all supported configuration parameters.
Expand All @@ -49,14 +49,13 @@ configuration.api_key['ApiToken'] = 'YOUR_API_KEY'
with groundlight_openapi_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = api_tokens_api.ApiTokensApi(api_client)
api_token_request = ApiTokenRequest(
api_token_creation_input_request = ApiTokenCreationInputRequest(
name="name_example",
expires_at=dateutil_parser('1970-01-01T00:00:00.00Z'),
) # ApiTokenRequest |
) # ApiTokenCreationInputRequest |

# example passing only required values which don't have defaults set
try:
api_response = api_instance.create_api_token(api_token_request)
api_response = api_instance.create_api_token(api_token_creation_input_request)
pprint(api_response)
except groundlight_openapi_client.ApiException as e:
print("Exception when calling ApiTokensApi->create_api_token: %s\n" % e)
Expand All @@ -67,7 +66,7 @@ with groundlight_openapi_client.ApiClient(configuration) as api_client:

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**api_token_request** | [**ApiTokenRequest**](ApiTokenRequest.md)| |
**api_token_creation_input_request** | [**ApiTokenCreationInputRequest**](ApiTokenCreationInputRequest.md)| |

### Return type

Expand Down
2 changes: 1 addition & 1 deletion generated/docs/DetectorCreationInputRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Name | Type | Description | Notes
**metadata** | **str** | Base64-encoded metadata for the detector. This should be a JSON object with string keys. The size after encoding should not exceed 1362 bytes, corresponding to 1KiB before encoding. | [optional]
**mode** | **bool, date, datetime, dict, float, int, list, str, none_type** | Mode in which this detector will work. * `BINARY` - BINARY * `COUNT` - COUNT * `MULTI_CLASS` - MULTI_CLASS * `TEXT` - TEXT * `BOUNDING_BOX` - BOUNDING_BOX | [optional]
**mode_configuration** | **bool, date, datetime, dict, float, int, list, str, none_type** | | [optional]
**priming_group_id** | **str, none_type** | ID of an existing PrimingGroup to associate with this detector (optional). | [optional]
**priming_group_id** | **str, none_type** | ID of an existing PrimingGroup to associate with this detector (optional). Must be a priming group your account owns or a global one; any other ID is reported as not found. | [optional]
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
12 changes: 12 additions & 0 deletions generated/docs/DetectorStatusEnum.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# DetectorStatusEnum

* `ON` - ON * `OFF` - OFF

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **str** | * `ON` - ON * `OFF` - OFF | must be one of ["ON", "OFF", ]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading