Page tree
Skip to end of metadata
Go to start of metadata

It is possible to access the Admin API and user API from some FDL API types, most notably the Triggers API.
The functions of the Admin API or User API are called from objects that exists in the compatible FDL code, they are accessed using the global objects adminAPI and userAPI.
The functions made available in the FDL API object are combined with the global adminAPI or userAPI objects and are accessed as if they were part of that object.
When accessing the admin API or user API through FDL, the default credentials are those of the MBE admin. Using the FDL API function setSessionUser you can assume another user's credentials.
These methods set out how the admin API and user API functions are represented in FDL.

FDL API Functions

Name

Return Type

Description

getResource(String, boolean)

PseudoResource

Returns a resource with a given UUID

listResourceKeys(SearchFilter, QueryLimit)

ListResult<ResourceKey>

Gets a list of resource keys based on the supplied SearchFilter and QueryLimit

runAggregationQuery(Query)

AggregationQueryIterator

Perform a do query ignoring the usual query limit limitations

runListQuery(SearchFilter, QueryLimit, ResourceType)

JadeFQLReadWriteIterator<E>

Perform a list result ignoring the usual query limit limitations

runListQuery(SearchFilter, QueryLimit, String)

JadeFQLReadWriteIterator<E>

Perform a list result ignoring the usual query limit limitations

setSessionUser(String)

void

This function will allow a trigger FDL to set the API thread context user.

updateConfigurationProviderValues(String, String, HashMap<String, String>)

boolean

Update the configuration provider values for the specified resource.

FDL Admin API Functions

Name

Return Type

Description

addCurrency(Currency)

Currency

This Operation will add new currency into the system.

addKey(String, ResourceKey, String)

Resource

This Operation will add keys to the given resource object.

addUserToCustomer(String, String, Date)

Job

This function will add a user to a customer.

createAPIKeyUser(UserDetails, String, Boolean, String, Date)

Job

Create an API Key User for the specified customer.

createBillingEntity(BillingEntityDetails, Date)

Job

This function will create a billing entity object.

createBlob(Blob, Date)

Job

This function will create a blob.

createCluster(Cluster, Date)

Job

Create a record for the specified cluster

createCustomer(CustomerDetails, String, Date)

Job

This function will create a customer, processing a promotion code if necessary.

createFDLCodeBlock(FDLCodeBlock, Date)

Job

This function will create an FDL code block in the unsigned state.

createInterworkingNetwork(Network, long, Date)

Job

This function will create an Internetworking VLAN.

createInterWorkingNetworking(Network, int, int, Date)

Job

This function will create an Internetworking VLAN for given inner and outer tags.

createInvoice(Invoice, Date)

Job

This function will create and return a Invoice

createPaymentMethod(PaymentMethod, Date)

Job

Creates a payment method

createPluggableResource(PluggableResource, Date)

Job

This function will start a job that will create a Pluggable Resource and return the job reference.

createProduct(Product, Date)

Job

This function will create a product

createProductOffer(ProductOffer, Date)

Job

This function will create and return a product offer.

createPromotion(Promotion, Date)

Job

This function will create and returns a promotion.

createPromotionCode(PromoCode)

PromoCode

This function will create a promotion code.

createReferralPromoCode(ReferralPromoCode)

ReferralPromoCode

This function will create a Referral promocode Object.

createReferralPromotion(ReferralPromotion, Date)

Job

This function will return a the newly created Referral promotion Object.

createServiceNetwork(String, String, Date)

Job

This function will create a Service Network.

createStorageGroup(StorageGroup, Date)

Job

This function will create a storage group.

createTranslation(Translation, Date)

Job

Create a Translation object.

createUser(UserDetails, String, String, String, boolean, Date)

Job

This function starts a job that will create a user/contact with the given user details.

deleteAuthenticationToken(String)

boolean

Revoke API access when using the specified authentication token.

deleteCluster(String, Date)

Job

Removes the records for all resources in the specified cluster.

deleteCurrency(int)

boolean

This Operation will delete given currency from the system.

deletePromoCode(String, String)

boolean

This function will remove the given promotion code.

deleteReferralPromoCode(String, String)

boolean

This function will remove the given referral promo code.

deleteResource(String, boolean, Date)

Job

This Operation will delete an existing resource object.

describeResource(Resource)

List<ProductComponentType>

Gets the Product Component Types that define an resource.

doQuery(Query)

QueryResult

This function will query the database, aggregating and grouping results if relevant.

doUnitTransaction(String, String, TransactionType, double, UnitType, Boolean)

Object

This function will return a newly created Unit Transaction Object.

getAuthenticationToken(String, String, Long, Boolean)

AuthenticationToken

Gets an API authentication token for the specified User on the specified Customer.

getBlobContent(String)

String

This function will return blob content for a given blob

getCompiledTranslationMap(String)

MapHolder

Gets the compiled values of a Translation object.

getCustomer(String)

CustomerDetails

This function will return the customer object for a customer given its UUID.

getExternalVMDetails(String, String)

ImportVmSpec

This function will get the external vm details.

getKeysByType(String, ResourceKeyType, KeyList, String)

KeyList

This Operation will return a list of resource keys for the given resource.

getLicenceInformation()

LicenceInformation

This function will return an object containing the serialised licence object, the licence object in XML format, the number of currently active clusters and CPU codes and the maximum permitted numbers of active clusters and CPU cores.

getMeasuredValues(String[], String[], String[], String[], long)

ArrayList<MeasuredValue>

This function will return a list of measured values close to a given time stamp.

getPurchasedUnits(Date, Date, String)

List<PurchasedUnits>

This function searches for a list of units purchased within a given date range and for a given Billing Entity ID.

getResource(String, ResourceType, Boolean)

PseudoResource

Gets a resource of the given type with the specified UUID.

getResourceTypes()

MapHolder

This function will return list of available resource types.

getTranslationForUser(String, String, String[])

Translation

Get the Translation associated with the specified resource, either a User or a Billing Entity

getUser(String)

UserDetails

This function returns details about existing User.

getVncForwarderDetails(String)

VncForwarderDetails

Get the VNC Forwarder details for a specific VNC session key.

importExternalIPAddress(String, int, String, String)

boolean

This function will import an external IP address.

importExternalSubnet(String, int, String)

boolean

This function will import an external subnet.

importExternalVM(Server, String, Date)

Job

This function will allow you to import and external VM from a compatible hypervisor as a new server

invokeAction(String, String, String, List<Value>, Date)

Job

This function will start a job that will invoke an action for a resouce.

invokeActionSync(String, String, String, List<Value>)

FDLActionOutput

This function will start a job that will invoke an action for a resouce.

invokeHypervisorAction(String, String, List<Value>, Date)

Job

This function will start a job that will invoke a hypervisor specifiec action for a resouce.

listAdvertisedResources(SearchFilter, QueryLimit, ResourceType, String, String)

ListResult<PseudoResource>

This Operation will return list of resources after satisfying the filter conditions and that are advertised to either a billing entity or customer

listBillableResourceTypes()

ArrayList<ResourceTypeDefinition>

This function will return list of billable resource types.

listBillingEntities(SearchFilter, QueryLimit)

ListResult<BillingEntityDetails>

This function searches for a list of billing entities matching a given search filter.

listCurrencies(SearchFilter, QueryLimit)

ListResult<Currency>

This function searches for a list of currencies matching a given search filter.

listCustomer(SearchFilter, QueryLimit)

ListResult<CustomerDetails>

This function searches for a list of existing customers.

listExternalVMs(String)

List<ExternalVm>

List the external VMs for the given cluster

listInvoices(SearchFilter, QueryLimit)

ListResult<Invoice>

This function searches for a list of invoices matching a given search filter.

listPermissions(SearchFilter, QueryLimit)

ListResult<Permission>

This function will fetch a list of permissions matching the specified filter conditions.

listProductOffers(SearchFilter, QueryLimit, String)

ListResult<ProductOffer>

This function searches for a list of product offers matching a given search filter.

listProductPurchases(SearchFilter, QueryLimit)

ListResult<ProductPurchase>

This function searches for a list of product purchases matching a given search filter.

listProducts(SearchFilter, QueryLimit)

ListResult<Product>

This function will list the available products

listPromoCode(SearchFilter, QueryLimit)

ListResult<PromoCode>

This function will return list of promotion codes which meets the filter criteria.

listReferralPromoCode(SearchFilter, QueryLimit)

ListResult<ReferralPromoCode>

This function will return list of referral promocodes which meets the filter criteria.

listResources(SearchFilter, QueryLimit, ResourceType)

ListResult<PseudoResource>

This Operation will return list of resources after satisfying the filter conditions

listStatementDetail(SearchFilter, QueryLimit)

ListResult<StatementDetail>

This function searches for a list of statement details matching a given search filter.

listUnitTransactions(SearchFilter, QueryLimit)

ListResult<UnitTransaction>

This function searches for a list of unit transactions.

listUnitTransactionSummary(SearchFilter, QueryLimit)

ListResult<UnitTransactionSummary>

This function searches for a list of unit transaction summaries matching a given search filter.

listUser(SearchFilter, QueryLimit)

ListResult<UserDetails>

This function searches for a list of existing users.

listValidProductOffers(SearchFilter, QueryLimit, String)

ListResult<ProductOffer>

This function searches for a list of active product offers matching a given search filter.

lockUser(String, String)

boolean

This function will move a user into the Locked group.

markInvoiceStatus(String, InvoiceStatus, String, Date)

Job

This function marks an existing invoice status either pending, paid, unpaid or void.

markProductPurchaseInactive(String[])

boolean

This function marks an existing product purchase as invalid.

mergeStorageGroup(String, String, Date)

Job

This function will merge two existing storage groups.

migrateServer(String, String, Date)

Job

This function will start a job to migrate a running server from one node to the specified compute node

modifyBlob(Blob, Date)

Job

This function will modify the a blob.

modifyCluster(Cluster, Date)

Job

This function updates a cluster object with the supplied details.

modifyFDLCodeBlock(FDLCodeBlock, Date)

Job

This function will modify the unsigned block of an existing FDL code block.

modifyPaymentMethod(PaymentMethod, Date)

Job

This function will modify the state of a payment method.

modifyPaymentProvider(PaymentProvider, Date)

Job

This function will modify the state of a payment provider.

modifyPluggableResource(PluggableResource, Date)

Job

This function will start a job that will modify a Pluggable Resource and return the job reference.

modifyProduct(Product, Date)

Job

This function will modify a products description or active state.

modifyProductOffer(ProductOffer, Date)

Job

This function will modify and return modified product offer.

modifyResource(Resource, Date)

Job

This function will modify an existing resource object.

modifyServiceNetwork(Network, Date)

Job

This function will allow you to modify an existing service network

modifyStorageGroup(StorageGroup, Date)

Job

This function will modify an existing storage group.

modifyTranslation(Translation, Date)

Job

Modify a Translation object.

openVNCConnection(String, VNCHandler)

VNCConnection

This function will open virtual network connection for a given server.

processCallback(String, String, String, CallbackParams)

CallbackParams

Handles a payment callback.

publishImage(String, String, Boolean, Date)

Job

This function will publish an image to a customer, Billing Entity or the platform as a whole.

publishResource(String, String, Boolean, Date)

Job

This function will publish an image to a Customer or a Billing Entity.

purchaseProduct(String, String, String)

ProductPurchase

This function will create a new product purchase.

purchaseProductOffer(String, String, String, String, Boolean)

Resource

This function will purchase a product offer for the specified resource (normally being a customer).

purchaseUnits(String, String, Double, String, String)

Job

This function will purchase the specified number of units using the payment method instance

refundTransaction(String, double, String, boolean)

Job

Refund a transaction, in part or in-full.

removeCluster(int, Date)

Job

Removes the record for the specified cluster

removeImportedIPAddress(String)

boolean

This function will remove an imported external IP address

removeImportedSubnet(String)

boolean

This function will remove an imported subnet

removeKey(String, ResourceKey, String)

Resource

This Operation will remove keys from the given resource object.

removeUserFromCustomer(String, String, Date)

Job

This function will remove a user from a customer.

renderInvoice(String, String)

String

This function will return Invoice/Credit note PDF in Base64 format or in HTML fromat

renewAuthenticationToken(String, Long)

boolean

Manully renew an authentication trigger for the specified number of seconds.

resourceInvalidations(long, String[], String[], String[], String[])

InvalidationQueryResult

This function will return the resource which have been changed after a given time, specified by fromTime paramerter.

revokeImage(String, String, Boolean, Date)

Job

This function will revoke an image from an authoritative entity i.e. Customer or Billing.

revokeResource(String, String, Boolean, Date)

Job

This function will revoke a resource from an authoritative entity i.e. Customer or Billing.

sendEmail(CustomerEmail)

boolean

This function will send out an email dependent upon the input parameters passed.

setKeysByType(String, ResourceKeyType, KeyList, String)

Resource

This Operation will add a set of resource keys to the given resource.

setLinkedProductOffer(String, String, Date)

Job

This function associates a chargeable product offer to a resource.

setOSProductOffer(String, String, Date)

Job

This function asoociates a chargeable OS product offer to an image.

setServiceNetworkFirewallTemplate(String, FirewallTemplate, Date)

Job

This function will create, delete, or modify a firewall template attached to a service network.

signFDLCodeBlock(String, Date)

Job

This function will start a job that will sign the specified FDL code block.

substituteAllProductPurchases(List<String>, String, String, Date)

Job

This function will substitute the existing purchases for a given product offer with another product offer.

unlockUser(String, String)

boolean

This function will remove a user from the Locked group.

updateBillingEntity(BillingEntityDetails, Date)

Job

This function updates a billing entity object with the supplied details.

updateCustomer(CustomerDetails, Date)

Job

This function will update an existing customer using the supplied fields.

updateEmailTemplate(EmailTemplate)

EmailTemplate

This function will update an email template object.

updatePromotion(Promotion, Date)

Job

This function will update an existing promotion object.

updateReferralPromoCode(ReferralPromoCode)

ReferralPromoCode

This function will update an existing referral promo code with the changed field.

updateReferralPromotion(ReferralPromotion, Date)

Job

This function will update an existing ReferralPromotion with the changed fields

updateUser(UserDetails, String, String, Date)

Job

This function will update a user's details

validateCustomer(String, String)

boolean

This function sets the validation string to a customer.

verifyUserPassword(String, String, String)

boolean

This Operation will verify a user's authentication details.

waitForJob(String, Boolean)

Job

This function will wait for a job to complete.

FDL User API Functions

Name

Return Type

Description

addIP(String, String, boolean, Date)

Job

This function will add an IP address to a network interface.

addKey(String, ResourceKey)

Resource

This function will add keys to the given resource object.

addToFavourites(ResourceType, String)

SimpleResource

This function adds a resource on to the favourites list.

addUserToGroup(String, String, Date)

Job

This function adds a user to the specified group.

applyFirewallTemplate(String, String, Date)

Job

This function will apply a firewall template to a given IP address.

attachDisk(String, String, int, Date)

Job

This function will attach a disk to an existing server.

attachNetworkInterface(String, String, int, Date)

Job

This function will attach a network interface to a given server.

attachSSHKey(String, String, Date)

Job

This function will attach an SSH key to a given server.

attachSubnet(String, String, Date)

Job

This function will attach a subnet an existing network.

cancelJob(String)

Job

This function will cancel a job.

cancelProductPurchase(String, Date)

Job

This function cancels an active purchase. This will only be applicable for UNIT purchaes

cancelTransaction(String, Date)

Job

Cancels a transaction.

changeDeploymentInstanceStatus(String, DeploymentInstanceStatus, boolean, ResourceMetadata, Date)

Job

This function will change the state of (start, stop, kill or reboot) resources in the deployment instance.

changeServerStatus(String, ServerStatus, boolean, ResourceMetadata, Date)

Job

This function will change the state of (start, stop, kill or reboot) a server.

checkPermissions(String, List<CapabilityAction>)

MapHolder

This function will determine whether the specified actions would be permitted for a resource.

cloneResource(String, String, String, Date)

Job

This function will clone a snapshot resource.

createAPIKeyUser(UserDetails, String, Boolean, Date)

Job

Create an API Key User for the current customer.

createBlob(Blob, Date)

Job

This function will create a blob.

createDeploymentTemplate(DeploymentTemplate, Date)

Job

This function will create a deployment template object.

createDeploymentTemplateFromInstance(String, Date)

Job

This function will create deployment template from deployment instance.

createDisk(Disk, FetchParameters, Date)

Job

This function will create a disk, and optionally attach it to a server.

createFirewallTemplate(FirewallTemplate, Date)

Job

This function will create a firewall template.

createGroup(Group, Date)

Job

This function will create a new empty group.

createImage(Image, FetchParameters, Date)

Job

This function will create an image from a server or disk.

createNetwork(Network, Date)

Job

This function will create a network.

createNetworkInterface(Nic, Date)

Job

This function will create a network interface.

createPaymentMethodInstance(PaymentMethodInstance, List<Value>, boolean, String, Date)

Job

Creates a payment method instance

createPluggableResource(PluggableResource, Date)

Job

This function will start a job that will create a Pluggable Resource and return the job reference.

createReferralPromoCode(ReferralPromoCode)

ReferralPromoCode

This function will return a the newly created Referral promocode Object.

createServer(Server, List<String>, FetchParameters, Date)

Job

This function will create a server using the supplied skeleton object.

createSnapshot(Snapshot, Date)

Job

This function will create a snapshot object from a disk or a server.

createSSHKey(SSHKey, Date)

Job

This function will create an ssh key.

createSubnet(Subnet, Date)

Job

This function will create a subnet.

createVDC(VDC, Date)

Job

This function will create a virtual data centre.

deleteAuthenticationToken(String)

boolean

Revoke API access when using the specified authentication token.

deleteReferralPromoCode(String)

boolean

This function will remove the given referral promo code.

deleteResource(String, boolean, Date)

Job

This function will delete an existing resource object.

deleteUserFromGroup(String, String, Date)

Job

This function will remove a user from the specified group, or all groups if the group UUID is null.

deployTemplate(DeploymentInstance, Date)

Job

This function will deploy a template object.

describeResource(Resource)

List<ProductComponentType>

Gets the Product Component Types that define an resource.

detachDisk(String, String, Date)

Job

This function will detach a disk from an existing server.

detachNetworkInterface(String, String, Date)

Job

This function will detach a network interface from a given server.

detachSSHKey(String, String, Date)

Job

This function will detach an SSH key to a given server.

doQuery(Query)

QueryResult

This function will query the database, aggregating and grouping results if relevant.

dryRunTemplate(DeploymentInstance, Date)

DryRunResult

This function will do a dry run on the deployment instance to check if template can be deployed.

fetchDisk(Disk, FetchParameters, Date)

Job

This function will fetch a disk over the internet, using the parameters supplied.

fetchResource(VirtualResource, FetchParameters, Long, Date)

Job

This function will fetch a resource (such as a disk, image or server) over the internet, using the parameters supplied.

fetchServer(Server, FetchParameters, Date)

Job

This function will fetch a server over the internet, using the parameters supplied.

getAuthenticationToken(Long, Boolean)

AuthenticationToken

Gets an API authentication token for the currently authenticated user/customer combination.

getBlobContent(String)

String

This function will return blob content for a given blob

getCompiledTranslationMap(String)

MapHolder

Gets the compiled value of a Translation object.

getHypervisorConfig(String)

MapHolder

This function returns the hypervisor specific settings for a cluster

getMeasuredValues(String[], String[], long)

ArrayList<MeasuredValue>

This function will return a list of measured values close to a given time stamp.

getProductOfferForResource(String, ResourceType, Boolean)

ProductOffer

Gets the product offer associated with the specified resource

getResource(String, ResourceType, Boolean)

PseudoResource

Gets a resource of the given type with the specified UUID.

getResourceTypes()

MapHolder

This function will return list of available resource types.

getTranslationForUser(String[])

Translation

Get the Translation associated with the authenticed User.

invokeAction(String, String, String, List<Value>, Date)

Object

This function will start a job that will invoke an action for a resouce.

invokeActionSync(String, String, String, List<Value>)

Object

This function will start a job that will invoke an action for a resouce.

invokeHypervisorAction(String, String, List<Value>, Date)

Job

This function will start a job that will invoke a hypervisor specifiec action for a resouce.

isPermitted(String, Permission)

boolean

This function will determine whether a specified action on a resource would be permitted.

listFavourites(ResourceType)

ListResult<SimpleResource>

This function list current user's favourites list. Optionally can be filtered by resource type

listPermissions(SearchFilter, QueryLimit)

ListResult<Permission>

This function will fetch a list of permissions matching the specified filter conditions.

listProductPurchases(SearchFilter, QueryLimit)

ListResult<ProductPurchase>

This function will list the product purchases matching a given filter.

listReferralPromoCode(SearchFilter, QueryLimit)

ListResult<ReferralPromoCode>

This function will return list of referral promocodes which meets the filter criteria.

listResourceKeysForResource(String)

ListResult<ResourceKey>

List the resource keys for the given resource.

listResources(SearchFilter, QueryLimit, ResourceType)

ListResult<PseudoResource>

This function will return list of resources after satisfying a filter.

listStatementDetail(SearchFilter, QueryLimit)

ListResult<StatementDetail>

This function will list the statement details matching a given filter.

listUnitTransactions(SearchFilter, QueryLimit)

ListResult<UnitTransaction>

This function will list the unit transactions matching a given filter.

listUnitTransactionSummary(SearchFilter, QueryLimit)

ListResult<UnitTransactionSummary>

This function will list the unit transaction summaries matching a given filter.

lockUser(String, Date)

Job

This function will move a user into the Locked group.

modifyBlob(Blob, Date)

Job

This function will modify the a blob.

modifyDeploymentInstance(DeploymentInstance, Date)

Job

This function will modify deployment instance.

modifyDeploymentTemplate(DeploymentTemplate, Date)

Job

This function will modify deployment template.

modifyDisk(Disk, Date)

Job

This function will modify a disk object.

modifyFirewall(Firewall, Date)

Job

This function will modify a firewall.

modifyFirewallTemplate(FirewallTemplate, Date)

Job

This function will modify a firewall template

modifyGroup(Group, Date)

Job

This function will modify a group.

modifyImage(Image, Date)

Job

This function will modify an image.

modifyKey(String, ResourceKey)

Resource

This function will modify an existing resource key for a given resource object.

modifyNetwork(Network, Date)

Job

This function will modify a network object.

modifyNetworkInterface(Nic, Date)

Job

This function will modify a network interface.

modifyPaymentMethodInstance(PaymentMethodInstance, Date)

Job

This function will modify a payment method instance.

modifyPluggableResource(PluggableResource, Date)

Job

This function will start a job that will modify a Pluggable Resource and return the job reference.

modifyResource(VirtualResource, Date)

Job

This function will modify an existing resource object.

modifyServer(Server, Date)

Job

This function will modify an existing server object.

modifySnapshot(Snapshot, Date)

Job

This function will modify an existing snapshot.

modifySSHKey(SSHKey, Date)

Job

This function will modify an ssh key.

modifySubnet(Subnet, Date)

Job

This function will modify a subnet.

modifyVDC(VDC, Date)

Job

This function will modify virtual data centre.

openVNCConnection(String, VNCHandler)

VNCConnection

This function will open virtual network connection for a given server.

payInvoice(String, String, boolean, String, Date)

Job

This function marks an existing invoice status either pending,paid,unpaid or void.

publishImage(String, String, Boolean, Date)

Job

This function will publish an image to a Customer or a Billing Entity.

publishResource(String, String, Boolean, Date)

Job

This function will publish an image to a Customer or a Billing Entity.

purchaseUnits(String, String, Double, String, Boolean)

Resource

This function will purchase the specified number of units using the payment method instance.

removeFromFavourites(ResourceType, String)

boolean

This function removes a resource on to the favourites list.

removeIP(String, String, Date)

Job

This function will remove an IP address from a network interface.

removeKey(String, ResourceKey)

Resource

This function will remove keys from the given resource object.

renderInvoice(String, String)

String

This function will return Invoice/Credit note PDF in Base64 format or in HTML fromat

renewAuthenticationToken(String, Long)

boolean

Manully renew an authentication trigger for the specified number of seconds.

resourceInvalidations(long, String[], String[])

InvalidationQueryResult

This function will return the resource which have been changed after a given time, specified by fromTime paramerter.

resumeTransaction(String, Date)

Job

Resumes a transaction which was awaiting interactive input.

revertToResource(String, String, Date)

Job

This function will revert all the changes of a resource object, back to its template.

revokeImage(String, String, Boolean, Date)

Job

This function will revoke the publication of an image to a Customer or Billing Entity.

revokeResource(String, String, Boolean, Date)

Job

This function will revoke the publication of an image/template to a Customer or Billing Entity.

setPermissions(String, List<Permission>)

boolean

This function will set the capabilities for the specified group or user on a specific resource.

setUserKeys(String, KeyList)

Resource

This Operation will add a set of resource keys of user type to the given resource.

testPaymentMethod(String, Date)

Job

Tests a payment method.

unlockUser(String, Date)

Job

This function will remove a user from the Locked group.

updateCustomer(CustomerDetails, Date)

Job

This function will update an existing customer using the supplied fields.

updateMetadata(String, ResourceMetadata)

boolean

This function will update the metadata attached to a resource.

updateUser(UserDetails, String, String, Date)

Job

This function will update a user's details.

waitForJob(String, boolean)

Job

This function will wait for a job to complete.

  • No labels