package com.temboo.Library.SendGrid.NewsletterAPI.Schedule;

/*
Copyright 2014 Temboo, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

import processing.data.JSONArray;
import processing.data.JSONObject;
import java.math.BigDecimal;
import com.temboo.core.Choreography;
import com.temboo.core.Choreography.ResultSet;
import com.temboo.core.TembooException;
import com.temboo.core.TembooPath;
import com.temboo.core.TembooSession;

/** 
ScheduleNewsletterDelivery

Schedule a delivery time for an existing Newsletter.
*/
public class ScheduleNewsletterDelivery extends Choreography {

	/**
	Create a new instance of the ScheduleNewsletterDelivery Choreo. A TembooSession object, containing a valid
	set of Temboo credentials, must be supplied.
	*/
	public ScheduleNewsletterDelivery(TembooSession session) {
		super(session, TembooPath.pathFromStringNoException("/Library/SendGrid/NewsletterAPI/Schedule/ScheduleNewsletterDelivery"));
	}

	/** 
	Set the value of the APIKey input for this Choreo. 

	@param String - (required, string) The API Key obtained from SendGrid.
	*/
	public void setAPIKey(String value) {
		this.inputs.setInput("APIKey", value);
	}


	/** 
	Set the value of the APIUser input for this Choreo. 

	@param String - (required, string) The username registered with SendGrid.
	*/
	public void setAPIUser(String value) {
		this.inputs.setInput("APIUser", value);
	}


	/** 
	Set the value of the After input for this Choreo. 

	@param Integer - (optional, integer) The number of minites after which the newsletter will be delivered.
	*/
	public void setAfter(Integer value) {
		this.inputs.setInput("After", value);
	}

	/** 
	Set the value of the After input for this Choreo as a String. 

	@param String - (optional, integer) The number of minites after which the newsletter will be delivered.
	*/
	public void setAfter(String value) {
		this.inputs.setInput("After", value);	
	}
	/** 
	Set the value of the At input for this Choreo. 

	@param String - (optional, string) The date and time when the newsletter is to be delievered, in ISO 8601 format (YYYY-MM-DD HH:MM:SS+-HH:MM)
	*/
	public void setAt(String value) {
		this.inputs.setInput("At", value);
	}


	/** 
	Set the value of the Name input for this Choreo. 

	@param String - (required, string) The name of the newsletter that is being scheduled for delivery.  If the newsletter is to be sent immediately, then leave the At, and After parameters empty.
	*/
	public void setName(String value) {
		this.inputs.setInput("Name", value);
	}


	/** 
	Set the value of the ResponseFormat input for this Choreo. 

	@param String - (optional, string) The format of the response from SendGrid, in either json, or xml.  Default is set to json.
	*/
	public void setResponseFormat(String value) {
		this.inputs.setInput("ResponseFormat", value);
	}


	/** 
	Set the value of the VaultFile input for this Choreo. 

	@param TembooPath - 
	*/

	
	/**
	 * Execute the Choreo, wait for the Choreo to complete 
	 * and return a ResultSet containing the execution results.
	 */
	@Override
	public ScheduleNewsletterDeliveryResultSet run() {
		JSONObject result = super.runWithResults();
		return new ScheduleNewsletterDeliveryResultSet(result);
	}
	
}
