66 Commits
Author SHA1 Message Date
StevanFreeborn 321baac650 docs: update docs 2026-03-25 19:54:58 +00:00
Stevan Freeborn b2af266eb4 Merge pull request #28 from StevanFreeborn/stevanfreeborn/fix/address-vuln-deps
fix: update dependencies to address vulnerabilities
2026-03-25 14:53:11 -05:00
Stevan Freeborn d83403e88d fix: update dependencies to address vulnerabilities 2026-03-25 14:45:12 -05:00
Stevan Freeborn 50fd735808 Merge pull request #23 from StevanFreeborn/stevanfreeborn/fix/address-vulns-in-deps
fix: update dependencies and address vulnerabilities in dependencies
2025-10-07 11:36:31 -05:00
StevanFreeborn e4a7e5c7c3 fix: resolve linter errors 2025-10-07 16:31:25 +00:00
Stevan Freeborn 5218f5598a chore: update github actions workflow 2025-10-07 11:30:45 -05:00
Stevan Freeborn b9f8929635 chore: update prettier config 2025-10-07 11:26:07 -05:00
Stevan Freeborn 0bf8f06952 fix: update dependencies and address vulnerabilities in dependencies 2025-10-07 11:19:07 -05:00
StevanFreeborn 22d6f5c1bc docs: update docs 2025-04-16 02:47:49 +00:00
Stevan Freeborn a9e12ca81f chore: remove testing from build and publish workflow 2025-04-15 21:45:21 -05:00
Stevan Freeborn 437dab014e chore: separate build step 2025-04-15 21:34:05 -05:00
Stevan Freeborn 1b76de3812 Merge pull request #20 from StevanFreeborn/stevanfreeborn/fix/pass-correct-ids-in-report-constructor
fix: make sure proper ids are passed to constructor
2025-04-15 21:21:00 -05:00
Stevan Freeborn cecf975255 chore: update workflows 2025-04-15 21:18:36 -05:00
Stevan Freeborn ca34b036a7 fix: make sure proper ids are passed to constructor
- swapped ids being passed to correct appId and id properties
  are set
- upgraded out of date dependencies
- addressed vulnerable dependcies
2025-04-15 21:02:11 -05:00
Stevan Freeborn b89c1cfa45 Merge pull request #16 from StevanFreeborn/dependabot/github_actions/dot-github/workflows/actions/download-artifact-4.1.7
chore(deps): bump actions/download-artifact from 3.0.2 to 4.1.7 in /.github/workflows
2024-09-04 09:02:05 -05:00
dependabot[bot] cece16c03f chore(deps): bump actions/download-artifact in /.github/workflows
Bumps [actions/download-artifact](https://github.com/actions/download-artifact) from 3.0.2 to 4.1.7.
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](https://github.com/actions/download-artifact/compare/v3.0.2...v4.1.7)

---
updated-dependencies:
- dependency-name: actions/download-artifact
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-09-04 14:00:36 +00:00
Stevan Freeborn 6aa37418c2 Merge pull request #15 from StevanFreeborn/stevanfreeborn/fix/address-axios-deps
fix: upgrade axios
2024-08-14 09:27:42 -05:00
Stevan Freeborn 28b3820f04 fix: upgrade axios 2024-08-14 09:22:41 -05:00
Stevan Freeborn 2014fe73a0 Merge pull request #13 from StevanFreeborn/stevanfreeborn/chore/update-copyright-year
chore: update copyright year in license
2024-07-19 10:02:48 -05:00
Stevan Freeborn 40c1921a2c chore: update copyright year in license 2024-07-19 10:01:03 -05:00
StevanFreeborn d99d00e450 docs: update docs 2024-07-19 04:16:56 +00:00
Stevan Freeborn 2a67ead01a chore: update workflows 2024-07-18 23:09:24 -05:00
Stevan Freeborn b7ce837bb2 chore: update workflows 2024-07-18 23:08:22 -05:00
Stevan Freeborn 762c0fd86d fix: address vulns and upgrade deps 2024-07-18 23:02:25 -05:00
Stevan Freeborn 83c9d24dfa Merge pull request #12 from StevanFreeborn/stevanfreeborn/chore/upgrade-deps
chore: upgrade dependencies
2024-07-18 22:58:46 -05:00
Stevan Freeborn 11fa365566 chore: run format 2024-07-18 22:52:11 -05:00
Stevan Freeborn 8839ddb322 chore: update dependencies 2024-07-18 22:50:08 -05:00
Stevan Freeborn 16db7015f2 Merge pull request #10 from StevanFreeborn/stevanfreeborn/docs/automattic-documentation-generation
chore: add typedoc and use to generate updated documenation when publishing
2024-03-23 16:03:46 -05:00
Stevan Freeborn 3884526ada chore: update ignore files 2024-03-23 16:00:39 -05:00
Stevan Freeborn f1a87eb2aa chore: add typedoc and use to generate updated documenation when publishing 2024-03-23 15:44:49 -05:00
Stevan Freeborn 90a559a7c8 Merge pull request #9 from StevanFreeborn/stevanfreeborn/chore/fix-publish-workflow
chore: use latest version of node for publish job
2024-03-23 15:09:30 -05:00
Stevan Freeborn 819b6fc550 chore: use latest version of node for publish job 2024-03-23 15:08:50 -05:00
Stevan Freeborn 3fc167c0df Merge pull request #8 from StevanFreeborn/stevanfreeborn/chore/update-dependencies
chore: update dependencies to address vulns
2024-03-23 15:02:51 -05:00
Stevan Freeborn 682eacf1ee fix: update workflow to include test for v20 of node 2024-03-23 14:53:09 -05:00
Stevan Freeborn 920d8bbdfd chore: update actions 2024-03-23 14:44:16 -05:00
Stevan Freeborn de940a189e chore: update dependencies to address vulns 2024-03-23 14:17:01 -05:00
Stevan Freeborn aafeba7d31 Merge pull request #5 from StevanFreeborn/docs-add-downloads-badge
docs: add downloads count
2023-11-02 15:44:45 -05:00
Stevan Freeborn e0b4f85b3d docs: add downloads count 2023-11-02 15:44:17 -05:00
Stevan Freeborn 67477023ad Merge pull request #4 from StevanFreeborn/stevan/docs/fix-usage-typos
docs: fix typo in usage examples
2023-06-12 12:39:15 -05:00
Stevan Freeborn 9292780007 docs: fix typo in usage examples 2023-06-12 12:36:39 -05:00
Stevan Freeborn e937d05490 Merge pull request #3 from StevanFreeborn/fix/update-documentation
fix: update documentation
2023-02-21 22:40:19 -06:00
StevanFreeborn eac881ec58 chore: update build script and build workflow 2023-02-21 22:35:57 -06:00
StevanFreeborn 9ff9f24d85 chore: update husky commit-msg 2023-02-21 22:25:27 -06:00
StevanFreeborn f412594338 chore: update publish coverage job with step to checkout repo 2023-02-21 22:21:38 -06:00
Stevan Freeborn 1bc5248781 chore: more work on coverage job 2023-02-21 22:07:06 -06:00
Stevan Freeborn 16fc7e2eae chore: more work on coverage job 2023-02-21 22:02:15 -06:00
Stevan Freeborn 8930bc2777 chore: update publish_test_coverage job 2023-02-21 21:58:01 -06:00
Stevan Freeborn 866774b5a5 chore: update publish_test_coverage job 2023-02-21 21:51:52 -06:00
Stevan Freeborn 74a1133e6f chore: update publish_test_coverage job 2023-02-21 21:47:22 -06:00
Stevan Freeborn 5938f28603 chore: update publish_test_coverage job 2023-02-21 21:40:56 -06:00
Stevan Freeborn bc44ed3a7a chore: update publish_test_coverage job 2023-02-21 21:34:45 -06:00
Stevan Freeborn 06ac0e91b0 chore: update publish_test_coverage job 2023-02-21 21:20:38 -06:00
Stevan Freeborn 0f58867c49 fix: incorrectly spelled variable name corrected 2023-02-21 21:13:51 -06:00
Stevan Freeborn 0aa840873c docs: update README.md 2023-02-21 21:12:57 -06:00
Stevan Freeborn ad9325a840 fix: finished updating README.md 2023-02-21 20:49:49 -06:00
Stevan Freeborn 1fcf72dca3 Merge branch 'master' into fix/update-documentation 2023-02-21 16:50:16 -06:00
Stevan Freeborn 77edd0a1fa docs: add code examples to README.md
+ Added code example for configuring onspring client
+ Added code examples for field methods
+ Added code example for getFileInfoById method
2023-02-21 16:27:05 -06:00
Stevan Freeborn d700c4fe4c docs: added example usages for canConnect, getApps, getAppById, and getAppsByIds methods 2023-02-21 14:28:02 -06:00
Stevan Freeborn 52b5d36ddd chore: fix merge conflict 2023-02-21 13:54:33 -06:00
Stevan Freeborn dbdd3e1895 docs: begin working on code snippets 2023-02-21 13:48:32 -06:00
StevanFreeborn d8b6bf0b7b docs: stub out README.md 2023-02-21 13:48:32 -06:00
StevanFreeborn 07ec44a0ad fix: add jsdoc comments to models 2023-02-21 13:48:32 -06:00
StevanFreeborn e97ee15387 fix: update jsdoc comments for enums 2023-02-21 13:48:32 -06:00
StevanFreeborn f48189a881 docs: stub out README.md 2023-02-21 08:59:14 -06:00
StevanFreeborn 396660e801 fix: add jsdoc comments to models 2023-02-20 21:08:22 -06:00
StevanFreeborn f3c69d3a34 fix: update jsdoc comments for enums 2023-02-20 19:12:15 -06:00
110 changed files with 20405 additions and 2342 deletions
+24 -11
View File
@@ -1,12 +1,25 @@
#################################################################################
# #
# This file uniquely identifies your project in dotenv-vault. #
# You SHOULD commit this file to source control. #
# #
# Generated with 'npx dotenv-vault new' #
# #
# Learn more at https://dotenv.org/env-vault #
# #
#################################################################################
#/-------------------.env.vault---------------------/
#/ cloud-agnostic vaulting standard /
#/ [how it works](https://dotenv.org/env-vault) /
#/--------------------------------------------------/
DOTENV_VAULT=vlt_ec81c3b4428f6b230fe7295edceef4214cd1b7b5b04982ab652b12393652128a
# development
DOTENV_VAULT_DEVELOPMENT="EET3bpW+THawI82WM7Y9pQjrM01fy6ll19KJe3j/PeOGvKL03yMoX9UO/F9WAWYL/2+IQSuRIH20MHo0VlnCzUBOVDqwtLHZu9Cp9Sx7NJVZx58JvOLmKUwJxTgVkyQ82TnjiwDiblrvRshXD4fMKvX+PeONQBP2QrQQ8wmkb/q9ftMlZ3sSt/QnWl8xz6Ima5YCrnAHJxmZDSToCQ6nALhmZMxeJr3JlHQwCQ4g3MA4e55+okvC6HbAYrRMnDO15PKjP9t09SkzbMutk0HLDGrgufcrXJwezgQttj1eW5MykwUV035Ll9G+RZ5PLIOy4ZabTGfrJawdnCytBNjwCze/iOwAl6Po6nKWf7oKu3sw8D+s2mW99mVa9n2s6ynnPLFv8C26h5C+G361e/mV6HaQwAaXlWeCRb5Px59R7kWllsOl9SCll0qeBSzYkB6ML4Bs01dVCmDxEcdc7bImm/pl5NrmwreCvbhNSJjjJOY8nKdMr57xdzdZJPLeNNcEf3M5EHuPbUvQTaddSl3xzt6kz4f1Ri/P2yG/WsFxfvNQmmvUCZJ9Eo3wrqnXY4SAHBqxrhYs/gGVpcw7xudzUdHeAcCJA5tBbLwUWzP1rYdwvKzQZBFKSvDIvh1ltKUXxwF+A2y/7CIneQ41v9KXc6yP40tprmmHxXbJ+JJB0CmWCiCVciL2FymWYXXLNUn6HC6/qCaKC809qMM2aIgpPkRdNvQFB90kbDNbhCY2+s/0JUzy+SpmIS2UXC9sltW8yi7fLfeTdoSTCAw+CQqarQMYwtpCJBKNSQidXwWHzj9uXx1dw8993brAJnfweQxJmS61kkz23+y4j9owWxbwItmf3LAvNFXnjPyHml9vPr+aISY0qAL8qUMStXAU1i5vL01xKAsKYEwkEbNZ6U7aCBkrdKQSPKspyHlFqqvhAkzSnK1cffOkKTrUG7U5pMYuCp8HGshvoWXzItxuvke3BjgCf3eeCZFWFDr6iWo5oMa/Nh6ZLUQCdYdv0lbtKldconb64UJl+a+7I+MtlpZo8NhiuSKrJGkbFJO8j8XWfosqNHbocjMMyAyZ6KzWjuxhuSTWRkLERCrbrz8mnVMnNLBYCCdd676XMPkLjo3/w9rCVrWXA5gCdaaUNmn16w=="
DOTENV_VAULT_DEVELOPMENT_VERSION=2
# ci
DOTENV_VAULT_CI="0xoqtgp12KwxYGAXEELvdfPJhjEtQlCCUfNAujsfr60v8BFkrhLY2uD29NyCb0AqSmbT+j4ylx4jgt2gygNMWUkjHbv0wG8M1aJNUqKxmPe7K/zxrWecVxvLLefxVICiGv33sf3U4VfKXo4nVZJEMLjUDP+InmxQMLiuoSnFuW1m5vBfj3bWzO26Ihra7Di0lgOvZf6MBn7My96IRUy/fjoooVuQ9ZR0c7426nldVUYQPMgqG1zER9dton2hw2mCBM3Y4FnE4A52hjgp3j9jBeUyQptKjmFFMOkoPbGTtcZGMxnYe3kfv68rSzVgURb7HqVqNBHsQXGvplkOAzUjoFLNX9xy0/23Jq4bI620mfo2I1rBSanTydL4u8ND5/miCs2TFG6m1PQXr42wm6x6LNee7udOrgVHc/xtuausJ10QOYykgVX5AljqCpdHV6bi0/N9NvK1rptIIip+YsIovWkm5eetZNuMErBLVNXMxPlAzC6lJiKTPvsdiERBUpIooCybRZugopSBsrUl12WpmIim/ZqSt5AH2r6MFuZGzn6jQ85Y2XMllQtfbX4mu0a3rYnpFNKion/oIncCq+Cjb5+ml+u4T+/zh/q1L8k3V8ozvZ2JZbLATvaWdPJXx/UCGVwURhZhD13BaKSKtYYLZZ0WbmeoybfYbPSYZnC0nZG1QjOO3guVkXERSPdj8EXv+bCUyBSJhN6oBWRgRbU7TsAV8scAYwhWZjcjbsQCHFzITjEW3GmRVIiv43m0EDJC8FUvCYGwYe6c4ZKH44ND16L9VIr9s2zL9MV+OBw6wdkqrqUXTMSUMk86PJTDIgIXf5dSzpaa5CYoLyfdl70uWJ7VzqTo0G2rD+2BWCdtFQQ8G+TDJFL9RxXyh9iPEEDJ29mRIOi8bDmhX9DJXaaXa2MQ88oYiw=="
DOTENV_VAULT_CI_VERSION=2
# staging
DOTENV_VAULT_STAGING="GSOelGYItlUhRndkRS534Ml6GACM4pSw8J+Afno3B8MVMg+6Y+/rDzpfYs0r0+f7JMwL9IXFg5xIhJY+R01RWoUsRryBISmRvtOhKyW3FLKwdGkxMnjrJmOFBYRiVrLe/lJ2TSaSJoFzyddMuCjGPRuLXokx+DamzAfgRZmOGLASCX6NcoL6TPZJJFG+EWsP1oT7aYZe/TRa9Ls8U7MECajPOwr4/JYloUacLsI3+OANwZohHk06VO5J1vcFfT3YxcEYiQckhXB2ThQ/lEw6yZ19CZywQvDbEEb8Mx4T1W71FhyrIi8g4HXux9o7PjbBD0tTleetAtwFc3uVWieQP8Mz0TCPKK7SIlGF2Q8B2z7DZzNOPd4oeJmhRi0sCy9B8ln+QfudukqaSLSg0Ep6J9hv7qcjP2IVqM2DxpsyStgn58rNTrl7DQsOSiKmYhkfp4nLQ5OQFXvBuBD2vuYGq8Hn4IgJYiAed8UjqhYDPp8JEQmKA+dncjSUxyhSVc26SpeE0GGe61IeXiW2SPyCS2MU5k+ddkO/vB2xP/NCqXuL0p3DAyeM0d1nE/XCM8ffMgCmVnOsn7FyEnYus+YNQ0plIY9zA5ViM+vLCDMSpMlEasc/7gIo6bIn0LA3G+iwTS51h5Nh6WdGDk+43DnLbwAndcEnz9w8yOhPvsbR0AVXwW4pS8Y6X4c5NRhhviEcEjLgtPHXDF3Qq8px8fVYDAUtchsMmr2nZlsC2YqAzbZyA/kgzzPkyG8cc6LO7JOZYcZaWzaMG//JeDO4nEWEo4tV+uB3tjKSHiBGRzVTFbsAWYfzCrr2KeSA8M4ilF6oUEx98y0HQuC6oGd4zU/tr30/nZzMlwmTOfKRdn1QYlZnOa20eZWAqH2KMB+c6+r8ptHpK0ra8rw+8pQriUEa0QlWDNZrrw=="
DOTENV_VAULT_STAGING_VERSION=2
# production
DOTENV_VAULT_PRODUCTION="svC1qRFQixGHF02zu8WYycTaySFghAlgtJOFI2o2zHQt1DOWBv1Vl/0dEkowI8Ce2uoK9fMEI3prh4RY8dGjk71m3ifqTDGAnlodNzjyOtGLBZP6llA8BX8f4qy/lXJMLZ3PkHU+gPofNfXS05XFGP/NDgvxvGW7ouqGhqQhR3dGNRi6oEP9Gwk/A64QpldTfSWHSFmdV92VcnFkZEHkYfFr78JOKFbCV4OwDZVArMi/8cnjQbQwyjJtE5bxqhyOmDgrqjkoDX7kcz6cpkYB+Lp8Ruv5Os8p+dwJuqWlb46kGl5D08N177u64Pj9/aD0vhNMfKQ1sDDvCq1acCAU/5UeYmUnKXEIHuEnB2+8TcIje5RPF7eyBLrqd+1P+QtatacvTif19IfM9PyhqlzFbDmT+6ykVj1OT7OHczXxXELFJkA0K0Z/CHqjDaAexFbI/9SZsW+yoH757ceQxo6w65TJMeoggX97y2LCMZzHzi78VZOCgHWGrEXoVfU1XYK7rtDILEF8NsXyrr2DZsGPkJSp71rGWm1TSf5KCmJBb+3AIS83vIGLlBtwSxkfWEJW98izfYmBTjHUnnMh7h7QIPBcMFtTLHGKcdH1XQuWsKuYGNb5rgW6C1xgdN6UYGv4x9mOGeqT53xpPNk78aYGGhDtVeHQUGOJENbQX2/ZYLDI0LuCKVbay1KuaadPclQD6DyI6j7fZ8dSEFqwjCtq7LRKnGUXdYOQEaHgaE5NyuP0tOfA/4G9tduNtXjylgiDLrGiPWmlqJccHBoIP+fJophLjzSlVa/xITCKvXkTHTRAjmshou426bh0KVrDLFKXXonH8l3u/STPQQ3CCpVyuk8yvTyABDcnnBBhnfEE22uZJaboo/UtD6UWN7d279FOEBcO3jDVObMwvzWORchVbdNyTPxSPg=="
DOTENV_VAULT_PRODUCTION_VERSION=2
#/----------------settings/metadata-----------------/
DOTENV_VAULT="vlt_ec81c3b4428f6b230fe7295edceef4214cd1b7b5b04982ab652b12393652128a"
DOTENV_API_URL="https://vault.dotenv.org"
DOTENV_CLI="npx dotenv-vault@latest"
+1
View File
@@ -5,3 +5,4 @@ dist/
node_modules/
.github/
scripts/
docs/
+36 -40
View File
@@ -13,65 +13,61 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Setup node
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: 18.x
node-version: lts/*
- name: Install dependencies
run: npm install
- name: Build package
run: npm run build
env:
API_BASE_URL: ${{ vars.API_BASE_URL }}
SANDBOX_API_KEY: ${{ secrets.SANDBOX_API_KEY }}
TEST_APP_ID: ${{ vars.TEST_APP_ID }}
TEST_APP_IDS: ${{ vars.TEST_APP_IDS }}
TEST_APP_IDS_NO_ACCESS: ${{ vars.TEST_APP_IDS_NO_ACCESS }}
TEST_APP_ID_NO_ACCESS: ${{ vars.TEST_APP_ID_NO_ACCESS }}
TEST_ATTACHMENT: ${{ vars.TEST_ATTACHMENT }}
TEST_ATTACHMENT_FIELD: ${{ vars.TEST_ATTACHMENT_FIELD }}
TEST_ATTACHMENT_FIELD_NO_ACCESS_APP: ${{ vars.TEST_ATTACHMENT_FIELD_NO_ACCESS_APP }}
TEST_ATTACHMENT_FIELD_NO_ACCESS_FIELD: ${{ vars.TEST_ATTACHMENT_FIELD_NO_ACCESS_FIELD }}
TEST_FIELD_ID: ${{ vars.TEST_FIELD_ID }}
TEST_FIELD_IDS: ${{ vars.TEST_FIELD_IDS }}
TEST_FIELD_IDS_NO_ACCESS: ${{ vars.TEST_FIELD_IDS_NO_ACCESS }}
TEST_FIELD_ID_NO_ACCESS: ${{ vars.TEST_FIELD_ID_NO_ACCESS }}
TEST_IMAGE: ${{ vars.TEST_IMAGE }}
TEST_IMAGE_FIELD: ${{ vars.TEST_IMAGE_FIELD }}
TEST_LIST_FIELD: ${{ vars.TEST_LIST_FIELD }}
TEST_LIST_FIELD_NO_ACCESS: ${{ vars.TEST_LIST_FIELD_NO_ACCESS }}
TEST_LIST_ID: ${{ vars.TEST_LIST_ID }}
TEST_LIST_ID_NO_ACCESS: ${{ vars.TEST_LIST_ID_NO_ACCESS }}
TEST_LIST_ITEM_ID_NO_ACCESS: ${{ vars.TEST_LIST_ITEM_ID_NO_ACCESS }}
TEST_RECORD: ${{ vars.TEST_RECORD }}
TEST_REPORT: ${{ vars.TEST_REPORT }}
TEST_REPORT_NO_ACCESS: ${{ vars.TEST_REPORT_NO_ACCESS }}
TEST_REPORT_WITH_CHART_DATA: ${{ vars.TEST_REPORT_WITH_CHART_DATA }}
TEST_SURVEY_AUTO_NUMBER_FIELD: ${{ vars.TEST_SURVEY_AUTO_NUMBER_FIELD }}
TEST_SURVEY_ID: ${{ vars.TEST_SURVEY_ID }}
TEST_SURVEY_RECORD_ID: ${{ vars.TEST_SURVEY_RECORD_ID }}
TEST_TEXT_FIELD: ${{ vars.TEST_TEXT_FIELD }}
- name: Build ESM
run: npm run build:esm
- name: Build CJS
run: npm run build:cjs
- name: Build package.json
run: npm run build:json
- name: Upload build artifact
uses: actions/upload-artifact@v3.1.2
uses: actions/upload-artifact@v4
with:
name: build
path: ./dist
generate_docs:
needs: build
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Setup node
uses: actions/setup-node@v4
with:
node-version: lts/*
- name: Install dependencies
run: npm install
- name: Generate docs
run: npm run generate-docs
- name: Commit generated docs
id: commit
uses: EndBug/add-and-commit@v9
with:
commit: --no-verify
message: 'docs: update docs'
committer_name: GitHub Actions
committer_email: actions@github.com
publish:
needs: build
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Setup node
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: 18.x
node-version: lts/*
registry-url: https://registry.npmjs.org/
- name: Install dependencies
run: npm install
- name: Download build artifact
uses: actions/download-artifact@v3.0.2
uses: actions/download-artifact@v4.1.7
with:
name: build
path: ./dist
+25 -10
View File
@@ -15,13 +15,14 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.ref }}
token: ${{ secrets.ACTIONS_PAT }}
- name: Setup node
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: 18.x
node-version: lts/*
- name: Install dependencies
run: npm install
- name: Run lint-fix
@@ -42,13 +43,13 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
token: ${{ secrets.ACTIONS_PAT }}
- name: Setup node
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: 18.x
node-version: lts/*
- name: Install dependencies
run: npm install
- name: Run format
@@ -70,13 +71,13 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [14.x, 16.x, 18.x]
node-version: [14.x, 16.x, 18.x, 20.x]
fail-fast: false
steps:
- name: Check out repository
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Setup node ${{ matrix.node-version }}
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
- name: Install dependencies
@@ -113,10 +114,24 @@ jobs:
TEST_SURVEY_ID: ${{ vars.TEST_SURVEY_ID }}
TEST_SURVEY_RECORD_ID: ${{ vars.TEST_SURVEY_RECORD_ID }}
TEST_TEXT_FIELD: ${{ vars.TEST_TEXT_FIELD }}
- name: Upload test coverage artifact
uses: actions/upload-artifact@v4
with:
name: coverage-${{ matrix.node-version }}
path: ./coverage
publish_test_coverage:
needs: test
name: publish_test_coverage
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4
- name: Download test coverage artifact
uses: actions/download-artifact@v4.1.7
with:
name: coverage-20.x
path: ./coverage
- name: Upload coverage reports to Codecov
uses: codecov/codecov-action@v3
uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }}
Regular → Executable
View File
+13 -3
View File
@@ -6,8 +6,18 @@
"functions": 100,
"statements": 100,
"all": true,
"include": ["src/**/*.ts"],
"exclude": ["src/index.ts", "**/*.spec.ts"],
"reporter": ["html", "lcov", "text", "text-summary"],
"include": [
"src/**/*.ts"
],
"exclude": [
"src/index.ts",
"**/*.spec.ts"
],
"reporter": [
"html",
"lcov",
"text",
"text-summary"
],
"report-dir": "coverage"
}
+1
View File
@@ -3,3 +3,4 @@
./coverage
./node_modules
./.github
./docs
+2 -1
View File
@@ -3,5 +3,6 @@
"tabWidth": 2,
"semi": true,
"singleQuote": true,
"bracketSpacing": true
"bracketSpacing": true,
"endOfLine": "auto"
}
+1 -1
View File
@@ -1,5 +1,5 @@
The MIT License (MIT)
Copyright (c) 2023 Stevan Freeborn
Copyright (c) 2024 Stevan Freeborn
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
+621 -1
View File
@@ -4,5 +4,625 @@
[![codecov](https://codecov.io/github/StevanFreeborn/onspring-api-sdk-javascript/branch/master/graph/badge.svg?token=G1L3GKE0LV)](https://codecov.io/github/StevanFreeborn/onspring-api-sdk-javascript)
[![build_publish](https://github.com/StevanFreeborn/onspring-api-sdk-javascript/actions/workflows/build_publish.yml/badge.svg?branch=master)](https://github.com/StevanFreeborn/onspring-api-sdk-javascript/actions/workflows/build_publish.yml)
[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
[![NPM](https://img.shields.io/npm/l/onspring-api-sdk)](License.txt)
![npm](https://img.shields.io/npm/v/onspring-api-sdk)
![npm](https://img.shields.io/npm/dt/onspring-api-sdk)
A javascript SDK for interacting with version 2 of the Onspring API.
The Javascript SDK for the Onspring API is meant to simplify development in Javascript for Onspring customers who want to build integrations with their Onspring instance.
**Note:** This is an unofficial SDK for the Onspring API. It was not built in consultation with Onspring Technologies LLC or a member of their development team.
This SDK was developed independently using Onspring's existing [C# SDK](https://github.com/onspring-technologies/onspring-api-sdk), the Onspring API's [swagger page](https://api.onspring.com/swagger/index.html), and [api documentation](https://software.onspring.com/hubfs/Training/Admin%20Guide%20-%20v2%20API.pdf) as the starting point with the intention of making development of integrations done in Javascript with an Onspring instance quicker and more convenient.
## 🛠️ Dependencies
### Node.js
![node-current](https://img.shields.io/node/v/onspring-api-sdk)
Requires use of [Node.js](https://nodejs.org/en/) 14.x or later.
### Axios
![npm (prod) dependency version](https://img.shields.io/npm/dependency-version/onspring-api-sdk/axios)
All methods for the `OnspringClient` make use of the [Axios](https://axios-http.com/) http client to interact with the Onspring API.
### Form-Data
![npm (prod) dependency version](https://img.shields.io/npm/dependency-version/onspring-api-sdk/form-data)
When it is necessary to send requests to the Onspring API using `multi-part/form-data` the [Form-Data](https://www.npmjs.com/package/form-data) package is used.
## 💾 Installation
Install the SDK using [npm](https://www.npmjs.com/):
`npm install onspring-api-sdk`
## 🔑 API Key
In order to successfully interact with the Onspring Api you will need an API key. API keys are obtained by an Onspring user with permissions to at least **Read** API Keys for your instance via the following steps:
1. Login to the Onspring instance.
2. Navigate to **Administration** > **Security** > **API Keys**
3. On the list page, add a new API Key - this will require **Create** permissions - or click an existing API key to view its details.
4. Click on the **Developer Information** tab.
5. Copy the **X-ApiKey Header** value from this tab.
**Important:**
- An API Key must have a status of `Enabled` in order to make authorized requests.
- Each API Key must have an assigned Role. This role controls the permissions for requests made. If the API Key used does not have sufficient permissions the requests made won't be successful.
### 🔒 Permission Considerations
You can think of any API Key as another user in your Onspring instance and therefore it is subject to all the same permission considerations as any other user when it comes to its ability to access data in your instance. The API Key you use needs to have all the correct permissions within your instance to access the data requested. Things to think about in this context are `role security`, `content security`, and `field security`.
## 🧑🏻‍💻 Start Coding
### `OnspringClient`
The most common way to use the SDK is to create an `OnspringClient` instance and call its methods. Its constructor requires two parameters:
- `baseUrl` - currently this should always be: `https://api.onspring.com`
- `apiKey` - the value obtained by following the steps in the **API Key** section
It is best practice to read these values in from a configuration file for both flexibility and security purposes.
Example `.env` file:
```env
API_KEY=000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000
BASE_URL=https://api.onspring.com
```
Example constructing `OnspringClient`:
`CommonJS`
```js
const { OnspringClient } = require('onspring-api-sdk');
const dotenv = require('dotenv');
dotenv.config();
const client = new OnspringClient(process.env.BASE_URL, process.env.API_KEY);
```
`ES Module`
```js
import dotenv from 'dotenv';
import { OnspringClient } from 'onspring-api-sdk';
dotenv.config();
const client = new OnspringClient(process.env.BASE_URL, process.env.API_KEY);
```
### `Axios` Instance Configuration
By default when you construct an instance of the `OnspringClient` a new `Axios` instance will also be created. Its `baseURL` property will always be set to the `baseUrl` parameter based to the `OnspringClient`'s constructor and its headers will always contain the proper `x-api-key` header.
You can though pass a third optional argument to the `OnspringClient` constructor that specifies additional configuration options for the `Axios` instance used to make requests.
```js
import dotenv from 'dotenv';
import { OnspringClient } from 'onspring-api-sdk';
dotenv.config();
const configs = {
timeout: 5000,
};
const client = new OnspringClient(
process.env.BASE_URL,
process.env.API_KEY,
configs
);
```
### `ApiResponse`
Each `OnspringClient` method - aside from `canConnect` - returns an `ApiResponse` object which will have the following properties:
- `statusCode` - The http status code of the response.
- `isSuccessful` - Indicates whether the request succeeded.
- `data` - If the request was successful will contain the response data deserialized to custom classes.
- `message` - A message that may provide more detail about the request when no successful
### CommonJS or ES Modules
There is support for using either CommonJS or ES Modules depending upon your preference. This documentation will use the later in the usage examples.
### Types
The package is written in typescript and all types are exported and available for you to use.
### Full API Documentation
You may wish to refer to the full [Onspring API documentation](https://software.onspring.com/hubfs/Training/Admin%20Guide%20-%20v2%20API.pdf) when determining which values to pass as parameters to some of the `OnspringClient` methods. There is also a [swagger page](https://api.onspring.com/swagger/index.html) that you can use for making exploratory requests.
## 📋 Examples
Note the following code snippets assume you've already instantiated an `OnspringClient` as shown in the [OnspringClient](#onspringclient) section.
### Connectivity
#### Verify connectivity
```js
const res = await client.canConnect();
console.log(res); // true or false
```
### Apps
#### Get Apps
Returns a paged collection of apps and/or surveys that can be paged through. By default the page size is 50 and page number is 1.
```js
const res = await client.getApps();
const apps = res.data.items;
for (const app of apps) {
console.log(app);
}
```
You can set your own page size and page number (max is 1,000) as well.
```js
import { PagingRequest } from 'onspring-api-sdk';
const res = await client.getApps(new PagingRequest(1, 1));
const apps = res.data.items;
for (const app of apps) {
console.log(app);
}
```
#### Get App By Id
Returns an Onspring app or survey according to provided id.
```js
const res = await client.getAppById(130);
const app = res.data;
console.log(app);
```
#### Get Apps By Ids
Returns a collection of Onspring apps and/or surveys according to provided ids.
```js
const res = await client.getAppsByIds([130, 131]);
const apps = res.data.items;
for (const app of apps) {
console.log(app);
}
```
### Fields
#### Get Field By Id
Returns an Onspring field according to provided id.
```js
const res = await client.getFieldById(4793);
const field = res.data;
console.log(field);
```
#### Get Fields By Ids
Returns a collection of Onspring fields according to provided ids.
```js
const res = await client.getFieldsByIds([4793, 4801]);
const fields = res.data.items;
for (const field of fields) {
console.log(field);
}
```
#### Get Fields By App Id
Returns a paged collection of fields that can be paged through. By default the page size is 50 and page number is 1.
```js
const res = await client.getFieldsByAppId(132);
const fields = res.data.items;
for (const field of fields) {
console.log(field);
}
```
You can set your own page size and page number (max is 1,000) as well.
```js
import { PagingRequest } from 'onspring-api-sdk';
const res = await client.getFieldsByAppId(132, new PagingRequest(1, 1));
const fields = res.data.items;
for (const field of fields) {
console.log(field);
}
```
### Files
#### Get File Info By Id
Returns the Onspring file's metadata.
```js
const res = await client.getFileInfoById(1, 4806, 909);
const fileInfo = res.data;
console.log(fileInfo);
```
#### Get File By Id
Returns the file itself.
```js
import fs from 'fs';
const res = await client.getFileById(1, 4806, 909);
const file = res.data;
console.log(file.contentLength);
console.log(file.contentType);
console.log(file.fileName);
file.stream.pipe(fs.createWriteStream(file.fileName));
```
#### Save File
```js
import fs from 'fs';
import { SaveFileRequest } from 'onspring-api-sdk';
const request = new SaveFileRequest(
1,
4806,
'notes',
new Date(),
'test-attachment.txt',
'text/plain',
fs.createReadStream('test-attachment.txt')
);
const res = await client.saveFile(request);
const fileId = res.data.id;
console.log(fileId);
```
#### Delete File By Id
```js
const res = await client.deleteFileById(1, 4806, 1505);
res.statusCode === 204
? console.log('File deleted')
: console.log('Error deleting file');
```
### Lists
#### Add Or Update List Value
To add a list value don't provide an id value.
```js
import { ListItemRequest } from 'onspring-api-sdk';
const request = new ListItemRequest(638, null, 'New Value', 1, '#000000');
const res = await client.addOrUpdateListItem(request);
const itemId = res.data.id;
console.log(itemId);
```
To update a list value provide an id value.
```js
import { ListItemRequest } from 'onspring-api-sdk';
const request = new ListItemRequest(
638,
'35c79a46-04b8-4069-bbc1-161a175f962c',
'Updated Value',
1,
'#000000'
);
const res = await client.addOrUpdateListItem(request);
const itemId = res.data.id;
console.log(itemId);
```
#### Delete List Value
```js
const res = await client.deleteListItemById(
638,
'35c79a46-04b8-4069-bbc1-161a175f962c'
);
res.statusCode === 204
? console.log('List item deleted')
: console.log('Error deleting list item');
```
### Records
#### Get Records By App Id
Returns a paged collection of records that can be paged through. By default the page size is 50 and page number is 1.
```js
import { GetRecordsByAppIdRequest } from 'onspring-api-sdk';
const request = new GetRecordsByAppIdRequest(130);
const res = await client.getRecordsByAppId(request);
const records = res.data.items;
for (const record of records) {
console.log(record);
}
```
You can set your own page size and page number (max is 1,000) as well. In addition to specifying what field values to return and in what format (Raw vs. Formatted) to return them.
```js
import {
DataFormat,
GetRecordsByAppIdRequest,
PagingRequest,
} from 'onspring-api-sdk';
const request = new GetRecordsByAppIdRequest(
130,
[4804],
DataFormat.Raw,
new PagingRequest(1, 1)
);
const res = await client.getRecordsByAppId(request);
const records = res.data.items;
for (const record of records) {
console.log(record);
}
```
#### Get Record By Id
Returns an onspring record based on the provided app and record ids.
```js
import { GetRecordRequest } from 'onspring-api-sdk';
const request = new GetRecordRequest(130, 1);
const res = await client.getRecordById(request);
const record = res.data;
console.log(record);
```
You can also specify what field values to return and in what format (Raw vs. Formatted) to return them.
```js
import { DataFormat, GetRecordRequest } from 'onspring-api-sdk';
const request = new GetRecordRequest(130, 1, [4804], DataFormat.Raw);
const res = await client.getRecordById(request);
const record = res.data;
console.log(record);
```
#### Get Records By Ids
Returns a collection of Onspring records based on the provided appId and recordIds.
```js
import { GetRecordsRequest } from 'onspring-api-sdk';
const request = new GetRecordsRequest(130, [1]);
const res = await client.getRecordsByIds(request);
const records = res.data.items;
for (const record of records) {
console.log(record);
}
```
You can also specify what field values to return and in what format (Raw vs. Formatted) to return them.
```js
import { DataFormat, GetRecordsRequest } from 'onspring-api-sdk';
const request = new GetRecordsRequest(130, [1], [4804], DataFormat.Formatted);
const res = await client.getRecordsByIds(request);
const records = res.data.items;
for (const record of records) {
console.log(record);
}
```
#### Query Records
Returns a paged collection of records based on a criteria that can be paged through. By default the page size is 50 and page number is 1.
```js
import {
FilterOperators,
QueryFilter,
QueryRecordsRequest,
} from 'onspring-api-sdk';
const filter = new QueryFilter(4745, FilterOperators.GreaterThan, 0);
const request = new QueryRecordsRequest(130, filter);
const res = await client.queryRecords(request);
const records = res.data.items;
for (const record of records) {
console.log(record);
}
```
You can set your own page size and page number (max is 1,000) as well. In addition to specifying what field values to return and in what format (Raw vs. Formatted) to return them.
```js
import {
DataFormat,
FilterOperators,
PagingRequest,
QueryFilter,
QueryRecordsRequest,
} from 'onspring-api-sdk';
const filter = new QueryFilter(4745, FilterOperators.GreaterThan, 0);
const request = new QueryRecordsRequest(
130,
filter,
[4804],
DataFormat.Formatted,
new PagingRequest(1, 1)
);
const res = await client.queryRecords(request);
const records = res.data.items;
for (const record of records) {
console.log(record);
}
```
For further details on constructing the `filter` parameter please refer to the [documentation](https://software.onspring.com/hubfs/Training/Admin%20Guide%20-%20v2%20API.pdf) for the Onspring API.
#### Add or Update A Record
You can add a record by not providing a record id value. If successful will return the id of the added record.
```js
import { Record, StringRecordValue } from 'onspring-api-sdk';
const record = new Record(130, null);
const fieldValue = new StringRecordValue(4804, 'Test');
record.addValue(fieldValue);
const res = await client.saveRecord(record);
const newRecordId = res.data.id;
console.log(newRecordId);
```
You can update a record by providing its id. If successful will return the id of record updated.
```js
import { Record, StringRecordValue } from 'onspring-api-sdk';
const record = new Record(130, 607);
const fieldValue = new StringRecordValue(4804, 'Updated');
record.addValue(fieldValue);
const res = await client.saveRecord(record);
const updatedRecordId = res.data.id;
console.log(updatedRecordId);
```
#### Delete Record By Id
Delete an individual record based upon its id.
```js
const res = await client.deleteRecordById(130, 607);
res.statusCode === 204
? console.log('Record deleted')
: console.log('Error deleting record');
```
#### Delete Records By Ids
Delete a batch of records based upon their ids.
```js
const res = await client.deleteRecordsByIds(130, [608, 609]);
res.statusCode === 204
? console.log('Records deleted')
: console.log('Error deleting records');
```
### Reports
#### Get Report By Id
Returns the report for the provided id.
```js
const res = await client.getReportById(408);
const report = res.data;
console.log(report);
```
You can also specify the format of the data in the report as well as whether you are requesting the report's data or its chart data.
```js
import { DataFormat, ReportDataType } from 'onspring-api-sdk';
const res = await client.getReportById(
409,
DataFormat.Formatted,
ReportDataType.ChartData
);
const report = res.data;
console.log(report);
```
#### Get Reports By App Id
Returns a paged collection of reports that can be paged through. By default the page size is 50 and page number is 1.
```js
const res = await client.getReportsByAppId(130);
const reports = res.data.items;
for (const report of reports) {
console.log(report);
}
```
You can set your own page size and page number (max is 1,000) as well.
```js
import { PagingRequest } from 'onspring-api-sdk';
const res = await client.getReportsByAppId(130, new PagingRequest(1, 1));
const reports = res.data.items;
for (const report of reports) {
console.log(report);
}
```
+1
View File
@@ -0,0 +1 @@
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
+85
View File
@@ -0,0 +1,85 @@
:root {
--light-hl-0: #0000FF;
--dark-hl-0: #569CD6;
--light-hl-1: #000000;
--dark-hl-1: #D4D4D4;
--light-hl-2: #0070C1;
--dark-hl-2: #4FC1FF;
--light-hl-3: #795E26;
--dark-hl-3: #DCDCAA;
--light-hl-4: #A31515;
--dark-hl-4: #CE9178;
--light-hl-5: #001080;
--dark-hl-5: #9CDCFE;
--light-hl-6: #AF00DB;
--dark-hl-6: #C586C0;
--light-hl-7: #098658;
--dark-hl-7: #B5CEA8;
--light-hl-8: #008000;
--dark-hl-8: #6A9955;
--light-code-background: #FFFFFF;
--dark-code-background: #1E1E1E;
}
@media (prefers-color-scheme: light) { :root {
--hl-0: var(--light-hl-0);
--hl-1: var(--light-hl-1);
--hl-2: var(--light-hl-2);
--hl-3: var(--light-hl-3);
--hl-4: var(--light-hl-4);
--hl-5: var(--light-hl-5);
--hl-6: var(--light-hl-6);
--hl-7: var(--light-hl-7);
--hl-8: var(--light-hl-8);
--code-background: var(--light-code-background);
} }
@media (prefers-color-scheme: dark) { :root {
--hl-0: var(--dark-hl-0);
--hl-1: var(--dark-hl-1);
--hl-2: var(--dark-hl-2);
--hl-3: var(--dark-hl-3);
--hl-4: var(--dark-hl-4);
--hl-5: var(--dark-hl-5);
--hl-6: var(--dark-hl-6);
--hl-7: var(--dark-hl-7);
--hl-8: var(--dark-hl-8);
--code-background: var(--dark-code-background);
} }
:root[data-theme='light'] {
--hl-0: var(--light-hl-0);
--hl-1: var(--light-hl-1);
--hl-2: var(--light-hl-2);
--hl-3: var(--light-hl-3);
--hl-4: var(--light-hl-4);
--hl-5: var(--light-hl-5);
--hl-6: var(--light-hl-6);
--hl-7: var(--light-hl-7);
--hl-8: var(--light-hl-8);
--code-background: var(--light-code-background);
}
:root[data-theme='dark'] {
--hl-0: var(--dark-hl-0);
--hl-1: var(--dark-hl-1);
--hl-2: var(--dark-hl-2);
--hl-3: var(--dark-hl-3);
--hl-4: var(--dark-hl-4);
--hl-5: var(--dark-hl-5);
--hl-6: var(--dark-hl-6);
--hl-7: var(--dark-hl-7);
--hl-8: var(--dark-hl-8);
--code-background: var(--dark-code-background);
}
.hl-0 { color: var(--hl-0); }
.hl-1 { color: var(--hl-1); }
.hl-2 { color: var(--hl-2); }
.hl-3 { color: var(--hl-3); }
.hl-4 { color: var(--hl-4); }
.hl-5 { color: var(--hl-5); }
.hl-6 { color: var(--hl-6); }
.hl-7 { color: var(--hl-7); }
.hl-8 { color: var(--hl-8); }
pre, code { background: var(--code-background); }
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 14 KiB

File diff suppressed because one or more lines are too long
+261
View File
@@ -0,0 +1,261 @@
@import url("https://fonts.googleapis.com/css2?family=Space+Grotesk:wght@300;400;500;600;700&family=Space+Mono:ital,wght@0,400;0,700;1,400;1,700&display=swap");
:root,
:root[data-theme="light"],
:root[data-theme="dark"] {
--font-sans: "Space Grotesk", sans-serif;
--font-mono: "Space Mono", monospace;
--color-background: var(--md-sys-color-surface-container);
--color-background-secondary: var(--md-sys-color-surface-container-high);
--color-background-warning: var(--md-sys-color-error-container);
--color-warning-text: var(--md-sys-color-on-error-container);
--color-icon-background: var(--md-sys-color-on-primary);
--color-accent: var(--md-sys-color-secondary-container);
--color-active-menu-item: var(--md-sys-color-surface-container-highest);
--color-text: var(--md-sys-color-on-surface);
--color-text-aside: var(--md-sys-color-on-surface-variant);
--color-link: var(--md-sys-color-primary);
--color-ts-project: var(--md-sys-color-secondary);
--color-ts-module: var(--color-ts-project);
--color-ts-namespace: var(--color-ts-project);
--color-ts-enum: var(--md-sys-color-tertiary);
--color-ts-enum-member: var(--color-ts-enum);
--color-ts-variable: var(--md-sys-color-primary);
--color-ts-function: var(--md-sys-color-secondary);
--color-ts-class: var(--md-sys-color-tertiary);
--color-ts-interface: var(--md-sys-color-tertiary);
--color-ts-constructor: var(--md-sys-color-inverse-primary);
--color-ts-property: var(--md-sys-color-on-background);
--color-ts-method: var(--color-ts-function);
--color-ts-call-signature: var(--color-ts-method);
--color-ts-index-signature: var(--color-ts-property); /* ? */
--color-ts-constructor-signature: var(--color-ts-function);
--color-ts-parameter: var(--md-sys-color-primary);
--color-ts-type-parameter: var(--md-sys-color-tertiary);
--color-ts-accessor: var(--color-ts-property);
--color-ts-get-signature: var(--color-ts-accessor);
--color-ts-set-signature: var(--color-ts-accessor);
--color-ts-type-alias: var(--md-sys-color-tertiary);
/* --external-icon: var(--md-sys-external-icon);
--color-scheme: var(--md-sys-color-scheme); */
--top-app-bar-height: 4.5rem;
--top-app-bar-padding-vertical: .5rem;
--footer-height: 3.5rem;
--safe-area-inset-top: env(safe-area-inset-top);
}
body {
font-family: var(--font-sans);
}
code,
pre {
font-family: var(--font-mono);
}
img {
max-width: 100%;
}
@supports not selector(::-webkit-scrollbar) {
* {
scrollbar-width: thin;
scrollbar-color: var(--color-accent) transparent;
}
}
@supports selector(::-webkit-scrollbar) {
*::-webkit-scrollbar {
width: 8px;
height: 8px;
}
*::-webkit-scrollbar-track {
background: none;
margin: 4px;
}
*::-webkit-scrollbar-thumb {
border: none;
}
*::-webkit-scrollbar-thumb:hover,
*::-webkit-scrollbar-thumb:active {
background-color: var(--md-sys-color-secondary);
}
* {
scrollbar-width: unset;
scrollbar-color: unset;
}
}
.container-main {
min-height: calc(100vh - var(--top-app-bar-height) - var(--footer-height));
}
.col-content {
overflow: hidden;
box-sizing: border-box;
padding: 1.75rem;
margin-bottom: 1.75rem;
border-radius: 28px;
background-color: var(--md-sys-color-surface);
}
.page-menu {
height: fit-content;
padding: 1.25rem 1.75rem;
border-radius: 28px;
background-color: var(--md-sys-color-surface);
}
.site-menu > *,
.page-menu > * {
position: relative;
}
.title {
display: inline-block;
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
font-size: 22px;
}
.tsd-page-title {
word-break: break-all;
}
.tsd-page-toolbar {
padding: 1rem 0;
background-color: var(--color-background);
border-bottom: none;
}
.tsd-page-toolbar .tsd-toolbar-icon {
padding: 20px 0;
}
#tsd-search {
border-radius: 38px;
}
#tsd-search-input {
border-radius: 22px;
}
#tsd-search-input:focus-visible {
background-color: var(--color-accent);
}
#tsd-search-results > li {
background: none;
}
#tsd-toolbar-menu-trigger,
#tsd-search-trigger {
border-radius: 50%;
}
html:not(.has-menu) .col-sidebar {
padding-top: 0;
margin-right: 1rem;
}
.tsd-signature {
padding: 1rem 1.5rem;
border-radius: 24px;
background-color: var(--md-sys-color-surface-container);
}
.tsd-page-navigation ul {
padding-left: 0.44rem;
}
.tsd-navigation a,
.tsd-navigation summary > span,
.tsd-page-navigation a {
padding: 0.88rem;
border-radius: 24px;
}
.tsd-navigation a:hover,
.tsd-page-navigation a:hover {
text-decoration: none;
background-color: var(--md-sys-color-surface-container-high);
}
.page-menu .tsd-accordion-summary {
margin-bottom: 0.5rem;
}
.page-menu .tsd-accordion-summary svg {
position: absolute;
right: 0;
}
.site-menu .tsd-navigation .tsd-accordion-summary {
display: flex;
flex-direction: row-reverse;
width: 100%;
}
.tsd-small-nested-navigation {
margin-left: 1rem;
}
.tsd-nested-navigation {
margin-left: 2.5rem;
}
.tsd-nested-navigation > li > a,
.tsd-nested-navigation > li > span {
width: 100%;
}
.tsd-navigation > a,
.tsd-navigation .tsd-accordion-summary {
width: 100%;
}
.tsd-accordion .tsd-accordion-summary > svg,
.tsd-index-accordion .tsd-accordion-summary > svg {
position: absolute;
right: 1.5rem;
}
.tsd-accordion-summary .tsd-kind-icon ~ span {
margin-right: 2.5rem;
}
.tsd-accordion-summary .tsd-nested-navigation > li > a,
.tsd-nested-navigation > li > span {
width: calc(100% - 0.44rem);
}
.tsd-kind-icon ~ span {
white-space: nowrap;
overflow: hidden;
text-overflow: ellipsis;
}
.tsd-generator {
padding: 0;
border-top: none;
height: var(--footer-height);
line-height: var(--footer-height);
}
.tsd-generator > p {
padding: 0 2rem;
}
@media (max-width: 769px) {
.col-sidebar {
margin-right: 0;
}
}
@media (min-width: 770px) {
.container-main {
margin: 0 auto;
}
.site-menu {
margin-right: 0.5rem;
}
}
@media (min-width: 1200px) {
.page-menu,
.site-menu {
max-height: calc(100vh - var(--footer-height) - var(--top-app-bar-height));
top: var(--top-app-bar-height);
}
.site-menu {
margin-top: 0;
}
.page-menu {
margin-left: 1rem;
}
.col-sidebar {
margin-right: 0;
}
}
+1
View File
@@ -0,0 +1 @@
window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA42XQY/TMBCF/0vOFSs4od5Kl10igQrtCg6Ig5XMthaObZwxS4X47ygNdGN7PPY1773P8djjxF9/Nwi/sFk3twLFnXGDwGbVWIGnZt2A9sN486y8OOGgmlXzXeq+Wb/+s3pOg4KjQHg4W0jyCy1PuJOg+gMK9GMMWEiFPDX8VeCyCg5onDjCQSJBCGSWg+B2FpxA44h5BDLDMW7wSuw8Wo/knGJDnvUO0c6125o+AYVqnvLBK5RWyU7iOWYstTxhD51x/WehPLlJIpnjWONw2pM0ZqnmKQ9ygIMVutWdgwF0sukTQ5m1h847B7ojJ0i78tSNlXsYrdHjAtUpMY4w3izEkPDyVciwVNayGUTRncKSXKNXrY7wXo64WFgOGFk5/tYoBR1Ko/MFSj0s0YFA6L9IPLU9A6VsHPdWILDzjwwsCzo5CMXjEg9PnM9lijMrNeniGmeMHPut7q2RGu9Eh8adU2Zk4FiX4z8lXB7zOUVMZnpaSrX60dDJSSmli/UkTCxz/lTkyrBQOco94EdxhH5j7ZhvEMpVQ70MX8ENfTXkuUgV6MhYx56+NVXswFhgz2+yhx8eRuIMjh1VtPHNeWNtW0GNnHX0CmwNz8u+uPsJU4lZ5FWyWo1wBFd8RdpXQa6hVhKnwTMtf5VK+RZhyK5sZKhj5RoldpRomRJdJS6/06N1Uh+3SpL/OKHOkf71dm5SgVzgSH3MVjqQOc4nD+483zFSykIsMkpdTZg45uxMMfPzcjKz2pWdsIdHuPxuZ9oh1HnSdIxThOl5OTndSnLpSWMJ5omImicucxA/YfpZyK5jZCixCh+mxFLLyzVQ6mGJnZna9t4ZT1x6lmotpXjQM2Z2DJxSZTplK3MrmJW8/zdWet8u1RoK+16EKWV++wv61xb7rRIAAA=="
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large Load Diff
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+181
View File
@@ -0,0 +1,181 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CreatedWithIdResponse | onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><style>
@media (prefers-color-scheme: dark) {
:root {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
}
:root[data-theme="dark"] {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
@media (prefers-color-scheme: light) {
:root {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
}
:root[data-theme="light"] {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">onspring-api-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">onspring-api-sdk</a></li><li><a href="CreatedWithIdResponse.html">CreatedWithIdResponse</a></li></ul><h1>Class CreatedWithIdResponse&lt;T&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>CreatedWithIdResponse<T> - Represents a response to a request to create a resource.</p>
</div><div class="tsd-comment tsd-typography"></div></section> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#CreatedWithIdResponse">view full</a>)</h4><ul class="tsd-hierarchy"><li><span class="target">CreatedWithIdResponse</span><ul class="tsd-hierarchy"><li><a href="ListItemResponse.html" class="tsd-signature-type tsd-kind-class">ListItemResponse</a></li><li><a href="SaveRecordResponse.html" class="tsd-signature-type tsd-kind-class">SaveRecordResponse</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/CreatedWithIdResponse.ts:4</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="CreatedWithIdResponse.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="CreatedWithIdResponse.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_CreatedWithIdResponse" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Created<wbr/>With<wbr/>Id<wbr/>Response</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CreatedWithIdResponse.html#constructor.new_CreatedWithIdResponse.T-1">T</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CreatedWithIdResponse.html#constructor.new_CreatedWithIdResponse.T-1">T</a><span class="tsd-signature-symbol">&gt;</span><a href="#constructor.new_CreatedWithIdResponse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="constructor.new_CreatedWithIdResponse.T-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="CreatedWithIdResponse.html#constructor.new_CreatedWithIdResponse.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>The id of the created object.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CreatedWithIdResponse.html#constructor.new_CreatedWithIdResponse.T-1">T</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
<li>A new instance of the CreatedWithIdResponse class.</li>
</ul>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/CreatedWithIdResponse.ts:15</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="CreatedWithIdResponse.html#constructor.new_CreatedWithIdResponse.T-1">T</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/CreatedWithIdResponse.ts:8</li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
try {
const generateLinkElement = document.querySelector(".tsd-generator a");
const link = document.createElement("a");
Object.assign(link, {
href: "https://github.com/dmnsgn/typedoc-material-theme",
target: "_blank",
rel: "noreferrer",
innerText: "typedoc-material-theme."
});
generateLinkElement.insertAdjacentElement("afterend", link);
generateLinkElement.insertAdjacentText("afterend", " with ");
} catch (error) {
}
</script></body></html>
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+181
View File
@@ -0,0 +1,181 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ListItemResponse | onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><style>
@media (prefers-color-scheme: dark) {
:root {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
}
:root[data-theme="dark"] {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
@media (prefers-color-scheme: light) {
:root {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
}
:root[data-theme="light"] {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">onspring-api-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">onspring-api-sdk</a></li><li><a href="ListItemResponse.html">ListItemResponse</a></li></ul><h1>Class ListItemResponse</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ListItemResponse - Represents a respons when a list item is created or updated.</p>
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy (<a class="link" href="../hierarchy.html#ListItemResponse">view full</a>)</h4><ul class="tsd-hierarchy"><li><a href="CreatedWithIdResponse.html" class="tsd-signature-type tsd-kind-class">CreatedWithIdResponse</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li><span class="target">ListItemResponse</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in models/ListItemResponse.ts:5</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="ListItemResponse.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ListItemResponse.html#id" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ListItemResponse" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>List<wbr/>Item<wbr/>Response</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ListItemResponse.html" class="tsd-signature-type tsd-kind-class">ListItemResponse</a><a href="#constructor.new_ListItemResponse" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the list item.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ListItemResponse.html" class="tsd-signature-type tsd-kind-class">ListItemResponse</a></h4><ul>
<li>A new instance of ListItemResponse.</li>
</ul>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="CreatedWithIdResponse.html">CreatedWithIdResponse</a>.<a href="CreatedWithIdResponse.html#constructor">constructor</a></p><ul><li>Defined in models/ListItemResponse.ts:11</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="CreatedWithIdResponse.html">CreatedWithIdResponse</a>.<a href="CreatedWithIdResponse.html#id">id</a></p><ul><li>Defined in models/CreatedWithIdResponse.ts:8</li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#id" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
try {
const generateLinkElement = document.querySelector(".tsd-generator a");
const link = document.createElement("a");
Object.assign(link, {
href: "https://github.com/dmnsgn/typedoc-material-theme",
target: "_blank",
rel: "noreferrer",
innerText: "typedoc-material-theme."
});
generateLinkElement.insertAdjacentElement("afterend", link);
generateLinkElement.insertAdjacentText("afterend", " with ");
} catch (error) {
}
</script></body></html>
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+193
View File
@@ -0,0 +1,193 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>QueryFilter | onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><style>
@media (prefers-color-scheme: dark) {
:root {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
}
:root[data-theme="dark"] {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
@media (prefers-color-scheme: light) {
:root {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
}
:root[data-theme="light"] {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">onspring-api-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">onspring-api-sdk</a></li><li><a href="QueryFilter.html">QueryFilter</a></li></ul><h1>Class QueryFilter</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>QueryFilter - Represents a query filter.</p>
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in models/QueryFilter.ts:6</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="QueryFilter.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="QueryFilter.html#fieldId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a>
<a href="QueryFilter.html#operator" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>operator</span></a>
<a href="QueryFilter.html#value" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="QueryFilter.html#toString" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_QueryFilter" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Query<wbr/>Filter</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldId</span>, <span class="tsd-kind-parameter">operator</span>, <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="QueryFilter.html" class="tsd-signature-type tsd-kind-class">QueryFilter</a><a href="#constructor.new_QueryFilter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fieldId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the field to filter on.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">operator</span>: <a href="../enums/FilterOperators.html" class="tsd-signature-type tsd-kind-enum">FilterOperators</a></span><div class="tsd-comment tsd-typography"><p>The operator for the filter.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></span><div class="tsd-comment tsd-typography"><p>The value for the filter.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="QueryFilter.html" class="tsd-signature-type tsd-kind-class">QueryFilter</a></h4><ul>
<li>A new instance of the QueryFilter class.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Throws</h4><ul>
<li>If the value is null and the operator is not IsNull or NotNull.</li>
</ul>
</div><aside class="tsd-sources"><ul><li>Defined in models/QueryFilter.ts:30</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="fieldId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Id</span><a href="#fieldId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">field<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/QueryFilter.ts:10</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="operator" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>operator</span><a href="#operator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">operator</span><span class="tsd-signature-symbol">:</span> <a href="../enums/FilterOperators.html" class="tsd-signature-type tsd-kind-enum">FilterOperators</a></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/QueryFilter.ts:15</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/QueryFilter.ts:20</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="toString" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>to<wbr/>String</span><a href="#toString" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="toString.toString-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">to<wbr/>String</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#toString.toString-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><ul>
<li>The filter as a string.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>toString - Converts the filter to a string.</p>
</div><aside class="tsd-sources"><ul><li>Defined in models/QueryFilter.ts:52</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#fieldId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Id</span></a><a href="#operator" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>operator</span></a><a href="#value" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</span></a><a href="#toString" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>to<wbr/>String</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
try {
const generateLinkElement = document.querySelector(".tsd-generator a");
const link = document.createElement("a");
Object.assign(link, {
href: "https://github.com/dmnsgn/typedoc-material-theme",
target: "_blank",
rel: "noreferrer",
innerText: "typedoc-material-theme."
});
generateLinkElement.insertAdjacentElement("afterend", link);
generateLinkElement.insertAdjacentText("afterend", " with ");
} catch (error) {
}
</script></body></html>
File diff suppressed because one or more lines are too long
+196
View File
@@ -0,0 +1,196 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Record | onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><style>
@media (prefers-color-scheme: dark) {
:root {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
}
:root[data-theme="dark"] {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
@media (prefers-color-scheme: light) {
:root {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
}
:root[data-theme="light"] {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">onspring-api-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">onspring-api-sdk</a></li><li><a href="Record.html">Record</a></li></ul><h1>Class Record</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Record - A record in an app.</p>
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in models/Record.ts:7</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="Record.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="Record.html#appId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Id</span></a>
<a href="Record.html#fieldData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Data</span></a>
<a href="Record.html#recordId" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>record<wbr/>Id</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="Record.html#addValue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Value</span></a>
<a href="Record.html#addValues" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Values</span></a>
<a href="Record.html#convertToSaveRecordRequest" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>convert<wbr/>To<wbr/>Save<wbr/>Record<wbr/>Request</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_Record" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Record</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">recordId</span>, <span class="tsd-kind-parameter">fieldData</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a><a href="#constructor.new_Record" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the app that the record belongs to.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">recordId</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>The id of the record.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fieldData</span>: <a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></span><div class="tsd-comment tsd-typography"><p>The data for the fields in the record.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="Record.html" class="tsd-signature-type tsd-kind-class">Record</a></h4><ul>
<li>A new instance of Record.</li>
</ul>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/Record.ts:30</li></ul></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="appId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>app<wbr/>Id</span><a href="#appId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">app<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/Record.ts:11</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fieldData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>field<wbr/>Data</span><a href="#fieldData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">field<wbr/>Data</span><span class="tsd-signature-symbol">:</span> <a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/Record.ts:21</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="recordId" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>record<wbr/>Id</span><a href="#recordId" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">record<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in models/Record.ts:16</li></ul></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="addValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Value</span><a href="#addValue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addValue.addValue-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Value</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addValue.addValue-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fieldData</span>: <a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The value to add to the record.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Method</h4><p>addValue - Adds a value to the record.</p>
</div><aside class="tsd-sources"><ul><li>Defined in models/Record.ts:45</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="addValues" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Values</span><a href="#addValues" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addValues.addValues-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Values</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">fieldData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#addValues.addValues-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fieldData</span>: <a href="RecordValue.html" class="tsd-signature-type tsd-kind-class">RecordValue</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The values to add to the record.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4>Method</h4><p>addValues - Adds values to the record.</p>
</div><aside class="tsd-sources"><ul><li>Defined in models/Record.ts:54</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="convertToSaveRecordRequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>convert<wbr/>To<wbr/>Save<wbr/>Record<wbr/>Request</span><a href="#convertToSaveRecordRequest" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="convertToSaveRecordRequest.convertToSaveRecordRequest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">convert<wbr/>To<wbr/>Save<wbr/>Record<wbr/>Request</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="SaveRecordRequest.html" class="tsd-signature-type tsd-kind-class">SaveRecordRequest</a><a href="#convertToSaveRecordRequest.convertToSaveRecordRequest-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="SaveRecordRequest.html" class="tsd-signature-type tsd-kind-class">SaveRecordRequest</a></h4><ul>
<li>A SaveRecordRequest.</li>
</ul>
<div class="tsd-comment tsd-typography"><h4>Method</h4><p>convertToSaveRecordRequest - Converts the record to a SaveRecordRequest.</p>
</div><aside class="tsd-sources"><ul><li>Defined in models/Record.ts:62</li></ul></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#appId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>app<wbr/>Id</span></a><a href="#fieldData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>field<wbr/>Data</span></a><a href="#recordId" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>record<wbr/>Id</span></a><a href="#addValue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Value</span></a><a href="#addValues" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Values</span></a><a href="#convertToSaveRecordRequest" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>convert<wbr/>To<wbr/>Save<wbr/>Record<wbr/>Request</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
try {
const generateLinkElement = document.querySelector(".tsd-generator a");
const link = document.createElement("a");
Object.assign(link, {
href: "https://github.com/dmnsgn/typedoc-material-theme",
target: "_blank",
rel: "noreferrer",
innerText: "typedoc-material-theme."
});
generateLinkElement.insertAdjacentElement("afterend", link);
generateLinkElement.insertAdjacentText("afterend", " with ");
} catch (error) {
}
</script></body></html>
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
+179
View File
@@ -0,0 +1,179 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DataFormat | onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><style>
@media (prefers-color-scheme: dark) {
:root {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
}
:root[data-theme="dark"] {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
@media (prefers-color-scheme: light) {
:root {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
}
:root[data-theme="light"] {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">onspring-api-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">onspring-api-sdk</a></li><li><a href="DataFormat.html">DataFormat</a></li></ul><h1>Enumeration DataFormat</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>DataFormat - The format of the data to be returned.</p>
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in enums/DataFormat.ts:4</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="DataFormat.html#Formatted" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Formatted</span></a>
<a href="DataFormat.html#Raw" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Raw</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="Formatted" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Formatted</span><a href="#Formatted" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Formatted</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Formatted&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>Formatted - The formatted data will be returned.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/DataFormat.ts:15</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Raw" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Raw</span><a href="#Raw" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Raw</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Raw&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>Raw - The raw data will be returned.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/DataFormat.ts:9</li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#Formatted" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Formatted</span></a><a href="#Raw" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Raw</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
try {
const generateLinkElement = document.querySelector(".tsd-generator a");
const link = document.createElement("a");
Object.assign(link, {
href: "https://github.com/dmnsgn/typedoc-material-theme",
target: "_blank",
rel: "noreferrer",
innerText: "typedoc-material-theme."
});
generateLinkElement.insertAdjacentElement("afterend", link);
generateLinkElement.insertAdjacentText("afterend", " with ");
} catch (error) {
}
</script></body></html>
+179
View File
@@ -0,0 +1,179 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DelegateType | onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><style>
@media (prefers-color-scheme: dark) {
:root {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
}
:root[data-theme="dark"] {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
@media (prefers-color-scheme: light) {
:root {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
}
:root[data-theme="light"] {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">onspring-api-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">onspring-api-sdk</a></li><li><a href="DelegateType.html">DelegateType</a></li></ul><h1>Enumeration DelegateType</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>DelegateType - The type of delegate</p>
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in enums/DelegateType.ts:4</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="DelegateType.html#External" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>External</span></a>
<a href="DelegateType.html#Internal" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Internal</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="External" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>External</span><a href="#External" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">External</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;External&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>External - The delegate is external.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/DelegateType.ts:9</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Internal" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Internal</span><a href="#Internal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Internal</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Internal&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>Internal - The delegate is internal.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/DelegateType.ts:15</li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#External" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>External</span></a><a href="#Internal" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Internal</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
try {
const generateLinkElement = document.querySelector(".tsd-generator a");
const link = document.createElement("a");
Object.assign(link, {
href: "https://github.com/dmnsgn/typedoc-material-theme",
target: "_blank",
rel: "noreferrer",
innerText: "typedoc-material-theme."
});
generateLinkElement.insertAdjacentElement("afterend", link);
generateLinkElement.insertAdjacentText("afterend", " with ");
} catch (error) {
}
</script></body></html>
+181
View File
@@ -0,0 +1,181 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FieldStatus | onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><style>
@media (prefers-color-scheme: dark) {
:root {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
}
:root[data-theme="dark"] {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
@media (prefers-color-scheme: light) {
:root {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
}
:root[data-theme="light"] {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">onspring-api-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">onspring-api-sdk</a></li><li><a href="FieldStatus.html">FieldStatus</a></li></ul><h1>Enumeration FieldStatus</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>FieldStatus - The status of a field.</p>
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in enums/FieldStatus.ts:4</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="FieldStatus.html#Disabled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Disabled</span></a>
<a href="FieldStatus.html#Enabled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Enabled</span></a>
<a href="FieldStatus.html#Invalid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Invalid</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="Disabled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Disabled</span><a href="#Disabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Disabled</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Disabled&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>Disabled - The field is disabled.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/FieldStatus.ts:15</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Enabled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Enabled</span><a href="#Enabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Enabled</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Enabled&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>Enabled - The field is enabled.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/FieldStatus.ts:9</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Invalid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Invalid</span><a href="#Invalid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Invalid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Invalid&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>Invalid - The field is invalid.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/FieldStatus.ts:21</li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#Disabled" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Disabled</span></a><a href="#Enabled" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Enabled</span></a><a href="#Invalid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Invalid</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
try {
const generateLinkElement = document.querySelector(".tsd-generator a");
const link = document.createElement("a");
Object.assign(link, {
href: "https://github.com/dmnsgn/typedoc-material-theme",
target: "_blank",
rel: "noreferrer",
innerText: "typedoc-material-theme."
});
generateLinkElement.insertAdjacentElement("afterend", link);
generateLinkElement.insertAdjacentText("afterend", " with ");
} catch (error) {
}
</script></body></html>
File diff suppressed because one or more lines are too long
+181
View File
@@ -0,0 +1,181 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FileStorageSite | onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><style>
@media (prefers-color-scheme: dark) {
:root {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
}
:root[data-theme="dark"] {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
@media (prefers-color-scheme: light) {
:root {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
}
:root[data-theme="light"] {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">onspring-api-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">onspring-api-sdk</a></li><li><a href="FileStorageSite.html">FileStorageSite</a></li></ul><h1>Enumeration FileStorageSite</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>FileStorageSite - The site where the file is stored.</p>
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in enums/FileStorageSite.ts:4</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="FileStorageSite.html#GoogleDrive" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Google<wbr/>Drive</span></a>
<a href="FileStorageSite.html#Internal" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Internal</span></a>
<a href="FileStorageSite.html#OneDrive" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>One<wbr/>Drive</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="GoogleDrive" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Google<wbr/>Drive</span><a href="#GoogleDrive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Google<wbr/>Drive</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;GoogleDrive&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>GoogleDrive - The file is stored in Google Drive.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/FileStorageSite.ts:21</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Internal" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Internal</span><a href="#Internal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Internal</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Internal&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>Internal - The file is stored in the internal file storage.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/FileStorageSite.ts:9</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="OneDrive" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>One<wbr/>Drive</span><a href="#OneDrive" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">One<wbr/>Drive</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;OneDrive&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>OneDrive - The file is stored in OneDrive.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/FileStorageSite.ts:15</li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#GoogleDrive" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Google<wbr/>Drive</span></a><a href="#Internal" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Internal</span></a><a href="#OneDrive" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>One<wbr/>Drive</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
try {
const generateLinkElement = document.querySelector(".tsd-generator a");
const link = document.createElement("a");
Object.assign(link, {
href: "https://github.com/dmnsgn/typedoc-material-theme",
target: "_blank",
rel: "noreferrer",
innerText: "typedoc-material-theme."
});
generateLinkElement.insertAdjacentElement("afterend", link);
generateLinkElement.insertAdjacentText("afterend", " with ");
} catch (error) {
}
</script></body></html>
File diff suppressed because one or more lines are too long
+183
View File
@@ -0,0 +1,183 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>FormulaOutputType | onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><style>
@media (prefers-color-scheme: dark) {
:root {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
}
:root[data-theme="dark"] {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
@media (prefers-color-scheme: light) {
:root {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
}
:root[data-theme="light"] {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">onspring-api-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">onspring-api-sdk</a></li><li><a href="FormulaOutputType.html">FormulaOutputType</a></li></ul><h1>Enumeration FormulaOutputType</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>FormulaOutputType - The type of the formula output.</p>
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in enums/FormulaOutputType.ts:4</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="FormulaOutputType.html#DateAndTime" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Date<wbr/>And<wbr/>Time</span></a>
<a href="FormulaOutputType.html#ListValue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>List<wbr/>Value</span></a>
<a href="FormulaOutputType.html#Numeric" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Numeric</span></a>
<a href="FormulaOutputType.html#Text" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Text</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="DateAndTime" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Date<wbr/>And<wbr/>Time</span><a href="#DateAndTime" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Date<wbr/>And<wbr/>Time</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;DateAndTime&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>DateAndTime - The formula output is a date and time value.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/FormulaOutputType.ts:21</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="ListValue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>List<wbr/>Value</span><a href="#ListValue" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">List<wbr/>Value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ListValue&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>ListValue - The formula output is a list value.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/FormulaOutputType.ts:27</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Numeric" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Numeric</span><a href="#Numeric" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Numeric</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Numeric&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>Numeric - The formula output is a numeric value.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/FormulaOutputType.ts:15</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Text" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Text</span><a href="#Text" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Text&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>Text - The formula output is a text value.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/FormulaOutputType.ts:9</li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#DateAndTime" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Date<wbr/>And<wbr/>Time</span></a><a href="#ListValue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>List<wbr/>Value</span></a><a href="#Numeric" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Numeric</span></a><a href="#Text" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Text</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
try {
const generateLinkElement = document.querySelector(".tsd-generator a");
const link = document.createElement("a");
Object.assign(link, {
href: "https://github.com/dmnsgn/typedoc-material-theme",
target: "_blank",
rel: "noreferrer",
innerText: "typedoc-material-theme."
});
generateLinkElement.insertAdjacentElement("afterend", link);
generateLinkElement.insertAdjacentText("afterend", " with ");
} catch (error) {
}
</script></body></html>
File diff suppressed because one or more lines are too long
+179
View File
@@ -0,0 +1,179 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Multiplicity | onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><style>
@media (prefers-color-scheme: dark) {
:root {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
}
:root[data-theme="dark"] {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
@media (prefers-color-scheme: light) {
:root {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
}
:root[data-theme="light"] {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">onspring-api-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">onspring-api-sdk</a></li><li><a href="Multiplicity.html">Multiplicity</a></li></ul><h1>Enumeration Multiplicity</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Multiplicity - The multiplicity type of the object.</p>
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in enums/Multiplicity.ts:4</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="Multiplicity.html#MultiSelect" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Multi<wbr/>Select</span></a>
<a href="Multiplicity.html#SingleSelect" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Single<wbr/>Select</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="MultiSelect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Multi<wbr/>Select</span><a href="#MultiSelect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Multi<wbr/>Select</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;MultiSelect&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>MultiSelect - Multi select multiplicity.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/Multiplicity.ts:15</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="SingleSelect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Single<wbr/>Select</span><a href="#SingleSelect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Single<wbr/>Select</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;SingleSelect&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>SingleSelect - Single select multiplicity.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/Multiplicity.ts:9</li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#MultiSelect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Multi<wbr/>Select</span></a><a href="#SingleSelect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Single<wbr/>Select</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
try {
const generateLinkElement = document.querySelector(".tsd-generator a");
const link = document.createElement("a");
Object.assign(link, {
href: "https://github.com/dmnsgn/typedoc-material-theme",
target: "_blank",
rel: "noreferrer",
innerText: "typedoc-material-theme."
});
generateLinkElement.insertAdjacentElement("afterend", link);
generateLinkElement.insertAdjacentText("afterend", " with ");
} catch (error) {
}
</script></body></html>
File diff suppressed because one or more lines are too long
+179
View File
@@ -0,0 +1,179 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ReportDataType | onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><style>
@media (prefers-color-scheme: dark) {
:root {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
}
:root[data-theme="dark"] {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
@media (prefers-color-scheme: light) {
:root {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
}
:root[data-theme="light"] {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">onspring-api-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">onspring-api-sdk</a></li><li><a href="ReportDataType.html">ReportDataType</a></li></ul><h1>Enumeration ReportDataType</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>ReportDataType - Enum for report data type</p>
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in enums/ReportDataType.ts:4</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="ReportDataType.html#ChartData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Chart<wbr/>Data</span></a>
<a href="ReportDataType.html#ReportData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Report<wbr/>Data</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="ChartData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Chart<wbr/>Data</span><a href="#ChartData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Chart<wbr/>Data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ChartData&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>ChartData - Chart data</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/ReportDataType.ts:14</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="ReportData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Report<wbr/>Data</span><a href="#ReportData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Report<wbr/>Data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;ReportData&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>ReportData - Report data</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/ReportDataType.ts:9</li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#ChartData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Chart<wbr/>Data</span></a><a href="#ReportData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Report<wbr/>Data</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
try {
const generateLinkElement = document.querySelector(".tsd-generator a");
const link = document.createElement("a");
Object.assign(link, {
href: "https://github.com/dmnsgn/typedoc-material-theme",
target: "_blank",
rel: "noreferrer",
innerText: "typedoc-material-theme."
});
generateLinkElement.insertAdjacentElement("afterend", link);
generateLinkElement.insertAdjacentText("afterend", " with ");
} catch (error) {
}
</script></body></html>
+189
View File
@@ -0,0 +1,189 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TimeSpanIncrement | onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><style>
@media (prefers-color-scheme: dark) {
:root {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
}
:root[data-theme="dark"] {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
@media (prefers-color-scheme: light) {
:root {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
}
:root[data-theme="light"] {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">onspring-api-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">onspring-api-sdk</a></li><li><a href="TimeSpanIncrement.html">TimeSpanIncrement</a></li></ul><h1>Enumeration TimeSpanIncrement</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>TimeSpanIncrement - The increment values for a time span field.</p>
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in enums/TimeSpanIncrement.ts:4</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="TimeSpanIncrement.html#Days" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Days</span></a>
<a href="TimeSpanIncrement.html#Hours" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Hours</span></a>
<a href="TimeSpanIncrement.html#Minutes" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Minutes</span></a>
<a href="TimeSpanIncrement.html#Months" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Months</span></a>
<a href="TimeSpanIncrement.html#Seconds" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Seconds</span></a>
<a href="TimeSpanIncrement.html#Weeks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Weeks</span></a>
<a href="TimeSpanIncrement.html#Years" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Years</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="Days" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Days</span><a href="#Days" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Days</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Days&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>Days - The time span increment is days.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/TimeSpanIncrement.ts:27</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Hours" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Hours</span><a href="#Hours" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Hours</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Hours&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>Hours - The time span increment is hours.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/TimeSpanIncrement.ts:21</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Minutes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Minutes</span><a href="#Minutes" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Minutes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Minutes&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>Minutes - The time span increment is minutes.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/TimeSpanIncrement.ts:15</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Months" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Months</span><a href="#Months" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Months</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Months&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>Months - The time span increment is months.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/TimeSpanIncrement.ts:39</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Seconds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Seconds</span><a href="#Seconds" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Seconds</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Seconds&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>Seconds - The time span increment is seconds.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/TimeSpanIncrement.ts:9</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Weeks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Weeks</span><a href="#Weeks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Weeks</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Weeks&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>Weeks - The time span increment is weeks.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/TimeSpanIncrement.ts:33</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="Years" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>Years</span><a href="#Years" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">Years</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Years&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>Years - The time span increment is years.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/TimeSpanIncrement.ts:45</li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#Days" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Days</span></a><a href="#Hours" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Hours</span></a><a href="#Minutes" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Minutes</span></a><a href="#Months" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Months</span></a><a href="#Seconds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Seconds</span></a><a href="#Weeks" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Weeks</span></a><a href="#Years" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>Years</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
try {
const generateLinkElement = document.querySelector(".tsd-generator a");
const link = document.createElement("a");
Object.assign(link, {
href: "https://github.com/dmnsgn/typedoc-material-theme",
target: "_blank",
rel: "noreferrer",
innerText: "typedoc-material-theme."
});
generateLinkElement.insertAdjacentElement("afterend", link);
generateLinkElement.insertAdjacentText("afterend", " with ");
} catch (error) {
}
</script></body></html>
+181
View File
@@ -0,0 +1,181 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TimeSpanRecurrenceType | onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><style>
@media (prefers-color-scheme: dark) {
:root {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
}
:root[data-theme="dark"] {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
@media (prefers-color-scheme: light) {
:root {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
}
:root[data-theme="light"] {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
</style><link rel="stylesheet" href="../assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">onspring-api-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">onspring-api-sdk</a></li><li><a href="TimeSpanRecurrenceType.html">TimeSpanRecurrenceType</a></li></ul><h1>Enumeration TimeSpanRecurrenceType</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>TimeSpanRecurrenceType - The type of recurrence for a time span.</p>
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in enums/TimeSpanRecurrenceType.ts:5</li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="TimeSpanRecurrenceType.html#EndAfterOccurrences" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>End<wbr/>After<wbr/>Occurrences</span></a>
<a href="TimeSpanRecurrenceType.html#EndByDate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>End<wbr/>By<wbr/>Date</span></a>
<a href="TimeSpanRecurrenceType.html#None" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>None</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Enumeration Members</h2><section class="tsd-panel tsd-member"><a id="EndAfterOccurrences" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>End<wbr/>After<wbr/>Occurrences</span><a href="#EndAfterOccurrences" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">End<wbr/>After<wbr/>Occurrences</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;EndAfterOccurrences&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>EndAfterOccurrences - The time span recurs for a specific number of occurrences.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/TimeSpanRecurrenceType.ts:22</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="EndByDate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>End<wbr/>By<wbr/>Date</span><a href="#EndByDate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">End<wbr/>By<wbr/>Date</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;EndByDate&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>EndByDate - The time span recurs until a specific date.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/TimeSpanRecurrenceType.ts:16</li></ul></aside></section><section class="tsd-panel tsd-member"><a id="None" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>None</span><a href="#None" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">None</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;None&quot;</span></div><div class="tsd-comment tsd-typography"><h4>Constant</h4><p>None - The time span does not recur.</p>
</div><aside class="tsd-sources"><ul><li>Defined in enums/TimeSpanRecurrenceType.ts:10</li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#EndAfterOccurrences" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>End<wbr/>After<wbr/>Occurrences</span></a><a href="#EndByDate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>End<wbr/>By<wbr/>Date</span></a><a href="#None" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-16"></use></svg><span>None</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
try {
const generateLinkElement = document.querySelector(".tsd-generator a");
const link = document.createElement("a");
Object.assign(link, {
href: "https://github.com/dmnsgn/typedoc-material-theme",
target: "_blank",
rel: "noreferrer",
innerText: "typedoc-material-theme."
});
generateLinkElement.insertAdjacentElement("afterend", link);
generateLinkElement.insertAdjacentText("afterend", " with ");
} catch (error) {
}
</script></body></html>
+174
View File
File diff suppressed because one or more lines are too long
+331
View File
File diff suppressed because one or more lines are too long
+238
View File
@@ -0,0 +1,238 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>onspring-api-sdk</title><meta name="description" content="Documentation for onspring-api-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><style>
@media (prefers-color-scheme: dark) {
:root {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
}
:root[data-theme="dark"] {
--md-sys-color-primary: #adc6ff;
--md-sys-color-on-primary: #002e6a;
--md-sys-color-primary-container: #10448f;
--md-sys-color-on-primary-container: #d8e2ff;
--md-sys-color-secondary: #bfc6dc;
--md-sys-color-on-secondary: #293041;
--md-sys-color-secondary-container: #3f4759;
--md-sys-color-on-secondary-container: #dbe2f9;
--md-sys-color-tertiary: #debcdf;
--md-sys-color-on-tertiary: #402843;
--md-sys-color-tertiary-container: #583e5b;
--md-sys-color-on-tertiary-container: #fcd7fb;
--md-sys-color-error: #ffb4ab;
--md-sys-color-on-error: #690005;
--md-sys-color-error-container: #93000a;
--md-sys-color-on-error-container: #ffb4ab;
--md-sys-color-background: #1b1b1f;
--md-sys-color-on-background: #e3e2e6;
--md-sys-color-surface: #1b1b1f;
--md-sys-color-on-surface: #e3e2e6;
--md-sys-color-surface-variant: #44474f;
--md-sys-color-on-surface-variant: #c4c6d0;
--md-sys-color-outline: #8e9099;
--md-sys-color-outline-variant: #44474f;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #e3e2e6;
--md-sys-color-inverse-on-surface: #303034;
--md-sys-color-inverse-primary: #325da8;
--md-sys-color-surface-dim: #121316;
--md-sys-color-surface-bright: #38393c;
--md-sys-color-surface-container-lowest: #0d0e11;
--md-sys-color-surface-container-low: #1b1b1f;
--md-sys-color-surface-container: #1f1f23;
--md-sys-color-surface-container-high: #292a2d;
--md-sys-color-surface-container-highest: #343538
}
@media (prefers-color-scheme: light) {
:root {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
}
:root[data-theme="light"] {
--md-sys-color-primary: #325da8;
--md-sys-color-on-primary: #ffffff;
--md-sys-color-primary-container: #d8e2ff;
--md-sys-color-on-primary-container: #001a42;
--md-sys-color-secondary: #575e71;
--md-sys-color-on-secondary: #ffffff;
--md-sys-color-secondary-container: #dbe2f9;
--md-sys-color-on-secondary-container: #141b2c;
--md-sys-color-tertiary: #715573;
--md-sys-color-on-tertiary: #ffffff;
--md-sys-color-tertiary-container: #fcd7fb;
--md-sys-color-on-tertiary-container: #29132d;
--md-sys-color-error: #ba1a1a;
--md-sys-color-on-error: #ffffff;
--md-sys-color-error-container: #ffdad6;
--md-sys-color-on-error-container: #410002;
--md-sys-color-background: #fefbff;
--md-sys-color-on-background: #1b1b1f;
--md-sys-color-surface: #fefbff;
--md-sys-color-on-surface: #1b1b1f;
--md-sys-color-surface-variant: #e1e2ec;
--md-sys-color-on-surface-variant: #44474f;
--md-sys-color-outline: #75777f;
--md-sys-color-outline-variant: #c4c6d0;
--md-sys-color-shadow: #000000;
--md-sys-color-scrim: #000000;
--md-sys-color-inverse-surface: #303034;
--md-sys-color-inverse-on-surface: #f2f0f4;
--md-sys-color-inverse-primary: #adc6ff;
--md-sys-color-surface-dim: #dbd9dd;
--md-sys-color-surface-bright: #faf8fd;
--md-sys-color-surface-container-lowest: #ffffff;
--md-sys-color-surface-container-low: #f5f3f7;
--md-sys-color-surface-container: #efedf1;
--md-sys-color-surface-container-high: #e9e7ec;
--md-sys-color-surface-container-highest: #e3e2e6
}
</style><link rel="stylesheet" href="assets/material-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">onspring-api-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>onspring-api-sdk</h2></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><h3 class="tsd-index-heading uppercase">Index</h3><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumerations</h3><div class="tsd-index-list"><a href="enums/DataFormat.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-8"></use></svg><span>Data<wbr/>Format</span></a>
<a href="enums/DelegateType.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-8"></use></svg><span>Delegate<wbr/>Type</span></a>
<a href="enums/FieldStatus.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-8"></use></svg><span>Field<wbr/>Status</span></a>
<a href="enums/FieldType.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-8"></use></svg><span>Field<wbr/>Type</span></a>
<a href="enums/FileStorageSite.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-8"></use></svg><span>File<wbr/>Storage<wbr/>Site</span></a>
<a href="enums/FilterOperators.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-8"></use></svg><span>Filter<wbr/>Operators</span></a>
<a href="enums/FormulaOutputType.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-8"></use></svg><span>Formula<wbr/>Output<wbr/>Type</span></a>
<a href="enums/HttpStatusCode.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-8"></use></svg><span>Http<wbr/>Status<wbr/>Code</span></a>
<a href="enums/Multiplicity.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-8"></use></svg><span>Multiplicity</span></a>
<a href="enums/RecordValueType.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-8"></use></svg><span>Record<wbr/>Value<wbr/>Type</span></a>
<a href="enums/ReportDataType.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-8"></use></svg><span>Report<wbr/>Data<wbr/>Type</span></a>
<a href="enums/TimeSpanIncrement.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-8"></use></svg><span>Time<wbr/>Span<wbr/>Increment</span></a>
<a href="enums/TimeSpanRecurrenceType.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-8"></use></svg><span>Time<wbr/>Span<wbr/>Recurrence<wbr/>Type</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Classes</h3><div class="tsd-index-list"><a href="classes/ApiResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Api<wbr/>Response</span></a>
<a href="classes/App.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>App</span></a>
<a href="classes/Attachment.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Attachment</span></a>
<a href="classes/AttachmentListRecordValue.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Attachment<wbr/>List<wbr/>Record<wbr/>Value</span></a>
<a href="classes/CollectionResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Collection<wbr/>Response</span></a>
<a href="classes/CreatedWithIdResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Created<wbr/>With<wbr/>Id<wbr/>Response</span></a>
<a href="classes/DateRecordValue.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Date<wbr/>Record<wbr/>Value</span></a>
<a href="classes/DecimalRecordValue.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Decimal<wbr/>Record<wbr/>Value</span></a>
<a href="classes/Delegate.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Delegate</span></a>
<a href="classes/DelegateListRecordValue.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Delegate<wbr/>List<wbr/>Record<wbr/>Value</span></a>
<a href="classes/EndpointFactory.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Endpoint<wbr/>Factory</span></a>
<a href="classes/Field.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Field</span></a>
<a href="classes/File.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>File</span></a>
<a href="classes/FileInfo.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>File<wbr/>Info</span></a>
<a href="classes/FileListRecordValue.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>File<wbr/>List<wbr/>Record<wbr/>Value</span></a>
<a href="classes/FormulaField.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Formula<wbr/>Field</span></a>
<a href="classes/GetPagedAppsResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Get<wbr/>Paged<wbr/>Apps<wbr/>Response</span></a>
<a href="classes/GetPagedFieldsResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Get<wbr/>Paged<wbr/>Fields<wbr/>Response</span></a>
<a href="classes/GetPagedRecordsResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Get<wbr/>Paged<wbr/>Records<wbr/>Response</span></a>
<a href="classes/GetPagedReportsResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Get<wbr/>Paged<wbr/>Reports<wbr/>Response</span></a>
<a href="classes/GetRecordRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Get<wbr/>Record<wbr/>Request</span></a>
<a href="classes/GetRecordsByAppIdRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Get<wbr/>Records<wbr/>By<wbr/>App<wbr/>Id<wbr/>Request</span></a>
<a href="classes/GetRecordsRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Get<wbr/>Records<wbr/>Request</span></a>
<a href="classes/GuidListRecordValue.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Guid<wbr/>List<wbr/>Record<wbr/>Value</span></a>
<a href="classes/GuidRecordValue.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Guid<wbr/>Record<wbr/>Value</span></a>
<a href="classes/IntegerListRecordValue.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Integer<wbr/>List<wbr/>Record<wbr/>Value</span></a>
<a href="classes/IntegerRecordValue.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Integer<wbr/>Record<wbr/>Value</span></a>
<a href="classes/ListField.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>List<wbr/>Field</span></a>
<a href="classes/ListItemRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>List<wbr/>Item<wbr/>Request</span></a>
<a href="classes/ListItemResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>List<wbr/>Item<wbr/>Response</span></a>
<a href="classes/ListValue.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>List<wbr/>Value</span></a>
<a href="classes/OnspringClient.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Onspring<wbr/>Client</span></a>
<a href="classes/PagedResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Paged<wbr/>Response</span></a>
<a href="classes/PagingRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Paging<wbr/>Request</span></a>
<a href="classes/QueryFilter.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Query<wbr/>Filter</span></a>
<a href="classes/QueryRecordsRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Query<wbr/>Records<wbr/>Request</span></a>
<a href="classes/Record.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Record</span></a>
<a href="classes/RecordValue.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Record<wbr/>Value</span></a>
<a href="classes/ReferenceField.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Reference<wbr/>Field</span></a>
<a href="classes/Report.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Report</span></a>
<a href="classes/ReportData.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Report<wbr/>Data</span></a>
<a href="classes/Row.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Row</span></a>
<a href="classes/SaveFileRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Save<wbr/>File<wbr/>Request</span></a>
<a href="classes/SaveRecordRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Save<wbr/>Record<wbr/>Request</span></a>
<a href="classes/SaveRecordResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Save<wbr/>Record<wbr/>Response</span></a>
<a href="classes/ScoringGroup.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Scoring<wbr/>Group</span></a>
<a href="classes/ScoringGroupListRecordValue.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Scoring<wbr/>Group<wbr/>List<wbr/>Record<wbr/>Value</span></a>
<a href="classes/StringListRecordValue.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>String<wbr/>List<wbr/>Record<wbr/>Value</span></a>
<a href="classes/StringRecordValue.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>String<wbr/>Record<wbr/>Value</span></a>
<a href="classes/TimeSpanData.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Time<wbr/>Span<wbr/>Data</span></a>
<a href="classes/TimeSpanRecordValue.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-128"></use></svg><span>Time<wbr/>Span<wbr/>Record<wbr/>Value</span></a>
</div></section></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>onspring-api-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div><script>
try {
const generateLinkElement = document.querySelector(".tsd-generator a");
const link = document.createElement("a");
Object.assign(link, {
href: "https://github.com/dmnsgn/typedoc-material-theme",
target: "_blank",
rel: "noreferrer",
innerText: "typedoc-material-theme."
});
generateLinkElement.insertAdjacentElement("afterend", link);
generateLinkElement.insertAdjacentText("afterend", " with ");
} catch (error) {
}
</script></body></html>
+3403 -2237
View File
File diff suppressed because it is too large Load Diff
+31 -25
View File
@@ -43,12 +43,16 @@
}
},
"scripts": {
"generate-docs": "typedoc src/index.ts --plugin typedoc-material-theme --themeColor '#194488' --gitRemote github",
"clean": "rimraf dist",
"lint": "eslint --ignore-path .eslintignore --ext .js,.ts .",
"lint-fix": "eslint --fix --ignore-path .eslintignore --ext .js,.ts . --max-warnings=0",
"format-staged": "pretty-quick --staged",
"format": "pretty-quick",
"build": "npm run tests && npm run clean && tsc --project tsconfig.cjs.json && tsc --project tsconfig.esm.json && node ./scripts/create_dist_package_json.js",
"build": "npm run test-coverage:ci && npm run clean && tsc --project tsconfig.cjs.json && tsc --project tsconfig.esm.json && node ./scripts/create_dist_package_json.js",
"build:esm": "tsc --project tsconfig.esm.json",
"build:cjs": "tsc --project tsconfig.cjs.json",
"build:json": "node ./scripts/create_dist_package_json.js",
"test:unit": "mocha -r ts-node/register",
"test:integration": "mocha -r ts-node/register -r integrationTests/mochaRootHooks.ts",
"tests:unit": "mocha -R progress -r ts-node/register ./tests/**/*.spec.ts",
@@ -59,35 +63,37 @@
"prepare": "husky install"
},
"devDependencies": {
"@commitlint/cli": "^17.4.4",
"@commitlint/config-conventional": "^17.4.4",
"@commitlint/cli": "^17.8.1",
"@commitlint/config-conventional": "^17.8.1",
"@istanbuljs/nyc-config-typescript": "^1.0.2",
"@types/chai": "^4.3.4",
"@types/mocha": "^10.0.1",
"@types/node": "^18.14.0",
"@types/sinon": "^10.0.13",
"@typescript-eslint/eslint-plugin": "^5.50.0",
"@typescript-eslint/parser": "^5.50.0",
"chai": "^4.3.7",
"dotenv": "^16.0.3",
"eslint": "^8.33.0",
"eslint-config-prettier": "^8.6.0",
"eslint-config-standard-with-typescript": "^34.0.0",
"eslint-plugin-import": "^2.27.5",
"eslint-plugin-mocha": "^10.1.0",
"eslint-plugin-n": "^15.6.1",
"eslint-plugin-promise": "^6.1.1",
"@types/chai": "^4.3.20",
"@types/mocha": "^10.0.10",
"@types/node": "^18.19.129",
"@types/sinon": "^10.0.20",
"@typescript-eslint/eslint-plugin": "^5.62.0",
"@typescript-eslint/parser": "^5.62.0",
"chai": "^4.5.0",
"dotenv": "^16.6.1",
"eslint": "^8.57.1",
"eslint-config-prettier": "^8.10.2",
"eslint-config-standard-with-typescript": "^34.0.1",
"eslint-plugin-import": "^2.32.0",
"eslint-plugin-mocha": "^10.5.0",
"eslint-plugin-n": "^15.7.0",
"eslint-plugin-promise": "^6.6.0",
"husky": "^8.0.3",
"mocha": "^10.2.0",
"mocha": "^10.8.2",
"nyc": "^15.1.0",
"prettier": "^2.8.3",
"pretty-quick": "^3.1.3",
"sinon": "^15.0.1",
"ts-node": "^10.9.1",
"prettier": "^2.8.8",
"pretty-quick": "^3.3.1",
"sinon": "^15.2.0",
"ts-node": "^10.9.2",
"typedoc": "^0.25.13",
"typedoc-material-theme": "^1.4.0",
"typescript": "^4.9.5"
},
"dependencies": {
"axios": "^1.2.4",
"form-data": "^4.0.0"
"axios": "^1.13.6",
"form-data": "^4.0.5"
}
}
+12
View File
@@ -1,4 +1,16 @@
/**
* @enum DelegateType - The type of delegate
*/
export enum DelegateType {
/**
* @constant External - The delegate is external.
* @type {string}
*/
External = 'External',
/**
* @constant Internal - The delegate is internal.
* @type {string}
*/
Internal = 'Internal',
}
+3
View File
@@ -1,3 +1,6 @@
/**
* @enum FileStorageSite - The site where the file is stored.
*/
export enum FileStorageSite {
/**
* @constant Internal - The file is stored in the internal file storage.
+10
View File
@@ -4,60 +4,70 @@
export enum FilterOperators {
/**
* @constant Equal - The equal operator
* @type {string}
* @remarks Can be used with text, auto-number, date, and number fields as well as their formula equivalents.
*/
Equal = 'eq',
/**
* @constant NotEqual - The not equal operator
* @type {string}
* @remarks Can be used with text, auto-number, date, and number fields as well as their formula equivalents.
*/
NotEqual = 'ne',
/**
* @constant Contains - The contains operator
* @type {string}
* @remarks Can be used with list fields as well as their formula equivalents.
*/
Contains = 'contains',
/**
* @constant IsNull - The is null operator
* @type {string}
* @remarks Can be used with text, date, and number fields as well as their formula equivalents.
*/
IsNull = 'isnull',
/**
* @constant NotNull - The not null operator
* @type {string}
* @remarks Can be used with text, date, and number fields as well as their formula equivalents.
*/
NotNull = 'notnull',
/**
* @constant GreaterThan - The greater than operator
* @type {string}
* @remarks Can be used with auto-number, date, and number fields as well as their formula equivalents.
*/
GreaterThan = 'gt',
/**
* @constant LessThan - The less than operator
* @type {string}
* @remarks Can be used with auto-number, date, and number fields as well as their formula equivalents.
*/
LessThan = 'lt',
/**
* @constant And - The and operator
* @type {string}
* @remarks Can be used to create compound filters.
*/
And = 'and',
/**
* @constant Or - The or operator
* @type {string}
* @remarks Can be used to create compound filters.
*/
Or = 'or',
/**
* @constant Not - The not operator
* @type {string}
* @remarks Can be used to negate a filter and create compound filters.
*/
Not = 'not',
+3
View File
@@ -1,3 +1,6 @@
/**
* @enum FormulaOutputType - The type of the formula output.
*/
export enum FormulaOutputType {
/**
* @constant Text - The formula output is a text value.
+30 -4
View File
@@ -238,6 +238,10 @@ export class ApiResponse<T> {
);
}
/**
* @method asFileInfoType - Converts the ApiResponse to an ApiResponse<FileInfo>.
* @returns {ApiResponse<FileInfo>} - An ApiResponse<FileInfo>.
*/
public asFileInfoType(): ApiResponse<FileInfo> {
const apiResponse = this as ApiResponse<any>;
@@ -259,6 +263,10 @@ export class ApiResponse<T> {
);
}
/**
* @method asFileType - Converts the ApiResponse to an ApiResponse<File>.
* @returns {ApiResponse<File>} - An ApiResponse<File>.
*/
public asFileType(response: AxiosResponse): ApiResponse<File> {
const apiResponse = this as ApiResponse<any>;
const fileName = response.headers['content-disposition']
@@ -315,7 +323,7 @@ export class ApiResponse<T> {
const apiResponse = this as ApiResponse<any>;
const reports = apiResponse.data.items.map((item: any) => {
return new Report(item.id, item.appId, item.name, item.description);
return new Report(item.appId, item.id, item.name, item.description);
});
const getPagedReportsResponse = new GetPagedReportsResponse(
@@ -408,6 +416,10 @@ export class ApiResponse<T> {
);
}
/**
* @method asRecordCollectionType - Converts the ApiResponse to an ApiResponse<CollectionResponse<Record>>.
* @returns {ApiResponse<CollectionResponse<Record>>} - An ApiResponse<CollectionResponse<Record>>.
*/
public asRecordCollectionType(): ApiResponse<CollectionResponse<Record>> {
const apiResponse = this as ApiResponse<any>;
@@ -431,6 +443,10 @@ export class ApiResponse<T> {
);
}
/**
* @method asSaveRecordResponseType - Converts the ApiResponse to an ApiResponse<SaveRecordResponse>.
* @returns {ApiResponse<SaveRecordResponse>} - An ApiResponse<SaveRecordResponse>.
*/
public asSaveRecordResponseType(): ApiResponse<SaveRecordResponse> {
const apiResponse = this as ApiResponse<any>;
const response = new SaveRecordResponse(
@@ -444,6 +460,11 @@ export class ApiResponse<T> {
);
}
/**
* @method getRecordValueByType - Gets the RecordValue by by type.
* @param {RecordValue} recordValueItem - The record value item.
* @returns {RecordValue} - The RecordValue.
*/
private static getRecordValueByType(recordValueItem: any): RecordValue<any> {
const type = RecordValueType[recordValueItem.type];
@@ -626,6 +647,11 @@ export class ApiResponse<T> {
}
}
/**
* @method convertToDelegate - Converts the delegate item to a Delegate object.
* @param {any} delegateItem - The delegate item to convert.
* @returns {Delegate} - The converted Delegate object.
*/
private static convertToDelegate(delegateItem: any): Delegate {
const delegateType = DelegateType[delegateItem.delegateType];
@@ -712,7 +738,7 @@ export class ApiResponse<T> {
const hasRecurrence =
timeSpanItem.recurrence !== null && timeSpanItem.recurrence !== undefined;
const recurrene = hasRecurrence
const recurrence = hasRecurrence
? TimeSpanRecurrenceType[timeSpanItem.recurrence]
: null;
@@ -735,7 +761,7 @@ export class ApiResponse<T> {
);
}
if (recurrene === undefined) {
if (recurrence === undefined) {
throw new Error(
`${
timeSpanItem.recurrence as string
@@ -746,7 +772,7 @@ export class ApiResponse<T> {
return new TimeSpanData(
timeSpanItem.quantity,
increment,
recurrene,
recurrence,
endAfterOccurrences,
endByDate
);
+3 -1
View File
@@ -60,7 +60,9 @@ export class ApiResponseFactory {
}
/**
*
* @method getStreamDataAsString - Gets the data from a stream as a string
* @param {Readable} stream - The stream that will be used to get the data
* @returns {Promise<string>} - A promise that resolves to the data from the stream as a string
*/
private static async getStreamDataAsString(
stream: Readable
+3
View File
@@ -1,3 +1,6 @@
/**
* @class CreatedWithIdResponse<T> - Represents a response to a request to create a resource.
*/
export class CreatedWithIdResponse<T> {
/**
* @property {T} id - The id of the created object.
+9
View File
@@ -1,7 +1,16 @@
import { RecordValue } from './RecordValue.js';
import { RecordValueType } from '../enums/RecordValueType.js';
/**
* @class DecimalRecordValue - Represents a decimal record value
*/
export class DecimalRecordValue extends RecordValue<number> {
/**
* @constructor - Creates a new instance of DecimalRecordValue
* @param {number} fieldId - The id of the field
* @param {number} value - The value of the field
* @returns {DecimalRecordValue} - A new instance of DecimalRecordValue
*/
constructor(fieldId: number, value: number) {
super(RecordValueType.Decimal, fieldId, value);
}
+9
View File
@@ -2,7 +2,16 @@ import { RecordValueType } from '../enums/RecordValueType.js';
import { type Delegate } from './Delegate.js';
import { RecordValue } from './RecordValue.js';
/**
* @class DelegateListRecordValue - Represents a delegate list record value.
*/
export class DelegateListRecordValue extends RecordValue<Delegate[]> {
/**
* @constructor - Creates a new instance of DelegateListRecordValue.
* @param {number} fieldId - The id of the field.
* @param {Delegate[]} value - The value of the field.
* @returns {DelegateListRecordValue} - A new instance of DelegateListRecordValue.
*/
constructor(fieldId: number, value: Delegate[]) {
super(RecordValueType.DelegateList, fieldId, value);
}
+9
View File
@@ -2,7 +2,16 @@ import { RecordValueType } from '../enums/RecordValueType.js';
import { type File } from './File.js';
import { RecordValue } from './RecordValue.js';
/**
* @class FileListRecordValue - Represents a file list record value.
*/
export class FileListRecordValue extends RecordValue<File[]> {
/**
* @constructor - Creates a new instance of FileListRecordValue.
* @param {number} fieldId - The id of the field.
* @param {File[]} value - The value of the field.
* @returns {FileListRecordValue} - A new instance of FileListRecordValue.
*/
constructor(fieldId: number, value: File[]) {
super(RecordValueType.FileList, fieldId, value);
}
+3
View File
@@ -1,6 +1,9 @@
import { DataFormat } from '../enums/DataFormat.js';
import { PagingRequest } from './PagingRequest.js';
/**
* @class GetRecordsByAppIdRequest - Represents a request to get records by app id.
*/
export class GetRecordsByAppIdRequest {
/**
* @property {number} appId - The id of the app that the records belong to.
+9
View File
@@ -1,7 +1,16 @@
import { RecordValueType } from '../enums/RecordValueType.js';
import { RecordValue } from './RecordValue.js';
/**
* @class GuidListRecordValue - Represents a guid list record value.
*/
export class GuidListRecordValue extends RecordValue<string[]> {
/**
* @constructor - Creates a new instance of GuidListRecordValue.
* @param {number} fieldId - The id of the field.
* @param {string[]} value - The value of the field.
* @returns {GuidListRecordValue} - A new instance of GuidListRecordValue.
*/
constructor(fieldId: number, value: string[]) {
super(RecordValueType.GuidList, fieldId, value);
}

Some files were not shown because too many files have changed in this diff Show More