Skip to content

Commit d8f7c37

Browse files
committed
SDK Release v1.46.1-alpha
1 parent f68356c commit d8f7c37

108 files changed

Lines changed: 6687 additions & 6222 deletions

File tree

Some content is hidden

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

README.md

Lines changed: 117 additions & 116 deletions
Large diffs are not rendered by default.

docs/AliveApi.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ All URIs are relative to *https://infrahub-api.nexgencloud.com/v1*
55
Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**get_alive**](AliveApi.md#get_alive) | **GET** /billing/alive | GET: Alive
8-
[**get_doc**](AliveApi.md#get_doc) | **GET** /billing/alive/doc |
8+
[**get_alive_doc**](AliveApi.md#get_alive_doc) | **GET** /billing/alive/doc |
99

1010

1111
# **get_alive**
@@ -80,8 +80,8 @@ void (empty response body)
8080

8181
[[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)
8282

83-
# **get_doc**
84-
> get_doc()
83+
# **get_alive_doc**
84+
> get_alive_doc()
8585
8686

8787

@@ -117,9 +117,9 @@ with hyperstack.ApiClient(configuration) as api_client:
117117
api_instance = hyperstack.AliveApi(api_client)
118118

119119
try:
120-
api_instance.get_doc()
120+
api_instance.get_alive_doc()
121121
except Exception as e:
122-
print("Exception when calling AliveApi->get_doc: %s\n" % e)
122+
print("Exception when calling AliveApi->get_alive_doc: %s\n" % e)
123123
```
124124

125125

docs/ApiKeyApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**delete_api_key**](ApiKeyApi.md#delete_api_key) | **DELETE** /api-key/{api_key_id} | Delete API Key
88
[**generate_api_key**](ApiKeyApi.md#generate_api_key) | **POST** /api-key/generate | Generate API Key
9-
[**retrieve_api_key**](ApiKeyApi.md#retrieve_api_key) | **GET** /api-key | Retrieve API Keys
9+
[**get_api_key**](ApiKeyApi.md#get_api_key) | **GET** /api-key | Retrieve API Keys
1010
[**update_api_key**](ApiKeyApi.md#update_api_key) | **PUT** /api-key/{api_key_id} | Update API Key
1111

1212

@@ -167,8 +167,8 @@ No authorization required
167167

168168
[[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)
169169

170-
# **retrieve_api_key**
171-
> GetApiKeysResponseModel retrieve_api_key()
170+
# **get_api_key**
171+
> GetApiKeysResponseModel get_api_key()
172172
173173
Retrieve API Keys
174174

@@ -208,11 +208,11 @@ with hyperstack.ApiClient(configuration) as api_client:
208208

209209
try:
210210
# Retrieve API Keys
211-
api_response = api_instance.retrieve_api_key()
212-
print("The response of ApiKeyApi->retrieve_api_key:\n")
211+
api_response = api_instance.get_api_key()
212+
print("The response of ApiKeyApi->get_api_key:\n")
213213
pprint(api_response)
214214
except Exception as e:
215-
print("Exception when calling ApiKeyApi->retrieve_api_key: %s\n" % e)
215+
print("Exception when calling ApiKeyApi->get_api_key: %s\n" % e)
216216
```
217217

218218

docs/AuthApi.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**change_organization_for_token**](AuthApi.md#change_organization_for_token) | **GET** /auth/token/change-org/{org_id} |
88
[**disable_mfa**](AuthApi.md#disable_mfa) | **GET** /auth/me/mfa/disable |
9+
[**get_authenticated_user**](AuthApi.md#get_authenticated_user) | **GET** /auth/me | Retrieve Authenticated User Details
910
[**get_user_mfa_status**](AuthApi.md#get_user_mfa_status) | **GET** /auth/me/mfa | Get MFA status for authenticated user
1011
[**get_user_organizations**](AuthApi.md#get_user_organizations) | **GET** /auth/me/organizations | Get User Organizations
11-
[**retrieve_authenticated_user_details**](AuthApi.md#retrieve_authenticated_user_details) | **GET** /auth/me | Retrieve Authenticated User Details
1212

1313

1414
# **change_organization_for_token**
@@ -170,20 +170,20 @@ This endpoint does not need any parameter.
170170

171171
[[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)
172172

173-
# **get_user_mfa_status**
174-
> MFAStatusResponse get_user_mfa_status()
173+
# **get_authenticated_user**
174+
> AuthUserInfoResponseModel get_authenticated_user()
175175
176-
Get MFA status for authenticated user
176+
Retrieve Authenticated User Details
177177

178-
Retrieve the Multi-Factor Authentication (MFA) status for the currentlyauthenticated user. Includes whether MFA is enabled.
178+
Retrieves detailed information about the currently authenticated user. For additional information, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/auth).
179179

180180
### Example
181181

182182
* Api Key Authentication (apiKey):
183183

184184
```python
185185
import hyperstack
186-
from hyperstack.models.mfa_status_response import MFAStatusResponse
186+
from hyperstack.models.auth_user_info_response_model import AuthUserInfoResponseModel
187187
from hyperstack.rest import ApiException
188188
from pprint import pprint
189189

@@ -210,12 +210,12 @@ with hyperstack.ApiClient(configuration) as api_client:
210210
api_instance = hyperstack.AuthApi(api_client)
211211

212212
try:
213-
# Get MFA status for authenticated user
214-
api_response = api_instance.get_user_mfa_status()
215-
print("The response of AuthApi->get_user_mfa_status:\n")
213+
# Retrieve Authenticated User Details
214+
api_response = api_instance.get_authenticated_user()
215+
print("The response of AuthApi->get_authenticated_user:\n")
216216
pprint(api_response)
217217
except Exception as e:
218-
print("Exception when calling AuthApi->get_user_mfa_status: %s\n" % e)
218+
print("Exception when calling AuthApi->get_authenticated_user: %s\n" % e)
219219
```
220220

221221

@@ -226,7 +226,7 @@ This endpoint does not need any parameter.
226226

227227
### Return type
228228

229-
[**MFAStatusResponse**](MFAStatusResponse.md)
229+
[**AuthUserInfoResponseModel**](AuthUserInfoResponseModel.md)
230230

231231
### Authorization
232232

@@ -241,27 +241,27 @@ This endpoint does not need any parameter.
241241

242242
| Status code | Description | Response headers |
243243
|-------------|-------------|------------------|
244-
**200** | MFA Status | - |
244+
**200** | User Information | - |
245+
**400** | Bad Request | - |
245246
**401** | Unauthorized | - |
246-
**404** | User not found | - |
247247
**500** | Internal Server Error | - |
248248

249249
[[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)
250250

251-
# **get_user_organizations**
252-
> UserOrganizationsResponse get_user_organizations()
251+
# **get_user_mfa_status**
252+
> MFAStatusResponse get_user_mfa_status()
253253
254-
Get User Organizations
254+
Get MFA status for authenticated user
255255

256-
Retrieve the organizations associated with a user by their user ID. This endpoint is useful for understanding the user's organizational affiliations.
256+
Retrieve the Multi-Factor Authentication (MFA) status for the currentlyauthenticated user. Includes whether MFA is enabled.
257257

258258
### Example
259259

260260
* Api Key Authentication (apiKey):
261261

262262
```python
263263
import hyperstack
264-
from hyperstack.models.user_organizations_response import UserOrganizationsResponse
264+
from hyperstack.models.mfa_status_response import MFAStatusResponse
265265
from hyperstack.rest import ApiException
266266
from pprint import pprint
267267

@@ -288,12 +288,12 @@ with hyperstack.ApiClient(configuration) as api_client:
288288
api_instance = hyperstack.AuthApi(api_client)
289289

290290
try:
291-
# Get User Organizations
292-
api_response = api_instance.get_user_organizations()
293-
print("The response of AuthApi->get_user_organizations:\n")
291+
# Get MFA status for authenticated user
292+
api_response = api_instance.get_user_mfa_status()
293+
print("The response of AuthApi->get_user_mfa_status:\n")
294294
pprint(api_response)
295295
except Exception as e:
296-
print("Exception when calling AuthApi->get_user_organizations: %s\n" % e)
296+
print("Exception when calling AuthApi->get_user_mfa_status: %s\n" % e)
297297
```
298298

299299

@@ -304,7 +304,7 @@ This endpoint does not need any parameter.
304304

305305
### Return type
306306

307-
[**UserOrganizationsResponse**](UserOrganizationsResponse.md)
307+
[**MFAStatusResponse**](MFAStatusResponse.md)
308308

309309
### Authorization
310310

@@ -319,28 +319,27 @@ This endpoint does not need any parameter.
319319

320320
| Status code | Description | Response headers |
321321
|-------------|-------------|------------------|
322-
**200** | Success | - |
323-
**400** | Bad Request | - |
322+
**200** | MFA Status | - |
324323
**401** | Unauthorized | - |
325-
**404** | Not Found | - |
324+
**404** | User not found | - |
326325
**500** | Internal Server Error | - |
327326

328327
[[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)
329328

330-
# **retrieve_authenticated_user_details**
331-
> AuthUserInfoResponseModel retrieve_authenticated_user_details()
329+
# **get_user_organizations**
330+
> UserOrganizationsResponse get_user_organizations()
332331
333-
Retrieve Authenticated User Details
332+
Get User Organizations
334333

335-
Retrieves detailed information about the currently authenticated user. For additional information, [**click here**](https://docs.hyperstack.cloud/docs/api-reference/auth-resources/auth).
334+
Retrieve the organizations associated with a user by their user ID. This endpoint is useful for understanding the user's organizational affiliations.
336335

337336
### Example
338337

339338
* Api Key Authentication (apiKey):
340339

341340
```python
342341
import hyperstack
343-
from hyperstack.models.auth_user_info_response_model import AuthUserInfoResponseModel
342+
from hyperstack.models.user_organizations_response import UserOrganizationsResponse
344343
from hyperstack.rest import ApiException
345344
from pprint import pprint
346345

@@ -367,12 +366,12 @@ with hyperstack.ApiClient(configuration) as api_client:
367366
api_instance = hyperstack.AuthApi(api_client)
368367

369368
try:
370-
# Retrieve Authenticated User Details
371-
api_response = api_instance.retrieve_authenticated_user_details()
372-
print("The response of AuthApi->retrieve_authenticated_user_details:\n")
369+
# Get User Organizations
370+
api_response = api_instance.get_user_organizations()
371+
print("The response of AuthApi->get_user_organizations:\n")
373372
pprint(api_response)
374373
except Exception as e:
375-
print("Exception when calling AuthApi->retrieve_authenticated_user_details: %s\n" % e)
374+
print("Exception when calling AuthApi->get_user_organizations: %s\n" % e)
376375
```
377376

378377

@@ -383,7 +382,7 @@ This endpoint does not need any parameter.
383382

384383
### Return type
385384

386-
[**AuthUserInfoResponseModel**](AuthUserInfoResponseModel.md)
385+
[**UserOrganizationsResponse**](UserOrganizationsResponse.md)
387386

388387
### Authorization
389388

@@ -398,9 +397,10 @@ This endpoint does not need any parameter.
398397

399398
| Status code | Description | Response headers |
400399
|-------------|-------------|------------------|
401-
**200** | User Information | - |
400+
**200** | Success | - |
402401
**400** | Bad Request | - |
403402
**401** | Unauthorized | - |
403+
**404** | Not Found | - |
404404
**500** | Internal Server Error | - |
405405

406406
[[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)

docs/BetaAccessApi.md

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

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**create_a_beta_access_request**](BetaAccessApi.md#create_a_beta_access_request) | **POST** /auth/beta-access/requests | Create a new beta access request
7+
[**create_beta_access_request**](BetaAccessApi.md#create_beta_access_request) | **POST** /auth/beta-access/requests | Create a new beta access request
8+
[**get_beta_access_requests**](BetaAccessApi.md#get_beta_access_requests) | **GET** /auth/beta-access/requests/{program} | Check the status of beta access requests
89
[**get_beta_access_status**](BetaAccessApi.md#get_beta_access_status) | **GET** /auth/beta-access/requests | Check the status of all beta access requests
9-
[**get_beta_access_status2**](BetaAccessApi.md#get_beta_access_status2) | **GET** /auth/beta-access/requests/{program} | Check the status of beta access requests
1010

1111

12-
# **create_a_beta_access_request**
13-
> BetaAccessRequestResponseModel create_a_beta_access_request(payload)
12+
# **create_beta_access_request**
13+
> BetaAccessRequestResponseModel create_beta_access_request(payload)
1414
1515
Create a new beta access request
1616

@@ -52,11 +52,11 @@ with hyperstack.ApiClient(configuration) as api_client:
5252

5353
try:
5454
# Create a new beta access request
55-
api_response = api_instance.create_a_beta_access_request(payload)
56-
print("The response of BetaAccessApi->create_a_beta_access_request:\n")
55+
api_response = api_instance.create_beta_access_request(payload)
56+
print("The response of BetaAccessApi->create_beta_access_request:\n")
5757
pprint(api_response)
5858
except Exception as e:
59-
print("Exception when calling BetaAccessApi->create_a_beta_access_request: %s\n" % e)
59+
print("Exception when calling BetaAccessApi->create_beta_access_request: %s\n" % e)
6060
```
6161

6262

@@ -93,12 +93,12 @@ Name | Type | Description | Notes
9393

9494
[[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)
9595

96-
# **get_beta_access_status**
97-
> BetaAccessStatusResponseModel get_beta_access_status()
96+
# **get_beta_access_requests**
97+
> BetaAccessStatusResponseModel get_beta_access_requests(program)
9898
99-
Check the status of all beta access requests
99+
Check the status of beta access requests
100100

101-
Check the status of all beta access requests.
101+
Check the status of a particular beta access requests.
102102

103103
### Example
104104

@@ -131,21 +131,25 @@ configuration.api_key['apiKey'] = os.environ["API_KEY"]
131131
with hyperstack.ApiClient(configuration) as api_client:
132132
# Create an instance of the API class
133133
api_instance = hyperstack.BetaAccessApi(api_client)
134+
program = 'program_example' # str |
134135

135136
try:
136-
# Check the status of all beta access requests
137-
api_response = api_instance.get_beta_access_status()
138-
print("The response of BetaAccessApi->get_beta_access_status:\n")
137+
# Check the status of beta access requests
138+
api_response = api_instance.get_beta_access_requests(program)
139+
print("The response of BetaAccessApi->get_beta_access_requests:\n")
139140
pprint(api_response)
140141
except Exception as e:
141-
print("Exception when calling BetaAccessApi->get_beta_access_status: %s\n" % e)
142+
print("Exception when calling BetaAccessApi->get_beta_access_requests: %s\n" % e)
142143
```
143144

144145

145146

146147
### Parameters
147148

148-
This endpoint does not need any parameter.
149+
150+
Name | Type | Description | Notes
151+
------------- | ------------- | ------------- | -------------
152+
**program** | **str**| |
149153

150154
### Return type
151155

@@ -172,12 +176,12 @@ This endpoint does not need any parameter.
172176

173177
[[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)
174178

175-
# **get_beta_access_status2**
176-
> BetaAccessStatusResponseModel get_beta_access_status2(program)
179+
# **get_beta_access_status**
180+
> BetaAccessStatusResponseModel get_beta_access_status()
177181
178-
Check the status of beta access requests
182+
Check the status of all beta access requests
179183

180-
Check the status of a particular beta access requests.
184+
Check the status of all beta access requests.
181185

182186
### Example
183187

@@ -210,25 +214,21 @@ configuration.api_key['apiKey'] = os.environ["API_KEY"]
210214
with hyperstack.ApiClient(configuration) as api_client:
211215
# Create an instance of the API class
212216
api_instance = hyperstack.BetaAccessApi(api_client)
213-
program = 'program_example' # str |
214217

215218
try:
216-
# Check the status of beta access requests
217-
api_response = api_instance.get_beta_access_status2(program)
218-
print("The response of BetaAccessApi->get_beta_access_status2:\n")
219+
# Check the status of all beta access requests
220+
api_response = api_instance.get_beta_access_status()
221+
print("The response of BetaAccessApi->get_beta_access_status:\n")
219222
pprint(api_response)
220223
except Exception as e:
221-
print("Exception when calling BetaAccessApi->get_beta_access_status2: %s\n" % e)
224+
print("Exception when calling BetaAccessApi->get_beta_access_status: %s\n" % e)
222225
```
223226

224227

225228

226229
### Parameters
227230

228-
229-
Name | Type | Description | Notes
230-
------------- | ------------- | ------------- | -------------
231-
**program** | **str**| |
231+
This endpoint does not need any parameter.
232232

233233
### Return type
234234

0 commit comments

Comments
 (0)