Custom Mutations

The gpp_client.generated.custom_mutations module provides helpers for building custom GraphQL mutations.

Use these helpers when you need custom return fields or mutation shapes beyond the provided domain methods.

API Reference

class gpp_client.generated.custom_mutations.Mutation

Bases: object

classmethod add_conditions_entry(*, input: ConditionsEntryInput | None = None) → AddConditionsEntryResultFields

Logs observing conditions to the Chronicle. This operation is permitted only for staff and service users.

classmethod add_dataset_event(input: AddDatasetEventInput) → AddDatasetEventResultFields

Adds a new dataset event associated with the given visit. The generation of a single dataset will produce multiple events as it transitions through the observe, readout and write stages.

classmethod add_program_user(input: AddProgramUserInput) → AddProgramUserResultFields

Creates a ‘ProgramUser’ without a link to any existing ‘User’. No invitation is sent as a result of this operation, but an invitation may be subsequently sent and when accepted the ‘User’ field will become available and the ‘User’ will gain appropriate access to the program.

classmethod add_sequence_event(input: AddSequenceEventInput) → AddSequenceEventResultFields

Adds a sequence event associated with the given visit. Multiple events will be produced during the execution of a sequence as it is started, paused, continued, etc.

classmethod add_slew_event(input: AddSlewEventInput) → AddSlewEventResultFields

Adds a new slew event associated with the given visit.

classmethod add_step_event(input: AddStepEventInput) → AddStepEventResultFields

Adds a new step event associated with the given step. Multiple events will be produced during the execution of a single step as it transitions through configure and observe stages.

classmethod add_time_charge_correction(input: AddTimeChargeCorrectionInput) → AddTimeChargeCorrectionResultFields

Adds a new time accounting correction for a particular observation. Note that time accounting corrections are additive and cannot be adjusted or deleted except via a future correction. For example, to undo the impact of an ‘Add’ operation, a new ‘Subtract’ operation of the same amount can be introduced.

classmethod change_program_user_role(input: ChangeProgramUserRoleInput) → ChangeProgramUserRoleResultFields

Update the role of a program user.

classmethod clone_group(input: CloneGroupInput) → CloneGroupResultFields

Copy this group and its contents, recursively, as a sibling of itself.

classmethod clone_observation(input: CloneObservationInput) → CloneObservationResultFields

classmethod clone_target(input: CloneTargetInput) → CloneTargetResultFields

Makes a copy of an existing target, setting it to unobserved and to PRESENT. If REPLACE_IN observationIds are specified in the input, the clone will replace the existing target in those observations

classmethod create_call_for_proposals(input: CreateCallForProposalsInput) → CreateCallForProposalsResultFields

Creates a Call for Proposals. Requires staff access.

classmethod create_configuration_request(input: CreateConfigurationRequestInput) → ConfigurationRequestFields

Create a configuration request.

classmethod create_group(input: CreateGroupInput) → CreateGroupResultFields

Creates a new observation according to provided parameters.

classmethod create_observation(input: CreateObservationInput) → CreateObservationResultFields

Creates a new observation according to provided parameters

classmethod create_program(input: CreateProgramInput) → CreateProgramResultFields

Creates a new program according to provided properties

classmethod create_program_note(input: CreateProgramNoteInput) → CreateProgramNoteResultFields

Creates a new program note according to provided parameters

classmethod create_proposal(input: CreateProposalInput) → CreateProposalResultFields

Creates a new proposal according to the provided properties

classmethod create_target(input: CreateTargetInput) → CreateTargetResultFields

Creates a new target according to the provided parameters. Only one of sidereal or nonsidereal may be specified.

classmethod create_user_invitation(input: CreateUserInvitationInput) → CreateUserInvitationResultFields

Create a user invitation.

classmethod delete_program_user(input: DeleteProgramUserInput) → DeleteProgramUserResultFields

Deletes a ‘ProgramUser’.

classmethod delete_proposal(input: DeleteProposalInput) → DeleteProposalResultFields

Deletes the given program’s proposal, if any.

classmethod link_user(input: LinkUserInput) → LinkUserResultFields

Ties a specific user to an existing ProgramUser, which must not already be associated with any user.

classmethod record_dataset(input: RecordDatasetInput) → RecordDatasetResultFields

Records a new dataset. This dataset may be subsequently referenced by dataset events.

classmethod record_flamingos_2_visit(input: RecordFlamingos2VisitInput) → RecordFlamingos2VisitResultFields

Record a new Flamingos 2 visit

classmethod record_gmos_north_visit(input: RecordGmosNorthVisitInput) → RecordGmosNorthVisitResultFields

Record a new GMOS North visit

classmethod record_gmos_south_visit(input: RecordGmosSouthVisitInput) → RecordGmosSouthVisitResultFields

Record a new GMOS South visit

classmethod record_igrins_2_visit(input: RecordIgrins2VisitInput) → RecordIgrins2VisitResultFields

Record a new IGRINS-2 visit

classmethod record_visit(input: RecordVisitInput) → RecordVisitResultFields

Record a new visit.

classmethod redeem_user_invitation(input: RedeemUserInvitationInput) → RedeemUserInvitationResultFields

Redeem a user invitation.

classmethod replace_flamingos_2_sequence(input: ReplaceFlamingos2SequenceInput) → ReplaceFlamingos2SequenceResultFields

Replaces the remaining steps in an execution sequence with the provided sequence. Previously executed (or even partially executed) steps are not deleted. Any ongoing steps are abandoned.

classmethod replace_gmos_north_sequence(input: ReplaceGmosNorthSequenceInput) → ReplaceGmosNorthSequenceResultFields

Replaces the remaining steps in an execution sequence with the provided sequence. Previously executed (or even partially executed) steps are not deleted. Any ongoing steps are abandoned.

classmethod replace_gmos_south_sequence(input: ReplaceGmosSouthSequenceInput) → ReplaceGmosSouthSequenceResultFields

Replaces the remaining steps in an execution sequence with the provided sequence. Previously executed (or even partially executed) steps are not deleted. Any ongoing steps are abandoned.

classmethod replace_igrins_2_sequence(input: ReplaceIgrins2SequenceInput) → ReplaceIgrins2SequenceResultFields

Replaces the remaining steps in an execution sequence with the provided sequence. Previously executed (or even partially executed) steps are not deleted. Any ongoing steps are abandoned.

classmethod reset_acquisition(input: ResetAcquisitionInput) → ResetAcquisitionResultFields

Resets the acquisition sequence to start from the initial step regardless of which acquisition steps may have been executed. Requires staff (or better) access.

classmethod revoke_user_invitation(input: RevokeUserInvitationInput) → RevokeUserInvitationResultFields

Revoke a user invitation.

classmethod set_allocations(input: SetAllocationsInput) → SetAllocationsResultFields

Set the allocations for a program.

classmethod set_guide_target_name(input: SetGuideTargetNameInput) → SetGuideTargetNameResultFields

Set the name of the guide target for an observation.

classmethod set_observation_workflow_state(input: SetObservationWorkflowStateInput) → ObservationWorkflowFields

Sets the workflow state for the specified observation. The transition must be valid according to the current workflow. Returns the updated workflow.

classmethod set_program_reference(input: SetProgramReferenceInput) → SetProgramReferenceResultFields

Set the program reference.

classmethod set_proposal_status(input: SetProposalStatusInput) → SetProposalStatusResultFields

Set the proposal status.

classmethod unlink_user(input: UnlinkUserInput) → UnlinkUserResultFields

Unlink a user from a program.

classmethod update_asterisms(input: UpdateAsterismsInput) → UpdateAsterismsResultFields

Update asterisms, adding or deleting targets, in (potentially) multiple observations at once.

classmethod update_attachments(input: UpdateAttachmentsInput) → UpdateAttachmentsResultFields

classmethod update_calls_for_proposals(input: UpdateCallsForProposalsInput) → UpdateCallsForProposalsResultFields

Update existing calls for proposals.

classmethod update_configuration_requests(input: UpdateConfigurationRequestsInput) → UpdateConfigurationRequestsResultFields

Update existing configuration requests.

classmethod update_datasets(input: UpdateDatasetsInput) → UpdateDatasetsResultFields

classmethod update_groups(input: UpdateGroupsInput) → UpdateGroupsResultFields

classmethod update_observations(input: UpdateObservationsInput) → UpdateObservationsResultFields

Updates existing observations

classmethod update_observations_times(input: UpdateObservationsTimesInput) → UpdateObservationsResultFields

Updates existing observations times (execution and duration)

classmethod update_program_notes(input: UpdateProgramNotesInput) → UpdateProgramNotesResultFields

Updates existing program notes.

classmethod update_program_users(input: UpdateProgramUsersInput) → UpdateProgramUsersResultFields

Updates existing program users.

classmethod update_programs(input: UpdateProgramsInput) → UpdateProgramsResultFields

Updates existing programs.

classmethod update_proposal(input: UpdateProposalInput) → UpdateProposalResultFields

Updates an existing proposal.

classmethod update_targets(input: UpdateTargetsInput) → UpdateTargetsResultFields

Updates existing targets