@oomol-lab/open-connector 1.9.0 → 1.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/assets/open-connector/catalog/apps/agentearth.json +441 -0
- package/assets/open-connector/catalog/apps/appgrowing_mcp.json +863 -0
- package/assets/open-connector/catalog/apps/arcmira.json +610 -0
- package/assets/open-connector/catalog/apps/bainiu.json +654 -0
- package/assets/open-connector/catalog/apps/chaport.json +331 -0
- package/assets/open-connector/catalog/apps/cnb.json +1408 -0
- package/assets/open-connector/catalog/apps/crtsh.json +123 -0
- package/assets/open-connector/catalog/apps/eastmoney_miaoxiang.json +406 -0
- package/assets/open-connector/catalog/apps/fastmoss_mcp.json +876 -876
- package/assets/open-connector/catalog/apps/ftshare.json +1162 -0
- package/assets/open-connector/catalog/apps/fusion-api.json +143 -0
- package/assets/open-connector/catalog/apps/fxbaogao.json +308 -0
- package/assets/open-connector/catalog/apps/github.json +38 -3
- package/assets/open-connector/catalog/apps/hrmos_kintai.json +7519 -0
- package/assets/open-connector/catalog/apps/humor_api.json +351 -0
- package/assets/open-connector/catalog/apps/kaonavi.json +1723 -0
- package/assets/open-connector/catalog/apps/linear_mcp.json +882 -22
- package/assets/open-connector/catalog/apps/listinggood.json +362 -0
- package/assets/open-connector/catalog/apps/notion_mcp.json +338 -1
- package/assets/open-connector/catalog/apps/outlook.json +414 -0
- package/assets/open-connector/catalog/apps/porteden.json +1258 -0
- package/assets/open-connector/catalog/apps/qiuxiaoce.json +915 -0
- package/assets/open-connector/catalog/apps/qqmusic.json +1834 -0
- package/assets/open-connector/catalog/apps/rakuraku_seisan.json +217 -0
- package/assets/open-connector/catalog/apps/redfox.json +9661 -897
- package/assets/open-connector/catalog/apps/salesforce.json +4907 -0
- package/assets/open-connector/catalog/apps/sansan.json +4594 -0
- package/assets/open-connector/catalog/apps/smarthr.json +8071 -0
- package/assets/open-connector/catalog/apps/smooth.json +914 -0
- package/assets/open-connector/catalog/apps/tapd.json +727 -0
- package/assets/open-connector/catalog/apps/tencent_meeting_mcp.json +1301 -0
- package/assets/open-connector/catalog/apps/threatfox.json +203 -0
- package/assets/open-connector/catalog/apps/tradebee.json +915 -0
- package/assets/open-connector/catalog/apps/twittrapi.json +4914 -0
- package/assets/open-connector/catalog/apps/urlhaus.json +246 -0
- package/assets/open-connector/catalog/apps/weread.json +1514 -0
- package/assets/open-connector/catalog/apps/whatsapp.json +12 -0
- package/assets/open-connector/catalog/apps/zhiliaobiaoxun.json +812 -0
- package/assets/open-connector/catalog/apps-index.json +1 -1
- package/package.json +2 -1
- package/src/connection-service.js +55 -11
- package/src/core/provider-error-codes.d.ts +9 -0
- package/src/core/provider-error-codes.js +13 -0
- package/src/core/request.d.ts +2 -0
- package/src/core/request.js +11 -2
- package/src/mail/imap-smtp/protocol.js +4 -3
- package/src/oauth/oauth-flow-service.js +1 -0
- package/src/oauth/oauth-token.d.ts +2 -0
- package/src/providers/17track/runtime.js +17 -20
- package/src/providers/action-contracts.generated.d.ts +36 -6
- package/src/providers/agentearth/actions.d.ts +2 -0
- package/src/providers/agentearth/actions.js +100 -0
- package/src/providers/agentearth/executors.d.ts +4 -0
- package/src/providers/agentearth/executors.js +109 -0
- package/src/providers/appgrowing_mcp/actions.d.ts +2 -0
- package/src/providers/appgrowing_mcp/actions.js +175 -0
- package/src/providers/appgrowing_mcp/executors.d.ts +4 -0
- package/src/providers/appgrowing_mcp/executors.js +66 -0
- package/src/providers/arcmira/executors.d.ts +3 -0
- package/src/providers/arcmira/executors.js +8 -0
- package/src/providers/arcmira/runtime.d.ts +6 -0
- package/src/providers/arcmira/runtime.js +41 -0
- package/src/providers/bainiu/actions.d.ts +2 -0
- package/src/providers/bainiu/actions.js +108 -0
- package/src/providers/bainiu/executors.d.ts +4 -0
- package/src/providers/bainiu/executors.js +113 -0
- package/src/providers/baixiao/executors.js +1 -1
- package/src/providers/bing_webmaster/executors.js +1 -1
- package/src/providers/chaport/actions.d.ts +2 -0
- package/src/providers/chaport/actions.js +70 -0
- package/src/providers/chaport/executors.d.ts +4 -0
- package/src/providers/chaport/executors.js +128 -0
- package/src/providers/clickup/runtime.js +49 -52
- package/src/providers/cnb/actions.d.ts +2 -0
- package/src/providers/cnb/actions.js +341 -0
- package/src/providers/cnb/executors.d.ts +4 -0
- package/src/providers/cnb/executors.js +135 -0
- package/src/providers/coupontools/runtime.js +11 -14
- package/src/providers/crtsh/executors.d.ts +3 -0
- package/src/providers/crtsh/executors.js +19 -0
- package/src/providers/crtsh/runtime.d.ts +17 -0
- package/src/providers/crtsh/runtime.js +84 -0
- package/src/providers/eastmoney_miaoxiang/actions.d.ts +2 -0
- package/src/providers/eastmoney_miaoxiang/actions.js +95 -0
- package/src/providers/eastmoney_miaoxiang/executors.d.ts +4 -0
- package/src/providers/eastmoney_miaoxiang/executors.js +81 -0
- package/src/providers/fastmoss_mcp/actions-content.d.ts +2 -0
- package/src/providers/fastmoss_mcp/actions-content.js +140 -0
- package/src/providers/fastmoss_mcp/actions-creator.d.ts +2 -0
- package/src/providers/fastmoss_mcp/actions-creator.js +154 -0
- package/src/providers/fastmoss_mcp/actions-product.d.ts +2 -0
- package/src/providers/fastmoss_mcp/actions-product.js +167 -0
- package/src/providers/fastmoss_mcp/actions-research.d.ts +2 -0
- package/src/providers/fastmoss_mcp/actions-research.js +174 -0
- package/src/providers/fastmoss_mcp/actions-shop.d.ts +2 -0
- package/src/providers/fastmoss_mcp/actions-shop.js +142 -0
- package/src/providers/fastmoss_mcp/actions.js +11 -12
- package/src/providers/fastmoss_mcp/schemas.d.ts +51 -0
- package/src/providers/fastmoss_mcp/schemas.js +52 -0
- package/src/providers/ftshare/actions.d.ts +2 -0
- package/src/providers/ftshare/actions.js +124 -0
- package/src/providers/ftshare/executors.d.ts +4 -0
- package/src/providers/ftshare/executors.js +102 -0
- package/src/providers/fusion-api/operations.js +37 -0
- package/src/providers/fxbaogao/actions.d.ts +2 -0
- package/src/providers/fxbaogao/actions.js +74 -0
- package/src/providers/fxbaogao/executors.d.ts +4 -0
- package/src/providers/fxbaogao/executors.js +155 -0
- package/src/providers/github/app-installation.d.ts +37 -0
- package/src/providers/github/app-installation.js +233 -0
- package/src/providers/github/executors.js +93 -15
- package/src/providers/github/runtime-repository.js +21 -1
- package/src/providers/github/runtime-shared.d.ts +2 -0
- package/src/providers/github/runtime-shared.js +1 -0
- package/src/providers/googledrive/runtime-request.js +3 -3
- package/src/providers/hrmos_kintai/actions.d.ts +2 -0
- package/src/providers/hrmos_kintai/actions.js +139 -0
- package/src/providers/hrmos_kintai/attendance-actions.d.ts +2 -0
- package/src/providers/hrmos_kintai/attendance-actions.js +276 -0
- package/src/providers/hrmos_kintai/business-actions.d.ts +2 -0
- package/src/providers/hrmos_kintai/business-actions.js +143 -0
- package/src/providers/hrmos_kintai/business-schemas.d.ts +4 -0
- package/src/providers/hrmos_kintai/business-schemas.js +320 -0
- package/src/providers/hrmos_kintai/executors.d.ts +4 -0
- package/src/providers/hrmos_kintai/executors.js +61 -0
- package/src/providers/hrmos_kintai/export-actions.d.ts +2 -0
- package/src/providers/hrmos_kintai/export-actions.js +58 -0
- package/src/providers/hrmos_kintai/operations.d.ts +9 -0
- package/src/providers/hrmos_kintai/operations.js +278 -0
- package/src/providers/hrmos_kintai/runtime.d.ts +10 -0
- package/src/providers/hrmos_kintai/runtime.js +217 -0
- package/src/providers/hrmos_kintai/schemas.d.ts +10 -0
- package/src/providers/hrmos_kintai/schemas.js +70 -0
- package/src/providers/humor_api/actions.d.ts +2 -0
- package/src/providers/humor_api/actions.js +96 -0
- package/src/providers/humor_api/executors.d.ts +4 -0
- package/src/providers/humor_api/executors.js +76 -0
- package/src/providers/kaonavi/actions.d.ts +4 -0
- package/src/providers/kaonavi/actions.js +144 -0
- package/src/providers/kaonavi/additional-actions.d.ts +10 -0
- package/src/providers/kaonavi/additional-actions.js +203 -0
- package/src/providers/kaonavi/executors.d.ts +4 -0
- package/src/providers/kaonavi/executors.js +69 -0
- package/src/providers/kaonavi/runtime.d.ts +4 -0
- package/src/providers/kaonavi/runtime.js +69 -0
- package/src/providers/linear_mcp/actions.d.ts +14 -0
- package/src/providers/linear_mcp/actions.js +134 -0
- package/src/providers/linear_mcp/runtime-mcp.d.ts +7 -1
- package/src/providers/linear_mcp/runtime-mcp.js +140 -28
- package/src/providers/linkfox/runtime.js +48 -51
- package/src/providers/listinggood/actions.d.ts +2 -0
- package/src/providers/listinggood/actions.js +95 -0
- package/src/providers/listinggood/executors.d.ts +4 -0
- package/src/providers/listinggood/executors.js +99 -0
- package/src/providers/mcp-tools.d.ts +3 -0
- package/src/providers/mcp-tools.js +5 -4
- package/src/providers/notion_mcp/executors.js +53 -24
- package/src/providers/notion_mcp/mcp-response.d.ts +26 -0
- package/src/providers/notion_mcp/mcp-response.js +95 -0
- package/src/providers/omise/executors.js +1 -1
- package/src/providers/outlook/executors.js +35 -2
- package/src/providers/porteden/actions.d.ts +2 -0
- package/src/providers/porteden/actions.js +162 -0
- package/src/providers/porteden/executors.d.ts +4 -0
- package/src/providers/porteden/executors.js +140 -0
- package/src/providers/provider-runtime.d.ts +3 -2
- package/src/providers/pushover/runtime.js +28 -31
- package/src/providers/qianfan/runtime.js +16 -19
- package/src/providers/qiuxiaoce/actions.d.ts +2 -0
- package/src/providers/qiuxiaoce/actions.js +248 -0
- package/src/providers/qiuxiaoce/executors.d.ts +4 -0
- package/src/providers/qiuxiaoce/executors.js +76 -0
- package/src/providers/qiuxiaoce/routes.d.ts +1 -0
- package/src/providers/qiuxiaoce/routes.js +20 -0
- package/src/providers/qqmusic/actions.d.ts +2 -0
- package/src/providers/qqmusic/actions.js +229 -0
- package/src/providers/qqmusic/executors.d.ts +4 -0
- package/src/providers/qqmusic/executors.js +92 -0
- package/src/providers/qqmusic/report-schema.d.ts +4 -0
- package/src/providers/qqmusic/report-schema.js +119 -0
- package/src/providers/rakuraku_seisan/actions.d.ts +2 -0
- package/src/providers/rakuraku_seisan/actions.js +50 -0
- package/src/providers/rakuraku_seisan/executors.d.ts +4 -0
- package/src/providers/rakuraku_seisan/executors.js +40 -0
- package/src/providers/rakuraku_seisan/runtime.d.ts +8 -0
- package/src/providers/rakuraku_seisan/runtime.js +251 -0
- package/src/providers/redfox/actions-account.d.ts +2 -0
- package/src/providers/redfox/actions-account.js +24 -0
- package/src/providers/redfox/actions-autohome.d.ts +2 -0
- package/src/providers/redfox/actions-autohome.js +51 -0
- package/src/providers/redfox/actions-baijiahao.d.ts +2 -0
- package/src/providers/redfox/actions-baijiahao.js +58 -0
- package/src/providers/redfox/actions-bilibili.d.ts +2 -0
- package/src/providers/redfox/actions-bilibili.js +67 -0
- package/src/providers/redfox/actions-dongchedi.d.ts +2 -0
- package/src/providers/redfox/actions-dongchedi.js +49 -0
- package/src/providers/redfox/actions-douyin.d.ts +2 -0
- package/src/providers/redfox/actions-douyin.js +297 -0
- package/src/providers/redfox/actions-generation.d.ts +2 -0
- package/src/providers/redfox/actions-generation.js +293 -0
- package/src/providers/redfox/actions-instagram.d.ts +2 -0
- package/src/providers/redfox/actions-instagram.js +49 -0
- package/src/providers/redfox/actions-kuaishou.d.ts +2 -0
- package/src/providers/redfox/actions-kuaishou.js +53 -0
- package/src/providers/redfox/actions-search.d.ts +2 -0
- package/src/providers/redfox/actions-search.js +125 -0
- package/src/providers/redfox/actions-tiktok.d.ts +2 -0
- package/src/providers/redfox/actions-tiktok.js +136 -0
- package/src/providers/redfox/actions-tools.d.ts +2 -0
- package/src/providers/redfox/actions-tools.js +151 -0
- package/src/providers/redfox/actions-toutiao.d.ts +2 -0
- package/src/providers/redfox/actions-toutiao.js +68 -0
- package/src/providers/redfox/actions-transcription.d.ts +2 -0
- package/src/providers/redfox/actions-transcription.js +165 -0
- package/src/providers/redfox/actions-wechat-channel.d.ts +2 -0
- package/src/providers/redfox/actions-wechat-channel.js +63 -0
- package/src/providers/redfox/actions-wechat.d.ts +2 -0
- package/src/providers/redfox/actions-wechat.js +302 -0
- package/src/providers/redfox/actions-weibo.d.ts +2 -0
- package/src/providers/redfox/actions-weibo.js +61 -0
- package/src/providers/redfox/actions-x.d.ts +2 -0
- package/src/providers/redfox/actions-x.js +126 -0
- package/src/providers/redfox/actions-xiaohongshu.d.ts +2 -0
- package/src/providers/redfox/actions-xiaohongshu.js +244 -0
- package/src/providers/redfox/actions-yiche.d.ts +2 -0
- package/src/providers/redfox/actions-yiche.js +59 -0
- package/src/providers/redfox/actions-youtube.d.ts +2 -0
- package/src/providers/redfox/actions-youtube.js +64 -0
- package/src/providers/redfox/actions-zhihu.d.ts +2 -0
- package/src/providers/redfox/actions-zhihu.js +26 -0
- package/src/providers/redfox/actions.d.ts +2 -0
- package/src/providers/redfox/actions.js +49 -0
- package/src/providers/redfox/executors.d.ts +2 -14
- package/src/providers/redfox/executors.js +28 -551
- package/src/providers/redfox/routes.d.ts +11 -0
- package/src/providers/redfox/routes.js +329 -0
- package/src/providers/redfox/runtime.d.ts +6 -0
- package/src/providers/redfox/runtime.js +151 -0
- package/src/providers/redfox/schemas.d.ts +9 -0
- package/src/providers/redfox/schemas.js +40 -0
- package/src/providers/registry.generated.js +30 -0
- package/src/providers/salesforce/context.d.ts +16 -0
- package/src/providers/salesforce/context.js +58 -0
- package/src/providers/salesforce/executors.d.ts +5 -0
- package/src/providers/salesforce/executors.js +54 -0
- package/src/providers/salesforce/media.d.ts +9 -0
- package/src/providers/salesforce/media.js +66 -0
- package/src/providers/salesforce/oauth.d.ts +2 -0
- package/src/providers/salesforce/oauth.js +89 -0
- package/src/providers/salesforce/runtime-analytics.d.ts +2 -0
- package/src/providers/salesforce/runtime-analytics.js +60 -0
- package/src/providers/salesforce/runtime-automation.d.ts +2 -0
- package/src/providers/salesforce/runtime-automation.js +64 -0
- package/src/providers/salesforce/runtime-base.d.ts +2 -0
- package/src/providers/salesforce/runtime-base.js +51 -0
- package/src/providers/salesforce/runtime-bulk.d.ts +2 -0
- package/src/providers/salesforce/runtime-bulk.js +98 -0
- package/src/providers/salesforce/runtime-data.d.ts +2 -0
- package/src/providers/salesforce/runtime-data.js +207 -0
- package/src/providers/salesforce/runtime-files.d.ts +2 -0
- package/src/providers/salesforce/runtime-files.js +108 -0
- package/src/providers/salesforce/transport.d.ts +9 -0
- package/src/providers/salesforce/transport.js +65 -0
- package/src/providers/sansan/actions.d.ts +2 -0
- package/src/providers/sansan/actions.js +165 -0
- package/src/providers/sansan/admin-actions.d.ts +2 -0
- package/src/providers/sansan/admin-actions.js +181 -0
- package/src/providers/sansan/admin.d.ts +2 -0
- package/src/providers/sansan/admin.js +42 -0
- package/src/providers/sansan/business-actions.d.ts +2 -0
- package/src/providers/sansan/business-actions.js +160 -0
- package/src/providers/sansan/business.d.ts +2 -0
- package/src/providers/sansan/business.js +51 -0
- package/src/providers/sansan/executors.d.ts +4 -0
- package/src/providers/sansan/executors.js +59 -0
- package/src/providers/sansan/file-schema.d.ts +2 -0
- package/src/providers/sansan/file-schema.js +8 -0
- package/src/providers/sansan/files.d.ts +11 -0
- package/src/providers/sansan/files.js +49 -0
- package/src/providers/sansan/organization-actions.d.ts +2 -0
- package/src/providers/sansan/organization-actions.js +198 -0
- package/src/providers/sansan/organization-columns.d.ts +2 -0
- package/src/providers/sansan/organization-columns.js +33 -0
- package/src/providers/sansan/organization.d.ts +2 -0
- package/src/providers/sansan/organization.js +88 -0
- package/src/providers/sansan/read.d.ts +2 -0
- package/src/providers/sansan/read.js +25 -0
- package/src/providers/sansan/request.d.ts +22 -0
- package/src/providers/sansan/request.js +94 -0
- package/src/providers/sansan/schemas.d.ts +7 -0
- package/src/providers/sansan/schemas.js +72 -0
- package/src/providers/shopee/runtime.d.ts +33 -29
- package/src/providers/shopee/runtime.js +166 -169
- package/src/providers/smarthr/actions.d.ts +2 -0
- package/src/providers/smarthr/actions.js +286 -0
- package/src/providers/smarthr/employee-runtime.d.ts +1 -0
- package/src/providers/smarthr/employee-runtime.js +63 -0
- package/src/providers/smarthr/employee-schema.d.ts +3 -0
- package/src/providers/smarthr/employee-schema.js +222 -0
- package/src/providers/smarthr/executors.d.ts +4 -0
- package/src/providers/smarthr/executors.js +35 -0
- package/src/providers/smarthr/pagination.d.ts +1 -0
- package/src/providers/smarthr/pagination.js +84 -0
- package/src/providers/smarthr/resource-routes.d.ts +16 -0
- package/src/providers/smarthr/resource-routes.js +163 -0
- package/src/providers/smarthr/runtime.d.ts +13 -0
- package/src/providers/smarthr/runtime.js +242 -0
- package/src/providers/smarthr/supplemental-actions.d.ts +2 -0
- package/src/providers/smarthr/supplemental-actions.js +541 -0
- package/src/providers/smooth/actions.d.ts +2 -0
- package/src/providers/smooth/actions.js +138 -0
- package/src/providers/smooth/executors.d.ts +4 -0
- package/src/providers/smooth/executors.js +102 -0
- package/src/providers/tapd/actions.d.ts +8 -0
- package/src/providers/tapd/actions.js +89 -0
- package/src/providers/tapd/executors.d.ts +4 -0
- package/src/providers/tapd/executors.js +137 -0
- package/src/providers/teable/runtime.js +12 -15
- package/src/providers/tencent_meeting_mcp/actions.d.ts +2 -0
- package/src/providers/tencent_meeting_mcp/actions.js +420 -0
- package/src/providers/tencent_meeting_mcp/executors.d.ts +4 -0
- package/src/providers/tencent_meeting_mcp/executors.js +117 -0
- package/src/providers/threatfox/executors.d.ts +4 -0
- package/src/providers/threatfox/executors.js +40 -0
- package/src/providers/threatfox/runtime.d.ts +15 -0
- package/src/providers/threatfox/runtime.js +128 -0
- package/src/providers/ticket_tailor/runtime.js +1 -1
- package/src/providers/ticketmaster/runtime.js +3 -6
- package/src/providers/timelinesai/runtime.js +13 -16
- package/src/providers/tradebee/actions.d.ts +2 -0
- package/src/providers/tradebee/actions.js +176 -0
- package/src/providers/tradebee/executors.d.ts +4 -0
- package/src/providers/tradebee/executors.js +83 -0
- package/src/providers/twittrapi/executors.d.ts +4 -0
- package/src/providers/twittrapi/executors.js +17 -0
- package/src/providers/twittrapi/runtime.d.ts +12 -0
- package/src/providers/twittrapi/runtime.js +203 -0
- package/src/providers/urlhaus/executors.d.ts +4 -0
- package/src/providers/urlhaus/executors.js +40 -0
- package/src/providers/urlhaus/runtime.d.ts +15 -0
- package/src/providers/urlhaus/runtime.js +142 -0
- package/src/providers/wangdian/runtime.js +16 -19
- package/src/providers/weread/actions.d.ts +2 -0
- package/src/providers/weread/actions.js +424 -0
- package/src/providers/weread/executors.d.ts +4 -0
- package/src/providers/weread/executors.js +98 -0
- package/src/providers/whatsapp/runtime.js +6 -1
- package/src/providers/workast/runtime.js +12 -17
- package/src/providers/youzan/runtime.js +21 -24
- package/src/providers/zenkit/runtime.js +13 -19
- package/src/providers/zhiliaobiaoxun/actions.d.ts +2 -0
- package/src/providers/zhiliaobiaoxun/actions.js +138 -0
- package/src/providers/zhiliaobiaoxun/executors.d.ts +4 -0
- package/src/providers/zhiliaobiaoxun/executors.js +78 -0
- package/src/server/api/auth.d.ts +2 -0
- package/src/server/api/auth.js +2 -1
- package/src/server/api/console-catalog-routes.d.ts +17 -0
- package/src/server/api/console-catalog-routes.js +88 -0
- package/src/server/api/console-oauth-routes.d.ts +18 -0
- package/src/server/api/console-oauth-routes.js +298 -0
- package/src/server/api/docs-routes.d.ts +12 -0
- package/src/server/api/docs-routes.js +38 -0
- package/src/server/api/http-utils.d.ts +1 -0
- package/src/server/api/http-utils.js +8 -0
- package/src/server/api/marketplace-routes.d.ts +7 -0
- package/src/server/api/marketplace-routes.js +62 -0
- package/src/server/api/mcp-routes.d.ts +18 -0
- package/src/server/api/mcp-routes.js +37 -0
- package/src/server/api/policy-routes.d.ts +13 -0
- package/src/server/api/policy-routes.js +50 -0
- package/src/server/api/policy-snapshot.d.ts +14 -0
- package/src/server/api/policy-snapshot.js +30 -0
- package/src/server/api/run-log-routes.d.ts +7 -0
- package/src/server/api/run-log-routes.js +70 -0
- package/src/server/api/runtime-api.d.ts +0 -7
- package/src/server/api/runtime-api.js +0 -13
- package/src/server/api/runtime-app-routes.d.ts +10 -0
- package/src/server/api/runtime-app-routes.js +72 -0
- package/src/server/api/runtime-catalog-routes.d.ts +37 -0
- package/src/server/api/runtime-catalog-routes.js +133 -0
- package/src/server/api/runtime-execution-routes.d.ts +16 -0
- package/src/server/api/runtime-execution-routes.js +198 -0
- package/src/server/api/saas-oauth-routes.d.ts +9 -0
- package/src/server/api/saas-oauth-routes.js +27 -0
- package/src/server/api/saas-project-routes.d.ts +7 -0
- package/src/server/api/saas-project-routes.js +16 -0
- package/src/server/api/transit-file-routes.d.ts +9 -0
- package/src/server/api/transit-file-routes.js +49 -0
- package/src/server/api/trigger-routes.d.ts +15 -0
- package/src/server/api/trigger-routes.js +48 -0
- package/src/server/connect-app.d.ts +1 -0
- package/src/server/connect-app.js +3 -1
- package/src/server/connect-server.d.ts +3 -54
- package/src/server/connect-server.js +95 -1148
- package/src/providers/fastmoss_mcp/official-tools.json +0 -2922
|
@@ -0,0 +1,4594 @@
|
|
|
1
|
+
{
|
|
2
|
+
"service": "sansan",
|
|
3
|
+
"displayName": "Sansan",
|
|
4
|
+
"categories": [
|
|
5
|
+
"Productivity",
|
|
6
|
+
"Marketing"
|
|
7
|
+
],
|
|
8
|
+
"homepageUrl": "https://jp.sansan.com",
|
|
9
|
+
"authTypes": [
|
|
10
|
+
"api_key"
|
|
11
|
+
],
|
|
12
|
+
"auth": [
|
|
13
|
+
{
|
|
14
|
+
"type": "api_key",
|
|
15
|
+
"label": "API Key",
|
|
16
|
+
"placeholder": "SANSAN_API_KEY",
|
|
17
|
+
"description": "Create an API key under User name > Settings > API Key, or Administrator settings > External service integration > API. The key inherits its owner's permissions: https://jp-help.sansan.com/hc/ja/articles/206511517."
|
|
18
|
+
}
|
|
19
|
+
],
|
|
20
|
+
"actions": [
|
|
21
|
+
{
|
|
22
|
+
"id": "sansan.check_organization_import",
|
|
23
|
+
"service": "sansan",
|
|
24
|
+
"name": "check_organization_import",
|
|
25
|
+
"description": "Validate user and department import data without applying changes. System administrator only; returns a downloadable CSV report if errors exist.",
|
|
26
|
+
"operationType": "read",
|
|
27
|
+
"requiredScopes": [],
|
|
28
|
+
"providerPermissions": [],
|
|
29
|
+
"inputSchema": {
|
|
30
|
+
"type": "object",
|
|
31
|
+
"properties": {
|
|
32
|
+
"users": {
|
|
33
|
+
"type": "array",
|
|
34
|
+
"items": {
|
|
35
|
+
"type": "object",
|
|
36
|
+
"properties": {
|
|
37
|
+
"TempId": {
|
|
38
|
+
"type": "string",
|
|
39
|
+
"maxLength": 256,
|
|
40
|
+
"description": "Temporary alphanumeric ID for a new user; blank when editing. Must be unique within the file."
|
|
41
|
+
},
|
|
42
|
+
"UserUuid": {
|
|
43
|
+
"type": "string",
|
|
44
|
+
"description": "Existing user UUID when editing; blank for a new user."
|
|
45
|
+
},
|
|
46
|
+
"DepartmentId": {
|
|
47
|
+
"type": "string",
|
|
48
|
+
"description": "Department IDs separated by semicolons; use tempId:ID for a new department in the same import."
|
|
49
|
+
},
|
|
50
|
+
"UserId": {
|
|
51
|
+
"type": "string",
|
|
52
|
+
"maxLength": 20,
|
|
53
|
+
"description": "Immutable user login ID, up to 20 characters; alphanumeric or .-_&."
|
|
54
|
+
},
|
|
55
|
+
"UserName": {
|
|
56
|
+
"type": "string",
|
|
57
|
+
"maxLength": 60,
|
|
58
|
+
"description": "User display name, up to 60 characters."
|
|
59
|
+
},
|
|
60
|
+
"AlternativeName": {
|
|
61
|
+
"type": "string",
|
|
62
|
+
"maxLength": 256,
|
|
63
|
+
"description": "User name reading."
|
|
64
|
+
},
|
|
65
|
+
"Email": {
|
|
66
|
+
"type": "string",
|
|
67
|
+
"maxLength": 60,
|
|
68
|
+
"description": "Unique primary user email within the company."
|
|
69
|
+
},
|
|
70
|
+
"SubEmail": {
|
|
71
|
+
"type": "string",
|
|
72
|
+
"maxLength": 60,
|
|
73
|
+
"description": "Secondary user email."
|
|
74
|
+
},
|
|
75
|
+
"EffectiveDateFrom": {
|
|
76
|
+
"type": "string",
|
|
77
|
+
"description": "Usage start date for new users, today or later in RFC3339 format; blank when unchanged during editing."
|
|
78
|
+
},
|
|
79
|
+
"SamlNameId": {
|
|
80
|
+
"type": "string",
|
|
81
|
+
"description": "Unique SAML Name ID within the company."
|
|
82
|
+
},
|
|
83
|
+
"Culture": {
|
|
84
|
+
"type": "integer",
|
|
85
|
+
"minimum": 0,
|
|
86
|
+
"maximum": 2,
|
|
87
|
+
"description": "Display language: 0 Japanese, 1 English, 2 Simplified Chinese. Omission serializes as a blank CSV cell."
|
|
88
|
+
},
|
|
89
|
+
"MailFormat": {
|
|
90
|
+
"type": "integer",
|
|
91
|
+
"minimum": 0,
|
|
92
|
+
"maximum": 1,
|
|
93
|
+
"description": "Email format: 0 HTML, 1 text. Omission serializes as a blank CSV cell."
|
|
94
|
+
},
|
|
95
|
+
"UserType": {
|
|
96
|
+
"type": "integer",
|
|
97
|
+
"minimum": 0,
|
|
98
|
+
"maximum": 2,
|
|
99
|
+
"description": "Role: 0 regular, 1 system administrator, 2 departmental administrator. Omission serializes as a blank CSV cell."
|
|
100
|
+
},
|
|
101
|
+
"CanUpdateData": {
|
|
102
|
+
"type": "integer",
|
|
103
|
+
"minimum": 0,
|
|
104
|
+
"maximum": 1,
|
|
105
|
+
"description": "Permission to update all data: 1 granted, 0 denied. Omission serializes as a blank CSV cell."
|
|
106
|
+
},
|
|
107
|
+
"DataDownloadPrivilege": {
|
|
108
|
+
"type": "integer",
|
|
109
|
+
"minimum": 0,
|
|
110
|
+
"maximum": 3,
|
|
111
|
+
"description": "Download permission: 0 none, 1 own data, 2 all data, 3 assigned departments. Omission serializes as a blank CSV cell."
|
|
112
|
+
},
|
|
113
|
+
"EmailDeliveryPrivilege": {
|
|
114
|
+
"type": "integer",
|
|
115
|
+
"minimum": 0,
|
|
116
|
+
"maximum": 1,
|
|
117
|
+
"description": "Email delivery permission: 1 granted, 0 denied. Omission serializes as a blank CSV cell."
|
|
118
|
+
},
|
|
119
|
+
"DealPrivilege": {
|
|
120
|
+
"type": "integer",
|
|
121
|
+
"minimum": 0,
|
|
122
|
+
"maximum": 2,
|
|
123
|
+
"description": "Deal permission: 0 none, 1 regular, 2 administrator. Omission serializes as a blank CSV cell."
|
|
124
|
+
},
|
|
125
|
+
"ApiIntegrationPrivilege": {
|
|
126
|
+
"type": "integer",
|
|
127
|
+
"minimum": 0,
|
|
128
|
+
"maximum": 1,
|
|
129
|
+
"description": "API integration permission: 1 granted, 0 denied. Omission serializes as a blank CSV cell."
|
|
130
|
+
},
|
|
131
|
+
"UsageStatisticsPrivilege": {
|
|
132
|
+
"type": "integer",
|
|
133
|
+
"minimum": 0,
|
|
134
|
+
"maximum": 1,
|
|
135
|
+
"description": "Usage statistics permission: 1 granted, 0 denied. Omission serializes as a blank CSV cell."
|
|
136
|
+
},
|
|
137
|
+
"OrganizationTreeDownloadPrivilege": {
|
|
138
|
+
"type": "integer",
|
|
139
|
+
"minimum": 0,
|
|
140
|
+
"maximum": 1,
|
|
141
|
+
"description": "Organization tree download permission: 1 granted, 0 denied. Omission serializes as a blank CSV cell."
|
|
142
|
+
},
|
|
143
|
+
"DeleteFlag": {
|
|
144
|
+
"type": "integer",
|
|
145
|
+
"minimum": 0,
|
|
146
|
+
"maximum": 1,
|
|
147
|
+
"description": "Set to 1 to delete the user. Omission serializes as a blank CSV cell."
|
|
148
|
+
},
|
|
149
|
+
"SalesforceIntegrationPrivilege": {
|
|
150
|
+
"type": "string",
|
|
151
|
+
"description": "Retired field, ignored by Sansan; the CSV column is retained even when omitted."
|
|
152
|
+
}
|
|
153
|
+
},
|
|
154
|
+
"additionalProperties": false,
|
|
155
|
+
"description": "A user import row using official Sansan CSV columns. Submission requires DepartmentId, UserId, UserName and Email; new users also require TempId and EffectiveDateFrom, while existing users require UserUuid. Blank optional cells preserve unchanged values when editing."
|
|
156
|
+
},
|
|
157
|
+
"description": "Structured user rows; Connector builds the official CSV, preserving all columns. Mutually exclusive with usersFileUrl.",
|
|
158
|
+
"minItems": 1
|
|
159
|
+
},
|
|
160
|
+
"departments": {
|
|
161
|
+
"type": "array",
|
|
162
|
+
"items": {
|
|
163
|
+
"type": "object",
|
|
164
|
+
"properties": {
|
|
165
|
+
"TempId": {
|
|
166
|
+
"type": "string",
|
|
167
|
+
"maxLength": 256,
|
|
168
|
+
"description": "Temporary alphanumeric ID for a new department; blank when editing."
|
|
169
|
+
},
|
|
170
|
+
"DepartmentId": {
|
|
171
|
+
"type": "string",
|
|
172
|
+
"description": "Existing department ID when editing; blank for a new department."
|
|
173
|
+
},
|
|
174
|
+
"DepartmentName": {
|
|
175
|
+
"type": "string",
|
|
176
|
+
"maxLength": 30,
|
|
177
|
+
"description": "Department name."
|
|
178
|
+
},
|
|
179
|
+
"DepartmentNamePhonetic": {
|
|
180
|
+
"type": "string",
|
|
181
|
+
"maxLength": 256,
|
|
182
|
+
"description": "Department name reading using lowercase Latin letters, digits, and spaces."
|
|
183
|
+
},
|
|
184
|
+
"ParentDepartmentId": {
|
|
185
|
+
"type": "string",
|
|
186
|
+
"description": "Parent department ID or tempId:ID for a parent created in the same import; blank for no parent."
|
|
187
|
+
},
|
|
188
|
+
"Order": {
|
|
189
|
+
"type": "integer",
|
|
190
|
+
"description": "Department sort order."
|
|
191
|
+
},
|
|
192
|
+
"DeleteFlag": {
|
|
193
|
+
"type": "integer",
|
|
194
|
+
"minimum": 0,
|
|
195
|
+
"maximum": 1,
|
|
196
|
+
"description": "Set to 1 to delete the department; it must have no users or child departments."
|
|
197
|
+
}
|
|
198
|
+
},
|
|
199
|
+
"additionalProperties": false,
|
|
200
|
+
"description": "A department import row using official Sansan CSV columns. Submission requires DepartmentName and either TempId for creation or DepartmentId for editing; the other identifier must be blank or omitted."
|
|
201
|
+
},
|
|
202
|
+
"description": "Structured department rows. Mutually exclusive with departmentsFileUrl.",
|
|
203
|
+
"minItems": 1
|
|
204
|
+
},
|
|
205
|
+
"usersFileUrl": {
|
|
206
|
+
"type": "string",
|
|
207
|
+
"description": "Public URL of a UTF-8 user CSV with a header row; maximum 20 MiB per source file.",
|
|
208
|
+
"format": "uri"
|
|
209
|
+
},
|
|
210
|
+
"departmentsFileUrl": {
|
|
211
|
+
"type": "string",
|
|
212
|
+
"description": "Public URL of a UTF-8 department CSV with a header row; maximum 20 MiB per source file.",
|
|
213
|
+
"format": "uri"
|
|
214
|
+
},
|
|
215
|
+
"delimiter": {
|
|
216
|
+
"type": "string",
|
|
217
|
+
"enum": [
|
|
218
|
+
"comma",
|
|
219
|
+
"semicolon",
|
|
220
|
+
"tab",
|
|
221
|
+
"space"
|
|
222
|
+
],
|
|
223
|
+
"description": "CSV delimiter; defaults to comma."
|
|
224
|
+
}
|
|
225
|
+
},
|
|
226
|
+
"additionalProperties": false,
|
|
227
|
+
"description": "Users and/or departments to check or import. System administrator only.",
|
|
228
|
+
"anyOf": [
|
|
229
|
+
{
|
|
230
|
+
"required": [
|
|
231
|
+
"users"
|
|
232
|
+
]
|
|
233
|
+
},
|
|
234
|
+
{
|
|
235
|
+
"required": [
|
|
236
|
+
"departments"
|
|
237
|
+
]
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
"required": [
|
|
241
|
+
"usersFileUrl"
|
|
242
|
+
]
|
|
243
|
+
},
|
|
244
|
+
{
|
|
245
|
+
"required": [
|
|
246
|
+
"departmentsFileUrl"
|
|
247
|
+
]
|
|
248
|
+
}
|
|
249
|
+
],
|
|
250
|
+
"allOf": [
|
|
251
|
+
{
|
|
252
|
+
"not": {
|
|
253
|
+
"required": [
|
|
254
|
+
"users",
|
|
255
|
+
"usersFileUrl"
|
|
256
|
+
]
|
|
257
|
+
}
|
|
258
|
+
},
|
|
259
|
+
{
|
|
260
|
+
"not": {
|
|
261
|
+
"required": [
|
|
262
|
+
"departments",
|
|
263
|
+
"departmentsFileUrl"
|
|
264
|
+
]
|
|
265
|
+
}
|
|
266
|
+
}
|
|
267
|
+
]
|
|
268
|
+
},
|
|
269
|
+
"outputSchema": {
|
|
270
|
+
"type": "object",
|
|
271
|
+
"properties": {
|
|
272
|
+
"valid": {
|
|
273
|
+
"type": "boolean",
|
|
274
|
+
"description": "Whether Sansan returned an empty validation response, indicating valid data."
|
|
275
|
+
},
|
|
276
|
+
"report": {
|
|
277
|
+
"anyOf": [
|
|
278
|
+
{
|
|
279
|
+
"type": "object",
|
|
280
|
+
"properties": {
|
|
281
|
+
"fileId": {
|
|
282
|
+
"type": "string",
|
|
283
|
+
"description": "The stored transit file identifier."
|
|
284
|
+
},
|
|
285
|
+
"downloadUrl": {
|
|
286
|
+
"type": "string",
|
|
287
|
+
"description": "The transit file download URL."
|
|
288
|
+
},
|
|
289
|
+
"name": {
|
|
290
|
+
"type": "string",
|
|
291
|
+
"description": "The file name."
|
|
292
|
+
},
|
|
293
|
+
"mimeType": {
|
|
294
|
+
"type": "string",
|
|
295
|
+
"description": "The file media type."
|
|
296
|
+
},
|
|
297
|
+
"sizeBytes": {
|
|
298
|
+
"type": "integer",
|
|
299
|
+
"description": "The file size in bytes."
|
|
300
|
+
}
|
|
301
|
+
},
|
|
302
|
+
"additionalProperties": false,
|
|
303
|
+
"required": [
|
|
304
|
+
"fileId",
|
|
305
|
+
"downloadUrl",
|
|
306
|
+
"name",
|
|
307
|
+
"mimeType",
|
|
308
|
+
"sizeBytes"
|
|
309
|
+
],
|
|
310
|
+
"description": "A downloaded file in local transit storage."
|
|
311
|
+
},
|
|
312
|
+
{
|
|
313
|
+
"type": "null"
|
|
314
|
+
}
|
|
315
|
+
],
|
|
316
|
+
"description": "A downloaded file in local transit storage."
|
|
317
|
+
}
|
|
318
|
+
},
|
|
319
|
+
"additionalProperties": false,
|
|
320
|
+
"required": [
|
|
321
|
+
"valid",
|
|
322
|
+
"report"
|
|
323
|
+
],
|
|
324
|
+
"description": "Organization import validation result."
|
|
325
|
+
}
|
|
326
|
+
},
|
|
327
|
+
{
|
|
328
|
+
"id": "sansan.create_access_control_pattern",
|
|
329
|
+
"service": "sansan",
|
|
330
|
+
"name": "create_access_control_pattern",
|
|
331
|
+
"description": "Create an access control pattern with department access rules. System administrator only.",
|
|
332
|
+
"operationType": "write",
|
|
333
|
+
"requiredScopes": [],
|
|
334
|
+
"providerPermissions": [],
|
|
335
|
+
"inputSchema": {
|
|
336
|
+
"type": "object",
|
|
337
|
+
"properties": {
|
|
338
|
+
"aclPatternName": {
|
|
339
|
+
"type": "string",
|
|
340
|
+
"minLength": 1,
|
|
341
|
+
"description": "Access control pattern name."
|
|
342
|
+
},
|
|
343
|
+
"description": {
|
|
344
|
+
"type": "string",
|
|
345
|
+
"description": "Access control pattern description."
|
|
346
|
+
},
|
|
347
|
+
"details": {
|
|
348
|
+
"type": "array",
|
|
349
|
+
"items": {
|
|
350
|
+
"type": "object",
|
|
351
|
+
"properties": {
|
|
352
|
+
"objectDepartmentId": {
|
|
353
|
+
"type": "string",
|
|
354
|
+
"minLength": 1,
|
|
355
|
+
"description": "The department whose data this rule covers."
|
|
356
|
+
},
|
|
357
|
+
"accessibleFieldsSettingsName": {
|
|
358
|
+
"type": "string",
|
|
359
|
+
"minLength": 1,
|
|
360
|
+
"description": "The upstream accessible-fields setting name, such as ALL. Use values configured in Sansan; no complete enum is published."
|
|
361
|
+
}
|
|
362
|
+
},
|
|
363
|
+
"additionalProperties": true,
|
|
364
|
+
"required": [
|
|
365
|
+
"objectDepartmentId",
|
|
366
|
+
"accessibleFieldsSettingsName"
|
|
367
|
+
],
|
|
368
|
+
"description": "Access rule for a target department; additional provider-defined fields are accepted."
|
|
369
|
+
},
|
|
370
|
+
"description": "Department access rules."
|
|
371
|
+
}
|
|
372
|
+
},
|
|
373
|
+
"additionalProperties": false,
|
|
374
|
+
"required": [
|
|
375
|
+
"aclPatternName",
|
|
376
|
+
"details"
|
|
377
|
+
],
|
|
378
|
+
"description": "New access control pattern."
|
|
379
|
+
},
|
|
380
|
+
"outputSchema": {
|
|
381
|
+
"type": "object",
|
|
382
|
+
"properties": {
|
|
383
|
+
"id": {
|
|
384
|
+
"type": "string",
|
|
385
|
+
"minLength": 1,
|
|
386
|
+
"description": "The access control pattern ID."
|
|
387
|
+
}
|
|
388
|
+
},
|
|
389
|
+
"additionalProperties": true,
|
|
390
|
+
"required": [
|
|
391
|
+
"id"
|
|
392
|
+
],
|
|
393
|
+
"description": "Created access control pattern."
|
|
394
|
+
}
|
|
395
|
+
},
|
|
396
|
+
{
|
|
397
|
+
"id": "sansan.create_business_card",
|
|
398
|
+
"service": "sansan",
|
|
399
|
+
"name": "create_business_card",
|
|
400
|
+
"description": "Create a Sansan business card, optionally for another user through the administrator import API.",
|
|
401
|
+
"operationType": "write",
|
|
402
|
+
"requiredScopes": [],
|
|
403
|
+
"providerPermissions": [],
|
|
404
|
+
"inputSchema": {
|
|
405
|
+
"type": "object",
|
|
406
|
+
"properties": {
|
|
407
|
+
"ownerUserId": {
|
|
408
|
+
"type": "string",
|
|
409
|
+
"minLength": 1,
|
|
410
|
+
"description": "Optional record owner user ID. When provided, use the system-administrator import API; the user must belong to the same company and contract. Omit to create for the connected user."
|
|
411
|
+
},
|
|
412
|
+
"lastName": {
|
|
413
|
+
"anyOf": [
|
|
414
|
+
{
|
|
415
|
+
"type": "string",
|
|
416
|
+
"maxLength": 250,
|
|
417
|
+
"description": "Last name."
|
|
418
|
+
},
|
|
419
|
+
{
|
|
420
|
+
"type": "null"
|
|
421
|
+
}
|
|
422
|
+
],
|
|
423
|
+
"description": "Last name."
|
|
424
|
+
},
|
|
425
|
+
"firstName": {
|
|
426
|
+
"anyOf": [
|
|
427
|
+
{
|
|
428
|
+
"type": "string",
|
|
429
|
+
"maxLength": 250,
|
|
430
|
+
"description": "First name."
|
|
431
|
+
},
|
|
432
|
+
{
|
|
433
|
+
"type": "null"
|
|
434
|
+
}
|
|
435
|
+
],
|
|
436
|
+
"description": "First name."
|
|
437
|
+
},
|
|
438
|
+
"lastNameReading": {
|
|
439
|
+
"anyOf": [
|
|
440
|
+
{
|
|
441
|
+
"type": "string",
|
|
442
|
+
"maxLength": 250,
|
|
443
|
+
"description": "Last name reading in kana; do not use kanji, hiragana, or full-width alphanumeric characters."
|
|
444
|
+
},
|
|
445
|
+
{
|
|
446
|
+
"type": "null"
|
|
447
|
+
}
|
|
448
|
+
],
|
|
449
|
+
"description": "Last name reading in kana; do not use kanji, hiragana, or full-width alphanumeric characters."
|
|
450
|
+
},
|
|
451
|
+
"firstNameReading": {
|
|
452
|
+
"anyOf": [
|
|
453
|
+
{
|
|
454
|
+
"type": "string",
|
|
455
|
+
"maxLength": 250,
|
|
456
|
+
"description": "First name reading in kana; do not use kanji, hiragana, or full-width alphanumeric characters."
|
|
457
|
+
},
|
|
458
|
+
{
|
|
459
|
+
"type": "null"
|
|
460
|
+
}
|
|
461
|
+
],
|
|
462
|
+
"description": "First name reading in kana; do not use kanji, hiragana, or full-width alphanumeric characters."
|
|
463
|
+
},
|
|
464
|
+
"departmentName": {
|
|
465
|
+
"anyOf": [
|
|
466
|
+
{
|
|
467
|
+
"type": "string",
|
|
468
|
+
"maxLength": 250,
|
|
469
|
+
"description": "Department name."
|
|
470
|
+
},
|
|
471
|
+
{
|
|
472
|
+
"type": "null"
|
|
473
|
+
}
|
|
474
|
+
],
|
|
475
|
+
"description": "Department name."
|
|
476
|
+
},
|
|
477
|
+
"title": {
|
|
478
|
+
"anyOf": [
|
|
479
|
+
{
|
|
480
|
+
"type": "string",
|
|
481
|
+
"maxLength": 250,
|
|
482
|
+
"description": "Job title."
|
|
483
|
+
},
|
|
484
|
+
{
|
|
485
|
+
"type": "null"
|
|
486
|
+
}
|
|
487
|
+
],
|
|
488
|
+
"description": "Job title."
|
|
489
|
+
},
|
|
490
|
+
"companyName": {
|
|
491
|
+
"anyOf": [
|
|
492
|
+
{
|
|
493
|
+
"type": "string",
|
|
494
|
+
"maxLength": 250,
|
|
495
|
+
"description": "Company name."
|
|
496
|
+
},
|
|
497
|
+
{
|
|
498
|
+
"type": "null"
|
|
499
|
+
}
|
|
500
|
+
],
|
|
501
|
+
"description": "Company name."
|
|
502
|
+
},
|
|
503
|
+
"prefecture": {
|
|
504
|
+
"anyOf": [
|
|
505
|
+
{
|
|
506
|
+
"type": "string",
|
|
507
|
+
"maxLength": 250,
|
|
508
|
+
"description": "Prefecture or state."
|
|
509
|
+
},
|
|
510
|
+
{
|
|
511
|
+
"type": "null"
|
|
512
|
+
}
|
|
513
|
+
],
|
|
514
|
+
"description": "Prefecture or state."
|
|
515
|
+
},
|
|
516
|
+
"city": {
|
|
517
|
+
"anyOf": [
|
|
518
|
+
{
|
|
519
|
+
"type": "string",
|
|
520
|
+
"maxLength": 250,
|
|
521
|
+
"description": "City."
|
|
522
|
+
},
|
|
523
|
+
{
|
|
524
|
+
"type": "null"
|
|
525
|
+
}
|
|
526
|
+
],
|
|
527
|
+
"description": "City."
|
|
528
|
+
},
|
|
529
|
+
"street": {
|
|
530
|
+
"anyOf": [
|
|
531
|
+
{
|
|
532
|
+
"type": "string",
|
|
533
|
+
"maxLength": 250,
|
|
534
|
+
"description": "Street address."
|
|
535
|
+
},
|
|
536
|
+
{
|
|
537
|
+
"type": "null"
|
|
538
|
+
}
|
|
539
|
+
],
|
|
540
|
+
"description": "Street address."
|
|
541
|
+
},
|
|
542
|
+
"building": {
|
|
543
|
+
"anyOf": [
|
|
544
|
+
{
|
|
545
|
+
"type": "string",
|
|
546
|
+
"maxLength": 250,
|
|
547
|
+
"description": "Building."
|
|
548
|
+
},
|
|
549
|
+
{
|
|
550
|
+
"type": "null"
|
|
551
|
+
}
|
|
552
|
+
],
|
|
553
|
+
"description": "Building."
|
|
554
|
+
},
|
|
555
|
+
"email": {
|
|
556
|
+
"anyOf": [
|
|
557
|
+
{
|
|
558
|
+
"type": "string",
|
|
559
|
+
"maxLength": 250,
|
|
560
|
+
"description": "Email address."
|
|
561
|
+
},
|
|
562
|
+
{
|
|
563
|
+
"type": "null"
|
|
564
|
+
}
|
|
565
|
+
],
|
|
566
|
+
"description": "Email address."
|
|
567
|
+
},
|
|
568
|
+
"mobile": {
|
|
569
|
+
"anyOf": [
|
|
570
|
+
{
|
|
571
|
+
"type": "string",
|
|
572
|
+
"maxLength": 30,
|
|
573
|
+
"description": "Mobile number using digits, plus, and hyphen."
|
|
574
|
+
},
|
|
575
|
+
{
|
|
576
|
+
"type": "null"
|
|
577
|
+
}
|
|
578
|
+
],
|
|
579
|
+
"description": "Mobile number using digits, plus, and hyphen."
|
|
580
|
+
},
|
|
581
|
+
"tel": {
|
|
582
|
+
"anyOf": [
|
|
583
|
+
{
|
|
584
|
+
"type": "string",
|
|
585
|
+
"maxLength": 30,
|
|
586
|
+
"description": "Telephone number using digits, plus, and hyphen."
|
|
587
|
+
},
|
|
588
|
+
{
|
|
589
|
+
"type": "null"
|
|
590
|
+
}
|
|
591
|
+
],
|
|
592
|
+
"description": "Telephone number using digits, plus, and hyphen."
|
|
593
|
+
},
|
|
594
|
+
"secondTel": {
|
|
595
|
+
"anyOf": [
|
|
596
|
+
{
|
|
597
|
+
"type": "string",
|
|
598
|
+
"maxLength": 30,
|
|
599
|
+
"description": "Second telephone number using digits, plus, and hyphen."
|
|
600
|
+
},
|
|
601
|
+
{
|
|
602
|
+
"type": "null"
|
|
603
|
+
}
|
|
604
|
+
],
|
|
605
|
+
"description": "Second telephone number using digits, plus, and hyphen."
|
|
606
|
+
},
|
|
607
|
+
"fax": {
|
|
608
|
+
"anyOf": [
|
|
609
|
+
{
|
|
610
|
+
"type": "string",
|
|
611
|
+
"maxLength": 30,
|
|
612
|
+
"description": "Fax number using digits, plus, and hyphen."
|
|
613
|
+
},
|
|
614
|
+
{
|
|
615
|
+
"type": "null"
|
|
616
|
+
}
|
|
617
|
+
],
|
|
618
|
+
"description": "Fax number using digits, plus, and hyphen."
|
|
619
|
+
},
|
|
620
|
+
"url": {
|
|
621
|
+
"anyOf": [
|
|
622
|
+
{
|
|
623
|
+
"type": "string",
|
|
624
|
+
"maxLength": 250,
|
|
625
|
+
"description": "Website URL."
|
|
626
|
+
},
|
|
627
|
+
{
|
|
628
|
+
"type": "null"
|
|
629
|
+
}
|
|
630
|
+
],
|
|
631
|
+
"description": "Website URL."
|
|
632
|
+
},
|
|
633
|
+
"memo": {
|
|
634
|
+
"anyOf": [
|
|
635
|
+
{
|
|
636
|
+
"type": "string",
|
|
637
|
+
"maxLength": 2000,
|
|
638
|
+
"description": "Memo."
|
|
639
|
+
},
|
|
640
|
+
{
|
|
641
|
+
"type": "null"
|
|
642
|
+
}
|
|
643
|
+
],
|
|
644
|
+
"description": "Memo."
|
|
645
|
+
},
|
|
646
|
+
"exchangeDate": {
|
|
647
|
+
"anyOf": [
|
|
648
|
+
{
|
|
649
|
+
"type": "string",
|
|
650
|
+
"description": "Business card exchange date, YYYY-MM-DD.",
|
|
651
|
+
"format": "date"
|
|
652
|
+
},
|
|
653
|
+
{
|
|
654
|
+
"type": "null"
|
|
655
|
+
}
|
|
656
|
+
],
|
|
657
|
+
"description": "Business card exchange date, YYYY-MM-DD."
|
|
658
|
+
},
|
|
659
|
+
"countryCode": {
|
|
660
|
+
"anyOf": [
|
|
661
|
+
{
|
|
662
|
+
"type": "string",
|
|
663
|
+
"description": "ISO 3166-1 alpha-2 country code or AUTO to infer the country from contact information."
|
|
664
|
+
},
|
|
665
|
+
{
|
|
666
|
+
"type": "null"
|
|
667
|
+
}
|
|
668
|
+
],
|
|
669
|
+
"description": "ISO 3166-1 alpha-2 country code or AUTO to infer the country from contact information."
|
|
670
|
+
},
|
|
671
|
+
"postalCode": {
|
|
672
|
+
"anyOf": [
|
|
673
|
+
{
|
|
674
|
+
"type": "string",
|
|
675
|
+
"description": "Postal code: alphanumeric, hyphens and spaces; at most ten characters excluding hyphens and spaces."
|
|
676
|
+
},
|
|
677
|
+
{
|
|
678
|
+
"type": "null"
|
|
679
|
+
}
|
|
680
|
+
],
|
|
681
|
+
"description": "Postal code: alphanumeric, hyphens and spaces; at most ten characters excluding hyphens and spaces."
|
|
682
|
+
},
|
|
683
|
+
"tagIds": {
|
|
684
|
+
"type": "array",
|
|
685
|
+
"items": {
|
|
686
|
+
"type": "string",
|
|
687
|
+
"minLength": 1,
|
|
688
|
+
"description": "An existing tag ID."
|
|
689
|
+
},
|
|
690
|
+
"description": "Existing tag IDs to attach, at most fifteen.",
|
|
691
|
+
"maxItems": 15
|
|
692
|
+
},
|
|
693
|
+
"sharingPermissions": {
|
|
694
|
+
"anyOf": [
|
|
695
|
+
{
|
|
696
|
+
"type": "object",
|
|
697
|
+
"properties": {
|
|
698
|
+
"companyInformation": {
|
|
699
|
+
"anyOf": [
|
|
700
|
+
{
|
|
701
|
+
"type": "boolean",
|
|
702
|
+
"description": "Whether to share company information."
|
|
703
|
+
},
|
|
704
|
+
{
|
|
705
|
+
"type": "null"
|
|
706
|
+
}
|
|
707
|
+
],
|
|
708
|
+
"description": "Whether to share company information."
|
|
709
|
+
},
|
|
710
|
+
"name": {
|
|
711
|
+
"anyOf": [
|
|
712
|
+
{
|
|
713
|
+
"type": "boolean",
|
|
714
|
+
"description": "Whether to share the name."
|
|
715
|
+
},
|
|
716
|
+
{
|
|
717
|
+
"type": "null"
|
|
718
|
+
}
|
|
719
|
+
],
|
|
720
|
+
"description": "Whether to share the name."
|
|
721
|
+
},
|
|
722
|
+
"exchangeDate": {
|
|
723
|
+
"anyOf": [
|
|
724
|
+
{
|
|
725
|
+
"type": "boolean",
|
|
726
|
+
"description": "Whether to share the exchange date."
|
|
727
|
+
},
|
|
728
|
+
{
|
|
729
|
+
"type": "null"
|
|
730
|
+
}
|
|
731
|
+
],
|
|
732
|
+
"description": "Whether to share the exchange date."
|
|
733
|
+
},
|
|
734
|
+
"contact": {
|
|
735
|
+
"anyOf": [
|
|
736
|
+
{
|
|
737
|
+
"type": "boolean",
|
|
738
|
+
"description": "Whether to share contact details."
|
|
739
|
+
},
|
|
740
|
+
{
|
|
741
|
+
"type": "null"
|
|
742
|
+
}
|
|
743
|
+
],
|
|
744
|
+
"description": "Whether to share contact details."
|
|
745
|
+
},
|
|
746
|
+
"mobile": {
|
|
747
|
+
"anyOf": [
|
|
748
|
+
{
|
|
749
|
+
"type": "boolean",
|
|
750
|
+
"description": "Whether to share the mobile number."
|
|
751
|
+
},
|
|
752
|
+
{
|
|
753
|
+
"type": "null"
|
|
754
|
+
}
|
|
755
|
+
],
|
|
756
|
+
"description": "Whether to share the mobile number."
|
|
757
|
+
},
|
|
758
|
+
"email": {
|
|
759
|
+
"anyOf": [
|
|
760
|
+
{
|
|
761
|
+
"type": "boolean",
|
|
762
|
+
"description": "Whether to share the email address."
|
|
763
|
+
},
|
|
764
|
+
{
|
|
765
|
+
"type": "null"
|
|
766
|
+
}
|
|
767
|
+
],
|
|
768
|
+
"description": "Whether to share the email address."
|
|
769
|
+
},
|
|
770
|
+
"memo": {
|
|
771
|
+
"anyOf": [
|
|
772
|
+
{
|
|
773
|
+
"type": "boolean",
|
|
774
|
+
"description": "Whether to share the memo."
|
|
775
|
+
},
|
|
776
|
+
{
|
|
777
|
+
"type": "null"
|
|
778
|
+
}
|
|
779
|
+
],
|
|
780
|
+
"description": "Whether to share the memo."
|
|
781
|
+
},
|
|
782
|
+
"others": {
|
|
783
|
+
"anyOf": [
|
|
784
|
+
{
|
|
785
|
+
"type": "boolean",
|
|
786
|
+
"description": "Whether to share other information."
|
|
787
|
+
},
|
|
788
|
+
{
|
|
789
|
+
"type": "null"
|
|
790
|
+
}
|
|
791
|
+
],
|
|
792
|
+
"description": "Whether to share other information."
|
|
793
|
+
}
|
|
794
|
+
},
|
|
795
|
+
"additionalProperties": false,
|
|
796
|
+
"description": "Per-field visibility settings."
|
|
797
|
+
},
|
|
798
|
+
{
|
|
799
|
+
"type": "null"
|
|
800
|
+
}
|
|
801
|
+
],
|
|
802
|
+
"description": "Per-field visibility settings."
|
|
803
|
+
}
|
|
804
|
+
},
|
|
805
|
+
"additionalProperties": false,
|
|
806
|
+
"description": "Business card fields. At least one non-empty companyName, firstName, or lastName is required.",
|
|
807
|
+
"anyOf": [
|
|
808
|
+
{
|
|
809
|
+
"required": [
|
|
810
|
+
"companyName"
|
|
811
|
+
],
|
|
812
|
+
"properties": {
|
|
813
|
+
"companyName": {
|
|
814
|
+
"type": "string",
|
|
815
|
+
"minLength": 1
|
|
816
|
+
}
|
|
817
|
+
}
|
|
818
|
+
},
|
|
819
|
+
{
|
|
820
|
+
"required": [
|
|
821
|
+
"firstName"
|
|
822
|
+
],
|
|
823
|
+
"properties": {
|
|
824
|
+
"firstName": {
|
|
825
|
+
"type": "string",
|
|
826
|
+
"minLength": 1
|
|
827
|
+
}
|
|
828
|
+
}
|
|
829
|
+
},
|
|
830
|
+
{
|
|
831
|
+
"required": [
|
|
832
|
+
"lastName"
|
|
833
|
+
],
|
|
834
|
+
"properties": {
|
|
835
|
+
"lastName": {
|
|
836
|
+
"type": "string",
|
|
837
|
+
"minLength": 1
|
|
838
|
+
}
|
|
839
|
+
}
|
|
840
|
+
}
|
|
841
|
+
]
|
|
842
|
+
},
|
|
843
|
+
"outputSchema": {
|
|
844
|
+
"type": "object",
|
|
845
|
+
"properties": {
|
|
846
|
+
"id": {
|
|
847
|
+
"anyOf": [
|
|
848
|
+
{
|
|
849
|
+
"type": "string",
|
|
850
|
+
"description": "The business card ID."
|
|
851
|
+
},
|
|
852
|
+
{
|
|
853
|
+
"type": "null"
|
|
854
|
+
}
|
|
855
|
+
],
|
|
856
|
+
"description": "The business card ID."
|
|
857
|
+
},
|
|
858
|
+
"companyId": {
|
|
859
|
+
"anyOf": [
|
|
860
|
+
{
|
|
861
|
+
"type": "string",
|
|
862
|
+
"description": "The company ID."
|
|
863
|
+
},
|
|
864
|
+
{
|
|
865
|
+
"type": "null"
|
|
866
|
+
}
|
|
867
|
+
],
|
|
868
|
+
"description": "The company ID."
|
|
869
|
+
},
|
|
870
|
+
"personId": {
|
|
871
|
+
"anyOf": [
|
|
872
|
+
{
|
|
873
|
+
"type": "string",
|
|
874
|
+
"description": "The person ID."
|
|
875
|
+
},
|
|
876
|
+
{
|
|
877
|
+
"type": "null"
|
|
878
|
+
}
|
|
879
|
+
],
|
|
880
|
+
"description": "The person ID."
|
|
881
|
+
},
|
|
882
|
+
"firstName": {
|
|
883
|
+
"anyOf": [
|
|
884
|
+
{
|
|
885
|
+
"type": "string",
|
|
886
|
+
"description": "The first name."
|
|
887
|
+
},
|
|
888
|
+
{
|
|
889
|
+
"type": "null"
|
|
890
|
+
}
|
|
891
|
+
],
|
|
892
|
+
"description": "The first name."
|
|
893
|
+
},
|
|
894
|
+
"lastName": {
|
|
895
|
+
"anyOf": [
|
|
896
|
+
{
|
|
897
|
+
"type": "string",
|
|
898
|
+
"description": "The last name."
|
|
899
|
+
},
|
|
900
|
+
{
|
|
901
|
+
"type": "null"
|
|
902
|
+
}
|
|
903
|
+
],
|
|
904
|
+
"description": "The last name."
|
|
905
|
+
},
|
|
906
|
+
"companyName": {
|
|
907
|
+
"anyOf": [
|
|
908
|
+
{
|
|
909
|
+
"type": "string",
|
|
910
|
+
"description": "The company name."
|
|
911
|
+
},
|
|
912
|
+
{
|
|
913
|
+
"type": "null"
|
|
914
|
+
}
|
|
915
|
+
],
|
|
916
|
+
"description": "The company name."
|
|
917
|
+
},
|
|
918
|
+
"departmentName": {
|
|
919
|
+
"anyOf": [
|
|
920
|
+
{
|
|
921
|
+
"type": "string",
|
|
922
|
+
"description": "The department name."
|
|
923
|
+
},
|
|
924
|
+
{
|
|
925
|
+
"type": "null"
|
|
926
|
+
}
|
|
927
|
+
],
|
|
928
|
+
"description": "The department name."
|
|
929
|
+
},
|
|
930
|
+
"title": {
|
|
931
|
+
"anyOf": [
|
|
932
|
+
{
|
|
933
|
+
"type": "string",
|
|
934
|
+
"description": "The job title."
|
|
935
|
+
},
|
|
936
|
+
{
|
|
937
|
+
"type": "null"
|
|
938
|
+
}
|
|
939
|
+
],
|
|
940
|
+
"description": "The job title."
|
|
941
|
+
},
|
|
942
|
+
"email": {
|
|
943
|
+
"anyOf": [
|
|
944
|
+
{
|
|
945
|
+
"type": "string",
|
|
946
|
+
"description": "The email address."
|
|
947
|
+
},
|
|
948
|
+
{
|
|
949
|
+
"type": "null"
|
|
950
|
+
}
|
|
951
|
+
],
|
|
952
|
+
"description": "The email address."
|
|
953
|
+
},
|
|
954
|
+
"tel": {
|
|
955
|
+
"anyOf": [
|
|
956
|
+
{
|
|
957
|
+
"type": "string",
|
|
958
|
+
"description": "The telephone number."
|
|
959
|
+
},
|
|
960
|
+
{
|
|
961
|
+
"type": "null"
|
|
962
|
+
}
|
|
963
|
+
],
|
|
964
|
+
"description": "The telephone number."
|
|
965
|
+
},
|
|
966
|
+
"mobile": {
|
|
967
|
+
"anyOf": [
|
|
968
|
+
{
|
|
969
|
+
"type": "string",
|
|
970
|
+
"description": "The mobile phone number."
|
|
971
|
+
},
|
|
972
|
+
{
|
|
973
|
+
"type": "null"
|
|
974
|
+
}
|
|
975
|
+
],
|
|
976
|
+
"description": "The mobile phone number."
|
|
977
|
+
},
|
|
978
|
+
"exchangeDate": {
|
|
979
|
+
"anyOf": [
|
|
980
|
+
{
|
|
981
|
+
"type": "string",
|
|
982
|
+
"description": "The business card exchange date."
|
|
983
|
+
},
|
|
984
|
+
{
|
|
985
|
+
"type": "null"
|
|
986
|
+
}
|
|
987
|
+
],
|
|
988
|
+
"description": "The business card exchange date."
|
|
989
|
+
},
|
|
990
|
+
"registeredTime": {
|
|
991
|
+
"anyOf": [
|
|
992
|
+
{
|
|
993
|
+
"type": "string",
|
|
994
|
+
"description": "The registration timestamp."
|
|
995
|
+
},
|
|
996
|
+
{
|
|
997
|
+
"type": "null"
|
|
998
|
+
}
|
|
999
|
+
],
|
|
1000
|
+
"description": "The registration timestamp."
|
|
1001
|
+
},
|
|
1002
|
+
"updatedTime": {
|
|
1003
|
+
"anyOf": [
|
|
1004
|
+
{
|
|
1005
|
+
"type": "string",
|
|
1006
|
+
"description": "The last update timestamp."
|
|
1007
|
+
},
|
|
1008
|
+
{
|
|
1009
|
+
"type": "null"
|
|
1010
|
+
}
|
|
1011
|
+
],
|
|
1012
|
+
"description": "The last update timestamp."
|
|
1013
|
+
},
|
|
1014
|
+
"entryStatus": {
|
|
1015
|
+
"anyOf": [
|
|
1016
|
+
{
|
|
1017
|
+
"type": "string",
|
|
1018
|
+
"description": "The digitization status."
|
|
1019
|
+
},
|
|
1020
|
+
{
|
|
1021
|
+
"type": "null"
|
|
1022
|
+
}
|
|
1023
|
+
],
|
|
1024
|
+
"description": "The digitization status."
|
|
1025
|
+
},
|
|
1026
|
+
"owner": {
|
|
1027
|
+
"type": "object",
|
|
1028
|
+
"properties": {
|
|
1029
|
+
"id": {
|
|
1030
|
+
"type": "string",
|
|
1031
|
+
"description": "The owner user ID."
|
|
1032
|
+
},
|
|
1033
|
+
"name": {
|
|
1034
|
+
"type": "string",
|
|
1035
|
+
"description": "The owner name."
|
|
1036
|
+
},
|
|
1037
|
+
"email": {
|
|
1038
|
+
"type": "string",
|
|
1039
|
+
"description": "The owner email address."
|
|
1040
|
+
}
|
|
1041
|
+
},
|
|
1042
|
+
"additionalProperties": true,
|
|
1043
|
+
"description": "The business card or tag owner."
|
|
1044
|
+
},
|
|
1045
|
+
"tags": {
|
|
1046
|
+
"type": "array",
|
|
1047
|
+
"items": {
|
|
1048
|
+
"type": "object",
|
|
1049
|
+
"properties": {
|
|
1050
|
+
"id": {
|
|
1051
|
+
"type": "string",
|
|
1052
|
+
"description": "The tag ID."
|
|
1053
|
+
},
|
|
1054
|
+
"name": {
|
|
1055
|
+
"type": "string",
|
|
1056
|
+
"description": "The tag name."
|
|
1057
|
+
},
|
|
1058
|
+
"type": {
|
|
1059
|
+
"type": "string",
|
|
1060
|
+
"description": "The tag visibility: private, public, or shared."
|
|
1061
|
+
},
|
|
1062
|
+
"owner": {
|
|
1063
|
+
"type": "object",
|
|
1064
|
+
"properties": {
|
|
1065
|
+
"id": {
|
|
1066
|
+
"type": "string",
|
|
1067
|
+
"description": "The owner user ID."
|
|
1068
|
+
},
|
|
1069
|
+
"name": {
|
|
1070
|
+
"type": "string",
|
|
1071
|
+
"description": "The owner name."
|
|
1072
|
+
},
|
|
1073
|
+
"email": {
|
|
1074
|
+
"type": "string",
|
|
1075
|
+
"description": "The owner email address."
|
|
1076
|
+
}
|
|
1077
|
+
},
|
|
1078
|
+
"additionalProperties": true,
|
|
1079
|
+
"description": "The business card or tag owner."
|
|
1080
|
+
}
|
|
1081
|
+
},
|
|
1082
|
+
"additionalProperties": true,
|
|
1083
|
+
"description": "A Sansan tag, with additional upstream fields preserved."
|
|
1084
|
+
},
|
|
1085
|
+
"description": "Tags attached to the business card when requested."
|
|
1086
|
+
}
|
|
1087
|
+
},
|
|
1088
|
+
"additionalProperties": true,
|
|
1089
|
+
"description": "A business card with contact details; additional Sansan fields are preserved."
|
|
1090
|
+
}
|
|
1091
|
+
},
|
|
1092
|
+
{
|
|
1093
|
+
"id": "sansan.create_contact_report",
|
|
1094
|
+
"service": "sansan",
|
|
1095
|
+
"name": "create_contact_report",
|
|
1096
|
+
"description": "Create a Sansan contact report. External attendee details also create new business cards; optionally import for another owner as an administrator.",
|
|
1097
|
+
"operationType": "write",
|
|
1098
|
+
"requiredScopes": [],
|
|
1099
|
+
"providerPermissions": [],
|
|
1100
|
+
"inputSchema": {
|
|
1101
|
+
"type": "object",
|
|
1102
|
+
"properties": {
|
|
1103
|
+
"ownerUserId": {
|
|
1104
|
+
"type": "string",
|
|
1105
|
+
"minLength": 1,
|
|
1106
|
+
"description": "Optional record owner user ID. When provided, use the system-administrator import API; the user must belong to the same company and contract. Omit to create for the connected user."
|
|
1107
|
+
},
|
|
1108
|
+
"startTime": {
|
|
1109
|
+
"type": "string",
|
|
1110
|
+
"description": "Start timestamp with timezone; seconds must be 00.",
|
|
1111
|
+
"format": "date-time"
|
|
1112
|
+
},
|
|
1113
|
+
"endTime": {
|
|
1114
|
+
"type": "string",
|
|
1115
|
+
"description": "End timestamp with timezone; seconds must be 00.",
|
|
1116
|
+
"format": "date-time"
|
|
1117
|
+
},
|
|
1118
|
+
"externalAttendees": {
|
|
1119
|
+
"type": "array",
|
|
1120
|
+
"items": {
|
|
1121
|
+
"type": "object",
|
|
1122
|
+
"properties": {
|
|
1123
|
+
"companyName": {
|
|
1124
|
+
"type": "string",
|
|
1125
|
+
"maxLength": 250,
|
|
1126
|
+
"description": "Company name."
|
|
1127
|
+
},
|
|
1128
|
+
"lastName": {
|
|
1129
|
+
"type": "string",
|
|
1130
|
+
"maxLength": 250,
|
|
1131
|
+
"description": "Last name."
|
|
1132
|
+
},
|
|
1133
|
+
"firstName": {
|
|
1134
|
+
"type": "string",
|
|
1135
|
+
"maxLength": 250,
|
|
1136
|
+
"description": "First name."
|
|
1137
|
+
},
|
|
1138
|
+
"email": {
|
|
1139
|
+
"type": "string",
|
|
1140
|
+
"maxLength": 250,
|
|
1141
|
+
"description": "Email address."
|
|
1142
|
+
}
|
|
1143
|
+
},
|
|
1144
|
+
"additionalProperties": false,
|
|
1145
|
+
"description": "An external attendee. Sansan creates a new business card from these details.",
|
|
1146
|
+
"anyOf": [
|
|
1147
|
+
{
|
|
1148
|
+
"required": [
|
|
1149
|
+
"companyName"
|
|
1150
|
+
],
|
|
1151
|
+
"properties": {
|
|
1152
|
+
"companyName": {
|
|
1153
|
+
"minLength": 1
|
|
1154
|
+
}
|
|
1155
|
+
}
|
|
1156
|
+
},
|
|
1157
|
+
{
|
|
1158
|
+
"required": [
|
|
1159
|
+
"lastName"
|
|
1160
|
+
],
|
|
1161
|
+
"properties": {
|
|
1162
|
+
"lastName": {
|
|
1163
|
+
"minLength": 1
|
|
1164
|
+
}
|
|
1165
|
+
}
|
|
1166
|
+
},
|
|
1167
|
+
{
|
|
1168
|
+
"required": [
|
|
1169
|
+
"firstName"
|
|
1170
|
+
],
|
|
1171
|
+
"properties": {
|
|
1172
|
+
"firstName": {
|
|
1173
|
+
"minLength": 1
|
|
1174
|
+
}
|
|
1175
|
+
}
|
|
1176
|
+
}
|
|
1177
|
+
]
|
|
1178
|
+
},
|
|
1179
|
+
"description": "External attendees whose details create new business cards."
|
|
1180
|
+
},
|
|
1181
|
+
"internalAttendeeUserIds": {
|
|
1182
|
+
"type": "array",
|
|
1183
|
+
"items": {
|
|
1184
|
+
"type": "string",
|
|
1185
|
+
"minLength": 1,
|
|
1186
|
+
"description": "An internal user ID."
|
|
1187
|
+
},
|
|
1188
|
+
"description": "Internal attendee user IDs; omission defaults to the report owner."
|
|
1189
|
+
},
|
|
1190
|
+
"type": {
|
|
1191
|
+
"type": "string",
|
|
1192
|
+
"enum": [
|
|
1193
|
+
"Meeting",
|
|
1194
|
+
"Visit",
|
|
1195
|
+
"MeetingAtOffice",
|
|
1196
|
+
"Call",
|
|
1197
|
+
"OutboundCall",
|
|
1198
|
+
"InboundCall",
|
|
1199
|
+
"Email",
|
|
1200
|
+
"SentEmail",
|
|
1201
|
+
"ReceivedEmail",
|
|
1202
|
+
"OnlineMeeting"
|
|
1203
|
+
],
|
|
1204
|
+
"description": "The contact interaction type."
|
|
1205
|
+
},
|
|
1206
|
+
"title": {
|
|
1207
|
+
"type": "string",
|
|
1208
|
+
"description": "Contact report title."
|
|
1209
|
+
},
|
|
1210
|
+
"location": {
|
|
1211
|
+
"type": "string",
|
|
1212
|
+
"description": "Contact location."
|
|
1213
|
+
},
|
|
1214
|
+
"memo": {
|
|
1215
|
+
"type": "string",
|
|
1216
|
+
"description": "Contact report memo."
|
|
1217
|
+
}
|
|
1218
|
+
},
|
|
1219
|
+
"additionalProperties": false,
|
|
1220
|
+
"required": [
|
|
1221
|
+
"startTime",
|
|
1222
|
+
"endTime",
|
|
1223
|
+
"externalAttendees",
|
|
1224
|
+
"type"
|
|
1225
|
+
],
|
|
1226
|
+
"description": "Contact report details."
|
|
1227
|
+
},
|
|
1228
|
+
"outputSchema": {
|
|
1229
|
+
"type": "object",
|
|
1230
|
+
"properties": {
|
|
1231
|
+
"id": {
|
|
1232
|
+
"type": "string",
|
|
1233
|
+
"description": "Contact report ID."
|
|
1234
|
+
},
|
|
1235
|
+
"registeredTime": {
|
|
1236
|
+
"type": "string",
|
|
1237
|
+
"description": "Contact report registration timestamp."
|
|
1238
|
+
},
|
|
1239
|
+
"updatedTime": {
|
|
1240
|
+
"type": "string",
|
|
1241
|
+
"description": "Contact report update timestamp."
|
|
1242
|
+
},
|
|
1243
|
+
"startDate": {
|
|
1244
|
+
"type": "string",
|
|
1245
|
+
"description": "Interaction start date."
|
|
1246
|
+
},
|
|
1247
|
+
"endDate": {
|
|
1248
|
+
"type": "string",
|
|
1249
|
+
"description": "Interaction end date."
|
|
1250
|
+
},
|
|
1251
|
+
"startTime": {
|
|
1252
|
+
"type": "string",
|
|
1253
|
+
"description": "Interaction start timestamp."
|
|
1254
|
+
},
|
|
1255
|
+
"endTime": {
|
|
1256
|
+
"type": "string",
|
|
1257
|
+
"description": "Interaction end timestamp."
|
|
1258
|
+
},
|
|
1259
|
+
"type": {
|
|
1260
|
+
"type": "string",
|
|
1261
|
+
"description": "Recorded interaction type."
|
|
1262
|
+
},
|
|
1263
|
+
"title": {
|
|
1264
|
+
"type": "string",
|
|
1265
|
+
"description": "Contact report title."
|
|
1266
|
+
},
|
|
1267
|
+
"location": {
|
|
1268
|
+
"type": "string",
|
|
1269
|
+
"description": "Contact location."
|
|
1270
|
+
},
|
|
1271
|
+
"memo": {
|
|
1272
|
+
"type": "string",
|
|
1273
|
+
"description": "Contact report memo."
|
|
1274
|
+
},
|
|
1275
|
+
"owner": {
|
|
1276
|
+
"type": "object",
|
|
1277
|
+
"properties": {
|
|
1278
|
+
"id": {
|
|
1279
|
+
"type": "string",
|
|
1280
|
+
"description": "The owner user ID."
|
|
1281
|
+
},
|
|
1282
|
+
"name": {
|
|
1283
|
+
"type": "string",
|
|
1284
|
+
"description": "The owner name."
|
|
1285
|
+
},
|
|
1286
|
+
"email": {
|
|
1287
|
+
"type": "string",
|
|
1288
|
+
"description": "The owner email address."
|
|
1289
|
+
}
|
|
1290
|
+
},
|
|
1291
|
+
"additionalProperties": true,
|
|
1292
|
+
"description": "The business card or tag owner."
|
|
1293
|
+
},
|
|
1294
|
+
"externalAttendees": {
|
|
1295
|
+
"type": "array",
|
|
1296
|
+
"items": {
|
|
1297
|
+
"type": "object",
|
|
1298
|
+
"additionalProperties": true,
|
|
1299
|
+
"description": "An external participant with provider-defined contact fields."
|
|
1300
|
+
},
|
|
1301
|
+
"description": "External attendees and their business card and person IDs."
|
|
1302
|
+
},
|
|
1303
|
+
"internalAttendees": {
|
|
1304
|
+
"type": "array",
|
|
1305
|
+
"items": {
|
|
1306
|
+
"type": "object",
|
|
1307
|
+
"additionalProperties": true,
|
|
1308
|
+
"description": "An internal participant with provider-defined user fields."
|
|
1309
|
+
},
|
|
1310
|
+
"description": "Internal attendees and their user details."
|
|
1311
|
+
},
|
|
1312
|
+
"categories": {
|
|
1313
|
+
"type": "array",
|
|
1314
|
+
"items": {
|
|
1315
|
+
"type": "object",
|
|
1316
|
+
"additionalProperties": true,
|
|
1317
|
+
"description": "A category name and value."
|
|
1318
|
+
},
|
|
1319
|
+
"description": "Categories assigned to the contact report."
|
|
1320
|
+
}
|
|
1321
|
+
},
|
|
1322
|
+
"additionalProperties": true,
|
|
1323
|
+
"description": "A contact report with meeting or communication details and additional upstream fields."
|
|
1324
|
+
}
|
|
1325
|
+
},
|
|
1326
|
+
{
|
|
1327
|
+
"id": "sansan.delete_access_control_pattern",
|
|
1328
|
+
"service": "sansan",
|
|
1329
|
+
"name": "delete_access_control_pattern",
|
|
1330
|
+
"description": "Delete an access control pattern. System administrator only; Sansan may reject a pattern still in use.",
|
|
1331
|
+
"operationType": "destructive",
|
|
1332
|
+
"requiredScopes": [],
|
|
1333
|
+
"providerPermissions": [],
|
|
1334
|
+
"inputSchema": {
|
|
1335
|
+
"type": "object",
|
|
1336
|
+
"properties": {
|
|
1337
|
+
"patternId": {
|
|
1338
|
+
"type": "string",
|
|
1339
|
+
"minLength": 1,
|
|
1340
|
+
"description": "The access control pattern ID."
|
|
1341
|
+
}
|
|
1342
|
+
},
|
|
1343
|
+
"additionalProperties": false,
|
|
1344
|
+
"required": [
|
|
1345
|
+
"patternId"
|
|
1346
|
+
],
|
|
1347
|
+
"description": "Access control pattern to delete."
|
|
1348
|
+
},
|
|
1349
|
+
"outputSchema": {
|
|
1350
|
+
"type": "object",
|
|
1351
|
+
"properties": {
|
|
1352
|
+
"success": {
|
|
1353
|
+
"type": "boolean",
|
|
1354
|
+
"description": "Whether the request succeeded."
|
|
1355
|
+
},
|
|
1356
|
+
"data": {
|
|
1357
|
+
"anyOf": [
|
|
1358
|
+
{
|
|
1359
|
+
"type": "object",
|
|
1360
|
+
"additionalProperties": true,
|
|
1361
|
+
"description": "Any JSON payload returned by Sansan."
|
|
1362
|
+
},
|
|
1363
|
+
{
|
|
1364
|
+
"type": "null"
|
|
1365
|
+
}
|
|
1366
|
+
],
|
|
1367
|
+
"description": "Any JSON payload returned by Sansan."
|
|
1368
|
+
}
|
|
1369
|
+
},
|
|
1370
|
+
"additionalProperties": false,
|
|
1371
|
+
"required": [
|
|
1372
|
+
"success",
|
|
1373
|
+
"data"
|
|
1374
|
+
],
|
|
1375
|
+
"description": "Successful administration change."
|
|
1376
|
+
}
|
|
1377
|
+
},
|
|
1378
|
+
{
|
|
1379
|
+
"id": "sansan.export_organization_departments",
|
|
1380
|
+
"service": "sansan",
|
|
1381
|
+
"name": "export_organization_departments",
|
|
1382
|
+
"description": "Export Sansan organization departments as a CSV download. System administrator only.",
|
|
1383
|
+
"operationType": "read",
|
|
1384
|
+
"requiredScopes": [],
|
|
1385
|
+
"providerPermissions": [],
|
|
1386
|
+
"inputSchema": {
|
|
1387
|
+
"type": "object",
|
|
1388
|
+
"properties": {
|
|
1389
|
+
"delimiter": {
|
|
1390
|
+
"type": "string",
|
|
1391
|
+
"enum": [
|
|
1392
|
+
"comma",
|
|
1393
|
+
"semicolon",
|
|
1394
|
+
"tab",
|
|
1395
|
+
"space"
|
|
1396
|
+
],
|
|
1397
|
+
"description": "CSV delimiter; defaults to comma."
|
|
1398
|
+
}
|
|
1399
|
+
},
|
|
1400
|
+
"additionalProperties": false,
|
|
1401
|
+
"description": "Department export options."
|
|
1402
|
+
},
|
|
1403
|
+
"outputSchema": {
|
|
1404
|
+
"type": "object",
|
|
1405
|
+
"properties": {
|
|
1406
|
+
"fileId": {
|
|
1407
|
+
"type": "string",
|
|
1408
|
+
"description": "The stored transit file identifier."
|
|
1409
|
+
},
|
|
1410
|
+
"downloadUrl": {
|
|
1411
|
+
"type": "string",
|
|
1412
|
+
"description": "The transit file download URL."
|
|
1413
|
+
},
|
|
1414
|
+
"name": {
|
|
1415
|
+
"type": "string",
|
|
1416
|
+
"description": "The file name."
|
|
1417
|
+
},
|
|
1418
|
+
"mimeType": {
|
|
1419
|
+
"type": "string",
|
|
1420
|
+
"description": "The file media type."
|
|
1421
|
+
},
|
|
1422
|
+
"sizeBytes": {
|
|
1423
|
+
"type": "integer",
|
|
1424
|
+
"description": "The file size in bytes."
|
|
1425
|
+
}
|
|
1426
|
+
},
|
|
1427
|
+
"additionalProperties": false,
|
|
1428
|
+
"required": [
|
|
1429
|
+
"fileId",
|
|
1430
|
+
"downloadUrl",
|
|
1431
|
+
"name",
|
|
1432
|
+
"mimeType",
|
|
1433
|
+
"sizeBytes"
|
|
1434
|
+
],
|
|
1435
|
+
"description": "A downloaded file in local transit storage."
|
|
1436
|
+
}
|
|
1437
|
+
},
|
|
1438
|
+
{
|
|
1439
|
+
"id": "sansan.export_organization_users",
|
|
1440
|
+
"service": "sansan",
|
|
1441
|
+
"name": "export_organization_users",
|
|
1442
|
+
"description": "Export Sansan organization users as a CSV download. System administrator only.",
|
|
1443
|
+
"operationType": "read",
|
|
1444
|
+
"requiredScopes": [],
|
|
1445
|
+
"providerPermissions": [],
|
|
1446
|
+
"inputSchema": {
|
|
1447
|
+
"type": "object",
|
|
1448
|
+
"properties": {
|
|
1449
|
+
"delimiter": {
|
|
1450
|
+
"type": "string",
|
|
1451
|
+
"enum": [
|
|
1452
|
+
"comma",
|
|
1453
|
+
"semicolon",
|
|
1454
|
+
"tab",
|
|
1455
|
+
"space"
|
|
1456
|
+
],
|
|
1457
|
+
"description": "CSV delimiter; defaults to comma."
|
|
1458
|
+
}
|
|
1459
|
+
},
|
|
1460
|
+
"additionalProperties": false,
|
|
1461
|
+
"description": "User export options."
|
|
1462
|
+
},
|
|
1463
|
+
"outputSchema": {
|
|
1464
|
+
"type": "object",
|
|
1465
|
+
"properties": {
|
|
1466
|
+
"fileId": {
|
|
1467
|
+
"type": "string",
|
|
1468
|
+
"description": "The stored transit file identifier."
|
|
1469
|
+
},
|
|
1470
|
+
"downloadUrl": {
|
|
1471
|
+
"type": "string",
|
|
1472
|
+
"description": "The transit file download URL."
|
|
1473
|
+
},
|
|
1474
|
+
"name": {
|
|
1475
|
+
"type": "string",
|
|
1476
|
+
"description": "The file name."
|
|
1477
|
+
},
|
|
1478
|
+
"mimeType": {
|
|
1479
|
+
"type": "string",
|
|
1480
|
+
"description": "The file media type."
|
|
1481
|
+
},
|
|
1482
|
+
"sizeBytes": {
|
|
1483
|
+
"type": "integer",
|
|
1484
|
+
"description": "The file size in bytes."
|
|
1485
|
+
}
|
|
1486
|
+
},
|
|
1487
|
+
"additionalProperties": false,
|
|
1488
|
+
"required": [
|
|
1489
|
+
"fileId",
|
|
1490
|
+
"downloadUrl",
|
|
1491
|
+
"name",
|
|
1492
|
+
"mimeType",
|
|
1493
|
+
"sizeBytes"
|
|
1494
|
+
],
|
|
1495
|
+
"description": "A downloaded file in local transit storage."
|
|
1496
|
+
}
|
|
1497
|
+
},
|
|
1498
|
+
{
|
|
1499
|
+
"id": "sansan.get_business_card",
|
|
1500
|
+
"service": "sansan",
|
|
1501
|
+
"name": "get_business_card",
|
|
1502
|
+
"description": "Get a business card by ID. Sansan may return the latest merged card with a different ID.",
|
|
1503
|
+
"operationType": "read",
|
|
1504
|
+
"requiredScopes": [],
|
|
1505
|
+
"providerPermissions": [],
|
|
1506
|
+
"inputSchema": {
|
|
1507
|
+
"type": "object",
|
|
1508
|
+
"properties": {
|
|
1509
|
+
"businessCardId": {
|
|
1510
|
+
"type": "string",
|
|
1511
|
+
"minLength": 1,
|
|
1512
|
+
"description": "The Sansan business card ID."
|
|
1513
|
+
},
|
|
1514
|
+
"includeTags": {
|
|
1515
|
+
"type": "boolean",
|
|
1516
|
+
"description": "Include attached tags and treat tag changes as business card updates."
|
|
1517
|
+
}
|
|
1518
|
+
},
|
|
1519
|
+
"additionalProperties": false,
|
|
1520
|
+
"required": [
|
|
1521
|
+
"businessCardId"
|
|
1522
|
+
],
|
|
1523
|
+
"description": "Business card lookup."
|
|
1524
|
+
},
|
|
1525
|
+
"outputSchema": {
|
|
1526
|
+
"type": "object",
|
|
1527
|
+
"properties": {
|
|
1528
|
+
"id": {
|
|
1529
|
+
"anyOf": [
|
|
1530
|
+
{
|
|
1531
|
+
"type": "string",
|
|
1532
|
+
"description": "The business card ID."
|
|
1533
|
+
},
|
|
1534
|
+
{
|
|
1535
|
+
"type": "null"
|
|
1536
|
+
}
|
|
1537
|
+
],
|
|
1538
|
+
"description": "The business card ID."
|
|
1539
|
+
},
|
|
1540
|
+
"companyId": {
|
|
1541
|
+
"anyOf": [
|
|
1542
|
+
{
|
|
1543
|
+
"type": "string",
|
|
1544
|
+
"description": "The company ID."
|
|
1545
|
+
},
|
|
1546
|
+
{
|
|
1547
|
+
"type": "null"
|
|
1548
|
+
}
|
|
1549
|
+
],
|
|
1550
|
+
"description": "The company ID."
|
|
1551
|
+
},
|
|
1552
|
+
"personId": {
|
|
1553
|
+
"anyOf": [
|
|
1554
|
+
{
|
|
1555
|
+
"type": "string",
|
|
1556
|
+
"description": "The person ID."
|
|
1557
|
+
},
|
|
1558
|
+
{
|
|
1559
|
+
"type": "null"
|
|
1560
|
+
}
|
|
1561
|
+
],
|
|
1562
|
+
"description": "The person ID."
|
|
1563
|
+
},
|
|
1564
|
+
"firstName": {
|
|
1565
|
+
"anyOf": [
|
|
1566
|
+
{
|
|
1567
|
+
"type": "string",
|
|
1568
|
+
"description": "The first name."
|
|
1569
|
+
},
|
|
1570
|
+
{
|
|
1571
|
+
"type": "null"
|
|
1572
|
+
}
|
|
1573
|
+
],
|
|
1574
|
+
"description": "The first name."
|
|
1575
|
+
},
|
|
1576
|
+
"lastName": {
|
|
1577
|
+
"anyOf": [
|
|
1578
|
+
{
|
|
1579
|
+
"type": "string",
|
|
1580
|
+
"description": "The last name."
|
|
1581
|
+
},
|
|
1582
|
+
{
|
|
1583
|
+
"type": "null"
|
|
1584
|
+
}
|
|
1585
|
+
],
|
|
1586
|
+
"description": "The last name."
|
|
1587
|
+
},
|
|
1588
|
+
"companyName": {
|
|
1589
|
+
"anyOf": [
|
|
1590
|
+
{
|
|
1591
|
+
"type": "string",
|
|
1592
|
+
"description": "The company name."
|
|
1593
|
+
},
|
|
1594
|
+
{
|
|
1595
|
+
"type": "null"
|
|
1596
|
+
}
|
|
1597
|
+
],
|
|
1598
|
+
"description": "The company name."
|
|
1599
|
+
},
|
|
1600
|
+
"departmentName": {
|
|
1601
|
+
"anyOf": [
|
|
1602
|
+
{
|
|
1603
|
+
"type": "string",
|
|
1604
|
+
"description": "The department name."
|
|
1605
|
+
},
|
|
1606
|
+
{
|
|
1607
|
+
"type": "null"
|
|
1608
|
+
}
|
|
1609
|
+
],
|
|
1610
|
+
"description": "The department name."
|
|
1611
|
+
},
|
|
1612
|
+
"title": {
|
|
1613
|
+
"anyOf": [
|
|
1614
|
+
{
|
|
1615
|
+
"type": "string",
|
|
1616
|
+
"description": "The job title."
|
|
1617
|
+
},
|
|
1618
|
+
{
|
|
1619
|
+
"type": "null"
|
|
1620
|
+
}
|
|
1621
|
+
],
|
|
1622
|
+
"description": "The job title."
|
|
1623
|
+
},
|
|
1624
|
+
"email": {
|
|
1625
|
+
"anyOf": [
|
|
1626
|
+
{
|
|
1627
|
+
"type": "string",
|
|
1628
|
+
"description": "The email address."
|
|
1629
|
+
},
|
|
1630
|
+
{
|
|
1631
|
+
"type": "null"
|
|
1632
|
+
}
|
|
1633
|
+
],
|
|
1634
|
+
"description": "The email address."
|
|
1635
|
+
},
|
|
1636
|
+
"tel": {
|
|
1637
|
+
"anyOf": [
|
|
1638
|
+
{
|
|
1639
|
+
"type": "string",
|
|
1640
|
+
"description": "The telephone number."
|
|
1641
|
+
},
|
|
1642
|
+
{
|
|
1643
|
+
"type": "null"
|
|
1644
|
+
}
|
|
1645
|
+
],
|
|
1646
|
+
"description": "The telephone number."
|
|
1647
|
+
},
|
|
1648
|
+
"mobile": {
|
|
1649
|
+
"anyOf": [
|
|
1650
|
+
{
|
|
1651
|
+
"type": "string",
|
|
1652
|
+
"description": "The mobile phone number."
|
|
1653
|
+
},
|
|
1654
|
+
{
|
|
1655
|
+
"type": "null"
|
|
1656
|
+
}
|
|
1657
|
+
],
|
|
1658
|
+
"description": "The mobile phone number."
|
|
1659
|
+
},
|
|
1660
|
+
"exchangeDate": {
|
|
1661
|
+
"anyOf": [
|
|
1662
|
+
{
|
|
1663
|
+
"type": "string",
|
|
1664
|
+
"description": "The business card exchange date."
|
|
1665
|
+
},
|
|
1666
|
+
{
|
|
1667
|
+
"type": "null"
|
|
1668
|
+
}
|
|
1669
|
+
],
|
|
1670
|
+
"description": "The business card exchange date."
|
|
1671
|
+
},
|
|
1672
|
+
"registeredTime": {
|
|
1673
|
+
"anyOf": [
|
|
1674
|
+
{
|
|
1675
|
+
"type": "string",
|
|
1676
|
+
"description": "The registration timestamp."
|
|
1677
|
+
},
|
|
1678
|
+
{
|
|
1679
|
+
"type": "null"
|
|
1680
|
+
}
|
|
1681
|
+
],
|
|
1682
|
+
"description": "The registration timestamp."
|
|
1683
|
+
},
|
|
1684
|
+
"updatedTime": {
|
|
1685
|
+
"anyOf": [
|
|
1686
|
+
{
|
|
1687
|
+
"type": "string",
|
|
1688
|
+
"description": "The last update timestamp."
|
|
1689
|
+
},
|
|
1690
|
+
{
|
|
1691
|
+
"type": "null"
|
|
1692
|
+
}
|
|
1693
|
+
],
|
|
1694
|
+
"description": "The last update timestamp."
|
|
1695
|
+
},
|
|
1696
|
+
"entryStatus": {
|
|
1697
|
+
"anyOf": [
|
|
1698
|
+
{
|
|
1699
|
+
"type": "string",
|
|
1700
|
+
"description": "The digitization status."
|
|
1701
|
+
},
|
|
1702
|
+
{
|
|
1703
|
+
"type": "null"
|
|
1704
|
+
}
|
|
1705
|
+
],
|
|
1706
|
+
"description": "The digitization status."
|
|
1707
|
+
},
|
|
1708
|
+
"owner": {
|
|
1709
|
+
"type": "object",
|
|
1710
|
+
"properties": {
|
|
1711
|
+
"id": {
|
|
1712
|
+
"type": "string",
|
|
1713
|
+
"description": "The owner user ID."
|
|
1714
|
+
},
|
|
1715
|
+
"name": {
|
|
1716
|
+
"type": "string",
|
|
1717
|
+
"description": "The owner name."
|
|
1718
|
+
},
|
|
1719
|
+
"email": {
|
|
1720
|
+
"type": "string",
|
|
1721
|
+
"description": "The owner email address."
|
|
1722
|
+
}
|
|
1723
|
+
},
|
|
1724
|
+
"additionalProperties": true,
|
|
1725
|
+
"description": "The business card or tag owner."
|
|
1726
|
+
},
|
|
1727
|
+
"tags": {
|
|
1728
|
+
"type": "array",
|
|
1729
|
+
"items": {
|
|
1730
|
+
"type": "object",
|
|
1731
|
+
"properties": {
|
|
1732
|
+
"id": {
|
|
1733
|
+
"type": "string",
|
|
1734
|
+
"description": "The tag ID."
|
|
1735
|
+
},
|
|
1736
|
+
"name": {
|
|
1737
|
+
"type": "string",
|
|
1738
|
+
"description": "The tag name."
|
|
1739
|
+
},
|
|
1740
|
+
"type": {
|
|
1741
|
+
"type": "string",
|
|
1742
|
+
"description": "The tag visibility: private, public, or shared."
|
|
1743
|
+
},
|
|
1744
|
+
"owner": {
|
|
1745
|
+
"type": "object",
|
|
1746
|
+
"properties": {
|
|
1747
|
+
"id": {
|
|
1748
|
+
"type": "string",
|
|
1749
|
+
"description": "The owner user ID."
|
|
1750
|
+
},
|
|
1751
|
+
"name": {
|
|
1752
|
+
"type": "string",
|
|
1753
|
+
"description": "The owner name."
|
|
1754
|
+
},
|
|
1755
|
+
"email": {
|
|
1756
|
+
"type": "string",
|
|
1757
|
+
"description": "The owner email address."
|
|
1758
|
+
}
|
|
1759
|
+
},
|
|
1760
|
+
"additionalProperties": true,
|
|
1761
|
+
"description": "The business card or tag owner."
|
|
1762
|
+
}
|
|
1763
|
+
},
|
|
1764
|
+
"additionalProperties": true,
|
|
1765
|
+
"description": "A Sansan tag, with additional upstream fields preserved."
|
|
1766
|
+
},
|
|
1767
|
+
"description": "Tags attached to the business card when requested."
|
|
1768
|
+
}
|
|
1769
|
+
},
|
|
1770
|
+
"additionalProperties": true,
|
|
1771
|
+
"description": "A business card with contact details; additional Sansan fields are preserved."
|
|
1772
|
+
}
|
|
1773
|
+
},
|
|
1774
|
+
{
|
|
1775
|
+
"id": "sansan.get_business_card_image",
|
|
1776
|
+
"service": "sansan",
|
|
1777
|
+
"name": "get_business_card_image",
|
|
1778
|
+
"description": "Download the front or back of a Sansan business card as a JPEG file URL.",
|
|
1779
|
+
"operationType": "read",
|
|
1780
|
+
"requiredScopes": [],
|
|
1781
|
+
"providerPermissions": [],
|
|
1782
|
+
"inputSchema": {
|
|
1783
|
+
"type": "object",
|
|
1784
|
+
"properties": {
|
|
1785
|
+
"businessCardId": {
|
|
1786
|
+
"type": "string",
|
|
1787
|
+
"minLength": 1,
|
|
1788
|
+
"description": "The Sansan business card ID."
|
|
1789
|
+
},
|
|
1790
|
+
"side": {
|
|
1791
|
+
"type": "string",
|
|
1792
|
+
"enum": [
|
|
1793
|
+
"front",
|
|
1794
|
+
"back"
|
|
1795
|
+
],
|
|
1796
|
+
"description": "The card side; defaults to front."
|
|
1797
|
+
}
|
|
1798
|
+
},
|
|
1799
|
+
"additionalProperties": false,
|
|
1800
|
+
"required": [
|
|
1801
|
+
"businessCardId"
|
|
1802
|
+
],
|
|
1803
|
+
"description": "Business card image selection."
|
|
1804
|
+
},
|
|
1805
|
+
"outputSchema": {
|
|
1806
|
+
"type": "object",
|
|
1807
|
+
"properties": {
|
|
1808
|
+
"fileId": {
|
|
1809
|
+
"type": "string",
|
|
1810
|
+
"description": "The stored transit file identifier."
|
|
1811
|
+
},
|
|
1812
|
+
"downloadUrl": {
|
|
1813
|
+
"type": "string",
|
|
1814
|
+
"description": "The transit file download URL."
|
|
1815
|
+
},
|
|
1816
|
+
"name": {
|
|
1817
|
+
"type": "string",
|
|
1818
|
+
"description": "The file name."
|
|
1819
|
+
},
|
|
1820
|
+
"mimeType": {
|
|
1821
|
+
"type": "string",
|
|
1822
|
+
"description": "The file media type."
|
|
1823
|
+
},
|
|
1824
|
+
"sizeBytes": {
|
|
1825
|
+
"type": "integer",
|
|
1826
|
+
"description": "The file size in bytes."
|
|
1827
|
+
}
|
|
1828
|
+
},
|
|
1829
|
+
"additionalProperties": false,
|
|
1830
|
+
"required": [
|
|
1831
|
+
"fileId",
|
|
1832
|
+
"downloadUrl",
|
|
1833
|
+
"name",
|
|
1834
|
+
"mimeType",
|
|
1835
|
+
"sizeBytes"
|
|
1836
|
+
],
|
|
1837
|
+
"description": "A downloaded file in local transit storage."
|
|
1838
|
+
}
|
|
1839
|
+
},
|
|
1840
|
+
{
|
|
1841
|
+
"id": "sansan.get_current_user",
|
|
1842
|
+
"service": "sansan",
|
|
1843
|
+
"name": "get_current_user",
|
|
1844
|
+
"description": "Get the Sansan user and permissions associated with the connected API key.",
|
|
1845
|
+
"operationType": "read",
|
|
1846
|
+
"requiredScopes": [],
|
|
1847
|
+
"providerPermissions": [],
|
|
1848
|
+
"inputSchema": {
|
|
1849
|
+
"type": "object",
|
|
1850
|
+
"properties": {},
|
|
1851
|
+
"additionalProperties": false,
|
|
1852
|
+
"description": "No input is required."
|
|
1853
|
+
},
|
|
1854
|
+
"outputSchema": {
|
|
1855
|
+
"type": "object",
|
|
1856
|
+
"properties": {
|
|
1857
|
+
"id": {
|
|
1858
|
+
"type": "string",
|
|
1859
|
+
"description": "The user ID."
|
|
1860
|
+
},
|
|
1861
|
+
"name": {
|
|
1862
|
+
"type": "string",
|
|
1863
|
+
"description": "The user name."
|
|
1864
|
+
},
|
|
1865
|
+
"userType": {
|
|
1866
|
+
"type": "string",
|
|
1867
|
+
"description": "The user role in Sansan."
|
|
1868
|
+
},
|
|
1869
|
+
"canUpdateData": {
|
|
1870
|
+
"type": "boolean",
|
|
1871
|
+
"description": "Whether the user can update all data."
|
|
1872
|
+
},
|
|
1873
|
+
"departments": {
|
|
1874
|
+
"type": "array",
|
|
1875
|
+
"items": {
|
|
1876
|
+
"type": "object",
|
|
1877
|
+
"properties": {
|
|
1878
|
+
"name": {
|
|
1879
|
+
"type": "string",
|
|
1880
|
+
"description": "The department name."
|
|
1881
|
+
}
|
|
1882
|
+
},
|
|
1883
|
+
"additionalProperties": true,
|
|
1884
|
+
"description": "A user department."
|
|
1885
|
+
},
|
|
1886
|
+
"description": "Departments the user belongs to."
|
|
1887
|
+
}
|
|
1888
|
+
},
|
|
1889
|
+
"additionalProperties": true,
|
|
1890
|
+
"description": "The Sansan user associated with the API key."
|
|
1891
|
+
}
|
|
1892
|
+
},
|
|
1893
|
+
{
|
|
1894
|
+
"id": "sansan.get_default_email_client",
|
|
1895
|
+
"service": "sansan",
|
|
1896
|
+
"name": "get_default_email_client",
|
|
1897
|
+
"description": "Get the default email client settings for new users. System administrator only.",
|
|
1898
|
+
"operationType": "read",
|
|
1899
|
+
"requiredScopes": [],
|
|
1900
|
+
"providerPermissions": [],
|
|
1901
|
+
"inputSchema": {
|
|
1902
|
+
"type": "object",
|
|
1903
|
+
"properties": {},
|
|
1904
|
+
"additionalProperties": false,
|
|
1905
|
+
"description": "No input is required."
|
|
1906
|
+
},
|
|
1907
|
+
"outputSchema": {
|
|
1908
|
+
"type": "object",
|
|
1909
|
+
"properties": {
|
|
1910
|
+
"settings": {
|
|
1911
|
+
"anyOf": [
|
|
1912
|
+
{
|
|
1913
|
+
"type": "object",
|
|
1914
|
+
"properties": {
|
|
1915
|
+
"emailClient": {
|
|
1916
|
+
"type": "string",
|
|
1917
|
+
"enum": [
|
|
1918
|
+
"clientSoftware",
|
|
1919
|
+
"gmail",
|
|
1920
|
+
"office365"
|
|
1921
|
+
],
|
|
1922
|
+
"description": "Default email client for newly added users."
|
|
1923
|
+
},
|
|
1924
|
+
"encoding": {
|
|
1925
|
+
"type": "string",
|
|
1926
|
+
"enum": [
|
|
1927
|
+
"sjis",
|
|
1928
|
+
"utf8",
|
|
1929
|
+
"iso2022jp"
|
|
1930
|
+
],
|
|
1931
|
+
"description": "Required only for clientSoftware."
|
|
1932
|
+
}
|
|
1933
|
+
},
|
|
1934
|
+
"additionalProperties": true,
|
|
1935
|
+
"description": "Email client configuration."
|
|
1936
|
+
},
|
|
1937
|
+
{
|
|
1938
|
+
"type": "null"
|
|
1939
|
+
}
|
|
1940
|
+
],
|
|
1941
|
+
"description": "Email client configuration."
|
|
1942
|
+
}
|
|
1943
|
+
},
|
|
1944
|
+
"additionalProperties": false,
|
|
1945
|
+
"required": [
|
|
1946
|
+
"settings"
|
|
1947
|
+
],
|
|
1948
|
+
"description": "Organization default email client; null when not configured."
|
|
1949
|
+
}
|
|
1950
|
+
},
|
|
1951
|
+
{
|
|
1952
|
+
"id": "sansan.get_department_access_control",
|
|
1953
|
+
"service": "sansan",
|
|
1954
|
+
"name": "get_department_access_control",
|
|
1955
|
+
"description": "Get the access control pattern assigned to a department. System administrator only.",
|
|
1956
|
+
"operationType": "read",
|
|
1957
|
+
"requiredScopes": [],
|
|
1958
|
+
"providerPermissions": [],
|
|
1959
|
+
"inputSchema": {
|
|
1960
|
+
"type": "object",
|
|
1961
|
+
"properties": {
|
|
1962
|
+
"departmentId": {
|
|
1963
|
+
"type": "string",
|
|
1964
|
+
"minLength": 1,
|
|
1965
|
+
"description": "The department ID."
|
|
1966
|
+
}
|
|
1967
|
+
},
|
|
1968
|
+
"additionalProperties": false,
|
|
1969
|
+
"required": [
|
|
1970
|
+
"departmentId"
|
|
1971
|
+
],
|
|
1972
|
+
"description": "Department selection."
|
|
1973
|
+
},
|
|
1974
|
+
"outputSchema": {
|
|
1975
|
+
"type": "object",
|
|
1976
|
+
"properties": {
|
|
1977
|
+
"departmentId": {
|
|
1978
|
+
"type": "string",
|
|
1979
|
+
"minLength": 1,
|
|
1980
|
+
"description": "The department ID."
|
|
1981
|
+
},
|
|
1982
|
+
"accessControlPattern": {
|
|
1983
|
+
"type": "object",
|
|
1984
|
+
"properties": {
|
|
1985
|
+
"aclPatternId": {
|
|
1986
|
+
"type": "string",
|
|
1987
|
+
"minLength": 1,
|
|
1988
|
+
"description": "The access control pattern ID."
|
|
1989
|
+
},
|
|
1990
|
+
"aclPatternName": {
|
|
1991
|
+
"type": "string",
|
|
1992
|
+
"minLength": 1,
|
|
1993
|
+
"description": "Access control pattern name."
|
|
1994
|
+
},
|
|
1995
|
+
"description": {
|
|
1996
|
+
"type": "string",
|
|
1997
|
+
"description": "Access control pattern description."
|
|
1998
|
+
},
|
|
1999
|
+
"details": {
|
|
2000
|
+
"type": "array",
|
|
2001
|
+
"items": {
|
|
2002
|
+
"type": "object",
|
|
2003
|
+
"properties": {
|
|
2004
|
+
"objectDepartmentId": {
|
|
2005
|
+
"type": "string",
|
|
2006
|
+
"minLength": 1,
|
|
2007
|
+
"description": "The department whose data this rule covers."
|
|
2008
|
+
},
|
|
2009
|
+
"accessibleFieldsSettingsName": {
|
|
2010
|
+
"type": "string",
|
|
2011
|
+
"minLength": 1,
|
|
2012
|
+
"description": "The upstream accessible-fields setting name, such as ALL. Use values configured in Sansan; no complete enum is published."
|
|
2013
|
+
}
|
|
2014
|
+
},
|
|
2015
|
+
"additionalProperties": true,
|
|
2016
|
+
"required": [
|
|
2017
|
+
"objectDepartmentId",
|
|
2018
|
+
"accessibleFieldsSettingsName"
|
|
2019
|
+
],
|
|
2020
|
+
"description": "Access rule for a target department; additional provider-defined fields are accepted."
|
|
2021
|
+
},
|
|
2022
|
+
"description": "Department access rules."
|
|
2023
|
+
},
|
|
2024
|
+
"isInUse": {
|
|
2025
|
+
"type": "boolean",
|
|
2026
|
+
"description": "Whether this pattern is in use."
|
|
2027
|
+
}
|
|
2028
|
+
},
|
|
2029
|
+
"additionalProperties": true,
|
|
2030
|
+
"description": "A Sansan access control pattern, including upstream-defined fields."
|
|
2031
|
+
}
|
|
2032
|
+
},
|
|
2033
|
+
"additionalProperties": true,
|
|
2034
|
+
"description": "Department access control assignment."
|
|
2035
|
+
}
|
|
2036
|
+
},
|
|
2037
|
+
{
|
|
2038
|
+
"id": "sansan.get_organization_import_result",
|
|
2039
|
+
"service": "sansan",
|
|
2040
|
+
"name": "get_organization_import_result",
|
|
2041
|
+
"description": "Check an organization import and return its result CSV when completed or failed. System administrator only. The report includes created IDs and row-level errors.",
|
|
2042
|
+
"operationType": "read",
|
|
2043
|
+
"requiredScopes": [],
|
|
2044
|
+
"providerPermissions": [],
|
|
2045
|
+
"inputSchema": {
|
|
2046
|
+
"type": "object",
|
|
2047
|
+
"properties": {
|
|
2048
|
+
"importId": {
|
|
2049
|
+
"type": "string",
|
|
2050
|
+
"minLength": 1,
|
|
2051
|
+
"description": "The import ID returned when the job was submitted."
|
|
2052
|
+
}
|
|
2053
|
+
},
|
|
2054
|
+
"additionalProperties": false,
|
|
2055
|
+
"required": [
|
|
2056
|
+
"importId"
|
|
2057
|
+
],
|
|
2058
|
+
"description": "Organization import job identifier."
|
|
2059
|
+
},
|
|
2060
|
+
"outputSchema": {
|
|
2061
|
+
"type": "object",
|
|
2062
|
+
"properties": {
|
|
2063
|
+
"importId": {
|
|
2064
|
+
"type": "string",
|
|
2065
|
+
"minLength": 1,
|
|
2066
|
+
"description": "The import ID."
|
|
2067
|
+
},
|
|
2068
|
+
"importStatus": {
|
|
2069
|
+
"type": "integer",
|
|
2070
|
+
"description": "Upstream import status: 0 queued, 1 running, 2 completed, 9 error."
|
|
2071
|
+
},
|
|
2072
|
+
"status": {
|
|
2073
|
+
"type": "string",
|
|
2074
|
+
"enum": [
|
|
2075
|
+
"queued",
|
|
2076
|
+
"running",
|
|
2077
|
+
"completed",
|
|
2078
|
+
"failed"
|
|
2079
|
+
],
|
|
2080
|
+
"description": "Normalized import status."
|
|
2081
|
+
},
|
|
2082
|
+
"report": {
|
|
2083
|
+
"anyOf": [
|
|
2084
|
+
{
|
|
2085
|
+
"type": "object",
|
|
2086
|
+
"properties": {
|
|
2087
|
+
"fileId": {
|
|
2088
|
+
"type": "string",
|
|
2089
|
+
"description": "The stored transit file identifier."
|
|
2090
|
+
},
|
|
2091
|
+
"downloadUrl": {
|
|
2092
|
+
"type": "string",
|
|
2093
|
+
"description": "The transit file download URL."
|
|
2094
|
+
},
|
|
2095
|
+
"name": {
|
|
2096
|
+
"type": "string",
|
|
2097
|
+
"description": "The file name."
|
|
2098
|
+
},
|
|
2099
|
+
"mimeType": {
|
|
2100
|
+
"type": "string",
|
|
2101
|
+
"description": "The file media type."
|
|
2102
|
+
},
|
|
2103
|
+
"sizeBytes": {
|
|
2104
|
+
"type": "integer",
|
|
2105
|
+
"description": "The file size in bytes."
|
|
2106
|
+
}
|
|
2107
|
+
},
|
|
2108
|
+
"additionalProperties": false,
|
|
2109
|
+
"required": [
|
|
2110
|
+
"fileId",
|
|
2111
|
+
"downloadUrl",
|
|
2112
|
+
"name",
|
|
2113
|
+
"mimeType",
|
|
2114
|
+
"sizeBytes"
|
|
2115
|
+
],
|
|
2116
|
+
"description": "A downloaded file in local transit storage."
|
|
2117
|
+
},
|
|
2118
|
+
{
|
|
2119
|
+
"type": "null"
|
|
2120
|
+
}
|
|
2121
|
+
],
|
|
2122
|
+
"description": "A downloaded file in local transit storage."
|
|
2123
|
+
}
|
|
2124
|
+
},
|
|
2125
|
+
"additionalProperties": true,
|
|
2126
|
+
"required": [
|
|
2127
|
+
"importId",
|
|
2128
|
+
"importStatus",
|
|
2129
|
+
"status",
|
|
2130
|
+
"report"
|
|
2131
|
+
],
|
|
2132
|
+
"description": "Organization import state and result report."
|
|
2133
|
+
},
|
|
2134
|
+
"asyncLifecycle": {
|
|
2135
|
+
"startActionId": "sansan.submit_organization_import",
|
|
2136
|
+
"statusActionId": "sansan.get_organization_import_result"
|
|
2137
|
+
}
|
|
2138
|
+
},
|
|
2139
|
+
{
|
|
2140
|
+
"id": "sansan.get_organization_import_status",
|
|
2141
|
+
"service": "sansan",
|
|
2142
|
+
"name": "get_organization_import_status",
|
|
2143
|
+
"description": "Get the current organization import status. System administrator only.",
|
|
2144
|
+
"operationType": "read",
|
|
2145
|
+
"requiredScopes": [],
|
|
2146
|
+
"providerPermissions": [],
|
|
2147
|
+
"inputSchema": {
|
|
2148
|
+
"type": "object",
|
|
2149
|
+
"properties": {
|
|
2150
|
+
"importId": {
|
|
2151
|
+
"type": "string",
|
|
2152
|
+
"minLength": 1,
|
|
2153
|
+
"description": "The import ID returned when the job was submitted."
|
|
2154
|
+
}
|
|
2155
|
+
},
|
|
2156
|
+
"additionalProperties": false,
|
|
2157
|
+
"required": [
|
|
2158
|
+
"importId"
|
|
2159
|
+
],
|
|
2160
|
+
"description": "Organization import job identifier."
|
|
2161
|
+
},
|
|
2162
|
+
"outputSchema": {
|
|
2163
|
+
"type": "object",
|
|
2164
|
+
"properties": {
|
|
2165
|
+
"importStatus": {
|
|
2166
|
+
"type": "integer",
|
|
2167
|
+
"description": "Upstream import status: 0 queued, 1 running, 2 completed, 9 error."
|
|
2168
|
+
},
|
|
2169
|
+
"status": {
|
|
2170
|
+
"type": "string",
|
|
2171
|
+
"enum": [
|
|
2172
|
+
"queued",
|
|
2173
|
+
"running",
|
|
2174
|
+
"completed",
|
|
2175
|
+
"failed"
|
|
2176
|
+
],
|
|
2177
|
+
"description": "Normalized import status."
|
|
2178
|
+
}
|
|
2179
|
+
},
|
|
2180
|
+
"additionalProperties": true,
|
|
2181
|
+
"required": [
|
|
2182
|
+
"importStatus",
|
|
2183
|
+
"status"
|
|
2184
|
+
],
|
|
2185
|
+
"description": "Organization import status."
|
|
2186
|
+
}
|
|
2187
|
+
},
|
|
2188
|
+
{
|
|
2189
|
+
"id": "sansan.get_person",
|
|
2190
|
+
"service": "sansan",
|
|
2191
|
+
"name": "get_person",
|
|
2192
|
+
"description": "Get the latest business card for a Sansan person, optionally including tags.",
|
|
2193
|
+
"operationType": "read",
|
|
2194
|
+
"requiredScopes": [],
|
|
2195
|
+
"providerPermissions": [],
|
|
2196
|
+
"inputSchema": {
|
|
2197
|
+
"type": "object",
|
|
2198
|
+
"properties": {
|
|
2199
|
+
"personId": {
|
|
2200
|
+
"type": "string",
|
|
2201
|
+
"minLength": 1,
|
|
2202
|
+
"description": "The Sansan person ID."
|
|
2203
|
+
},
|
|
2204
|
+
"includeTags": {
|
|
2205
|
+
"type": "boolean",
|
|
2206
|
+
"description": "Include attached tags and treat tag changes as business card updates."
|
|
2207
|
+
}
|
|
2208
|
+
},
|
|
2209
|
+
"additionalProperties": false,
|
|
2210
|
+
"required": [
|
|
2211
|
+
"personId"
|
|
2212
|
+
],
|
|
2213
|
+
"description": "Person lookup."
|
|
2214
|
+
},
|
|
2215
|
+
"outputSchema": {
|
|
2216
|
+
"type": "object",
|
|
2217
|
+
"properties": {
|
|
2218
|
+
"id": {
|
|
2219
|
+
"anyOf": [
|
|
2220
|
+
{
|
|
2221
|
+
"type": "string",
|
|
2222
|
+
"description": "The business card ID."
|
|
2223
|
+
},
|
|
2224
|
+
{
|
|
2225
|
+
"type": "null"
|
|
2226
|
+
}
|
|
2227
|
+
],
|
|
2228
|
+
"description": "The business card ID."
|
|
2229
|
+
},
|
|
2230
|
+
"companyId": {
|
|
2231
|
+
"anyOf": [
|
|
2232
|
+
{
|
|
2233
|
+
"type": "string",
|
|
2234
|
+
"description": "The company ID."
|
|
2235
|
+
},
|
|
2236
|
+
{
|
|
2237
|
+
"type": "null"
|
|
2238
|
+
}
|
|
2239
|
+
],
|
|
2240
|
+
"description": "The company ID."
|
|
2241
|
+
},
|
|
2242
|
+
"personId": {
|
|
2243
|
+
"anyOf": [
|
|
2244
|
+
{
|
|
2245
|
+
"type": "string",
|
|
2246
|
+
"description": "The person ID."
|
|
2247
|
+
},
|
|
2248
|
+
{
|
|
2249
|
+
"type": "null"
|
|
2250
|
+
}
|
|
2251
|
+
],
|
|
2252
|
+
"description": "The person ID."
|
|
2253
|
+
},
|
|
2254
|
+
"firstName": {
|
|
2255
|
+
"anyOf": [
|
|
2256
|
+
{
|
|
2257
|
+
"type": "string",
|
|
2258
|
+
"description": "The first name."
|
|
2259
|
+
},
|
|
2260
|
+
{
|
|
2261
|
+
"type": "null"
|
|
2262
|
+
}
|
|
2263
|
+
],
|
|
2264
|
+
"description": "The first name."
|
|
2265
|
+
},
|
|
2266
|
+
"lastName": {
|
|
2267
|
+
"anyOf": [
|
|
2268
|
+
{
|
|
2269
|
+
"type": "string",
|
|
2270
|
+
"description": "The last name."
|
|
2271
|
+
},
|
|
2272
|
+
{
|
|
2273
|
+
"type": "null"
|
|
2274
|
+
}
|
|
2275
|
+
],
|
|
2276
|
+
"description": "The last name."
|
|
2277
|
+
},
|
|
2278
|
+
"companyName": {
|
|
2279
|
+
"anyOf": [
|
|
2280
|
+
{
|
|
2281
|
+
"type": "string",
|
|
2282
|
+
"description": "The company name."
|
|
2283
|
+
},
|
|
2284
|
+
{
|
|
2285
|
+
"type": "null"
|
|
2286
|
+
}
|
|
2287
|
+
],
|
|
2288
|
+
"description": "The company name."
|
|
2289
|
+
},
|
|
2290
|
+
"departmentName": {
|
|
2291
|
+
"anyOf": [
|
|
2292
|
+
{
|
|
2293
|
+
"type": "string",
|
|
2294
|
+
"description": "The department name."
|
|
2295
|
+
},
|
|
2296
|
+
{
|
|
2297
|
+
"type": "null"
|
|
2298
|
+
}
|
|
2299
|
+
],
|
|
2300
|
+
"description": "The department name."
|
|
2301
|
+
},
|
|
2302
|
+
"title": {
|
|
2303
|
+
"anyOf": [
|
|
2304
|
+
{
|
|
2305
|
+
"type": "string",
|
|
2306
|
+
"description": "The job title."
|
|
2307
|
+
},
|
|
2308
|
+
{
|
|
2309
|
+
"type": "null"
|
|
2310
|
+
}
|
|
2311
|
+
],
|
|
2312
|
+
"description": "The job title."
|
|
2313
|
+
},
|
|
2314
|
+
"email": {
|
|
2315
|
+
"anyOf": [
|
|
2316
|
+
{
|
|
2317
|
+
"type": "string",
|
|
2318
|
+
"description": "The email address."
|
|
2319
|
+
},
|
|
2320
|
+
{
|
|
2321
|
+
"type": "null"
|
|
2322
|
+
}
|
|
2323
|
+
],
|
|
2324
|
+
"description": "The email address."
|
|
2325
|
+
},
|
|
2326
|
+
"tel": {
|
|
2327
|
+
"anyOf": [
|
|
2328
|
+
{
|
|
2329
|
+
"type": "string",
|
|
2330
|
+
"description": "The telephone number."
|
|
2331
|
+
},
|
|
2332
|
+
{
|
|
2333
|
+
"type": "null"
|
|
2334
|
+
}
|
|
2335
|
+
],
|
|
2336
|
+
"description": "The telephone number."
|
|
2337
|
+
},
|
|
2338
|
+
"mobile": {
|
|
2339
|
+
"anyOf": [
|
|
2340
|
+
{
|
|
2341
|
+
"type": "string",
|
|
2342
|
+
"description": "The mobile phone number."
|
|
2343
|
+
},
|
|
2344
|
+
{
|
|
2345
|
+
"type": "null"
|
|
2346
|
+
}
|
|
2347
|
+
],
|
|
2348
|
+
"description": "The mobile phone number."
|
|
2349
|
+
},
|
|
2350
|
+
"exchangeDate": {
|
|
2351
|
+
"anyOf": [
|
|
2352
|
+
{
|
|
2353
|
+
"type": "string",
|
|
2354
|
+
"description": "The business card exchange date."
|
|
2355
|
+
},
|
|
2356
|
+
{
|
|
2357
|
+
"type": "null"
|
|
2358
|
+
}
|
|
2359
|
+
],
|
|
2360
|
+
"description": "The business card exchange date."
|
|
2361
|
+
},
|
|
2362
|
+
"registeredTime": {
|
|
2363
|
+
"anyOf": [
|
|
2364
|
+
{
|
|
2365
|
+
"type": "string",
|
|
2366
|
+
"description": "The registration timestamp."
|
|
2367
|
+
},
|
|
2368
|
+
{
|
|
2369
|
+
"type": "null"
|
|
2370
|
+
}
|
|
2371
|
+
],
|
|
2372
|
+
"description": "The registration timestamp."
|
|
2373
|
+
},
|
|
2374
|
+
"updatedTime": {
|
|
2375
|
+
"anyOf": [
|
|
2376
|
+
{
|
|
2377
|
+
"type": "string",
|
|
2378
|
+
"description": "The last update timestamp."
|
|
2379
|
+
},
|
|
2380
|
+
{
|
|
2381
|
+
"type": "null"
|
|
2382
|
+
}
|
|
2383
|
+
],
|
|
2384
|
+
"description": "The last update timestamp."
|
|
2385
|
+
},
|
|
2386
|
+
"entryStatus": {
|
|
2387
|
+
"anyOf": [
|
|
2388
|
+
{
|
|
2389
|
+
"type": "string",
|
|
2390
|
+
"description": "The digitization status."
|
|
2391
|
+
},
|
|
2392
|
+
{
|
|
2393
|
+
"type": "null"
|
|
2394
|
+
}
|
|
2395
|
+
],
|
|
2396
|
+
"description": "The digitization status."
|
|
2397
|
+
},
|
|
2398
|
+
"owner": {
|
|
2399
|
+
"type": "object",
|
|
2400
|
+
"properties": {
|
|
2401
|
+
"id": {
|
|
2402
|
+
"type": "string",
|
|
2403
|
+
"description": "The owner user ID."
|
|
2404
|
+
},
|
|
2405
|
+
"name": {
|
|
2406
|
+
"type": "string",
|
|
2407
|
+
"description": "The owner name."
|
|
2408
|
+
},
|
|
2409
|
+
"email": {
|
|
2410
|
+
"type": "string",
|
|
2411
|
+
"description": "The owner email address."
|
|
2412
|
+
}
|
|
2413
|
+
},
|
|
2414
|
+
"additionalProperties": true,
|
|
2415
|
+
"description": "The business card or tag owner."
|
|
2416
|
+
},
|
|
2417
|
+
"tags": {
|
|
2418
|
+
"type": "array",
|
|
2419
|
+
"items": {
|
|
2420
|
+
"type": "object",
|
|
2421
|
+
"properties": {
|
|
2422
|
+
"id": {
|
|
2423
|
+
"type": "string",
|
|
2424
|
+
"description": "The tag ID."
|
|
2425
|
+
},
|
|
2426
|
+
"name": {
|
|
2427
|
+
"type": "string",
|
|
2428
|
+
"description": "The tag name."
|
|
2429
|
+
},
|
|
2430
|
+
"type": {
|
|
2431
|
+
"type": "string",
|
|
2432
|
+
"description": "The tag visibility: private, public, or shared."
|
|
2433
|
+
},
|
|
2434
|
+
"owner": {
|
|
2435
|
+
"type": "object",
|
|
2436
|
+
"properties": {
|
|
2437
|
+
"id": {
|
|
2438
|
+
"type": "string",
|
|
2439
|
+
"description": "The owner user ID."
|
|
2440
|
+
},
|
|
2441
|
+
"name": {
|
|
2442
|
+
"type": "string",
|
|
2443
|
+
"description": "The owner name."
|
|
2444
|
+
},
|
|
2445
|
+
"email": {
|
|
2446
|
+
"type": "string",
|
|
2447
|
+
"description": "The owner email address."
|
|
2448
|
+
}
|
|
2449
|
+
},
|
|
2450
|
+
"additionalProperties": true,
|
|
2451
|
+
"description": "The business card or tag owner."
|
|
2452
|
+
}
|
|
2453
|
+
},
|
|
2454
|
+
"additionalProperties": true,
|
|
2455
|
+
"description": "A Sansan tag, with additional upstream fields preserved."
|
|
2456
|
+
},
|
|
2457
|
+
"description": "Tags attached to the business card when requested."
|
|
2458
|
+
}
|
|
2459
|
+
},
|
|
2460
|
+
"additionalProperties": true,
|
|
2461
|
+
"description": "A business card with contact details; additional Sansan fields are preserved."
|
|
2462
|
+
}
|
|
2463
|
+
},
|
|
2464
|
+
{
|
|
2465
|
+
"id": "sansan.list_access_control_patterns",
|
|
2466
|
+
"service": "sansan",
|
|
2467
|
+
"name": "list_access_control_patterns",
|
|
2468
|
+
"description": "List access control patterns, optionally filtering by a name substring. System administrator only.",
|
|
2469
|
+
"operationType": "read",
|
|
2470
|
+
"requiredScopes": [],
|
|
2471
|
+
"providerPermissions": [],
|
|
2472
|
+
"inputSchema": {
|
|
2473
|
+
"type": "object",
|
|
2474
|
+
"properties": {
|
|
2475
|
+
"nextPageToken": {
|
|
2476
|
+
"type": "string",
|
|
2477
|
+
"minLength": 1,
|
|
2478
|
+
"description": "Continue with the next page token; original filters are inherited."
|
|
2479
|
+
},
|
|
2480
|
+
"name": {
|
|
2481
|
+
"type": "string",
|
|
2482
|
+
"description": "Pattern name substring."
|
|
2483
|
+
}
|
|
2484
|
+
},
|
|
2485
|
+
"additionalProperties": false,
|
|
2486
|
+
"description": "Access control pattern search."
|
|
2487
|
+
},
|
|
2488
|
+
"outputSchema": {
|
|
2489
|
+
"type": "object",
|
|
2490
|
+
"properties": {
|
|
2491
|
+
"data": {
|
|
2492
|
+
"type": "array",
|
|
2493
|
+
"items": {
|
|
2494
|
+
"type": "object",
|
|
2495
|
+
"properties": {
|
|
2496
|
+
"aclPatternId": {
|
|
2497
|
+
"type": "string",
|
|
2498
|
+
"minLength": 1,
|
|
2499
|
+
"description": "The access control pattern ID."
|
|
2500
|
+
},
|
|
2501
|
+
"aclPatternName": {
|
|
2502
|
+
"type": "string",
|
|
2503
|
+
"minLength": 1,
|
|
2504
|
+
"description": "Access control pattern name."
|
|
2505
|
+
},
|
|
2506
|
+
"description": {
|
|
2507
|
+
"type": "string",
|
|
2508
|
+
"description": "Access control pattern description."
|
|
2509
|
+
},
|
|
2510
|
+
"details": {
|
|
2511
|
+
"type": "array",
|
|
2512
|
+
"items": {
|
|
2513
|
+
"type": "object",
|
|
2514
|
+
"properties": {
|
|
2515
|
+
"objectDepartmentId": {
|
|
2516
|
+
"type": "string",
|
|
2517
|
+
"minLength": 1,
|
|
2518
|
+
"description": "The department whose data this rule covers."
|
|
2519
|
+
},
|
|
2520
|
+
"accessibleFieldsSettingsName": {
|
|
2521
|
+
"type": "string",
|
|
2522
|
+
"minLength": 1,
|
|
2523
|
+
"description": "The upstream accessible-fields setting name, such as ALL. Use values configured in Sansan; no complete enum is published."
|
|
2524
|
+
}
|
|
2525
|
+
},
|
|
2526
|
+
"additionalProperties": true,
|
|
2527
|
+
"required": [
|
|
2528
|
+
"objectDepartmentId",
|
|
2529
|
+
"accessibleFieldsSettingsName"
|
|
2530
|
+
],
|
|
2531
|
+
"description": "Access rule for a target department; additional provider-defined fields are accepted."
|
|
2532
|
+
},
|
|
2533
|
+
"description": "Department access rules."
|
|
2534
|
+
},
|
|
2535
|
+
"isInUse": {
|
|
2536
|
+
"type": "boolean",
|
|
2537
|
+
"description": "Whether this pattern is in use."
|
|
2538
|
+
}
|
|
2539
|
+
},
|
|
2540
|
+
"additionalProperties": true,
|
|
2541
|
+
"description": "A Sansan access control pattern, including upstream-defined fields."
|
|
2542
|
+
},
|
|
2543
|
+
"description": "Records in this page."
|
|
2544
|
+
},
|
|
2545
|
+
"hasMore": {
|
|
2546
|
+
"type": "boolean",
|
|
2547
|
+
"description": "Whether another page is available."
|
|
2548
|
+
},
|
|
2549
|
+
"nextPageToken": {
|
|
2550
|
+
"anyOf": [
|
|
2551
|
+
{
|
|
2552
|
+
"type": "string",
|
|
2553
|
+
"description": "The next page token, or null."
|
|
2554
|
+
},
|
|
2555
|
+
{
|
|
2556
|
+
"type": "null"
|
|
2557
|
+
}
|
|
2558
|
+
],
|
|
2559
|
+
"description": "The next page token, or null."
|
|
2560
|
+
}
|
|
2561
|
+
},
|
|
2562
|
+
"additionalProperties": true,
|
|
2563
|
+
"required": [
|
|
2564
|
+
"data",
|
|
2565
|
+
"hasMore",
|
|
2566
|
+
"nextPageToken"
|
|
2567
|
+
],
|
|
2568
|
+
"description": "A page of administration records."
|
|
2569
|
+
}
|
|
2570
|
+
},
|
|
2571
|
+
{
|
|
2572
|
+
"id": "sansan.list_business_card_tags",
|
|
2573
|
+
"service": "sansan",
|
|
2574
|
+
"name": "list_business_card_tags",
|
|
2575
|
+
"description": "List tags attached to a Sansan business card.",
|
|
2576
|
+
"operationType": "read",
|
|
2577
|
+
"requiredScopes": [],
|
|
2578
|
+
"providerPermissions": [],
|
|
2579
|
+
"inputSchema": {
|
|
2580
|
+
"type": "object",
|
|
2581
|
+
"properties": {
|
|
2582
|
+
"businessCardId": {
|
|
2583
|
+
"type": "string",
|
|
2584
|
+
"minLength": 1,
|
|
2585
|
+
"description": "The Sansan business card ID."
|
|
2586
|
+
},
|
|
2587
|
+
"nextPageToken": {
|
|
2588
|
+
"type": "string",
|
|
2589
|
+
"minLength": 1,
|
|
2590
|
+
"description": "Continue a previous query using its nextPageToken; original query parameters are inherited."
|
|
2591
|
+
},
|
|
2592
|
+
"limit": {
|
|
2593
|
+
"type": "integer",
|
|
2594
|
+
"minimum": 1,
|
|
2595
|
+
"maximum": 300,
|
|
2596
|
+
"description": "Maximum records per page, from 1 to 300; defaults to 100."
|
|
2597
|
+
}
|
|
2598
|
+
},
|
|
2599
|
+
"additionalProperties": false,
|
|
2600
|
+
"required": [
|
|
2601
|
+
"businessCardId"
|
|
2602
|
+
],
|
|
2603
|
+
"description": "Business card tag query."
|
|
2604
|
+
},
|
|
2605
|
+
"outputSchema": {
|
|
2606
|
+
"type": "object",
|
|
2607
|
+
"properties": {
|
|
2608
|
+
"data": {
|
|
2609
|
+
"type": "array",
|
|
2610
|
+
"items": {
|
|
2611
|
+
"type": "object",
|
|
2612
|
+
"properties": {
|
|
2613
|
+
"id": {
|
|
2614
|
+
"type": "string",
|
|
2615
|
+
"description": "The tag ID."
|
|
2616
|
+
},
|
|
2617
|
+
"name": {
|
|
2618
|
+
"type": "string",
|
|
2619
|
+
"description": "The tag name."
|
|
2620
|
+
},
|
|
2621
|
+
"type": {
|
|
2622
|
+
"type": "string",
|
|
2623
|
+
"description": "The tag visibility: private, public, or shared."
|
|
2624
|
+
},
|
|
2625
|
+
"owner": {
|
|
2626
|
+
"type": "object",
|
|
2627
|
+
"properties": {
|
|
2628
|
+
"id": {
|
|
2629
|
+
"type": "string",
|
|
2630
|
+
"description": "The owner user ID."
|
|
2631
|
+
},
|
|
2632
|
+
"name": {
|
|
2633
|
+
"type": "string",
|
|
2634
|
+
"description": "The owner name."
|
|
2635
|
+
},
|
|
2636
|
+
"email": {
|
|
2637
|
+
"type": "string",
|
|
2638
|
+
"description": "The owner email address."
|
|
2639
|
+
}
|
|
2640
|
+
},
|
|
2641
|
+
"additionalProperties": true,
|
|
2642
|
+
"description": "The business card or tag owner."
|
|
2643
|
+
}
|
|
2644
|
+
},
|
|
2645
|
+
"additionalProperties": true,
|
|
2646
|
+
"description": "A Sansan tag, with additional upstream fields preserved."
|
|
2647
|
+
},
|
|
2648
|
+
"description": "Records in this page."
|
|
2649
|
+
},
|
|
2650
|
+
"hasMore": {
|
|
2651
|
+
"type": "boolean",
|
|
2652
|
+
"description": "Whether another page is available."
|
|
2653
|
+
},
|
|
2654
|
+
"nextPageToken": {
|
|
2655
|
+
"anyOf": [
|
|
2656
|
+
{
|
|
2657
|
+
"type": "string",
|
|
2658
|
+
"description": "The next page token, or null when absent. Tokens expire six hours after the first request."
|
|
2659
|
+
},
|
|
2660
|
+
{
|
|
2661
|
+
"type": "null"
|
|
2662
|
+
}
|
|
2663
|
+
],
|
|
2664
|
+
"description": "The next page token, or null when absent. Tokens expire six hours after the first request."
|
|
2665
|
+
}
|
|
2666
|
+
},
|
|
2667
|
+
"additionalProperties": true,
|
|
2668
|
+
"required": [
|
|
2669
|
+
"data",
|
|
2670
|
+
"hasMore",
|
|
2671
|
+
"nextPageToken"
|
|
2672
|
+
],
|
|
2673
|
+
"description": "One page of Sansan records."
|
|
2674
|
+
}
|
|
2675
|
+
},
|
|
2676
|
+
{
|
|
2677
|
+
"id": "sansan.list_business_cards",
|
|
2678
|
+
"service": "sansan",
|
|
2679
|
+
"name": "list_business_cards",
|
|
2680
|
+
"description": "List business cards updated within a time interval, with optional historical cards and tags. Use nextPageToken to continue.",
|
|
2681
|
+
"operationType": "read",
|
|
2682
|
+
"requiredScopes": [],
|
|
2683
|
+
"providerPermissions": [],
|
|
2684
|
+
"inputSchema": {
|
|
2685
|
+
"type": "object",
|
|
2686
|
+
"properties": {
|
|
2687
|
+
"nextPageToken": {
|
|
2688
|
+
"type": "string",
|
|
2689
|
+
"minLength": 1,
|
|
2690
|
+
"description": "Continue a previous query using its nextPageToken; original query parameters are inherited."
|
|
2691
|
+
},
|
|
2692
|
+
"limit": {
|
|
2693
|
+
"type": "integer",
|
|
2694
|
+
"minimum": 1,
|
|
2695
|
+
"maximum": 300,
|
|
2696
|
+
"description": "Maximum records per page, from 1 to 300; defaults to 100."
|
|
2697
|
+
},
|
|
2698
|
+
"range": {
|
|
2699
|
+
"type": "string",
|
|
2700
|
+
"enum": [
|
|
2701
|
+
"me",
|
|
2702
|
+
"all"
|
|
2703
|
+
],
|
|
2704
|
+
"description": "Record ownership scope: me or all accessible records; defaults to me."
|
|
2705
|
+
},
|
|
2706
|
+
"includeTags": {
|
|
2707
|
+
"type": "boolean",
|
|
2708
|
+
"description": "Include attached tags and treat tag changes as business card updates."
|
|
2709
|
+
},
|
|
2710
|
+
"includePastBizCards": {
|
|
2711
|
+
"type": "boolean",
|
|
2712
|
+
"description": "Include older business cards for merged persons; defaults to false."
|
|
2713
|
+
},
|
|
2714
|
+
"entryStatus": {
|
|
2715
|
+
"type": "array",
|
|
2716
|
+
"items": {
|
|
2717
|
+
"type": "string",
|
|
2718
|
+
"enum": [
|
|
2719
|
+
"processing",
|
|
2720
|
+
"completed",
|
|
2721
|
+
"unreadable"
|
|
2722
|
+
],
|
|
2723
|
+
"description": "A business card digitization status."
|
|
2724
|
+
},
|
|
2725
|
+
"description": "Digitization statuses to include; defaults to completed."
|
|
2726
|
+
},
|
|
2727
|
+
"orderBy": {
|
|
2728
|
+
"type": "string",
|
|
2729
|
+
"enum": [
|
|
2730
|
+
"registeredAt",
|
|
2731
|
+
"completedAt",
|
|
2732
|
+
"updatedAt"
|
|
2733
|
+
],
|
|
2734
|
+
"description": "Sort field; defaults to updatedAt for listing and registeredAt for searching."
|
|
2735
|
+
},
|
|
2736
|
+
"orderDirection": {
|
|
2737
|
+
"type": "string",
|
|
2738
|
+
"enum": [
|
|
2739
|
+
"asc",
|
|
2740
|
+
"desc"
|
|
2741
|
+
],
|
|
2742
|
+
"description": "Sort direction; defaults to asc for listing and desc for searching."
|
|
2743
|
+
},
|
|
2744
|
+
"updatedFrom": {
|
|
2745
|
+
"type": "string",
|
|
2746
|
+
"description": "Start of the update interval as an ISO 8601 timestamp with timezone. Required on the first page.",
|
|
2747
|
+
"format": "date-time"
|
|
2748
|
+
},
|
|
2749
|
+
"updatedTo": {
|
|
2750
|
+
"type": "string",
|
|
2751
|
+
"description": "End of the update interval as an ISO 8601 timestamp with timezone. Required on the first page.",
|
|
2752
|
+
"format": "date-time"
|
|
2753
|
+
}
|
|
2754
|
+
},
|
|
2755
|
+
"additionalProperties": false,
|
|
2756
|
+
"description": "Business card update query.",
|
|
2757
|
+
"anyOf": [
|
|
2758
|
+
{
|
|
2759
|
+
"required": [
|
|
2760
|
+
"nextPageToken"
|
|
2761
|
+
]
|
|
2762
|
+
},
|
|
2763
|
+
{
|
|
2764
|
+
"required": [
|
|
2765
|
+
"updatedFrom",
|
|
2766
|
+
"updatedTo"
|
|
2767
|
+
]
|
|
2768
|
+
}
|
|
2769
|
+
]
|
|
2770
|
+
},
|
|
2771
|
+
"outputSchema": {
|
|
2772
|
+
"type": "object",
|
|
2773
|
+
"properties": {
|
|
2774
|
+
"data": {
|
|
2775
|
+
"type": "array",
|
|
2776
|
+
"items": {
|
|
2777
|
+
"type": "object",
|
|
2778
|
+
"properties": {
|
|
2779
|
+
"id": {
|
|
2780
|
+
"anyOf": [
|
|
2781
|
+
{
|
|
2782
|
+
"type": "string",
|
|
2783
|
+
"description": "The business card ID."
|
|
2784
|
+
},
|
|
2785
|
+
{
|
|
2786
|
+
"type": "null"
|
|
2787
|
+
}
|
|
2788
|
+
],
|
|
2789
|
+
"description": "The business card ID."
|
|
2790
|
+
},
|
|
2791
|
+
"companyId": {
|
|
2792
|
+
"anyOf": [
|
|
2793
|
+
{
|
|
2794
|
+
"type": "string",
|
|
2795
|
+
"description": "The company ID."
|
|
2796
|
+
},
|
|
2797
|
+
{
|
|
2798
|
+
"type": "null"
|
|
2799
|
+
}
|
|
2800
|
+
],
|
|
2801
|
+
"description": "The company ID."
|
|
2802
|
+
},
|
|
2803
|
+
"personId": {
|
|
2804
|
+
"anyOf": [
|
|
2805
|
+
{
|
|
2806
|
+
"type": "string",
|
|
2807
|
+
"description": "The person ID."
|
|
2808
|
+
},
|
|
2809
|
+
{
|
|
2810
|
+
"type": "null"
|
|
2811
|
+
}
|
|
2812
|
+
],
|
|
2813
|
+
"description": "The person ID."
|
|
2814
|
+
},
|
|
2815
|
+
"firstName": {
|
|
2816
|
+
"anyOf": [
|
|
2817
|
+
{
|
|
2818
|
+
"type": "string",
|
|
2819
|
+
"description": "The first name."
|
|
2820
|
+
},
|
|
2821
|
+
{
|
|
2822
|
+
"type": "null"
|
|
2823
|
+
}
|
|
2824
|
+
],
|
|
2825
|
+
"description": "The first name."
|
|
2826
|
+
},
|
|
2827
|
+
"lastName": {
|
|
2828
|
+
"anyOf": [
|
|
2829
|
+
{
|
|
2830
|
+
"type": "string",
|
|
2831
|
+
"description": "The last name."
|
|
2832
|
+
},
|
|
2833
|
+
{
|
|
2834
|
+
"type": "null"
|
|
2835
|
+
}
|
|
2836
|
+
],
|
|
2837
|
+
"description": "The last name."
|
|
2838
|
+
},
|
|
2839
|
+
"companyName": {
|
|
2840
|
+
"anyOf": [
|
|
2841
|
+
{
|
|
2842
|
+
"type": "string",
|
|
2843
|
+
"description": "The company name."
|
|
2844
|
+
},
|
|
2845
|
+
{
|
|
2846
|
+
"type": "null"
|
|
2847
|
+
}
|
|
2848
|
+
],
|
|
2849
|
+
"description": "The company name."
|
|
2850
|
+
},
|
|
2851
|
+
"departmentName": {
|
|
2852
|
+
"anyOf": [
|
|
2853
|
+
{
|
|
2854
|
+
"type": "string",
|
|
2855
|
+
"description": "The department name."
|
|
2856
|
+
},
|
|
2857
|
+
{
|
|
2858
|
+
"type": "null"
|
|
2859
|
+
}
|
|
2860
|
+
],
|
|
2861
|
+
"description": "The department name."
|
|
2862
|
+
},
|
|
2863
|
+
"title": {
|
|
2864
|
+
"anyOf": [
|
|
2865
|
+
{
|
|
2866
|
+
"type": "string",
|
|
2867
|
+
"description": "The job title."
|
|
2868
|
+
},
|
|
2869
|
+
{
|
|
2870
|
+
"type": "null"
|
|
2871
|
+
}
|
|
2872
|
+
],
|
|
2873
|
+
"description": "The job title."
|
|
2874
|
+
},
|
|
2875
|
+
"email": {
|
|
2876
|
+
"anyOf": [
|
|
2877
|
+
{
|
|
2878
|
+
"type": "string",
|
|
2879
|
+
"description": "The email address."
|
|
2880
|
+
},
|
|
2881
|
+
{
|
|
2882
|
+
"type": "null"
|
|
2883
|
+
}
|
|
2884
|
+
],
|
|
2885
|
+
"description": "The email address."
|
|
2886
|
+
},
|
|
2887
|
+
"tel": {
|
|
2888
|
+
"anyOf": [
|
|
2889
|
+
{
|
|
2890
|
+
"type": "string",
|
|
2891
|
+
"description": "The telephone number."
|
|
2892
|
+
},
|
|
2893
|
+
{
|
|
2894
|
+
"type": "null"
|
|
2895
|
+
}
|
|
2896
|
+
],
|
|
2897
|
+
"description": "The telephone number."
|
|
2898
|
+
},
|
|
2899
|
+
"mobile": {
|
|
2900
|
+
"anyOf": [
|
|
2901
|
+
{
|
|
2902
|
+
"type": "string",
|
|
2903
|
+
"description": "The mobile phone number."
|
|
2904
|
+
},
|
|
2905
|
+
{
|
|
2906
|
+
"type": "null"
|
|
2907
|
+
}
|
|
2908
|
+
],
|
|
2909
|
+
"description": "The mobile phone number."
|
|
2910
|
+
},
|
|
2911
|
+
"exchangeDate": {
|
|
2912
|
+
"anyOf": [
|
|
2913
|
+
{
|
|
2914
|
+
"type": "string",
|
|
2915
|
+
"description": "The business card exchange date."
|
|
2916
|
+
},
|
|
2917
|
+
{
|
|
2918
|
+
"type": "null"
|
|
2919
|
+
}
|
|
2920
|
+
],
|
|
2921
|
+
"description": "The business card exchange date."
|
|
2922
|
+
},
|
|
2923
|
+
"registeredTime": {
|
|
2924
|
+
"anyOf": [
|
|
2925
|
+
{
|
|
2926
|
+
"type": "string",
|
|
2927
|
+
"description": "The registration timestamp."
|
|
2928
|
+
},
|
|
2929
|
+
{
|
|
2930
|
+
"type": "null"
|
|
2931
|
+
}
|
|
2932
|
+
],
|
|
2933
|
+
"description": "The registration timestamp."
|
|
2934
|
+
},
|
|
2935
|
+
"updatedTime": {
|
|
2936
|
+
"anyOf": [
|
|
2937
|
+
{
|
|
2938
|
+
"type": "string",
|
|
2939
|
+
"description": "The last update timestamp."
|
|
2940
|
+
},
|
|
2941
|
+
{
|
|
2942
|
+
"type": "null"
|
|
2943
|
+
}
|
|
2944
|
+
],
|
|
2945
|
+
"description": "The last update timestamp."
|
|
2946
|
+
},
|
|
2947
|
+
"entryStatus": {
|
|
2948
|
+
"anyOf": [
|
|
2949
|
+
{
|
|
2950
|
+
"type": "string",
|
|
2951
|
+
"description": "The digitization status."
|
|
2952
|
+
},
|
|
2953
|
+
{
|
|
2954
|
+
"type": "null"
|
|
2955
|
+
}
|
|
2956
|
+
],
|
|
2957
|
+
"description": "The digitization status."
|
|
2958
|
+
},
|
|
2959
|
+
"owner": {
|
|
2960
|
+
"type": "object",
|
|
2961
|
+
"properties": {
|
|
2962
|
+
"id": {
|
|
2963
|
+
"type": "string",
|
|
2964
|
+
"description": "The owner user ID."
|
|
2965
|
+
},
|
|
2966
|
+
"name": {
|
|
2967
|
+
"type": "string",
|
|
2968
|
+
"description": "The owner name."
|
|
2969
|
+
},
|
|
2970
|
+
"email": {
|
|
2971
|
+
"type": "string",
|
|
2972
|
+
"description": "The owner email address."
|
|
2973
|
+
}
|
|
2974
|
+
},
|
|
2975
|
+
"additionalProperties": true,
|
|
2976
|
+
"description": "The business card or tag owner."
|
|
2977
|
+
},
|
|
2978
|
+
"tags": {
|
|
2979
|
+
"type": "array",
|
|
2980
|
+
"items": {
|
|
2981
|
+
"type": "object",
|
|
2982
|
+
"properties": {
|
|
2983
|
+
"id": {
|
|
2984
|
+
"type": "string",
|
|
2985
|
+
"description": "The tag ID."
|
|
2986
|
+
},
|
|
2987
|
+
"name": {
|
|
2988
|
+
"type": "string",
|
|
2989
|
+
"description": "The tag name."
|
|
2990
|
+
},
|
|
2991
|
+
"type": {
|
|
2992
|
+
"type": "string",
|
|
2993
|
+
"description": "The tag visibility: private, public, or shared."
|
|
2994
|
+
},
|
|
2995
|
+
"owner": {
|
|
2996
|
+
"type": "object",
|
|
2997
|
+
"properties": {
|
|
2998
|
+
"id": {
|
|
2999
|
+
"type": "string",
|
|
3000
|
+
"description": "The owner user ID."
|
|
3001
|
+
},
|
|
3002
|
+
"name": {
|
|
3003
|
+
"type": "string",
|
|
3004
|
+
"description": "The owner name."
|
|
3005
|
+
},
|
|
3006
|
+
"email": {
|
|
3007
|
+
"type": "string",
|
|
3008
|
+
"description": "The owner email address."
|
|
3009
|
+
}
|
|
3010
|
+
},
|
|
3011
|
+
"additionalProperties": true,
|
|
3012
|
+
"description": "The business card or tag owner."
|
|
3013
|
+
}
|
|
3014
|
+
},
|
|
3015
|
+
"additionalProperties": true,
|
|
3016
|
+
"description": "A Sansan tag, with additional upstream fields preserved."
|
|
3017
|
+
},
|
|
3018
|
+
"description": "Tags attached to the business card when requested."
|
|
3019
|
+
}
|
|
3020
|
+
},
|
|
3021
|
+
"additionalProperties": true,
|
|
3022
|
+
"description": "A business card with contact details; additional Sansan fields are preserved."
|
|
3023
|
+
},
|
|
3024
|
+
"description": "Records in this page."
|
|
3025
|
+
},
|
|
3026
|
+
"hasMore": {
|
|
3027
|
+
"type": "boolean",
|
|
3028
|
+
"description": "Whether another page is available."
|
|
3029
|
+
},
|
|
3030
|
+
"nextPageToken": {
|
|
3031
|
+
"anyOf": [
|
|
3032
|
+
{
|
|
3033
|
+
"type": "string",
|
|
3034
|
+
"description": "The next page token, or null when absent. Tokens expire six hours after the first request."
|
|
3035
|
+
},
|
|
3036
|
+
{
|
|
3037
|
+
"type": "null"
|
|
3038
|
+
}
|
|
3039
|
+
],
|
|
3040
|
+
"description": "The next page token, or null when absent. Tokens expire six hours after the first request."
|
|
3041
|
+
}
|
|
3042
|
+
},
|
|
3043
|
+
"additionalProperties": true,
|
|
3044
|
+
"required": [
|
|
3045
|
+
"data",
|
|
3046
|
+
"hasMore",
|
|
3047
|
+
"nextPageToken"
|
|
3048
|
+
],
|
|
3049
|
+
"description": "One page of Sansan records."
|
|
3050
|
+
}
|
|
3051
|
+
},
|
|
3052
|
+
{
|
|
3053
|
+
"id": "sansan.list_contact_reports",
|
|
3054
|
+
"service": "sansan",
|
|
3055
|
+
"name": "list_contact_reports",
|
|
3056
|
+
"description": "List Sansan contact reports updated within a time interval, including meetings, calls, emails, and business card exchanges.",
|
|
3057
|
+
"operationType": "read",
|
|
3058
|
+
"requiredScopes": [],
|
|
3059
|
+
"providerPermissions": [],
|
|
3060
|
+
"inputSchema": {
|
|
3061
|
+
"type": "object",
|
|
3062
|
+
"properties": {
|
|
3063
|
+
"nextPageToken": {
|
|
3064
|
+
"type": "string",
|
|
3065
|
+
"minLength": 1,
|
|
3066
|
+
"description": "Continue a previous query using its nextPageToken; original query parameters are inherited."
|
|
3067
|
+
},
|
|
3068
|
+
"limit": {
|
|
3069
|
+
"type": "integer",
|
|
3070
|
+
"minimum": 1,
|
|
3071
|
+
"maximum": 300,
|
|
3072
|
+
"description": "Maximum records per page, from 1 to 300; defaults to 100."
|
|
3073
|
+
},
|
|
3074
|
+
"updatedFrom": {
|
|
3075
|
+
"type": "string",
|
|
3076
|
+
"description": "Start of the update interval as an ISO 8601 timestamp with timezone. Required on the first page.",
|
|
3077
|
+
"format": "date-time"
|
|
3078
|
+
},
|
|
3079
|
+
"updatedTo": {
|
|
3080
|
+
"type": "string",
|
|
3081
|
+
"description": "End of the update interval as an ISO 8601 timestamp with timezone. Required on the first page.",
|
|
3082
|
+
"format": "date-time"
|
|
3083
|
+
},
|
|
3084
|
+
"range": {
|
|
3085
|
+
"type": "string",
|
|
3086
|
+
"enum": [
|
|
3087
|
+
"me",
|
|
3088
|
+
"all"
|
|
3089
|
+
],
|
|
3090
|
+
"description": "Record ownership scope: me or all accessible records; defaults to me."
|
|
3091
|
+
},
|
|
3092
|
+
"category": {
|
|
3093
|
+
"type": "array",
|
|
3094
|
+
"items": {
|
|
3095
|
+
"type": "string",
|
|
3096
|
+
"description": "A report category."
|
|
3097
|
+
},
|
|
3098
|
+
"description": "Exact category names to include."
|
|
3099
|
+
},
|
|
3100
|
+
"type": {
|
|
3101
|
+
"type": "array",
|
|
3102
|
+
"items": {
|
|
3103
|
+
"type": "string",
|
|
3104
|
+
"enum": [
|
|
3105
|
+
"Meeting",
|
|
3106
|
+
"Call",
|
|
3107
|
+
"Email",
|
|
3108
|
+
"BizCardExchange",
|
|
3109
|
+
"OnlineMeeting"
|
|
3110
|
+
],
|
|
3111
|
+
"description": "A contact report type."
|
|
3112
|
+
},
|
|
3113
|
+
"description": "Contact report types to include."
|
|
3114
|
+
},
|
|
3115
|
+
"orderBy": {
|
|
3116
|
+
"type": "string",
|
|
3117
|
+
"enum": [
|
|
3118
|
+
"registeredAt",
|
|
3119
|
+
"updatedAt"
|
|
3120
|
+
],
|
|
3121
|
+
"description": "Sort field; defaults to updatedAt."
|
|
3122
|
+
},
|
|
3123
|
+
"orderDirection": {
|
|
3124
|
+
"type": "string",
|
|
3125
|
+
"enum": [
|
|
3126
|
+
"asc",
|
|
3127
|
+
"desc"
|
|
3128
|
+
],
|
|
3129
|
+
"description": "Sort direction; defaults to desc."
|
|
3130
|
+
}
|
|
3131
|
+
},
|
|
3132
|
+
"additionalProperties": false,
|
|
3133
|
+
"description": "Contact report query filters.",
|
|
3134
|
+
"anyOf": [
|
|
3135
|
+
{
|
|
3136
|
+
"required": [
|
|
3137
|
+
"nextPageToken"
|
|
3138
|
+
]
|
|
3139
|
+
},
|
|
3140
|
+
{
|
|
3141
|
+
"required": [
|
|
3142
|
+
"updatedFrom",
|
|
3143
|
+
"updatedTo"
|
|
3144
|
+
]
|
|
3145
|
+
}
|
|
3146
|
+
]
|
|
3147
|
+
},
|
|
3148
|
+
"outputSchema": {
|
|
3149
|
+
"type": "object",
|
|
3150
|
+
"properties": {
|
|
3151
|
+
"data": {
|
|
3152
|
+
"type": "array",
|
|
3153
|
+
"items": {
|
|
3154
|
+
"type": "object",
|
|
3155
|
+
"properties": {
|
|
3156
|
+
"id": {
|
|
3157
|
+
"type": "string",
|
|
3158
|
+
"description": "Contact report ID."
|
|
3159
|
+
},
|
|
3160
|
+
"registeredTime": {
|
|
3161
|
+
"type": "string",
|
|
3162
|
+
"description": "Contact report registration timestamp."
|
|
3163
|
+
},
|
|
3164
|
+
"updatedTime": {
|
|
3165
|
+
"type": "string",
|
|
3166
|
+
"description": "Contact report update timestamp."
|
|
3167
|
+
},
|
|
3168
|
+
"startDate": {
|
|
3169
|
+
"type": "string",
|
|
3170
|
+
"description": "Interaction start date."
|
|
3171
|
+
},
|
|
3172
|
+
"endDate": {
|
|
3173
|
+
"type": "string",
|
|
3174
|
+
"description": "Interaction end date."
|
|
3175
|
+
},
|
|
3176
|
+
"startTime": {
|
|
3177
|
+
"type": "string",
|
|
3178
|
+
"description": "Interaction start timestamp."
|
|
3179
|
+
},
|
|
3180
|
+
"endTime": {
|
|
3181
|
+
"type": "string",
|
|
3182
|
+
"description": "Interaction end timestamp."
|
|
3183
|
+
},
|
|
3184
|
+
"type": {
|
|
3185
|
+
"type": "string",
|
|
3186
|
+
"description": "Recorded interaction type."
|
|
3187
|
+
},
|
|
3188
|
+
"title": {
|
|
3189
|
+
"type": "string",
|
|
3190
|
+
"description": "Contact report title."
|
|
3191
|
+
},
|
|
3192
|
+
"location": {
|
|
3193
|
+
"type": "string",
|
|
3194
|
+
"description": "Contact location."
|
|
3195
|
+
},
|
|
3196
|
+
"memo": {
|
|
3197
|
+
"type": "string",
|
|
3198
|
+
"description": "Contact report memo."
|
|
3199
|
+
},
|
|
3200
|
+
"owner": {
|
|
3201
|
+
"type": "object",
|
|
3202
|
+
"properties": {
|
|
3203
|
+
"id": {
|
|
3204
|
+
"type": "string",
|
|
3205
|
+
"description": "The owner user ID."
|
|
3206
|
+
},
|
|
3207
|
+
"name": {
|
|
3208
|
+
"type": "string",
|
|
3209
|
+
"description": "The owner name."
|
|
3210
|
+
},
|
|
3211
|
+
"email": {
|
|
3212
|
+
"type": "string",
|
|
3213
|
+
"description": "The owner email address."
|
|
3214
|
+
}
|
|
3215
|
+
},
|
|
3216
|
+
"additionalProperties": true,
|
|
3217
|
+
"description": "The business card or tag owner."
|
|
3218
|
+
},
|
|
3219
|
+
"externalAttendees": {
|
|
3220
|
+
"type": "array",
|
|
3221
|
+
"items": {
|
|
3222
|
+
"type": "object",
|
|
3223
|
+
"additionalProperties": true,
|
|
3224
|
+
"description": "An external participant with provider-defined contact fields."
|
|
3225
|
+
},
|
|
3226
|
+
"description": "External attendees and their business card and person IDs."
|
|
3227
|
+
},
|
|
3228
|
+
"internalAttendees": {
|
|
3229
|
+
"type": "array",
|
|
3230
|
+
"items": {
|
|
3231
|
+
"type": "object",
|
|
3232
|
+
"additionalProperties": true,
|
|
3233
|
+
"description": "An internal participant with provider-defined user fields."
|
|
3234
|
+
},
|
|
3235
|
+
"description": "Internal attendees and their user details."
|
|
3236
|
+
},
|
|
3237
|
+
"categories": {
|
|
3238
|
+
"type": "array",
|
|
3239
|
+
"items": {
|
|
3240
|
+
"type": "object",
|
|
3241
|
+
"additionalProperties": true,
|
|
3242
|
+
"description": "A category name and value."
|
|
3243
|
+
},
|
|
3244
|
+
"description": "Categories assigned to the contact report."
|
|
3245
|
+
}
|
|
3246
|
+
},
|
|
3247
|
+
"additionalProperties": true,
|
|
3248
|
+
"description": "A contact report with meeting or communication details and additional upstream fields."
|
|
3249
|
+
},
|
|
3250
|
+
"description": "Records in this page."
|
|
3251
|
+
},
|
|
3252
|
+
"hasMore": {
|
|
3253
|
+
"type": "boolean",
|
|
3254
|
+
"description": "Whether another page is available."
|
|
3255
|
+
},
|
|
3256
|
+
"nextPageToken": {
|
|
3257
|
+
"anyOf": [
|
|
3258
|
+
{
|
|
3259
|
+
"type": "string",
|
|
3260
|
+
"description": "The next page token, or null when absent. Tokens expire six hours after the first request."
|
|
3261
|
+
},
|
|
3262
|
+
{
|
|
3263
|
+
"type": "null"
|
|
3264
|
+
}
|
|
3265
|
+
],
|
|
3266
|
+
"description": "The next page token, or null when absent. Tokens expire six hours after the first request."
|
|
3267
|
+
}
|
|
3268
|
+
},
|
|
3269
|
+
"additionalProperties": true,
|
|
3270
|
+
"required": [
|
|
3271
|
+
"data",
|
|
3272
|
+
"hasMore",
|
|
3273
|
+
"nextPageToken"
|
|
3274
|
+
],
|
|
3275
|
+
"description": "One page of Sansan records."
|
|
3276
|
+
}
|
|
3277
|
+
},
|
|
3278
|
+
{
|
|
3279
|
+
"id": "sansan.list_departments",
|
|
3280
|
+
"service": "sansan",
|
|
3281
|
+
"name": "list_departments",
|
|
3282
|
+
"description": "List administrative department IDs, names, and parents. System administrator only.",
|
|
3283
|
+
"operationType": "read",
|
|
3284
|
+
"requiredScopes": [],
|
|
3285
|
+
"providerPermissions": [],
|
|
3286
|
+
"inputSchema": {
|
|
3287
|
+
"type": "object",
|
|
3288
|
+
"properties": {
|
|
3289
|
+
"nextPageToken": {
|
|
3290
|
+
"type": "string",
|
|
3291
|
+
"minLength": 1,
|
|
3292
|
+
"description": "Continue with the next page token; original filters are inherited."
|
|
3293
|
+
}
|
|
3294
|
+
},
|
|
3295
|
+
"additionalProperties": false,
|
|
3296
|
+
"description": "Department pagination."
|
|
3297
|
+
},
|
|
3298
|
+
"outputSchema": {
|
|
3299
|
+
"type": "object",
|
|
3300
|
+
"properties": {
|
|
3301
|
+
"data": {
|
|
3302
|
+
"type": "array",
|
|
3303
|
+
"items": {
|
|
3304
|
+
"type": "object",
|
|
3305
|
+
"properties": {
|
|
3306
|
+
"id": {
|
|
3307
|
+
"type": "string",
|
|
3308
|
+
"minLength": 1,
|
|
3309
|
+
"description": "The department ID."
|
|
3310
|
+
},
|
|
3311
|
+
"name": {
|
|
3312
|
+
"type": "string",
|
|
3313
|
+
"description": "Department name."
|
|
3314
|
+
},
|
|
3315
|
+
"parentId": {
|
|
3316
|
+
"anyOf": [
|
|
3317
|
+
{
|
|
3318
|
+
"type": "string",
|
|
3319
|
+
"description": "Parent department ID."
|
|
3320
|
+
},
|
|
3321
|
+
{
|
|
3322
|
+
"type": "null"
|
|
3323
|
+
}
|
|
3324
|
+
],
|
|
3325
|
+
"description": "Parent department ID."
|
|
3326
|
+
}
|
|
3327
|
+
},
|
|
3328
|
+
"additionalProperties": true,
|
|
3329
|
+
"description": "An administrative department."
|
|
3330
|
+
},
|
|
3331
|
+
"description": "Records in this page."
|
|
3332
|
+
},
|
|
3333
|
+
"hasMore": {
|
|
3334
|
+
"type": "boolean",
|
|
3335
|
+
"description": "Whether another page is available."
|
|
3336
|
+
},
|
|
3337
|
+
"nextPageToken": {
|
|
3338
|
+
"anyOf": [
|
|
3339
|
+
{
|
|
3340
|
+
"type": "string",
|
|
3341
|
+
"description": "The next page token, or null."
|
|
3342
|
+
},
|
|
3343
|
+
{
|
|
3344
|
+
"type": "null"
|
|
3345
|
+
}
|
|
3346
|
+
],
|
|
3347
|
+
"description": "The next page token, or null."
|
|
3348
|
+
}
|
|
3349
|
+
},
|
|
3350
|
+
"additionalProperties": true,
|
|
3351
|
+
"required": [
|
|
3352
|
+
"data",
|
|
3353
|
+
"hasMore",
|
|
3354
|
+
"nextPageToken"
|
|
3355
|
+
],
|
|
3356
|
+
"description": "A page of administration records."
|
|
3357
|
+
}
|
|
3358
|
+
},
|
|
3359
|
+
{
|
|
3360
|
+
"id": "sansan.list_tags",
|
|
3361
|
+
"service": "sansan",
|
|
3362
|
+
"name": "list_tags",
|
|
3363
|
+
"description": "List Sansan tags by ownership, visibility, owner user, and tag name.",
|
|
3364
|
+
"operationType": "read",
|
|
3365
|
+
"requiredScopes": [],
|
|
3366
|
+
"providerPermissions": [],
|
|
3367
|
+
"inputSchema": {
|
|
3368
|
+
"type": "object",
|
|
3369
|
+
"properties": {
|
|
3370
|
+
"nextPageToken": {
|
|
3371
|
+
"type": "string",
|
|
3372
|
+
"minLength": 1,
|
|
3373
|
+
"description": "Continue a previous query using its nextPageToken; original query parameters are inherited."
|
|
3374
|
+
},
|
|
3375
|
+
"limit": {
|
|
3376
|
+
"type": "integer",
|
|
3377
|
+
"minimum": 1,
|
|
3378
|
+
"maximum": 300,
|
|
3379
|
+
"description": "Maximum records per page, from 1 to 300; defaults to 100."
|
|
3380
|
+
},
|
|
3381
|
+
"range": {
|
|
3382
|
+
"type": "string",
|
|
3383
|
+
"enum": [
|
|
3384
|
+
"me",
|
|
3385
|
+
"all"
|
|
3386
|
+
],
|
|
3387
|
+
"description": "Record ownership scope: me or all accessible records; defaults to me."
|
|
3388
|
+
},
|
|
3389
|
+
"type": {
|
|
3390
|
+
"type": "array",
|
|
3391
|
+
"items": {
|
|
3392
|
+
"type": "string",
|
|
3393
|
+
"enum": [
|
|
3394
|
+
"private",
|
|
3395
|
+
"public",
|
|
3396
|
+
"shared"
|
|
3397
|
+
],
|
|
3398
|
+
"description": "A tag visibility type."
|
|
3399
|
+
},
|
|
3400
|
+
"description": "Tag visibility types to include."
|
|
3401
|
+
},
|
|
3402
|
+
"ownerUserId": {
|
|
3403
|
+
"type": "string",
|
|
3404
|
+
"maxLength": 20,
|
|
3405
|
+
"description": "Tag owner user ID, effective only when range is all."
|
|
3406
|
+
},
|
|
3407
|
+
"tagName": {
|
|
3408
|
+
"type": "string",
|
|
3409
|
+
"maxLength": 50,
|
|
3410
|
+
"description": "Tag name substring."
|
|
3411
|
+
}
|
|
3412
|
+
},
|
|
3413
|
+
"additionalProperties": false,
|
|
3414
|
+
"description": "Tag query filters."
|
|
3415
|
+
},
|
|
3416
|
+
"outputSchema": {
|
|
3417
|
+
"type": "object",
|
|
3418
|
+
"properties": {
|
|
3419
|
+
"data": {
|
|
3420
|
+
"type": "array",
|
|
3421
|
+
"items": {
|
|
3422
|
+
"type": "object",
|
|
3423
|
+
"properties": {
|
|
3424
|
+
"id": {
|
|
3425
|
+
"type": "string",
|
|
3426
|
+
"description": "The tag ID."
|
|
3427
|
+
},
|
|
3428
|
+
"name": {
|
|
3429
|
+
"type": "string",
|
|
3430
|
+
"description": "The tag name."
|
|
3431
|
+
},
|
|
3432
|
+
"type": {
|
|
3433
|
+
"type": "string",
|
|
3434
|
+
"description": "The tag visibility: private, public, or shared."
|
|
3435
|
+
},
|
|
3436
|
+
"owner": {
|
|
3437
|
+
"type": "object",
|
|
3438
|
+
"properties": {
|
|
3439
|
+
"id": {
|
|
3440
|
+
"type": "string",
|
|
3441
|
+
"description": "The owner user ID."
|
|
3442
|
+
},
|
|
3443
|
+
"name": {
|
|
3444
|
+
"type": "string",
|
|
3445
|
+
"description": "The owner name."
|
|
3446
|
+
},
|
|
3447
|
+
"email": {
|
|
3448
|
+
"type": "string",
|
|
3449
|
+
"description": "The owner email address."
|
|
3450
|
+
}
|
|
3451
|
+
},
|
|
3452
|
+
"additionalProperties": true,
|
|
3453
|
+
"description": "The business card or tag owner."
|
|
3454
|
+
}
|
|
3455
|
+
},
|
|
3456
|
+
"additionalProperties": true,
|
|
3457
|
+
"description": "A Sansan tag, with additional upstream fields preserved."
|
|
3458
|
+
},
|
|
3459
|
+
"description": "Records in this page."
|
|
3460
|
+
},
|
|
3461
|
+
"hasMore": {
|
|
3462
|
+
"type": "boolean",
|
|
3463
|
+
"description": "Whether another page is available."
|
|
3464
|
+
},
|
|
3465
|
+
"nextPageToken": {
|
|
3466
|
+
"anyOf": [
|
|
3467
|
+
{
|
|
3468
|
+
"type": "string",
|
|
3469
|
+
"description": "The next page token, or null when absent. Tokens expire six hours after the first request."
|
|
3470
|
+
},
|
|
3471
|
+
{
|
|
3472
|
+
"type": "null"
|
|
3473
|
+
}
|
|
3474
|
+
],
|
|
3475
|
+
"description": "The next page token, or null when absent. Tokens expire six hours after the first request."
|
|
3476
|
+
}
|
|
3477
|
+
},
|
|
3478
|
+
"additionalProperties": true,
|
|
3479
|
+
"required": [
|
|
3480
|
+
"data",
|
|
3481
|
+
"hasMore",
|
|
3482
|
+
"nextPageToken"
|
|
3483
|
+
],
|
|
3484
|
+
"description": "One page of Sansan records."
|
|
3485
|
+
}
|
|
3486
|
+
},
|
|
3487
|
+
{
|
|
3488
|
+
"id": "sansan.search_business_cards",
|
|
3489
|
+
"service": "sansan",
|
|
3490
|
+
"name": "search_business_cards",
|
|
3491
|
+
"description": "Search accessible Sansan business cards by company, name, email, telephone, mobile, and tags.",
|
|
3492
|
+
"operationType": "read",
|
|
3493
|
+
"requiredScopes": [],
|
|
3494
|
+
"providerPermissions": [],
|
|
3495
|
+
"inputSchema": {
|
|
3496
|
+
"type": "object",
|
|
3497
|
+
"properties": {
|
|
3498
|
+
"nextPageToken": {
|
|
3499
|
+
"type": "string",
|
|
3500
|
+
"minLength": 1,
|
|
3501
|
+
"description": "Continue a previous query using its nextPageToken; original query parameters are inherited."
|
|
3502
|
+
},
|
|
3503
|
+
"limit": {
|
|
3504
|
+
"type": "integer",
|
|
3505
|
+
"minimum": 1,
|
|
3506
|
+
"maximum": 300,
|
|
3507
|
+
"description": "Maximum records per page, from 1 to 300; defaults to 100."
|
|
3508
|
+
},
|
|
3509
|
+
"range": {
|
|
3510
|
+
"type": "string",
|
|
3511
|
+
"enum": [
|
|
3512
|
+
"me",
|
|
3513
|
+
"all"
|
|
3514
|
+
],
|
|
3515
|
+
"description": "Record ownership scope: me or all accessible records; defaults to me."
|
|
3516
|
+
},
|
|
3517
|
+
"includeTags": {
|
|
3518
|
+
"type": "boolean",
|
|
3519
|
+
"description": "Include attached tags and treat tag changes as business card updates."
|
|
3520
|
+
},
|
|
3521
|
+
"includePastBizCards": {
|
|
3522
|
+
"type": "boolean",
|
|
3523
|
+
"description": "Include older business cards for merged persons; defaults to false."
|
|
3524
|
+
},
|
|
3525
|
+
"entryStatus": {
|
|
3526
|
+
"type": "array",
|
|
3527
|
+
"items": {
|
|
3528
|
+
"type": "string",
|
|
3529
|
+
"enum": [
|
|
3530
|
+
"processing",
|
|
3531
|
+
"completed",
|
|
3532
|
+
"unreadable"
|
|
3533
|
+
],
|
|
3534
|
+
"description": "A business card digitization status."
|
|
3535
|
+
},
|
|
3536
|
+
"description": "Digitization statuses to include; defaults to completed."
|
|
3537
|
+
},
|
|
3538
|
+
"orderBy": {
|
|
3539
|
+
"type": "string",
|
|
3540
|
+
"enum": [
|
|
3541
|
+
"registeredAt",
|
|
3542
|
+
"completedAt",
|
|
3543
|
+
"updatedAt"
|
|
3544
|
+
],
|
|
3545
|
+
"description": "Sort field; defaults to updatedAt for listing and registeredAt for searching."
|
|
3546
|
+
},
|
|
3547
|
+
"orderDirection": {
|
|
3548
|
+
"type": "string",
|
|
3549
|
+
"enum": [
|
|
3550
|
+
"asc",
|
|
3551
|
+
"desc"
|
|
3552
|
+
],
|
|
3553
|
+
"description": "Sort direction; defaults to asc for listing and desc for searching."
|
|
3554
|
+
},
|
|
3555
|
+
"companyName": {
|
|
3556
|
+
"type": "string",
|
|
3557
|
+
"description": "Company name substring."
|
|
3558
|
+
},
|
|
3559
|
+
"name": {
|
|
3560
|
+
"type": "string",
|
|
3561
|
+
"description": "Name prefix."
|
|
3562
|
+
},
|
|
3563
|
+
"email": {
|
|
3564
|
+
"type": "string",
|
|
3565
|
+
"description": "Exact email address."
|
|
3566
|
+
},
|
|
3567
|
+
"tel": {
|
|
3568
|
+
"type": "string",
|
|
3569
|
+
"description": "Telephone number substring."
|
|
3570
|
+
},
|
|
3571
|
+
"mobile": {
|
|
3572
|
+
"type": "string",
|
|
3573
|
+
"description": "Mobile number substring."
|
|
3574
|
+
},
|
|
3575
|
+
"tagIds": {
|
|
3576
|
+
"type": "array",
|
|
3577
|
+
"items": {
|
|
3578
|
+
"type": "string",
|
|
3579
|
+
"minLength": 1,
|
|
3580
|
+
"description": "A tag ID."
|
|
3581
|
+
},
|
|
3582
|
+
"description": "Filter by one or more Sansan tag IDs."
|
|
3583
|
+
}
|
|
3584
|
+
},
|
|
3585
|
+
"additionalProperties": false,
|
|
3586
|
+
"description": "Business card search filters."
|
|
3587
|
+
},
|
|
3588
|
+
"outputSchema": {
|
|
3589
|
+
"type": "object",
|
|
3590
|
+
"properties": {
|
|
3591
|
+
"data": {
|
|
3592
|
+
"type": "array",
|
|
3593
|
+
"items": {
|
|
3594
|
+
"type": "object",
|
|
3595
|
+
"properties": {
|
|
3596
|
+
"id": {
|
|
3597
|
+
"anyOf": [
|
|
3598
|
+
{
|
|
3599
|
+
"type": "string",
|
|
3600
|
+
"description": "The business card ID."
|
|
3601
|
+
},
|
|
3602
|
+
{
|
|
3603
|
+
"type": "null"
|
|
3604
|
+
}
|
|
3605
|
+
],
|
|
3606
|
+
"description": "The business card ID."
|
|
3607
|
+
},
|
|
3608
|
+
"companyId": {
|
|
3609
|
+
"anyOf": [
|
|
3610
|
+
{
|
|
3611
|
+
"type": "string",
|
|
3612
|
+
"description": "The company ID."
|
|
3613
|
+
},
|
|
3614
|
+
{
|
|
3615
|
+
"type": "null"
|
|
3616
|
+
}
|
|
3617
|
+
],
|
|
3618
|
+
"description": "The company ID."
|
|
3619
|
+
},
|
|
3620
|
+
"personId": {
|
|
3621
|
+
"anyOf": [
|
|
3622
|
+
{
|
|
3623
|
+
"type": "string",
|
|
3624
|
+
"description": "The person ID."
|
|
3625
|
+
},
|
|
3626
|
+
{
|
|
3627
|
+
"type": "null"
|
|
3628
|
+
}
|
|
3629
|
+
],
|
|
3630
|
+
"description": "The person ID."
|
|
3631
|
+
},
|
|
3632
|
+
"firstName": {
|
|
3633
|
+
"anyOf": [
|
|
3634
|
+
{
|
|
3635
|
+
"type": "string",
|
|
3636
|
+
"description": "The first name."
|
|
3637
|
+
},
|
|
3638
|
+
{
|
|
3639
|
+
"type": "null"
|
|
3640
|
+
}
|
|
3641
|
+
],
|
|
3642
|
+
"description": "The first name."
|
|
3643
|
+
},
|
|
3644
|
+
"lastName": {
|
|
3645
|
+
"anyOf": [
|
|
3646
|
+
{
|
|
3647
|
+
"type": "string",
|
|
3648
|
+
"description": "The last name."
|
|
3649
|
+
},
|
|
3650
|
+
{
|
|
3651
|
+
"type": "null"
|
|
3652
|
+
}
|
|
3653
|
+
],
|
|
3654
|
+
"description": "The last name."
|
|
3655
|
+
},
|
|
3656
|
+
"companyName": {
|
|
3657
|
+
"anyOf": [
|
|
3658
|
+
{
|
|
3659
|
+
"type": "string",
|
|
3660
|
+
"description": "The company name."
|
|
3661
|
+
},
|
|
3662
|
+
{
|
|
3663
|
+
"type": "null"
|
|
3664
|
+
}
|
|
3665
|
+
],
|
|
3666
|
+
"description": "The company name."
|
|
3667
|
+
},
|
|
3668
|
+
"departmentName": {
|
|
3669
|
+
"anyOf": [
|
|
3670
|
+
{
|
|
3671
|
+
"type": "string",
|
|
3672
|
+
"description": "The department name."
|
|
3673
|
+
},
|
|
3674
|
+
{
|
|
3675
|
+
"type": "null"
|
|
3676
|
+
}
|
|
3677
|
+
],
|
|
3678
|
+
"description": "The department name."
|
|
3679
|
+
},
|
|
3680
|
+
"title": {
|
|
3681
|
+
"anyOf": [
|
|
3682
|
+
{
|
|
3683
|
+
"type": "string",
|
|
3684
|
+
"description": "The job title."
|
|
3685
|
+
},
|
|
3686
|
+
{
|
|
3687
|
+
"type": "null"
|
|
3688
|
+
}
|
|
3689
|
+
],
|
|
3690
|
+
"description": "The job title."
|
|
3691
|
+
},
|
|
3692
|
+
"email": {
|
|
3693
|
+
"anyOf": [
|
|
3694
|
+
{
|
|
3695
|
+
"type": "string",
|
|
3696
|
+
"description": "The email address."
|
|
3697
|
+
},
|
|
3698
|
+
{
|
|
3699
|
+
"type": "null"
|
|
3700
|
+
}
|
|
3701
|
+
],
|
|
3702
|
+
"description": "The email address."
|
|
3703
|
+
},
|
|
3704
|
+
"tel": {
|
|
3705
|
+
"anyOf": [
|
|
3706
|
+
{
|
|
3707
|
+
"type": "string",
|
|
3708
|
+
"description": "The telephone number."
|
|
3709
|
+
},
|
|
3710
|
+
{
|
|
3711
|
+
"type": "null"
|
|
3712
|
+
}
|
|
3713
|
+
],
|
|
3714
|
+
"description": "The telephone number."
|
|
3715
|
+
},
|
|
3716
|
+
"mobile": {
|
|
3717
|
+
"anyOf": [
|
|
3718
|
+
{
|
|
3719
|
+
"type": "string",
|
|
3720
|
+
"description": "The mobile phone number."
|
|
3721
|
+
},
|
|
3722
|
+
{
|
|
3723
|
+
"type": "null"
|
|
3724
|
+
}
|
|
3725
|
+
],
|
|
3726
|
+
"description": "The mobile phone number."
|
|
3727
|
+
},
|
|
3728
|
+
"exchangeDate": {
|
|
3729
|
+
"anyOf": [
|
|
3730
|
+
{
|
|
3731
|
+
"type": "string",
|
|
3732
|
+
"description": "The business card exchange date."
|
|
3733
|
+
},
|
|
3734
|
+
{
|
|
3735
|
+
"type": "null"
|
|
3736
|
+
}
|
|
3737
|
+
],
|
|
3738
|
+
"description": "The business card exchange date."
|
|
3739
|
+
},
|
|
3740
|
+
"registeredTime": {
|
|
3741
|
+
"anyOf": [
|
|
3742
|
+
{
|
|
3743
|
+
"type": "string",
|
|
3744
|
+
"description": "The registration timestamp."
|
|
3745
|
+
},
|
|
3746
|
+
{
|
|
3747
|
+
"type": "null"
|
|
3748
|
+
}
|
|
3749
|
+
],
|
|
3750
|
+
"description": "The registration timestamp."
|
|
3751
|
+
},
|
|
3752
|
+
"updatedTime": {
|
|
3753
|
+
"anyOf": [
|
|
3754
|
+
{
|
|
3755
|
+
"type": "string",
|
|
3756
|
+
"description": "The last update timestamp."
|
|
3757
|
+
},
|
|
3758
|
+
{
|
|
3759
|
+
"type": "null"
|
|
3760
|
+
}
|
|
3761
|
+
],
|
|
3762
|
+
"description": "The last update timestamp."
|
|
3763
|
+
},
|
|
3764
|
+
"entryStatus": {
|
|
3765
|
+
"anyOf": [
|
|
3766
|
+
{
|
|
3767
|
+
"type": "string",
|
|
3768
|
+
"description": "The digitization status."
|
|
3769
|
+
},
|
|
3770
|
+
{
|
|
3771
|
+
"type": "null"
|
|
3772
|
+
}
|
|
3773
|
+
],
|
|
3774
|
+
"description": "The digitization status."
|
|
3775
|
+
},
|
|
3776
|
+
"owner": {
|
|
3777
|
+
"type": "object",
|
|
3778
|
+
"properties": {
|
|
3779
|
+
"id": {
|
|
3780
|
+
"type": "string",
|
|
3781
|
+
"description": "The owner user ID."
|
|
3782
|
+
},
|
|
3783
|
+
"name": {
|
|
3784
|
+
"type": "string",
|
|
3785
|
+
"description": "The owner name."
|
|
3786
|
+
},
|
|
3787
|
+
"email": {
|
|
3788
|
+
"type": "string",
|
|
3789
|
+
"description": "The owner email address."
|
|
3790
|
+
}
|
|
3791
|
+
},
|
|
3792
|
+
"additionalProperties": true,
|
|
3793
|
+
"description": "The business card or tag owner."
|
|
3794
|
+
},
|
|
3795
|
+
"tags": {
|
|
3796
|
+
"type": "array",
|
|
3797
|
+
"items": {
|
|
3798
|
+
"type": "object",
|
|
3799
|
+
"properties": {
|
|
3800
|
+
"id": {
|
|
3801
|
+
"type": "string",
|
|
3802
|
+
"description": "The tag ID."
|
|
3803
|
+
},
|
|
3804
|
+
"name": {
|
|
3805
|
+
"type": "string",
|
|
3806
|
+
"description": "The tag name."
|
|
3807
|
+
},
|
|
3808
|
+
"type": {
|
|
3809
|
+
"type": "string",
|
|
3810
|
+
"description": "The tag visibility: private, public, or shared."
|
|
3811
|
+
},
|
|
3812
|
+
"owner": {
|
|
3813
|
+
"type": "object",
|
|
3814
|
+
"properties": {
|
|
3815
|
+
"id": {
|
|
3816
|
+
"type": "string",
|
|
3817
|
+
"description": "The owner user ID."
|
|
3818
|
+
},
|
|
3819
|
+
"name": {
|
|
3820
|
+
"type": "string",
|
|
3821
|
+
"description": "The owner name."
|
|
3822
|
+
},
|
|
3823
|
+
"email": {
|
|
3824
|
+
"type": "string",
|
|
3825
|
+
"description": "The owner email address."
|
|
3826
|
+
}
|
|
3827
|
+
},
|
|
3828
|
+
"additionalProperties": true,
|
|
3829
|
+
"description": "The business card or tag owner."
|
|
3830
|
+
}
|
|
3831
|
+
},
|
|
3832
|
+
"additionalProperties": true,
|
|
3833
|
+
"description": "A Sansan tag, with additional upstream fields preserved."
|
|
3834
|
+
},
|
|
3835
|
+
"description": "Tags attached to the business card when requested."
|
|
3836
|
+
}
|
|
3837
|
+
},
|
|
3838
|
+
"additionalProperties": true,
|
|
3839
|
+
"description": "A business card with contact details; additional Sansan fields are preserved."
|
|
3840
|
+
},
|
|
3841
|
+
"description": "Records in this page."
|
|
3842
|
+
},
|
|
3843
|
+
"hasMore": {
|
|
3844
|
+
"type": "boolean",
|
|
3845
|
+
"description": "Whether another page is available."
|
|
3846
|
+
},
|
|
3847
|
+
"nextPageToken": {
|
|
3848
|
+
"anyOf": [
|
|
3849
|
+
{
|
|
3850
|
+
"type": "string",
|
|
3851
|
+
"description": "The next page token, or null when absent. Tokens expire six hours after the first request."
|
|
3852
|
+
},
|
|
3853
|
+
{
|
|
3854
|
+
"type": "null"
|
|
3855
|
+
}
|
|
3856
|
+
],
|
|
3857
|
+
"description": "The next page token, or null when absent. Tokens expire six hours after the first request."
|
|
3858
|
+
}
|
|
3859
|
+
},
|
|
3860
|
+
"additionalProperties": true,
|
|
3861
|
+
"required": [
|
|
3862
|
+
"data",
|
|
3863
|
+
"hasMore",
|
|
3864
|
+
"nextPageToken"
|
|
3865
|
+
],
|
|
3866
|
+
"description": "One page of Sansan records."
|
|
3867
|
+
}
|
|
3868
|
+
},
|
|
3869
|
+
{
|
|
3870
|
+
"id": "sansan.set_default_email_client",
|
|
3871
|
+
"service": "sansan",
|
|
3872
|
+
"name": "set_default_email_client",
|
|
3873
|
+
"description": "Set the default email client for subsequently added users; users may change it later. System administrator only.",
|
|
3874
|
+
"operationType": "write",
|
|
3875
|
+
"requiredScopes": [],
|
|
3876
|
+
"providerPermissions": [],
|
|
3877
|
+
"inputSchema": {
|
|
3878
|
+
"type": "object",
|
|
3879
|
+
"properties": {
|
|
3880
|
+
"emailClient": {
|
|
3881
|
+
"type": "string",
|
|
3882
|
+
"enum": [
|
|
3883
|
+
"clientSoftware",
|
|
3884
|
+
"gmail",
|
|
3885
|
+
"office365"
|
|
3886
|
+
],
|
|
3887
|
+
"description": "Default email client for newly added users."
|
|
3888
|
+
},
|
|
3889
|
+
"encoding": {
|
|
3890
|
+
"type": "string",
|
|
3891
|
+
"enum": [
|
|
3892
|
+
"sjis",
|
|
3893
|
+
"utf8",
|
|
3894
|
+
"iso2022jp"
|
|
3895
|
+
],
|
|
3896
|
+
"description": "Required only for clientSoftware."
|
|
3897
|
+
}
|
|
3898
|
+
},
|
|
3899
|
+
"additionalProperties": false,
|
|
3900
|
+
"required": [
|
|
3901
|
+
"emailClient"
|
|
3902
|
+
],
|
|
3903
|
+
"description": "Default email client settings.",
|
|
3904
|
+
"allOf": [
|
|
3905
|
+
{
|
|
3906
|
+
"if": {
|
|
3907
|
+
"properties": {
|
|
3908
|
+
"emailClient": {
|
|
3909
|
+
"const": "clientSoftware"
|
|
3910
|
+
}
|
|
3911
|
+
}
|
|
3912
|
+
},
|
|
3913
|
+
"then": {
|
|
3914
|
+
"required": [
|
|
3915
|
+
"encoding"
|
|
3916
|
+
]
|
|
3917
|
+
},
|
|
3918
|
+
"else": {
|
|
3919
|
+
"not": {
|
|
3920
|
+
"required": [
|
|
3921
|
+
"encoding"
|
|
3922
|
+
]
|
|
3923
|
+
}
|
|
3924
|
+
}
|
|
3925
|
+
}
|
|
3926
|
+
]
|
|
3927
|
+
},
|
|
3928
|
+
"outputSchema": {
|
|
3929
|
+
"type": "object",
|
|
3930
|
+
"properties": {
|
|
3931
|
+
"settings": {
|
|
3932
|
+
"anyOf": [
|
|
3933
|
+
{
|
|
3934
|
+
"type": "object",
|
|
3935
|
+
"properties": {
|
|
3936
|
+
"emailClient": {
|
|
3937
|
+
"type": "string",
|
|
3938
|
+
"enum": [
|
|
3939
|
+
"clientSoftware",
|
|
3940
|
+
"gmail",
|
|
3941
|
+
"office365"
|
|
3942
|
+
],
|
|
3943
|
+
"description": "Default email client for newly added users."
|
|
3944
|
+
},
|
|
3945
|
+
"encoding": {
|
|
3946
|
+
"type": "string",
|
|
3947
|
+
"enum": [
|
|
3948
|
+
"sjis",
|
|
3949
|
+
"utf8",
|
|
3950
|
+
"iso2022jp"
|
|
3951
|
+
],
|
|
3952
|
+
"description": "Required only for clientSoftware."
|
|
3953
|
+
}
|
|
3954
|
+
},
|
|
3955
|
+
"additionalProperties": true,
|
|
3956
|
+
"description": "Email client configuration."
|
|
3957
|
+
},
|
|
3958
|
+
{
|
|
3959
|
+
"type": "null"
|
|
3960
|
+
}
|
|
3961
|
+
],
|
|
3962
|
+
"description": "Email client configuration."
|
|
3963
|
+
}
|
|
3964
|
+
},
|
|
3965
|
+
"additionalProperties": false,
|
|
3966
|
+
"required": [
|
|
3967
|
+
"settings"
|
|
3968
|
+
],
|
|
3969
|
+
"description": "Organization default email client; null when not configured."
|
|
3970
|
+
}
|
|
3971
|
+
},
|
|
3972
|
+
{
|
|
3973
|
+
"id": "sansan.set_department_access_control",
|
|
3974
|
+
"service": "sansan",
|
|
3975
|
+
"name": "set_department_access_control",
|
|
3976
|
+
"description": "Assign an access control pattern to a department. System administrator only.",
|
|
3977
|
+
"operationType": "write",
|
|
3978
|
+
"requiredScopes": [],
|
|
3979
|
+
"providerPermissions": [],
|
|
3980
|
+
"inputSchema": {
|
|
3981
|
+
"type": "object",
|
|
3982
|
+
"properties": {
|
|
3983
|
+
"departmentId": {
|
|
3984
|
+
"type": "string",
|
|
3985
|
+
"minLength": 1,
|
|
3986
|
+
"description": "The department ID."
|
|
3987
|
+
},
|
|
3988
|
+
"aclPatternId": {
|
|
3989
|
+
"type": "string",
|
|
3990
|
+
"minLength": 1,
|
|
3991
|
+
"description": "The access control pattern ID."
|
|
3992
|
+
}
|
|
3993
|
+
},
|
|
3994
|
+
"additionalProperties": false,
|
|
3995
|
+
"required": [
|
|
3996
|
+
"departmentId",
|
|
3997
|
+
"aclPatternId"
|
|
3998
|
+
],
|
|
3999
|
+
"description": "Department and pattern assignment."
|
|
4000
|
+
},
|
|
4001
|
+
"outputSchema": {
|
|
4002
|
+
"type": "object",
|
|
4003
|
+
"properties": {
|
|
4004
|
+
"success": {
|
|
4005
|
+
"type": "boolean",
|
|
4006
|
+
"description": "Whether the request succeeded."
|
|
4007
|
+
},
|
|
4008
|
+
"data": {
|
|
4009
|
+
"anyOf": [
|
|
4010
|
+
{
|
|
4011
|
+
"type": "object",
|
|
4012
|
+
"additionalProperties": true,
|
|
4013
|
+
"description": "Any JSON payload returned by Sansan."
|
|
4014
|
+
},
|
|
4015
|
+
{
|
|
4016
|
+
"type": "null"
|
|
4017
|
+
}
|
|
4018
|
+
],
|
|
4019
|
+
"description": "Any JSON payload returned by Sansan."
|
|
4020
|
+
}
|
|
4021
|
+
},
|
|
4022
|
+
"additionalProperties": false,
|
|
4023
|
+
"required": [
|
|
4024
|
+
"success",
|
|
4025
|
+
"data"
|
|
4026
|
+
],
|
|
4027
|
+
"description": "Successful administration change."
|
|
4028
|
+
}
|
|
4029
|
+
},
|
|
4030
|
+
{
|
|
4031
|
+
"id": "sansan.submit_organization_import",
|
|
4032
|
+
"service": "sansan",
|
|
4033
|
+
"name": "submit_organization_import",
|
|
4034
|
+
"description": "Submit user and department additions, updates, or deletions. System administrator only. DeleteFlag can delete users or departments; preserve the import ID to retrieve results.",
|
|
4035
|
+
"operationType": "destructive",
|
|
4036
|
+
"requiredScopes": [],
|
|
4037
|
+
"providerPermissions": [],
|
|
4038
|
+
"inputSchema": {
|
|
4039
|
+
"type": "object",
|
|
4040
|
+
"properties": {
|
|
4041
|
+
"users": {
|
|
4042
|
+
"type": "array",
|
|
4043
|
+
"items": {
|
|
4044
|
+
"type": "object",
|
|
4045
|
+
"properties": {
|
|
4046
|
+
"TempId": {
|
|
4047
|
+
"type": "string",
|
|
4048
|
+
"maxLength": 256,
|
|
4049
|
+
"description": "Temporary alphanumeric ID for a new user; blank when editing. Must be unique within the file."
|
|
4050
|
+
},
|
|
4051
|
+
"UserUuid": {
|
|
4052
|
+
"type": "string",
|
|
4053
|
+
"description": "Existing user UUID when editing; blank for a new user."
|
|
4054
|
+
},
|
|
4055
|
+
"DepartmentId": {
|
|
4056
|
+
"type": "string",
|
|
4057
|
+
"description": "Department IDs separated by semicolons; use tempId:ID for a new department in the same import."
|
|
4058
|
+
},
|
|
4059
|
+
"UserId": {
|
|
4060
|
+
"type": "string",
|
|
4061
|
+
"maxLength": 20,
|
|
4062
|
+
"description": "Immutable user login ID, up to 20 characters; alphanumeric or .-_&."
|
|
4063
|
+
},
|
|
4064
|
+
"UserName": {
|
|
4065
|
+
"type": "string",
|
|
4066
|
+
"maxLength": 60,
|
|
4067
|
+
"description": "User display name, up to 60 characters."
|
|
4068
|
+
},
|
|
4069
|
+
"AlternativeName": {
|
|
4070
|
+
"type": "string",
|
|
4071
|
+
"maxLength": 256,
|
|
4072
|
+
"description": "User name reading."
|
|
4073
|
+
},
|
|
4074
|
+
"Email": {
|
|
4075
|
+
"type": "string",
|
|
4076
|
+
"maxLength": 60,
|
|
4077
|
+
"description": "Unique primary user email within the company."
|
|
4078
|
+
},
|
|
4079
|
+
"SubEmail": {
|
|
4080
|
+
"type": "string",
|
|
4081
|
+
"maxLength": 60,
|
|
4082
|
+
"description": "Secondary user email."
|
|
4083
|
+
},
|
|
4084
|
+
"EffectiveDateFrom": {
|
|
4085
|
+
"type": "string",
|
|
4086
|
+
"description": "Usage start date for new users, today or later in RFC3339 format; blank when unchanged during editing."
|
|
4087
|
+
},
|
|
4088
|
+
"SamlNameId": {
|
|
4089
|
+
"type": "string",
|
|
4090
|
+
"description": "Unique SAML Name ID within the company."
|
|
4091
|
+
},
|
|
4092
|
+
"Culture": {
|
|
4093
|
+
"type": "integer",
|
|
4094
|
+
"minimum": 0,
|
|
4095
|
+
"maximum": 2,
|
|
4096
|
+
"description": "Display language: 0 Japanese, 1 English, 2 Simplified Chinese. Omission serializes as a blank CSV cell."
|
|
4097
|
+
},
|
|
4098
|
+
"MailFormat": {
|
|
4099
|
+
"type": "integer",
|
|
4100
|
+
"minimum": 0,
|
|
4101
|
+
"maximum": 1,
|
|
4102
|
+
"description": "Email format: 0 HTML, 1 text. Omission serializes as a blank CSV cell."
|
|
4103
|
+
},
|
|
4104
|
+
"UserType": {
|
|
4105
|
+
"type": "integer",
|
|
4106
|
+
"minimum": 0,
|
|
4107
|
+
"maximum": 2,
|
|
4108
|
+
"description": "Role: 0 regular, 1 system administrator, 2 departmental administrator. Omission serializes as a blank CSV cell."
|
|
4109
|
+
},
|
|
4110
|
+
"CanUpdateData": {
|
|
4111
|
+
"type": "integer",
|
|
4112
|
+
"minimum": 0,
|
|
4113
|
+
"maximum": 1,
|
|
4114
|
+
"description": "Permission to update all data: 1 granted, 0 denied. Omission serializes as a blank CSV cell."
|
|
4115
|
+
},
|
|
4116
|
+
"DataDownloadPrivilege": {
|
|
4117
|
+
"type": "integer",
|
|
4118
|
+
"minimum": 0,
|
|
4119
|
+
"maximum": 3,
|
|
4120
|
+
"description": "Download permission: 0 none, 1 own data, 2 all data, 3 assigned departments. Omission serializes as a blank CSV cell."
|
|
4121
|
+
},
|
|
4122
|
+
"EmailDeliveryPrivilege": {
|
|
4123
|
+
"type": "integer",
|
|
4124
|
+
"minimum": 0,
|
|
4125
|
+
"maximum": 1,
|
|
4126
|
+
"description": "Email delivery permission: 1 granted, 0 denied. Omission serializes as a blank CSV cell."
|
|
4127
|
+
},
|
|
4128
|
+
"DealPrivilege": {
|
|
4129
|
+
"type": "integer",
|
|
4130
|
+
"minimum": 0,
|
|
4131
|
+
"maximum": 2,
|
|
4132
|
+
"description": "Deal permission: 0 none, 1 regular, 2 administrator. Omission serializes as a blank CSV cell."
|
|
4133
|
+
},
|
|
4134
|
+
"ApiIntegrationPrivilege": {
|
|
4135
|
+
"type": "integer",
|
|
4136
|
+
"minimum": 0,
|
|
4137
|
+
"maximum": 1,
|
|
4138
|
+
"description": "API integration permission: 1 granted, 0 denied. Omission serializes as a blank CSV cell."
|
|
4139
|
+
},
|
|
4140
|
+
"UsageStatisticsPrivilege": {
|
|
4141
|
+
"type": "integer",
|
|
4142
|
+
"minimum": 0,
|
|
4143
|
+
"maximum": 1,
|
|
4144
|
+
"description": "Usage statistics permission: 1 granted, 0 denied. Omission serializes as a blank CSV cell."
|
|
4145
|
+
},
|
|
4146
|
+
"OrganizationTreeDownloadPrivilege": {
|
|
4147
|
+
"type": "integer",
|
|
4148
|
+
"minimum": 0,
|
|
4149
|
+
"maximum": 1,
|
|
4150
|
+
"description": "Organization tree download permission: 1 granted, 0 denied. Omission serializes as a blank CSV cell."
|
|
4151
|
+
},
|
|
4152
|
+
"DeleteFlag": {
|
|
4153
|
+
"type": "integer",
|
|
4154
|
+
"minimum": 0,
|
|
4155
|
+
"maximum": 1,
|
|
4156
|
+
"description": "Set to 1 to delete the user. Omission serializes as a blank CSV cell."
|
|
4157
|
+
},
|
|
4158
|
+
"SalesforceIntegrationPrivilege": {
|
|
4159
|
+
"type": "string",
|
|
4160
|
+
"description": "Retired field, ignored by Sansan; the CSV column is retained even when omitted."
|
|
4161
|
+
}
|
|
4162
|
+
},
|
|
4163
|
+
"additionalProperties": false,
|
|
4164
|
+
"description": "A user import row using official Sansan CSV columns. Submission requires DepartmentId, UserId, UserName and Email; new users also require TempId and EffectiveDateFrom, while existing users require UserUuid. Blank optional cells preserve unchanged values when editing."
|
|
4165
|
+
},
|
|
4166
|
+
"description": "Structured user rows; Connector builds the official CSV, preserving all columns. Mutually exclusive with usersFileUrl.",
|
|
4167
|
+
"minItems": 1
|
|
4168
|
+
},
|
|
4169
|
+
"departments": {
|
|
4170
|
+
"type": "array",
|
|
4171
|
+
"items": {
|
|
4172
|
+
"type": "object",
|
|
4173
|
+
"properties": {
|
|
4174
|
+
"TempId": {
|
|
4175
|
+
"type": "string",
|
|
4176
|
+
"maxLength": 256,
|
|
4177
|
+
"description": "Temporary alphanumeric ID for a new department; blank when editing."
|
|
4178
|
+
},
|
|
4179
|
+
"DepartmentId": {
|
|
4180
|
+
"type": "string",
|
|
4181
|
+
"description": "Existing department ID when editing; blank for a new department."
|
|
4182
|
+
},
|
|
4183
|
+
"DepartmentName": {
|
|
4184
|
+
"type": "string",
|
|
4185
|
+
"maxLength": 30,
|
|
4186
|
+
"description": "Department name."
|
|
4187
|
+
},
|
|
4188
|
+
"DepartmentNamePhonetic": {
|
|
4189
|
+
"type": "string",
|
|
4190
|
+
"maxLength": 256,
|
|
4191
|
+
"description": "Department name reading using lowercase Latin letters, digits, and spaces."
|
|
4192
|
+
},
|
|
4193
|
+
"ParentDepartmentId": {
|
|
4194
|
+
"type": "string",
|
|
4195
|
+
"description": "Parent department ID or tempId:ID for a parent created in the same import; blank for no parent."
|
|
4196
|
+
},
|
|
4197
|
+
"Order": {
|
|
4198
|
+
"type": "integer",
|
|
4199
|
+
"description": "Department sort order."
|
|
4200
|
+
},
|
|
4201
|
+
"DeleteFlag": {
|
|
4202
|
+
"type": "integer",
|
|
4203
|
+
"minimum": 0,
|
|
4204
|
+
"maximum": 1,
|
|
4205
|
+
"description": "Set to 1 to delete the department; it must have no users or child departments."
|
|
4206
|
+
}
|
|
4207
|
+
},
|
|
4208
|
+
"additionalProperties": false,
|
|
4209
|
+
"description": "A department import row using official Sansan CSV columns. Submission requires DepartmentName and either TempId for creation or DepartmentId for editing; the other identifier must be blank or omitted."
|
|
4210
|
+
},
|
|
4211
|
+
"description": "Structured department rows. Mutually exclusive with departmentsFileUrl.",
|
|
4212
|
+
"minItems": 1
|
|
4213
|
+
},
|
|
4214
|
+
"usersFileUrl": {
|
|
4215
|
+
"type": "string",
|
|
4216
|
+
"description": "Public URL of a UTF-8 user CSV with a header row; maximum 20 MiB per source file.",
|
|
4217
|
+
"format": "uri"
|
|
4218
|
+
},
|
|
4219
|
+
"departmentsFileUrl": {
|
|
4220
|
+
"type": "string",
|
|
4221
|
+
"description": "Public URL of a UTF-8 department CSV with a header row; maximum 20 MiB per source file.",
|
|
4222
|
+
"format": "uri"
|
|
4223
|
+
},
|
|
4224
|
+
"delimiter": {
|
|
4225
|
+
"type": "string",
|
|
4226
|
+
"enum": [
|
|
4227
|
+
"comma",
|
|
4228
|
+
"semicolon",
|
|
4229
|
+
"tab",
|
|
4230
|
+
"space"
|
|
4231
|
+
],
|
|
4232
|
+
"description": "CSV delimiter; defaults to comma."
|
|
4233
|
+
}
|
|
4234
|
+
},
|
|
4235
|
+
"additionalProperties": false,
|
|
4236
|
+
"description": "Users and/or departments to check or import. System administrator only.",
|
|
4237
|
+
"anyOf": [
|
|
4238
|
+
{
|
|
4239
|
+
"required": [
|
|
4240
|
+
"users"
|
|
4241
|
+
]
|
|
4242
|
+
},
|
|
4243
|
+
{
|
|
4244
|
+
"required": [
|
|
4245
|
+
"departments"
|
|
4246
|
+
]
|
|
4247
|
+
},
|
|
4248
|
+
{
|
|
4249
|
+
"required": [
|
|
4250
|
+
"usersFileUrl"
|
|
4251
|
+
]
|
|
4252
|
+
},
|
|
4253
|
+
{
|
|
4254
|
+
"required": [
|
|
4255
|
+
"departmentsFileUrl"
|
|
4256
|
+
]
|
|
4257
|
+
}
|
|
4258
|
+
],
|
|
4259
|
+
"allOf": [
|
|
4260
|
+
{
|
|
4261
|
+
"not": {
|
|
4262
|
+
"required": [
|
|
4263
|
+
"users",
|
|
4264
|
+
"usersFileUrl"
|
|
4265
|
+
]
|
|
4266
|
+
}
|
|
4267
|
+
},
|
|
4268
|
+
{
|
|
4269
|
+
"not": {
|
|
4270
|
+
"required": [
|
|
4271
|
+
"departments",
|
|
4272
|
+
"departmentsFileUrl"
|
|
4273
|
+
]
|
|
4274
|
+
}
|
|
4275
|
+
},
|
|
4276
|
+
{
|
|
4277
|
+
"properties": {
|
|
4278
|
+
"users": {
|
|
4279
|
+
"items": {
|
|
4280
|
+
"required": [
|
|
4281
|
+
"DepartmentId",
|
|
4282
|
+
"UserId",
|
|
4283
|
+
"UserName",
|
|
4284
|
+
"Email"
|
|
4285
|
+
],
|
|
4286
|
+
"properties": {
|
|
4287
|
+
"DepartmentId": {
|
|
4288
|
+
"minLength": 1
|
|
4289
|
+
},
|
|
4290
|
+
"UserId": {
|
|
4291
|
+
"minLength": 1
|
|
4292
|
+
},
|
|
4293
|
+
"UserName": {
|
|
4294
|
+
"minLength": 1
|
|
4295
|
+
},
|
|
4296
|
+
"Email": {
|
|
4297
|
+
"minLength": 1
|
|
4298
|
+
}
|
|
4299
|
+
},
|
|
4300
|
+
"oneOf": [
|
|
4301
|
+
{
|
|
4302
|
+
"required": [
|
|
4303
|
+
"TempId",
|
|
4304
|
+
"EffectiveDateFrom"
|
|
4305
|
+
],
|
|
4306
|
+
"properties": {
|
|
4307
|
+
"TempId": {
|
|
4308
|
+
"minLength": 1
|
|
4309
|
+
},
|
|
4310
|
+
"UserUuid": {
|
|
4311
|
+
"maxLength": 0
|
|
4312
|
+
},
|
|
4313
|
+
"EffectiveDateFrom": {
|
|
4314
|
+
"minLength": 1
|
|
4315
|
+
}
|
|
4316
|
+
}
|
|
4317
|
+
},
|
|
4318
|
+
{
|
|
4319
|
+
"required": [
|
|
4320
|
+
"UserUuid"
|
|
4321
|
+
],
|
|
4322
|
+
"properties": {
|
|
4323
|
+
"UserUuid": {
|
|
4324
|
+
"minLength": 1
|
|
4325
|
+
},
|
|
4326
|
+
"TempId": {
|
|
4327
|
+
"maxLength": 0
|
|
4328
|
+
}
|
|
4329
|
+
}
|
|
4330
|
+
}
|
|
4331
|
+
]
|
|
4332
|
+
}
|
|
4333
|
+
},
|
|
4334
|
+
"departments": {
|
|
4335
|
+
"items": {
|
|
4336
|
+
"required": [
|
|
4337
|
+
"DepartmentName"
|
|
4338
|
+
],
|
|
4339
|
+
"properties": {
|
|
4340
|
+
"DepartmentName": {
|
|
4341
|
+
"minLength": 1
|
|
4342
|
+
}
|
|
4343
|
+
},
|
|
4344
|
+
"oneOf": [
|
|
4345
|
+
{
|
|
4346
|
+
"required": [
|
|
4347
|
+
"TempId"
|
|
4348
|
+
],
|
|
4349
|
+
"properties": {
|
|
4350
|
+
"TempId": {
|
|
4351
|
+
"minLength": 1
|
|
4352
|
+
},
|
|
4353
|
+
"DepartmentId": {
|
|
4354
|
+
"maxLength": 0
|
|
4355
|
+
}
|
|
4356
|
+
}
|
|
4357
|
+
},
|
|
4358
|
+
{
|
|
4359
|
+
"required": [
|
|
4360
|
+
"DepartmentId"
|
|
4361
|
+
],
|
|
4362
|
+
"properties": {
|
|
4363
|
+
"DepartmentId": {
|
|
4364
|
+
"minLength": 1
|
|
4365
|
+
},
|
|
4366
|
+
"TempId": {
|
|
4367
|
+
"maxLength": 0
|
|
4368
|
+
}
|
|
4369
|
+
}
|
|
4370
|
+
}
|
|
4371
|
+
]
|
|
4372
|
+
}
|
|
4373
|
+
}
|
|
4374
|
+
}
|
|
4375
|
+
}
|
|
4376
|
+
]
|
|
4377
|
+
},
|
|
4378
|
+
"outputSchema": {
|
|
4379
|
+
"type": "object",
|
|
4380
|
+
"properties": {
|
|
4381
|
+
"importId": {
|
|
4382
|
+
"type": "string",
|
|
4383
|
+
"minLength": 1,
|
|
4384
|
+
"description": "The submitted import job ID."
|
|
4385
|
+
}
|
|
4386
|
+
},
|
|
4387
|
+
"additionalProperties": true,
|
|
4388
|
+
"required": [
|
|
4389
|
+
"importId"
|
|
4390
|
+
],
|
|
4391
|
+
"description": "Submitted organization import."
|
|
4392
|
+
},
|
|
4393
|
+
"asyncLifecycle": {
|
|
4394
|
+
"startActionId": "sansan.submit_organization_import",
|
|
4395
|
+
"statusActionId": "sansan.get_organization_import_result"
|
|
4396
|
+
}
|
|
4397
|
+
},
|
|
4398
|
+
{
|
|
4399
|
+
"id": "sansan.update_access_control_pattern",
|
|
4400
|
+
"service": "sansan",
|
|
4401
|
+
"name": "update_access_control_pattern",
|
|
4402
|
+
"description": "Update an access control pattern and its department rules. System administrator only.",
|
|
4403
|
+
"operationType": "write",
|
|
4404
|
+
"requiredScopes": [],
|
|
4405
|
+
"providerPermissions": [],
|
|
4406
|
+
"inputSchema": {
|
|
4407
|
+
"type": "object",
|
|
4408
|
+
"properties": {
|
|
4409
|
+
"patternId": {
|
|
4410
|
+
"type": "string",
|
|
4411
|
+
"minLength": 1,
|
|
4412
|
+
"description": "The access control pattern ID."
|
|
4413
|
+
},
|
|
4414
|
+
"aclPatternName": {
|
|
4415
|
+
"type": "string",
|
|
4416
|
+
"minLength": 1,
|
|
4417
|
+
"description": "Access control pattern name."
|
|
4418
|
+
},
|
|
4419
|
+
"description": {
|
|
4420
|
+
"type": "string",
|
|
4421
|
+
"description": "Access control pattern description."
|
|
4422
|
+
},
|
|
4423
|
+
"details": {
|
|
4424
|
+
"type": "array",
|
|
4425
|
+
"items": {
|
|
4426
|
+
"type": "object",
|
|
4427
|
+
"properties": {
|
|
4428
|
+
"objectDepartmentId": {
|
|
4429
|
+
"type": "string",
|
|
4430
|
+
"minLength": 1,
|
|
4431
|
+
"description": "The department whose data this rule covers."
|
|
4432
|
+
},
|
|
4433
|
+
"accessibleFieldsSettingsName": {
|
|
4434
|
+
"type": "string",
|
|
4435
|
+
"minLength": 1,
|
|
4436
|
+
"description": "The upstream accessible-fields setting name, such as ALL. Use values configured in Sansan; no complete enum is published."
|
|
4437
|
+
}
|
|
4438
|
+
},
|
|
4439
|
+
"additionalProperties": true,
|
|
4440
|
+
"required": [
|
|
4441
|
+
"objectDepartmentId",
|
|
4442
|
+
"accessibleFieldsSettingsName"
|
|
4443
|
+
],
|
|
4444
|
+
"description": "Access rule for a target department; additional provider-defined fields are accepted."
|
|
4445
|
+
},
|
|
4446
|
+
"description": "Department access rules."
|
|
4447
|
+
}
|
|
4448
|
+
},
|
|
4449
|
+
"additionalProperties": false,
|
|
4450
|
+
"required": [
|
|
4451
|
+
"patternId"
|
|
4452
|
+
],
|
|
4453
|
+
"description": "Access control pattern changes."
|
|
4454
|
+
},
|
|
4455
|
+
"outputSchema": {
|
|
4456
|
+
"type": "object",
|
|
4457
|
+
"properties": {
|
|
4458
|
+
"success": {
|
|
4459
|
+
"type": "boolean",
|
|
4460
|
+
"description": "Whether the request succeeded."
|
|
4461
|
+
},
|
|
4462
|
+
"data": {
|
|
4463
|
+
"anyOf": [
|
|
4464
|
+
{
|
|
4465
|
+
"type": "object",
|
|
4466
|
+
"additionalProperties": true,
|
|
4467
|
+
"description": "Any JSON payload returned by Sansan."
|
|
4468
|
+
},
|
|
4469
|
+
{
|
|
4470
|
+
"type": "null"
|
|
4471
|
+
}
|
|
4472
|
+
],
|
|
4473
|
+
"description": "Any JSON payload returned by Sansan."
|
|
4474
|
+
}
|
|
4475
|
+
},
|
|
4476
|
+
"additionalProperties": false,
|
|
4477
|
+
"required": [
|
|
4478
|
+
"success",
|
|
4479
|
+
"data"
|
|
4480
|
+
],
|
|
4481
|
+
"description": "Successful administration change."
|
|
4482
|
+
}
|
|
4483
|
+
},
|
|
4484
|
+
{
|
|
4485
|
+
"id": "sansan.upload_business_card_image",
|
|
4486
|
+
"service": "sansan",
|
|
4487
|
+
"name": "upload_business_card_image",
|
|
4488
|
+
"description": "Submit JPEG business card images for paid Sansan digitization. Optionally use administrator import for another owner.",
|
|
4489
|
+
"operationType": "write",
|
|
4490
|
+
"requiredScopes": [],
|
|
4491
|
+
"providerPermissions": [],
|
|
4492
|
+
"inputSchema": {
|
|
4493
|
+
"type": "object",
|
|
4494
|
+
"properties": {
|
|
4495
|
+
"ownerUserId": {
|
|
4496
|
+
"type": "string",
|
|
4497
|
+
"minLength": 1,
|
|
4498
|
+
"description": "Optional record owner user ID. When provided, use the system-administrator import API; the user must belong to the same company and contract. Omit to create for the connected user."
|
|
4499
|
+
},
|
|
4500
|
+
"frontImageUrl": {
|
|
4501
|
+
"type": "string",
|
|
4502
|
+
"description": "Public URL of the front JPEG image, at most 5 MB.",
|
|
4503
|
+
"format": "uri"
|
|
4504
|
+
},
|
|
4505
|
+
"backImageUrl": {
|
|
4506
|
+
"type": "string",
|
|
4507
|
+
"description": "Public URL of the optional back JPEG image, at most 5 MB.",
|
|
4508
|
+
"format": "uri"
|
|
4509
|
+
},
|
|
4510
|
+
"exchangeDate": {
|
|
4511
|
+
"type": "string",
|
|
4512
|
+
"description": "Business card exchange date, YYYY-MM-DD.",
|
|
4513
|
+
"format": "date"
|
|
4514
|
+
},
|
|
4515
|
+
"prioritizeHandWrittenDates": {
|
|
4516
|
+
"type": "boolean",
|
|
4517
|
+
"description": "Use a handwritten date on the image as the exchange date."
|
|
4518
|
+
},
|
|
4519
|
+
"memo": {
|
|
4520
|
+
"type": "string",
|
|
4521
|
+
"maxLength": 2000,
|
|
4522
|
+
"description": "Memo attached to the imported card."
|
|
4523
|
+
},
|
|
4524
|
+
"languages": {
|
|
4525
|
+
"type": "array",
|
|
4526
|
+
"items": {
|
|
4527
|
+
"type": "string",
|
|
4528
|
+
"enum": [
|
|
4529
|
+
"Japanese",
|
|
4530
|
+
"English",
|
|
4531
|
+
"Chinese",
|
|
4532
|
+
"Korean",
|
|
4533
|
+
"Spanish",
|
|
4534
|
+
"Portuguese",
|
|
4535
|
+
"German",
|
|
4536
|
+
"French",
|
|
4537
|
+
"Thai",
|
|
4538
|
+
"Indonesian",
|
|
4539
|
+
"Vietnamese"
|
|
4540
|
+
],
|
|
4541
|
+
"description": "A supported digitization language."
|
|
4542
|
+
},
|
|
4543
|
+
"description": "Requested digitization languages, at most two.",
|
|
4544
|
+
"maxItems": 2
|
|
4545
|
+
},
|
|
4546
|
+
"tagIds": {
|
|
4547
|
+
"type": "array",
|
|
4548
|
+
"items": {
|
|
4549
|
+
"type": "string",
|
|
4550
|
+
"minLength": 1,
|
|
4551
|
+
"description": "An existing tag ID."
|
|
4552
|
+
},
|
|
4553
|
+
"description": "Existing tag IDs to attach, at most fifteen.",
|
|
4554
|
+
"maxItems": 15
|
|
4555
|
+
}
|
|
4556
|
+
},
|
|
4557
|
+
"additionalProperties": false,
|
|
4558
|
+
"required": [
|
|
4559
|
+
"frontImageUrl"
|
|
4560
|
+
],
|
|
4561
|
+
"description": "Image URLs and digitization options."
|
|
4562
|
+
},
|
|
4563
|
+
"outputSchema": {
|
|
4564
|
+
"type": "object",
|
|
4565
|
+
"properties": {
|
|
4566
|
+
"data": {
|
|
4567
|
+
"type": "array",
|
|
4568
|
+
"items": {
|
|
4569
|
+
"type": "object",
|
|
4570
|
+
"properties": {
|
|
4571
|
+
"id": {
|
|
4572
|
+
"type": "string",
|
|
4573
|
+
"description": "The created business card ID."
|
|
4574
|
+
},
|
|
4575
|
+
"language": {
|
|
4576
|
+
"type": "string",
|
|
4577
|
+
"description": "The digitization language."
|
|
4578
|
+
}
|
|
4579
|
+
},
|
|
4580
|
+
"additionalProperties": true,
|
|
4581
|
+
"description": "A card queued for digitization."
|
|
4582
|
+
},
|
|
4583
|
+
"description": "Created card identifiers for each requested language."
|
|
4584
|
+
}
|
|
4585
|
+
},
|
|
4586
|
+
"additionalProperties": true,
|
|
4587
|
+
"required": [
|
|
4588
|
+
"data"
|
|
4589
|
+
],
|
|
4590
|
+
"description": "Business cards submitted for paid digitization."
|
|
4591
|
+
}
|
|
4592
|
+
}
|
|
4593
|
+
]
|
|
4594
|
+
}
|