rust_sync_force 0.2.2

Salesforce Sync REST API Client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181

[![crate-name at crates.io](https://img.shields.io/crates/v/rust_sync_force.svg)](https://crates.io/crates/rust_sync_force)
[![crate-name at docs.rs](https://docs.rs/rust_sync_force/badge.svg)](https://docs.rs/rust_sync_force)
[![Rust](https://github.com/0cv/rust_sync_force/actions/workflows/rust.yml/badge.svg)](https://github.com/0cv/rust_sync_force/actions/workflows/rust.yml)

## Rust Sync Force

Salesforce Client for Rust Sync.

Async version is here https://github.com/tzmfreedom/rustforce

## Usage

```rust
use rust_sync_force::{Client, Error};
use rust_sync_force::response::{QueryResponse, ErrorResponse};
use serde::Deserialize;
use std::env;

#[derive(Deserialize, Debug)]
#[serde(rename_all = "PascalCase")]
struct Account {
    #[serde(rename = "attributes")]
    attributes: Attribute,
    id: String,
    name: String,
}

#[derive(Deserialize, Debug)]
struct Attribute {
    url: String,
    #[serde(rename = "type")]
    sobject_type: String,
}

fn main() -> Result<(), Error> {
    
    let client_id = env::var("SFDC_CLIENT_ID").unwrap();
    let client_secret = env::var("SFDC_CLIENT_SECRET").unwrap();
    let username = env::var("SFDC_USERNAME").unwrap();
    let password = env::var("SFDC_PASSWORD").unwrap();

    let mut client = Client::new(client_id, client_secret);
    client.login_with_credential(username, password)?;

    let res: QueryResponse<Account> = client.query("SELECT Id, Name FROM Account WHERE id = '0012K00001drfGYQAY'".to_string())?;
    println!("{:?}", res);

    Ok(())
}
```

### Authentication

Username Password Flow
```rust
let mut client = Client::new(client_id, client_secret);
client.login_with_credential(username, password)?;
```

[WIP]Authorization Code Grant

### Refresh Token

```rust
let r = client.refresh("xxxx")?;
```

### Query Records

```rust
let r: Result<QueryResponse<Account>, Error> = client.query("SELECT Id, Name FROM Account")?;
```

### Query All Records

```rust
let r: Result<QueryResponse<Account>, Error> = client.query_all("SELECT Id, Name FROM Account")?;
```

### Find By Id

```rust
let r: Result<Account, Error> = client.find_by_id("Account", "{sf_id}")?;
```

### Insert a Record

```rust
let mut params = HashMap::new();
params.insert("Name", "hello rust");
let r = client.insert("Account", params)?;
println!("{:?}", r);
```

### Insert multiple Records

```rust
let account1 = Account {
    name: "account name1".into(),
    attributes: Attribute { sobject_type: "Account".into() },
};

let account2 = Account {
    name: "account name2".into(),
    attributes: Attribute { sobject_type: "Account".into() },
};

let r = client.inserts(true, vec![account1, account2])?;
```

### Update a Record

```rust
let r = client.update("Account", "{sobject_id}", params)?;
```

### Update multiple Records

```rust
let account = Account {
    id: "account_id".into(),
    name: "new_name".into(),
    attributes: Attribute { sobject_type: "Account".into() },
};

let r = client.updates(true, vec![account])?;
```

### Upsert a Record

```rust
let r = client.upsert("Account", "external_key_name", "external_key_value", params)?;
```

### Upsert multiple Records

```rust
let account = Account {
    exkey: "external_key_id".into(),
    name: "new_name".into(),
    attributes: Attribute { sobject_type: "Account".into() },
};

let r = client.upserts(true, "Account", "ExKey__c", vec![account])?;
```

### Delete a Record

```rust
let r = client.delete("Account", "{sobject_id}")?;
```

### Delete multiple Records

```rust
let r = client.deletes(true, vec!["account_id".into()])?;
```

### Describe Global

```rust
let r = client.describe_global()?;
```

### Describe SObject

```rust
let r = client.describe("Account")?;
```

### Versions

```rust
let versions = client.versions()?;
```

### Search(SOSL)

```rust
let r = client.search("FIND {Rust}")?;
```