Struct BasicGoalRequest 

pub struct BasicGoalRequest {
    pub title: Option<String>,
    pub assignee: Option<Value>,
    pub type: Option<Value>,
    pub expected_outcome: Option<Value>,
    pub duration: Option<Value>,
    pub interval: Option<Interval>,
}

Fields

title: Option<String>

The title of the goal

assignee: Option<Value>

Who this goal is assigned to. It requires the following JSON structure: { \"id\": \"1\", \"type\": \"person\" }. type can be either person, company or team. ID of the assignee person, company or team.

type: Option<Value>

The type of the goal. It requires the following JSON structure: { \"name\": \"deals_started\", \"params\": { \"pipeline_id\": [1, 2], \"activity_type_id\": [9] } }. Type can be one of: deals_won, deals_progressed, activities_completed, activities_added, deals_started or revenue_forecast. params can include pipeline_id, stage_id or activity_type_id. stage_id is related to only deals_progressed type of goals and activity_type_id to activities_completed or activities_added types of goals. The pipeline_id and activity_type_id need to be given as an array of integers. To track the goal in all pipelines, set pipeline_id as null and similarly, to track the goal for all activities, set activity_type_id as null.”

expected_outcome: Option<Value>

The expected outcome of the goal. Expected outcome can be tracked either by quantity or by sum. It requires the following JSON structure: { \"target\": \"50\", \"tracking_metric\": \"quantity\" } or { \"target\": \"50\", \"tracking_metric\": \"sum\", \"currency_id\": 1 }. currency_id should only be added to sum type of goals.

duration: Option<Value>

The date when the goal starts and ends. It requires the following JSON structure: { \"start\": \"2019-01-01\", \"end\": \"2022-12-31\" }. Date in format of YYYY-MM-DD. "end" can be set to null for an infinite, open-ended goal.

interval: Option<Interval>

The interval of the goal

Implementations

impl BasicGoalRequest

pub fn new() -> BasicGoalRequest

Trait Implementations

impl Clone for BasicGoalRequest

fn clone(&self) -> BasicGoalRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BasicGoalRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BasicGoalRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BasicGoalRequest

fn eq(&self, other: &BasicGoalRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BasicGoalRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BasicGoalRequest