Update.hs

{-# LANGUAGE DataKinds #-}
{-# LANGUAGE DerivingStrategies #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE ImportQualifiedPost #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE PatternSynonyms #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-duplicate-exports #-}
{-# OPTIONS_GHC -fno-warn-name-shadowing #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- |
-- Module      : Gogol.AppsCalendar.Calendar.Events.Update
-- Copyright   : (c) 2015-2025 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+gogol@gmail.com>
--               Toni Cebrián <toni@tonicebrian.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Updates an event.
--
-- /See:/ <https://developers.google.com/google-apps/calendar/firstapp Calendar API Reference> for @calendar.events.update@.
module Gogol.AppsCalendar.Calendar.Events.Update
  ( -- * Resource
    CalendarEventsUpdateResource,

    -- ** Constructing a Request
    CalendarEventsUpdate (..),
    newCalendarEventsUpdate,
  )
where

import Gogol.AppsCalendar.Types
import Gogol.Prelude qualified as Core

-- | A resource alias for @calendar.events.update@ method which the
-- 'CalendarEventsUpdate' request conforms to.
type CalendarEventsUpdateResource =
  "calendar"
    Core.:> "v3"
    Core.:> "calendars"
    Core.:> Core.Capture "calendarId" Core.Text
    Core.:> "events"
    Core.:> Core.Capture "eventId" Core.Text
    Core.:> Core.QueryParam "alwaysIncludeEmail" Core.Bool
    Core.:> Core.QueryParam "conferenceDataVersion" Core.Int32
    Core.:> Core.QueryParam "maxAttendees" Core.Int32
    Core.:> Core.QueryParam "sendNotifications" Core.Bool
    Core.:> Core.QueryParam "sendUpdates" EventsUpdateSendUpdates
    Core.:> Core.QueryParam "supportsAttachments" Core.Bool
    Core.:> Core.QueryParam "alt" Core.AltJSON
    Core.:> Core.ReqBody '[Core.JSON] Event
    Core.:> Core.Put '[Core.JSON] Event

-- | Updates an event.
--
-- /See:/ 'newCalendarEventsUpdate' smart constructor.
data CalendarEventsUpdate = CalendarEventsUpdate
  { -- | Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
    alwaysIncludeEmail :: (Core.Maybe Core.Bool),
    -- | Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword.
    calendarId :: Core.Text,
    -- | Version number of conference data supported by the API client. Version 0 assumes no conference data support and ignores conference data in the event\'s body. Version 1 enables support for copying of ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0.
    conferenceDataVersion :: (Core.Maybe Core.Int32),
    -- | Event identifier.
    eventId :: Core.Text,
    -- | The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.
    maxAttendees :: (Core.Maybe Core.Int32),
    -- | Multipart request metadata.
    payload :: Event,
    -- | Deprecated. Please use sendUpdates instead.
    --
    -- Whether to send notifications about the event update (for example, description changes, etc.). Note that some emails might still be sent even if you set the value to false. The default is false.
    sendNotifications :: (Core.Maybe Core.Bool),
    -- | Guests who should receive notifications about the event update (for example, title changes, etc.).
    sendUpdates :: (Core.Maybe EventsUpdateSendUpdates),
    -- | Whether API client performing operation supports event attachments. Optional. The default is False.
    supportsAttachments :: (Core.Maybe Core.Bool)
  }
  deriving (Core.Eq, Core.Show, Core.Generic)

-- | Creates a value of 'CalendarEventsUpdate' with the minimum fields required to make a request.
newCalendarEventsUpdate ::
  -- |  Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the \"primary\" keyword. See 'calendarId'.
  Core.Text ->
  -- |  Event identifier. See 'eventId'.
  Core.Text ->
  -- |  Multipart request metadata. See 'payload'.
  Event ->
  CalendarEventsUpdate
newCalendarEventsUpdate calendarId eventId payload =
  CalendarEventsUpdate
    { alwaysIncludeEmail = Core.Nothing,
      calendarId = calendarId,
      conferenceDataVersion = Core.Nothing,
      eventId = eventId,
      maxAttendees = Core.Nothing,
      payload = payload,
      sendNotifications = Core.Nothing,
      sendUpdates = Core.Nothing,
      supportsAttachments = Core.Nothing
    }

instance Core.GoogleRequest CalendarEventsUpdate where
  type Rs CalendarEventsUpdate = Event
  type
    Scopes CalendarEventsUpdate =
      '[ Calendar'FullControl,
         Calendar'App'Created,
         Calendar'Events,
         Calendar'Events'Owned
       ]
  requestClient CalendarEventsUpdate {..} =
    go
      calendarId
      eventId
      alwaysIncludeEmail
      conferenceDataVersion
      maxAttendees
      sendNotifications
      sendUpdates
      supportsAttachments
      (Core.Just Core.AltJSON)
      payload
      appsCalendarService
    where
      go =
        Core.buildClient
          (Core.Proxy :: Core.Proxy CalendarEventsUpdateResource)
          Core.mempty