kintone 0.6.2

kintone 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

//! # Add Form Field Example
//!
//! This example demonstrates how to add fields to a Kintone app's form using the add_form_field API.
//! The example shows how to create various types of fields including text, number, date, and choice fields.
//!
//! ## Usage
//!
//! ```bash
//! cargo run --example add_form_field
//! ```
//!
//! ## Environment Variables
//!
//! Set the following environment variables before running:
//! - `KINTONE_BASE_URL`: Your Kintone domain (e.g., "https://example.cybozu.com")
//! - `KINTONE_USERNAME`: Your Kintone username
//! - `KINTONE_PASSWORD`: Your Kintone password
//! - `KINTONE_APP_ID`: The ID of the app to add fields to

use kintone::client::{Auth, KintoneClient};
use kintone::model::app::field::{
    Alignment, FieldOption, UnitPosition, date_field_property, multi_line_text_field_property,
    number_field_property, radio_button_field_property, single_line_text_field_property,
};
use kintone::v1::app::form;
use std::collections::BTreeMap;
use std::env;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Read configuration from environment variables
    let base_url =
        env::var("KINTONE_BASE_URL").expect("KINTONE_BASE_URL environment variable is required");
    let username =
        env::var("KINTONE_USERNAME").expect("KINTONE_USERNAME environment variable is required");
    let password =
        env::var("KINTONE_PASSWORD").expect("KINTONE_PASSWORD environment variable is required");
    let app_id: u64 = env::var("KINTONE_APP_ID")
        .expect("KINTONE_APP_ID environment variable is required")
        .parse()
        .expect("KINTONE_APP_ID must be a valid number");

    // Create client with username/password authentication
    // Note: App management APIs require username/password authentication, API tokens cannot be used
    let client = KintoneClient::new(&base_url, Auth::password(username, password));

    println!("Adding form fields to app {app_id}");

    // Create various field types to demonstrate the API

    // 1. Single Line Text Field
    let customer_name_field = single_line_text_field_property("customer_name")
        .label("Customer Name")
        .required(true)
        .max_length(100)
        .build();

    // 2. Number Field
    let price_field = number_field_property("price")
        .label("Price")
        .required(true)
        .min_value(0.into())
        .digit(true) // Show thousand separators
        .display_scale(2) // 2 decimal places
        .unit("USD")
        .unit_position(UnitPosition::Before)
        .build();

    // 3. Date Field
    let order_date_field = date_field_property("order_date")
        .label("Order Date")
        .required(true)
        .default_now_value(true) // Default to current date
        .build();

    // 4. Radio Button Field (choice field)
    let mut priority_options = BTreeMap::new();
    priority_options.insert(
        "High".to_owned(),
        FieldOption {
            label: "High".to_owned(),
            index: 0,
        },
    );
    priority_options.insert(
        "Medium".to_owned(),
        FieldOption {
            label: "Medium".to_owned(),
            index: 1,
        },
    );
    priority_options.insert(
        "Low".to_owned(),
        FieldOption {
            label: "Low".to_owned(),
            index: 2,
        },
    );

    let priority_field = radio_button_field_property("priority")
        .label("Priority")
        .required(true)
        .options(priority_options)
        .default_value("Medium")
        .align(Alignment::Horizontal)
        .build();

    // 5. Multi-line Text Field
    let description_field =
        multi_line_text_field_property("description").label("Description").build();

    // Send the request to add all fields
    let response = form::add_form_field(app_id)
        .field(customer_name_field.into())
        .field(price_field.into())
        .field(order_date_field.into())
        .field(priority_field.into())
        .field(description_field.into())
        .send(&client)?;

    println!("Successfully added form fields!");
    println!("New app revision: {}", response.revision);
    println!();
    println!("Note: The fields have been added to the preview environment.");
    println!("To apply these changes to the production environment, you need to deploy the app.");
    println!("You can use the deploy_app API or deploy manually from the app settings interface.");

    Ok(())
}