connect.models.TierConfigRequest - Haxe SDK Documentation

This class represents a request on a TierConfig

Static methods

`staticget(id:String):TierConfigRequest`

Returns:

The TierConfigRequest with the given id, or null if it was not found.

`staticlist(filters:Query):Collection<TierConfigRequest>`

Lists all TierConfigRequests that match the given filters. Supported filters are:

type (=, in)
status (=, in)
id (=, in)
configuration__id (=, in)
configuration__tier_level (=, in)
configuration__account__id (=, in)
configuration__product__id (=, in)
assignee__id (=)
unassigned (bool)
configuration__account__external_uid (=)

Returns:

A Collection of TierConfigRequests.

Constructor

`new()`

Variables

`activation:Activation`

Activation object. This is created only if TCR has ordering parameters and seen in inquiring state of the TCR.

`configuration:TierConfig`

Full representation of TierConfig Object.

`notes:String`

TCR pending notes. Notes can be modified only in Pending state.

`params:Collection<Param>`

List of parameter data objects as in Asset Object. Params can be modified only in Pending state.

`parentConfiguration:TierConfig`

Full representation of parent TierConfig.

`product:Product`

Reference object to product (application).

`reason:String`

Failing reason. This is filled only if TCR is failed.

`status:String`

TCR current status. One of: tiers_setup, pending, inquiring, approved, failed.

`template:Template`

Template Object. This is filled only if TCR is approved.

`tierLevel:Null<Int>`

Tier level for product from customer perspective (1 or 2).

`type:String`

TCR type. One of: setup, update.

Methods

`approveByTemplate(id:String):Bool`

Changes this TierConfigRequest status to "approved", sending the id of a Template to render on the portal.

When processing requests within a Flow, you should use the Flow.approveByTemplate method instead of this one, since it finishes the flow and logs the information.

`assign():Bool`

Assigns this TierConfigRequest.

`fail(reason:String):Bool`

Changes the status of this TierConfigRequest to "failed".

When processing requests within a Flow, you should use the Flow.fail method instead of this one, since it finishes the flow and logs the information.

`getParamById(paramId:String):Param`

Returns:

The Param with the given id, or null if it was not found.

`inquire():Bool`

Changes the status of this TierConfigRequest to "inquiring".

When processing requests within a Flow, you should use the Flow.inquire method instead of this one, since it finishes the flow and logs the information.

`pend():Bool`

Changes the status of this TierConfigRequest to "pending".

When processing requests within a Flow, you should use the Flow.pend method instead of this one, since it finishes the flow and logs the information.

`register():TierConfigRequest`

Registers a new TierConfigRequest on Connect, based on the data of this TierConfigRequest, which should have a value at least in the following fields:

configuration.product.id
configuration.connection.id (not required on preview)
configuration.marketplace.id (only available for preview)
configuration.account.id
configuration.parentAccount.id (optional)
configuration.parentAccount.externalUid (optional)
configuration.tierLevel
configuration.params (id and value of given params)

Returns:

The new TierConfigRequest, or null if it couldn't be created.

`unassign():Bool`

Unassigns this TierConfigRequest.

`update(params:Collection<Param>):TierConfigRequest`

Updates the TierConfigRequest in the server with the data changed in this model.

If no parameters are specified for updating, you should reassign your request with the object returned by this method, so the next time you call update on the object, the SDK knows the fields that already got updated in a previous call, like this:

request = request.update(null);

Parameters:

`params`	A collection of parameters to update. If `null` is passed, then the parameters that have changed in the request will be sent.

Returns:

The TierConfigRequest returned from the server, which should contain the same data as this TierConfigRequest, or null if the updating fails.

class TierConfigRequest

package connect.models

extends IdModel › Model

Static methods

staticget(id:String):TierConfigRequest

staticlist(filters:Query):Collection<TierConfigRequest>

Constructor

new()

Variables

account:TierAccount

activation:Activation

assignee:User

configuration:TierConfig

contract:Contract

environment:String

events:Events

marketplace:Marketplace

notes:String

params:Collection<Param>

parentConfiguration:TierConfig

product:Product

reason:String

status:String

template:Template

tierLevel:Null<Int>

tiers:Tiers

type:String

Methods

approveByTemplate(id:String):Bool

assign():Bool

fail(reason:String):Bool

getParamById(paramId:String):Param

inquire():Bool

pend():Bool

register():TierConfigRequest

unassign():Bool

update(params:Collection<Param>):TierConfigRequest

Inherited Variables

Defined by IdModel

id:String

Inherited Methods

Defined by Model

toObject():Dynamic

toString():String

`staticget(id:String):TierConfigRequest`

`staticlist(filters:Query):Collection<TierConfigRequest>`

`new()`

`account:TierAccount`

`activation:Activation`

`assignee:User`

`configuration:TierConfig`

`contract:Contract`

`environment:String`

`events:Events`

`marketplace:Marketplace`

`notes:String`

`params:Collection<Param>`

`parentConfiguration:TierConfig`

`product:Product`

`reason:String`

`status:String`

`template:Template`

`tierLevel:Null<Int>`

`tiers:Tiers`

`type:String`

`approveByTemplate(id:String):Bool`

`assign():Bool`

`fail(reason:String):Bool`

`getParamById(paramId:String):Param`

`inquire():Bool`

`pend():Bool`

`register():TierConfigRequest`

`unassign():Bool`

`update(params:Collection<Param>):TierConfigRequest`

`id:String`

`toObject():Dynamic`

`toString():String`