### Project Setup with pnpm

Source: https://github.com/kintone/js-sdk/blob/main/CONTRIBUTING.md

Installs project dependencies using pnpm. Ensure Node.js and pnpm are managed by mise.

```sh
cd js-sdk
mise install
pnpm install
```

--------------------------------

### Install and Run Plugin Uploader (Global)

Source: https://github.com/kintone/js-sdk/blob/main/packages/plugin-uploader/README.md

Install the package globally for command-line access.

```bash
% npm install -g @kintone/plugin-uploader
% kintone-plugin-uploader \
--base-url ${yourKintoneBaseUrl} \
--username ${yourLoginName} \
--password ${yourPassword} \
${pluginZipPath}
```

--------------------------------

### Get Installed Plugins with Kintone REST API Client

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest-api-client/docs/plugin.md

Demonstrates how to fetch a list of installed plug-ins using the Kintone REST API client. It includes basic error handling.

```typescript
const client = new KintoneRestAPIClient();

(async () => {
  try {
    console.log(await client.plugin.getPlugins({ offset: 1, limit: 10 }));
  } catch (error) {
    console.log(error);
  }
})();
```

--------------------------------

### Install Plugin

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest-api-client/docs/plugin.md

Installs a plugin into the Kintone environment using a file key.

```APIDOC
## POST /kintone/v1/plugins

### Description
Installs a plugin into the Kintone environment.

### Method
POST

### Endpoint
/kintone/v1/plugins

### Parameters
#### Request Body
- **fileKey** (String) - Required - The fileKey representing an uploaded file. Use the following API to upload the file and retrieve the fileKey: https://kintone.dev/en/docs/kintone/rest-api/files/upload-file/

### Response
#### Success Response (200)
- **id** (String) - The installed plug-in ID.
- **version** (String) - The version number of the plug-in.

### Response Example
{
  "id": "12345",
  "version": "1.0.0"
}
```

--------------------------------

### Install Plugin

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest-api-client/docs/plugin.md

Installs an imported plug-in into the Kintone environment.

```APIDOC
## POST /kintone/plugins

### Description
Install an imported plug-in in the Kintone environment.

### Method
POST

### Endpoint
/kintone/plugins

### Parameters
#### Request Body
- **id** (String) - Required - The ID of the plug-in to install.
- **fileKey** (String) - Required - The fileKey representing an uploaded file.

### Response
#### Success Response (200)
- **id** (String) - The plug-in ID of the installed plug-in.
- **version** (String) - The version number of the plug-in.

#### Response Example
{
  "id": "plugin-id-1",
  "version": "1.0.0"
}
```

--------------------------------

### Navigate to Project and Start Development

Source: https://github.com/kintone/js-sdk/blob/main/packages/create-plugin/README.md

After the plugin project is created, change into the project directory and run 'npm start' to begin development.

```bash
cd hello-kintone-plugin
npm start
```

--------------------------------

### Install and Run Plugin Uploader (Local)

Source: https://github.com/kintone/js-sdk/blob/main/packages/plugin-uploader/README.md

Install the package locally and execute the uploader using npm scripts.

```bash
% npm install @kintone/plugin-uploader
% ./node_modules/.bin/kintone-plugin-uploader \
--base-url ${yourKintoneBaseUrl} \
--username ${yourLoginName} \
--password ${yourPassword} \
${pluginZipPath}
```

--------------------------------

### Install and Run Create Plugin CLI

Source: https://github.com/kintone/js-sdk/blob/main/packages/create-plugin/README.md

Use npx to run the create-plugin command directly, or install it globally first for repeated use.

```bash
npx @kintone/create-plugin ${name}
```

```bash
npm install -g @kintone/create-plugin
create-kintone-plugin ${name}
```

--------------------------------

### Install and Initialize Customize Uploader

Source: https://github.com/kintone/js-sdk/blob/main/packages/customize-uploader/README.md

Install the package using npm and initialize a customize-manifest.json file. You will be prompted for the app ID and customization scope.

```bash
% npm install @kintone/customize-uploader

% ./node_modules/.bin/kintone-customize-uploader init
? Input your app id: {appId}
? Select the scope of customization: "ALL" | "ADMIN" | "NONE"

dest/customize-manifest.json file has been created
```

```bash
% npm install -g @kintone/customize-uploader

% kintone-customize-uploader init
? Input your app id: {appId}
? Select the scope of customization: "ALL" | "ADMIN" | "NONE"

dest/customize-manifest.json file has been created
```

--------------------------------

### Install kintone-rest-api-client with npm

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest-api-client/README.md

Install the library using npm. You can then import it using CommonJS or ES modules.

```shell
npm install @kintone/rest-api-client
```

--------------------------------

### Get Required Plugins

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest-api-client/docs/plugin.md

Retrieves a list of plugins that need to be installed for the current Kintone environment.

```APIDOC
## GET /kintone/plugins

### Description
Retrieves a list of plugins that need to be installed.

### Method
GET

### Endpoint
/kintone/plugins

### Response
#### Success Response (200)
- **plugins** (Array) - A list of Plug-ins that needs to be installed.
  - **plugins[].id** (String) - The Plugin ID.
  - **plugins[].name** (String) - The name of the Plugin.
  - **plugins[].isMarketPlugin** (Boolean) - States whether or not the plug-in is a Marketplace plug-in.
    - true: The plug-in is a Marketplace plug-in.
    - false: The plug-in is not a Marketplace plug-in.

#### Response Example
{
  "plugins": [
    {
      "id": "plugin-id-1",
      "name": "Example Plugin",
      "isMarketPlugin": false
    }
  ]
}
```

--------------------------------

### Install @kintone/eslint-plugin

Source: https://github.com/kintone/js-sdk/blob/main/packages/eslint-plugin/README.md

Install the plugin as a development dependency using npm.

```shell
npm i -D @kintone/eslint-plugin
```

--------------------------------

### Get Form Fields Example

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest-api-client/docs/app.md

Demonstrates how to retrieve form fields for a specific app. Ensure you have initialized the KintoneRestAPIClient.

```typescript
const client = new KintoneRestAPIClient();

(async () => {
  try {
    console.log(await client.app.getFormFields({ app: "1" }));
  } catch (error) {
    console.log(error);
  }
})();
```

--------------------------------

### Install @kintone/rest

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest/docs/migration-from-rest-api-client.md

Install the new kintone REST API client package using npm.

```bash
npm install @kintone/rest
```

--------------------------------

### Install and Build dts-gen with pnpm

Source: https://github.com/kintone/js-sdk/blob/main/packages/dts-gen/docs/maintenance-guide.md

Use these commands to install dependencies and build the dts-gen package. Ensure pnpm is installed globally.

```bash
pnpm install
pnpm build
```

--------------------------------

### Running the Development Server

Source: https://github.com/kintone/js-sdk/blob/main/CONTRIBUTING.md

Starts the development server for the kintone/js-sdk project.

```sh
cd js-sdk
pnpm start
```

--------------------------------

### Install Dependencies for Modern Template

Source: https://github.com/kintone/js-sdk/blob/main/packages/create-plugin/README.md

When using the experimental 'modern' template, install React and its type definitions.

```bash
npm install react react-dom
npm install --save-dev @types/react @types/react-dom # type definition for React and ReactDOM
```

--------------------------------

### Initialize Kintone REST API Client and Get Records

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest-api-client/README.md

Initializes the client with password authentication and retrieves records from a specified app. Ensure environment variables for username and password are set. This example is suitable for Node.js environments.

```javascript
const client = new KintoneRestAPIClient({
  baseUrl: "https://example.cybozu.com",
  // Use password authentication
  auth: {
    username: process.env.KINTONE_USERNAME,
    password: process.env.KINTONE_PASSWORD,
  },
  // Use API token authentication
  // auth: { apiToken: process.env.KINTONE_API_TOKEN }
  // Use OAuth token authentication
  // auth: { oAuthToken: process.env.KINTONE_OAUTH_TOKEN }

  // Use session authentication if `auth` is omitted (in browser only)
});

client.record
  .getRecords({ app: "1" })
  .then((resp) => {
    console.log(resp.records);
  })
  .catch((err) => {
    console.log(err);
  });
```

--------------------------------

### Install kintone-plugin-packer CLI

Source: https://github.com/kintone/js-sdk/blob/main/packages/plugin-packer/README.md

Install the plugin packer globally using npm. This makes the `kintone-plugin-packer` command available in your terminal.

```bash
npm install -g @kintone/plugin-packer
```

--------------------------------

### Install @kintone/dts-gen

Source: https://github.com/kintone/js-sdk/blob/main/packages/dts-gen/README.md

Install the dts-gen package as a development dependency using npm.

```bash
npm install -D @kintone/dts-gen
```

--------------------------------

### Install webpack-plugin-kintone-plugin

Source: https://github.com/kintone/js-sdk/blob/main/packages/webpack-plugin-kintone-plugin/README.md

Install the plugin using npm. This command adds the plugin to your project's dependencies.

```bash
npm install @kintone/webpack-plugin-kintone-plugin

```

--------------------------------

### ESLint Script Example

Source: https://github.com/kintone/js-sdk/blob/main/CONTRIBUTING.md

Example of a `lint` script using the `eslint` command for source file linting.

```sh
eslint
```

--------------------------------

### TypeScript Build Script Example

Source: https://github.com/kintone/js-sdk/blob/main/CONTRIBUTING.md

Example of a `build` script using `tsc --build --force` for building TypeScript projects.

```sh
tsc --build --force
```

--------------------------------

### TOML Credentials File Example

Source: https://github.com/kintone/js-sdk/blob/main/packages/profile-loader/README.md

Store default and profile-specific credentials like username, password, apiToken, and oAuthToken in a TOML file.

```toml
# The default setting, so the function
[default]
username = "bob"
password = "pass"
apiToken = "api_token1,api_token2"
oAuthToken = "oauth_token"

[staging]
username = "staging-bob"
password = "staging-pass"
apiToken = "staging-api_token1,staging-api_token2"
oAuthToken = "staging-oauth_token"
```

--------------------------------

### Get App Settings

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest-api-client/docs/app.md

Retrieves the description, name, icon, revision, and color theme of an app.

```APIDOC
## GET /kintone/api/v1/app/settings

### Description
Gets the description, name, icon, revision and color theme of an app.

### Method
GET

### Endpoint
/kintone/api/v1/app/settings

### Parameters
#### Query Parameters
- **app** (Number or String) - Required - The app ID.

### Response
#### Success Response (200)
- **name** (String) - The name of the app.
- **description** (String) - The description of the app.
- **icon** (Object) - The icon of the app.
  - **id** (String) - The ID of the icon.
- **color** (String) - The color theme of the app.
- **revision** (String) - The revision number of the app settings.

#### Response Example
```json
{
  "name": "App Name",
  "description": "App Description",
  "icon": {
    "id": "icon_id"
  },
  "color": "blue",
  "revision": "1"
}
```
```

--------------------------------

### Get Apps by Plugin ID

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest-api-client/docs/plugin.md

Gets a list of Kintone Apps that have a specific plugin installed.

```APIDOC
## GET /kintone/plugins/{id}/apps

### Description
Gets Apps that have the specified plug-in added.

### Method
GET

### Endpoint
/kintone/plugins/{id}/apps

### Parameters
#### Path Parameters
- **id** (String) - Required - The ID of the plug-in.

#### Query Parameters
- **offset** (Number) - Optional - The number of apps to skip from the list of app. If ignored, this value is 0.
- **limit** (Number) - Optional - The maximum number of apps to retrieve. Must be between 1 and 500. The default number is 100.

### Response
#### Success Response (200)
- **apps** (Array) - A list of objects containing the App ID and name. Objects are listed in ascending order of their App IDs.
  - **apps[].id** (String) - The App ID.
  - **apps[].name** (String) - The name of the App.

#### Response Example
{
  "apps": [
    {
      "id": "app-id-1",
      "name": "App Name 1"
    }
  ]
}
```

--------------------------------

### Execute setup-test-app Utility

Source: https://github.com/kintone/js-sdk/blob/main/packages/dts-gen/docs/maintenance-guide.md

This command-line utility prepares a kintone app for integration testing by creating an app, setting fields, uploading test JavaScript, deploying the app, and adding demo records. Provide your kintone credentials and base URL.

```bash
node ./dist/integration-tests/setup-test-app.js \
    -u *** \
    -p *** \
    --base-url https://****.cybozu.com \
    --integration-test-js-file ./dist/dts-gen-integration-test.js
```

--------------------------------

### Upload and Download File Example

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest-api-client/docs/file.md

Demonstrates uploading a file, attaching it to a record, and then downloading it using the file key. Ensure the KintoneRestAPIClient is initialized.

```typescript
const client = new KintoneRestAPIClient();

(async () => {
  const APP_ID = "1";
  const ATTACHMENT_FIELD_CODE = "Attachment";

  const FILE = {
    name: "Hello.txt",
    data: "Hello World!",
  };

  // Upload a file and attach it to a record
  const { fileKey } = await client.file.uploadFile({
    file: FILE,
  });
  const { id } = await client.record.addRecord({
    app: APP_ID,
    record: {
      [ATTACHMENT_FIELD_CODE]: {
        value: [{ fileKey }],
      },
    },
  });

  // Download the attached file
  const { record } = await client.record.getRecord({
    app: APP_ID,
    id,
  });
  const data = await client.file.downloadFile({
    fileKey: record[ATTACHMENT_FIELD_CODE].value[0].fileKey,
  });
  console.log(data.toString()); // Hello World!
})();
```

--------------------------------

### Interactive Plugin Creation

Source: https://github.com/kintone/js-sdk/blob/main/packages/create-plugin/README.md

Run the create-plugin command to be prompted for plugin details like name, description, and language support.

```bash
npx @kintone/create-plugin hello-kintone-plugin
:
Please answer some questions to create your kintone plugin project :)
Let's start!


? Input your plugin name in English [1-64chars] hello-kintone-plugin
? Input your plugin description in English [1-200chars] hello-kintone-plugin
? Does your plugin support Japanese? Yes
? Input your plugin name in Japanese [1-64chars] (Optional)
? Input your plugin description in Japanese [1-200chars] (Optional)
? Does your plugin support Chinese? Yes
? Input your plugin name in Chinese [1-64chars] (Optional)
? Input your plugin description in Chinese [1-200chars] (Optional)
? Does your plug-in support Spanish?
? Input your plug-in name in Spanish [1-64chars] (Optional)
? Input your plug-in description in Spanish [1-200chars] (Optional)
? Input your home page url for English (Optional)
? Input your home page url for Japanese (Optional)
? Input your home page url for Chinese (Optional)
? Input your home page url for Spanish (Optional)
? Does your plugin support mobile views? Yes
? Do you use @kintone/plugin-uploader? Yes
:
:
:
Success! Created hello-kintone-plugin at hello-kintone-plugin

npm start

  Start the process watching file changes and create a kintone plugin zip.
  And then, the plugin zip is uploaded automatically by @kintone/plugin-uploader.

npm run build

  Create a kintone plugin zip.

npm run lint

  Lint js files with ESLint.

Try the following commands
And then, please input your information for kintone account

  cd hello-kintone-plugin
  npm start

Enjoy Hacking kintone plugin!
```

--------------------------------

### TOML Configuration File Example

Source: https://github.com/kintone/js-sdk/blob/main/packages/profile-loader/README.md

Define default and profile-specific settings in a TOML file. Settings in the config file are loaded if they correspond to environment variables.

```toml
# The default setting, so the function
[default]
baseUrl = "https://example.kintone.com"
# Custom settings
debug = true

[staging]
baseUrl = "https://staging-example.kintone.com"
# Custom settings
debug = false
```

--------------------------------

### addApp

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest-api-client/docs/app.md

Creates a preview app. The Deploy App Settings API must be used on the created preview app for the app to become live.

```APIDOC
## POST /kintone/api/v1/apps

### Description
Creates a preview app.

### Method
POST

### Endpoint
/kintone/api/v1/apps

### Parameters
#### Request Body
- **name** (string) - Required - The app name. The maximum length is 64 characters.
- **space** (number or string) - Optional - The space ID of where the app will be created.

### Response
#### Success Response (200)
- **app** (string) - The app ID of the created preview app.
- **revision** (string) - The revision number of the app settings.
```

--------------------------------

### Building and Testing the Project

Source: https://github.com/kintone/js-sdk/blob/main/CONTRIBUTING.md

Builds the project, runs tests, and performs linting. Ensure you run `pnpm build` before `pnpm test` or `pnpm lint`.

```sh
cd js-sdk
pnpm build
pnpm test
pnpm lint
```

--------------------------------

### Jest Test Script Example

Source: https://github.com/kintone/js-sdk/blob/main/CONTRIBUTING.md

Example of a `test` script using the `jest` command for running tests.

```sh
jest
```

--------------------------------

### TypeScript Clean Script Example

Source: https://github.com/kintone/js-sdk/blob/main/CONTRIBUTING.md

Example of a `clean` script using `rimraf` to remove build assets.

```sh
pnpm clean
```

--------------------------------

### Package kintone plugin using npm script

Source: https://github.com/kintone/js-sdk/blob/main/packages/plugin-packer/README.md

Configure your `package.json` to include a script for packaging your kintone plugin. This example assumes your private key is at `./private.ppk` and your plugin source is in the `./plugin` directory.

```json
{
  "scripts": {
    "package": "kintone-plugin-packer --ppk private.ppk plugin"
  }
}
```

--------------------------------

### Import Customize Manifest

Source: https://github.com/kintone/js-sdk/blob/main/packages/customize-uploader/README.md

Import customization settings from kintone by providing the path to the manifest file. You will be prompted for kintone base URL, username, and password.

```bash
% ./node_modules/.bin/kintone-customize-uploader import dest/customize-manifest.json
? Input your kintone's base URL (https://example.cybozu.com): {kintoneBaseUrl}
? Input your username: {userLoginName}
? Input your password: [input is hidden] {yourPassword}

Generate customize-manifest.json from kintone app customize
Download Uploaded files on kintone app customize
Finish importing from kintone app customize
```

```bash
% kintone-customize-uploader import dest/customize-manifest.json
? Input your kintone's base URL (https://example.cybozu.com): {kintoneBaseUrl}
? Input your username: {userLoginName}
? Input your password: [input is hidden] {yourPassword}

Generate customize-manifest.json from kintone app customize
Download Uploaded files on kintone app customize
Finish importing from kintone app customize
```

--------------------------------

### Install Plugin Manifest Validator

Source: https://github.com/kintone/js-sdk/blob/main/packages/plugin-manifest-validator/README.md

Install the validator package using npm. This command adds the package as a development dependency.

```bash
npm install @kintone/plugin-manifest-validator
```

--------------------------------

### Conventional Commit Message Example

Source: https://github.com/kintone/js-sdk/blob/main/CONTRIBUTING.md

Example of a commit message following Conventional Commits format, including the package scope.

```sh
# rest-api-client is the scope of this commit
feat(rest-api-client): add record.getRecord()
```

--------------------------------

### Call getAppAcl API for Pre-Live App with @kintone/rest-api-client

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest/docs/migration-from-rest-api-client.md

Use the `preview: true` parameter to target pre-deployment apps.

```typescript
const getAppAcl = await client.app.getAppAcl({ app: "1", preview: true });
```

--------------------------------

### Create Client with Password Authentication (TypeScript)

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest/docs/migration-from-rest-api-client.md

Demonstrates creating a client instance with password authentication in TypeScript. Requires explicit auth type.

```typescript
import { createClient } from "@kintone/rest";

const client = createClient({
  baseUrl: "https://example.cybozu.com",
  auth: {
    type: "password",
    username: process.env.KINTONE_USERNAME,
    password: process.env.KINTONE_PASSWORD,
  },
});
```

--------------------------------

### KintoneRest Initialization Parameters

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest/README.md

Configure the KintoneRest client with various options for authentication, proxy, and user agent.

```APIDOC
## Parameters for `KintoneRest`

### `clientCertAuth.pfxFilePath`
- **Type**: String
- **Description**: The path to the client certificate file. Required, unless `pfx` is specified.

### `clientCertAuth.password`
- **Type**: String
- **Description**: The password for the client certificate.

### `proxy`
- **Type**: Object
- **Description**: **Available only in Node.js environment.** Configure proxy settings if you are using a proxy server.
  - ### `proxy.protocol`
    - **Type**: String
    - **Description**: The protocol of the proxy server. Defaults to `http`.
  - ### `proxy.host`
    - **Type**: String
    - **Description**: The host of the proxy server.
  - ### `proxy.port`
    - **Type**: Number
    - **Description**: The port of the proxy server.
  - ### `proxy.auth`
    - **Type**: Object
    - **Description**: Configure Basic authentication for the proxy server if required.
      - ### `proxy.auth.username`
        - **Type**: String
        - **Description**: The username for Basic authentication.
      - ### `proxy.auth.password`
        - **Type**: String
        - **Description**: The password for Basic authentication.

### `userAgent`
- **Type**: String
- **Description**: **Available only in Node.js environment.** A User-Agent HTTP header to be sent with requests.
```

--------------------------------

### Jest CI Test Script Example

Source: https://github.com/kintone/js-sdk/blob/main/CONTRIBUTING.md

Example of a `test:ci` script using `jest --runInBand` for running tests in CI environments.

```sh
jest --runInBand
```

--------------------------------

### AJV Error Object Example

Source: https://github.com/kintone/js-sdk/blob/main/packages/plugin-manifest-validator/README.md

An example of the structure of an error object returned by the validator, conforming to AJV (Another JSON Schema Validator) error formats.

```javascript
{
  dataPath: '/version',
  keyword: 'type',
  message: 'should be integer',
  params: {
    type: 'integer',
  },
  schemaPath: '#/properties/version/type',
}
```

--------------------------------

### getAppAcl

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest-api-client/docs/app.md

Gets the app permissions of an app.

```APIDOC
## GET /kintone/api/v1/apps/{appId}/acl

### Description
Gets the app permissions of an app.

### Method
GET

### Endpoint
/kintone/api/v1/apps/{appId}/acl

### Parameters
#### Query Parameters
- **app** (number or string) - Required - The app ID
- **preview** (boolean) - Optional - A flag whether to get the app permissions for pre-live environment
```

--------------------------------

### Create App

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest-api-client/docs/app.md

Creates a new Kintone application with specified settings. Requires app ID, name, and optionally accepts description, icon, theme, and title field configurations.

```APIDOC
## POST /kintone/api/v1/apps

### Description
Creates a new Kintone application.

### Method
POST

### Endpoint
/kintone/api/v1/apps

### Parameters
#### Request Body
- **app** (Number or String) - Required - The app ID.
- **name** (String) - Optional - The app name.
- **description** (String) - Optional - The app description. The maximum character limit is 10,000. HTML tags can be used.
- **icon** (Object) - Optional - An object containing information of the app icon.
  - **icon.type** (String) - Conditionally Required - The icon type. Specify one of the following: `FILE`, `PRESET`. Required, if the "icon" parameter will be set.
  - **icon.key** (String) - Conditionally Required - The key identifier of the icon. Required, if the `icon.type` parameter is set as `PRESET`.
  - **icon.file** (Object) - Conditionally Required - An object containing data of uploaded icon files. Required, if the `icon.type` parameter is set as `FILE`.
    - **icon.file.fileKey** (String) - Conditionally Required - The fileKey of the icon. To attach a file, specify the fileKey responded when using [File#uploadFile()](https://github.com/kintone/js-sdk/blob/main/packages/rest-api-client/docs/file.md#uploadFile). The maximum file size limit is 800KB. Required, if the `icon.type` parameter is set as `FILE`.
- **theme** (String) - Optional - The color theme. The following can be specified: `WHITE`, `RED`, `BLUE`, `GREEN`, `YELLOW`, `BLACK`. If you specify values correspond to classic themes(`CLIPBOARD`, `BINDER`, `PENCIL`, `CLIPS`), the app is displayed as `WHITE` theme.
- **titleField** (Object) - Optional - The record title.
```

--------------------------------

### getRecordAcl

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest-api-client/docs/app.md

Gets the record permission settings of an app.

```APIDOC
## getRecordAcl

### Description
Gets the record permission settings of an app.

### Endpoint
/kintone/api/k/v1/app/acl.json
```

--------------------------------

### Get Admin Notes

Source: https://github.com/kintone/js-sdk/blob/main/packages/rest-api-client/docs/app.md

Retrieves notes and their settings for app administrators.

```APIDOC
## GET /kintone/api/v1/app/admin_notes.json

### Description
Gets notes for app administrators and their settings.

### Method
GET

### Endpoint
/kintone/api/v1/app/admin_notes.json

### Parameters
#### Query Parameters
- **app** (Number or String) - Required - The App ID.
- **preview** (Boolean) - Optional - A flag whether to get the app actions for pre-live environment.

### Response
#### Success Response (200)
- **content** (String) - The content of the notes. If not set, an empty string is returned.
- **includeInTemplateAndDuplicates** (Boolean) - The permission settings to include this note in app templates or duplicates.
- **revision** (String) - The revision number of the App settings.

### Reference
- https://kintone.dev/en/docs/kintone/rest-api/apps/get-app-admin-notes/
```