Create An ATS Specific Contract

FUNCTION CreateContract
    INPUT: A request body containing:
        - TriggeredBy: The user who triggered the contract creation
        - Auth: Authorization details for OneFlow
        - Contract details
        - SendContract: Flag indicating if the contract should be sent automatically (true/false)
        - ContractSubject: Subject for the contract (if SendContract is true)
        - ContractMessage: Message for the contract (if SendContract is true)
    OUTPUT: The ID of the created contract

    BEGIN
        # Step 1: Extract required data from request body
        Retrieve the email of the user from TriggeredBy
        Retrieve the authorization token from Auth
        SET template_id TO value of 'template_id' in body
        SET workspace_id TO value of 'workspace_id' in body
        SET participants TO value of 'participants' in body
        SET contract_name TO value of 'candidate_name' in body
        SET send_contract TO value of 'SendContract' in body
        SET contract_subject TO value of 'ContractSubject' in body
        SET contract_message TO value of 'ContractMessage' in body
        
        # Step 2: Prepare participant details
	Call AddParticipants to add participants to the contract
				
	# Step 3: Determine if the contract should be sent directly
        IF send_contract IS TRUE THEN
            IF contract_subject IS EMPTY OR contract_message IS EMPTY THEN
                RETURN {'error': 'Contract subject and message cannot be empty'}

        # Step 4: Create the Oneflow contract
        TRY
            # Calls the CreateOneflowContract function to create a contract.
            SET oneflow_contract TO CALL CreateOneflowContract USING template_id, workspace_id, my_party, counterparties, and contract_name
        CATCH Exception
            # Handles exceptions encountered during contract creation.
            HANDLE exception
        END TRY

        # Step 5: Return the contract ID
        Return the ID of the created contract
    END

FUNCTION AddParticipants
    INPUT: participants (contains participant details, including candidate and my_party participants)
    OUTPUT: my_party (an object containing participants), parties (a list of party objects)

    BEGIN
        # Step 1: Initialize my_party object
        Initialize an empty object called my_party
        Initialize an empty list called my_party.participants

        # Step 2: Add additional my_party participants (if any)
        IF participants IS NOT EMPTY THEN
            TRY
                FOR EACH participant IN participants DO
                    SET participant_details TO {
                        '_permissions': { 'contract:update': participant_type != 'viewer' },
                        'name': participant.fullname,
                        'title': participant.jobtitle OR '',
                        'email': participant.email,
                        'phone_number': participant.phone_number,
                        'signatory': participant_type == 'signatory',  # Set signatory as boolean
                        'sign_method': participant.preferred_sign_method OR 'standard_esign',  # Default value
                        'delivery_channel': participant.preferred_delivery_channel OR 'email'  # Default value
                    }
                    # Add participant details to the my_party.participants array
                    ADD participant_details TO my_party.participants
            CATCH Exception
                # Handles exceptions encountered during my_party creation
                HANDLE exception
            END TRY
        END IF

        # Step 3: Initialize parties list
        Initialize an empty list called parties

        # Step 4: Add the candidate as an individual counterparty
        TRY
            SET candidate TO {
                '_permissions': { 'contract:update': false },
                'name': candidate.fullname,
                'title': candidate.jobtitle OR '',
                'email': candidate.email,
                'phone_number': candidate.phone_number,
                'signatory': participant_type == 'signatory',  # Set signatory as boolean
                'sign_method': candidate.preferred_sign_method OR 'standard_esign',  # Default value
                'delivery_channel': candidate.preferred_delivery_channel OR 'email'  # Default value
            }
            # Add candidate details to the parties list with type set to IndividualCounterparty
            ADD candidate TO parties WITH type 'IndividualCounterparty'
        CATCH Exception
            # Handles exceptions encountered during parties creation
            HANDLE exception
        END TRY

        # Step 5: Return the my_party object and parties list separately
        RETURN my_party, parties
    END

FUNCTION CreateOneflowContract(template_id, workspace_id, my_party, counterparties, contract_name)
    # Purpose: Create a contract in Oneflow using the provided details.

    # Step 1: Prepare the request body
    CREATE body AS a key-value store WITH:
        "template_id": template_id,
        "workspace_id": workspace_id,
        "contract_name": candidate_name,
        "my_party": my_party
        "parties": counterparties

    # Step 2: Set up the headers for the API request
    DEFINE HEADERS
        SET "x-oneflow-api-token" IN HEADERS TO user.apiToken
        SET "x-oneflow-user-email" IN HEADERS TO user.email
        SET "Content-Type" IN HEADERS TO "application/json"

    # Step 3: Make the API request to create the contract
    SET response TO POST REQUEST TO "{host}/v1/contracts/create" WITH:
        - JSON body
        - SSL verification
        - HEADERS

    # Step 4: Check the response status code
    IF response.StatusCode EQUALS 200 THEN
        SET jsonResponse TO result of parsing response to JSON format
        RETURN jsonResponse
    ELSE
        THROW HttpResponseError
END FUNCTION