{-# 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.MarketplaceMetering.ResolveCustomer
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- @ResolveCustomer@ is called by a SaaS application during the
-- registration process. When a buyer visits your website during the
-- registration process, the buyer submits a registration token through
-- their browser. The registration token is resolved through this API to
-- obtain a @CustomerIdentifier@ along with the @CustomerAWSAccountId@ and
-- @ProductCode@.
--
-- The API needs to called from the seller account id used to publish the
-- SaaS application to successfully resolve the token.
--
-- For an example of using @ResolveCustomer@, see
-- <https://docs.aws.amazon.com/marketplace/latest/userguide/saas-code-examples.html#saas-resolvecustomer-example ResolveCustomer code example>
-- in the /AWS Marketplace Seller Guide/.
module Amazonka.MarketplaceMetering.ResolveCustomer
( -- * Creating a Request
ResolveCustomer (..),
newResolveCustomer,
-- * Request Lenses
resolveCustomer_registrationToken,
-- * Destructuring the Response
ResolveCustomerResponse (..),
newResolveCustomerResponse,
-- * Response Lenses
resolveCustomerResponse_customerAWSAccountId,
resolveCustomerResponse_customerIdentifier,
resolveCustomerResponse_productCode,
resolveCustomerResponse_httpStatus,
)
where
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.MarketplaceMetering.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
-- | Contains input to the @ResolveCustomer@ operation.
--
-- /See:/ 'newResolveCustomer' smart constructor.
data ResolveCustomer = ResolveCustomer'
{ -- | When a buyer visits your website during the registration process, the
-- buyer submits a registration token through the browser. The registration
-- token is resolved to obtain a @CustomerIdentifier@ along with the
-- @CustomerAWSAccountId@ and @ProductCode@.
registrationToken :: Prelude.Text
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'ResolveCustomer' 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:
--
-- 'registrationToken', 'resolveCustomer_registrationToken' - When a buyer visits your website during the registration process, the
-- buyer submits a registration token through the browser. The registration
-- token is resolved to obtain a @CustomerIdentifier@ along with the
-- @CustomerAWSAccountId@ and @ProductCode@.
newResolveCustomer ::
-- | 'registrationToken'
Prelude.Text ->
ResolveCustomer
newResolveCustomer pRegistrationToken_ =
ResolveCustomer'
{ registrationToken =
pRegistrationToken_
}
-- | When a buyer visits your website during the registration process, the
-- buyer submits a registration token through the browser. The registration
-- token is resolved to obtain a @CustomerIdentifier@ along with the
-- @CustomerAWSAccountId@ and @ProductCode@.
resolveCustomer_registrationToken :: Lens.Lens' ResolveCustomer Prelude.Text
resolveCustomer_registrationToken = Lens.lens (\ResolveCustomer' {registrationToken} -> registrationToken) (\s@ResolveCustomer' {} a -> s {registrationToken = a} :: ResolveCustomer)
instance Core.AWSRequest ResolveCustomer where
type
AWSResponse ResolveCustomer =
ResolveCustomerResponse
request overrides =
Request.postJSON (overrides defaultService)
response =
Response.receiveJSON
( \s h x ->
ResolveCustomerResponse'
Prelude.<$> (x Data..?> "CustomerAWSAccountId")
Prelude.<*> (x Data..?> "CustomerIdentifier")
Prelude.<*> (x Data..?> "ProductCode")
Prelude.<*> (Prelude.pure (Prelude.fromEnum s))
)
instance Prelude.Hashable ResolveCustomer where
hashWithSalt _salt ResolveCustomer' {..} =
_salt `Prelude.hashWithSalt` registrationToken
instance Prelude.NFData ResolveCustomer where
rnf ResolveCustomer' {..} =
Prelude.rnf registrationToken
instance Data.ToHeaders ResolveCustomer where
toHeaders =
Prelude.const
( Prelude.mconcat
[ "X-Amz-Target"
Data.=# ( "AWSMPMeteringService.ResolveCustomer" ::
Prelude.ByteString
),
"Content-Type"
Data.=# ( "application/x-amz-json-1.1" ::
Prelude.ByteString
)
]
)
instance Data.ToJSON ResolveCustomer where
toJSON ResolveCustomer' {..} =
Data.object
( Prelude.catMaybes
[ Prelude.Just
("RegistrationToken" Data..= registrationToken)
]
)
instance Data.ToPath ResolveCustomer where
toPath = Prelude.const "/"
instance Data.ToQuery ResolveCustomer where
toQuery = Prelude.const Prelude.mempty
-- | The result of the @ResolveCustomer@ operation. Contains the
-- @CustomerIdentifier@ along with the @CustomerAWSAccountId@ and
-- @ProductCode@.
--
-- /See:/ 'newResolveCustomerResponse' smart constructor.
data ResolveCustomerResponse = ResolveCustomerResponse'
{ -- | The @CustomerAWSAccountId@ provides the AWS account ID associated with
-- the @CustomerIdentifier@ for the individual customer.
customerAWSAccountId :: Prelude.Maybe Prelude.Text,
-- | The @CustomerIdentifier@ is used to identify an individual customer in
-- your application. Calls to @BatchMeterUsage@ require
-- @CustomerIdentifiers@ for each @UsageRecord@.
customerIdentifier :: Prelude.Maybe Prelude.Text,
-- | The product code is returned to confirm that the buyer is registering
-- for your product. Subsequent @BatchMeterUsage@ calls should be made
-- using this product code.
productCode :: Prelude.Maybe Prelude.Text,
-- | The response's http status code.
httpStatus :: Prelude.Int
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'ResolveCustomerResponse' 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:
--
-- 'customerAWSAccountId', 'resolveCustomerResponse_customerAWSAccountId' - The @CustomerAWSAccountId@ provides the AWS account ID associated with
-- the @CustomerIdentifier@ for the individual customer.
--
-- 'customerIdentifier', 'resolveCustomerResponse_customerIdentifier' - The @CustomerIdentifier@ is used to identify an individual customer in
-- your application. Calls to @BatchMeterUsage@ require
-- @CustomerIdentifiers@ for each @UsageRecord@.
--
-- 'productCode', 'resolveCustomerResponse_productCode' - The product code is returned to confirm that the buyer is registering
-- for your product. Subsequent @BatchMeterUsage@ calls should be made
-- using this product code.
--
-- 'httpStatus', 'resolveCustomerResponse_httpStatus' - The response's http status code.
newResolveCustomerResponse ::
-- | 'httpStatus'
Prelude.Int ->
ResolveCustomerResponse
newResolveCustomerResponse pHttpStatus_ =
ResolveCustomerResponse'
{ customerAWSAccountId =
Prelude.Nothing,
customerIdentifier = Prelude.Nothing,
productCode = Prelude.Nothing,
httpStatus = pHttpStatus_
}
-- | The @CustomerAWSAccountId@ provides the AWS account ID associated with
-- the @CustomerIdentifier@ for the individual customer.
resolveCustomerResponse_customerAWSAccountId :: Lens.Lens' ResolveCustomerResponse (Prelude.Maybe Prelude.Text)
resolveCustomerResponse_customerAWSAccountId = Lens.lens (\ResolveCustomerResponse' {customerAWSAccountId} -> customerAWSAccountId) (\s@ResolveCustomerResponse' {} a -> s {customerAWSAccountId = a} :: ResolveCustomerResponse)
-- | The @CustomerIdentifier@ is used to identify an individual customer in
-- your application. Calls to @BatchMeterUsage@ require
-- @CustomerIdentifiers@ for each @UsageRecord@.
resolveCustomerResponse_customerIdentifier :: Lens.Lens' ResolveCustomerResponse (Prelude.Maybe Prelude.Text)
resolveCustomerResponse_customerIdentifier = Lens.lens (\ResolveCustomerResponse' {customerIdentifier} -> customerIdentifier) (\s@ResolveCustomerResponse' {} a -> s {customerIdentifier = a} :: ResolveCustomerResponse)
-- | The product code is returned to confirm that the buyer is registering
-- for your product. Subsequent @BatchMeterUsage@ calls should be made
-- using this product code.
resolveCustomerResponse_productCode :: Lens.Lens' ResolveCustomerResponse (Prelude.Maybe Prelude.Text)
resolveCustomerResponse_productCode = Lens.lens (\ResolveCustomerResponse' {productCode} -> productCode) (\s@ResolveCustomerResponse' {} a -> s {productCode = a} :: ResolveCustomerResponse)
-- | The response's http status code.
resolveCustomerResponse_httpStatus :: Lens.Lens' ResolveCustomerResponse Prelude.Int
resolveCustomerResponse_httpStatus = Lens.lens (\ResolveCustomerResponse' {httpStatus} -> httpStatus) (\s@ResolveCustomerResponse' {} a -> s {httpStatus = a} :: ResolveCustomerResponse)
instance Prelude.NFData ResolveCustomerResponse where
rnf ResolveCustomerResponse' {..} =
Prelude.rnf customerAWSAccountId
`Prelude.seq` Prelude.rnf customerIdentifier
`Prelude.seq` Prelude.rnf productCode
`Prelude.seq` Prelude.rnf httpStatus