codemountains/collaboflow-rs

A Collaboflow REST API client for Rust language.

Collaboflow REST API Client

A Collaboflow REST API client for Rust language.

This is not an official crate, just a hobby project.

Installation

Requirements

• Rust 1.65.0+

Importing

The driver is available on crates.io.

To use the driver in your application, simply add it to your project's Cargo.toml.

[dependencies]
collaboflow-rs = "0.0.13"

Example Usage

[dependencies]
collaboflow-rs = "0.0.13"
tokio = "1.22.0"

use collaboflow_rs::{Authorization, CollaboflowClient, Query};

#[tokio::main]
async fn main() -> Result<(), ()> {
    let authorization = Authorization::with_api_key("User id", "API key");

    let client = CollaboflowClient::new("https://{Collaboflow url}/{Instance name}/api/index.cfm", authorization);

    let query = Query::builder().app_cd(1); // Your app cd

    let document_id: i32 = 1; // Your document id
    let result = client.document.get(document_id, query).await;
    match result {
        Ok(resp) => {
            println!("{:?}", resp);
            Ok(())
        },
        Err(err) => {
            println!("{:?}", err);
            Err(())
        }
    }
}

Support APIs

Document

• getDocumentOverview
• requestDocument
• putDocumentStatus
• deleteDocument
• getDeterms
• getDocumentContents
• simulateDeterms
• searchDocument

MyStatus

• getMyDeterms
• getMyRequests
• getMyDrafts
• getMyProcesses

File

• uploadFile
• downloadFile

Form

• getForms
• getFormParts
• getFormSettingsPrints

User

• getUsers
  • Query fields is not supported.
• postUser
• getUser
• putUser
• deleteUser

Group

• getGroups
  • Query fields is not supported.
• postGroup
• getGroup
• putGroup
• deleteGroup

Title

• getTitles
  • Query fields is not supported.
• postTitle
• getTitle
• putTitle
• deleteTitle

LICENSE

This project is licensed under the MIT license.

collaboflow-rs's Issues

Fix tokio version in README

Fix tokio version in README

Refactoring status

Refactoring status in response.

Fix `response.rs`

Fix response.rs

Create tests dir.

Create tests dir.

Fix `DetermRecord`

Move record dir.

Write docs.rs

Write docs.rs

Fix `PutDocumentStatusRequest`

Fix PutDocumentStatusRequest

the trait std::error::Error is not implemented for ErrorResponse

the trait std::error::Error is not implemented for ErrorResponse.

Use reqwest `query()`

Use reqwest query()

pub fn query<T: Serialize + ?Sized>(self, query: &T)

AuthorizationType doesn't implement Debug

AuthorizationType doesn't implement Debug.

Query params `fields` is not working.

Query params fields is not working.

getTitles

Err(ErrorResponse { status: 200, body: ErrorResponseBody { error: true, messages: ["error decoding response body: missing field `id` at line 1 column 32"] } })

Query builder

Implement a Query builder.

Change `user_id` type from `String` to `&str`.

Change user_id type from String to &str.

let resp = client.user.get("user_id".to_string()).await?;

let resp = client.user.get("user_id").await?;

Define HEADER_KEY in authorization.rs .

Define HEADER_KEY in authorization.rs.

`tokio` is `dev-dependencies` ?