Struct AddDealRequest

pub struct AddDealRequest {

    pub title: String,
    pub value: Option<String>,
    pub currency: Option<String>,
    pub user_id: Option<i32>,
    pub person_id: Option<i32>,
    pub org_id: Option<i32>,
    pub pipeline_id: Option<i32>,
    pub stage_id: Option<i32>,
    pub status: Option<Status>,
    pub add_time: Option<String>,
    pub expected_close_date: Option<String>,
    pub probability: Option<f32>,
    pub lost_reason: Option<String>,
    pub visible_to: Option<VisibleTo>,
}

Fields

title: String

The title of the deal

value: Option<String>

The value of the deal. If omitted, value will be set to 0.

currency: Option<String>

The currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user.

user_id: Option<i32>

The ID of the user which will be the owner of the created deal. If not provided, the user making the request will be used.

person_id: Option<i32>

The ID of a person which this deal will be linked to. If the person does not exist yet, it needs to be created first. This property is required unless org_id is specified.

org_id: Option<i32>

The ID of an organization which this deal will be linked to. If the organization does not exist yet, it needs to be created first. This property is required unless person_id is specified.

pipeline_id: Option<i32>

The ID of the pipeline this deal will be added to. By default, the deal will be added to the first stage of the specified pipeline. Please note that pipeline_id and stage_id should not be used together as pipeline_id will be ignored.

stage_id: Option<i32>

The ID of the stage this deal will be added to. Please note that a pipeline will be assigned automatically based on the stage_id. If omitted, the deal will be placed in the first stage of the default pipeline.

status: Option<Status>

open = Open, won = Won, lost = Lost, deleted = Deleted. If omitted, status will be set to open.

add_time: Option<String>

The optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS

expected_close_date: Option<String>

The expected close date of the deal. In ISO 8601 format: YYYY-MM-DD.

probability: Option<f32>

The success probability percentage of the deal. Used/shown only when deal_probability for the pipeline of the deal is enabled.

lost_reason: Option<String>

The optional message about why the deal was lost (to be used when status = lost)

visible_to: Option<VisibleTo>

Implementations

impl AddDealRequest

pub fn new(title: String) -> AddDealRequest

Trait Implementations

impl Clone for AddDealRequest

fn clone(&self) -> AddDealRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddDealRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AddDealRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AddDealRequest

fn eq(&self, other: &AddDealRequest) -> 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 AddDealRequest

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 AddDealRequest