qi-compute-api-client 0.32.0__py3-none-any.whl → 0.35.0__py3-none-any.whl

compute_api_client/docs/PageBatchJob.md

@@ -0,0 +1,32 @@
+# PageBatchJob
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[BatchJob]**](BatchJob.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.page_batch_job import PageBatchJob
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageBatchJob from a JSON string
+page_batch_job_instance = PageBatchJob.from_json(json)
+# print the JSON string representation of the object
+print PageBatchJob.to_json()
+
+# convert the object into a dict
+page_batch_job_dict = page_batch_job_instance.to_dict()
+# create an instance of PageBatchJob from a dict
+page_batch_job_form_dict = page_batch_job.from_dict(page_batch_job_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/PageCommit.md

@@ -0,0 +1,32 @@
+# PageCommit
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[Commit]**](Commit.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.page_commit import PageCommit
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageCommit from a JSON string
+page_commit_instance = PageCommit.from_json(json)
+# print the JSON string representation of the object
+print PageCommit.to_json()
+
+# convert the object into a dict
+page_commit_dict = page_commit_instance.to_dict()
+# create an instance of PageCommit from a dict
+page_commit_form_dict = page_commit.from_dict(page_commit_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/PageFile.md

@@ -0,0 +1,32 @@
+# PageFile
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[File]**](File.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.page_file import PageFile
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageFile from a JSON string
+page_file_instance = PageFile.from_json(json)
+# print the JSON string representation of the object
+print PageFile.to_json()
+
+# convert the object into a dict
+page_file_dict = page_file_instance.to_dict()
+# create an instance of PageFile from a dict
+page_file_form_dict = page_file.from_dict(page_file_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/PageJob.md

@@ -0,0 +1,32 @@
+# PageJob
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[Job]**](Job.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.page_job import PageJob
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageJob from a JSON string
+page_job_instance = PageJob.from_json(json)
+# print the JSON string representation of the object
+print PageJob.to_json()
+
+# convert the object into a dict
+page_job_dict = page_job_instance.to_dict()
+# create an instance of PageJob from a dict
+page_job_form_dict = page_job.from_dict(page_job_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/PageLanguage.md

@@ -0,0 +1,32 @@
+# PageLanguage
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[Language]**](Language.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.page_language import PageLanguage
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageLanguage from a JSON string
+page_language_instance = PageLanguage.from_json(json)
+# print the JSON string representation of the object
+print PageLanguage.to_json()
+
+# convert the object into a dict
+page_language_dict = page_language_instance.to_dict()
+# create an instance of PageLanguage from a dict
+page_language_form_dict = page_language.from_dict(page_language_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/PageMember.md

@@ -0,0 +1,32 @@
+# PageMember
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[Member]**](Member.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.page_member import PageMember
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageMember from a JSON string
+page_member_instance = PageMember.from_json(json)
+# print the JSON string representation of the object
+print PageMember.to_json()
+
+# convert the object into a dict
+page_member_dict = page_member_instance.to_dict()
+# create an instance of PageMember from a dict
+page_member_form_dict = page_member.from_dict(page_member_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/PageMetadata.md

@@ -0,0 +1,32 @@
+# PageMetadata
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[Metadata]**](Metadata.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.page_metadata import PageMetadata
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageMetadata from a JSON string
+page_metadata_instance = PageMetadata.from_json(json)
+# print the JSON string representation of the object
+print PageMetadata.to_json()
+
+# convert the object into a dict
+page_metadata_dict = page_metadata_instance.to_dict()
+# create an instance of PageMetadata from a dict
+page_metadata_form_dict = page_metadata.from_dict(page_metadata_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/PagePermission.md

@@ -0,0 +1,32 @@
+# PagePermission
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[Permission]**](Permission.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.page_permission import PagePermission
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PagePermission from a JSON string
+page_permission_instance = PagePermission.from_json(json)
+# print the JSON string representation of the object
+print PagePermission.to_json()
+
+# convert the object into a dict
+page_permission_dict = page_permission_instance.to_dict()
+# create an instance of PagePermission from a dict
+page_permission_form_dict = page_permission.from_dict(page_permission_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/PagePermissionGroup.md

@@ -0,0 +1,32 @@
+# PagePermissionGroup
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[PermissionGroup]**](PermissionGroup.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.page_permission_group import PagePermissionGroup
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PagePermissionGroup from a JSON string
+page_permission_group_instance = PagePermissionGroup.from_json(json)
+# print the JSON string representation of the object
+print PagePermissionGroup.to_json()
+
+# convert the object into a dict
+page_permission_group_dict = page_permission_group_instance.to_dict()
+# create an instance of PagePermissionGroup from a dict
+page_permission_group_form_dict = page_permission_group.from_dict(page_permission_group_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/PageProject.md

@@ -0,0 +1,32 @@
+# PageProject
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[Project]**](Project.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.page_project import PageProject
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageProject from a JSON string
+page_project_instance = PageProject.from_json(json)
+# print the JSON string representation of the object
+print PageProject.to_json()
+
+# convert the object into a dict
+page_project_dict = page_project_instance.to_dict()
+# create an instance of PageProject from a dict
+page_project_form_dict = page_project.from_dict(page_project_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/PageReservation.md

@@ -0,0 +1,32 @@
+# PageReservation
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[Reservation]**](Reservation.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.page_reservation import PageReservation
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageReservation from a JSON string
+page_reservation_instance = PageReservation.from_json(json)
+# print the JSON string representation of the object
+print PageReservation.to_json()
+
+# convert the object into a dict
+page_reservation_dict = page_reservation_instance.to_dict()
+# create an instance of PageReservation from a dict
+page_reservation_form_dict = page_reservation.from_dict(page_reservation_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/PageResult.md

@@ -0,0 +1,32 @@
+# PageResult
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[Result]**](Result.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.page_result import PageResult
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageResult from a JSON string
+page_result_instance = PageResult.from_json(json)
+# print the JSON string representation of the object
+print PageResult.to_json()
+
+# convert the object into a dict
+page_result_dict = page_result_instance.to_dict()
+# create an instance of PageResult from a dict
+page_result_form_dict = page_result.from_dict(page_result_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/PageTeam.md

@@ -0,0 +1,32 @@
+# PageTeam
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[Team]**](Team.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.page_team import PageTeam
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageTeam from a JSON string
+page_team_instance = PageTeam.from_json(json)
+# print the JSON string representation of the object
+print PageTeam.to_json()
+
+# convert the object into a dict
+page_team_dict = page_team_instance.to_dict()
+# create an instance of PageTeam from a dict
+page_team_form_dict = page_team.from_dict(page_team_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/PageTransaction.md

@@ -0,0 +1,32 @@
+# PageTransaction
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[Transaction]**](Transaction.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.page_transaction import PageTransaction
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageTransaction from a JSON string
+page_transaction_instance = PageTransaction.from_json(json)
+# print the JSON string representation of the object
+print PageTransaction.to_json()
+
+# convert the object into a dict
+page_transaction_dict = page_transaction_instance.to_dict()
+# create an instance of PageTransaction from a dict
+page_transaction_form_dict = page_transaction.from_dict(page_transaction_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/PageUser.md

@@ -0,0 +1,32 @@
+# PageUser
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**items** | [**List[User]**](User.md) |  | 
+**total** | **int** |  | 
+**page** | **int** |  | 
+**size** | **int** |  | 
+**pages** | **int** |  | [optional] 
+
+## Example
+
+```python
+from compute_api_client.models.page_user import PageUser
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PageUser from a JSON string
+page_user_instance = PageUser.from_json(json)
+# print the JSON string representation of the object
+print PageUser.to_json()
+
+# convert the object into a dict
+page_user_dict = page_user_instance.to_dict()
+# create an instance of PageUser from a dict
+page_user_form_dict = page_user.from_dict(page_user_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/PermissionsApi.md

@@ -87,7 +87,7 @@ Name | Type | Description  | Notes
 [[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)
 
 # **read_permission_groups_permission_groups_get**
-> List[PermissionGroup] read_permission_groups_permission_groups_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name)
+> PagePermissionGroup read_permission_groups_permission_groups_get(id=id, name=name, sort_by=sort_by, latest=latest, page=page, size=size)
 
 List permission groups
 
@@ -100,7 +100,7 @@ Read permissions groups.
 import time
 import os
 import compute_api_client
-from compute_api_client.models.permission_group import PermissionGroup
+from compute_api_client.models.page_permission_group import PagePermissionGroup
 from compute_api_client.rest import ApiException
 from pprint import pprint
 
@@ -121,16 +121,16 @@ configuration.access_token = os.environ["ACCESS_TOKEN"]
 async with compute_api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = compute_api_client.PermissionsApi(api_client)
-    latest = True # bool |  (optional)
-    sort_by = 'sort_by_example' # str |  (optional)
-    page_number = 56 # int |  (optional)
-    items_per_page = 56 # int |  (optional)
     id = 56 # int |  (optional)
     name = 'name_example' # str |  (optional)
+    sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional)
+    latest = True # bool | If True gets the most recently created object. (optional)
+    page = 1 # int | Page number (optional) (default to 1)
+    size = 50 # int | Page size (optional) (default to 50)
 
     try:
         # List permission groups
-        api_response = await api_instance.read_permission_groups_permission_groups_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, name=name)
+        api_response = await api_instance.read_permission_groups_permission_groups_get(id=id, name=name, sort_by=sort_by, latest=latest, page=page, size=size)
         print("The response of PermissionsApi->read_permission_groups_permission_groups_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -143,16 +143,16 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **latest** | **bool**|  | [optional] 
- **sort_by** | **str**|  | [optional] 
- **page_number** | **int**|  | [optional] 
- **items_per_page** | **int**|  | [optional] 
  **id** | **int**|  | [optional] 
  **name** | **str**|  | [optional] 
+ **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] 
+ **latest** | **bool**| If True gets the most recently created object. | [optional] 
+ **page** | **int**| Page number | [optional] [default to 1]
+ **size** | **int**| Page size | [optional] [default to 50]
 
 ### Return type
 
-[**List[PermissionGroup]**](PermissionGroup.md)
+[**PagePermissionGroup**](PagePermissionGroup.md)
 
 ### Authorization
 
@@ -248,7 +248,7 @@ Name | Type | Description  | Notes
 [[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)
 
 # **read_permissions_permissions_get**
-> List[Permission] read_permissions_permissions_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, permission=permission, name=name)
+> PagePermission read_permissions_permissions_get(id=id, permission=permission, name=name, sort_by=sort_by, latest=latest, page=page, size=size)
 
 List permissions
 
@@ -261,7 +261,7 @@ Read permissions.
 import time
 import os
 import compute_api_client
-from compute_api_client.models.permission import Permission
+from compute_api_client.models.page_permission import PagePermission
 from compute_api_client.rest import ApiException
 from pprint import pprint
 
@@ -282,17 +282,17 @@ configuration.access_token = os.environ["ACCESS_TOKEN"]
 async with compute_api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = compute_api_client.PermissionsApi(api_client)
-    latest = True # bool |  (optional)
-    sort_by = 'sort_by_example' # str |  (optional)
-    page_number = 56 # int |  (optional)
-    items_per_page = 56 # int |  (optional)
     id = 56 # int |  (optional)
     permission = 'permission_example' # str |  (optional)
     name = 'name_example' # str |  (optional)
+    sort_by = 'sort_by_example' # str | The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. (optional)
+    latest = True # bool | If True gets the most recently created object. (optional)
+    page = 1 # int | Page number (optional) (default to 1)
+    size = 50 # int | Page size (optional) (default to 50)
 
     try:
         # List permissions
-        api_response = await api_instance.read_permissions_permissions_get(latest=latest, sort_by=sort_by, page_number=page_number, items_per_page=items_per_page, id=id, permission=permission, name=name)
+        api_response = await api_instance.read_permissions_permissions_get(id=id, permission=permission, name=name, sort_by=sort_by, latest=latest, page=page, size=size)
         print("The response of PermissionsApi->read_permissions_permissions_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -305,17 +305,17 @@ async with compute_api_client.ApiClient(configuration) as api_client:
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **latest** | **bool**|  | [optional] 
- **sort_by** | **str**|  | [optional] 
- **page_number** | **int**|  | [optional] 
- **items_per_page** | **int**|  | [optional] 
  **id** | **int**|  | [optional] 
  **permission** | **str**|  | [optional] 
  **name** | **str**|  | [optional] 
+ **sort_by** | **str**| The field name to sort on. Prefix with '-' for descending order. E.g., '-created_on'. | [optional] 
+ **latest** | **bool**| If True gets the most recently created object. | [optional] 
+ **page** | **int**| Page number | [optional] [default to 1]
+ **size** | **int**| Page size | [optional] [default to 50]
 
 ### Return type
 
-[**List[Permission]**](Permission.md)
+[**PagePermission**](PagePermission.md)
 
 ### Authorization