"use strict";
export class RuleValidationResult {
/** @param {{RuleCode?:string,Message?:string,Key?:string,Tag?:string,ErrorCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
RuleCode;
/** @type {string} */
Message;
/** @type {string} */
Key;
/** @type {string} */
Tag;
/** @type {string} */
ErrorCode;
}
export class ValidationErrorList {
/** @param {{ValidationErrors?:RuleValidationResult[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {RuleValidationResult[]} */
ValidationErrors;
}
export class SubscriptionLinkContact {
/** @param {{ContactId?:string,ContactAlternateKey?:string,RoleId?:string,RoleAlternateKey?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Guid of the contact object within Eros. */
ContactId;
/**
* @type {string}
* @description The unique key that represents the contact on the external system. */
ContactAlternateKey;
/**
* @type {string}
* @description Guid of the Role List Item object within Eros. */
RoleId;
/**
* @type {string}
* @description The unique key that represents the role type on the external system. Note: Use of this is not currently implemented */
RoleAlternateKey;
}
export class SubscriptionContactGroupConnectionModel extends SubscriptionLinkContact {
/** @param {{Index?:number,MarkAsDeleted?:boolean,ContactId?:string,ContactAlternateKey?:string,RoleId?:string,RoleAlternateKey?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {number}
* @description The order this contact is in priority. 1 would be the primary contact, 2 the secondary and so forth. */
Index;
/**
* @type {boolean}
* @description Set this to be true if the contact connection to the group is to be deleted */
MarkAsDeleted;
}
export class SubscriptionContactGroupModel {
/** @param {{ContactGroupName?:string,GroupRoleId?:string,RoleAlternateKey?:string,ContactConnections?:SubscriptionContactGroupConnectionModel[],MarkAsDeleted?:boolean,MarkAsArchived?:boolean,MarkAsRestored?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description A name for the contact group. */
ContactGroupName;
/**
* @type {string}
* @description Guid of the Role List Item object within Eros that defines the role of the group. */
GroupRoleId;
/**
* @type {string}
* @description The unique key that represents the role type of the group on the external system. Note: Use of this is not currently implemented */
RoleAlternateKey;
/**
* @type {SubscriptionContactGroupConnectionModel[]}
* @description A list of ContactGroupConnection records that link contacts (and their role in the contact group) to the contact group. */
ContactConnections;
/**
* @type {boolean}
* @description Set this to be true if the contact group is to be deleted */
MarkAsDeleted;
/**
* @type {boolean}
* @description Set this to be true if the contact group is to be archived */
MarkAsArchived;
/**
* @type {boolean}
* @description Set this to be true if the contact group is to be restored */
MarkAsRestored;
}
export class SaveContactGroup extends ValidationErrorList {
/** @param {{SuiteDataSourceInstanceId?:string,AlternateKey?:string,ObjectId?:string,IgnoreHash?:boolean,ContactGroup?:SubscriptionContactGroupModel,IgnoreValidation?:boolean,LicenseeId?:string,SessionId?:string,ValidationErrors?:RuleValidationResult[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description Guid representing the external systems datasource information. */
SuiteDataSourceInstanceId;
/**
* @type {string}
* @description The unique key that represents the contact group on the external system. */
AlternateKey;
/**
* @type {string}
* @description Guid of the contact group object within Eros. If ObjectId is known, the external system may pass this insted of the alternate key. */
ObjectId;
/**
* @type {boolean}
* @description If set to true, the object will be updated/refreshed. If false, the hash representation of the ContactGroup model and its data will be compared with the current ContactGroup to determine if there are any changes to save. */
IgnoreHash;
/**
* @type {SubscriptionContactGroupModel}
* @description Object containing all details of the contact group to be inserted or updated. */
ContactGroup;
/** @type {boolean} */
IgnoreValidation;
/** @type {string} */
LicenseeId;
/** @type {string} */
SessionId;
}
JavaScript SaveContactGroup DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /jsv/reply/SaveContactGroup HTTP/1.1
Host: production-eros-platform-apisubscription.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
AlternateKey: String,
IgnoreHash: False,
ContactGroup:
{
ContactGroupName: String,
RoleAlternateKey: String,
ContactConnections:
[
{
Index: 0,
MarkAsDeleted: False,
ContactAlternateKey: String,
RoleAlternateKey: String
}
],
MarkAsDeleted: False,
MarkAsArchived: False,
MarkAsRestored: False
},
IgnoreValidation: False,
ValidationErrors:
[
{
RuleCode: String,
Message: String,
Key: String,
Tag: String,
ErrorCode: String
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}