qcs_api_client.operations.sync

Package Contents

Functions

add_group_user(→ qcs_api_client.types.Response[Any])	Add user to a group
get_group_balance(...)	Get Group Balance
get_group_billing_customer(...)	Retrieve billing customer for a QCS group account.
get_group_upcoming_billing_invoice(...)	Retrieve upcoming invoice for QCS group billing customer.
get_user_balance(...)	Get User Balance
get_user_billing_customer(...)	Retrieve billing customer for a QCS user account.
get_user_upcoming_billing_invoice(...)	Retrieve upcoming invoice for QCS user billing customer.
list_group_billing_invoice_lines(...)	Retrieve billing invoice lines for a QCS group account's invoice.
list_group_billing_invoices(...)	Retrieve billing invoices for a QCS group account.
list_group_upcoming_billing_invoice_lines(...)	List invoice lines for QCS group billing customer upcoming invoice.
list_group_users(...)	List users belonging to a group
list_user_billing_invoice_lines(...)	Retrieve billing invoice lines for a QCS user account's invoice.
list_user_billing_invoices(...)	Retrieve billing invoices for a QCS user account.
list_user_groups(...)	List QCS groups for the requested user
list_user_upcoming_billing_invoice_lines(...)	List invoice lines for QCS user billing customer upcoming invoice.
remove_group_user(→ qcs_api_client.types.Response[Any])	Remove user from a group.
auth_email_password_reset_token(...)	Email Password Reset Token
auth_get_user(...)	Get User
auth_reset_password(→ qcs_api_client.types.Response[Any])	Reset Password
auth_reset_password_with_token(...)	Reset Password With Token
check_client_application(...)	Check Client Application
get_client_application(...)	Get Client Application
list_client_applications(...)	List Client Applications
get_health(...)	Retrieve the health status of the API
health_check(→ qcs_api_client.types.Response[Any])	Health Check
create_endpoint(...)	Create Endpoint
delete_endpoint(→ qcs_api_client.types.Response[Any])	Delete Endpoint
get_default_endpoint(...)	Get Default Endpoint
get_endpoint(...)	Get Endpoint
list_endpoints(...)	List Endpoints
restart_endpoint(→ qcs_api_client.types.Response[Any])	Restart Endpoint
create_engagement(...)	Create Engagement
get_instruction_set_architecture(...)	Get Instruction Set Architecture
get_quantum_processor(...)	Get Quantum Processor
list_quantum_processor_accessors(...)	List Quantum Processor Accessors
list_quantum_processors(...)	List Quantum Processors
create_reservation(...)	Create Reservation
delete_reservation(...)	Delete Reservation
find_available_reservations(...)	Find Available Reservations
list_group_reservations(...)	List Group Reservations
list_reservations(...)	List Reservations
get_quilt_calibrations(...)	Get Quilt Calibrations
translate_native_quil_to_encrypted_binary(...)	Translate Native Quil To Encrypted Binary

qcs_api_client.operations.sync.add_group_user(*, client: httpx.Client, 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]

qcs_api_client.operations.sync.get_group_balance(group_name: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.get_group_billing_customer(group_name: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.get_group_upcoming_billing_invoice(group_name: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.get_user_balance(user_id: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.get_user_billing_customer(user_id: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.get_user_upcoming_billing_invoice(user_id: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.list_group_billing_invoice_lines(group_name: str, billing_invoice_id: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.list_group_billing_invoices(group_name: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.list_group_upcoming_billing_invoice_lines(group_name: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.list_group_users(group_name: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.list_user_billing_invoice_lines(user_id: str, billing_invoice_id: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.list_user_billing_invoices(user_id: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.list_user_groups(user_id: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.list_user_upcoming_billing_invoice_lines(user_id: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.remove_group_user(*, client: httpx.Client, 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]

qcs_api_client.operations.sync.auth_email_password_reset_token(*, client: httpx.Client, 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]

qcs_api_client.operations.sync.auth_get_user(*, client: httpx.Client, 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]

qcs_api_client.operations.sync.auth_reset_password(*, client: httpx.Client, 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]

qcs_api_client.operations.sync.auth_reset_password_with_token(*, client: httpx.Client, 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]

qcs_api_client.operations.sync.check_client_application(*, client: httpx.Client, 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]

qcs_api_client.operations.sync.get_client_application(client_application_name: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.list_client_applications(*, client: httpx.Client, 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]

qcs_api_client.operations.sync.get_health(*, client: httpx.Client, 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]

qcs_api_client.operations.sync.health_check(*, client: httpx.Client, 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]

qcs_api_client.operations.sync.create_endpoint(*, client: httpx.Client, 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]

qcs_api_client.operations.sync.delete_endpoint(endpoint_id: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.get_default_endpoint(quantum_processor_id: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.get_endpoint(endpoint_id: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.list_endpoints(*, client: httpx.Client, 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]

qcs_api_client.operations.sync.restart_endpoint(endpoint_id: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.create_engagement(*, client: httpx.Client, 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]

qcs_api_client.operations.sync.get_instruction_set_architecture(quantum_processor_id: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.get_quantum_processor(quantum_processor_id: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.list_quantum_processor_accessors(quantum_processor_id: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.list_quantum_processors(*, client: httpx.Client, 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]

qcs_api_client.operations.sync.create_reservation(*, client: httpx.Client, 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]

qcs_api_client.operations.sync.delete_reservation(reservation_id: int, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.find_available_reservations(*, client: httpx.Client, 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]

qcs_api_client.operations.sync.list_group_reservations(group_name: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.list_reservations(*, client: httpx.Client, 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]

qcs_api_client.operations.sync.get_quilt_calibrations(quantum_processor_id: str, *, client: httpx.Client, 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]

qcs_api_client.operations.sync.translate_native_quil_to_encrypted_binary(quantum_processor_id: str, *, client: httpx.Client, 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]