createGymClient
createGymClient(
opts?):object
The gymgym client: every GraphQL operation as a typed method, the Better Auth client as auth, and an
offline queue for idempotent saves. This is the only way apps talk to the backend.
Parameters
Section titled “Parameters”GymClientOptions = {}
Returns
Section titled “Returns”activeWorkout
Section titled “activeWorkout”activeWorkout: () =>
Promise<ActiveWorkoutQuery>
query ActiveWorkout from operations/*.graphql
Returns
Section titled “Returns”Promise<ActiveWorkoutQuery>
activity
Section titled “activity”activity: (
variables?) =>Promise<ActivityQuery>
query Activity from operations/*.graphql
Parameters
Section titled “Parameters”variables?
Section titled “variables?”Exact<{ from?: string | null; to?: string | null; }>
Returns
Section titled “Returns”Promise<ActivityQuery>
adminCreateInvite
Section titled “adminCreateInvite”adminCreateInvite: () =>
Promise<AdminCreateInviteMutation>
mutation AdminCreateInvite from operations/*.graphql
Returns
Section titled “Returns”Promise<AdminCreateInviteMutation>
adminDashboard
Section titled “adminDashboard”adminDashboard: () =>
Promise<AdminDashboardQuery>
query AdminDashboard from operations/*.graphql
Returns
Section titled “Returns”Promise<AdminDashboardQuery>
adminRevokeInvite
Section titled “adminRevokeInvite”adminRevokeInvite: (
variables) =>Promise<AdminRevokeInviteMutation>
mutation AdminRevokeInvite from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.AdminRevokeInviteMutationVariables
Returns
Section titled “Returns”Promise<AdminRevokeInviteMutation>
adminSetUserDisabled
Section titled “adminSetUserDisabled”adminSetUserDisabled: (
variables) =>Promise<AdminSetUserDisabledMutation>
mutation AdminSetUserDisabled from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.AdminSetUserDisabledMutationVariables
Returns
Section titled “Returns”Promise<AdminSetUserDisabledMutation>
adminSignIns
Section titled “adminSignIns”adminSignIns: (
variables?) =>Promise<AdminSignInsQuery>
query AdminSignIns from operations/*.graphql
Parameters
Section titled “Parameters”variables?
Section titled “variables?”Exact<{ limit?: number | null; }>
Returns
Section titled “Returns”Promise<AdminSignInsQuery>
adminUser
Section titled “adminUser”adminUser: (
variables) =>Promise<AdminUserQuery>
query AdminUser from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.AdminUserQueryVariables
Returns
Section titled “Returns”Promise<AdminUserQuery>
apiKeys
Section titled “apiKeys”apiKeys: () =>
Promise<ApiKeysQuery>
query ApiKeys from operations/*.graphql
Returns
Section titled “Returns”Promise<ApiKeysQuery>
auth:
AuthClient<{baseURL:string;fetchOptions: {auth: {token: () =>string|undefined;type:"Bearer"; };customFetchImpl?: (input,init?) =>Promise<Response>;headers?:Record<string,string>; };plugins: ({ } | { } | { } | { } | { } | { } | { })[]; }>
backup
Section titled “backup”backup: () =>
Promise<BackupQuery>
query Backup from operations/*.graphql
Returns
Section titled “Returns”Promise<BackupQuery>
bodyweight
Section titled “bodyweight”bodyweight: (
variables?) =>Promise<BodyweightQuery>
query Bodyweight from operations/*.graphql
Parameters
Section titled “Parameters”variables?
Section titled “variables?”Exact<{ from?: string | null; to?: string | null; }>
Returns
Section titled “Returns”Promise<BodyweightQuery>
cancelRestPush
Section titled “cancelRestPush”cancelRestPush: () =>
Promise<CancelRestPushMutation>
mutation CancelRestPush from operations/*.graphql
Returns
Section titled “Returns”Promise<CancelRestPushMutation>
clearDayOverride
Section titled “clearDayOverride”clearDayOverride: (
variables) =>Promise<ClearDayOverrideMutation>
mutation ClearDayOverride from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.ClearDayOverrideMutationVariables
Returns
Section titled “Returns”Promise<ClearDayOverrideMutation>
config
Section titled “config”config: () =>
Promise<ConfigQuery>
query Config from operations/*.graphql
Returns
Section titled “Returns”Promise<ConfigQuery>
connectedApps
Section titled “connectedApps”connectedApps: () =>
Promise<ConnectedAppsQuery>
query ConnectedApps from operations/*.graphql
Returns
Section titled “Returns”Promise<ConnectedAppsQuery>
createApiKey
Section titled “createApiKey”createApiKey: (
variables) =>Promise<CreateApiKeyMutation>
mutation CreateApiKey from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.CreateApiKeyMutationVariables
Returns
Section titled “Returns”Promise<CreateApiKeyMutation>
createPlanShare
Section titled “createPlanShare”createPlanShare: () =>
Promise<CreatePlanShareMutation>
mutation CreatePlanShare from operations/*.graphql
Returns
Section titled “Returns”Promise<CreatePlanShareMutation>
day: (
variables?) =>Promise<DayQuery>
query Day from operations/*.graphql
Parameters
Section titled “Parameters”variables?
Section titled “variables?”Exact<{ date?: string | null; }>
Returns
Section titled “Returns”Promise<DayQuery>
deleteBodyweight
Section titled “deleteBodyweight”deleteBodyweight: (
variables) =>Promise<DeleteBodyweightMutation>
mutation DeleteBodyweight from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.DeleteBodyweightMutationVariables
Returns
Section titled “Returns”Promise<DeleteBodyweightMutation>
deleteCustomExercise
Section titled “deleteCustomExercise”deleteCustomExercise: (
variables) =>Promise<DeleteCustomExerciseMutation>
mutation DeleteCustomExercise from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.DeleteCustomExerciseMutationVariables
Returns
Section titled “Returns”Promise<DeleteCustomExerciseMutation>
deleteRoutine
Section titled “deleteRoutine”deleteRoutine: (
variables) =>Promise<DeleteRoutineMutation>
mutation DeleteRoutine from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.DeleteRoutineMutationVariables
Returns
Section titled “Returns”Promise<DeleteRoutineMutation>
deleteWorkout
Section titled “deleteWorkout”deleteWorkout: (
variables) =>Promise<DeleteWorkoutMutation>
mutation DeleteWorkout from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.DeleteWorkoutMutationVariables
Returns
Section titled “Returns”Promise<DeleteWorkoutMutation>
disconnectApp
Section titled “disconnectApp”disconnectApp: (
variables) =>Promise<DisconnectAppMutation>
mutation DisconnectApp from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.DisconnectAppMutationVariables
Returns
Section titled “Returns”Promise<DisconnectAppMutation>
effort
Section titled “effort”effort: (
variables?) =>Promise<EffortQuery>
query Effort from operations/*.graphql
Parameters
Section titled “Parameters”variables?
Section titled “variables?”Exact<{ from?: string | null; to?: string | null; }>
Returns
Section titled “Returns”Promise<EffortQuery>
exercises
Section titled “exercises”exercises: (
variables?) =>Promise<ExercisesQuery>
query Exercises from operations/*.graphql
Parameters
Section titled “Parameters”variables?
Section titled “variables?”Exact<{ includeDeleted?: boolean | null; }>
Returns
Section titled “Returns”Promise<ExercisesQuery>
exerciseStats
Section titled “exerciseStats”exerciseStats: (
variables) =>Promise<ExerciseStatsQuery>
query ExerciseStats from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.ExerciseStatsQueryVariables
Returns
Section titled “Returns”Promise<ExerciseStatsQuery>
finishWorkout
Section titled “finishWorkout”finishWorkout: (
variables) =>Promise<FinishWorkoutMutation>
mutation FinishWorkout from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.FinishWorkoutMutationVariables
Returns
Section titled “Returns”Promise<FinishWorkoutMutation>
heartbeat
Section titled “heartbeat”heartbeat: (
variables) =>Promise<HeartbeatMutation>
mutation Heartbeat from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.HeartbeatMutationVariables
Returns
Section titled “Returns”Promise<HeartbeatMutation>
hevyWorkouts
Section titled “hevyWorkouts”hevyWorkouts: (
variables) =>Promise<HevyWorkoutsQuery>
query HevyWorkouts from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.HevyWorkoutsQueryVariables
Returns
Section titled “Returns”Promise<HevyWorkoutsQuery>
importHistory
Section titled “importHistory”importHistory: (
variables) =>Promise<ImportHistoryMutation>
mutation ImportHistory from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.ImportHistoryMutationVariables
Returns
Section titled “Returns”Promise<ImportHistoryMutation>
importPlan
Section titled “importPlan”importPlan: (
variables) =>Promise<ImportPlanMutation>
mutation ImportPlan from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.ImportPlanMutationVariables
Returns
Section titled “Returns”Promise<ImportPlanMutation>
importSharedPlan
Section titled “importSharedPlan”importSharedPlan: (
variables) =>Promise<ImportSharedPlanMutation>
mutation ImportSharedPlan from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.ImportSharedPlanMutationVariables
Returns
Section titled “Returns”Promise<ImportSharedPlanMutation>
liftBalance
Section titled “liftBalance”liftBalance: () =>
Promise<LiftBalanceQuery>
query LiftBalance from operations/*.graphql
Returns
Section titled “Returns”Promise<LiftBalanceQuery>
loadStarterPlan
Section titled “loadStarterPlan”loadStarterPlan: (
variables) =>Promise<LoadStarterPlanMutation>
mutation LoadStarterPlan from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.LoadStarterPlanMutationVariables
Returns
Section titled “Returns”Promise<LoadStarterPlanMutation>
logBodyweight
Section titled “logBodyweight”logBodyweight: (
variables) =>Promise<LogBodyweightMutation>
mutation LogBodyweight from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.LogBodyweightMutationVariables
Returns
Section titled “Returns”Promise<LogBodyweightMutation>
me: () =>
Promise<MeQuery>
query Me from operations/*.graphql
Returns
Section titled “Returns”Promise<MeQuery>
muscleBalance
Section titled “muscleBalance”muscleBalance: (
variables?) =>Promise<MuscleBalanceQuery>
query MuscleBalance from operations/*.graphql
Parameters
Section titled “Parameters”variables?
Section titled “variables?”Exact<{ from?: string | null; hardOnly?: boolean | null; to?: string | null; }>
Returns
Section titled “Returns”Promise<MuscleBalanceQuery>
muscleRecovery
Section titled “muscleRecovery”muscleRecovery: () =>
Promise<MuscleRecoveryQuery>
query MuscleRecovery from operations/*.graphql
Returns
Section titled “Returns”Promise<MuscleRecoveryQuery>
nextTargets
Section titled “nextTargets”nextTargets: (
variables) =>Promise<NextTargetsQuery>
query NextTargets from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.NextTargetsQueryVariables
Returns
Section titled “Returns”Promise<NextTargetsQuery>
overrides
Section titled “overrides”overrides: (
variables?) =>Promise<OverridesQuery>
query Overrides from operations/*.graphql
Parameters
Section titled “Parameters”variables?
Section titled “variables?”Exact<{ from?: string | null; to?: string | null; }>
Returns
Section titled “Returns”Promise<OverridesQuery>
pinnedNotes
Section titled “pinnedNotes”pinnedNotes: () =>
Promise<PinnedNotesQuery>
query PinnedNotes from operations/*.graphql
Returns
Section titled “Returns”Promise<PinnedNotesQuery>
plan: () =>
Promise<PlanQuery>
query Plan from operations/*.graphql
Returns
Section titled “Returns”Promise<PlanQuery>
planFile
Section titled “planFile”planFile: () =>
Promise<PlanFileQuery>
query PlanFile from operations/*.graphql
Returns
Section titled “Returns”Promise<PlanFileQuery>
queue:
OfflineQueue
Durable queue for idempotent mutations such as SaveWorkout.
removeCustomExercisePhoto
Section titled “removeCustomExercisePhoto”removeCustomExercisePhoto: (
variables) =>Promise<RemoveCustomExercisePhotoMutation>
mutation RemoveCustomExercisePhoto from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.RemoveCustomExercisePhotoMutationVariables
Returns
Section titled “Returns”Promise<RemoveCustomExercisePhotoMutation>
reorderRoutines
Section titled “reorderRoutines”reorderRoutines: (
variables) =>Promise<ReorderRoutinesMutation>
mutation ReorderRoutines from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.ReorderRoutinesMutationVariables
Returns
Section titled “Returns”Promise<ReorderRoutinesMutation>
request
Section titled “request”request:
Requester
Low-level: send any generated document.
rescheduleDay
Section titled “rescheduleDay”rescheduleDay: (
variables) =>Promise<RescheduleDayMutation>
mutation RescheduleDay from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.RescheduleDayMutationVariables
Returns
Section titled “Returns”Promise<RescheduleDayMutation>
resetData
Section titled “resetData”resetData: () =>
Promise<ResetDataMutation>
mutation ResetData from operations/*.graphql
Returns
Section titled “Returns”Promise<ResetDataMutation>
restoreBackup
Section titled “restoreBackup”restoreBackup: (
variables) =>Promise<RestoreBackupMutation>
mutation RestoreBackup from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.RestoreBackupMutationVariables
Returns
Section titled “Returns”Promise<RestoreBackupMutation>
revokeApiKey
Section titled “revokeApiKey”revokeApiKey: (
variables) =>Promise<RevokeApiKeyMutation>
mutation RevokeApiKey from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.RevokeApiKeyMutationVariables
Returns
Section titled “Returns”Promise<RevokeApiKeyMutation>
revokeSession
Section titled “revokeSession”revokeSession: (
variables) =>Promise<RevokeSessionMutation>
mutation RevokeSession from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.RevokeSessionMutationVariables
Returns
Section titled “Returns”Promise<RevokeSessionMutation>
saveCustomExercise
Section titled “saveCustomExercise”saveCustomExercise: (
variables) =>Promise<SaveCustomExerciseMutation>
mutation SaveCustomExercise from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.SaveCustomExerciseMutationVariables
Returns
Section titled “Returns”Promise<SaveCustomExerciseMutation>
saveRoutine
Section titled “saveRoutine”saveRoutine: (
variables) =>Promise<SaveRoutineMutation>
mutation SaveRoutine from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.SaveRoutineMutationVariables
Returns
Section titled “Returns”Promise<SaveRoutineMutation>
saveWorkout
Section titled “saveWorkout”saveWorkout: (
variables) =>Promise<SaveWorkoutMutation>
mutation SaveWorkout from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.SaveWorkoutMutationVariables
Returns
Section titled “Returns”Promise<SaveWorkoutMutation>
scheduleRestPush
Section titled “scheduleRestPush”scheduleRestPush: (
variables) =>Promise<ScheduleRestPushMutation>
mutation ScheduleRestPush from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.ScheduleRestPushMutationVariables
Returns
Section titled “Returns”Promise<ScheduleRestPushMutation>
sendTestPush
Section titled “sendTestPush”sendTestPush: () =>
Promise<SendTestPushMutation>
mutation SendTestPush from operations/*.graphql
Returns
Section titled “Returns”Promise<SendTestPushMutation>
setCustomExercisePhoto
Section titled “setCustomExercisePhoto”setCustomExercisePhoto: (
variables) =>Promise<SetCustomExercisePhotoMutation>
mutation SetCustomExercisePhoto from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.SetCustomExercisePhotoMutationVariables
Returns
Section titled “Returns”Promise<SetCustomExercisePhotoMutation>
setDayOverride
Section titled “setDayOverride”setDayOverride: (
variables) =>Promise<SetDayOverrideMutation>
mutation SetDayOverride from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.SetDayOverrideMutationVariables
Returns
Section titled “Returns”Promise<SetDayOverrideMutation>
setExerciseSetting
Section titled “setExerciseSetting”setExerciseSetting: (
variables) =>Promise<SetExerciseSettingMutation>
mutation SetExerciseSetting from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.SetExerciseSettingMutationVariables
Returns
Section titled “Returns”Promise<SetExerciseSettingMutation>
setFavourite
Section titled “setFavourite”setFavourite: (
variables) =>Promise<SetFavouriteMutation>
mutation SetFavourite from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.SetFavouriteMutationVariables
Returns
Section titled “Returns”Promise<SetFavouriteMutation>
setPassword
Section titled “setPassword”setPassword: (
variables) =>Promise<SetPasswordMutation>
mutation SetPassword from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.SetPasswordMutationVariables
Returns
Section titled “Returns”Promise<SetPasswordMutation>
setWeekday
Section titled “setWeekday”setWeekday: (
variables) =>Promise<SetWeekdayMutation>
mutation SetWeekday from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.SetWeekdayMutationVariables
Returns
Section titled “Returns”Promise<SetWeekdayMutation>
sharedPlan
Section titled “sharedPlan”sharedPlan: (
variables) =>Promise<SharedPlanQuery>
query SharedPlan from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.SharedPlanQueryVariables
Returns
Section titled “Returns”Promise<SharedPlanQuery>
signedInSessions
Section titled “signedInSessions”signedInSessions: () =>
Promise<SignedInSessionsQuery>
query SignedInSessions from operations/*.graphql
Returns
Section titled “Returns”Promise<SignedInSessionsQuery>
subscribePush
Section titled “subscribePush”subscribePush: (
variables) =>Promise<SubscribePushMutation>
mutation SubscribePush from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.SubscribePushMutationVariables
Returns
Section titled “Returns”Promise<SubscribePushMutation>
unsubscribePush
Section titled “unsubscribePush”unsubscribePush: (
variables) =>Promise<UnsubscribePushMutation>
mutation UnsubscribePush from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.UnsubscribePushMutationVariables
Returns
Section titled “Returns”Promise<UnsubscribePushMutation>
updateSettings
Section titled “updateSettings”updateSettings: (
variables) =>Promise<UpdateSettingsMutation>
mutation UpdateSettings from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.UpdateSettingsMutationVariables
Returns
Section titled “Returns”Promise<UpdateSettingsMutation>
workout
Section titled “workout”workout: (
variables) =>Promise<WorkoutQuery>
query Workout from operations/*.graphql
Parameters
Section titled “Parameters”variables
Section titled “variables”G.WorkoutQueryVariables
Returns
Section titled “Returns”Promise<WorkoutQuery>
workouts
Section titled “workouts”workouts: (
variables?) =>Promise<WorkoutsQuery>
query Workouts from operations/*.graphql
Parameters
Section titled “Parameters”variables?
Section titled “variables?”Exact<{ from?: string | null; limit?: number | null; offset?: number | null; to?: string | null; }>
Returns
Section titled “Returns”Promise<WorkoutsQuery>