Skip to content

Commit 9fef704

Browse files
shuvo072shuvo072
committed
SDK Release v1.42.0-alpha
1 parent 967e3f0 commit 9fef704

27 files changed

Lines changed: 2279 additions & 1851 deletions

‎README.md‎

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ To contribute, please raise an issue with a bug report, feature request, feedbac
88
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
99

1010
- API version: 1.0
11-
- Package version: v1.41.2-alpha
11+
- Package version: v1.42.0-alpha
1212
- Generator version: 7.10.0
1313
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
1414

@@ -106,11 +106,12 @@ Class | Method | HTTP request | Description
106106
*CustomerContractApi* | [**get_customer_contract_gpu_allocation_graph**](docs/CustomerContractApi.md#get_customer_contract_gpu_allocation_graph) | **GET** /pricebook/contracts/{contract_id}/gpu_allocation_graph | Retrieve GPU Allocation Graph for Contract
107107
*PricebookApi* | [**get_pricebook**](docs/PricebookApi.md#get_pricebook) | **GET** /pricebook |
108108
*SnapshotsApi* | [**create_a_new_custom_image**](docs/SnapshotsApi.md#create_a_new_custom_image) | **POST** /core/snapshots/{snapshot_id}/image | Create an image from a snapshot
109-
*SnapshotsApi* | [**delete_snapshot**](docs/SnapshotsApi.md#delete_snapshot) | **DELETE** /core/snapshots/{id} | Delete snapshot
109+
*SnapshotsApi* | [**delete_an_existing_snapshot**](docs/SnapshotsApi.md#delete_an_existing_snapshot) | **DELETE** /core/snapshots/{id} | Delete snapshot
110110
*SnapshotsApi* | [**fetch_snapshot_name_availability**](docs/SnapshotsApi.md#fetch_snapshot_name_availability) | **GET** /core/snapshots/name-availability/{name} | Fetch snapshot name availability
111-
*SnapshotsApi* | [**get_snapshot**](docs/SnapshotsApi.md#get_snapshot) | **GET** /core/snapshots/{id} | Retrieve a snapshot
112-
*SnapshotsApi* | [**get_snapshots**](docs/SnapshotsApi.md#get_snapshots) | **GET** /core/snapshots | Retrieve list of snapshots with pagination
113-
*SnapshotsApi* | [**post_snapshot_restore**](docs/SnapshotsApi.md#post_snapshot_restore) | **POST** /core/snapshots/{id}/restore | Restore a snapshot
111+
*SnapshotsApi* | [**restore_a_snapshot**](docs/SnapshotsApi.md#restore_a_snapshot) | **POST** /core/snapshots/{id}/restore | Restore a snapshot
112+
*SnapshotsApi* | [**retrieve_an_existing_snapshot**](docs/SnapshotsApi.md#retrieve_an_existing_snapshot) | **GET** /core/snapshots/{id} | Retrieve a snapshot
113+
*SnapshotsApi* | [**retrieves_a_list_of_snapshots**](docs/SnapshotsApi.md#retrieves_a_list_of_snapshots) | **GET** /core/snapshots | Retrieve list of snapshots with pagination
114+
*AdminApi* | [**send_password_change_notification_email**](docs/AdminApi.md#send_password_change_notification_email) | **POST** /auth/admin/password-change-mail | Send Password Change Notification Email
114115
*AliveApi* | [**get_alive**](docs/AliveApi.md#get_alive) | **GET** /billing/alive | GET: Alive
115116
*AliveApi* | [**get_doc**](docs/AliveApi.md#get_doc) | **GET** /billing/alive/doc |
116117
*ApiKeyApi* | [**delete_api_key**](docs/ApiKeyApi.md#delete_api_key) | **DELETE** /api-key/{api_key_id} | Delete API Key
@@ -202,13 +203,13 @@ Class | Method | HTTP request | Description
202203
*EnvironmentApi* | [**list_environments**](docs/EnvironmentApi.md#list_environments) | **GET** /core/environments | List environments
203204
*EnvironmentApi* | [**retrieve_environment**](docs/EnvironmentApi.md#retrieve_environment) | **GET** /core/environments/{id} | Retrieve environment
204205
*EnvironmentApi* | [**update_environment**](docs/EnvironmentApi.md#update_environment) | **PUT** /core/environments/{id} | Update environment
205-
*FirewallAttachmentApi* | [**post_attach_security_groups**](docs/FirewallAttachmentApi.md#post_attach_security_groups) | **POST** /core/firewalls/{firewall_id}/update-attachments | Attach Firewalls to VMs
206-
*FirewallsApi* | [**delete_security_group_details**](docs/FirewallsApi.md#delete_security_group_details) | **DELETE** /core/firewalls/{id} | Delete firewall
207-
*FirewallsApi* | [**delete_security_group_rule_delete**](docs/FirewallsApi.md#delete_security_group_rule_delete) | **DELETE** /core/firewalls/{firewall_id}/firewall-rules/{firewall_rule_id} | Delete firewall rules from firewall
208-
*FirewallsApi* | [**get_security_group**](docs/FirewallsApi.md#get_security_group) | **GET** /core/firewalls | List firewalls
209-
*FirewallsApi* | [**get_security_group_details**](docs/FirewallsApi.md#get_security_group_details) | **GET** /core/firewalls/{id} | Retrieve firewall details
210-
*FirewallsApi* | [**post_security_group**](docs/FirewallsApi.md#post_security_group) | **POST** /core/firewalls | Create firewall
211-
*FirewallsApi* | [**post_security_group_rules**](docs/FirewallsApi.md#post_security_group_rules) | **POST** /core/firewalls/{firewall_id}/firewall-rules | Add firewall rule to firewall
206+
*FirewallAttachmentApi* | [**attach_firewall_to_virtual_machines**](docs/FirewallAttachmentApi.md#attach_firewall_to_virtual_machines) | **POST** /core/firewalls/{firewall_id}/update-attachments | Attach Firewalls to VMs
207+
*FirewallsApi* | [**add_firewall_rule_to_an_existing_firewall**](docs/FirewallsApi.md#add_firewall_rule_to_an_existing_firewall) | **POST** /core/firewalls/{firewall_id}/firewall-rules | Add firewall rule to firewall
208+
*FirewallsApi* | [**create_a_new_firewall**](docs/FirewallsApi.md#create_a_new_firewall) | **POST** /core/firewalls | Create firewall
209+
*FirewallsApi* | [**delete_existing_firewall**](docs/FirewallsApi.md#delete_existing_firewall) | **DELETE** /core/firewalls/{id} | Delete firewall
210+
*FirewallsApi* | [**delete_firewall_rules_from_firewall**](docs/FirewallsApi.md#delete_firewall_rules_from_firewall) | **DELETE** /core/firewalls/{firewall_id}/firewall-rules/{firewall_rule_id} | Delete firewall rules from firewall
211+
*FirewallsApi* | [**list_existing_firewalls**](docs/FirewallsApi.md#list_existing_firewalls) | **GET** /core/firewalls | List firewalls
212+
*FirewallsApi* | [**retrieve_the_details_of_an_existing_firewall**](docs/FirewallsApi.md#retrieve_the_details_of_an_existing_firewall) | **GET** /core/firewalls/{id} | Retrieve firewall details
212213
*FlavorApi* | [**list_flavors**](docs/FlavorApi.md#list_flavors) | **GET** /core/flavors | List Flavors
213214
*FloatingIpApi* | [**attach_public_ipto_virtual_machine**](docs/FloatingIpApi.md#attach_public_ipto_virtual_machine) | **POST** /core/virtual-machines/{vm_id}/attach-floatingip | Attach public IP to virtual machine
214215
*FloatingIpApi* | [**detach_public_ip_from_virtual_machine**](docs/FloatingIpApi.md#detach_public_ip_from_virtual_machine) | **POST** /core/virtual-machines/{vm_id}/detach-floatingip | Detach public IP from virtual machine
@@ -259,29 +260,29 @@ Class | Method | HTTP request | Description
259260
*UserDetailChoiceApi* | [**retrieve_default_flavors_and_images**](docs/UserDetailChoiceApi.md#retrieve_default_flavors_and_images) | **GET** /core/user/resources/defaults | Retrieve Default Flavors and Images
260261
*UserPermissionApi* | [**list_my_user_permissions**](docs/UserPermissionApi.md#list_my_user_permissions) | **GET** /auth/users/me/permissions | List My User Permissions
261262
*UserPermissionApi* | [**list_user_permissions**](docs/UserPermissionApi.md#list_user_permissions) | **GET** /auth/users/{id}/permissions | List User Permissions
262-
*VirtualMachineApi* | [**delete_instance**](docs/VirtualMachineApi.md#delete_instance) | **DELETE** /core/virtual-machines/{vm_id} | Delete virtual machine
263+
*VirtualMachineApi* | [**attach_firewalls_to_a_virtual_machine**](docs/VirtualMachineApi.md#attach_firewalls_to_a_virtual_machine) | **POST** /core/virtual-machines/{vm_id}/attach-firewalls | Attach firewalls to a virtual machine
264+
*VirtualMachineApi* | [**create_one_or_more_virtual_machines**](docs/VirtualMachineApi.md#create_one_or_more_virtual_machines) | **POST** /core/virtual-machines | Create virtual machines
263265
*VirtualMachineApi* | [**delete_security_rule**](docs/VirtualMachineApi.md#delete_security_rule) | **DELETE** /core/virtual-machines/{vm_id}/sg-rules/{sg_rule_id} | Delete firewall rule from virtual machine
266+
*VirtualMachineApi* | [**delete_virtual_machine**](docs/VirtualMachineApi.md#delete_virtual_machine) | **DELETE** /core/virtual-machines/{vm_id} | Delete virtual machine
264267
*VirtualMachineApi* | [**fetch_virtual_machine_name_availability**](docs/VirtualMachineApi.md#fetch_virtual_machine_name_availability) | **GET** /core/virtual-machines/name-availability/{name} | Fetch virtual machine name availability
265-
*VirtualMachineApi* | [**get_contract_instances**](docs/VirtualMachineApi.md#get_contract_instances) | **GET** /core/virtual-machines/contract/{contract_id}/virtual-machines | Retrieve virtual machines associated with a contract
266-
*VirtualMachineApi* | [**get_instance**](docs/VirtualMachineApi.md#get_instance) | **GET** /core/virtual-machines | List virtual machines
267-
*VirtualMachineApi* | [**get_instance2**](docs/VirtualMachineApi.md#get_instance2) | **GET** /core/virtual-machines/{vm_id} | Retrieve virtual machine details
268-
*VirtualMachineApi* | [**get_instance3**](docs/VirtualMachineApi.md#get_instance3) | **GET** /core/virtual-machines/{vm_id}/hard-reboot | Hard reboot virtual machine
269-
*VirtualMachineApi* | [**get_instance4**](docs/VirtualMachineApi.md#get_instance4) | **GET** /core/virtual-machines/{vm_id}/start | Start virtual machine
270-
*VirtualMachineApi* | [**get_instance5**](docs/VirtualMachineApi.md#get_instance5) | **GET** /core/virtual-machines/{vm_id}/stop | Stop virtual machine
268+
*VirtualMachineApi* | [**get_instance_hard_reboot**](docs/VirtualMachineApi.md#get_instance_hard_reboot) | **GET** /core/virtual-machines/{vm_id}/hard-reboot | Hard reboot virtual machine
271269
*VirtualMachineApi* | [**get_instance_hibernate**](docs/VirtualMachineApi.md#get_instance_hibernate) | **GET** /core/virtual-machines/{vm_id}/hibernate | Hibernate virtual machine
272270
*VirtualMachineApi* | [**get_instance_hibernate_restore**](docs/VirtualMachineApi.md#get_instance_hibernate_restore) | **GET** /core/virtual-machines/{vm_id}/hibernate-restore | Restore virtual machine from hibernation
273271
*VirtualMachineApi* | [**get_instance_logs**](docs/VirtualMachineApi.md#get_instance_logs) | **GET** /core/virtual-machines/{vm_id}/logs | Get virtual machine logs
274272
*VirtualMachineApi* | [**get_instance_metrics**](docs/VirtualMachineApi.md#get_instance_metrics) | **GET** /core/virtual-machines/{vm_id}/metrics | Retrieve virtual machine performance metrics
275-
*VirtualMachineApi* | [**post_instance**](docs/VirtualMachineApi.md#post_instance) | **POST** /core/virtual-machines | Create virtual machines
276-
*VirtualMachineApi* | [**post_instance_attach_firewalls**](docs/VirtualMachineApi.md#post_instance_attach_firewalls) | **POST** /core/virtual-machines/{vm_id}/attach-firewalls | Attach firewalls to a virtual machine
273+
*VirtualMachineApi* | [**get_instance_start**](docs/VirtualMachineApi.md#get_instance_start) | **GET** /core/virtual-machines/{vm_id}/start | Start virtual machine
274+
*VirtualMachineApi* | [**get_instance_stop**](docs/VirtualMachineApi.md#get_instance_stop) | **GET** /core/virtual-machines/{vm_id}/stop | Stop virtual machine
275+
*VirtualMachineApi* | [**list_virtual_machines**](docs/VirtualMachineApi.md#list_virtual_machines) | **GET** /core/virtual-machines | List virtual machines
277276
*VirtualMachineApi* | [**post_instance_logs**](docs/VirtualMachineApi.md#post_instance_logs) | **POST** /core/virtual-machines/{vm_id}/logs | Request virtual machine logs
278277
*VirtualMachineApi* | [**post_instance_resize**](docs/VirtualMachineApi.md#post_instance_resize) | **POST** /core/virtual-machines/{vm_id}/resize | Resize virtual machine
279278
*VirtualMachineApi* | [**post_security_rule**](docs/VirtualMachineApi.md#post_security_rule) | **POST** /core/virtual-machines/{vm_id}/sg-rules | Add firewall rule to virtual machine
280279
*VirtualMachineApi* | [**post_snapshots**](docs/VirtualMachineApi.md#post_snapshots) | **POST** /core/virtual-machines/{vm_id}/snapshots | Create snapshot from a virtual machine
281280
*VirtualMachineApi* | [**put_labels**](docs/VirtualMachineApi.md#put_labels) | **PUT** /core/virtual-machines/{vm_id}/label | Edit virtual machine labels
281+
*VirtualMachineApi* | [**retrieve_virtual_machine_details**](docs/VirtualMachineApi.md#retrieve_virtual_machine_details) | **GET** /core/virtual-machines/{vm_id} | Retrieve virtual machine details
282+
*VirtualMachineApi* | [**retrieve_virtual_machines_associated_with_a_contract**](docs/VirtualMachineApi.md#retrieve_virtual_machines_associated_with_a_contract) | **GET** /core/virtual-machines/contract/{contract_id}/virtual-machines | Retrieve virtual machines associated with a contract
282283
*VirtualMachineEventsApi* | [**list_virtual_machine_events**](docs/VirtualMachineEventsApi.md#list_virtual_machine_events) | **GET** /core/virtual-machines/{vm_id}/events | List virtual machine events
283-
*VncUrlApi* | [**get_vnc_url**](docs/VncUrlApi.md#get_vnc_url) | **GET** /core/virtual-machines/{vm_id}/console/{job_id} | Get VNC Console Link
284-
*VncUrlApi* | [**get_vnc_url2**](docs/VncUrlApi.md#get_vnc_url2) | **GET** /core/virtual-machines/{vm_id}/request-console | Request Instance Console
284+
*VncUrlApi* | [**get_vnc_url**](docs/VncUrlApi.md#get_vnc_url) | **GET** /core/virtual-machines/{vm_id}/request-console | Request Instance Console
285+
*VncUrlApi* | [**get_vncurl**](docs/VncUrlApi.md#get_vncurl) | **GET** /core/virtual-machines/{vm_id}/console/{job_id} | Get VNC Console Link
285286
*VolumeApi* | [**create_volume**](docs/VolumeApi.md#create_volume) | **POST** /core/volumes | Create volume
286287
*VolumeApi* | [**delete_volume**](docs/VolumeApi.md#delete_volume) | **DELETE** /core/volumes/{volume_id} | Delete volume
287288
*VolumeApi* | [**fetch_volume_details**](docs/VolumeApi.md#fetch_volume_details) | **GET** /core/volumes/{volume_id} | Fetch Volume Details

‎docs/AdminApi.md‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# hyperstack.AdminApi
2+
3+
All URIs are relative to *https://infrahub-api.nexgencloud.com/v1*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**send_password_change_notification_email**](AdminApi.md#send_password_change_notification_email) | **POST** /auth/admin/password-change-mail | Send Password Change Notification Email
8+
9+
10+
# **send_password_change_notification_email**
11+
> CommonResponseModel send_password_change_notification_email()
12+
13+
Send Password Change Notification Email
14+
15+
Send a password change notification email to a user
16+
17+
### Example
18+
19+
* Api Key Authentication (apiKey):
20+
21+
```python
22+
import hyperstack
23+
from hyperstack.models.common_response_model import CommonResponseModel
24+
from hyperstack.rest import ApiException
25+
from pprint import pprint
26+
27+
# Defining the host is optional and defaults to https://infrahub-api.nexgencloud.com/v1
28+
# See configuration.py for a list of all supported configuration parameters.
29+
configuration = hyperstack.Configuration(
30+
host = "https://infrahub-api.nexgencloud.com/v1"
31+
)
32+
33+
# The client must configure the authentication and authorization parameters
34+
# in accordance with the API server security policy.
35+
# Examples for each auth method are provided below, use the example that
36+
# satisfies your auth use case.
37+
38+
# Configure API key authorization: apiKey
39+
configuration.api_key['apiKey'] = os.environ["API_KEY"]
40+
41+
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
42+
# configuration.api_key_prefix['apiKey'] = 'Bearer'
43+
44+
# Enter a context with an instance of the API client
45+
with hyperstack.ApiClient(configuration) as api_client:
46+
# Create an instance of the API class
47+
api_instance = hyperstack.AdminApi(api_client)
48+
49+
try:
50+
# Send Password Change Notification Email
51+
api_response = api_instance.send_password_change_notification_email()
52+
print("The response of AdminApi->send_password_change_notification_email:\n")
53+
pprint(api_response)
54+
except Exception as e:
55+
print("Exception when calling AdminApi->send_password_change_notification_email: %s\n" % e)
56+
```
57+
58+
59+
60+
### Parameters
61+
62+
This endpoint does not need any parameter.
63+
64+
### Return type
65+
66+
[**CommonResponseModel**](CommonResponseModel.md)
67+
68+
### Authorization
69+
70+
[apiKey](../README.md#apiKey)
71+
72+
### HTTP request headers
73+
74+
- **Content-Type**: Not defined
75+
- **Accept**: application/json
76+
77+
### HTTP response details
78+
79+
| Status code | Description | Response headers |
80+
|-------------|-------------|------------------|
81+
**200** | Email Sent Successfully. | - |
82+
**400** | Unable to send email | - |
83+
**401** | Unauthorized | - |
84+
**404** | User Not Found | - |
85+
**405** | Method Not Allowed | - |
86+
**500** | Internal Server Error | - |
87+
88+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
89+

‎docs/FirewallAttachmentApi.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ All URIs are relative to *https://infrahub-api.nexgencloud.com/v1*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**post_attach_security_groups**](FirewallAttachmentApi.md#post_attach_security_groups) | **POST** /core/firewalls/{firewall_id}/update-attachments | Attach Firewalls to VMs
7+
[**attach_firewall_to_virtual_machines**](FirewallAttachmentApi.md#attach_firewall_to_virtual_machines) | **POST** /core/firewalls/{firewall_id}/update-attachments | Attach Firewalls to VMs
88

99

10-
# **post_attach_security_groups**
11-
> ResponseModel post_attach_security_groups(firewall_id, payload)
10+
# **attach_firewall_to_virtual_machines**
11+
> ResponseModel attach_firewall_to_virtual_machines(firewall_id, payload)
1212
1313
Attach Firewalls to VMs
1414

@@ -51,11 +51,11 @@ with hyperstack.ApiClient(configuration) as api_client:
5151

5252
try:
5353
# Attach Firewalls to VMs
54-
api_response = api_instance.post_attach_security_groups(firewall_id, payload)
55-
print("The response of FirewallAttachmentApi->post_attach_security_groups:\n")
54+
api_response = api_instance.attach_firewall_to_virtual_machines(firewall_id, payload)
55+
print("The response of FirewallAttachmentApi->attach_firewall_to_virtual_machines:\n")
5656
pprint(api_response)
5757
except Exception as e:
58-
print("Exception when calling FirewallAttachmentApi->post_attach_security_groups: %s\n" % e)
58+
print("Exception when calling FirewallAttachmentApi->attach_firewall_to_virtual_machines: %s\n" % e)
5959
```
6060

6161

0 commit comments

Comments
 (0)