Struct rustforce::client::Client

pub struct Client { /* fields omitted */ }

Represents a Salesforce Client

Implementations

impl Client

pub fn new(client_id: String, client_secret: String) -> Client

Creates a new client when passed a Client ID and Client Secret. These can be obtained by creating a connected app in Salesforce

pub fn set_login_endpoint(&mut self, endpoint: &str)

Set the login endpoint. This is useful if you want to connect to a Sandbox

pub fn set_version(&mut self, version: &str)

Set API Version

pub fn set_instance_url(&mut self, instance_url: &str)

pub fn set_access_token(&mut self, access_token: &str)

Set Access token if you've already obtained one via one of the OAuth2 flows

pub async fn refresh<'_, '_>(
    &'_ mut self,
    refresh_token: &'_ str
) -> Result<(), Error>

This will fetch an access token when provided with a refresh token

pub async fn login_with_credential<'_>(
    &'_ mut self,
    username: String,
    password: String
) -> Result<(), Error>

Login to Salesforce with username and password

pub async fn query<T: DeserializeOwned, '_, '_>(
    &'_ self,
    query: &'_ str
) -> Result<QueryResponse<T>, Error>

Query record using SOQL

pub async fn query_all<T: DeserializeOwned, '_, '_>(
    &'_ self,
    query: &'_ str
) -> Result<QueryResponse<T>, Error>

Query All records using SOQL

pub async fn search<'_, '_>(
    &'_ self,
    query: &'_ str
) -> Result<SearchResponse, Error>

Find records using SOSL

pub async fn versions<'_>(&'_ self) -> Result<Vec<VersionResponse>, Error>

Get all supported API versions

pub async fn find_by_id<T: DeserializeOwned, '_, '_, '_>(
    &'_ self,
    sobject_name: &'_ str,
    id: &'_ str
) -> Result<T, Error>

Finds a record by ID

pub async fn create<T: Serialize, '_, '_>(
    &'_ self,
    sobject_name: &'_ str,
    params: T
) -> Result<CreateResponse, Error>

Creates an SObject

pub async fn update<T: Serialize, '_, '_, '_>(
    &'_ self,
    sobject_name: &'_ str,
    id: &'_ str,
    params: T
) -> Result<(), Error>

Updates an SObject

pub async fn upsert<T: Serialize, '_, '_, '_, '_>(
    &'_ self,
    sobject_name: &'_ str,
    key_name: &'_ str,
    key: &'_ str,
    params: T
) -> Result<Option<CreateResponse>, Error>

Upserts an SObject with key

pub async fn destroy<'_, '_, '_>(
    &'_ self,
    sobject_name: &'_ str,
    id: &'_ str
) -> Result<(), Error>

Deletes an SObject

pub async fn describe_global<'_>(
    &'_ self
) -> Result<DescribeGlobalResponse, Error>

Describes all objects

pub async fn describe<'_, '_>(
    &'_ self,
    sobject_name: &'_ str
) -> Result<DescribeResponse, Error>

Describes specific object