Struct Basic 

pub struct Basic {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Basic

pub async fn get_crm_v_3_objects_contacts_contact_id_get_by_id<'a>( &'a self, archived: Option<bool>, associations: Option<Vec<String>>, contact_id: &'a str, id_property: Option<String>, properties: Option<Vec<String>>, properties_with_history: Option<Vec<String>>, ) -> Result<SimplePublicObjectWithAssociations, Error>

Read

Read an Object identified by {contactId}. {contactId} refers to the internal object ID. Control what is returned via the properties query param.

Parameters:

• archived: Option<bool>: Whether to return only results that have been archived.
• associations: Option<Vec<String>>: A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
• contact_id: &'astr (required)
• id_property: Option<String>: What id property to query, could be id or email
• properties: Option<Vec<String>>: A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
• properties_with_history: Option<Vec<String>>: A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.

async fn example_basic_get_crm_v_3_objects_contacts_contact_id_get_by_id() -> anyhow::Result<()> {
    let client = hubspot_contacts::Client::new_from_env();
    let result: hubspot_contacts::types::SimplePublicObjectWithAssociations = client
        .basic()
        .get_crm_v_3_objects_contacts_contact_id_get_by_id(
            Some(false),
            Some(vec!["some-string".to_string()]),
            "some-string",
            Some("some-string".to_string()),
            Some(vec!["some-string".to_string()]),
            Some(vec!["some-string".to_string()]),
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn delete_crm_v_3_objects_contacts_contact_id_archive<'a>( &'a self, contact_id: &'a str, ) -> Result<(), Error>

Archive

Move an Object identified by {contactId} to the recycling bin.

Parameters:

• contact_id: &'astr (required)

async fn example_basic_delete_crm_v_3_objects_contacts_contact_id_archive() -> anyhow::Result<()> {
    let client = hubspot_contacts::Client::new_from_env();
    client
        .basic()
        .delete_crm_v_3_objects_contacts_contact_id_archive("some-string")
        .await?;
    Ok(())
}

pub async fn patch_crm_v_3_objects_contacts_contact_id_update<'a>( &'a self, contact_id: &'a str, body: &SimplePublicObjectInput, ) -> Result<SimplePublicObject, Error>

Update

Perform a partial update of an Object identified by {contactId}. {contactId} refers to the internal object ID. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.

Parameters:

• contact_id: &'astr (required)

async fn example_basic_patch_crm_v_3_objects_contacts_contact_id_update() -> anyhow::Result<()> {
    let client = hubspot_contacts::Client::new_from_env();
    let result: hubspot_contacts::types::SimplePublicObject = client
        .basic()
        .patch_crm_v_3_objects_contacts_contact_id_update(
            "some-string",
            &hubspot_contacts::types::SimplePublicObjectInput {
                properties: std::collections::HashMap::from([(
                    "some-key".to_string(),
                    "some-string".to_string(),
                )]),
            },
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn get_crm_v_3_objects_contacts_get_page<'a>( &'a self, after: Option<String>, archived: Option<bool>, associations: Option<Vec<String>>, limit: Option<i32>, properties: Option<Vec<String>>, properties_with_history: Option<Vec<String>>, ) -> Result<CollectionResponseSimplePublicObjectWithAssociationsForwardPaging, Error>

List

Read a page of contacts. Control what is returned via the properties query param.

Parameters:

• after: Option<String>: The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results.
• archived: Option<bool>: Whether to return only results that have been archived.
• associations: Option<Vec<String>>: A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.
• limit: Option<i32>: The maximum number of results to display per page.
• properties: Option<Vec<String>>: A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.
• properties_with_history: Option<Vec<String>>: A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.

async fn example_basic_get_crm_v_3_objects_contacts_get_page() -> anyhow::Result<()> {
    let client = hubspot_contacts::Client::new_from_env();
    let result: hubspot_contacts::types::CollectionResponseSimplePublicObjectWithAssociationsForwardPaging =
        client
            .basic()
            .get_crm_v_3_objects_contacts_get_page(
                Some("some-string".to_string()),
                Some(false),
                Some(vec!["some-string".to_string()]),
                Some(4 as i32),
                Some(vec!["some-string".to_string()]),
                Some(vec!["some-string".to_string()]),
            )
            .await?;
    println!("{:?}", result);
    Ok(())
}

pub async fn post_crm_v_3_objects_contacts_create<'a>( &'a self, body: &SimplePublicObjectInputForCreate, ) -> Result<SimplePublicObject, Error>

Create

Create a contact with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard contacts is provided.

async fn example_basic_post_crm_v_3_objects_contacts_create() -> anyhow::Result<()> {
    let client = hubspot_contacts::Client::new_from_env();
    let result: hubspot_contacts::types::SimplePublicObject = client
        .basic()
        .post_crm_v_3_objects_contacts_create(&hubspot_contacts::types::SimplePublicObjectInputForCreate {
            associations: vec![hubspot_contacts::types::PublicAssociationsForObject {
                types: vec![hubspot_contacts::types::AssociationSpec {
                    association_category: hubspot_contacts::types::AssociationCategory::IntegratorDefined,
                    association_type_id: 4 as i32,
                }],
                to: hubspot_contacts::types::PublicObjectId {
                    id: "some-string".to_string(),
                },
            }],
            properties: std::collections::HashMap::from([(
                "some-key".to_string(),
                "some-string".to_string(),
            )]),
        })
        .await?;
    println!("{:?}", result);
    Ok(())
}

Trait Implementations

impl Clone for Basic

fn clone(&self) -> Basic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Basic

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

Formats the value using the given formatter.