{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Pinpoint.GetCampaignActivities
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Retrieves information about all the activities for a campaign.
module Amazonka.Pinpoint.GetCampaignActivities
  ( -- * Creating a Request
    GetCampaignActivities (..),
    newGetCampaignActivities,

    -- * Request Lenses
    getCampaignActivities_pageSize,
    getCampaignActivities_token,
    getCampaignActivities_applicationId,
    getCampaignActivities_campaignId,

    -- * Destructuring the Response
    GetCampaignActivitiesResponse (..),
    newGetCampaignActivitiesResponse,

    -- * Response Lenses
    getCampaignActivitiesResponse_httpStatus,
    getCampaignActivitiesResponse_activitiesResponse,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Pinpoint.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newGetCampaignActivities' smart constructor.
data GetCampaignActivities = GetCampaignActivities'
  { -- | The maximum number of items to include in each page of a paginated
    -- response. This parameter is not supported for application, campaign, and
    -- journey metrics.
    GetCampaignActivities -> Maybe Text
pageSize :: Prelude.Maybe Prelude.Text,
    -- | The NextToken string that specifies which page of results to return in a
    -- paginated response.
    GetCampaignActivities -> Maybe Text
token :: Prelude.Maybe Prelude.Text,
    -- | The unique identifier for the application. This identifier is displayed
    -- as the __Project ID__ on the Amazon Pinpoint console.
    GetCampaignActivities -> Text
applicationId :: Prelude.Text,
    -- | The unique identifier for the campaign.
    GetCampaignActivities -> Text
campaignId :: Prelude.Text
  }
  deriving (GetCampaignActivities -> GetCampaignActivities -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetCampaignActivities -> GetCampaignActivities -> Bool
$c/= :: GetCampaignActivities -> GetCampaignActivities -> Bool
== :: GetCampaignActivities -> GetCampaignActivities -> Bool
$c== :: GetCampaignActivities -> GetCampaignActivities -> Bool
Prelude.Eq, ReadPrec [GetCampaignActivities]
ReadPrec GetCampaignActivities
Int -> ReadS GetCampaignActivities
ReadS [GetCampaignActivities]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetCampaignActivities]
$creadListPrec :: ReadPrec [GetCampaignActivities]
readPrec :: ReadPrec GetCampaignActivities
$creadPrec :: ReadPrec GetCampaignActivities
readList :: ReadS [GetCampaignActivities]
$creadList :: ReadS [GetCampaignActivities]
readsPrec :: Int -> ReadS GetCampaignActivities
$creadsPrec :: Int -> ReadS GetCampaignActivities
Prelude.Read, Int -> GetCampaignActivities -> ShowS
[GetCampaignActivities] -> ShowS
GetCampaignActivities -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetCampaignActivities] -> ShowS
$cshowList :: [GetCampaignActivities] -> ShowS
show :: GetCampaignActivities -> String
$cshow :: GetCampaignActivities -> String
showsPrec :: Int -> GetCampaignActivities -> ShowS
$cshowsPrec :: Int -> GetCampaignActivities -> ShowS
Prelude.Show, forall x. Rep GetCampaignActivities x -> GetCampaignActivities
forall x. GetCampaignActivities -> Rep GetCampaignActivities x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetCampaignActivities x -> GetCampaignActivities
$cfrom :: forall x. GetCampaignActivities -> Rep GetCampaignActivities x
Prelude.Generic)

-- |
-- Create a value of 'GetCampaignActivities' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'pageSize', 'getCampaignActivities_pageSize' - The maximum number of items to include in each page of a paginated
-- response. This parameter is not supported for application, campaign, and
-- journey metrics.
--
-- 'token', 'getCampaignActivities_token' - The NextToken string that specifies which page of results to return in a
-- paginated response.
--
-- 'applicationId', 'getCampaignActivities_applicationId' - The unique identifier for the application. This identifier is displayed
-- as the __Project ID__ on the Amazon Pinpoint console.
--
-- 'campaignId', 'getCampaignActivities_campaignId' - The unique identifier for the campaign.
newGetCampaignActivities ::
  -- | 'applicationId'
  Prelude.Text ->
  -- | 'campaignId'
  Prelude.Text ->
  GetCampaignActivities
newGetCampaignActivities :: Text -> Text -> GetCampaignActivities
newGetCampaignActivities Text
pApplicationId_ Text
pCampaignId_ =
  GetCampaignActivities'
    { $sel:pageSize:GetCampaignActivities' :: Maybe Text
pageSize = forall a. Maybe a
Prelude.Nothing,
      $sel:token:GetCampaignActivities' :: Maybe Text
token = forall a. Maybe a
Prelude.Nothing,
      $sel:applicationId:GetCampaignActivities' :: Text
applicationId = Text
pApplicationId_,
      $sel:campaignId:GetCampaignActivities' :: Text
campaignId = Text
pCampaignId_
    }

-- | The maximum number of items to include in each page of a paginated
-- response. This parameter is not supported for application, campaign, and
-- journey metrics.
getCampaignActivities_pageSize :: Lens.Lens' GetCampaignActivities (Prelude.Maybe Prelude.Text)
getCampaignActivities_pageSize :: Lens' GetCampaignActivities (Maybe Text)
getCampaignActivities_pageSize = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetCampaignActivities' {Maybe Text
pageSize :: Maybe Text
$sel:pageSize:GetCampaignActivities' :: GetCampaignActivities -> Maybe Text
pageSize} -> Maybe Text
pageSize) (\s :: GetCampaignActivities
s@GetCampaignActivities' {} Maybe Text
a -> GetCampaignActivities
s {$sel:pageSize:GetCampaignActivities' :: Maybe Text
pageSize = Maybe Text
a} :: GetCampaignActivities)

-- | The NextToken string that specifies which page of results to return in a
-- paginated response.
getCampaignActivities_token :: Lens.Lens' GetCampaignActivities (Prelude.Maybe Prelude.Text)
getCampaignActivities_token :: Lens' GetCampaignActivities (Maybe Text)
getCampaignActivities_token = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetCampaignActivities' {Maybe Text
token :: Maybe Text
$sel:token:GetCampaignActivities' :: GetCampaignActivities -> Maybe Text
token} -> Maybe Text
token) (\s :: GetCampaignActivities
s@GetCampaignActivities' {} Maybe Text
a -> GetCampaignActivities
s {$sel:token:GetCampaignActivities' :: Maybe Text
token = Maybe Text
a} :: GetCampaignActivities)

-- | The unique identifier for the application. This identifier is displayed
-- as the __Project ID__ on the Amazon Pinpoint console.
getCampaignActivities_applicationId :: Lens.Lens' GetCampaignActivities Prelude.Text
getCampaignActivities_applicationId :: Lens' GetCampaignActivities Text
getCampaignActivities_applicationId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetCampaignActivities' {Text
applicationId :: Text
$sel:applicationId:GetCampaignActivities' :: GetCampaignActivities -> Text
applicationId} -> Text
applicationId) (\s :: GetCampaignActivities
s@GetCampaignActivities' {} Text
a -> GetCampaignActivities
s {$sel:applicationId:GetCampaignActivities' :: Text
applicationId = Text
a} :: GetCampaignActivities)

-- | The unique identifier for the campaign.
getCampaignActivities_campaignId :: Lens.Lens' GetCampaignActivities Prelude.Text
getCampaignActivities_campaignId :: Lens' GetCampaignActivities Text
getCampaignActivities_campaignId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetCampaignActivities' {Text
campaignId :: Text
$sel:campaignId:GetCampaignActivities' :: GetCampaignActivities -> Text
campaignId} -> Text
campaignId) (\s :: GetCampaignActivities
s@GetCampaignActivities' {} Text
a -> GetCampaignActivities
s {$sel:campaignId:GetCampaignActivities' :: Text
campaignId = Text
a} :: GetCampaignActivities)

instance Core.AWSRequest GetCampaignActivities where
  type
    AWSResponse GetCampaignActivities =
      GetCampaignActivitiesResponse
  request :: (Service -> Service)
-> GetCampaignActivities -> Request GetCampaignActivities
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.get (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy GetCampaignActivities
-> ClientResponse ClientBody
-> m (Either
        Error (ClientResponse (AWSResponse GetCampaignActivities)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Int -> ActivitiesResponse -> GetCampaignActivitiesResponse
GetCampaignActivitiesResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall a. FromJSON a => Object -> Either String a
Data.eitherParseJSON Object
x)
      )

instance Prelude.Hashable GetCampaignActivities where
  hashWithSalt :: Int -> GetCampaignActivities -> Int
hashWithSalt Int
_salt GetCampaignActivities' {Maybe Text
Text
campaignId :: Text
applicationId :: Text
token :: Maybe Text
pageSize :: Maybe Text
$sel:campaignId:GetCampaignActivities' :: GetCampaignActivities -> Text
$sel:applicationId:GetCampaignActivities' :: GetCampaignActivities -> Text
$sel:token:GetCampaignActivities' :: GetCampaignActivities -> Maybe Text
$sel:pageSize:GetCampaignActivities' :: GetCampaignActivities -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
pageSize
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
token
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
applicationId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
campaignId

instance Prelude.NFData GetCampaignActivities where
  rnf :: GetCampaignActivities -> ()
rnf GetCampaignActivities' {Maybe Text
Text
campaignId :: Text
applicationId :: Text
token :: Maybe Text
pageSize :: Maybe Text
$sel:campaignId:GetCampaignActivities' :: GetCampaignActivities -> Text
$sel:applicationId:GetCampaignActivities' :: GetCampaignActivities -> Text
$sel:token:GetCampaignActivities' :: GetCampaignActivities -> Maybe Text
$sel:pageSize:GetCampaignActivities' :: GetCampaignActivities -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
pageSize
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
token
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
applicationId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
campaignId

instance Data.ToHeaders GetCampaignActivities where
  toHeaders :: GetCampaignActivities -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToPath GetCampaignActivities where
  toPath :: GetCampaignActivities -> ByteString
toPath GetCampaignActivities' {Maybe Text
Text
campaignId :: Text
applicationId :: Text
token :: Maybe Text
pageSize :: Maybe Text
$sel:campaignId:GetCampaignActivities' :: GetCampaignActivities -> Text
$sel:applicationId:GetCampaignActivities' :: GetCampaignActivities -> Text
$sel:token:GetCampaignActivities' :: GetCampaignActivities -> Maybe Text
$sel:pageSize:GetCampaignActivities' :: GetCampaignActivities -> Maybe Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"/v1/apps/",
        forall a. ToByteString a => a -> ByteString
Data.toBS Text
applicationId,
        ByteString
"/campaigns/",
        forall a. ToByteString a => a -> ByteString
Data.toBS Text
campaignId,
        ByteString
"/activities"
      ]

instance Data.ToQuery GetCampaignActivities where
  toQuery :: GetCampaignActivities -> QueryString
toQuery GetCampaignActivities' {Maybe Text
Text
campaignId :: Text
applicationId :: Text
token :: Maybe Text
pageSize :: Maybe Text
$sel:campaignId:GetCampaignActivities' :: GetCampaignActivities -> Text
$sel:applicationId:GetCampaignActivities' :: GetCampaignActivities -> Text
$sel:token:GetCampaignActivities' :: GetCampaignActivities -> Maybe Text
$sel:pageSize:GetCampaignActivities' :: GetCampaignActivities -> Maybe Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ByteString
"page-size" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
pageSize, ByteString
"token" forall a. ToQuery a => ByteString -> a -> QueryString
Data.=: Maybe Text
token]

-- | /See:/ 'newGetCampaignActivitiesResponse' smart constructor.
data GetCampaignActivitiesResponse = GetCampaignActivitiesResponse'
  { -- | The response's http status code.
    GetCampaignActivitiesResponse -> Int
httpStatus :: Prelude.Int,
    GetCampaignActivitiesResponse -> ActivitiesResponse
activitiesResponse :: ActivitiesResponse
  }
  deriving (GetCampaignActivitiesResponse
-> GetCampaignActivitiesResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetCampaignActivitiesResponse
-> GetCampaignActivitiesResponse -> Bool
$c/= :: GetCampaignActivitiesResponse
-> GetCampaignActivitiesResponse -> Bool
== :: GetCampaignActivitiesResponse
-> GetCampaignActivitiesResponse -> Bool
$c== :: GetCampaignActivitiesResponse
-> GetCampaignActivitiesResponse -> Bool
Prelude.Eq, ReadPrec [GetCampaignActivitiesResponse]
ReadPrec GetCampaignActivitiesResponse
Int -> ReadS GetCampaignActivitiesResponse
ReadS [GetCampaignActivitiesResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetCampaignActivitiesResponse]
$creadListPrec :: ReadPrec [GetCampaignActivitiesResponse]
readPrec :: ReadPrec GetCampaignActivitiesResponse
$creadPrec :: ReadPrec GetCampaignActivitiesResponse
readList :: ReadS [GetCampaignActivitiesResponse]
$creadList :: ReadS [GetCampaignActivitiesResponse]
readsPrec :: Int -> ReadS GetCampaignActivitiesResponse
$creadsPrec :: Int -> ReadS GetCampaignActivitiesResponse
Prelude.Read, Int -> GetCampaignActivitiesResponse -> ShowS
[GetCampaignActivitiesResponse] -> ShowS
GetCampaignActivitiesResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetCampaignActivitiesResponse] -> ShowS
$cshowList :: [GetCampaignActivitiesResponse] -> ShowS
show :: GetCampaignActivitiesResponse -> String
$cshow :: GetCampaignActivitiesResponse -> String
showsPrec :: Int -> GetCampaignActivitiesResponse -> ShowS
$cshowsPrec :: Int -> GetCampaignActivitiesResponse -> ShowS
Prelude.Show, forall x.
Rep GetCampaignActivitiesResponse x
-> GetCampaignActivitiesResponse
forall x.
GetCampaignActivitiesResponse
-> Rep GetCampaignActivitiesResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep GetCampaignActivitiesResponse x
-> GetCampaignActivitiesResponse
$cfrom :: forall x.
GetCampaignActivitiesResponse
-> Rep GetCampaignActivitiesResponse x
Prelude.Generic)

-- |
-- Create a value of 'GetCampaignActivitiesResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'httpStatus', 'getCampaignActivitiesResponse_httpStatus' - The response's http status code.
--
-- 'activitiesResponse', 'getCampaignActivitiesResponse_activitiesResponse' - Undocumented member.
newGetCampaignActivitiesResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  -- | 'activitiesResponse'
  ActivitiesResponse ->
  GetCampaignActivitiesResponse
newGetCampaignActivitiesResponse :: Int -> ActivitiesResponse -> GetCampaignActivitiesResponse
newGetCampaignActivitiesResponse
  Int
pHttpStatus_
  ActivitiesResponse
pActivitiesResponse_ =
    GetCampaignActivitiesResponse'
      { $sel:httpStatus:GetCampaignActivitiesResponse' :: Int
httpStatus =
          Int
pHttpStatus_,
        $sel:activitiesResponse:GetCampaignActivitiesResponse' :: ActivitiesResponse
activitiesResponse = ActivitiesResponse
pActivitiesResponse_
      }

-- | The response's http status code.
getCampaignActivitiesResponse_httpStatus :: Lens.Lens' GetCampaignActivitiesResponse Prelude.Int
getCampaignActivitiesResponse_httpStatus :: Lens' GetCampaignActivitiesResponse Int
getCampaignActivitiesResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetCampaignActivitiesResponse' {Int
httpStatus :: Int
$sel:httpStatus:GetCampaignActivitiesResponse' :: GetCampaignActivitiesResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: GetCampaignActivitiesResponse
s@GetCampaignActivitiesResponse' {} Int
a -> GetCampaignActivitiesResponse
s {$sel:httpStatus:GetCampaignActivitiesResponse' :: Int
httpStatus = Int
a} :: GetCampaignActivitiesResponse)

-- | Undocumented member.
getCampaignActivitiesResponse_activitiesResponse :: Lens.Lens' GetCampaignActivitiesResponse ActivitiesResponse
getCampaignActivitiesResponse_activitiesResponse :: Lens' GetCampaignActivitiesResponse ActivitiesResponse
getCampaignActivitiesResponse_activitiesResponse = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetCampaignActivitiesResponse' {ActivitiesResponse
activitiesResponse :: ActivitiesResponse
$sel:activitiesResponse:GetCampaignActivitiesResponse' :: GetCampaignActivitiesResponse -> ActivitiesResponse
activitiesResponse} -> ActivitiesResponse
activitiesResponse) (\s :: GetCampaignActivitiesResponse
s@GetCampaignActivitiesResponse' {} ActivitiesResponse
a -> GetCampaignActivitiesResponse
s {$sel:activitiesResponse:GetCampaignActivitiesResponse' :: ActivitiesResponse
activitiesResponse = ActivitiesResponse
a} :: GetCampaignActivitiesResponse)

instance Prelude.NFData GetCampaignActivitiesResponse where
  rnf :: GetCampaignActivitiesResponse -> ()
rnf GetCampaignActivitiesResponse' {Int
ActivitiesResponse
activitiesResponse :: ActivitiesResponse
httpStatus :: Int
$sel:activitiesResponse:GetCampaignActivitiesResponse' :: GetCampaignActivitiesResponse -> ActivitiesResponse
$sel:httpStatus:GetCampaignActivitiesResponse' :: GetCampaignActivitiesResponse -> Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf ActivitiesResponse
activitiesResponse