gogol-apps-reseller-0.4.0: Google Enterprise Apps Reseller SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.AppsReseller.Types

Contents

Description

 
Synopsis

Service Configuration

appsResellerService :: ServiceConfig Source #

Default request referring to version v1 of the Enterprise Apps Reseller API. This contains the host and root path used as a starting point for constructing service requests.

OAuth Scopes

appsOrderReadOnlyScope :: Proxy '["https://www.googleapis.com/auth/apps.order.readonly"] Source #

Manage users on your domain

appsOrderScope :: Proxy '["https://www.googleapis.com/auth/apps.order"] Source #

Manage users on your domain

SubscriptionTrialSettings

data SubscriptionTrialSettings Source #

The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.

See: subscriptionTrialSettings smart constructor.

Instances
Eq SubscriptionTrialSettings Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Data SubscriptionTrialSettings Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SubscriptionTrialSettings -> c SubscriptionTrialSettings #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SubscriptionTrialSettings #

toConstr :: SubscriptionTrialSettings -> Constr #

dataTypeOf :: SubscriptionTrialSettings -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SubscriptionTrialSettings) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SubscriptionTrialSettings) #

gmapT :: (forall b. Data b => b -> b) -> SubscriptionTrialSettings -> SubscriptionTrialSettings #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SubscriptionTrialSettings -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SubscriptionTrialSettings -> r #

gmapQ :: (forall d. Data d => d -> u) -> SubscriptionTrialSettings -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SubscriptionTrialSettings -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SubscriptionTrialSettings -> m SubscriptionTrialSettings #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SubscriptionTrialSettings -> m SubscriptionTrialSettings #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SubscriptionTrialSettings -> m SubscriptionTrialSettings #

Show SubscriptionTrialSettings Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Generic SubscriptionTrialSettings Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Associated Types

type Rep SubscriptionTrialSettings :: Type -> Type #

ToJSON SubscriptionTrialSettings Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

FromJSON SubscriptionTrialSettings Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep SubscriptionTrialSettings Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep SubscriptionTrialSettings = D1 (MetaData "SubscriptionTrialSettings" "Network.Google.AppsReseller.Types.Product" "gogol-apps-reseller-0.4.0-KDuipGWXeWG9naMHX80l3C" False) (C1 (MetaCons "SubscriptionTrialSettings'" PrefixI True) (S1 (MetaSel (Just "_stsIsInTrial") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_stsTrialEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))))

subscriptionTrialSettings :: SubscriptionTrialSettings Source #

Creates a value of SubscriptionTrialSettings with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

stsIsInTrial :: Lens' SubscriptionTrialSettings (Maybe Bool) Source #

Determines if a subscription's plan is in a 30-day free trial or not: - true — The plan is in trial. - false — The plan is not in trial.

stsTrialEndTime :: Lens' SubscriptionTrialSettings (Maybe Int64) Source #

Date when the trial ends. The value is in milliseconds using the UNIX Epoch format. See an example Epoch converter.

ResellernotifyResource

data ResellernotifyResource Source #

JSON template for resellernotify response.

See: resellernotifyResource smart constructor.

Instances
Eq ResellernotifyResource Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Data ResellernotifyResource Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ResellernotifyResource -> c ResellernotifyResource #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ResellernotifyResource #

toConstr :: ResellernotifyResource -> Constr #

dataTypeOf :: ResellernotifyResource -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ResellernotifyResource) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ResellernotifyResource) #

gmapT :: (forall b. Data b => b -> b) -> ResellernotifyResource -> ResellernotifyResource #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ResellernotifyResource -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ResellernotifyResource -> r #

gmapQ :: (forall d. Data d => d -> u) -> ResellernotifyResource -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ResellernotifyResource -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ResellernotifyResource -> m ResellernotifyResource #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ResellernotifyResource -> m ResellernotifyResource #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ResellernotifyResource -> m ResellernotifyResource #

Show ResellernotifyResource Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Generic ResellernotifyResource Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Associated Types

type Rep ResellernotifyResource :: Type -> Type #

ToJSON ResellernotifyResource Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

FromJSON ResellernotifyResource Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep ResellernotifyResource Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep ResellernotifyResource = D1 (MetaData "ResellernotifyResource" "Network.Google.AppsReseller.Types.Product" "gogol-apps-reseller-0.4.0-KDuipGWXeWG9naMHX80l3C" True) (C1 (MetaCons "ResellernotifyResource'" PrefixI True) (S1 (MetaSel (Just "_rrTopicName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Text))))

resellernotifyResource :: ResellernotifyResource Source #

Creates a value of ResellernotifyResource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ResellernotifyGetwatchdetailsResponse

data ResellernotifyGetwatchdetailsResponse Source #

JSON template for resellernotify getwatchdetails response.

See: resellernotifyGetwatchdetailsResponse smart constructor.

Instances
Eq ResellernotifyGetwatchdetailsResponse Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Data ResellernotifyGetwatchdetailsResponse Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ResellernotifyGetwatchdetailsResponse -> c ResellernotifyGetwatchdetailsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ResellernotifyGetwatchdetailsResponse #

toConstr :: ResellernotifyGetwatchdetailsResponse -> Constr #

dataTypeOf :: ResellernotifyGetwatchdetailsResponse -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ResellernotifyGetwatchdetailsResponse) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ResellernotifyGetwatchdetailsResponse) #

gmapT :: (forall b. Data b => b -> b) -> ResellernotifyGetwatchdetailsResponse -> ResellernotifyGetwatchdetailsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ResellernotifyGetwatchdetailsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ResellernotifyGetwatchdetailsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ResellernotifyGetwatchdetailsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ResellernotifyGetwatchdetailsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ResellernotifyGetwatchdetailsResponse -> m ResellernotifyGetwatchdetailsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ResellernotifyGetwatchdetailsResponse -> m ResellernotifyGetwatchdetailsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ResellernotifyGetwatchdetailsResponse -> m ResellernotifyGetwatchdetailsResponse #

Show ResellernotifyGetwatchdetailsResponse Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Generic ResellernotifyGetwatchdetailsResponse Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

ToJSON ResellernotifyGetwatchdetailsResponse Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

FromJSON ResellernotifyGetwatchdetailsResponse Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep ResellernotifyGetwatchdetailsResponse Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep ResellernotifyGetwatchdetailsResponse = D1 (MetaData "ResellernotifyGetwatchdetailsResponse" "Network.Google.AppsReseller.Types.Product" "gogol-apps-reseller-0.4.0-KDuipGWXeWG9naMHX80l3C" False) (C1 (MetaCons "ResellernotifyGetwatchdetailsResponse'" PrefixI True) (S1 (MetaSel (Just "_rgrTopicName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_rgrServiceAccountEmailAddresses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))

resellernotifyGetwatchdetailsResponse :: ResellernotifyGetwatchdetailsResponse Source #

Creates a value of ResellernotifyGetwatchdetailsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Address

data Address Source #

JSON template for address of a customer.

See: address smart constructor.

Instances
Eq Address Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Methods

(==) :: Address -> Address -> Bool #

(/=) :: Address -> Address -> Bool #

Data Address Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Address -> c Address #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Address #

toConstr :: Address -> Constr #

dataTypeOf :: Address -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Address) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Address) #

gmapT :: (forall b. Data b => b -> b) -> Address -> Address #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Address -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Address -> r #

gmapQ :: (forall d. Data d => d -> u) -> Address -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Address -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Address -> m Address #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Address -> m Address #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Address -> m Address #

Show Address Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Generic Address Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Associated Types

type Rep Address :: Type -> Type #

Methods

from :: Address -> Rep Address x #

to :: Rep Address x -> Address #

ToJSON Address Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

FromJSON Address Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep Address Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

address :: Address Source #

Creates a value of Address with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aOrganizationName :: Lens' Address (Maybe Text) Source #

The company or company division name. This is required.

aKind :: Lens' Address Text Source #

Identifies the resource as a customer address. Value: customers#address

aPostalCode :: Lens' Address (Maybe Text) Source #

A postalCode example is a postal zip code such as 94043. This property is required when creating a new customer.

aAddressLine1 :: Lens' Address (Maybe Text) Source #

A customer's physical address. An address can be composed of one to three lines. The addressline2 and addressLine3 are optional.

aLocality :: Lens' Address (Maybe Text) Source #

An example of a locality value is the city of San Francisco.

aContactName :: Lens' Address (Maybe Text) Source #

The customer contact's name. This is required.

aAddressLine2 :: Lens' Address (Maybe Text) Source #

Line 2 of the address.

aCountryCode :: Lens' Address (Maybe Text) Source #

For countryCode information, see the ISO 3166 country code elements. Verify that country is approved for resale of Google products. This property is required when creating a new customer.

aRegion :: Lens' Address (Maybe Text) Source #

An example of a region value is CA for the state of California.

aAddressLine3 :: Lens' Address (Maybe Text) Source #

Line 3 of the address.

Customer

data Customer Source #

JSON template for a customer.

See: customer smart constructor.

Instances
Eq Customer Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Data Customer Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Customer -> c Customer #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Customer #

toConstr :: Customer -> Constr #

dataTypeOf :: Customer -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Customer) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Customer) #

gmapT :: (forall b. Data b => b -> b) -> Customer -> Customer #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Customer -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Customer -> r #

gmapQ :: (forall d. Data d => d -> u) -> Customer -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Customer -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Customer -> m Customer #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Customer -> m Customer #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Customer -> m Customer #

Show Customer Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Generic Customer Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Associated Types

type Rep Customer :: Type -> Type #

Methods

from :: Customer -> Rep Customer x #

to :: Rep Customer x -> Customer #

ToJSON Customer Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

FromJSON Customer Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep Customer Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep Customer = D1 (MetaData "Customer" "Network.Google.AppsReseller.Types.Product" "gogol-apps-reseller-0.4.0-KDuipGWXeWG9naMHX80l3C" False) (C1 (MetaCons "Customer'" PrefixI True) (((S1 (MetaSel (Just "_cCustomerDomainVerified") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_cResourceUiURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_cKind") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cCustomerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_cAlternateEmail") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cCustomerDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_cPhoneNumber") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cPostalAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Address))))))

customer :: Customer Source #

Creates a value of Customer with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cCustomerDomainVerified :: Lens' Customer (Maybe Bool) Source #

Whether the customer's primary domain has been verified.

cResourceUiURL :: Lens' Customer (Maybe Text) Source #

URL to customer's Admin console dashboard. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task in the Admin console.

cKind :: Lens' Customer Text Source #

Identifies the resource as a customer. Value: reseller#customer

cCustomerId :: Lens' Customer (Maybe Text) Source #

This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.

cAlternateEmail :: Lens' Customer (Maybe Text) Source #

Like the "Customer email" in the reseller tools, this email is the secondary contact used if something happens to the customer's service such as service outage or a security issue. This property is required when creating a new customer and should not use the same domain as customerDomain.

cCustomerDomain :: Lens' Customer (Maybe Text) Source #

The customer's primary domain name string. customerDomain is required when creating a new customer. Do not include the www prefix in the domain when adding a customer.

cPhoneNumber :: Lens' Customer (Maybe Text) Source #

Customer contact phone number. This can be continuous numbers, with spaces, etc. But it must be a real phone number and not, for example, "123". See phone local format conventions.

cPostalAddress :: Lens' Customer (Maybe Address) Source #

A customer's address information. Each field has a limit of 255 charcters.

ChangePlanRequest

data ChangePlanRequest Source #

JSON template for the ChangePlan rpc request.

See: changePlanRequest smart constructor.

Instances
Eq ChangePlanRequest Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Data ChangePlanRequest Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ChangePlanRequest -> c ChangePlanRequest #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ChangePlanRequest #

toConstr :: ChangePlanRequest -> Constr #

dataTypeOf :: ChangePlanRequest -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ChangePlanRequest) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ChangePlanRequest) #

gmapT :: (forall b. Data b => b -> b) -> ChangePlanRequest -> ChangePlanRequest #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ChangePlanRequest -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ChangePlanRequest -> r #

gmapQ :: (forall d. Data d => d -> u) -> ChangePlanRequest -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ChangePlanRequest -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ChangePlanRequest -> m ChangePlanRequest #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ChangePlanRequest -> m ChangePlanRequest #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ChangePlanRequest -> m ChangePlanRequest #

Show ChangePlanRequest Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Generic ChangePlanRequest Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Associated Types

type Rep ChangePlanRequest :: Type -> Type #

ToJSON ChangePlanRequest Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

FromJSON ChangePlanRequest Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep ChangePlanRequest Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep ChangePlanRequest = D1 (MetaData "ChangePlanRequest" "Network.Google.AppsReseller.Types.Product" "gogol-apps-reseller-0.4.0-KDuipGWXeWG9naMHX80l3C" False) (C1 (MetaCons "ChangePlanRequest'" PrefixI True) ((S1 (MetaSel (Just "_cprKind") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_cprDealCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_cprPlanName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_cprPurchaseOrderId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_cprSeats") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Seats))))))

changePlanRequest :: ChangePlanRequest Source #

Creates a value of ChangePlanRequest with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cprKind :: Lens' ChangePlanRequest Text Source #

Identifies the resource as a subscription change plan request. Value: subscriptions#changePlanRequest

cprDealCode :: Lens' ChangePlanRequest (Maybe Text) Source #

Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in changePlan request in order to receive discounted rate. This property is optional. If a deal code has already been added to a subscription, this property may be left empty and the existing discounted rate will still apply (if not empty, only provide the deal code that is already present on the subscription). If a deal code has never been added to a subscription and this property is left blank, regular pricing will apply.

cprPlanName :: Lens' ChangePlanRequest (Maybe Text) Source #

The planName property is required. This is the name of the subscription's payment plan. For more information about the Google payment plans, see API concepts. Possible values are: - ANNUAL_MONTHLY_PAY - The annual commitment plan with monthly payments - ANNUAL_YEARLY_PAY - The annual commitment plan with yearly payments - FLEXIBLE - The flexible plan - TRIAL - The 30-day free trial plan

cprPurchaseOrderId :: Lens' ChangePlanRequest (Maybe Text) Source #

This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.

cprSeats :: Lens' ChangePlanRequest (Maybe Seats) Source #

This is a required property. The seats property is the number of user seat licenses.

SubscriptionPlanCommitmentInterval

data SubscriptionPlanCommitmentInterval Source #

In this version of the API, annual commitment plan's interval is one year.

See: subscriptionPlanCommitmentInterval smart constructor.

Instances
Eq SubscriptionPlanCommitmentInterval Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Data SubscriptionPlanCommitmentInterval Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SubscriptionPlanCommitmentInterval -> c SubscriptionPlanCommitmentInterval #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SubscriptionPlanCommitmentInterval #

toConstr :: SubscriptionPlanCommitmentInterval -> Constr #

dataTypeOf :: SubscriptionPlanCommitmentInterval -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SubscriptionPlanCommitmentInterval) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SubscriptionPlanCommitmentInterval) #

gmapT :: (forall b. Data b => b -> b) -> SubscriptionPlanCommitmentInterval -> SubscriptionPlanCommitmentInterval #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SubscriptionPlanCommitmentInterval -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SubscriptionPlanCommitmentInterval -> r #

gmapQ :: (forall d. Data d => d -> u) -> SubscriptionPlanCommitmentInterval -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SubscriptionPlanCommitmentInterval -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SubscriptionPlanCommitmentInterval -> m SubscriptionPlanCommitmentInterval #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SubscriptionPlanCommitmentInterval -> m SubscriptionPlanCommitmentInterval #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SubscriptionPlanCommitmentInterval -> m SubscriptionPlanCommitmentInterval #

Show SubscriptionPlanCommitmentInterval Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Generic SubscriptionPlanCommitmentInterval Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Associated Types

type Rep SubscriptionPlanCommitmentInterval :: Type -> Type #

ToJSON SubscriptionPlanCommitmentInterval Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

FromJSON SubscriptionPlanCommitmentInterval Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep SubscriptionPlanCommitmentInterval Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep SubscriptionPlanCommitmentInterval = D1 (MetaData "SubscriptionPlanCommitmentInterval" "Network.Google.AppsReseller.Types.Product" "gogol-apps-reseller-0.4.0-KDuipGWXeWG9naMHX80l3C" False) (C1 (MetaCons "SubscriptionPlanCommitmentInterval'" PrefixI True) (S1 (MetaSel (Just "_spciStartTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :*: S1 (MetaSel (Just "_spciEndTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64)))))

subscriptionPlanCommitmentInterval :: SubscriptionPlanCommitmentInterval Source #

Creates a value of SubscriptionPlanCommitmentInterval with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

spciStartTime :: Lens' SubscriptionPlanCommitmentInterval (Maybe Int64) Source #

An annual commitment plan's interval's startTime in milliseconds using UNIX Epoch format. See an example Epoch converter.

spciEndTime :: Lens' SubscriptionPlanCommitmentInterval (Maybe Int64) Source #

An annual commitment plan's interval's endTime in milliseconds using the UNIX Epoch format. See an example Epoch converter.

SubscriptionsDeleteDeletionType

data SubscriptionsDeleteDeletionType Source #

The deletionType query string enables the cancellation, downgrade, or suspension of a subscription.

Constructors

Cancel

cancel Cancels the subscription immediately. This does not apply to a G Suite subscription.

Downgrade

downgrade Downgrades a G Suite subscription to a Google Apps Free edition subscription only if the customer was initially subscribed to a Google Apps Free edition (also known as the Standard edition). Once downgraded, the customer no longer has access to the previous G Suite subscription and is no longer managed by the reseller. A G Suite subscription's downgrade cannot be invoked if an active or suspended Google Drive or Google Vault subscription is present. The Google Drive or Google Vault subscription must be cancelled before the G Suite subscription's downgrade is invoked. The downgrade deletionType does not apply to other products or G Suite SKUs.

Suspend

suspend (DEPRECATED) The G Suite account is suspended for four days and then cancelled. Once suspended, an administrator has access to the suspended account, but the account users can not access their services. A suspension can be lifted, using the reseller tools. A G Suite subscription's suspension can not be invoked if an active or suspended Google Drive or Google Vault subscription is present. The Google Drive or Google Vault subscription must be cancelled before the G Suite subscription's suspension is invoked.

TransferToDirect

transfer_to_direct Transfers a subscription directly to Google.  The customer is immediately transferred to a direct billing relationship with Google and is given a short amount of time with no service interruption. The customer can then choose to set up billing directly with Google by using a credit card, or they can transfer to another reseller.

Instances
Enum SubscriptionsDeleteDeletionType Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Sum

Eq SubscriptionsDeleteDeletionType Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Sum

Data SubscriptionsDeleteDeletionType Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Sum

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SubscriptionsDeleteDeletionType -> c SubscriptionsDeleteDeletionType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SubscriptionsDeleteDeletionType #

toConstr :: SubscriptionsDeleteDeletionType -> Constr #

dataTypeOf :: SubscriptionsDeleteDeletionType -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SubscriptionsDeleteDeletionType) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SubscriptionsDeleteDeletionType) #

gmapT :: (forall b. Data b => b -> b) -> SubscriptionsDeleteDeletionType -> SubscriptionsDeleteDeletionType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SubscriptionsDeleteDeletionType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SubscriptionsDeleteDeletionType -> r #

gmapQ :: (forall d. Data d => d -> u) -> SubscriptionsDeleteDeletionType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SubscriptionsDeleteDeletionType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SubscriptionsDeleteDeletionType -> m SubscriptionsDeleteDeletionType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SubscriptionsDeleteDeletionType -> m SubscriptionsDeleteDeletionType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SubscriptionsDeleteDeletionType -> m SubscriptionsDeleteDeletionType #

Ord SubscriptionsDeleteDeletionType Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Sum

Read SubscriptionsDeleteDeletionType Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Sum

Show SubscriptionsDeleteDeletionType Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Sum

Generic SubscriptionsDeleteDeletionType Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Sum

Associated Types

type Rep SubscriptionsDeleteDeletionType :: Type -> Type #

Hashable SubscriptionsDeleteDeletionType Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Sum

ToJSON SubscriptionsDeleteDeletionType Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Sum

FromJSON SubscriptionsDeleteDeletionType Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Sum

FromHttpApiData SubscriptionsDeleteDeletionType Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Sum

ToHttpApiData SubscriptionsDeleteDeletionType Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Sum

type Rep SubscriptionsDeleteDeletionType Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Sum

type Rep SubscriptionsDeleteDeletionType = D1 (MetaData "SubscriptionsDeleteDeletionType" "Network.Google.AppsReseller.Types.Sum" "gogol-apps-reseller-0.4.0-KDuipGWXeWG9naMHX80l3C" False) ((C1 (MetaCons "Cancel" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Downgrade" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Suspend" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "TransferToDirect" PrefixI False) (U1 :: Type -> Type)))

SubscriptionPlan

data SubscriptionPlan Source #

The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API"s payment plans, see the API concepts.

See: subscriptionPlan smart constructor.

Instances
Eq SubscriptionPlan Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Data SubscriptionPlan Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SubscriptionPlan -> c SubscriptionPlan #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SubscriptionPlan #

toConstr :: SubscriptionPlan -> Constr #

dataTypeOf :: SubscriptionPlan -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SubscriptionPlan) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SubscriptionPlan) #

gmapT :: (forall b. Data b => b -> b) -> SubscriptionPlan -> SubscriptionPlan #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SubscriptionPlan -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SubscriptionPlan -> r #

gmapQ :: (forall d. Data d => d -> u) -> SubscriptionPlan -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SubscriptionPlan -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SubscriptionPlan -> m SubscriptionPlan #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SubscriptionPlan -> m SubscriptionPlan #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SubscriptionPlan -> m SubscriptionPlan #

Show SubscriptionPlan Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Generic SubscriptionPlan Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Associated Types

type Rep SubscriptionPlan :: Type -> Type #

ToJSON SubscriptionPlan Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

FromJSON SubscriptionPlan Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep SubscriptionPlan Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep SubscriptionPlan = D1 (MetaData "SubscriptionPlan" "Network.Google.AppsReseller.Types.Product" "gogol-apps-reseller-0.4.0-KDuipGWXeWG9naMHX80l3C" False) (C1 (MetaCons "SubscriptionPlan'" PrefixI True) (S1 (MetaSel (Just "_spCommitmentInterval") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SubscriptionPlanCommitmentInterval)) :*: (S1 (MetaSel (Just "_spIsCommitmentPlan") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_spPlanName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))

subscriptionPlan :: SubscriptionPlan Source #

Creates a value of SubscriptionPlan with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

spCommitmentInterval :: Lens' SubscriptionPlan (Maybe SubscriptionPlanCommitmentInterval) Source #

In this version of the API, annual commitment plan's interval is one year.

spIsCommitmentPlan :: Lens' SubscriptionPlan (Maybe Bool) Source #

The isCommitmentPlan property's boolean value identifies the plan as an annual commitment plan: - true — The subscription's plan is an annual commitment plan. - false — The plan is not an annual commitment plan.

spPlanName :: Lens' SubscriptionPlan (Maybe Text) Source #

The planName property is required. This is the name of the subscription's plan. For more information about the Google payment plans, see the API concepts. Possible values are: - ANNUAL_MONTHLY_PAY — The annual commitment plan with monthly payments - ANNUAL_YEARLY_PAY — The annual commitment plan with yearly payments - FLEXIBLE — The flexible plan - TRIAL — The 30-day free trial plan. A subscription in trial will be suspended after the 30th free day if no payment plan is assigned. Calling changePlan will assign a payment plan to a trial but will not activate the plan. A trial will automatically begin its assigned payment plan after its 30th free day or immediately after calling startPaidService.

Subscriptions

data Subscriptions Source #

JSON template for a subscription list.

See: subscriptions smart constructor.

Instances
Eq Subscriptions Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Data Subscriptions Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Subscriptions -> c Subscriptions #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Subscriptions #

toConstr :: Subscriptions -> Constr #

dataTypeOf :: Subscriptions -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Subscriptions) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Subscriptions) #

gmapT :: (forall b. Data b => b -> b) -> Subscriptions -> Subscriptions #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Subscriptions -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Subscriptions -> r #

gmapQ :: (forall d. Data d => d -> u) -> Subscriptions -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Subscriptions -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Subscriptions -> m Subscriptions #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Subscriptions -> m Subscriptions #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Subscriptions -> m Subscriptions #

Show Subscriptions Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Generic Subscriptions Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Associated Types

type Rep Subscriptions :: Type -> Type #

ToJSON Subscriptions Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

FromJSON Subscriptions Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep Subscriptions Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep Subscriptions = D1 (MetaData "Subscriptions" "Network.Google.AppsReseller.Types.Product" "gogol-apps-reseller-0.4.0-KDuipGWXeWG9naMHX80l3C" False) (C1 (MetaCons "Subscriptions'" PrefixI True) (S1 (MetaSel (Just "_sNextPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_sKind") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_sSubscriptions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Subscription])))))

subscriptions :: Subscriptions Source #

Creates a value of Subscriptions with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sNextPageToken :: Lens' Subscriptions (Maybe Text) Source #

The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.

sKind :: Lens' Subscriptions Text Source #

Identifies the resource as a collection of subscriptions. Value: reseller#subscriptions

sSubscriptions :: Lens' Subscriptions [Subscription] Source #

The subscriptions in this page of results.

Seats

data Seats Source #

JSON template for subscription seats.

See: seats smart constructor.

Instances
Eq Seats Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Methods

(==) :: Seats -> Seats -> Bool #

(/=) :: Seats -> Seats -> Bool #

Data Seats Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Seats -> c Seats #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Seats #

toConstr :: Seats -> Constr #

dataTypeOf :: Seats -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Seats) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Seats) #

gmapT :: (forall b. Data b => b -> b) -> Seats -> Seats #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Seats -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Seats -> r #

gmapQ :: (forall d. Data d => d -> u) -> Seats -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Seats -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Seats -> m Seats #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Seats -> m Seats #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Seats -> m Seats #

Show Seats Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Methods

showsPrec :: Int -> Seats -> ShowS #

show :: Seats -> String #

showList :: [Seats] -> ShowS #

Generic Seats Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Associated Types

type Rep Seats :: Type -> Type #

Methods

from :: Seats -> Rep Seats x #

to :: Rep Seats x -> Seats #

ToJSON Seats Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

FromJSON Seats Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep Seats Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep Seats = D1 (MetaData "Seats" "Network.Google.AppsReseller.Types.Product" "gogol-apps-reseller-0.4.0-KDuipGWXeWG9naMHX80l3C" False) (C1 (MetaCons "Seats'" PrefixI True) ((S1 (MetaSel (Just "_seaNumberOfSeats") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_seaMaximumNumberOfSeats") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))) :*: (S1 (MetaSel (Just "_seaLicensedNumberOfSeats") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_seaKind") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

seats :: Seats Source #

Creates a value of Seats with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

seaNumberOfSeats :: Lens' Seats (Maybe Int32) Source #

The numberOfSeats property holds the customer's number of user licenses. How a user's licenses are managed depends on the subscription's plan: - annual commitment plan (with monthly or yearly pay) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. This is the maximum number of user licenses that a reseller's customer can create. The reseller can add more licenses, but once set, the numberOfSeats can not be reduced until renewal. The reseller is invoiced based on the numberOfSeats value regardless of how many of these user licenses are provisioned users. - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. The numberOfSeats property is not used in the request or response for flexible plan customers. - 30-day free trial plan — The numberOfSeats property is not used in the request or response for an account in a 30-day trial.

seaMaximumNumberOfSeats :: Lens' Seats (Maybe Int32) Source #

The maximumNumberOfSeats property is the maximum number of licenses that the customer can purchase. This property applies to plans other than the annual commitment plan. How a user's licenses are managed depends on the subscription's payment plan: - annual commitment plan (with monthly or yearly payments) — For this plan, a reseller is invoiced on the number of user licenses in the numberOfSeats property. The maximumNumberOfSeats property is a read-only property in the API's response. - flexible plan — For this plan, a reseller is invoiced on the actual number of users which is capped by the maximumNumberOfSeats. This is the maximum number of user licenses a customer has for user license provisioning. This quantity can be increased up to the maximum limit defined in the reseller's contract. And the minimum quantity is the current number of users in the customer account. - 30-day free trial plan — A subscription in a 30-day free trial is restricted to maximum 10 seats.

seaLicensedNumberOfSeats :: Lens' Seats (Maybe Int32) Source #

Read-only field containing the current number of licensed seats for FLEXIBLE Google-Apps subscriptions and secondary subscriptions such as Google-Vault and Drive-storage.

seaKind :: Lens' Seats Text Source #

Identifies the resource as a subscription change plan request. Value: subscriptions#seats

RenewalSettings

data RenewalSettings Source #

JSON template for a subscription renewal settings.

See: renewalSettings smart constructor.

Instances
Eq RenewalSettings Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Data RenewalSettings Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RenewalSettings -> c RenewalSettings #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RenewalSettings #

toConstr :: RenewalSettings -> Constr #

dataTypeOf :: RenewalSettings -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RenewalSettings) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RenewalSettings) #

gmapT :: (forall b. Data b => b -> b) -> RenewalSettings -> RenewalSettings #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RenewalSettings -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RenewalSettings -> r #

gmapQ :: (forall d. Data d => d -> u) -> RenewalSettings -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> RenewalSettings -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RenewalSettings -> m RenewalSettings #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RenewalSettings -> m RenewalSettings #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RenewalSettings -> m RenewalSettings #

Show RenewalSettings Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Generic RenewalSettings Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Associated Types

type Rep RenewalSettings :: Type -> Type #

ToJSON RenewalSettings Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

FromJSON RenewalSettings Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep RenewalSettings Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep RenewalSettings = D1 (MetaData "RenewalSettings" "Network.Google.AppsReseller.Types.Product" "gogol-apps-reseller-0.4.0-KDuipGWXeWG9naMHX80l3C" False) (C1 (MetaCons "RenewalSettings'" PrefixI True) (S1 (MetaSel (Just "_rsKind") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_rsRenewalType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))

renewalSettings :: RenewalSettings Source #

Creates a value of RenewalSettings with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rsKind :: Lens' RenewalSettings Text Source #

Identifies the resource as a subscription renewal setting. Value: subscriptions#renewalSettings

rsRenewalType :: Lens' RenewalSettings (Maybe Text) Source #

Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center. When renewing a subscription, the renewalType is a required property.

Subscription

data Subscription Source #

JSON template for a subscription.

See: subscription smart constructor.

Instances
Eq Subscription Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Data Subscription Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Subscription -> c Subscription #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Subscription #

toConstr :: Subscription -> Constr #

dataTypeOf :: Subscription -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Subscription) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Subscription) #

gmapT :: (forall b. Data b => b -> b) -> Subscription -> Subscription #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Subscription -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Subscription -> r #

gmapQ :: (forall d. Data d => d -> u) -> Subscription -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Subscription -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Subscription -> m Subscription #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Subscription -> m Subscription #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Subscription -> m Subscription #

Show Subscription Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Generic Subscription Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Associated Types

type Rep Subscription :: Type -> Type #

ToJSON Subscription Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

FromJSON Subscription Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep Subscription Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep Subscription = D1 (MetaData "Subscription" "Network.Google.AppsReseller.Types.Product" "gogol-apps-reseller-0.4.0-KDuipGWXeWG9naMHX80l3C" False) (C1 (MetaCons "Subscription'" PrefixI True) ((((S1 (MetaSel (Just "_subCreationTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :*: S1 (MetaSel (Just "_subBillingMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_subStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_subTrialSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SubscriptionTrialSettings)))) :*: ((S1 (MetaSel (Just "_subSKUName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_subResourceUiURL") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_subKind") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_subSKUId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_subPlan") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SubscriptionPlan)))))) :*: (((S1 (MetaSel (Just "_subDealCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_subCustomerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_subCustomerDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_subSuspensionReasons") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 (MetaSel (Just "_subTransferInfo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SubscriptionTransferInfo)) :*: S1 (MetaSel (Just "_subPurchaseOrderId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_subSeats") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Seats)) :*: (S1 (MetaSel (Just "_subRenewalSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RenewalSettings)) :*: S1 (MetaSel (Just "_subSubscriptionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

subCreationTime :: Lens' Subscription (Maybe Int64) Source #

The creationTime property is the date when subscription was created. It is in milliseconds using the Epoch format. See an example Epoch converter.

subBillingMethod :: Lens' Subscription (Maybe Text) Source #

Read-only field that returns the current billing method for a subscription.

subStatus :: Lens' Subscription (Maybe Text) Source #

This is an optional property.

subTrialSettings :: Lens' Subscription (Maybe SubscriptionTrialSettings) Source #

The G Suite annual commitment and flexible payment plans can be in a 30-day free trial. For more information, see the API concepts.

subSKUName :: Lens' Subscription (Maybe Text) Source #

Read-only external display name for a product's SKU assigned to a customer in the subscription. SKU names are subject to change at Google's discretion. For products and SKUs available in this version of the API, see Product and SKU IDs.

subResourceUiURL :: Lens' Subscription (Maybe Text) Source #

URL to customer's Subscriptions page in the Admin console. The read-only URL is generated by the API service. This is used if your client application requires the customer to complete a task using the Subscriptions page in the Admin console.

subKind :: Lens' Subscription Text Source #

Identifies the resource as a Subscription. Value: reseller#subscription

subSKUId :: Lens' Subscription (Maybe Text) Source #

A required property. The skuId is a unique system identifier for a product's SKU assigned to a customer in the subscription. For products and SKUs available in this version of the API, see Product and SKU IDs.

subPlan :: Lens' Subscription (Maybe SubscriptionPlan) Source #

The plan property is required. In this version of the API, the G Suite plans are the flexible plan, annual commitment plan, and the 30-day free trial plan. For more information about the API"s payment plans, see the API concepts.

subDealCode :: Lens' Subscription (Maybe Text) Source #

Google-issued code (100 char max) for discounted pricing on subscription plans. Deal code must be included in insert requests in order to receive discounted rate. This property is optional, regular pricing applies if left empty.

subCustomerId :: Lens' Subscription (Maybe Text) Source #

This property will always be returned in a response as the unique identifier generated by Google. In a request, this property can be either the primary domain or the unique identifier generated by Google.

subCustomerDomain :: Lens' Subscription (Maybe Text) Source #

Primary domain name of the customer

subSuspensionReasons :: Lens' Subscription [Text] Source #

Read-only field containing an enumerable of all the current suspension reasons for a subscription. It is possible for a subscription to have many concurrent, overlapping suspension reasons. A subscription's STATUS is SUSPENDED until all pending suspensions are removed. Possible options include: - PENDING_TOS_ACCEPTANCE - The customer has not logged in and accepted the G Suite Resold Terms of Services. - RENEWAL_WITH_TYPE_CANCEL - The customer's commitment ended and their service was cancelled at the end of their term. - RESELLER_INITIATED - A manual suspension invoked by a Reseller. - TRIAL_ENDED - The customer's trial expired without a plan selected. - OTHER - The customer is suspended for an internal Google reason (e.g. abuse or otherwise).

subTransferInfo :: Lens' Subscription (Maybe SubscriptionTransferInfo) Source #

Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.

subPurchaseOrderId :: Lens' Subscription (Maybe Text) Source #

This is an optional property. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters.

subSeats :: Lens' Subscription (Maybe Seats) Source #

This is a required property. The number and limit of user seat licenses in the plan.

subRenewalSettings :: Lens' Subscription (Maybe RenewalSettings) Source #

Renewal settings for the annual commitment plan. For more detailed information, see renewal options in the administrator help center.

subSubscriptionId :: Lens' Subscription (Maybe Text) Source #

The subscriptionId is the subscription identifier and is unique for each customer. This is a required property. Since a subscriptionId changes when a subscription is updated, we recommend not using this ID as a key for persistent data. Use the subscriptionId as described in retrieve all reseller subscriptions.

SubscriptionTransferInfo

data SubscriptionTransferInfo Source #

Read-only transfer related information for the subscription. For more information, see retrieve transferable subscriptions for a customer.

See: subscriptionTransferInfo smart constructor.

Instances
Eq SubscriptionTransferInfo Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Data SubscriptionTransferInfo Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SubscriptionTransferInfo -> c SubscriptionTransferInfo #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SubscriptionTransferInfo #

toConstr :: SubscriptionTransferInfo -> Constr #

dataTypeOf :: SubscriptionTransferInfo -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SubscriptionTransferInfo) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SubscriptionTransferInfo) #

gmapT :: (forall b. Data b => b -> b) -> SubscriptionTransferInfo -> SubscriptionTransferInfo #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SubscriptionTransferInfo -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SubscriptionTransferInfo -> r #

gmapQ :: (forall d. Data d => d -> u) -> SubscriptionTransferInfo -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SubscriptionTransferInfo -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SubscriptionTransferInfo -> m SubscriptionTransferInfo #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SubscriptionTransferInfo -> m SubscriptionTransferInfo #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SubscriptionTransferInfo -> m SubscriptionTransferInfo #

Show SubscriptionTransferInfo Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Generic SubscriptionTransferInfo Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

Associated Types

type Rep SubscriptionTransferInfo :: Type -> Type #

ToJSON SubscriptionTransferInfo Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

FromJSON SubscriptionTransferInfo Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep SubscriptionTransferInfo Source # 
Instance details

Defined in Network.Google.AppsReseller.Types.Product

type Rep SubscriptionTransferInfo = D1 (MetaData "SubscriptionTransferInfo" "Network.Google.AppsReseller.Types.Product" "gogol-apps-reseller-0.4.0-KDuipGWXeWG9naMHX80l3C" False) (C1 (MetaCons "SubscriptionTransferInfo'" PrefixI True) (S1 (MetaSel (Just "_stiTransferabilityExpirationTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :*: S1 (MetaSel (Just "_stiMinimumTransferableSeats") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))

subscriptionTransferInfo :: SubscriptionTransferInfo Source #

Creates a value of SubscriptionTransferInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

stiTransferabilityExpirationTime :: Lens' SubscriptionTransferInfo (Maybe Int64) Source #

The time when transfer token or intent to transfer will expire. The time is in milliseconds using UNIX Epoch format.

stiMinimumTransferableSeats :: Lens' SubscriptionTransferInfo (Maybe Int32) Source #

When inserting a subscription, this is the minimum number of seats listed in the transfer order for this product. For example, if the customer has 20 users, the reseller cannot place a transfer order of 15 seats. The minimum is 20 seats.