ZuoraModule | Mule Zuora Cloud Connector

Summary: Configuration | Message Processors

Namespace	http://repository.mulesoft.org/releases/org/mule/modules/mule-module-zuora
Schema Location	http://repository.mulesoft.org/releases/org/mule/modules/mule-module-zuora/1.0/mule-zuora.xsd
Version	1.0

Summary

Configuration
<zuora:config> Configure an instance of this module

Message Processors
<zuora:amend> Amends subscriptions `<amend amendaments-ref="#[header:amendamentsList]"/>`
<zuora:create> Batch creation of ZObjects `<create> <zobjects> <zobject ref="#[variable:anObject]"/> </zobject> </create>`
<zuora:delete> Batch delete of ZObjects `<delete ids-ref="#[variable:ids]" type="#[variable:zobjectType]"/>`
<zuora:find> Lazily retrieves ZObject that match a given query, written in Zuora native query language `<find query="#[header:queryString]" />`
<zuora:generate> Batch creation of invoces for accounts `<generate zobjects-ref="#[variable:accounts]"/>`
<zuora:get-user-info> Answers user information `<get-user-info userId="#[header:userId]""/>`
<zuora:subscribe> Batch creation of ZObjects associated to Subscriptions `<subscribe subscriptions-ref="#[variable:subscribtions]"/>`
<zuora:update> Batch update of ZObjects `<update zobjects-ref="#[variable:objects]"/>`

Configuration

This module is configured using the config element. This element must be placed outside of your flows and at the root of your Mule application. You can create as many configurations as you deem necesary as long as each carries its own name.

Each message processor, message source or transformer carries a config-ref attribute that allows the invoker to specify which configuration to use.

Attributes
Type	Name	Default Value	Description
xs:string	name		Optional. Give a name to this configuration so it can be later referenced.
	client		Optional.
xs:string	endpoint
xs:string	password
xs:string	username

Message Processors

<zuora:amend>

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

Attributes

config-ref	Optional. Specify which configuration to use for this invocation.

Return Payload

a list of AmmendResults, one for each amendament

<zuora:create>

Batch creation of ZObjects <create> <zobjects> <zobject ref="#[variable:anObject]"/> </zobject> </create>

Attributes

config-ref	Optional. Specify which configuration to use for this invocation.
type	the type of zobject passed
zobjects	the zobjects to create

Return Payload

a list of SaveResult, one for each ZObject

<zuora:delete>

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

Attributes

config-ref	Optional. Specify which configuration to use for this invocation.
type	the type of ZObjects to delete

Return Payload

a list of DeleteResults, one for each id

<zuora:find>

Lazily retrieves ZObject that match a given query, written in Zuora native query language <find query="#[header:queryString]" />

Attributes

config-ref	Optional. Specify which configuration to use for this invocation.

Return Payload

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

<zuora:generate>

Batch creation of invoces for accounts <generate zobjects-ref="#[variable:accounts]"/>

Attributes

config-ref	Optional. Specify which configuration to use for this invocation.
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.

Return Payload

a list of SaveResult, one for each ZObject

<zuora:get-user-info>

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

Attributes

config-ref	Optional. Specify which configuration to use for this invocation.

Return Payload

a User

<zuora:subscribe>

Batch creation of ZObjects associated to Subscriptions <subscribe subscriptions-ref="#[variable:subscribtions]"/>

Attributes

config-ref	Optional. Specify which configuration to use for this invocation.

Return Payload

a subscription results list, one for each subscription

<zuora:update>

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

Attributes

config-ref	Optional. Specify which configuration to use for this invocation.
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.

Return Payload

a list of SaveResult, one for each ZObject