/// <summary>
/// Initializes a new instance of the <see cref="ActionOutput" /> class.
/// </summary>
/// <param name="SuccessSchema">JSON schema that defines the transformed, successful result that will be sent back to the caller. If the 'flatten' query parameter is omitted or false, this field will be returned. Either successSchema or successSchemaFlattened will be returned, not both..</param>
/// <param name="SuccessSchemaUri">URI to retrieve success schema.</param>
/// <param name="ErrorSchema">JSON schema that defines the body of response when request is not successful. If the 'flatten' query parameter is omitted or false, this field will be returned. Either errorSchema or errorSchemaFlattened will be returned, not both..</param>
/// <param name="ErrorSchemaUri">URI to retrieve error schema.</param>
/// <param name="SuccessSchemaFlattened">JSON schema that defines the transformed, successful result that will be sent back to the caller. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either successSchema or successSchemaFlattened will be returned, not both..</param>
/// <param name="ErrorSchemaFlattened">JSON schema that defines the body of response when request is not successful. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either errorSchema or errorSchemaFlattened will be returned, not both..</param>
public ActionOutput(JsonSchemaDocument SuccessSchema = null, string SuccessSchemaUri = null, JsonSchemaDocument ErrorSchema = null, string ErrorSchemaUri = null, JsonSchemaDocument SuccessSchemaFlattened = null, Object ErrorSchemaFlattened = null)
{
this.SuccessSchema = SuccessSchema;
this.SuccessSchemaUri = SuccessSchemaUri;
this.ErrorSchema = ErrorSchema;
this.ErrorSchemaUri = ErrorSchemaUri;
this.SuccessSchemaFlattened = SuccessSchemaFlattened;
this.ErrorSchemaFlattened = ErrorSchemaFlattened;
}
/// <summary>
/// Initializes a new instance of the <see cref="PostInputContract" /> class.
/// </summary>
/// <param name="InputSchema">JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path. (required).</param>
public PostInputContract(JsonSchemaDocument InputSchema = null)
{
// to ensure "InputSchema" is required (not null)
if (InputSchema == null)
{
throw new InvalidDataException("InputSchema is a required property for PostInputContract and cannot be null");
}
else
{
this.InputSchema = InputSchema;
}
}
/// <summary>
/// Initializes a new instance of the <see cref="ActionInput" /> class.
/// </summary>
/// <param name="InputSchema">JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path. If the 'flatten' query parameter is omitted or false, this field will be returned. Either inputSchema or inputSchemaFlattened will be returned, not both..</param>
/// <param name="InputSchemaFlattened">JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path. The schema is transformed based on Architect's flattened format. If the 'flatten' query parameter is supplied as true, this field will be returned. Either inputSchema or inputSchemaFlattened will be returned, not both..</param>
/// <param name="InputSchemaUri">The URI of the input schema.</param>
public ActionInput(JsonSchemaDocument InputSchema = null, JsonSchemaDocument InputSchemaFlattened = null, string InputSchemaUri = null)
{
this.InputSchema = InputSchema;
this.InputSchemaFlattened = InputSchemaFlattened;
this.InputSchemaUri = InputSchemaUri;
}
/// <summary>
/// Initializes a new instance of the <see cref="DataTable" /> class.
/// </summary>
/// <param name="Name">Name.</param>
/// <param name="Description">The description from the JSON schema (equates to the Description field on the JSON schema.).</param>
/// <param name="Schema">the schema as stored in the system..</param>
public DataTable(string Name = null, string Description = null, JsonSchemaDocument Schema = null)
{
this.Name = Name;
this.Description = Description;
this.Schema = Schema;
}
/// <summary>
/// Initializes a new instance of the <see cref="PostOutputContract" /> class.
/// </summary>
/// <param name="SuccessSchema">JSON schema that defines the transformed, successful result that will be sent back to the caller. (required).</param>
public PostOutputContract(JsonSchemaDocument SuccessSchema = null)
{
// to ensure "SuccessSchema" is required (not null)
if (SuccessSchema == null)
{
throw new InvalidDataException("SuccessSchema is a required property for PostOutputContract and cannot be null");
}
else
{
this.SuccessSchema = SuccessSchema;
}
}
/// <summary>
/// Initializes a new instance of the <see cref="PostOutputContract" /> class.
/// </summary>
/// <param name="SuccessSchema">JSON schema that defines the transformed, successful result that will be sent back to the caller. (required).</param>
public PostOutputContract(JsonSchemaDocument SuccessSchema = null)
{
this.SuccessSchema = SuccessSchema;
}
/// <summary>
/// Initializes a new instance of the <see cref="Response" /> class.
/// </summary>
/// <param name="Name">Name.</param>
/// <param name="Version">Version number required for updates..</param>
/// <param name="Libraries">One or more libraries response is associated with. (required).</param>
/// <param name="Texts">One or more texts associated with the response. (required).</param>
/// <param name="InteractionType">The interaction type for this response..</param>
/// <param name="Substitutions">Details about any text substitutions used in the texts for this response..</param>
/// <param name="SubstitutionsSchema">Metadata about the text substitutions in json schema format..</param>
/// <param name="ResponseType">The response type represented by the response..</param>
/// <param name="MessagingTemplate">An optional messaging template definition for responseType.MessagingTemplate..</param>
/// <param name="Assets">Assets used in the response.</param>
public Response(string Name = null, int?Version = null, List <DomainEntityRef> Libraries = null, List <ResponseText> Texts = null, InteractionTypeEnum?InteractionType = null, List <ResponseSubstitution> Substitutions = null, JsonSchemaDocument SubstitutionsSchema = null, ResponseTypeEnum?ResponseType = null, MessagingTemplate MessagingTemplate = null, List <AddressableEntityRef> Assets = null)
{
this.Name = Name;
this.Version = Version;
this.Libraries = Libraries;
this.Texts = Texts;
this.InteractionType = InteractionType;
this.Substitutions = Substitutions;
this.SubstitutionsSchema = SubstitutionsSchema;
this.ResponseType = ResponseType;
this.MessagingTemplate = MessagingTemplate;
this.Assets = Assets;
}
/// <summary>
/// Initializes a new instance of the <see cref="Response" /> class.
/// </summary>
/// <param name="Name">Name.</param>
/// <param name="Version">Version number required for updates..</param>
/// <param name="Libraries">One or more libraries response is associated with. (required).</param>
/// <param name="Texts">One or more texts associated with the response. (required).</param>
/// <param name="CreatedBy">User that created the response.</param>
/// <param name="DateCreated">The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ.</param>
/// <param name="InteractionType">The interaction type for this response..</param>
/// <param name="Substitutions">Details about any text substitutions used in the texts for this response..</param>
/// <param name="SubstitutionsSchema">Metadata about the text substitutions in json schema format..</param>
public Response(string Name = null, int?Version = null, List <UriReference> Libraries = null, List <ResponseText> Texts = null, User CreatedBy = null, DateTime?DateCreated = null, InteractionTypeEnum?InteractionType = null, List <ResponseSubstitution> Substitutions = null, JsonSchemaDocument SubstitutionsSchema = null)
{
this.Name = Name;
this.Version = Version;
this.Libraries = Libraries;
this.Texts = Texts;
this.CreatedBy = CreatedBy;
this.DateCreated = DateCreated;
this.InteractionType = InteractionType;
this.Substitutions = Substitutions;
this.SubstitutionsSchema = SubstitutionsSchema;
}
/// <summary>
/// Initializes a new instance of the <see cref="DataSchema" /> class.
/// </summary>
/// <param name="Name">Name.</param>
/// <param name="Version">The schema's version. Required for updates. (required).</param>
/// <param name="AppliesTo">The PureCloud data this schema extends..</param>
/// <param name="Enabled">The schema's current enabled/disabled status. A disabled schema cannot be assigned to any other objects, but the data on those objects from the schemas still exists.</param>
/// <param name="Deleted">The schema's deleted status. A deleted schema can not be used by any records or updated. All records using a deleted schema will eventually have their schema-based data removed..</param>
/// <param name="CreatedBy">The user that created this schema..</param>
/// <param name="JsonSchema">The JSON schema defining the data extension. (required).</param>
public DataSchema(string Name = null, int?Version = null, List <AppliesToEnum> AppliesTo = null, bool?Enabled = null, bool?Deleted = null, UriReference CreatedBy = null, JsonSchemaDocument JsonSchema = null)
{
this.Name = Name;
this.Version = Version;
this.AppliesTo = AppliesTo;
this.Enabled = Enabled;
this.Deleted = Deleted;
this.CreatedBy = CreatedBy;
this.JsonSchema = JsonSchema;
}
/// <summary>
/// Initializes a new instance of the <see cref="PostInputContract" /> class.
/// </summary>
/// <param name="InputSchema">JSON Schema that defines the body of the request that the client (edge/architect/postman) is sending to the service, on the /execute path. (required).</param>
public PostInputContract(JsonSchemaDocument InputSchema = null)
{
this.InputSchema = InputSchema;
}
/// <summary>
/// Initializes a new instance of the <see cref="FlowVersion" /> class.
/// </summary>
/// <param name="Id">The flow version identifier.</param>
/// <param name="Name">Name.</param>
/// <param name="CommitVersion">CommitVersion.</param>
/// <param name="ConfigurationVersion">ConfigurationVersion.</param>
/// <param name="Type">Type.</param>
/// <param name="Secure">Secure.</param>
/// <param name="Debug">Debug.</param>
/// <param name="CreatedBy">CreatedBy.</param>
/// <param name="CreatedByClient">CreatedByClient.</param>
/// <param name="ConfigurationUri">ConfigurationUri.</param>
/// <param name="DateCreated">DateCreated.</param>
/// <param name="GenerationId">GenerationId.</param>
/// <param name="PublishResultUri">PublishResultUri.</param>
/// <param name="InputSchema">InputSchema.</param>
/// <param name="OutputSchema">OutputSchema.</param>
public FlowVersion(string Id = null, string Name = null, string CommitVersion = null, string ConfigurationVersion = null, TypeEnum?Type = null, bool?Secure = null, bool?Debug = null, User CreatedBy = null, DomainEntityRef CreatedByClient = null, string ConfigurationUri = null, long?DateCreated = null, string GenerationId = null, string PublishResultUri = null, JsonSchemaDocument InputSchema = null, JsonSchemaDocument OutputSchema = null)
{
this.Id = Id;
this.Name = Name;
this.CommitVersion = CommitVersion;
this.ConfigurationVersion = ConfigurationVersion;
this.Type = Type;
this.Secure = Secure;
this.Debug = Debug;
this.CreatedBy = CreatedBy;
this.CreatedByClient = CreatedByClient;
this.ConfigurationUri = ConfigurationUri;
this.DateCreated = DateCreated;
this.GenerationId = GenerationId;
this.PublishResultUri = PublishResultUri;
this.InputSchema = InputSchema;
this.OutputSchema = OutputSchema;
}
/// <summary>
/// Initializes a new instance of the <see cref="DataSchema" /> class.
/// </summary>
/// <param name="Name">Name.</param>
/// <param name="Version">The schema's version, a positive integer. Required for updates. (required).</param>
/// <param name="AppliesTo">One of \"CONTACT\" or \"EXTERNAL_ORGANIZATION\". Indicates the built-in entity type to which this schema applies..</param>
/// <param name="Enabled">The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists..</param>
/// <param name="CreatedBy">The URI of the user that created this schema..</param>
/// <param name="JsonSchema">A JSON schema defining the extension to the built-in entity type. (required).</param>
public DataSchema(string Name = null, int?Version = null, List <AppliesToEnum> AppliesTo = null, bool?Enabled = null, DomainEntityRef CreatedBy = null, JsonSchemaDocument JsonSchema = null)
{
this.Name = Name;
this.Version = Version;
this.AppliesTo = AppliesTo;
this.Enabled = Enabled;
this.CreatedBy = CreatedBy;
this.JsonSchema = JsonSchema;
}
/// <summary>
/// Initializes a new instance of the <see cref="Response" /> class.
/// </summary>
/// <param name="Name">Name.</param>
/// <param name="Version">Version number required for updates..</param>
/// <param name="Libraries">One or more libraries response is associated with. (required).</param>
/// <param name="Texts">One or more texts associated with the response. (required).</param>
/// <param name="CreatedBy">User that created the response.</param>
/// <param name="DateCreated">The date and time the response was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ.</param>
/// <param name="InteractionType">The interaction type for this response..</param>
/// <param name="Substitutions">Details about any text substitutions used in the texts for this response..</param>
/// <param name="SubstitutionsSchema">Metadata about the text substitutions in json schema format..</param>
public Response(string Name = null, int?Version = null, List <UriReference> Libraries = null, List <ResponseText> Texts = null, User CreatedBy = null, DateTime?DateCreated = null, InteractionTypeEnum?InteractionType = null, List <ResponseSubstitution> Substitutions = null, JsonSchemaDocument SubstitutionsSchema = null)
{
// to ensure "Libraries" is required (not null)
if (Libraries == null)
{
throw new InvalidDataException("Libraries is a required property for Response and cannot be null");
}
else
{
this.Libraries = Libraries;
}
// to ensure "Texts" is required (not null)
if (Texts == null)
{
throw new InvalidDataException("Texts is a required property for Response and cannot be null");
}
else
{
this.Texts = Texts;
}
this.Name = Name;
this.Version = Version;
this.CreatedBy = CreatedBy;
this.DateCreated = DateCreated;
this.InteractionType = InteractionType;
this.Substitutions = Substitutions;
this.SubstitutionsSchema = SubstitutionsSchema;
}
/// <summary>
/// Initializes a new instance of the <see cref="FlowDivisionView" /> class.
/// </summary>
/// <param name="Id">The flow identifier.</param>
/// <param name="Name">The flow name (required).</param>
/// <param name="Division">The division to which this entity belongs..</param>
/// <param name="Type">Type.</param>
/// <param name="InputSchema">json schema describing the inputs for the flow.</param>
/// <param name="OutputSchema">json schema describing the outputs for the flow.</param>
public FlowDivisionView(string Id = null, string Name = null, WritableDivision Division = null, TypeEnum?Type = null, JsonSchemaDocument InputSchema = null, JsonSchemaDocument OutputSchema = null)
{
this.Id = Id;
this.Name = Name;
this.Division = Division;
this.Type = Type;
this.InputSchema = InputSchema;
this.OutputSchema = OutputSchema;
}
/// <summary>
/// Initializes a new instance of the <see cref="FlowDivisionView" /> class.
/// </summary>
/// <param name="Id">The flow identifier.</param>
/// <param name="Name">The flow name (required).</param>
/// <param name="Division">The division to which this entity belongs..</param>
/// <param name="Type">Type.</param>
/// <param name="Description">the flow description.</param>
/// <param name="InputSchema">json schema describing the inputs for the flow.</param>
/// <param name="OutputSchema">json schema describing the outputs for the flow.</param>
/// <param name="PublishedVersion">published version information if there is a published version.</param>
/// <param name="DebugVersion">debug version information if there is a debug version.</param>
public FlowDivisionView(string Id = null, string Name = null, WritableDivision Division = null, TypeEnum?Type = null, string Description = null, JsonSchemaDocument InputSchema = null, JsonSchemaDocument OutputSchema = null, FlowVersion PublishedVersion = null, FlowVersion DebugVersion = null)
{
this.Id = Id;
this.Name = Name;
this.Division = Division;
this.Type = Type;
this.Description = Description;
this.InputSchema = InputSchema;
this.OutputSchema = OutputSchema;
this.PublishedVersion = PublishedVersion;
this.DebugVersion = DebugVersion;
}
/// <summary>
/// Initializes a new instance of the <see cref="DataSchema" /> class.
/// </summary>
/// <param name="Id">The globally unique identifier for the schema. Only required if a schema is used for custom fields during external entity creation or updates..</param>
/// <param name="Name">Name.</param>
/// <param name="Version">The schema's version, a positive integer. Required for updates. (required).</param>
/// <param name="Enabled">The schema's enabled/disabled status. A disabled schema cannot be assigned to any other entities, but the data on those entities from the schema still exists..</param>
/// <param name="JsonSchema">A JSON schema defining the extension to the built-in entity type. (required).</param>
public DataSchema(string Id = null, string Name = null, int?Version = null, bool?Enabled = null, JsonSchemaDocument JsonSchema = null)
{
this.Id = Id;
this.Name = Name;
this.Version = Version;
this.Enabled = Enabled;
this.JsonSchema = JsonSchema;
}
