Network.Google.AppsReseller.Types

Service Configuration

appsResellerService :: Service

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 :: OAuthScope

Manage users on your domain

appsOrderScope :: OAuthScope

Manage users on your domain

SubscriptionTrialSettings

data SubscriptionTrialSettings

Trial Settings of the subscription.

See: subscriptionTrialSettings smart constructor.

Instances

Eq SubscriptionTrialSettings

Data SubscriptionTrialSettings

Show SubscriptionTrialSettings

Generic SubscriptionTrialSettings

ToJSON SubscriptionTrialSettings

FromJSON SubscriptionTrialSettings

type Rep SubscriptionTrialSettings

subscriptionTrialSettings :: SubscriptionTrialSettings

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
• stsTrialEndTime

stsIsInTrial :: Lens' SubscriptionTrialSettings (Maybe Bool)

Whether the subscription is in trial.

stsTrialEndTime :: Lens' SubscriptionTrialSettings (Maybe Int64)

End time of the trial in milliseconds since Unix epoch.

Address

data Address

JSON template for address of a customer.

See: address smart constructor.

Instances

Eq Address

Data Address

Show Address

Generic Address

ToJSON Address

FromJSON Address

type Rep Address

address :: Address

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
• aKind
• aPostalCode
• aAddressLine1
• aLocality
• aContactName
• aAddressLine2
• aCountryCode
• aRegion
• aAddressLine3

aOrganizationName :: Lens' Address (Maybe Text)

Name of the organization.

aKind :: Lens' Address Text

Identifies the resource as a customer address.

aPostalCode :: Lens' Address (Maybe Text)

The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.

aAddressLine1 :: Lens' Address (Maybe Text)

Address line 1 of the address.

aLocality :: Lens' Address (Maybe Text)

Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.

aContactName :: Lens' Address (Maybe Text)

Name of the contact person.

aAddressLine2 :: Lens' Address (Maybe Text)

Address line 2 of the address.

aCountryCode :: Lens' Address (Maybe Text)

ISO 3166 country code.

aRegion :: Lens' Address (Maybe Text)

Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.

aAddressLine3 :: Lens' Address (Maybe Text)

Address line 3 of the address.

Customer

data Customer

JSON template for a customer.

See: customer smart constructor.

Instances

Eq Customer

Data Customer

Show Customer

Generic Customer

ToJSON Customer

FromJSON Customer

type Rep Customer

customer :: Customer

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:

• cResourceUiURL
• cKind
• cCustomerId
• cAlternateEmail
• cCustomerDomain
• cPhoneNumber
• cPostalAddress

cResourceUiURL :: Lens' Customer (Maybe Text)

Ui url for customer resource.

cKind :: Lens' Customer Text

Identifies the resource as a customer.

cCustomerId :: Lens' Customer (Maybe Text)

The id of the customer.

cAlternateEmail :: Lens' Customer (Maybe Text)

The alternate email of the customer.

cCustomerDomain :: Lens' Customer (Maybe Text)

The domain name of the customer.

cPhoneNumber :: Lens' Customer (Maybe Text)

The phone number of the customer.

cPostalAddress :: Lens' Customer (Maybe Address)

The postal address of the customer.

ChangePlanRequest

data ChangePlanRequest

JSON template for the ChangePlan rpc request.

See: changePlanRequest smart constructor.

Instances

Eq ChangePlanRequest

Data ChangePlanRequest

Show ChangePlanRequest

Generic ChangePlanRequest

ToJSON ChangePlanRequest

FromJSON ChangePlanRequest

type Rep ChangePlanRequest

changePlanRequest :: ChangePlanRequest

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
• cprPlanName
• cprPurchaseOrderId
• cprSeats

cprKind :: Lens' ChangePlanRequest Text

Identifies the resource as a subscription change plan request.

cprPlanName :: Lens' ChangePlanRequest (Maybe Text)

Name of the plan to change to.

cprPurchaseOrderId :: Lens' ChangePlanRequest (Maybe Text)

Purchase order id for your order tracking purposes.

cprSeats :: Lens' ChangePlanRequest (Maybe Seats)

Number/Limit of seats in the new plan.

SubscriptionPlanCommitmentInterval

data SubscriptionPlanCommitmentInterval

Interval of the commitment if it is a commitment plan.

See: subscriptionPlanCommitmentInterval smart constructor.

Instances

Eq SubscriptionPlanCommitmentInterval

Data SubscriptionPlanCommitmentInterval

Show SubscriptionPlanCommitmentInterval

Generic SubscriptionPlanCommitmentInterval

ToJSON SubscriptionPlanCommitmentInterval

FromJSON SubscriptionPlanCommitmentInterval

type Rep SubscriptionPlanCommitmentInterval

subscriptionPlanCommitmentInterval :: SubscriptionPlanCommitmentInterval

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
• spciEndTime

spciStartTime :: Lens' SubscriptionPlanCommitmentInterval (Maybe Int64)

Start time of the commitment interval in milliseconds since Unix epoch.

spciEndTime :: Lens' SubscriptionPlanCommitmentInterval (Maybe Int64)

End time of the commitment interval in milliseconds since Unix epoch.

SubscriptionsDeleteDeletionType

data SubscriptionsDeleteDeletionType

Whether the subscription is to be fully cancelled or downgraded

Constructors

Cancel

cancel Cancels the subscription immediately

Downgrade

downgrade Downgrades a Google Apps for Business subscription to Google Apps

Suspend

suspend Suspends the subscriptions for 4 days before cancelling it

TransferToDirect

transfer_to_direct Transfers a subscription directly to Google

Instances

Enum SubscriptionsDeleteDeletionType

Eq SubscriptionsDeleteDeletionType

Data SubscriptionsDeleteDeletionType

Ord SubscriptionsDeleteDeletionType

Read SubscriptionsDeleteDeletionType

Show SubscriptionsDeleteDeletionType

Generic SubscriptionsDeleteDeletionType

ToJSON SubscriptionsDeleteDeletionType

FromJSON SubscriptionsDeleteDeletionType

ToText SubscriptionsDeleteDeletionType

FromText SubscriptionsDeleteDeletionType

Hashable SubscriptionsDeleteDeletionType

type Rep SubscriptionsDeleteDeletionType

SubscriptionPlan

data SubscriptionPlan

Plan details of the subscription

See: subscriptionPlan smart constructor.

Instances

Eq SubscriptionPlan

Data SubscriptionPlan

Show SubscriptionPlan

Generic SubscriptionPlan

ToJSON SubscriptionPlan

FromJSON SubscriptionPlan

type Rep SubscriptionPlan

subscriptionPlan :: SubscriptionPlan

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
• spIsCommitmentPlan
• spPlanName

spCommitmentInterval :: Lens' SubscriptionPlan (Maybe SubscriptionPlanCommitmentInterval)

Interval of the commitment if it is a commitment plan.

spIsCommitmentPlan :: Lens' SubscriptionPlan (Maybe Bool)

Whether the plan is a commitment plan or not.

spPlanName :: Lens' SubscriptionPlan (Maybe Text)

The plan name of this subscription's plan.

Subscriptions

data Subscriptions

JSON template for a subscription list.

See: subscriptions smart constructor.

Instances

Eq Subscriptions

Data Subscriptions

Show Subscriptions

Generic Subscriptions

ToJSON Subscriptions

FromJSON Subscriptions

type Rep Subscriptions

subscriptions :: Subscriptions

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
• sKind
• sSubscriptions

sNextPageToken :: Lens' Subscriptions (Maybe Text)

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

Identifies the resource as a collection of subscriptions.

sSubscriptions :: Lens' Subscriptions [Subscription]

The subscriptions in this page of results.

Seats

data Seats

JSON template for subscription seats.

See: seats smart constructor.

Instances

Eq Seats

Data Seats

Show Seats

Generic Seats

ToJSON Seats

FromJSON Seats

type Rep Seats

seats :: Seats

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
• seaMaximumNumberOfSeats
• seaLicensedNumberOfSeats
• seaKind

seaNumberOfSeats :: Lens' Seats (Maybe Int32)

Number of seats to purchase. This is applicable only for a commitment plan.

seaMaximumNumberOfSeats :: Lens' Seats (Maybe Int32)

Maximum number of seats that can be purchased. This needs to be provided only for a non-commitment plan. For a commitment plan it is decided by the contract.

seaLicensedNumberOfSeats :: Lens' Seats (Maybe Int32)

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

Identifies the resource as a subscription change plan request.

RenewalSettings

data RenewalSettings

JSON template for a subscription renewal settings.

See: renewalSettings smart constructor.

Instances

Eq RenewalSettings

Data RenewalSettings

Show RenewalSettings

Generic RenewalSettings

ToJSON RenewalSettings

FromJSON RenewalSettings

type Rep RenewalSettings

renewalSettings :: RenewalSettings

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
• rsRenewalType

rsKind :: Lens' RenewalSettings Text

Identifies the resource as a subscription renewal setting.

rsRenewalType :: Lens' RenewalSettings (Maybe Text)

Subscription renewal type.

Subscription

data Subscription

JSON template for a subscription.

See: subscription smart constructor.

Instances

Eq Subscription

Data Subscription

Show Subscription

Generic Subscription

ToJSON Subscription

FromJSON Subscription

type Rep Subscription

subscription :: Subscription

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

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

• subCreationTime
• subBillingMethod
• subStatus
• subTrialSettings
• subResourceUiURL
• subKind
• subSKUId
• subPlan
• subCustomerId
• subSuspensionReasons
• subTransferInfo
• subPurchaseOrderId
• subSeats
• subRenewalSettings
• subSubscriptionId

subCreationTime :: Lens' Subscription (Maybe Int64)

Creation time of this subscription in milliseconds since Unix epoch.

subBillingMethod :: Lens' Subscription (Maybe Text)

Billing method of this subscription.

subStatus :: Lens' Subscription (Maybe Text)

Status of the subscription.

subTrialSettings :: Lens' Subscription (Maybe SubscriptionTrialSettings)

Trial Settings of the subscription.

subResourceUiURL :: Lens' Subscription (Maybe Text)

Ui url for subscription resource.

subKind :: Lens' Subscription Text

Identifies the resource as a Subscription.

subSKUId :: Lens' Subscription (Maybe Text)

Name of the sku for which this subscription is purchased.

subPlan :: Lens' Subscription (Maybe SubscriptionPlan)

Plan details of the subscription

subCustomerId :: Lens' Subscription (Maybe Text)

The id of the customer to whom the subscription belongs.

subSuspensionReasons :: Lens' Subscription [Text]

Suspension Reasons

subTransferInfo :: Lens' Subscription (Maybe SubscriptionTransferInfo)

Transfer related information for the subscription.

subPurchaseOrderId :: Lens' Subscription (Maybe Text)

Purchase order id for your order tracking purposes.

subSeats :: Lens' Subscription (Maybe Seats)

Number/Limit of seats in the new plan.

subRenewalSettings :: Lens' Subscription (Maybe RenewalSettings)

Renewal settings of the subscription.

subSubscriptionId :: Lens' Subscription (Maybe Text)

The id of the subscription.

SubscriptionTransferInfo

data SubscriptionTransferInfo

Transfer related information for the subscription.

See: subscriptionTransferInfo smart constructor.

Instances

Eq SubscriptionTransferInfo

Data SubscriptionTransferInfo

Show SubscriptionTransferInfo

Generic SubscriptionTransferInfo

ToJSON SubscriptionTransferInfo

FromJSON SubscriptionTransferInfo

type Rep SubscriptionTransferInfo

subscriptionTransferInfo :: SubscriptionTransferInfo

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
• stiMinimumTransferableSeats

stiTransferabilityExpirationTime :: Lens' SubscriptionTransferInfo (Maybe Int64)

Time when transfer token or intent to transfer will expire.

stiMinimumTransferableSeats :: Lens' SubscriptionTransferInfo (Maybe Int32)