qcs_api_client.operations.asyncio
#
Package Contents#
Functions#
|
Add user to a group |
|
Get Group Balance |
Retrieve billing customer for a QCS group account. |
|
Retrieve upcoming invoice for QCS group billing customer. |
|
|
Get User Balance |
Retrieve billing customer for a QCS user account. |
|
Retrieve upcoming invoice for QCS user billing customer. |
|
Retrieve billing invoice lines for a QCS group account's invoice. |
|
Retrieve billing invoices for a QCS group account. |
|
List invoice lines for QCS group billing customer upcoming invoice. |
|
|
List users belonging to a group |
Retrieve billing invoice lines for a QCS user account's invoice. |
|
Retrieve billing invoices for a QCS user account. |
|
|
List QCS groups for the requested user |
List invoice lines for QCS user billing customer upcoming invoice. |
|
|
Remove user from a group. |
Email Password Reset Token |
|
|
Get User |
|
Reset Password |
Reset Password With Token |
|
Check Client Application |
|
Get Client Application |
|
List Client Applications |
|
|
Retrieve the health status of the API |
|
Health Check |
|
Create Endpoint |
|
Delete Endpoint |
|
Get Default Endpoint |
|
Get Endpoint |
|
List Endpoints |
|
Restart Endpoint |
|
Create Engagement |
Get Instruction Set Architecture |
|
Get Quantum Processor |
|
List Quantum Processor Accessors |
|
List Quantum Processors |
|
|
Create Reservation |
|
Delete Reservation |
Find Available Reservations |
|
List Group Reservations |
|
|
List Reservations |
Get Quilt Calibrations |
|
Translate Native Quil To Encrypted Binary |
- async qcs_api_client.operations.asyncio.add_group_user(*, client: httpx.AsyncClient, json_body: qcs_api_client.models.add_group_user_request.AddGroupUserRequest, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[Any] #
Add user to a group
Add a user to a group. Note, group membership may take several minutes to update within our identity
provider. After adding a user to a group, please allow up to 60 minutes for changes to be reflected.
- Parameters
json_body (AddGroupUserRequest) – Must provide either userId or userEmail and groupId or groupName.
- Returns
Response[Any]
- async qcs_api_client.operations.asyncio.get_group_balance(group_name: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.account_balance.AccountBalance] #
Get Group Balance
Retrieve the balance of the requested QCS group account.
- Parameters
group_name (str) –
- Returns
Response[AccountBalance]
- async qcs_api_client.operations.asyncio.get_group_billing_customer(group_name: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.billing_customer.BillingCustomer] #
Retrieve billing customer for a QCS group account.
- Parameters
group_name (str) –
- Returns
Response[BillingCustomer]
- async qcs_api_client.operations.asyncio.get_group_upcoming_billing_invoice(group_name: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.billing_upcoming_invoice.BillingUpcomingInvoice] #
Retrieve upcoming invoice for QCS group billing customer.
- Parameters
group_name (str) –
- Returns
Response[BillingUpcomingInvoice]
- async qcs_api_client.operations.asyncio.get_user_balance(user_id: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.account_balance.AccountBalance] #
Get User Balance
Retrieve the balance of the requested QCS user account.
- Parameters
user_id (str) –
- Returns
Response[AccountBalance]
- async qcs_api_client.operations.asyncio.get_user_billing_customer(user_id: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.billing_customer.BillingCustomer] #
Retrieve billing customer for a QCS user account.
- Parameters
user_id (str) –
- Returns
Response[BillingCustomer]
- async qcs_api_client.operations.asyncio.get_user_upcoming_billing_invoice(user_id: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.billing_upcoming_invoice.BillingUpcomingInvoice] #
Retrieve upcoming invoice for QCS user billing customer.
- Parameters
user_id (str) –
- Returns
Response[BillingUpcomingInvoice]
- async qcs_api_client.operations.asyncio.list_group_billing_invoice_lines(group_name: str, billing_invoice_id: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.list_account_billing_invoice_lines_response.ListAccountBillingInvoiceLinesResponse] #
Retrieve billing invoice lines for a QCS group account’s invoice.
- Parameters
group_name (str) –
billing_invoice_id (str) –
- Returns
Response[ListAccountBillingInvoiceLinesResponse]
- async qcs_api_client.operations.asyncio.list_group_billing_invoices(group_name: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.list_account_billing_invoices_response.ListAccountBillingInvoicesResponse] #
Retrieve billing invoices for a QCS group account.
- Parameters
group_name (str) –
- Returns
Response[ListAccountBillingInvoicesResponse]
- async qcs_api_client.operations.asyncio.list_group_upcoming_billing_invoice_lines(group_name: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.list_account_billing_invoice_lines_response.ListAccountBillingInvoiceLinesResponse] #
List invoice lines for QCS group billing customer upcoming invoice.
- Parameters
group_name (str) –
- Returns
Response[ListAccountBillingInvoiceLinesResponse]
- async qcs_api_client.operations.asyncio.list_group_users(group_name: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.list_group_users_response.ListGroupUsersResponse] #
List users belonging to a group
List users belonging to a group. Note, group membership may take several minutes to update within
our identity provider. After adding or removing a user to or from a group, please allow up to 60 minutes for changes to be reflected.
- Parameters
group_name (str) –
- Returns
Response[ListGroupUsersResponse]
- async qcs_api_client.operations.asyncio.list_user_billing_invoice_lines(user_id: str, billing_invoice_id: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.list_account_billing_invoice_lines_response.ListAccountBillingInvoiceLinesResponse] #
Retrieve billing invoice lines for a QCS user account’s invoice.
- Parameters
user_id (str) –
billing_invoice_id (str) –
- Returns
Response[ListAccountBillingInvoiceLinesResponse]
- async qcs_api_client.operations.asyncio.list_user_billing_invoices(user_id: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.list_account_billing_invoices_response.ListAccountBillingInvoicesResponse] #
Retrieve billing invoices for a QCS user account.
- Parameters
user_id (str) –
- Returns
Response[ListAccountBillingInvoicesResponse]
- async qcs_api_client.operations.asyncio.list_user_groups(user_id: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.list_groups_response.ListGroupsResponse] #
List QCS groups for the requested user
List QCS groups for the requested user
- Parameters
user_id (str) –
- Returns
Response[ListGroupsResponse]
- async qcs_api_client.operations.asyncio.list_user_upcoming_billing_invoice_lines(user_id: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.list_account_billing_invoice_lines_response.ListAccountBillingInvoiceLinesResponse] #
List invoice lines for QCS user billing customer upcoming invoice.
- Parameters
user_id (str) –
- Returns
Response[ListAccountBillingInvoiceLinesResponse]
- async qcs_api_client.operations.asyncio.remove_group_user(*, client: httpx.AsyncClient, json_body: qcs_api_client.models.remove_group_user_request.RemoveGroupUserRequest, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[Any] #
Remove user from a group.
Remove a user from a group. Note, group membership may take several minutes to update within our
identity provider. After removing a user from a group, please allow up to 60 minutes for changes to be reflected.
- Parameters
json_body (RemoveGroupUserRequest) – Must provide either userId or userEmail and groupId or groupName.
- Returns
Response[Any]
- async qcs_api_client.operations.asyncio.auth_email_password_reset_token(*, client: httpx.AsyncClient, json_body: qcs_api_client.models.auth_email_password_reset_token_request.AuthEmailPasswordResetTokenRequest, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[Any] #
Email Password Reset Token
Send a password reset link to the provided email address, if that email matches a registered user.
- Parameters
json_body (AuthEmailPasswordResetTokenRequest) –
- Returns
Response[Any]
- async qcs_api_client.operations.asyncio.auth_get_user(*, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.user.User] #
Get User
Retrieve the profile of the authenticated user.
- Returns
Response[User]
- async qcs_api_client.operations.asyncio.auth_reset_password(*, client: httpx.AsyncClient, json_body: qcs_api_client.models.auth_reset_password_request.AuthResetPasswordRequest, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[Any] #
Reset Password
Reset the password using the user’s existing password. Note, this is an authenticated route.
- Parameters
json_body (AuthResetPasswordRequest) –
- Returns
Response[Any]
- async qcs_api_client.operations.asyncio.auth_reset_password_with_token(*, client: httpx.AsyncClient, json_body: qcs_api_client.models.auth_reset_password_with_token_request.AuthResetPasswordWithTokenRequest, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[Any] #
Reset Password With Token
Complete the forgot password flow, resetting the new password in exchange for an emailed token.
- Parameters
json_body (AuthResetPasswordWithTokenRequest) – Token may be requested with AuthEmailPasswordResetToken.
- Returns
Response[Any]
- async qcs_api_client.operations.asyncio.check_client_application(*, client: httpx.AsyncClient, json_body: qcs_api_client.models.check_client_application_request.CheckClientApplicationRequest, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.check_client_application_response.CheckClientApplicationResponse] #
Check Client Application
Check the requested client application version against the latest and minimum version.
- Parameters
json_body (CheckClientApplicationRequest) –
- Returns
Response[CheckClientApplicationResponse]
- async qcs_api_client.operations.asyncio.get_client_application(client_application_name: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.client_application.ClientApplication] #
Get Client Application
Get details of a specific Rigetti system component along with its latest and minimum supported
versions.
- Parameters
client_application_name (str) –
- Returns
Response[ClientApplication]
- async qcs_api_client.operations.asyncio.list_client_applications(*, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.list_client_applications_response.ListClientApplicationsResponse] #
List Client Applications
List supported clients of Rigetti system components along with their latest and minimum supported
versions.
- Returns
Response[ListClientApplicationsResponse]
- async qcs_api_client.operations.asyncio.get_health(*, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.health.Health] #
Retrieve the health status of the API
- Returns
Response[Health]
- async qcs_api_client.operations.asyncio.health_check(*, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[Any] #
Health Check
Endpoint to return a status 200 for load balancer health checks
- Returns
Response[Any]
- async qcs_api_client.operations.asyncio.create_endpoint(*, client: httpx.AsyncClient, json_body: qcs_api_client.models.create_endpoint_parameters.CreateEndpointParameters, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.endpoint.Endpoint] #
Create Endpoint
Create an endpoint associated with your user account.
- Parameters
json_body (CreateEndpointParameters) – A publicly available set of parameters for defining an endpoint.
- Returns
Response[Endpoint]
- async qcs_api_client.operations.asyncio.delete_endpoint(endpoint_id: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[Any] #
Delete Endpoint
Delete an endpoint, releasing its resources. This operation is not reversible.
- Parameters
endpoint_id (str) –
- Returns
Response[Any]
- async qcs_api_client.operations.asyncio.get_default_endpoint(quantum_processor_id: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.endpoint.Endpoint] #
Get Default Endpoint
Retrieve the endpoint set as “default” for the given Quantum Processor.
If no endpoint is set as the default, return “not found.”
- Parameters
quantum_processor_id (str) – Public identifier for a quantum processor [example: Aspen-1]
- Returns
Response[Endpoint]
- async qcs_api_client.operations.asyncio.get_endpoint(endpoint_id: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.endpoint.Endpoint] #
Get Endpoint
Retrieve a specific endpoint by its ID.
- Parameters
endpoint_id (str) –
- Returns
Response[Endpoint]
- async qcs_api_client.operations.asyncio.list_endpoints(*, client: httpx.AsyncClient, filter_: Union[qcs_api_client.types.Unset, None, str] = UNSET, page_size: Union[qcs_api_client.types.Unset, None, int] = 10, page_token: Union[qcs_api_client.types.Unset, None, str] = UNSET, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.list_endpoints_response.ListEndpointsResponse] #
List Endpoints
List all endpoints, optionally filtering by attribute.
- Parameters
filter (Union[Unset, None, str]) – Filtering logic specified using [rule- engine](https://zerosteiner.github.io/rule-engine/syntax.html) grammar
page_size (Union[Unset, None, int]) – Default: 10.
page_token (Union[Unset, None, str]) –
- Returns
Response[ListEndpointsResponse]
- async qcs_api_client.operations.asyncio.restart_endpoint(endpoint_id: str, *, client: httpx.AsyncClient, json_body: qcs_api_client.models.restart_endpoint_request.RestartEndpointRequest, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[Any] #
Restart Endpoint
Restart an entire endpoint or a single component within an endpoint.
- Parameters
endpoint_id (str) –
json_body (RestartEndpointRequest) –
- Returns
Response[Any]
- async qcs_api_client.operations.asyncio.create_engagement(*, client: httpx.AsyncClient, json_body: qcs_api_client.models.create_engagement_request.CreateEngagementRequest, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.engagement_with_credentials.EngagementWithCredentials] #
Create Engagement
Create a new engagement using the specified parameters.
At least one of the following parameters must be supplied: - endpointId: The ID of the endpoint on which to engage. - quantumProcessorId: The ID of the quantum processor on which to engage, allowing the
service to select a default endpoint. Ignored if endpointId is set.
- Parameters
json_body (CreateEngagementRequest) –
- Returns
Response[EngagementWithCredentials]
- async qcs_api_client.operations.asyncio.get_instruction_set_architecture(quantum_processor_id: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.instruction_set_architecture.InstructionSetArchitecture] #
Get Instruction Set Architecture
Retrieve the Instruction Set Architecture of a QuantumProcessor by ID.
- Parameters
quantum_processor_id (str) –
- Returns
Response[InstructionSetArchitecture]
- async qcs_api_client.operations.asyncio.get_quantum_processor(quantum_processor_id: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.quantum_processor.QuantumProcessor] #
Get Quantum Processor
Retrieve a single QuantumProcessor by ID.
- Parameters
quantum_processor_id (str) – Public identifier for a quantum processor [example: Aspen-1]
- Returns
Response[QuantumProcessor]
- async qcs_api_client.operations.asyncio.list_quantum_processor_accessors(quantum_processor_id: str, *, client: httpx.AsyncClient, page_size: Union[qcs_api_client.types.Unset, None, int] = 10, page_token: Union[qcs_api_client.types.Unset, None, str] = UNSET, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.list_quantum_processor_accessors_response.ListQuantumProcessorAccessorsResponse] #
List Quantum Processor Accessors
List all means of accessing a QuantumProcessor available to the user.
- Parameters
quantum_processor_id (str) – Public identifier for a quantum processor [example: Aspen-1]
page_size (Union[Unset, None, int]) – Default: 10.
page_token (Union[Unset, None, str]) –
- Returns
Response[ListQuantumProcessorAccessorsResponse]
- async qcs_api_client.operations.asyncio.list_quantum_processors(*, client: httpx.AsyncClient, page_size: Union[qcs_api_client.types.Unset, None, int] = 10, page_token: Union[qcs_api_client.types.Unset, None, str] = UNSET, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.list_quantum_processors_response.ListQuantumProcessorsResponse] #
List Quantum Processors
List all QuantumProcessors available to the user.
- Parameters
page_size (Union[Unset, None, int]) – Default: 10.
page_token (Union[Unset, None, str]) –
- Returns
Response[ListQuantumProcessorsResponse]
- async qcs_api_client.operations.asyncio.create_reservation(*, client: httpx.AsyncClient, json_body: qcs_api_client.models.create_reservation_request.CreateReservationRequest, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.reservation.Reservation] #
Create Reservation
Create a new reservation.
The following precedence applies when specifying the reservation subject account ID and type: * request body accountId field, or if unset then X-QCS-ACCOUNT-ID header, or if unset then requesting user’s ID. * request body accountType field, or if unset then X-QCS-ACCOUNT-TYPE header, or if unset then “user” type.
- Parameters
json_body (CreateReservationRequest) –
- Returns
Response[Reservation]
- async qcs_api_client.operations.asyncio.delete_reservation(reservation_id: int, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.reservation.Reservation] #
Delete Reservation
Cancel an existing reservation for the user.
- Parameters
reservation_id (int) –
- Returns
Response[Reservation]
- async qcs_api_client.operations.asyncio.find_available_reservations(*, client: httpx.AsyncClient, quantum_processor_id: str, start_time_from: datetime.datetime, duration: str, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.find_available_reservations_response.FindAvailableReservationsResponse] #
Find Available Reservations
List currently available reservations on the requested Rigetti quantum computer.
- Parameters
quantum_processor_id (str) –
start_time_from (datetime.datetime) –
duration (str) – Formatted as specified for golang https://golang.org/pkg/time/#ParseDuration.
- Returns
Response[FindAvailableReservationsResponse]
- async qcs_api_client.operations.asyncio.list_group_reservations(group_name: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.list_reservations_response.ListReservationsResponse] #
List Group Reservations
List existing reservations for the requested group.
Available filter fields include:
startTime - timestamp
endTime - timestamp
createdTime - timestamp
price - integer
quantumProcessorId - string
Available order fields include:
startTime - timestamp
endTime - timestamp
createdTime - timestamp
price - integer
- Parameters
group_name (str) –
- Returns
Response[ListReservationsResponse]
- async qcs_api_client.operations.asyncio.list_reservations(*, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.list_reservations_response.ListReservationsResponse] #
List Reservations
List existing reservations for the authenticated user,
or a target user when specifying X-QCS-ACCOUNT-ID and X-QCS-ACCOUNT-TYPE headers.
Available filter fields include:
startTime - timestamp
endTime - timestamp
createdTime - timestamp
price - integer
cancelled - boolean (deprecated, use showDeleted parameter)
quantumProcessorId - string
Available order fields include:
startTime - timestamp
endTime - timestamp
createdTime - timestamp
price - integer
- Returns
Response[ListReservationsResponse]
- async qcs_api_client.operations.asyncio.get_quilt_calibrations(quantum_processor_id: str, *, client: httpx.AsyncClient, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.get_quilt_calibrations_response.GetQuiltCalibrationsResponse] #
Get Quilt Calibrations
Retrieve the calibration data used for client-side Quilt generation.
- Parameters
quantum_processor_id (str) – Public identifier for a quantum processor [example: Aspen-1]
- Returns
Response[GetQuiltCalibrationsResponse]
- async qcs_api_client.operations.asyncio.translate_native_quil_to_encrypted_binary(quantum_processor_id: str, *, client: httpx.AsyncClient, json_body: qcs_api_client.models.translate_native_quil_to_encrypted_binary_request.TranslateNativeQuilToEncryptedBinaryRequest, httpx_request_kwargs: Dict[str, Any] = {}) qcs_api_client.types.Response[qcs_api_client.models.translate_native_quil_to_encrypted_binary_response.TranslateNativeQuilToEncryptedBinaryResponse] #
Translate Native Quil To Encrypted Binary
Compile Rigetti-native Quil code to encrypted binary form, ready for execution on a
Rigetti Quantum Processor.
- Parameters
quantum_processor_id (str) – Public identifier for a quantum processor [example: Aspen-1]
json_body (TranslateNativeQuilToEncryptedBinaryRequest) –
- Returns
Response[TranslateNativeQuilToEncryptedBinaryResponse]