public class

ZuoraModule

extends Object
java.lang.Object
   ↳ org.mule.modules.zuora.ZuoraModule
Known Direct Subclasses
Known Indirect Subclasses

Summary

Fields
private ZuoraClient<ZuoraException> client
private String endpoint
Public Constructors
ZuoraModule()
Public Methods
List<AmendResult> amend(ZuoraSession session, List<AmendRequest> amendaments)
Amends subscriptions

<amend amendaments-ref="#[header:amendamentsList]"/>

List<SaveResult> create(ZuoraSession session, ZObjectType type, List<Map<String, Object>> zobjects)
Batch creation of ZObjects

<create> <zobjects> <zobject ref="#[variable:anObject]"/> </zobject> </create>

ZuoraSession createSession(String username, String password)
List<DeleteResult> delete(ZuoraSession session, ZObjectType type, List<String> ids)
Batch delete of ZObjects

<delete ids-ref="#[variable:ids]" type="#[variable:zobjectType]"/>

void destroySession(ZuoraSession session)
Iterable<ZObject> find(ZuoraSession session, String zquery)
Lazily retrieves ZObject that match a given query, written in Zuora native query language

<find query="#[header:queryString]" />

List<SaveResult> generate(ZuoraSession session, ZObjectType type, List<Map<String, Object>> zobjects)
Batch creation of invoces for accounts

<generate zobjects-ref="#[variable:accounts]"/>

String getEnpoint()
User getUserInfo(ZuoraSession session)
Answers user information

<get-user-info userId="#[header:userId]""/>

void setEndpoint(String enpoint)
List<SubscribeResult> subscribe(ZuoraSession session, List<SubscribeRequest> subscriptions)
Batch creation of ZObjects associated to Subscriptions

<subscribe subscriptions-ref="#[variable:subscribtions]"/>

List<SaveResult> update(ZuoraSession session, ZObjectType type, List<Map<String, Object>> zobjects)
Batch update of ZObjects

<update zobjects-ref="#[variable:objects]"/>

[Expand]
Inherited Methods
From class java.lang.Object

Fields

private ZuoraClient<ZuoraException> client

private String endpoint

Public Constructors

public ZuoraModule ()

Public Methods

public List<AmendResult> amend (ZuoraSession session, List<AmendRequest> amendaments)

Amends subscriptions

<amend amendaments-ref="#[header:amendamentsList]"/>

Returns
  • a list of AmmendResults, one for each amendament
Throws
ZuoraException

public List<SaveResult> create (ZuoraSession session, ZObjectType type, List<Map<String, Object>> zobjects)

Batch creation of ZObjects

<create> <zobjects> <zobject ref="#[variable:anObject]"/> </zobject> </create>

Parameters
type the type of zobject passed
zobjects the zobjects to create
Returns
  • a list of SaveResult, one for each ZObject
Throws
ZuoraException

public ZuoraSession createSession (String username, String password)

public List<DeleteResult> delete (ZuoraSession session, ZObjectType type, List<String> ids)

Batch delete of ZObjects

<delete ids-ref="#[variable:ids]" type="#[variable:zobjectType]"/>

Parameters
type the type of ZObjects to delete
Returns
  • a list of DeleteResults, one for each id
Throws
ZuoraException

public void destroySession (ZuoraSession session)

public Iterable<ZObject> find (ZuoraSession session, String zquery)

Lazily retrieves ZObject that match a given query, written in Zuora native query language

<find query="#[header:queryString]" />

Returns
  • a ZObjects iterable. ZObjects returned by this operation may be instances of either StaticZObject - like Account or Amendment -, if the object is a non-customizable Zuora entity, or ZObject, if the object is a customizable Zuora entity
Throws
ZuoraException

public List<SaveResult> generate (ZuoraSession session, ZObjectType type, List<Map<String, Object>> zobjects)

Batch creation of invoces for accounts

<generate zobjects-ref="#[variable:accounts]"/>

Parameters
type the type of zobject passed
zobjects the zobjects to generate, as a list of string-object maps . Zuora attribute names, unlike java beans, are CamelCase.
Returns
  • a list of SaveResult, one for each ZObject
Throws
ZuoraException

public String getEnpoint ()

public User getUserInfo (ZuoraSession session)

Answers user information

<get-user-info userId="#[header:userId]""/>

Returns
  • a User
Throws
ZuoraException

public void setEndpoint (String enpoint)

public List<SubscribeResult> subscribe (ZuoraSession session, List<SubscribeRequest> subscriptions)

Batch creation of ZObjects associated to Subscriptions

<subscribe subscriptions-ref="#[variable:subscribtions]"/>

Returns
  • a subscription results list, one for each subscription
Throws
ZuoraException

public List<SaveResult> update (ZuoraSession session, ZObjectType type, List<Map<String, Object>> zobjects)

Batch update of ZObjects

<update zobjects-ref="#[variable:objects]"/>

Parameters
type the type of zobject passed
zobjects the zobjects to update, as a list of string-object maps . Zuora attribute names, unlike java beans, are CamelCase.
Returns
  • a list of SaveResult, one for each ZObject
Throws
ZuoraException