/* Options:
Date: 2025-09-14 06:46:49
SwiftVersion: 6.0
Version: 8.52
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://production-eros-platform-apisubscription.azurewebsites.net/api

//BaseClass: 
//AddModelExtensions: True
//AddServiceStackTypes: True
//MakePropertiesOptional: True
IncludeTypes: SaveContactGroup.*
//ExcludeTypes: 
//ExcludeGenericBaseTypes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
//InitializeCollections: False
//TreatTypesAsStrings: 
//DefaultImports: Foundation,ServiceStack
*/

import Foundation
import ServiceStack

/**
* Inserts or Updates a contact group and its contact connections.
*/
// @Api(Description="Inserts or Updates a contact group and its contact connections.")
public class SaveContactGroup : ValidationErrorList, IReturn, ISubscription
{
    public typealias Return = ResponseStatus

    /**
    * Guid representing the external systems datasource information.
    */
    // @ApiMember(DataType="Guid", Description="Guid representing the external systems datasource information.", IsRequired=true, Name="SuiteDataSourceInstanceId", ParameterType="query")
    public var suiteDataSourceInstanceId:String?

    /**
    * The unique key that represents the contact group on the external system.
    */
    // @ApiMember(DataType="string", Description="The unique key that represents the contact group on the external system.", IsRequired=true, Name="AlternateKey", ParameterType="query")
    public var alternateKey:String?

    /**
    * Guid of the contact group object within Eros.  If ObjectId is known, the external system may pass this insted of the alternate key.
    */
    // @ApiMember(DataType="Guid", Description="Guid of the contact group object within Eros.  If ObjectId is known, the external system may pass this insted of the alternate key.", Name="ObjectId", ParameterType="query")
    public var objectId:String?

    /**
    * 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.
    */
    // @ApiMember(DataType="bool", 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.", Name="IgnoreHash")
    public var ignoreHash:Bool?

    /**
    * Object containing all details of the contact group to be inserted or updated.
    */
    // @ApiMember(DataType="SubscriptionContactGroupModel", Description="Object containing all details of the contact group to be inserted or updated.", IsRequired=true, Name="ContactGroup", ParameterType="query")
    public var contactGroup:SubscriptionContactGroupModel?

    public var ignoreValidation:Bool?
    public var licenseeId:String?
    public var sessionId:String?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case suiteDataSourceInstanceId
        case alternateKey
        case objectId
        case ignoreHash
        case contactGroup
        case ignoreValidation
        case licenseeId
        case sessionId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        suiteDataSourceInstanceId = try container.decodeIfPresent(String.self, forKey: .suiteDataSourceInstanceId)
        alternateKey = try container.decodeIfPresent(String.self, forKey: .alternateKey)
        objectId = try container.decodeIfPresent(String.self, forKey: .objectId)
        ignoreHash = try container.decodeIfPresent(Bool.self, forKey: .ignoreHash)
        contactGroup = try container.decodeIfPresent(SubscriptionContactGroupModel.self, forKey: .contactGroup)
        ignoreValidation = try container.decodeIfPresent(Bool.self, forKey: .ignoreValidation)
        licenseeId = try container.decodeIfPresent(String.self, forKey: .licenseeId)
        sessionId = try container.decodeIfPresent(String.self, forKey: .sessionId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if suiteDataSourceInstanceId != nil { try container.encode(suiteDataSourceInstanceId, forKey: .suiteDataSourceInstanceId) }
        if alternateKey != nil { try container.encode(alternateKey, forKey: .alternateKey) }
        if objectId != nil { try container.encode(objectId, forKey: .objectId) }
        if ignoreHash != nil { try container.encode(ignoreHash, forKey: .ignoreHash) }
        if contactGroup != nil { try container.encode(contactGroup, forKey: .contactGroup) }
        if ignoreValidation != nil { try container.encode(ignoreValidation, forKey: .ignoreValidation) }
        if licenseeId != nil { try container.encode(licenseeId, forKey: .licenseeId) }
        if sessionId != nil { try container.encode(sessionId, forKey: .sessionId) }
    }
}

public class SubscriptionContactGroupModel : Codable
{
    /**
    * A name for the contact group.
    */
    // @ApiMember(DataType="string", Description="A name for the contact group.", IsRequired=true, Name="ContactGroupName", ParameterType="query")
    public var contactGroupName:String?

    /**
    * Guid of the Role List Item object within Eros that defines the role of the group.
    */
    // @ApiMember(DataType="Guid", Description="Guid of the Role List Item object within Eros that defines the role of the group.", IsRequired=true, Name="GroupRoleId", ParameterType="query")
    public var groupRoleId:String?

    /**
    * The unique key that represents the role type of the group on the external system. Note: Use of this is not currently implemented
    */
    // @ApiMember(DataType="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", Name="RoleAlternateKey", ParameterType="query")
    public var roleAlternateKey:String?

    /**
    * A list of ContactGroupConnection records that link contacts (and their role in the contact group) to the contact group.
    */
    // @ApiMember(DataType="List<SubscriptionContactGroupConnectionModel>", Description="A list of ContactGroupConnection records that link contacts (and their role in the contact group) to the contact group.", Name="ContactConnections", ParameterType="query")
    public var contactConnections:[SubscriptionContactGroupConnectionModel]?

    /**
    * Set this to be true if the contact group is to be deleted
    */
    // @ApiMember(DataType="bool", Description="Set this to be true if the contact group is to be deleted", Name="MarkAsDeleted", ParameterType="query")
    public var markAsDeleted:Bool?

    /**
    * Set this to be true if the contact group is to be archived
    */
    // @ApiMember(DataType="bool", Description="Set this to be true if the contact group is to be archived", Name="MarkAsArchived", ParameterType="query")
    public var markAsArchived:Bool?

    /**
    * Set this to be true if the contact group is to be restored
    */
    // @ApiMember(DataType="bool", Description="Set this to be true if the contact group is to be restored", Name="MarkAsRestored", ParameterType="query")
    public var markAsRestored:Bool?

    required public init(){}
}

public class RuleValidationResult : Codable
{
    public var ruleCode:String?
    public var message:String?
    public var key:String?
    public var tag:String?
    public var errorCode:String?

    required public init(){}
}

public class ValidationErrorList : Codable
{
    public var validationErrors:[RuleValidationResult]?

    required public init(){}
}

public protocol ISubscription
{
    var suiteDataSourceInstanceId:String? { get set }
    var objectId:String? { get set }
    var alternateKey:String? { get set }
    var ignoreValidation:Bool? { get set }

}

public class SubscriptionContactGroupConnectionModel : SubscriptionLinkContact
{
    /**
    * The order this contact is in priority.  1 would be the primary contact, 2 the secondary and so forth.
    */
    // @ApiMember(DataType="int", Description="The order this contact is in priority.  1 would be the primary contact, 2 the secondary and so forth.", Name="Index", ParameterType="query")
    public var index:Int?

    /**
    * Set this to be true if the contact connection to the group is to be deleted
    */
    // @ApiMember(DataType="bool", Description="Set this to be true if the contact connection to the group is to be deleted", Name="MarkAsDeleted", ParameterType="query")
    public var markAsDeleted:Bool?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case index
        case markAsDeleted
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        index = try container.decodeIfPresent(Int.self, forKey: .index)
        markAsDeleted = try container.decodeIfPresent(Bool.self, forKey: .markAsDeleted)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if index != nil { try container.encode(index, forKey: .index) }
        if markAsDeleted != nil { try container.encode(markAsDeleted, forKey: .markAsDeleted) }
    }
}

public class SubscriptionLinkContact : Codable
{
    /**
    * Guid of the contact object within Eros.
    */
    // @ApiMember(DataType="Guid", Description="Guid of the contact object within Eros.", Name="ContactId", ParameterType="query")
    public var contactId:String?

    /**
    * The unique key that represents the contact on the external system.
    */
    // @ApiMember(DataType="string", Description="The unique key that represents the contact on the external system.", IsRequired=true, Name="ContactAlternateKey", ParameterType="query")
    public var contactAlternateKey:String?

    /**
    * Guid of the Role List Item object within Eros.
    */
    // @ApiMember(DataType="Guid", Description="Guid of the Role List Item object within Eros.", IsRequired=true, Name="RoleId", ParameterType="query")
    public var roleId:String?

    /**
    * The unique key that represents the role type on the external system. Note: Use of this is not currently implemented
    */
    // @ApiMember(DataType="string", Description="The unique key that represents the role type on the external system. Note: Use of this is not currently implemented", Name="RoleAlternateKey", ParameterType="query")
    public var roleAlternateKey:String?

    required public init(){}
}