Copyright | (c) 2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- API Declaration
- Resources
- reseller.customers.get
- reseller.customers.insert
- reseller.customers.patch
- reseller.customers.update
- reseller.subscriptions.activate
- reseller.subscriptions.changePlan
- reseller.subscriptions.changeRenewalSettings
- reseller.subscriptions.changeSeats
- reseller.subscriptions.delete
- reseller.subscriptions.get
- reseller.subscriptions.insert
- reseller.subscriptions.list
- reseller.subscriptions.startPaidService
- reseller.subscriptions.suspend
- Types
Lets you create and manage your customers and their subscriptions.
- appsResellerService :: Service
- type AppsResellerAPI = CustomersInsertResource :<|> (CustomersPatchResource :<|> (CustomersGetResource :<|> (CustomersUpdateResource :<|> (SubscriptionsInsertResource :<|> (SubscriptionsListResource :<|> (SubscriptionsChangeRenewalSettingsResource :<|> (SubscriptionsGetResource :<|> (SubscriptionsActivateResource :<|> (SubscriptionsSuspendResource :<|> (SubscriptionsChangePlanResource :<|> (SubscriptionsChangeSeatsResource :<|> (SubscriptionsDeleteResource :<|> SubscriptionsStartPaidServiceResource))))))))))))
- module Network.Google.Resource.Reseller.Customers.Get
- module Network.Google.Resource.Reseller.Customers.Insert
- module Network.Google.Resource.Reseller.Customers.Patch
- module Network.Google.Resource.Reseller.Customers.Update
- module Network.Google.Resource.Reseller.Subscriptions.Activate
- module Network.Google.Resource.Reseller.Subscriptions.ChangePlan
- module Network.Google.Resource.Reseller.Subscriptions.ChangeRenewalSettings
- module Network.Google.Resource.Reseller.Subscriptions.ChangeSeats
- module Network.Google.Resource.Reseller.Subscriptions.Delete
- module Network.Google.Resource.Reseller.Subscriptions.Get
- module Network.Google.Resource.Reseller.Subscriptions.Insert
- module Network.Google.Resource.Reseller.Subscriptions.List
- module Network.Google.Resource.Reseller.Subscriptions.StartPaidService
- module Network.Google.Resource.Reseller.Subscriptions.Suspend
- data SubscriptionTrialSettings
- subscriptionTrialSettings :: SubscriptionTrialSettings
- stsIsInTrial :: Lens' SubscriptionTrialSettings (Maybe Bool)
- stsTrialEndTime :: Lens' SubscriptionTrialSettings (Maybe Int64)
- data Address
- address :: Address
- aOrganizationName :: Lens' Address (Maybe Text)
- aKind :: Lens' Address Text
- aPostalCode :: Lens' Address (Maybe Text)
- aAddressLine1 :: Lens' Address (Maybe Text)
- aLocality :: Lens' Address (Maybe Text)
- aContactName :: Lens' Address (Maybe Text)
- aAddressLine2 :: Lens' Address (Maybe Text)
- aCountryCode :: Lens' Address (Maybe Text)
- aRegion :: Lens' Address (Maybe Text)
- aAddressLine3 :: Lens' Address (Maybe Text)
- data Customer
- customer :: Customer
- cResourceUiURL :: Lens' Customer (Maybe Text)
- cKind :: Lens' Customer Text
- cCustomerId :: Lens' Customer (Maybe Text)
- cAlternateEmail :: Lens' Customer (Maybe Text)
- cCustomerDomain :: Lens' Customer (Maybe Text)
- cPhoneNumber :: Lens' Customer (Maybe Text)
- cPostalAddress :: Lens' Customer (Maybe Address)
- data ChangePlanRequest
- changePlanRequest :: ChangePlanRequest
- cprKind :: Lens' ChangePlanRequest Text
- cprPlanName :: Lens' ChangePlanRequest (Maybe Text)
- cprPurchaseOrderId :: Lens' ChangePlanRequest (Maybe Text)
- cprSeats :: Lens' ChangePlanRequest (Maybe Seats)
- data SubscriptionPlanCommitmentInterval
- subscriptionPlanCommitmentInterval :: SubscriptionPlanCommitmentInterval
- spciStartTime :: Lens' SubscriptionPlanCommitmentInterval (Maybe Int64)
- spciEndTime :: Lens' SubscriptionPlanCommitmentInterval (Maybe Int64)
- data SubscriptionsDeleteDeletionType
- data SubscriptionPlan
- subscriptionPlan :: SubscriptionPlan
- spCommitmentInterval :: Lens' SubscriptionPlan (Maybe SubscriptionPlanCommitmentInterval)
- spIsCommitmentPlan :: Lens' SubscriptionPlan (Maybe Bool)
- spPlanName :: Lens' SubscriptionPlan (Maybe Text)
- data Subscriptions
- subscriptions :: Subscriptions
- sNextPageToken :: Lens' Subscriptions (Maybe Text)
- sKind :: Lens' Subscriptions Text
- sSubscriptions :: Lens' Subscriptions [Subscription]
- data Seats
- seats :: Seats
- seaNumberOfSeats :: Lens' Seats (Maybe Int32)
- seaMaximumNumberOfSeats :: Lens' Seats (Maybe Int32)
- seaLicensedNumberOfSeats :: Lens' Seats (Maybe Int32)
- seaKind :: Lens' Seats Text
- data RenewalSettings
- renewalSettings :: RenewalSettings
- rsKind :: Lens' RenewalSettings Text
- rsRenewalType :: Lens' RenewalSettings (Maybe Text)
- data Subscription
- subscription :: Subscription
- subCreationTime :: Lens' Subscription (Maybe Int64)
- subBillingMethod :: Lens' Subscription (Maybe Text)
- subStatus :: Lens' Subscription (Maybe Text)
- subTrialSettings :: Lens' Subscription (Maybe SubscriptionTrialSettings)
- subResourceUiURL :: Lens' Subscription (Maybe Text)
- subKind :: Lens' Subscription Text
- subSKUId :: Lens' Subscription (Maybe Text)
- subPlan :: Lens' Subscription (Maybe SubscriptionPlan)
- subCustomerId :: Lens' Subscription (Maybe Text)
- subSuspensionReasons :: Lens' Subscription [Text]
- subTransferInfo :: Lens' Subscription (Maybe SubscriptionTransferInfo)
- subPurchaseOrderId :: Lens' Subscription (Maybe Text)
- subSeats :: Lens' Subscription (Maybe Seats)
- subRenewalSettings :: Lens' Subscription (Maybe RenewalSettings)
- subSubscriptionId :: Lens' Subscription (Maybe Text)
- data SubscriptionTransferInfo
- subscriptionTransferInfo :: SubscriptionTransferInfo
- stiTransferabilityExpirationTime :: Lens' SubscriptionTransferInfo (Maybe Int64)
- stiMinimumTransferableSeats :: Lens' SubscriptionTransferInfo (Maybe Int32)
Service Configuration
appsResellerService :: Service 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.
API Declaration
type AppsResellerAPI = CustomersInsertResource :<|> (CustomersPatchResource :<|> (CustomersGetResource :<|> (CustomersUpdateResource :<|> (SubscriptionsInsertResource :<|> (SubscriptionsListResource :<|> (SubscriptionsChangeRenewalSettingsResource :<|> (SubscriptionsGetResource :<|> (SubscriptionsActivateResource :<|> (SubscriptionsSuspendResource :<|> (SubscriptionsChangePlanResource :<|> (SubscriptionsChangeSeatsResource :<|> (SubscriptionsDeleteResource :<|> SubscriptionsStartPaidServiceResource)))))))))))) Source
Represents the entirety of the methods and resources available for the Enterprise Apps Reseller API service.
Resources
reseller.customers.get
reseller.customers.insert
reseller.customers.patch
reseller.customers.update
reseller.subscriptions.activate
reseller.subscriptions.changePlan
reseller.subscriptions.changeRenewalSettings
reseller.subscriptions.changeSeats
reseller.subscriptions.delete
reseller.subscriptions.get
reseller.subscriptions.insert
reseller.subscriptions.list
reseller.subscriptions.startPaidService
reseller.subscriptions.suspend
Types
SubscriptionTrialSettings
data SubscriptionTrialSettings Source
Trial Settings of the subscription.
See: subscriptionTrialSettings
smart constructor.
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
Whether the subscription is in trial.
stsTrialEndTime :: Lens' SubscriptionTrialSettings (Maybe Int64) Source
End time of the trial in milliseconds since Unix epoch.
Address
JSON template for address of a customer.
See: address
smart constructor.
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:
aPostalCode :: Lens' Address (Maybe Text) Source
The postal code. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
aLocality :: Lens' Address (Maybe Text) Source
Name of the locality. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
aRegion :: Lens' Address (Maybe Text) Source
Name of the region. This is in accordance with - http://portablecontacts.net/draft-spec.html#address_element.
Customer
JSON template for a customer.
See: customer
smart constructor.
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:
ChangePlanRequest
data ChangePlanRequest Source
JSON template for the ChangePlan rpc request.
See: changePlanRequest
smart constructor.
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.
cprPlanName :: Lens' ChangePlanRequest (Maybe Text) Source
Name of the plan to change to.
cprPurchaseOrderId :: Lens' ChangePlanRequest (Maybe Text) Source
Purchase order id for your order tracking purposes.
SubscriptionPlanCommitmentInterval
data SubscriptionPlanCommitmentInterval Source
Interval of the commitment if it is a commitment plan.
See: subscriptionPlanCommitmentInterval
smart constructor.
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
Start time of the commitment interval in milliseconds since Unix epoch.
spciEndTime :: Lens' SubscriptionPlanCommitmentInterval (Maybe Int64) Source
End time of the commitment interval in milliseconds since Unix epoch.
SubscriptionsDeleteDeletionType
data SubscriptionsDeleteDeletionType Source
Whether the subscription is to be fully cancelled or downgraded
Cancel |
|
Downgrade |
|
Suspend |
|
TransferToDirect |
|
SubscriptionPlan
data SubscriptionPlan Source
Plan details of the subscription
See: subscriptionPlan
smart constructor.
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
Interval of the commitment if it is a commitment plan.
spIsCommitmentPlan :: Lens' SubscriptionPlan (Maybe Bool) Source
Whether the plan is a commitment plan or not.
spPlanName :: Lens' SubscriptionPlan (Maybe Text) Source
The plan name of this subscription's plan.
Subscriptions
data Subscriptions Source
JSON template for a subscription list.
See: subscriptions
smart constructor.
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.
sSubscriptions :: Lens' Subscriptions [Subscription] Source
The subscriptions in this page of results.
Seats
JSON template for subscription seats.
See: seats
smart constructor.
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
Number of seats to purchase. This is applicable only for a commitment plan.
seaMaximumNumberOfSeats :: Lens' Seats (Maybe Int32) Source
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) 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.
RenewalSettings
data RenewalSettings Source
JSON template for a subscription renewal settings.
See: renewalSettings
smart constructor.
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.
rsRenewalType :: Lens' RenewalSettings (Maybe Text) Source
Subscription renewal type.
Subscription
data Subscription Source
JSON template for a subscription.
See: subscription
smart constructor.
subscription :: Subscription Source
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 :: Lens' Subscription (Maybe Int64) Source
Creation time of this subscription in milliseconds since Unix epoch.
subBillingMethod :: Lens' Subscription (Maybe Text) Source
Billing method of this subscription.
subTrialSettings :: Lens' Subscription (Maybe SubscriptionTrialSettings) Source
Trial Settings of the subscription.
subResourceUiURL :: Lens' Subscription (Maybe Text) Source
Ui url for subscription resource.
subKind :: Lens' Subscription Text Source
Identifies the resource as a Subscription.
subSKUId :: Lens' Subscription (Maybe Text) Source
Name of the sku for which this subscription is purchased.
subPlan :: Lens' Subscription (Maybe SubscriptionPlan) Source
Plan details of the subscription
subCustomerId :: Lens' Subscription (Maybe Text) Source
The id of the customer to whom the subscription belongs.
subSuspensionReasons :: Lens' Subscription [Text] Source
Suspension Reasons
subTransferInfo :: Lens' Subscription (Maybe SubscriptionTransferInfo) Source
Transfer related information for the subscription.
subPurchaseOrderId :: Lens' Subscription (Maybe Text) Source
Purchase order id for your order tracking purposes.
subRenewalSettings :: Lens' Subscription (Maybe RenewalSettings) Source
Renewal settings of the subscription.
subSubscriptionId :: Lens' Subscription (Maybe Text) Source
The id of the subscription.
SubscriptionTransferInfo
data SubscriptionTransferInfo Source
Transfer related information for the subscription.
See: subscriptionTransferInfo
smart constructor.
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
Time when transfer token or intent to transfer will expire.