Service.Customer

Customer methods.

Summary

Service.Customer	Customer methods.
Functions
CP_Wizard	Control Panel wizard
requestCancellation	Create a cancellation request for a customer
createKey	Create an API Key for the customer
revokeKey	Revoke an API Key for the customer
getKeys	List all customer Keys
createKeyACL	Associate an ACL with the key
updateKeyACL	Update a field on the ACL
deleteKeyACL	Delete a key ACL
listRoles	List all customer roles
getUsername	Get Customer Username
changePassword	Change the customer password
changePIN	Change the customer PIN
changeEmail	Change the customer email address
setSettings	Set a list of settings on the Customer
getSettings	Get all the settings associated with the Customer
addIpAddress	Add address to the Customer
getIpAddresses	Get Addresses associated with Customer
getDetailedIpAddresses	Get address details for a Customer
freeIpAddress	Free an Address from the customer
createFTPUser	Create a Customer-controlled FTP user
listFTPUsers	List FTP users
updateFTPUser	Update an FTP user
destroyFTPUser	Delete an FTP user
currentBillableBandwidth	Fetch the latest billable bandwidth amount
listNotices	Fetch all the notices associated with the customer (or global)
acknowledgeNotice	Set the acknowledged flag of a customer notice
createContact	Create a contact
destroyContact	Delete a contact
createContactMethod	Associate a contact method with a contact
destroyContactMethod	Delete a contact method
createContactMethodNotice	Associate a notice type with a contact method
destroyContactMethodNotice	Delete a contact method notice association
listContactNoticeTypes	List contact notice types
listContactMethods	List contact methods
listContacts	List contacts and related objects

Functions

CP_Wizard

Control Panel wizard

Parameters

customerId	no docs (idx: 1, type: Types.CustomerId)
siteName	no docs (idx: 2, type: Types.SiteName)
siteHostname	no docs (idx: 3, type: Types.Hostname)
containerName	no docs (idx: 4, type: Types.ContainerName)
containerType	no docs (idx: 8, type: Types.ContainerTypeId)
containerOSId	no docs (idx: 10, type: Types.OSId)
containerDiskSpace	no docs (idx: 11, type: Types.ContainerDiskSpace)
containerSize	no docs (idx: 12, type: Types.ContainerSize)
environmentNames	no docs (idx: 6, type: Thrift.list (Types.EnvironmentName))
aliasNames	no docs (idx: 7, type: Thrift.list (Types.SiteAlias), optional)
createDNS	no docs (idx: 9, type: Thrift.bool, optional)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

requestCancellation

Create a cancellation request for a customer

Parameters

id	no docs (idx: 1, type: Types.CustomerId)
reason	no docs (idx: 2, type: Thrift.string)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

createKey

Create an API Key for the customer

Parameters

id	no docs (idx: 1, type: Types.CustomerId)
type	no docs (idx: 2, type: Types.APIKeyType, role: internal, optional)

Returns

Types.APIKey

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

revokeKey

Revoke an API Key for the customer

Parameters

id	no docs (idx: 1, type: Types.APIKeyId)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

getKeys

List all customer Keys

Parameters

id	no docs (idx: 1, type: Types.CustomerId)
type	no docs (idx: 2, type: Types.APIKeyType, optional)

Returns

Types.APIKeys

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

createKeyACL

Associate an ACL with the key

Parameters

id	no docs (idx: 1, type: Types.APIKeyId)
address	no docs (idx: 2, type: Types.IPAddress)
cidr	no docs (idx: 3, type: Types.CIDRMask)

Returns

Types.APIKeyACL

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

updateKeyACL

Update a field on the ACL

Parameters

id	no docs (idx: 1, type: Types.APIKeyACLId)
address	no docs (idx: 2, type: Types.IPAddress, optional)
cidr	no docs (idx: 3, type: Types.CIDRMask, optional)

Returns

Types.APIKeyACL

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

deleteKeyACL

Delete a key ACL

Parameters

id	no docs (idx: 1, type: Types.APIKeyACLId)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

listRoles

List all customer roles

Parameters

id	no docs (idx: 1, type: Types.CustomerId)

Returns

Thrift.list (Types.Role)

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

getUsername

Get Customer Username

Parameters

id	no docs (idx: 1, type: Types.CustomerId)

Returns

Types.CustomerUsername

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

changePassword

Change the customer password

Parameters

id	no docs (idx: 1, type: Types.CustomerId)
password	no docs (idx: 2, type: Thrift.string)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

changePIN

Change the customer PIN

Parameters

id	no docs (idx: 1, type: Types.CustomerId)
pin	no docs (idx: 2, type: Thrift.string)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

changeEmail

Change the customer email address

Parameters

id	no docs (idx: 1, type: Types.CustomerId)
email	no docs (idx: 2, type: Types.EmailAddress)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

setSettings

Set a list of settings on the Customer

Parameters

id	the ID of the Customer (idx: 1, type: Types.CustomerId)
settings	a list of the settings (idx: 2, type: Types.SettingList)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

getSettings

Get all the settings associated with the Customer

Parameters

id	the ID of the Customer (idx: 1, type: Types.CustomerId)

Returns

Types.SettingList

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

addIpAddress

Add address to the Customer

Parameters

id	no docs (idx: 1, type: Types.CustomerId)
address	no docs (idx: 2, type: Types.IPAddress, role: internal, optional)

Returns

Types.IPAddress

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

getIpAddresses

Get Addresses associated with Customer

Parameters

id	no docs (idx: 1, type: Types.CustomerId)

Returns

Thrift.list (Types.IPAddress)

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

getDetailedIpAddresses

Get address details for a Customer

Parameters

id	no docs (idx: 1, type: Types.CustomerId)

Returns

Thrift.list (Types.IPAddressDetails)

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

freeIpAddress

Free an Address from the customer

Parameters

id	no docs (idx: 1, type: Types.CustomerId)
address	no docs (idx: 2, type: Types.IPAddress)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

createFTPUser

Create a Customer-controlled FTP user

Parameters

customerId	no docs (idx: 1, type: Types.CustomerId)
name	no docs (idx: 2, type: Types.CustomerName)
username	no docs (idx: 3, type: Types.CustomerUsername)
password	no docs (idx: 4, type: Thrift.string)
relativeRoot	no docs (idx: 5, type: Thrift.string, utf8)
type	no docs (idx: 6, type: Types.FTPUserType)
siteId	no docs (idx: 7, type: Types.SiteId, optional)
environmentId	no docs (idx: 8, type: Types.EnvironmentId, optional)

Returns

Types.FTPUser

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

listFTPUsers

List FTP users

Parameters

id	no docs (idx: 1, type: Types.CustomerId)
siteId	no docs (idx: 7, type: Types.SiteId, optional)
environmentId	no docs (idx: 8, type: Types.EnvironmentId, optional)

Returns

Thrift.list (Types.FTPUser)

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

updateFTPUser

Update an FTP user

Parameters

id	no docs (idx: 1, type: Types.FTPUserId)
name	no docs (idx: 2, type: Types.CustomerName, optional)
username	no docs (idx: 3, type: Types.CustomerUsername, optional)
password	no docs (idx: 4, type: Thrift.string, optional)
relativeRoot	no docs (idx: 5, type: Thrift.string, optional, utf8)
type	no docs (idx: 6, type: Types.FTPUserType, optional)
siteId	no docs (idx: 7, type: Types.SiteId, optional)
environmentId	no docs (idx: 8, type: Types.EnvironmentId, optional)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

destroyFTPUser

Delete an FTP user

Parameters

id	no docs (idx: 1, type: Types.FTPUserId)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

currentBillableBandwidth

Fetch the latest billable bandwidth amount

Parameters

customerId

no docs (idx: 1, type: Types.CustomerId)

Returns

Types.ResourceHistoricalUsage

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

listNotices

Fetch all the notices associated with the customer (or global)

Parameters

customerId	no docs (idx: 1, type: Types.CustomerId)
since	Ignore notices that were created or updated before this time (idx: 2, type: Types.UnixTime, optional)

Returns

Thrift.list (Types.CustomerNotice)

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

acknowledgeNotice

Set the acknowledged flag of a customer notice

Parameters

noticeId

no docs (idx: 1, type: Types.CustomerNoticeId)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

createContact

Create a contact

Parameters

customerId	no docs (idx: 1, type: Types.CustomerId)
name	no docs (idx: 2, type: Thrift.string)

Returns

Types.CustomerContactId

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

destroyContact

Delete a contact

Parameters

contactId

no docs (idx: 1, type: Types.CustomerContactId)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

createContactMethod

Associate a contact method with a contact

Parameters

contactId	no docs (idx: 1, type: Types.CustomerContactId)
methodId	no docs (idx: 2, type: Types.ContactMethodId)
options	no docs (idx: 3, type: Thrift.map (Thrift.string => Thrift.string), optional)

Returns

Types.CustomerContactMethodId

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

destroyContactMethod

Delete a contact method

Parameters

contactMethodId

no docs (idx: 1, type: Types.CustomerContactMethodId)

Returns

Thrift.void

Throws

Exceptions.InvalidArguments (idx: 1)

Roles

customer

createContactMethodNotice

Associate a notice type with a contact method

Parameters

contactMethodId	no docs (idx: 1, type: Types.CustomerContactMethodId)
noticeTypeId	no docs (idx: 2, type: Types.ContactNoticeTypeId)
options	no docs (idx: 3, type: Thrift.map (Thrift.string => Thrift.string), optional)