Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yemikudaisi/FrappeRestClient.Net
Frappe Framework REST client for .Net
https://github.com/yemikudaisi/FrappeRestClient.Net
api api-client frappe-framework rest
Last synced: about 1 month ago
JSON representation
Frappe Framework REST client for .Net
- Host: GitHub
- URL: https://github.com/yemikudaisi/FrappeRestClient.Net
- Owner: yemikudaisi
- License: mit
- Created: 2021-10-28T02:54:26.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2021-11-13T14:19:04.000Z (over 2 years ago)
- Last Synced: 2023-09-19T08:19:08.951Z (9 months ago)
- Topics: api, api-client, frappe-framework, rest
- Language: C#
- Homepage:
- Size: 142 KB
- Stars: 5
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-frappe - FrappeRestClient.Net - Frappe Framework REST client for .Net (Uncategorized / Uncategorized)
README
# FrappeRestClient.Net
[](https://www.nuget.org/packages/FrappeRestClient.Net/)
[](https://ci.appveyor.com/project/yemikudaisi/frapperestclient-net/branch/main)
[](LICENSE)
.Net REST client for [Frappe Framework](https://frappeframework.com/)
## Basic Usage
### Create the Client
```cs
using Frappe.Net
var frappe = new Frappe("https://base-url.com/");
```
### Test Connection to Frappe Site
To ping a Frappe Site use the ```PingAsync``` method.
```cs
...
var res = await frappe.PingAsync()
Console.WriteLine(res) // pong
```
### Debug
When the debug mode is on, Frappe.Net logs all HTTP requests in debug console
```cs
var frappe = new Frappe("https://base-url.com/", true);
```
### Authentication
Frappe.Net supports all [Frappe Framework](https://frappeframework.com/) [REST](https://frappeframework.com/docs/user/en/api/rest) authentication methods. It attempts to validate credentials once supplied, as such all athentication functions are asynchronous. All authentication methods support fluent style coding.
#### 1. Token Based Authentication
```cs
frappe.UseTokenAync("api-key", "api-secret");
```
#### 2. Password Based
Logging in with password yields cookie data of type ```IDictionary``` that contains the keys ```sid```, ```system_user```, ```full_name```, ```user_id``` and ```user_image```. Session data is maintained, so there is no need to supply username and password again for subsequent requests.
```cs
var cookies = await frappe.UsePasswordAync("email-or-username", "password");
Console.WriteLine(cookies[Cookies.FieldNames.UserId]); // Administrator
```
#### 3. Access Token
```cs
frappe.UseAccessTokenAync("oauth-access-token");
```
### Get Logged In User
```cs
var user = await frappe.UseTokenAync("api-key", "api-secret")
.GetLoggedUserAsync()
Console.WriteLine(user); // administrator
```
### DB Funcitons
The methods implemented corellates to RESTful requests that are mapped to the `/api/resource` in Frappe. Also, some other ```frappe.client``` APImethods are implemented here.
#### Listing Documents
To get a list of records of a DocType use ```Frappe.Db.GetListAsync()```
```cs
var frappe = new Frappe(baseUrl);
await frappe.UseTokenAsync(apiKey, apiSecret);
string[] fields = {
"name",
"description",
"status"
};
string[,] filters = {
{
"status", "=", "Open"
}
};
var todos = await frappe.Db.GetListAsync(
"ToDo",
fields:fields,
filters:filters,
orderBy: "modified desc",
limitStart: 10,
limitPageLenght: 30,
);
foreach ( var t in todos) {
console.WriteLine($"{t.name} -> {t.description} : {t.status}");
}
```
By default Frappe will return 20 records and will only fetch the name of the records unless fields supplied.
#### Get Count
```cs
string[,] filters = {
{
"status", "=", "Closed"
}
};
int count = frappe.Db.GetCount("ToDo"); // count all close ToDo
```
#### Get Single Document
To get a document with a document name use the ```GetAsync``` method.
```cs
...
var doc = await frappe.Db.GetAsync("ToDo", "340a5acab3");
Console.WriteLine(doc.name); // 340a5acab3
```
This method will throw a ```KeyNotFoundException``` if the document for the suplied name is not found.
#### Get a Value from Document
```cs
...
string[,] filter = { { "name", "=", "bafc4c81fe" } };
var value = await frappe.Db.GetValueAsync("ToDo", "description", filter);
Console.WriteLine(value) // Some ToDo description
```
#### Get Single Value from Single-Type Document
```cs
...
var value = await frappe.Db.GetSingleValueAsync("Website Settings", "website_theme");
Console.WriteLine(doc.name) // Standard
```
#### Set a Single Value in a Document
```cs
...
// returns the updated document as a ```dynamic``` object
await frappe.Db.SetValueAsync("ToDo", doc.name.ToObject(), "description", data);
```
#### Insert Document
```cs
...
var doc = await frappe.Db.InsertAsync(
new Dictionary {
{ "doctype", "ToDo"},
{ "description", desc}
}
);
Console.WriteLine(doc.description.ToString()); // desc
```
#### Insert Many Document
```cs
...
Dictionary[] manyDocs = {
new Dictionary {
{ "doctype", "ToDo"},
{ "description","Description 1"}
},
new Dictionary {
{ "doctype", "ToDo"},
{ "description", "Description 2"}
}
};
var docs = await frappe.Db.InsertManyAsync(manyDocs);
Console.WriteLine((int)docs.Count); // 2
```
#### Update (save) an existing Document
```cs
var doc = await Frappe.Db.GetAsync("ToDo", "xxxxxx");
doc.description = "new description";
// Note that the document received from Get will not contain a
// ```doctype``` property for hence the need to add it before save
doc.doctype = "ToDo";
await Frappe.Db.SaveAsync(doc);
var updateDoc = await Frappe.Db.GetAsync("ToDo", doc.name.ToString());
```