# -*- coding: utf-8 -*-

###############################################################################
#
# DeletePeople
# Deletes a specified contact from your Highrise CRM.
#
# Python versions 2.6, 2.7, 3.x
#
# 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.
#
#
###############################################################################

from temboo.core.choreography import Choreography
from temboo.core.choreography import InputSet
from temboo.core.choreography import ResultSet
from temboo.core.choreography import ChoreographyExecution

import json

class DeletePeople(Choreography):

    def __init__(self, temboo_session):
        """
        Create a new instance of the DeletePeople Choreo. A TembooSession object, containing a valid
        set of Temboo credentials, must be supplied.
        """
        super(DeletePeople, self).__init__(temboo_session, '/Library/Highrise/DeletePeople')


    def new_input_set(self):
        return DeletePeopleInputSet()

    def _make_result_set(self, result, path):
        return DeletePeopleResultSet(result, path)

    def _make_execution(self, session, exec_id, path):
        return DeletePeopleChoreographyExecution(session, exec_id, path)

class DeletePeopleInputSet(InputSet):
    """
    An InputSet with methods appropriate for specifying the inputs to the DeletePeople
    Choreo. The InputSet object is used to specify input parameters when executing this Choreo.
    """
    def set_AccountName(self, value):
        """
        Set the value of the AccountName input for this Choreo. ((required, string) A valid Highrise account name. This is the first part of the account's URL.)
        """
        super(DeletePeopleInputSet, self)._set_input('AccountName', value)
    def set_ContactID(self, value):
        """
        Set the value of the ContactID input for this Choreo. ((required, string) The ID number of the contact you want to delete. This is used to contruct the URL for the request.)
        """
        super(DeletePeopleInputSet, self)._set_input('ContactID', value)
    def set_Password(self, value):
        """
        Set the value of the Password input for this Choreo. ((required, password) The Highrise account password. Use the value 'X' when specifying an API Key for the Username input.)
        """
        super(DeletePeopleInputSet, self)._set_input('Password', value)
    def set_Username(self, value):
        """
        Set the value of the Username input for this Choreo. ((required, string) A Highrise account username or API Key.)
        """
        super(DeletePeopleInputSet, self)._set_input('Username', value)

class DeletePeopleResultSet(ResultSet):
    """
    A ResultSet with methods tailored to the values returned by the DeletePeople Choreo.
    The ResultSet object is used to retrieve the results of a Choreo execution.
    """

    def getJSONFromString(self, str):
        return json.loads(str)

    def get_Response(self):
        """
        Retrieve the value for the "Response" output from this Choreo execution. (The response from Highrise. The delete people API method returns no XML, so this variable will contain no data.)
        """
        return self._output.get('Response', None)

class DeletePeopleChoreographyExecution(ChoreographyExecution):

    def _make_result_set(self, response, path):
        return DeletePeopleResultSet(response, path)
