Skip to content

Commit abd691a

Browse files
authored
Latest client (#3)
1 parent 32673a2 commit abd691a

File tree

165 files changed

+9463
-1896
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

165 files changed

+9463
-1896
lines changed

README.md

Lines changed: 67 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
# platform-api-client
1+
# platform-api-python-client
22
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
33

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

66
- API version: 0.1.0
77
- Package version: 1.0.0
8+
- Generator version: 7.5.0
89
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
910

1011
## Requirements.
@@ -17,13 +18,13 @@ Python 3.7+
1718
If the python package is hosted on a repository, you can install directly using:
1819

1920
```sh
20-
pip install git+https://github.com/CentML/platform_api_python_client.git
21+
pip install git+https://github.com/centml/platform/client.git
2122
```
22-
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/CentML/platform_api_python_client.git`)
23+
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/centml/platform/client.git`)
2324

2425
Then import the package:
2526
```python
26-
import platform_api_client
27+
import platform_api_python_client
2728
```
2829

2930
### Setuptools
@@ -37,7 +38,7 @@ python setup.py install --user
3738

3839
Then import the package:
3940
```python
40-
import platform_api_client
41+
import platform_api_python_client
4142
```
4243

4344
### Tests
@@ -50,13 +51,13 @@ Please follow the [installation procedure](#installation--usage) and then run th
5051

5152
```python
5253

53-
import platform_api_client
54-
from platform_api_client.rest import ApiException
54+
import platform_api_python_client
55+
from platform_api_python_client.rest import ApiException
5556
from pprint import pprint
5657

5758
# Defining the host is optional and defaults to http://localhost
5859
# See configuration.py for a list of all supported configuration parameters.
59-
configuration = platform_api_client.Configuration(
60+
configuration = platform_api_python_client.Configuration(
6061
host = "http://localhost"
6162
)
6263

@@ -66,24 +67,24 @@ configuration = platform_api_client.Configuration(
6667
# satisfies your auth use case.
6768

6869
# Configure Bearer authorization: HTTPBearer
69-
configuration = platform_api_client.Configuration(
70+
configuration = platform_api_python_client.Configuration(
7071
access_token = os.environ["BEARER_TOKEN"]
7172
)
7273

7374

7475
# Enter a context with an instance of the API client
75-
with platform_api_client.ApiClient(configuration) as api_client:
76+
with platform_api_python_client.ApiClient(configuration) as api_client:
7677
# Create an instance of the API class
77-
api_instance = platform_api_client.EXTERNALApi(api_client)
78-
create_compute_deployment_request = platform_api_client.CreateComputeDeploymentRequest() # CreateComputeDeploymentRequest |
78+
api_instance = platform_api_python_client.EXTERNALApi(api_client)
79+
feedback_request = platform_api_python_client.FeedbackRequest() # FeedbackRequest |
7980

8081
try:
81-
# Create Compute Deployment
82-
api_response = api_instance.create_compute_deployment_deployments_compute_post(create_compute_deployment_request)
83-
print("The response of EXTERNALApi->create_compute_deployment_deployments_compute_post:\n")
82+
# Add Feedback Request
83+
api_response = api_instance.add_feedback_request_support_feedback_post(feedback_request)
84+
print("The response of EXTERNALApi->add_feedback_request_support_feedback_post:\n")
8485
pprint(api_response)
8586
except ApiException as e:
86-
print("Exception when calling EXTERNALApi->create_compute_deployment_deployments_compute_post: %s\n" % e)
87+
print("Exception when calling EXTERNALApi->add_feedback_request_support_feedback_post: %s\n" % e)
8788

8889
```
8990

@@ -93,54 +94,82 @@ All URIs are relative to *http://localhost*
9394

9495
Class | Method | HTTP request | Description
9596
------------ | ------------- | ------------- | -------------
96-
*EXTERNALApi* | [**create_compute_deployment_deployments_compute_post**](docs/EXTERNALApi.md#create_compute_deployment_deployments_compute_post) | **POST** /deployments/compute | Create Compute Deployment
97-
*EXTERNALApi* | [**create_inference_deployment_deployments_inference_post**](docs/EXTERNALApi.md#create_inference_deployment_deployments_inference_post) | **POST** /deployments/inference | Create Inference Deployment
97+
*EXTERNALApi* | [**add_feedback_request_support_feedback_post**](docs/EXTERNALApi.md#add_feedback_request_support_feedback_post) | **POST** /support/feedback | Add Feedback Request
98+
*EXTERNALApi* | [**create_api_key_credentials_api_key_post**](docs/EXTERNALApi.md#create_api_key_credentials_api_key_post) | **POST** /credentials/api-key | Create Api Key
99+
*EXTERNALApi* | [**create_compute_deployment_deployments_v2_compute_post**](docs/EXTERNALApi.md#create_compute_deployment_deployments_v2_compute_post) | **POST** /deployments/v2/compute | Create Compute Deployment
100+
*EXTERNALApi* | [**create_cserve_deployment_deployments_v2_cserve_post**](docs/EXTERNALApi.md#create_cserve_deployment_deployments_v2_cserve_post) | **POST** /deployments/v2/cserve | Create Cserve Deployment
101+
*EXTERNALApi* | [**create_hardware_request_support_hardware_request_post**](docs/EXTERNALApi.md#create_hardware_request_support_hardware_request_post) | **POST** /support/hardware-request | Create Hardware Request
102+
*EXTERNALApi* | [**create_inference_deployment_deployments_v2_inference_post**](docs/EXTERNALApi.md#create_inference_deployment_deployments_v2_inference_post) | **POST** /deployments/v2/inference | Create Inference Deployment
98103
*EXTERNALApi* | [**create_payment_payments_post**](docs/EXTERNALApi.md#create_payment_payments_post) | **POST** /payments | Create Payment
99104
*EXTERNALApi* | [**create_payment_setup_payments_setup_post**](docs/EXTERNALApi.md#create_payment_setup_payments_setup_post) | **POST** /payments/setup | Create Payment Setup
100-
*EXTERNALApi* | [**create_training_deployment_deployments_training_post**](docs/EXTERNALApi.md#create_training_deployment_deployments_training_post) | **POST** /deployments/training | Create Training Deployment
105+
*EXTERNALApi* | [**delete_api_key_credentials_api_key_id_delete**](docs/EXTERNALApi.md#delete_api_key_credentials_api_key_id_delete) | **DELETE** /credentials/api-key/{id} | Delete Api Key
101106
*EXTERNALApi* | [**delete_payment_method_payments_methods_payment_method_delete**](docs/EXTERNALApi.md#delete_payment_method_payments_methods_payment_method_delete) | **DELETE** /payments/methods/{payment_method} | Delete Payment Method
102-
*EXTERNALApi* | [**get_compute_deployment_deployments_compute_deployment_id_get**](docs/EXTERNALApi.md#get_compute_deployment_deployments_compute_deployment_id_get) | **GET** /deployments/compute/{deployment_id} | Get Compute Deployment
107+
*EXTERNALApi* | [**get_api_keys_credentials_api_key_get**](docs/EXTERNALApi.md#get_api_keys_credentials_api_key_get) | **GET** /credentials/api-key | Get Api Keys
108+
*EXTERNALApi* | [**get_clusters_clusters_get**](docs/EXTERNALApi.md#get_clusters_clusters_get) | **GET** /clusters | Get Clusters
109+
*EXTERNALApi* | [**get_compute_deployment_deployments_v2_compute_deployment_id_get**](docs/EXTERNALApi.md#get_compute_deployment_deployments_v2_compute_deployment_id_get) | **GET** /deployments/v2/compute/{deployment_id} | Get Compute Deployment
103110
*EXTERNALApi* | [**get_credits_credits_get**](docs/EXTERNALApi.md#get_credits_credits_get) | **GET** /credits | Get Credits
104-
*EXTERNALApi* | [**get_deployment_status_deployments_status_deployment_id_get**](docs/EXTERNALApi.md#get_deployment_status_deployments_status_deployment_id_get) | **GET** /deployments/status/{deployment_id} | Get Deployment Status
105-
*EXTERNALApi* | [**get_deployments_deployments_get**](docs/EXTERNALApi.md#get_deployments_deployments_get) | **GET** /deployments | Get Deployments
111+
*EXTERNALApi* | [**get_cserve_deployment_deployments_v2_cserve_deployment_id_get**](docs/EXTERNALApi.md#get_cserve_deployment_deployments_v2_cserve_deployment_id_get) | **GET** /deployments/v2/cserve/{deployment_id} | Get Cserve Deployment
112+
*EXTERNALApi* | [**get_cserve_recipe_deployments_v2_cserve_recipes_get**](docs/EXTERNALApi.md#get_cserve_recipe_deployments_v2_cserve_recipes_get) | **GET** /deployments/v2/cserve/recipes | Get Cserve Recipe
113+
*EXTERNALApi* | [**get_deployment_logs_deployments_logs_deployment_id_get**](docs/EXTERNALApi.md#get_deployment_logs_deployments_logs_deployment_id_get) | **GET** /deployments/logs/{deployment_id} | Get Deployment Logs
114+
*EXTERNALApi* | [**get_deployment_status_deployments_v2_status_deployment_id_get**](docs/EXTERNALApi.md#get_deployment_status_deployments_v2_status_deployment_id_get) | **GET** /deployments/v2/status/{deployment_id} | Get Deployment Status
115+
*EXTERNALApi* | [**get_deployments_deployments_v2_get**](docs/EXTERNALApi.md#get_deployments_deployments_v2_get) | **GET** /deployments/v2 | Get Deployments
106116
*EXTERNALApi* | [**get_hardware_instances_hardware_instances_get**](docs/EXTERNALApi.md#get_hardware_instances_hardware_instances_get) | **GET** /hardware-instances | Get Hardware Instances
107-
*EXTERNALApi* | [**get_inference_deployment_deployments_inference_deployment_id_get**](docs/EXTERNALApi.md#get_inference_deployment_deployments_inference_deployment_id_get) | **GET** /deployments/inference/{deployment_id} | Get Inference Deployment
117+
*EXTERNALApi* | [**get_hardware_instances_hardware_instances_v2_get**](docs/EXTERNALApi.md#get_hardware_instances_hardware_instances_v2_get) | **GET** /hardware-instances/v2 | Get Hardware Instances
118+
*EXTERNALApi* | [**get_inference_deployment_deployments_v2_inference_deployment_id_get**](docs/EXTERNALApi.md#get_inference_deployment_deployments_v2_inference_deployment_id_get) | **GET** /deployments/v2/inference/{deployment_id} | Get Inference Deployment
108119
*EXTERNALApi* | [**get_payment_methods_payments_methods_get**](docs/EXTERNALApi.md#get_payment_methods_payments_methods_get) | **GET** /payments/methods | Get Payment Methods
109120
*EXTERNALApi* | [**get_prebuilt_images_prebuilt_images_get**](docs/EXTERNALApi.md#get_prebuilt_images_prebuilt_images_get) | **GET** /prebuilt-images | Get Prebuilt Images
110-
*EXTERNALApi* | [**get_training_deployment_deployments_training_deployment_id_get**](docs/EXTERNALApi.md#get_training_deployment_deployments_training_deployment_id_get) | **GET** /deployments/training/{deployment_id} | Get Training Deployment
111-
*EXTERNALApi* | [**update_deployment_status_deployments_status_deployment_id_put**](docs/EXTERNALApi.md#update_deployment_status_deployments_status_deployment_id_put) | **PUT** /deployments/status/{deployment_id} | Update Deployment Status
121+
*EXTERNALApi* | [**get_usage_daily_bills_get**](docs/EXTERNALApi.md#get_usage_daily_bills_get) | **GET** /daily_bills | Get Usage
122+
*EXTERNALApi* | [**get_usage_deployments_usage_deployment_id_get**](docs/EXTERNALApi.md#get_usage_deployments_usage_deployment_id_get) | **GET** /deployments/usage/{deployment_id} | Get Usage
123+
*EXTERNALApi* | [**update_deployment_status_deployments_v2_status_deployment_id_put**](docs/EXTERNALApi.md#update_deployment_status_deployments_v2_status_deployment_id_put) | **PUT** /deployments/v2/status/{deployment_id} | Update Deployment Status
112124

113125

114126
## Documentation For Models
115127

116-
- [AuthSecret](docs/AuthSecret.md)
128+
- [APIKeyRequest](docs/APIKeyRequest.md)
129+
- [APIKeyResponse](docs/APIKeyResponse.md)
130+
- [AddHardwareRequest](docs/AddHardwareRequest.md)
131+
- [CServeRecipeInput](docs/CServeRecipeInput.md)
132+
- [CServeRecipeOutput](docs/CServeRecipeOutput.md)
133+
- [CServeRecipePerf](docs/CServeRecipePerf.md)
134+
- [CServeRecipeResponse](docs/CServeRecipeResponse.md)
117135
- [ClientSecretResponse](docs/ClientSecretResponse.md)
118-
- [CreateComputeDeploymentRequest](docs/CreateComputeDeploymentRequest.md)
136+
- [CreateCServeDeploymentRequest](docs/CreateCServeDeploymentRequest.md)
137+
- [CreateCServeDeploymentResponse](docs/CreateCServeDeploymentResponse.md)
119138
- [CreateComputeDeploymentResponse](docs/CreateComputeDeploymentResponse.md)
120-
- [CreateInferenceDeploymentRequest](docs/CreateInferenceDeploymentRequest.md)
139+
- [CreateComputeDeploymentV2Request](docs/CreateComputeDeploymentV2Request.md)
121140
- [CreateInferenceDeploymentResponse](docs/CreateInferenceDeploymentResponse.md)
141+
- [CreateInferenceDeploymentV2Request](docs/CreateInferenceDeploymentV2Request.md)
122142
- [CreatePaymentRequest](docs/CreatePaymentRequest.md)
123-
- [CreateTrainingDeploymentRequest](docs/CreateTrainingDeploymentRequest.md)
124-
- [CreateTrainingDeploymentResponse](docs/CreateTrainingDeploymentResponse.md)
125143
- [CreditsResponse](docs/CreditsResponse.md)
144+
- [DailyBillResponse](docs/DailyBillResponse.md)
126145
- [DeploymentStatus](docs/DeploymentStatus.md)
127146
- [DeploymentStatusRequest](docs/DeploymentStatusRequest.md)
128-
- [DeploymentStatusResponse](docs/DeploymentStatusResponse.md)
147+
- [DeploymentStatusResponseV2](docs/DeploymentStatusResponseV2.md)
129148
- [DeploymentType](docs/DeploymentType.md)
130-
- [EndpointReadyState](docs/EndpointReadyState.md)
131-
- [GetComputeDeploymentResponse](docs/GetComputeDeploymentResponse.md)
132-
- [GetDeploymentResponse](docs/GetDeploymentResponse.md)
133-
- [GetInferenceDeploymentResponse](docs/GetInferenceDeploymentResponse.md)
134-
- [GetTrainingDeploymentResponse](docs/GetTrainingDeploymentResponse.md)
149+
- [DeploymentUsageValue](docs/DeploymentUsageValue.md)
150+
- [FeedbackRequest](docs/FeedbackRequest.md)
151+
- [GetCServeDeploymentResponse](docs/GetCServeDeploymentResponse.md)
152+
- [GetClusterResponse](docs/GetClusterResponse.md)
153+
- [GetComputeV2DeploymentResponse](docs/GetComputeV2DeploymentResponse.md)
154+
- [GetDeploymentLogResponse](docs/GetDeploymentLogResponse.md)
155+
- [GetDeploymentUsageResponse](docs/GetDeploymentUsageResponse.md)
156+
- [GetDeploymentV2Response](docs/GetDeploymentV2Response.md)
157+
- [GetInferenceV2DeploymentResponse](docs/GetInferenceV2DeploymentResponse.md)
135158
- [HTTPValidationError](docs/HTTPValidationError.md)
136159
- [HardwareInstanceResponse](docs/HardwareInstanceResponse.md)
137-
- [ListGetDeploymentResponse](docs/ListGetDeploymentResponse.md)
160+
- [HealthStatus](docs/HealthStatus.md)
161+
- [ListAPIKeyResponse](docs/ListAPIKeyResponse.md)
162+
- [ListCServeRecipeResponse](docs/ListCServeRecipeResponse.md)
163+
- [ListDailyBillResponse](docs/ListDailyBillResponse.md)
164+
- [ListGetClusterResponse](docs/ListGetClusterResponse.md)
165+
- [ListGetDeploymentV2Response](docs/ListGetDeploymentV2Response.md)
138166
- [ListHardwareInstanceResponse](docs/ListHardwareInstanceResponse.md)
139167
- [ListPaymentMethodResponse](docs/ListPaymentMethodResponse.md)
140168
- [ListPrebuiltImageResponse](docs/ListPrebuiltImageResponse.md)
141-
- [LocationInner](docs/LocationInner.md)
169+
- [Metric](docs/Metric.md)
142170
- [PrebuiltImageResponse](docs/PrebuiltImageResponse.md)
143171
- [ValidationError](docs/ValidationError.md)
172+
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
144173

145174

146175
<a id="documentation-for-authorization"></a>

docs/APIKeyRequest.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# APIKeyRequest
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**name** | **str** | |
9+
10+
## Example
11+
12+
```python
13+
from platform_api_python_client.models.api_key_request import APIKeyRequest
14+
15+
# TODO update the JSON string below
16+
json = "{}"
17+
# create an instance of APIKeyRequest from a JSON string
18+
api_key_request_instance = APIKeyRequest.from_json(json)
19+
# print the JSON string representation of the object
20+
print(APIKeyRequest.to_json())
21+
22+
# convert the object into a dict
23+
api_key_request_dict = api_key_request_instance.to_dict()
24+
# create an instance of APIKeyRequest from a dict
25+
api_key_request_from_dict = APIKeyRequest.from_dict(api_key_request_dict)
26+
```
27+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28+
29+

docs/APIKeyResponse.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# APIKeyResponse
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**name** | **str** | |
9+
**id** | **str** | |
10+
**created_at** | **datetime** | |
11+
12+
## Example
13+
14+
```python
15+
from platform_api_python_client.models.api_key_response import APIKeyResponse
16+
17+
# TODO update the JSON string below
18+
json = "{}"
19+
# create an instance of APIKeyResponse from a JSON string
20+
api_key_response_instance = APIKeyResponse.from_json(json)
21+
# print the JSON string representation of the object
22+
print(APIKeyResponse.to_json())
23+
24+
# convert the object into a dict
25+
api_key_response_dict = api_key_response_instance.to_dict()
26+
# create an instance of APIKeyResponse from a dict
27+
api_key_response_from_dict = APIKeyResponse.from_dict(api_key_response_dict)
28+
```
29+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30+
31+

docs/AddHardwareRequest.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# AddHardwareRequest
2+
3+
4+
## Properties
5+
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**message** | **str** | |
9+
10+
## Example
11+
12+
```python
13+
from platform_api_python_client.models.add_hardware_request import AddHardwareRequest
14+
15+
# TODO update the JSON string below
16+
json = "{}"
17+
# create an instance of AddHardwareRequest from a JSON string
18+
add_hardware_request_instance = AddHardwareRequest.from_json(json)
19+
# print the JSON string representation of the object
20+
print(AddHardwareRequest.to_json())
21+
22+
# convert the object into a dict
23+
add_hardware_request_dict = add_hardware_request_instance.to_dict()
24+
# create an instance of AddHardwareRequest from a dict
25+
add_hardware_request_from_dict = AddHardwareRequest.from_dict(add_hardware_request_dict)
26+
```
27+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28+
29+

docs/AuthSecret.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

0 commit comments

Comments
 (0)