@simpleapps-com/augur-api 2026.10.31 → 2026.11.2
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/README.md +85 -34
- package/SKILL.md +25 -24
- package/dist/client.d.ts +336 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/core/base-client.d.ts +159 -0
- package/dist/core/base-client.d.ts.map +1 -0
- package/dist/core/call-rules.d.ts +73 -0
- package/dist/core/call-rules.d.ts.map +1 -0
- package/dist/core/call.d.ts +48 -0
- package/dist/core/call.d.ts.map +1 -0
- package/dist/core/client.d.ts +112 -0
- package/dist/core/client.d.ts.map +1 -0
- package/dist/core/common-schemas.d.ts +522 -0
- package/dist/core/common-schemas.d.ts.map +1 -0
- package/dist/core/config.d.ts +72 -0
- package/dist/core/config.d.ts.map +1 -0
- package/dist/core/encoded-segment.d.ts +23 -0
- package/dist/core/encoded-segment.d.ts.map +1 -0
- package/dist/core/errors.d.ts +91 -0
- package/dist/core/errors.d.ts.map +1 -0
- package/dist/core/http-rules.d.ts +64 -0
- package/dist/core/http-rules.d.ts.map +1 -0
- package/dist/core/path-validation.d.ts +28 -0
- package/dist/core/path-validation.d.ts.map +1 -0
- package/dist/core/proxy-rules.d.ts +21 -0
- package/dist/core/proxy-rules.d.ts.map +1 -0
- package/dist/core/registry-rules.d.ts +15 -0
- package/dist/core/registry-rules.d.ts.map +1 -0
- package/dist/core/registry-tables.d.ts +3 -0
- package/dist/core/registry-tables.d.ts.map +1 -0
- package/dist/core/registry.d.ts +54 -0
- package/dist/core/registry.d.ts.map +1 -0
- package/dist/core/response-rules.d.ts +26 -0
- package/dist/core/response-rules.d.ts.map +1 -0
- package/dist/core/schemas.d.ts +71 -0
- package/dist/core/schemas.d.ts.map +1 -0
- package/dist/core/service-proxy.d.ts +81 -0
- package/dist/core/service-proxy.d.ts.map +1 -0
- package/dist/core/site-id-check.d.ts +6 -0
- package/dist/core/site-id-check.d.ts.map +1 -0
- package/dist/core/site-id.d.ts +15 -0
- package/dist/core/site-id.d.ts.map +1 -0
- package/dist/index.d.ts +71 -236
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +19565 -18212
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +19564 -18212
- package/dist/index.mjs.map +1 -1
- package/dist/services/agr-info/client.d.ts +71 -0
- package/dist/services/agr-info/client.d.ts.map +1 -0
- package/dist/services/agr-info/generated/endpoints.d.ts +41 -0
- package/dist/services/agr-info/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-info/generated/schemas.d.ts +299 -0
- package/dist/services/agr-info/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-info/generated/types.d.ts +1111 -0
- package/dist/services/agr-info/generated/types.d.ts.map +1 -0
- package/dist/services/agr-info/index.d.ts +2 -0
- package/dist/services/agr-info/index.d.ts.map +1 -0
- package/dist/services/agr-int/client.d.ts +100 -0
- package/dist/services/agr-int/client.d.ts.map +1 -0
- package/dist/services/agr-int/generated/endpoints.d.ts +42 -0
- package/dist/services/agr-int/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-int/generated/schemas.d.ts +595 -0
- package/dist/services/agr-int/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-int/generated/types.d.ts +1984 -0
- package/dist/services/agr-int/generated/types.d.ts.map +1 -0
- package/dist/services/agr-int/index.d.ts +2 -0
- package/dist/services/agr-int/index.d.ts.map +1 -0
- package/dist/services/agr-site/client.d.ts +112 -0
- package/dist/services/agr-site/client.d.ts.map +1 -0
- package/dist/services/agr-site/generated/endpoints.d.ts +42 -0
- package/dist/services/agr-site/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-site/generated/schemas.d.ts +537 -0
- package/dist/services/agr-site/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-site/generated/types.d.ts +1732 -0
- package/dist/services/agr-site/generated/types.d.ts.map +1 -0
- package/dist/services/agr-site/index.d.ts +2 -0
- package/dist/services/agr-site/index.d.ts.map +1 -0
- package/dist/services/agr-work/client.d.ts +23 -0
- package/dist/services/agr-work/client.d.ts.map +1 -0
- package/dist/services/agr-work/generated/endpoints.d.ts +41 -0
- package/dist/services/agr-work/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-work/generated/schemas.d.ts +21 -0
- package/dist/services/agr-work/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-work/generated/types.d.ts +19 -0
- package/dist/services/agr-work/generated/types.d.ts.map +1 -0
- package/dist/services/agr-work/index.d.ts +2 -0
- package/dist/services/agr-work/index.d.ts.map +1 -0
- package/dist/services/avalara/client.d.ts +33 -0
- package/dist/services/avalara/client.d.ts.map +1 -0
- package/dist/services/avalara/generated/endpoints.d.ts +41 -0
- package/dist/services/avalara/generated/endpoints.d.ts.map +1 -0
- package/dist/services/avalara/generated/schemas.d.ts +22 -0
- package/dist/services/avalara/generated/schemas.d.ts.map +1 -0
- package/dist/services/avalara/generated/types.d.ts +103 -0
- package/dist/services/avalara/generated/types.d.ts.map +1 -0
- package/dist/services/avalara/index.d.ts +2 -0
- package/dist/services/avalara/index.d.ts.map +1 -0
- package/dist/services/basecamp2/client.d.ts +92 -0
- package/dist/services/basecamp2/client.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/endpoints.d.ts +42 -0
- package/dist/services/basecamp2/generated/endpoints.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/schemas.d.ts +845 -0
- package/dist/services/basecamp2/generated/schemas.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/types.d.ts +1587 -0
- package/dist/services/basecamp2/generated/types.d.ts.map +1 -0
- package/dist/services/basecamp2/index.d.ts +2 -0
- package/dist/services/basecamp2/index.d.ts.map +1 -0
- package/dist/services/brand-folder/client.d.ts +37 -0
- package/dist/services/brand-folder/client.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/endpoints.d.ts +41 -0
- package/dist/services/brand-folder/generated/endpoints.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/schemas.d.ts +81 -0
- package/dist/services/brand-folder/generated/schemas.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/types.d.ts +195 -0
- package/dist/services/brand-folder/generated/types.d.ts.map +1 -0
- package/dist/services/brand-folder/index.d.ts +2 -0
- package/dist/services/brand-folder/index.d.ts.map +1 -0
- package/dist/services/commerce/client.d.ts +57 -0
- package/dist/services/commerce/client.d.ts.map +1 -0
- package/dist/services/commerce/generated/endpoints.d.ts +42 -0
- package/dist/services/commerce/generated/endpoints.d.ts.map +1 -0
- package/dist/services/commerce/generated/schemas.d.ts +319 -0
- package/dist/services/commerce/generated/schemas.d.ts.map +1 -0
- package/dist/services/commerce/generated/types.d.ts +1134 -0
- package/dist/services/commerce/generated/types.d.ts.map +1 -0
- package/dist/services/commerce/index.d.ts +2 -0
- package/dist/services/commerce/index.d.ts.map +1 -0
- package/dist/services/customers/client.d.ts +162 -0
- package/dist/services/customers/client.d.ts.map +1 -0
- package/dist/services/customers/generated/endpoints.d.ts +42 -0
- package/dist/services/customers/generated/endpoints.d.ts.map +1 -0
- package/dist/services/customers/generated/schemas.d.ts +1970 -0
- package/dist/services/customers/generated/schemas.d.ts.map +1 -0
- package/dist/services/customers/generated/types.d.ts +3849 -0
- package/dist/services/customers/generated/types.d.ts.map +1 -0
- package/dist/services/customers/index.d.ts +2 -0
- package/dist/services/customers/index.d.ts.map +1 -0
- package/dist/services/goog-mc/client.d.ts +44 -0
- package/dist/services/goog-mc/client.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/endpoints.d.ts +42 -0
- package/dist/services/goog-mc/generated/endpoints.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/schemas.d.ts +175 -0
- package/dist/services/goog-mc/generated/schemas.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/types.d.ts +361 -0
- package/dist/services/goog-mc/generated/types.d.ts.map +1 -0
- package/dist/services/goog-mc/index.d.ts +2 -0
- package/dist/services/goog-mc/index.d.ts.map +1 -0
- package/dist/services/gregorovich/client.d.ts +34 -0
- package/dist/services/gregorovich/client.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/endpoints.d.ts +42 -0
- package/dist/services/gregorovich/generated/endpoints.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/schemas.d.ts +35 -0
- package/dist/services/gregorovich/generated/schemas.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/types.d.ts +70 -0
- package/dist/services/gregorovich/generated/types.d.ts.map +1 -0
- package/dist/services/gregorovich/index.d.ts +2 -0
- package/dist/services/gregorovich/index.d.ts.map +1 -0
- package/dist/services/items/client.d.ts +453 -0
- package/dist/services/items/client.d.ts.map +1 -0
- package/dist/services/items/generated/endpoints.d.ts +42 -0
- package/dist/services/items/generated/endpoints.d.ts.map +1 -0
- package/dist/services/items/generated/schemas.d.ts +4636 -0
- package/dist/services/items/generated/schemas.d.ts.map +1 -0
- package/dist/services/items/generated/types.d.ts +10513 -0
- package/dist/services/items/generated/types.d.ts.map +1 -0
- package/dist/services/items/index.d.ts +2 -0
- package/dist/services/items/index.d.ts.map +1 -0
- package/dist/services/joomla/client.d.ts +74 -0
- package/dist/services/joomla/client.d.ts.map +1 -0
- package/dist/services/joomla/generated/endpoints.d.ts +41 -0
- package/dist/services/joomla/generated/endpoints.d.ts.map +1 -0
- package/dist/services/joomla/generated/schemas.d.ts +550 -0
- package/dist/services/joomla/generated/schemas.d.ts.map +1 -0
- package/dist/services/joomla/generated/types.d.ts +1502 -0
- package/dist/services/joomla/generated/types.d.ts.map +1 -0
- package/dist/services/joomla/index.d.ts +2 -0
- package/dist/services/joomla/index.d.ts.map +1 -0
- package/dist/services/legacy/client.d.ts +75 -0
- package/dist/services/legacy/client.d.ts.map +1 -0
- package/dist/services/legacy/generated/endpoints.d.ts +41 -0
- package/dist/services/legacy/generated/endpoints.d.ts.map +1 -0
- package/dist/services/legacy/generated/schemas.d.ts +567 -0
- package/dist/services/legacy/generated/schemas.d.ts.map +1 -0
- package/dist/services/legacy/generated/types.d.ts +1454 -0
- package/dist/services/legacy/generated/types.d.ts.map +1 -0
- package/dist/services/legacy/index.d.ts +2 -0
- package/dist/services/legacy/index.d.ts.map +1 -0
- package/dist/services/logistics/client.d.ts +64 -0
- package/dist/services/logistics/client.d.ts.map +1 -0
- package/dist/services/logistics/generated/endpoints.d.ts +41 -0
- package/dist/services/logistics/generated/endpoints.d.ts.map +1 -0
- package/dist/services/logistics/generated/schemas.d.ts +375 -0
- package/dist/services/logistics/generated/schemas.d.ts.map +1 -0
- package/dist/services/logistics/generated/types.d.ts +925 -0
- package/dist/services/logistics/generated/types.d.ts.map +1 -0
- package/dist/services/logistics/index.d.ts +2 -0
- package/dist/services/logistics/index.d.ts.map +1 -0
- package/dist/services/markets/client.d.ts +47 -0
- package/dist/services/markets/client.d.ts.map +1 -0
- package/dist/services/markets/generated/endpoints.d.ts +41 -0
- package/dist/services/markets/generated/endpoints.d.ts.map +1 -0
- package/dist/services/markets/generated/schemas.d.ts +180 -0
- package/dist/services/markets/generated/schemas.d.ts.map +1 -0
- package/dist/services/markets/generated/types.d.ts +405 -0
- package/dist/services/markets/generated/types.d.ts.map +1 -0
- package/dist/services/markets/index.d.ts +2 -0
- package/dist/services/markets/index.d.ts.map +1 -0
- package/dist/services/notifications/client.d.ts +58 -0
- package/dist/services/notifications/client.d.ts.map +1 -0
- package/dist/services/notifications/generated/endpoints.d.ts +41 -0
- package/dist/services/notifications/generated/endpoints.d.ts.map +1 -0
- package/dist/services/notifications/generated/schemas.d.ts +247 -0
- package/dist/services/notifications/generated/schemas.d.ts.map +1 -0
- package/dist/services/notifications/generated/types.d.ts +666 -0
- package/dist/services/notifications/generated/types.d.ts.map +1 -0
- package/dist/services/notifications/index.d.ts +2 -0
- package/dist/services/notifications/index.d.ts.map +1 -0
- package/dist/services/open-search/client.d.ts +69 -0
- package/dist/services/open-search/client.d.ts.map +1 -0
- package/dist/services/open-search/generated/endpoints.d.ts +42 -0
- package/dist/services/open-search/generated/endpoints.d.ts.map +1 -0
- package/dist/services/open-search/generated/schemas.d.ts +363 -0
- package/dist/services/open-search/generated/schemas.d.ts.map +1 -0
- package/dist/services/open-search/generated/types.d.ts +983 -0
- package/dist/services/open-search/generated/types.d.ts.map +1 -0
- package/dist/services/open-search/index.d.ts +2 -0
- package/dist/services/open-search/index.d.ts.map +1 -0
- package/dist/services/orders/client.d.ts +180 -0
- package/dist/services/orders/client.d.ts.map +1 -0
- package/dist/services/orders/generated/endpoints.d.ts +42 -0
- package/dist/services/orders/generated/endpoints.d.ts.map +1 -0
- package/dist/services/orders/generated/schemas.d.ts +2479 -0
- package/dist/services/orders/generated/schemas.d.ts.map +1 -0
- package/dist/services/orders/generated/types.d.ts +4717 -0
- package/dist/services/orders/generated/types.d.ts.map +1 -0
- package/dist/services/orders/index.d.ts +2 -0
- package/dist/services/orders/index.d.ts.map +1 -0
- package/dist/services/p21-apis/client.d.ts +59 -0
- package/dist/services/p21-apis/client.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/endpoints.d.ts +41 -0
- package/dist/services/p21-apis/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/schemas.d.ts +46 -0
- package/dist/services/p21-apis/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/types.d.ts +246 -0
- package/dist/services/p21-apis/generated/types.d.ts.map +1 -0
- package/dist/services/p21-apis/index.d.ts +2 -0
- package/dist/services/p21-apis/index.d.ts.map +1 -0
- package/dist/services/p21-core/client.d.ts +131 -0
- package/dist/services/p21-core/client.d.ts.map +1 -0
- package/dist/services/p21-core/generated/endpoints.d.ts +42 -0
- package/dist/services/p21-core/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-core/generated/schemas.d.ts +1478 -0
- package/dist/services/p21-core/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-core/generated/types.d.ts +2718 -0
- package/dist/services/p21-core/generated/types.d.ts.map +1 -0
- package/dist/services/p21-core/index.d.ts +2 -0
- package/dist/services/p21-core/index.d.ts.map +1 -0
- package/dist/services/p21-pim/client.d.ts +75 -0
- package/dist/services/p21-pim/client.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/endpoints.d.ts +41 -0
- package/dist/services/p21-pim/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/schemas.d.ts +383 -0
- package/dist/services/p21-pim/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/types.d.ts +933 -0
- package/dist/services/p21-pim/generated/types.d.ts.map +1 -0
- package/dist/services/p21-pim/index.d.ts +2 -0
- package/dist/services/p21-pim/index.d.ts.map +1 -0
- package/dist/services/p21-sism/client.d.ts +432 -0
- package/dist/services/p21-sism/client.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/endpoints.d.ts +42 -0
- package/dist/services/p21-sism/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/schemas.d.ts +2844 -0
- package/dist/services/p21-sism/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/types.d.ts +6977 -0
- package/dist/services/p21-sism/generated/types.d.ts.map +1 -0
- package/dist/services/p21-sism/index.d.ts +37 -0
- package/dist/services/p21-sism/index.d.ts.map +1 -0
- package/dist/services/payments/client.d.ts +77 -0
- package/dist/services/payments/client.d.ts.map +1 -0
- package/dist/services/payments/generated/endpoints.d.ts +42 -0
- package/dist/services/payments/generated/endpoints.d.ts.map +1 -0
- package/dist/services/payments/generated/schemas.d.ts +1015 -0
- package/dist/services/payments/generated/schemas.d.ts.map +1 -0
- package/dist/services/payments/generated/types.d.ts +1432 -0
- package/dist/services/payments/generated/types.d.ts.map +1 -0
- package/dist/services/payments/index.d.ts +2 -0
- package/dist/services/payments/index.d.ts.map +1 -0
- package/dist/services/pricing/client.d.ts +216 -0
- package/dist/services/pricing/client.d.ts.map +1 -0
- package/dist/services/pricing/generated/endpoints.d.ts +42 -0
- package/dist/services/pricing/generated/endpoints.d.ts.map +1 -0
- package/dist/services/pricing/generated/schemas.d.ts +2048 -0
- package/dist/services/pricing/generated/schemas.d.ts.map +1 -0
- package/dist/services/pricing/generated/types.d.ts +4257 -0
- package/dist/services/pricing/generated/types.d.ts.map +1 -0
- package/dist/services/pricing/index.d.ts +2 -0
- package/dist/services/pricing/index.d.ts.map +1 -0
- package/dist/services/shipping/client.d.ts +33 -0
- package/dist/services/shipping/client.d.ts.map +1 -0
- package/dist/services/shipping/generated/endpoints.d.ts +41 -0
- package/dist/services/shipping/generated/endpoints.d.ts.map +1 -0
- package/dist/services/shipping/generated/schemas.d.ts +29 -0
- package/dist/services/shipping/generated/schemas.d.ts.map +1 -0
- package/dist/services/shipping/generated/types.d.ts +116 -0
- package/dist/services/shipping/generated/types.d.ts.map +1 -0
- package/dist/services/shipping/index.d.ts +2 -0
- package/dist/services/shipping/index.d.ts.map +1 -0
- package/dist/services/smarty-streets/client.d.ts +33 -0
- package/dist/services/smarty-streets/client.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/endpoints.d.ts +41 -0
- package/dist/services/smarty-streets/generated/endpoints.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/schemas.d.ts +72 -0
- package/dist/services/smarty-streets/generated/schemas.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/types.d.ts +145 -0
- package/dist/services/smarty-streets/generated/types.d.ts.map +1 -0
- package/dist/services/smarty-streets/index.d.ts +2 -0
- package/dist/services/smarty-streets/index.d.ts.map +1 -0
- package/dist/services/ups/client.d.ts +32 -0
- package/dist/services/ups/client.d.ts.map +1 -0
- package/dist/services/ups/generated/endpoints.d.ts +40 -0
- package/dist/services/ups/generated/endpoints.d.ts.map +1 -0
- package/dist/services/ups/generated/schemas.d.ts +51 -0
- package/dist/services/ups/generated/schemas.d.ts.map +1 -0
- package/dist/services/ups/generated/types.d.ts +98 -0
- package/dist/services/ups/generated/types.d.ts.map +1 -0
- package/dist/services/ups/index.d.ts +2 -0
- package/dist/services/ups/index.d.ts.map +1 -0
- package/dist/services/vendors/client.d.ts +38 -0
- package/dist/services/vendors/client.d.ts.map +1 -0
- package/dist/services/vendors/generated/endpoints.d.ts +41 -0
- package/dist/services/vendors/generated/endpoints.d.ts.map +1 -0
- package/dist/services/vendors/generated/schemas.d.ts +350 -0
- package/dist/services/vendors/generated/schemas.d.ts.map +1 -0
- package/dist/services/vendors/generated/types.d.ts +470 -0
- package/dist/services/vendors/generated/types.d.ts.map +1 -0
- package/dist/services/vendors/index.d.ts +2 -0
- package/dist/services/vendors/index.d.ts.map +1 -0
- package/dist/services/vmi/client.d.ts +129 -0
- package/dist/services/vmi/client.d.ts.map +1 -0
- package/dist/services/vmi/generated/endpoints.d.ts +41 -0
- package/dist/services/vmi/generated/endpoints.d.ts.map +1 -0
- package/dist/services/vmi/generated/schemas.d.ts +723 -0
- package/dist/services/vmi/generated/schemas.d.ts.map +1 -0
- package/dist/services/vmi/generated/types.d.ts +2620 -0
- package/dist/services/vmi/generated/types.d.ts.map +1 -0
- package/dist/services/vmi/index.d.ts +2 -0
- package/dist/services/vmi/index.d.ts.map +1 -0
- package/dist/testing.d.ts +9 -13
- package/dist/testing.d.ts.map +1 -0
- package/dist/testing.js +7 -17
- package/dist/testing.js.map +1 -1
- package/dist/testing.mjs +7 -17
- package/dist/testing.mjs.map +1 -1
- package/dist/utils/cross-site-auth.d.ts +88 -0
- package/dist/utils/cross-site-auth.d.ts.map +1 -0
- package/package.json +30 -47
- package/dist/client-TPJa269Y.d.mts +0 -58610
- package/dist/client-TPJa269Y.d.ts +0 -58610
- package/dist/index.d.mts +0 -236
- package/dist/testing.d.mts +0 -83
|
@@ -0,0 +1,1587 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated types for the basecamp2 service.
|
|
3
|
+
* Basecamp project management integration syncing todos, projects, people, and conversation data
|
|
4
|
+
* with AI analytics
|
|
5
|
+
*
|
|
6
|
+
* Public specs (the source of truth for every shape below):
|
|
7
|
+
* https://basecamp2.augur-api.com/endpoints.jsonl: one JSON line per endpoint: method, path, path
|
|
8
|
+
* params and query params, each with type and required flag. Grep it for a path; for a GET
|
|
9
|
+
* that line is all you need. Bodies are not in it.
|
|
10
|
+
* https://basecamp2.augur-api.com/openapi.json: the full contract: request and response bodies
|
|
11
|
+
* field by field, descriptions, formats and documented errors.
|
|
12
|
+
* https://basecamp2.augur-api.com/llms.txt: the plain-text endpoint list and the other Augur
|
|
13
|
+
* services.
|
|
14
|
+
*
|
|
15
|
+
* Source: shared/specs/basecamp2.json
|
|
16
|
+
*
|
|
17
|
+
* DO NOT EDIT — regenerate with: pnpm -C tools/augur-api-generator generate ts
|
|
18
|
+
*/
|
|
19
|
+
import type { EdgeCacheParams } from "../../../core/common-schemas";
|
|
20
|
+
import type { BaseResponse } from "../../../core/schemas";
|
|
21
|
+
/** Params for GET /comments */
|
|
22
|
+
export interface CommentsListParams extends EdgeCacheParams {
|
|
23
|
+
/** Filter by creator ID */
|
|
24
|
+
creatorId?: number;
|
|
25
|
+
/** Limit number of results (Default: 10) */
|
|
26
|
+
limit?: number;
|
|
27
|
+
/** Starting offset results (Default: 0) */
|
|
28
|
+
offset?: number;
|
|
29
|
+
/** Sort field (Default: id|asc) */
|
|
30
|
+
orderBy?: string;
|
|
31
|
+
/**
|
|
32
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
33
|
+
* (704,705); -1 for every status. Default: every status
|
|
34
|
+
*/
|
|
35
|
+
statusCd?: number | number[];
|
|
36
|
+
/** Filter by todos ID */
|
|
37
|
+
todosId?: number;
|
|
38
|
+
}
|
|
39
|
+
/** Params for GET /comments/{id} */
|
|
40
|
+
export type CommentsGetParams = EdgeCacheParams;
|
|
41
|
+
/** Params for GET /events */
|
|
42
|
+
export interface EventsListParams extends EdgeCacheParams {
|
|
43
|
+
/** Filter by event type (1=created, 2=comment, 3=completed) */
|
|
44
|
+
eventTypeCd?: number;
|
|
45
|
+
/** Filter by todos ID */
|
|
46
|
+
id?: number;
|
|
47
|
+
/** Limit number of results (Default: 10) */
|
|
48
|
+
limit?: number;
|
|
49
|
+
/** Starting offset results (Default: 0) */
|
|
50
|
+
offset?: number;
|
|
51
|
+
/** Sort as field|ASC or field|DESC on a todos_events column (Default: id|desc) */
|
|
52
|
+
orderBy?: string;
|
|
53
|
+
/** Filter by person ID */
|
|
54
|
+
peopleId?: number;
|
|
55
|
+
/**
|
|
56
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
57
|
+
* (704,705); -1 for every status. Default: every status
|
|
58
|
+
*/
|
|
59
|
+
statusCd?: number | number[];
|
|
60
|
+
}
|
|
61
|
+
/** Params for GET /metrics */
|
|
62
|
+
export interface MetricsListParams extends EdgeCacheParams {
|
|
63
|
+
/** Filter by assignee ID */
|
|
64
|
+
assigneeId?: number;
|
|
65
|
+
/** Filter by creator ID */
|
|
66
|
+
creatorId?: number;
|
|
67
|
+
/** Filter by has comments (1=yes) */
|
|
68
|
+
hasComments?: number;
|
|
69
|
+
/** Filter stale todos (1=stale) */
|
|
70
|
+
isStale?: number;
|
|
71
|
+
/** Limit number of results (Default: 10) */
|
|
72
|
+
limit?: number;
|
|
73
|
+
/** Filter needs response (1=yes) */
|
|
74
|
+
needsResponse?: number;
|
|
75
|
+
/** Starting offset results (Default: 0) */
|
|
76
|
+
offset?: number;
|
|
77
|
+
/** Order By (Default: id|ASC) */
|
|
78
|
+
orderBy?: string;
|
|
79
|
+
/** Filter by project ID */
|
|
80
|
+
projectsId?: number;
|
|
81
|
+
/**
|
|
82
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
83
|
+
* (704,705); -1 for every status. Default: every status
|
|
84
|
+
*/
|
|
85
|
+
statusCd?: number | number[];
|
|
86
|
+
/** Filter by status (1=open, 2=completed) */
|
|
87
|
+
todosStatusCd?: number;
|
|
88
|
+
}
|
|
89
|
+
/** Params for GET /people */
|
|
90
|
+
export interface PeopleListParams extends EdgeCacheParams {
|
|
91
|
+
/** Filter by admin status (Y/N) */
|
|
92
|
+
adminFlag?: string;
|
|
93
|
+
/** Limit number of results (Default: 10) */
|
|
94
|
+
limit?: number;
|
|
95
|
+
/** Starting offset for results (Default: 0) */
|
|
96
|
+
offset?: number;
|
|
97
|
+
/** Sort as field|ASC or field|DESC on a people column, e.g. name|asc (Default: id|asc) */
|
|
98
|
+
orderBy?: string;
|
|
99
|
+
/** Search name or emailAddress (LIKE) */
|
|
100
|
+
q?: string;
|
|
101
|
+
/**
|
|
102
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
103
|
+
* (704,705); -1 for every status. Default: every status
|
|
104
|
+
*/
|
|
105
|
+
statusCd?: number | number[];
|
|
106
|
+
/** Filter by trashed status (Y/N) */
|
|
107
|
+
trashedFlag?: string;
|
|
108
|
+
}
|
|
109
|
+
/** Params for GET /people/{id} */
|
|
110
|
+
export type PeopleGetParams = EdgeCacheParams;
|
|
111
|
+
/** Params for GET /people/{id}/metrics */
|
|
112
|
+
export interface PeopleMetricsListParams extends EdgeCacheParams {
|
|
113
|
+
/** Filter by creator ID */
|
|
114
|
+
creatorId?: number;
|
|
115
|
+
/** Filter by has comments (1=yes) */
|
|
116
|
+
hasComments?: number;
|
|
117
|
+
/** Filter stale todos (1=stale) */
|
|
118
|
+
isStale?: number;
|
|
119
|
+
/** Limit number of results (Default: 10) */
|
|
120
|
+
limit?: number;
|
|
121
|
+
/** Filter needs response (1=yes) */
|
|
122
|
+
needsResponse?: number;
|
|
123
|
+
/** Starting offset results (Default: 0) */
|
|
124
|
+
offset?: number;
|
|
125
|
+
/** Order By (Default: id|ASC) */
|
|
126
|
+
orderBy?: string;
|
|
127
|
+
/** Filter by project ID */
|
|
128
|
+
projectsId?: number;
|
|
129
|
+
/**
|
|
130
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
131
|
+
* (704,705); -1 for every status. Default: every status
|
|
132
|
+
*/
|
|
133
|
+
statusCd?: number | number[];
|
|
134
|
+
/** Filter by status (1=open, 2=completed) */
|
|
135
|
+
todosStatusCd?: number;
|
|
136
|
+
}
|
|
137
|
+
/** Params for GET /people/{id}/todos */
|
|
138
|
+
export interface PeopleTodosListParams extends EdgeCacheParams {
|
|
139
|
+
/** Filter by completion status (Y/N) */
|
|
140
|
+
completedFlag?: string;
|
|
141
|
+
/** Filter by due date */
|
|
142
|
+
dueAt?: string;
|
|
143
|
+
/** Limit number of results (Default: 10) */
|
|
144
|
+
limit?: number;
|
|
145
|
+
/** Starting offset results (Default: 0) */
|
|
146
|
+
offset?: number;
|
|
147
|
+
/** Sort as field|ASC or field|DESC on a todos column (Default: id|asc) */
|
|
148
|
+
orderBy?: string;
|
|
149
|
+
/** Filter by project ID (optional) */
|
|
150
|
+
projectsId?: number;
|
|
151
|
+
/**
|
|
152
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
153
|
+
* (704,705); -1 for every status. Default: every status
|
|
154
|
+
*/
|
|
155
|
+
statusCd?: number | number[];
|
|
156
|
+
}
|
|
157
|
+
/** Params for GET /people/{personId}/projects/{projectId}/todos */
|
|
158
|
+
export interface PeopleProjectsTodosListParams extends EdgeCacheParams {
|
|
159
|
+
/** Filter by completion status (Y/N) */
|
|
160
|
+
completedFlag?: string;
|
|
161
|
+
/** Filter by due date */
|
|
162
|
+
dueAt?: string;
|
|
163
|
+
/** Limit number of results (Default: 10) */
|
|
164
|
+
limit?: number;
|
|
165
|
+
/** Starting offset results (Default: 0) */
|
|
166
|
+
offset?: number;
|
|
167
|
+
/** Sort as field|ASC or field|DESC on a todos column (Default: id|asc) */
|
|
168
|
+
orderBy?: string;
|
|
169
|
+
/**
|
|
170
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
171
|
+
* (704,705); -1 for every status. Default: every status
|
|
172
|
+
*/
|
|
173
|
+
statusCd?: number | number[];
|
|
174
|
+
}
|
|
175
|
+
/** Params for GET /projects */
|
|
176
|
+
export interface ProjectsListParams extends EdgeCacheParams {
|
|
177
|
+
/** Filter by archived status (Y/N) */
|
|
178
|
+
archivedFlag?: string;
|
|
179
|
+
/** Limit number of results (Default: 10) */
|
|
180
|
+
limit?: number;
|
|
181
|
+
/** Starting offset results (Default: 0) */
|
|
182
|
+
offset?: number;
|
|
183
|
+
/** Sort as field|ASC or field|DESC on a projects column, e.g. name|asc (Default: id|asc) */
|
|
184
|
+
orderBy?: string;
|
|
185
|
+
/**
|
|
186
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
187
|
+
* (704,705); -1 for every status. Default: every status
|
|
188
|
+
*/
|
|
189
|
+
statusCd?: number | number[];
|
|
190
|
+
/** Filter by trashed status (Y/N) */
|
|
191
|
+
trashedFlag?: string;
|
|
192
|
+
}
|
|
193
|
+
/** Params for GET /projects/{id} */
|
|
194
|
+
export type ProjectsGetParams = EdgeCacheParams;
|
|
195
|
+
/** Params for GET /projects/{id}/metrics */
|
|
196
|
+
export interface ProjectsMetricsListParams extends EdgeCacheParams {
|
|
197
|
+
/** Filter by assignee ID */
|
|
198
|
+
assigneeId?: number;
|
|
199
|
+
/** Filter by creator ID */
|
|
200
|
+
creatorId?: number;
|
|
201
|
+
/** Filter by has comments (1=yes) */
|
|
202
|
+
hasComments?: number;
|
|
203
|
+
/** Filter stale todos (1=stale) */
|
|
204
|
+
isStale?: number;
|
|
205
|
+
/** Limit number of results (Default: 10) */
|
|
206
|
+
limit?: number;
|
|
207
|
+
/** Filter needs response (1=yes) */
|
|
208
|
+
needsResponse?: number;
|
|
209
|
+
/** Starting offset results (Default: 0) */
|
|
210
|
+
offset?: number;
|
|
211
|
+
/** Order By (Default: id|ASC) */
|
|
212
|
+
orderBy?: string;
|
|
213
|
+
/**
|
|
214
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
215
|
+
* (704,705); -1 for every status. Default: every status
|
|
216
|
+
*/
|
|
217
|
+
statusCd?: number | number[];
|
|
218
|
+
/** Filter by status (1=open, 2=completed) */
|
|
219
|
+
todosStatusCd?: number;
|
|
220
|
+
}
|
|
221
|
+
/** Params for GET /projects/{id}/todolists */
|
|
222
|
+
export interface ProjectsTodolistsListParams extends EdgeCacheParams {
|
|
223
|
+
/** Filter by completion status (Y/N) */
|
|
224
|
+
completedFlag?: string;
|
|
225
|
+
/** Limit number of results (Default: 10) */
|
|
226
|
+
limit?: number;
|
|
227
|
+
/** Starting offset results (Default: 0) */
|
|
228
|
+
offset?: number;
|
|
229
|
+
/** Sort field (Default: id|asc) */
|
|
230
|
+
orderBy?: string;
|
|
231
|
+
/**
|
|
232
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
233
|
+
* (704,705); -1 for every status. Default: every status
|
|
234
|
+
*/
|
|
235
|
+
statusCd?: number | number[];
|
|
236
|
+
}
|
|
237
|
+
/** Params for GET /projects/{id}/todos */
|
|
238
|
+
export interface ProjectsTodosListParams extends EdgeCacheParams {
|
|
239
|
+
/** Filter by assignee (Person ID) */
|
|
240
|
+
assigneeId?: number;
|
|
241
|
+
/** Filter by completion status (Y/N) */
|
|
242
|
+
completedFlag?: string;
|
|
243
|
+
/** Limit number of results (Default: 10) */
|
|
244
|
+
limit?: number;
|
|
245
|
+
/** Starting offset results (Default: 0) */
|
|
246
|
+
offset?: number;
|
|
247
|
+
/** Sort as field|ASC or field|DESC on a todos column (Default: id|asc) */
|
|
248
|
+
orderBy?: string;
|
|
249
|
+
/**
|
|
250
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
251
|
+
* (704,705); -1 for every status. Default: every status
|
|
252
|
+
*/
|
|
253
|
+
statusCd?: number | number[];
|
|
254
|
+
}
|
|
255
|
+
/** Params for GET /projects/{projectId}/todolists/{todolistId}/todos */
|
|
256
|
+
export interface ProjectsTodolistsTodosListParams extends EdgeCacheParams {
|
|
257
|
+
/** Filter by assignee ID */
|
|
258
|
+
assigneeId?: number;
|
|
259
|
+
/** Filter by completion status (Y/N) */
|
|
260
|
+
completedFlag?: string;
|
|
261
|
+
/** Limit number of results (Default: 10) */
|
|
262
|
+
limit?: number;
|
|
263
|
+
/** Starting offset results (Default: 0) */
|
|
264
|
+
offset?: number;
|
|
265
|
+
/** Sort field (Default: id|asc) */
|
|
266
|
+
orderBy?: string;
|
|
267
|
+
/**
|
|
268
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
269
|
+
* (704,705); -1 for every status. Default: every status
|
|
270
|
+
*/
|
|
271
|
+
statusCd?: number | number[];
|
|
272
|
+
}
|
|
273
|
+
/** Params for GET /todolists */
|
|
274
|
+
export interface TodolistsListParams extends EdgeCacheParams {
|
|
275
|
+
/** Filter by assignee ID */
|
|
276
|
+
assigneeId?: number;
|
|
277
|
+
/** Filter by completion status (Y/N) */
|
|
278
|
+
completedFlag?: string;
|
|
279
|
+
/** Limit number of results (Default: 10) */
|
|
280
|
+
limit?: number;
|
|
281
|
+
/** Starting offset results (Default: 0) */
|
|
282
|
+
offset?: number;
|
|
283
|
+
/** Sort field (Default: id|asc) */
|
|
284
|
+
orderBy?: string;
|
|
285
|
+
/** Filter by project ID */
|
|
286
|
+
projectsId?: number;
|
|
287
|
+
/**
|
|
288
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
289
|
+
* (704,705); -1 for every status. Default: every status
|
|
290
|
+
*/
|
|
291
|
+
statusCd?: number | number[];
|
|
292
|
+
}
|
|
293
|
+
/** Params for GET /todolists/{id} */
|
|
294
|
+
export type TodolistsGetParams = EdgeCacheParams;
|
|
295
|
+
/** Params for GET /todos */
|
|
296
|
+
export interface TodosListParams extends EdgeCacheParams {
|
|
297
|
+
/** Filter by assignee ID */
|
|
298
|
+
assigneeId?: number;
|
|
299
|
+
/** Filter by completion status (Y/N) */
|
|
300
|
+
completedFlag?: string;
|
|
301
|
+
/** Filter by due date */
|
|
302
|
+
dueAt?: string;
|
|
303
|
+
/** Limit number of results (Default: 10) */
|
|
304
|
+
limit?: number;
|
|
305
|
+
/** Starting offset results (Default: 0) */
|
|
306
|
+
offset?: number;
|
|
307
|
+
/** Sort field (Default: id|asc) */
|
|
308
|
+
orderBy?: string;
|
|
309
|
+
/** Filter by project ID */
|
|
310
|
+
projectsId?: number;
|
|
311
|
+
/**
|
|
312
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
313
|
+
* (704,705); -1 for every status. Default: every status
|
|
314
|
+
*/
|
|
315
|
+
statusCd?: number | number[];
|
|
316
|
+
/** Filter by todolist ID */
|
|
317
|
+
todolistId?: number;
|
|
318
|
+
}
|
|
319
|
+
/** Params for GET /todos-summary */
|
|
320
|
+
export interface TodosSummaryListParams extends EdgeCacheParams {
|
|
321
|
+
/** Filter by akasha sync status */
|
|
322
|
+
akashaCd?: number;
|
|
323
|
+
/** Limit number of results (Default: 10) */
|
|
324
|
+
limit?: number;
|
|
325
|
+
/** Starting offset results (Default: 0) */
|
|
326
|
+
offset?: number;
|
|
327
|
+
/** Sort as field|ASC or field|DESC on a todos_summary column (Default: id|asc) */
|
|
328
|
+
orderBy?: string;
|
|
329
|
+
/** Filter by process code */
|
|
330
|
+
processCd?: number;
|
|
331
|
+
/**
|
|
332
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
333
|
+
* (704,705); -1 for every status. Default: every status
|
|
334
|
+
*/
|
|
335
|
+
statusCd?: number | number[];
|
|
336
|
+
}
|
|
337
|
+
/** Params for GET /todos-summary/{id} */
|
|
338
|
+
export type TodosSummaryGetParams = EdgeCacheParams;
|
|
339
|
+
/** Params for GET /todos/{id} */
|
|
340
|
+
export type TodosGetParams = EdgeCacheParams;
|
|
341
|
+
/** Params for GET /todos/{id}/comments */
|
|
342
|
+
export interface TodosCommentsListParams extends EdgeCacheParams {
|
|
343
|
+
/** Limit number of results (Default: 10) */
|
|
344
|
+
limit?: number;
|
|
345
|
+
/** Starting offset results (Default: 0) */
|
|
346
|
+
offset?: number;
|
|
347
|
+
/** Sort field (Default: id|asc) */
|
|
348
|
+
orderBy?: string;
|
|
349
|
+
/**
|
|
350
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
351
|
+
* (704,705); -1 for every status. Default: every status
|
|
352
|
+
*/
|
|
353
|
+
statusCd?: number | number[];
|
|
354
|
+
}
|
|
355
|
+
/** Params for GET /todos/{id}/events */
|
|
356
|
+
export interface TodosEventsListParams extends EdgeCacheParams {
|
|
357
|
+
/** Filter by event type (1=created, 2=comment, 3=completed) */
|
|
358
|
+
eventTypeCd?: number;
|
|
359
|
+
/** Limit number of results (Default: 10) */
|
|
360
|
+
limit?: number;
|
|
361
|
+
/** Starting offset results (Default: 0) */
|
|
362
|
+
offset?: number;
|
|
363
|
+
/** Sort as field|ASC or field|DESC on a todos_events column (Default: id|desc) */
|
|
364
|
+
orderBy?: string;
|
|
365
|
+
/** Filter by person ID */
|
|
366
|
+
peopleId?: number;
|
|
367
|
+
/**
|
|
368
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
369
|
+
* (704,705); -1 for every status. Default: every status
|
|
370
|
+
*/
|
|
371
|
+
statusCd?: number | number[];
|
|
372
|
+
}
|
|
373
|
+
/** Params for GET /todos/{id}/events/{eventNum} */
|
|
374
|
+
export type TodosEventsGetParams = EdgeCacheParams;
|
|
375
|
+
/** Params for GET /todos/{id}/metrics */
|
|
376
|
+
export type TodosMetricsListParams = EdgeCacheParams;
|
|
377
|
+
/** Params for GET /todos/{id}/sessions */
|
|
378
|
+
export interface TodosSessionsListParams extends EdgeCacheParams {
|
|
379
|
+
/** Limit number of results (Default: 10) */
|
|
380
|
+
limit?: number;
|
|
381
|
+
/** Starting offset results (Default: 0) */
|
|
382
|
+
offset?: number;
|
|
383
|
+
/**
|
|
384
|
+
* Sort as field|ASC or field|DESC on a todos_sessions column (Default: todos_sessions_uid|asc)
|
|
385
|
+
*/
|
|
386
|
+
orderBy?: string;
|
|
387
|
+
/** Filter by session status (100=open, 101=closed, 102=blocked) */
|
|
388
|
+
sessionStatusCd?: number;
|
|
389
|
+
/**
|
|
390
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
391
|
+
* (704,705); -1 for every status. Default: every status
|
|
392
|
+
*/
|
|
393
|
+
statusCd?: number | number[];
|
|
394
|
+
}
|
|
395
|
+
/** Params for GET /todos/{id}/sessions/{sessionId} */
|
|
396
|
+
export type TodosSessionsGetParams = EdgeCacheParams;
|
|
397
|
+
/**
|
|
398
|
+
* List Comments
|
|
399
|
+
* Response data for GET /comments — MINIMUM fields, extras pass through
|
|
400
|
+
*
|
|
401
|
+
* Returned by: api.basecamp2.comments.list(params) (array items)
|
|
402
|
+
* Returned by: api.basecamp2.comments.get(id)
|
|
403
|
+
*/
|
|
404
|
+
export interface CommentsListItem {
|
|
405
|
+
/** Basecamp comment ID */
|
|
406
|
+
id: number;
|
|
407
|
+
/** Comment HTML, or efs:{hash} when the body is stored in EFS */
|
|
408
|
+
content: string;
|
|
409
|
+
/** When the record was last updated in Basecamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
410
|
+
updatedAt: string;
|
|
411
|
+
/** When the record was created in Basecamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
412
|
+
createdAt: string;
|
|
413
|
+
/** Person who wrote the comment */
|
|
414
|
+
creatorId: number | null;
|
|
415
|
+
/** Update code (704 = queued for refresh, 1185 = refresh complete) */
|
|
416
|
+
updateCd: number;
|
|
417
|
+
/** Status code (704 = Active, 700 = Deleted) */
|
|
418
|
+
statusCd: number;
|
|
419
|
+
/** Process code (704 = Active) */
|
|
420
|
+
processCd: number;
|
|
421
|
+
/** To-do the comment belongs to */
|
|
422
|
+
todosId: number | null;
|
|
423
|
+
/** The 1536 dimensional vector that represents the comment */
|
|
424
|
+
vector: string | null;
|
|
425
|
+
/** Embedding queue code (704 = queued, 1185 = done) */
|
|
426
|
+
vectorCd: number;
|
|
427
|
+
/** Y when an embedding exists for the comment (max 1 chars) */
|
|
428
|
+
vectorFlag: string;
|
|
429
|
+
/** When the comment embedding was last built (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
430
|
+
dateLastVector: string;
|
|
431
|
+
/** Where the body is stored: rds (inline) or efs (max 17 chars) */
|
|
432
|
+
location: string | null;
|
|
433
|
+
/** Comment body length in characters */
|
|
434
|
+
contentLength: number;
|
|
435
|
+
/** Token count of the comment body */
|
|
436
|
+
tokenCount: number;
|
|
437
|
+
[key: string]: unknown;
|
|
438
|
+
}
|
|
439
|
+
/** Returned by: api.basecamp2.comments.list(params) */
|
|
440
|
+
export type CommentsListData = CommentsListItem[];
|
|
441
|
+
/**
|
|
442
|
+
* Get Comment by ID
|
|
443
|
+
* Response data for GET /comments/{id} — MINIMUM fields, extras pass through
|
|
444
|
+
*
|
|
445
|
+
* Returned by: api.basecamp2.comments.get(id)
|
|
446
|
+
*/
|
|
447
|
+
export type CommentsGetData = CommentsListItem;
|
|
448
|
+
/**
|
|
449
|
+
* List Todo Events
|
|
450
|
+
* Response data for GET /events — MINIMUM fields, extras pass through
|
|
451
|
+
*
|
|
452
|
+
* Returned by: api.basecamp2.events.list(params) (array items)
|
|
453
|
+
* Returned by: api.basecamp2.todos.events.list(id, params) (array items)
|
|
454
|
+
* Returned by: api.basecamp2.todos.events.get(id, eventNum)
|
|
455
|
+
*/
|
|
456
|
+
export interface EventsListItem {
|
|
457
|
+
/** FK to todos.id */
|
|
458
|
+
id: number;
|
|
459
|
+
/** Event sequence number (0=created, 1+=comments/completed) */
|
|
460
|
+
eventNum: number;
|
|
461
|
+
/** CodeBasecamp enum (1=created, 2=comment, 3=completed) */
|
|
462
|
+
eventTypeCd: number;
|
|
463
|
+
/** FK to people.id */
|
|
464
|
+
peopleId: number;
|
|
465
|
+
/** When the event occurred (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
466
|
+
eventAt: string;
|
|
467
|
+
/** Basecamp comment ID (only for comment events) */
|
|
468
|
+
commentId: number | null;
|
|
469
|
+
/** Record creation timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
470
|
+
dateCreated: string;
|
|
471
|
+
/** Record update timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
472
|
+
dateLastModified: string;
|
|
473
|
+
/** Update code (704 = queued for refresh, 1185 = refresh complete) */
|
|
474
|
+
updateCd: number;
|
|
475
|
+
/** Status code (704 = Active, 700 = Deleted) */
|
|
476
|
+
statusCd: number;
|
|
477
|
+
/** Process code (704 = Active) */
|
|
478
|
+
processCd: number;
|
|
479
|
+
/** FK to todos_sessions.todos_sessions_uid (optional session context) */
|
|
480
|
+
todosSessionsUid: number | null;
|
|
481
|
+
[key: string]: unknown;
|
|
482
|
+
}
|
|
483
|
+
/** Returned by: api.basecamp2.events.list(params) */
|
|
484
|
+
export type EventsListData = EventsListItem[];
|
|
485
|
+
/**
|
|
486
|
+
* List Todo Metrics
|
|
487
|
+
* Response data for GET /metrics — MINIMUM fields, extras pass through
|
|
488
|
+
*
|
|
489
|
+
* Returned by: api.basecamp2.metrics.list(params) (array items)
|
|
490
|
+
* Returned by: api.basecamp2.people.metrics.list(id, params) (array items)
|
|
491
|
+
* Returned by: api.basecamp2.projects.metrics.list(id, params) (array items)
|
|
492
|
+
* Returned by: api.basecamp2.todos.metrics.list(id)
|
|
493
|
+
*/
|
|
494
|
+
export interface MetricsListItem {
|
|
495
|
+
/** Todos ID (PK, FK to todos.id) */
|
|
496
|
+
id: number;
|
|
497
|
+
/** FK to projects.id */
|
|
498
|
+
projectsId: number | null;
|
|
499
|
+
/** FK to todolist.id */
|
|
500
|
+
todolistId: number | null;
|
|
501
|
+
/** FK to people.id (current assignee) */
|
|
502
|
+
assigneeId: number | null;
|
|
503
|
+
/** FK to people.id (creator) */
|
|
504
|
+
creatorId: number;
|
|
505
|
+
/** Todos title/content */
|
|
506
|
+
todosContent: string | null;
|
|
507
|
+
/** Status (1=open, 2=completed) */
|
|
508
|
+
todosStatusCd: number;
|
|
509
|
+
/** days_since_last_event > 7 (open only) */
|
|
510
|
+
isStale: number;
|
|
511
|
+
/** comment_count > 0 */
|
|
512
|
+
hasComments: number;
|
|
513
|
+
/** last_commenter != assignee (open only) */
|
|
514
|
+
needsResponse: number;
|
|
515
|
+
/** Todos created timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
516
|
+
createdAt: string;
|
|
517
|
+
/** Todos completion timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
518
|
+
completedAt: string | null;
|
|
519
|
+
/** Most recent event timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
520
|
+
lastActivityAt: string;
|
|
521
|
+
/** First comment timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
522
|
+
firstCommentAt: string | null;
|
|
523
|
+
/** Last comment timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
524
|
+
lastCommentAt: string | null;
|
|
525
|
+
/** Days since creation (NULL if complete) */
|
|
526
|
+
daysOpen: number | null;
|
|
527
|
+
/** Days since last activity (NULL if complete) */
|
|
528
|
+
daysSinceLastEvent: number | null;
|
|
529
|
+
/** Days from creation to first comment */
|
|
530
|
+
daysToFirstComment: number | null;
|
|
531
|
+
/** Days to complete (NULL if open) */
|
|
532
|
+
cycleTimeDays: number | null;
|
|
533
|
+
/** Total comment events */
|
|
534
|
+
commentCount: number;
|
|
535
|
+
/** Count of distinct days with activity */
|
|
536
|
+
activeDaysCount: number;
|
|
537
|
+
/** Days between first and last event */
|
|
538
|
+
activitySpanDays: number | null;
|
|
539
|
+
/** Average days between active days */
|
|
540
|
+
avgDaysBetweenActivity: number | null;
|
|
541
|
+
/** FK to people.id (last commenter) */
|
|
542
|
+
lastCommenterId: number | null;
|
|
543
|
+
/** Record creation timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
544
|
+
dateCreated: string;
|
|
545
|
+
/** Record update timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
546
|
+
dateLastModified: string;
|
|
547
|
+
/** Update code */
|
|
548
|
+
updateCd: number;
|
|
549
|
+
/** Record status code */
|
|
550
|
+
statusCd: number;
|
|
551
|
+
/** Process status code */
|
|
552
|
+
processCd: number;
|
|
553
|
+
[key: string]: unknown;
|
|
554
|
+
}
|
|
555
|
+
/** Returned by: api.basecamp2.metrics.list(params) */
|
|
556
|
+
export type MetricsListData = MetricsListItem[];
|
|
557
|
+
/**
|
|
558
|
+
* List People with filters
|
|
559
|
+
* Response data for GET /people — MINIMUM fields, extras pass through
|
|
560
|
+
*
|
|
561
|
+
* Returned by: api.basecamp2.people.list(params) (array items)
|
|
562
|
+
* Returned by: api.basecamp2.people.get(id)
|
|
563
|
+
* Returned by: api.basecamp2.people.todos.list(id, params) (array items)
|
|
564
|
+
* Returned by: api.basecamp2.people.projects.todos.list(personId, projectId, params) (array items)
|
|
565
|
+
*/
|
|
566
|
+
export interface PeopleListItem {
|
|
567
|
+
/** Basecamp person ID */
|
|
568
|
+
id: number;
|
|
569
|
+
/** Basecamp identity ID shared across accounts */
|
|
570
|
+
identityId: number | null;
|
|
571
|
+
/** Full name (max 255 chars) */
|
|
572
|
+
name: string | null;
|
|
573
|
+
/** Email address (max 255 chars) */
|
|
574
|
+
emailAddress: string | null;
|
|
575
|
+
/** Y when the person is a Basecamp admin (max 1 chars) */
|
|
576
|
+
adminFlag: string | null;
|
|
577
|
+
/** Y when the record is in the Basecamp trash (max 1 chars) */
|
|
578
|
+
trashedFlag: string | null;
|
|
579
|
+
/** When the record was last updated in Basecamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
580
|
+
updatedAt: string;
|
|
581
|
+
/** When the record was created in Basecamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
582
|
+
createdAt: string;
|
|
583
|
+
/** Basecamp API URL for this record (max 255 chars) */
|
|
584
|
+
url: string | null;
|
|
585
|
+
/** Basecamp web URL for this record (max 255 chars) */
|
|
586
|
+
appUrl: string | null;
|
|
587
|
+
/** Avatar image URL (max 255 chars) */
|
|
588
|
+
avatarUrl: string | null;
|
|
589
|
+
/** Full-size avatar image URL (max 255 chars) */
|
|
590
|
+
fullsizeAvatarUrl: string | null;
|
|
591
|
+
/** Update code (704 = queued for refresh, 1185 = refresh complete) */
|
|
592
|
+
updateCd: number;
|
|
593
|
+
/** Status code (704 = Active, 700 = Deleted) */
|
|
594
|
+
statusCd: number;
|
|
595
|
+
/** Process code (704 = Active) */
|
|
596
|
+
processCd: number;
|
|
597
|
+
[key: string]: unknown;
|
|
598
|
+
}
|
|
599
|
+
/** Returned by: api.basecamp2.people.list(params) */
|
|
600
|
+
export type PeopleListData = PeopleListItem[];
|
|
601
|
+
/**
|
|
602
|
+
* Get Person by ID
|
|
603
|
+
* Response data for GET /people/{id} — MINIMUM fields, extras pass through
|
|
604
|
+
*
|
|
605
|
+
* Returned by: api.basecamp2.people.get(id)
|
|
606
|
+
*/
|
|
607
|
+
export type PeopleGetData = PeopleListItem;
|
|
608
|
+
/**
|
|
609
|
+
* List Todo Metrics by Person
|
|
610
|
+
* Response data for GET /people/{id}/metrics — MINIMUM fields, extras pass through
|
|
611
|
+
*
|
|
612
|
+
* Returned by: api.basecamp2.people.metrics.list(id, params) (array items)
|
|
613
|
+
*/
|
|
614
|
+
export type PeopleMetricsListItem = MetricsListItem;
|
|
615
|
+
/** Returned by: api.basecamp2.people.metrics.list(id, params) */
|
|
616
|
+
export type PeopleMetricsListData = PeopleMetricsListItem[];
|
|
617
|
+
/**
|
|
618
|
+
* List Todos for Person
|
|
619
|
+
* Response data for GET /people/{id}/todos — MINIMUM fields, extras pass through
|
|
620
|
+
*
|
|
621
|
+
* Returned by: api.basecamp2.people.todos.list(id, params) (array items)
|
|
622
|
+
*/
|
|
623
|
+
export type PeopleTodosListItem = PeopleListItem;
|
|
624
|
+
/** Returned by: api.basecamp2.people.todos.list(id, params) */
|
|
625
|
+
export type PeopleTodosListData = PeopleTodosListItem[];
|
|
626
|
+
/**
|
|
627
|
+
* List Todos for Person on Project
|
|
628
|
+
* Response data for GET /people/{personId}/projects/{projectId}/todos — MINIMUM fields, extras pass
|
|
629
|
+
* through
|
|
630
|
+
*
|
|
631
|
+
* Returned by: api.basecamp2.people.projects.todos.list(personId, projectId, params) (array items)
|
|
632
|
+
*/
|
|
633
|
+
export type PeopleProjectsTodosListItem = PeopleListItem;
|
|
634
|
+
/** Returned by: api.basecamp2.people.projects.todos.list(personId, projectId, params) */
|
|
635
|
+
export type PeopleProjectsTodosListData = PeopleProjectsTodosListItem[];
|
|
636
|
+
/**
|
|
637
|
+
* List Projects
|
|
638
|
+
* Response data for GET /projects — MINIMUM fields, extras pass through
|
|
639
|
+
*
|
|
640
|
+
* Returned by: api.basecamp2.projects.list(params) (array items)
|
|
641
|
+
* Returned by: api.basecamp2.projects.get(id)
|
|
642
|
+
* Returned by: api.basecamp2.projects.todolists.list(id, params) (array items)
|
|
643
|
+
* Returned by: api.basecamp2.projects.todos.list(id, params) (array items)
|
|
644
|
+
* Returned by: api.basecamp2.projects.todolists.todos.list(projectId, todolistId, params) (array
|
|
645
|
+
* items)
|
|
646
|
+
*/
|
|
647
|
+
export interface ProjectsListItem {
|
|
648
|
+
/** Basecamp project ID */
|
|
649
|
+
id: number;
|
|
650
|
+
/** Project name (max 255 chars) */
|
|
651
|
+
name: string | null;
|
|
652
|
+
/** Project description (max 255 chars) */
|
|
653
|
+
description: string | null;
|
|
654
|
+
/** When the record was last updated in Basecamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
655
|
+
updatedAt: string;
|
|
656
|
+
/** When the record was created in Basecamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
657
|
+
createdAt: string;
|
|
658
|
+
/** When the last activity happened on the project (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
659
|
+
lastEventAt: string;
|
|
660
|
+
/** Basecamp API URL for this record (max 255 chars) */
|
|
661
|
+
url: string | null;
|
|
662
|
+
/** Basecamp web URL for this record (max 255 chars) */
|
|
663
|
+
appUrl: string | null;
|
|
664
|
+
/** Y when the project is a template (max 1 chars) */
|
|
665
|
+
templateFlag: string | null;
|
|
666
|
+
/** Y when the project is archived (max 1 chars) */
|
|
667
|
+
archivedFlag: string | null;
|
|
668
|
+
/** Y when the project is starred (max 1 chars) */
|
|
669
|
+
starredFlag: string | null;
|
|
670
|
+
/** Y when the record is in the Basecamp trash (max 1 chars) */
|
|
671
|
+
trashedFlag: string | null;
|
|
672
|
+
/** Y when the project is a draft (max 1 chars) */
|
|
673
|
+
draftFlag: string | null;
|
|
674
|
+
/** Y when the project is shared with a client (max 1 chars) */
|
|
675
|
+
isClientProjectFlag: string | null;
|
|
676
|
+
/** Project color in Basecamp (max 10 chars) */
|
|
677
|
+
color: string | null;
|
|
678
|
+
/** Update code (704 = queued for refresh, 1185 = refresh complete) */
|
|
679
|
+
updateCd: number;
|
|
680
|
+
/** Status code (704 = Active, 700 = Deleted) */
|
|
681
|
+
statusCd: number;
|
|
682
|
+
/** Process code (704 = Active) */
|
|
683
|
+
processCd: number;
|
|
684
|
+
[key: string]: unknown;
|
|
685
|
+
}
|
|
686
|
+
/** Returned by: api.basecamp2.projects.list(params) */
|
|
687
|
+
export type ProjectsListData = ProjectsListItem[];
|
|
688
|
+
/**
|
|
689
|
+
* Get Project by ID
|
|
690
|
+
* Response data for GET /projects/{id} — MINIMUM fields, extras pass through
|
|
691
|
+
*
|
|
692
|
+
* Returned by: api.basecamp2.projects.get(id)
|
|
693
|
+
*/
|
|
694
|
+
export type ProjectsGetData = ProjectsListItem;
|
|
695
|
+
/**
|
|
696
|
+
* List Todo Metrics by Project
|
|
697
|
+
* Response data for GET /projects/{id}/metrics — MINIMUM fields, extras pass through
|
|
698
|
+
*
|
|
699
|
+
* Returned by: api.basecamp2.projects.metrics.list(id, params) (array items)
|
|
700
|
+
*/
|
|
701
|
+
export type ProjectsMetricsListItem = MetricsListItem;
|
|
702
|
+
/** Returned by: api.basecamp2.projects.metrics.list(id, params) */
|
|
703
|
+
export type ProjectsMetricsListData = ProjectsMetricsListItem[];
|
|
704
|
+
/**
|
|
705
|
+
* List Todolists for Project
|
|
706
|
+
* Response data for GET /projects/{id}/todolists — MINIMUM fields, extras pass through
|
|
707
|
+
*
|
|
708
|
+
* Returned by: api.basecamp2.projects.todolists.list(id, params) (array items)
|
|
709
|
+
*/
|
|
710
|
+
export type ProjectsTodolistsListItem = ProjectsListItem;
|
|
711
|
+
/** Returned by: api.basecamp2.projects.todolists.list(id, params) */
|
|
712
|
+
export type ProjectsTodolistsListData = ProjectsTodolistsListItem[];
|
|
713
|
+
/**
|
|
714
|
+
* List Todos for Project
|
|
715
|
+
* Response data for GET /projects/{id}/todos — MINIMUM fields, extras pass through
|
|
716
|
+
*
|
|
717
|
+
* Returned by: api.basecamp2.projects.todos.list(id, params) (array items)
|
|
718
|
+
*/
|
|
719
|
+
export type ProjectsTodosListItem = ProjectsListItem;
|
|
720
|
+
/** Returned by: api.basecamp2.projects.todos.list(id, params) */
|
|
721
|
+
export type ProjectsTodosListData = ProjectsTodosListItem[];
|
|
722
|
+
/**
|
|
723
|
+
* List Todos in Todolist within Project
|
|
724
|
+
* Response data for GET /projects/{projectId}/todolists/{todolistId}/todos — MINIMUM fields, extras
|
|
725
|
+
* pass through
|
|
726
|
+
*
|
|
727
|
+
* Returned by: api.basecamp2.projects.todolists.todos.list(projectId, todolistId, params) (array
|
|
728
|
+
* items)
|
|
729
|
+
*/
|
|
730
|
+
export type ProjectsTodolistsTodosListItem = ProjectsListItem;
|
|
731
|
+
/** Returned by: api.basecamp2.projects.todolists.todos.list(projectId, todolistId, params) */
|
|
732
|
+
export type ProjectsTodolistsTodosListData = ProjectsTodolistsTodosListItem[];
|
|
733
|
+
/**
|
|
734
|
+
* List Todolists
|
|
735
|
+
* Response data for GET /todolists — MINIMUM fields, extras pass through
|
|
736
|
+
*
|
|
737
|
+
* Returned by: api.basecamp2.todolists.list(params) (array items)
|
|
738
|
+
* Returned by: api.basecamp2.todolists.get(id)
|
|
739
|
+
*/
|
|
740
|
+
export interface TodolistsListItem {
|
|
741
|
+
/** Basecamp todolist ID */
|
|
742
|
+
id: number;
|
|
743
|
+
/** Todolist name (max 255 chars) */
|
|
744
|
+
name: string | null;
|
|
745
|
+
/** Todolist description (max 255 chars) */
|
|
746
|
+
description: string | null;
|
|
747
|
+
/** When the record was last updated in Basecamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
748
|
+
updatedAt: string;
|
|
749
|
+
/** When the record was created in Basecamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
750
|
+
createdAt: string;
|
|
751
|
+
/** Basecamp API URL for this record (max 255 chars) */
|
|
752
|
+
url: string | null;
|
|
753
|
+
/** Basecamp web URL for this record (max 255 chars) */
|
|
754
|
+
appUrl: string | null;
|
|
755
|
+
/** Y when every to-do on the list is complete (max 1 chars) */
|
|
756
|
+
completedFlag: string | null;
|
|
757
|
+
/** Y when the list is hidden from clients (max 1 chars) */
|
|
758
|
+
privateFlag: string | null;
|
|
759
|
+
/** Y when the record is in the Basecamp trash (max 1 chars) */
|
|
760
|
+
trashedFlag: string | null;
|
|
761
|
+
/** Number of completed todos on the list */
|
|
762
|
+
completedCount: number | null;
|
|
763
|
+
/** Number of open todos on the list */
|
|
764
|
+
remainingCount: number | null;
|
|
765
|
+
/** Person who created the list */
|
|
766
|
+
creatorId: number | null;
|
|
767
|
+
/** Basecamp bucket (project) the list lives in */
|
|
768
|
+
bucketId: number | null;
|
|
769
|
+
/** Update code (704 = queued for refresh, 1185 = refresh complete) */
|
|
770
|
+
updateCd: number;
|
|
771
|
+
/** Sort position within the project */
|
|
772
|
+
position: number;
|
|
773
|
+
/** Status code (704 = Active, 700 = Deleted) */
|
|
774
|
+
statusCd: number;
|
|
775
|
+
/** Process code (704 = Active) */
|
|
776
|
+
processCd: number;
|
|
777
|
+
/** Project the list belongs to */
|
|
778
|
+
projectsId: number;
|
|
779
|
+
[key: string]: unknown;
|
|
780
|
+
}
|
|
781
|
+
/** Returned by: api.basecamp2.todolists.list(params) */
|
|
782
|
+
export type TodolistsListData = TodolistsListItem[];
|
|
783
|
+
/**
|
|
784
|
+
* Get Todolist Details
|
|
785
|
+
* Response data for GET /todolists/{id} — MINIMUM fields, extras pass through
|
|
786
|
+
*
|
|
787
|
+
* Returned by: api.basecamp2.todolists.get(id)
|
|
788
|
+
*/
|
|
789
|
+
export type TodolistsGetData = TodolistsListItem;
|
|
790
|
+
/**
|
|
791
|
+
* List Todos
|
|
792
|
+
* Response data for GET /todos — MINIMUM fields, extras pass through
|
|
793
|
+
*
|
|
794
|
+
* Returned by: api.basecamp2.todos.list(params) (array items)
|
|
795
|
+
* Returned by: api.basecamp2.todos.get(id)
|
|
796
|
+
* Returned by: api.basecamp2.todos.comments.list(id, params) (array items)
|
|
797
|
+
*/
|
|
798
|
+
export interface TodosListItem {
|
|
799
|
+
/** Basecamp to-do ID */
|
|
800
|
+
id: number;
|
|
801
|
+
/** Todolist the to-do belongs to */
|
|
802
|
+
todolistId: number | null;
|
|
803
|
+
/** To-do title (max 255 chars) */
|
|
804
|
+
content: string | null;
|
|
805
|
+
/** Due date and time (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
806
|
+
dueAt: string | null;
|
|
807
|
+
/** Due date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
808
|
+
dueOn: string | null;
|
|
809
|
+
/** When the record was last updated in Basecamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
810
|
+
updatedAt: string;
|
|
811
|
+
/** When the record was created in Basecamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
812
|
+
createdAt: string;
|
|
813
|
+
/** When the to-do was completed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
814
|
+
completedAt: string | null;
|
|
815
|
+
/** Number of comments on the to-do */
|
|
816
|
+
commentsCount: number | null;
|
|
817
|
+
/** Y when the to-do is hidden from clients (max 1 chars) */
|
|
818
|
+
privateFlag: string | null;
|
|
819
|
+
/** Y when the record is in the Basecamp trash (max 1 chars) */
|
|
820
|
+
trashedFlag: string | null;
|
|
821
|
+
/** Person who created the to-do */
|
|
822
|
+
creatorId: number | null;
|
|
823
|
+
/** Person the to-do is assigned to */
|
|
824
|
+
assigneeId: number | null;
|
|
825
|
+
/** Y when the to-do is complete (max 1 chars) */
|
|
826
|
+
completedFlag: string | null;
|
|
827
|
+
/** Basecamp API URL for this record (max 255 chars) */
|
|
828
|
+
url: string | null;
|
|
829
|
+
/** Basecamp web URL for this record (max 255 chars) */
|
|
830
|
+
appUrl: string | null;
|
|
831
|
+
/** Update code (704 = queued for refresh, 1185 = refresh complete) */
|
|
832
|
+
updateCd: number;
|
|
833
|
+
/** Sort position within the todolist */
|
|
834
|
+
position: number;
|
|
835
|
+
/** Project the to-do belongs to */
|
|
836
|
+
projectsId: number;
|
|
837
|
+
/** Full Basecamp to-do detail as JSON */
|
|
838
|
+
detailJson: string | null;
|
|
839
|
+
/** Detail fetch queue code (704 = queued, 1185 = fetched) */
|
|
840
|
+
pullDetailCd: number;
|
|
841
|
+
/** Process code (704 = Active) */
|
|
842
|
+
processCd: number;
|
|
843
|
+
/** agr_info sync queue code (704 = queued, 705 = skipped) */
|
|
844
|
+
agrInfoCd: number;
|
|
845
|
+
/** Status code (704 = Active, 700 = Deleted) */
|
|
846
|
+
statusCd: number;
|
|
847
|
+
/** When the latest comment was posted (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
848
|
+
lastCommentAt: string;
|
|
849
|
+
/** The 1536 dimensional vector that represents the comment */
|
|
850
|
+
vector: string | null;
|
|
851
|
+
/** Comments embedding queue code (704 = queued, 1185 = done) */
|
|
852
|
+
vectorCd: number;
|
|
853
|
+
/** Y when an embedding exists for the to-do (max 1 chars) */
|
|
854
|
+
vectorFlag: string;
|
|
855
|
+
/** When the comments embedding was last built (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
856
|
+
dateLastVector: string;
|
|
857
|
+
[key: string]: unknown;
|
|
858
|
+
}
|
|
859
|
+
/** Returned by: api.basecamp2.todos.list(params) */
|
|
860
|
+
export type TodosListData = TodosListItem[];
|
|
861
|
+
/**
|
|
862
|
+
* List Todo Summaries
|
|
863
|
+
* Response data for GET /todos-summary — MINIMUM fields, extras pass through
|
|
864
|
+
*
|
|
865
|
+
* Returned by: api.basecamp2.todosSummary.list(params) (array items)
|
|
866
|
+
* Returned by: api.basecamp2.todosSummary.get(id)
|
|
867
|
+
*/
|
|
868
|
+
export interface TodosSummaryListItem {
|
|
869
|
+
/** Primary key - same value as todos.id, enforced in code */
|
|
870
|
+
id: number;
|
|
871
|
+
/** AI-generated summary of ticket and comments */
|
|
872
|
+
summary: string | null;
|
|
873
|
+
/** Token estimate for summary size */
|
|
874
|
+
summaryTokens: number;
|
|
875
|
+
/** Full context blob in YAML format for knowledge base */
|
|
876
|
+
context: string | null;
|
|
877
|
+
/** Token estimate for context size */
|
|
878
|
+
contextTokens: number;
|
|
879
|
+
/** AI model used for generation (max 100 chars) */
|
|
880
|
+
modelName: string | null;
|
|
881
|
+
/** Base64 encoded 768-dim float32 vector (max 4200 chars) */
|
|
882
|
+
vector: string | null;
|
|
883
|
+
/** Vector processing code */
|
|
884
|
+
vectorCd: number;
|
|
885
|
+
/** Record status code */
|
|
886
|
+
statusCd: number;
|
|
887
|
+
/** Processing status code */
|
|
888
|
+
processCd: number;
|
|
889
|
+
/** Update tracking code */
|
|
890
|
+
updateCd: number;
|
|
891
|
+
/** Creation timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
892
|
+
dateCreated: string;
|
|
893
|
+
/** Last update timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
894
|
+
dateLastModified: string;
|
|
895
|
+
/** Akasha sync status code (704=needs sync, 1185=synced) */
|
|
896
|
+
akashaCd: number;
|
|
897
|
+
/** AI-assessed complexity score (1=trivial, 2=simple, 3=moderate, 4=complex, 5=major) */
|
|
898
|
+
complexityScore: number | null;
|
|
899
|
+
/** Brief explanation of complexity score (max 255 chars) */
|
|
900
|
+
complexityReason: string | null;
|
|
901
|
+
/** AI-estimated time to complete in minutes */
|
|
902
|
+
estimatedMinutes: number | null;
|
|
903
|
+
/** Comma-separated list of services/datatypes involved (max 255 chars) */
|
|
904
|
+
requiredServices: string | null;
|
|
905
|
+
/** Explanation of training worthiness assessment (max 255 chars) */
|
|
906
|
+
worthinessReason: string | null;
|
|
907
|
+
[key: string]: unknown;
|
|
908
|
+
}
|
|
909
|
+
/** Returned by: api.basecamp2.todosSummary.list(params) */
|
|
910
|
+
export type TodosSummaryListData = TodosSummaryListItem[];
|
|
911
|
+
/**
|
|
912
|
+
* Get Todo Summary Details
|
|
913
|
+
* Response data for GET /todos-summary/{id} — MINIMUM fields, extras pass through
|
|
914
|
+
*
|
|
915
|
+
* Returned by: api.basecamp2.todosSummary.get(id)
|
|
916
|
+
*/
|
|
917
|
+
export type TodosSummaryGetData = TodosSummaryListItem;
|
|
918
|
+
/**
|
|
919
|
+
* Get Todo Details
|
|
920
|
+
* Response data for GET /todos/{id} — MINIMUM fields, extras pass through
|
|
921
|
+
*
|
|
922
|
+
* Returned by: api.basecamp2.todos.get(id)
|
|
923
|
+
*/
|
|
924
|
+
export type TodosGetData = TodosListItem;
|
|
925
|
+
/**
|
|
926
|
+
* List Comments for Todo
|
|
927
|
+
* Response data for GET /todos/{id}/comments — MINIMUM fields, extras pass through
|
|
928
|
+
*
|
|
929
|
+
* Returned by: api.basecamp2.todos.comments.list(id, params) (array items)
|
|
930
|
+
*/
|
|
931
|
+
export type TodosCommentsListItem = TodosListItem;
|
|
932
|
+
/** Returned by: api.basecamp2.todos.comments.list(id, params) */
|
|
933
|
+
export type TodosCommentsListData = TodosCommentsListItem[];
|
|
934
|
+
/**
|
|
935
|
+
* List Events for a Todo
|
|
936
|
+
* Response data for GET /todos/{id}/events — MINIMUM fields, extras pass through
|
|
937
|
+
*
|
|
938
|
+
* Returned by: api.basecamp2.todos.events.list(id, params) (array items)
|
|
939
|
+
*/
|
|
940
|
+
export type TodosEventsListItem = EventsListItem;
|
|
941
|
+
/** Returned by: api.basecamp2.todos.events.list(id, params) */
|
|
942
|
+
export type TodosEventsListData = TodosEventsListItem[];
|
|
943
|
+
/**
|
|
944
|
+
* Get Todo Event Details
|
|
945
|
+
* Response data for GET /todos/{id}/events/{eventNum} — MINIMUM fields, extras pass through
|
|
946
|
+
*
|
|
947
|
+
* Returned by: api.basecamp2.todos.events.get(id, eventNum)
|
|
948
|
+
*/
|
|
949
|
+
export type TodosEventsGetData = EventsListItem;
|
|
950
|
+
/**
|
|
951
|
+
* Get Todo Metrics Detail
|
|
952
|
+
* Response data for GET /todos/{id}/metrics — MINIMUM fields, extras pass through
|
|
953
|
+
*
|
|
954
|
+
* Returned by: api.basecamp2.todos.metrics.list(id)
|
|
955
|
+
*/
|
|
956
|
+
export type TodosMetricsListData = MetricsListItem;
|
|
957
|
+
/**
|
|
958
|
+
* List Sessions for Todo
|
|
959
|
+
* Response data for GET /todos/{id}/sessions — MINIMUM fields, extras pass through
|
|
960
|
+
*
|
|
961
|
+
* Returned by: api.basecamp2.todos.sessions.list(id, params) (array items)
|
|
962
|
+
* Returned by: api.basecamp2.todos.sessions.create(id, data)
|
|
963
|
+
* Returned by: api.basecamp2.todos.sessions.get(id, sessionId)
|
|
964
|
+
* Returned by: api.basecamp2.todos.sessions.update(id, sessionId, data)
|
|
965
|
+
* Returned by: api.basecamp2.todos.sessions.delete(id, sessionId)
|
|
966
|
+
*/
|
|
967
|
+
export interface TodosSessionsListItem {
|
|
968
|
+
/** Primary key */
|
|
969
|
+
todosSessionsUid: number;
|
|
970
|
+
/** FK to todos.id */
|
|
971
|
+
todosId: number;
|
|
972
|
+
/** Session sequence number (1, 2, 3...) */
|
|
973
|
+
sessionNum: number;
|
|
974
|
+
/** Session status (open/closed/blocked) */
|
|
975
|
+
sessionStatusCd: number;
|
|
976
|
+
/** Session subject/title (max 255 chars) */
|
|
977
|
+
subject: string | null;
|
|
978
|
+
/** Problem statement */
|
|
979
|
+
problem: string | null;
|
|
980
|
+
/** Investigation notes */
|
|
981
|
+
investigation: string | null;
|
|
982
|
+
/** Execution plan */
|
|
983
|
+
plan: string | null;
|
|
984
|
+
/** Session outcome/result */
|
|
985
|
+
outcome: string | null;
|
|
986
|
+
/** Record creation timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
987
|
+
dateCreated: string;
|
|
988
|
+
/** Record update timestamp (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
989
|
+
dateLastModified: string;
|
|
990
|
+
/** Datasync update code */
|
|
991
|
+
updateCd: number;
|
|
992
|
+
/** Record status */
|
|
993
|
+
statusCd: number;
|
|
994
|
+
/** Processing code */
|
|
995
|
+
processCd: number;
|
|
996
|
+
[key: string]: unknown;
|
|
997
|
+
}
|
|
998
|
+
/** Returned by: api.basecamp2.todos.sessions.list(id, params) */
|
|
999
|
+
export type TodosSessionsListData = TodosSessionsListItem[];
|
|
1000
|
+
/**
|
|
1001
|
+
* Create Session for Todo
|
|
1002
|
+
* Response data for POST /todos/{id}/sessions — MINIMUM fields, extras pass through
|
|
1003
|
+
*
|
|
1004
|
+
* Returned by: api.basecamp2.todos.sessions.create(id, data)
|
|
1005
|
+
*/
|
|
1006
|
+
export type TodosSessionsCreateData = TodosSessionsListItem;
|
|
1007
|
+
/**
|
|
1008
|
+
* Create Session for Todo
|
|
1009
|
+
* Request body for POST /todos/{id}/sessions — MINIMUM fields, extras pass through
|
|
1010
|
+
*
|
|
1011
|
+
* Request body of: api.basecamp2.todos.sessions.create(id, data)
|
|
1012
|
+
*/
|
|
1013
|
+
export interface TodosSessionsCreateBody {
|
|
1014
|
+
/** Session subject */
|
|
1015
|
+
subject?: string | null;
|
|
1016
|
+
/** Problem statement */
|
|
1017
|
+
problem?: string | null;
|
|
1018
|
+
/** Investigation notes */
|
|
1019
|
+
investigation?: string | null;
|
|
1020
|
+
/** Planned approach */
|
|
1021
|
+
plan?: string | null;
|
|
1022
|
+
/** Session outcome */
|
|
1023
|
+
outcome?: string | null;
|
|
1024
|
+
[key: string]: unknown;
|
|
1025
|
+
}
|
|
1026
|
+
/**
|
|
1027
|
+
* Get Session Details
|
|
1028
|
+
* Response data for GET /todos/{id}/sessions/{sessionId} — MINIMUM fields, extras pass through
|
|
1029
|
+
*
|
|
1030
|
+
* Returned by: api.basecamp2.todos.sessions.get(id, sessionId)
|
|
1031
|
+
*/
|
|
1032
|
+
export type TodosSessionsGetData = TodosSessionsListItem;
|
|
1033
|
+
/**
|
|
1034
|
+
* Update Session
|
|
1035
|
+
* Response data for PUT /todos/{id}/sessions/{sessionId} — MINIMUM fields, extras pass through
|
|
1036
|
+
*
|
|
1037
|
+
* Returned by: api.basecamp2.todos.sessions.update(id, sessionId, data)
|
|
1038
|
+
*/
|
|
1039
|
+
export type TodosSessionsUpdateData = TodosSessionsListItem;
|
|
1040
|
+
/**
|
|
1041
|
+
* Update Session
|
|
1042
|
+
* Request body for PUT /todos/{id}/sessions/{sessionId} — MINIMUM fields, extras pass through
|
|
1043
|
+
*
|
|
1044
|
+
* Request body of: api.basecamp2.todos.sessions.update(id, sessionId, data)
|
|
1045
|
+
*/
|
|
1046
|
+
export interface TodosSessionsUpdateBody {
|
|
1047
|
+
/** Session subject */
|
|
1048
|
+
subject?: string | null;
|
|
1049
|
+
/** Problem statement */
|
|
1050
|
+
problem?: string | null;
|
|
1051
|
+
/** Investigation notes */
|
|
1052
|
+
investigation?: string | null;
|
|
1053
|
+
/** Planned approach */
|
|
1054
|
+
plan?: string | null;
|
|
1055
|
+
/** Session outcome */
|
|
1056
|
+
outcome?: string | null;
|
|
1057
|
+
/** Session status (100 = Open, 101 = Closed, 102 = Blocked) */
|
|
1058
|
+
sessionStatusCd?: number | null;
|
|
1059
|
+
/** Status code; an invalid code is ignored */
|
|
1060
|
+
statusCd?: number | null;
|
|
1061
|
+
/** Process code; an invalid code is ignored */
|
|
1062
|
+
processCd?: number | null;
|
|
1063
|
+
/** Update code; an invalid code is ignored */
|
|
1064
|
+
updateCd?: number | null;
|
|
1065
|
+
[key: string]: unknown;
|
|
1066
|
+
}
|
|
1067
|
+
/**
|
|
1068
|
+
* Delete Session
|
|
1069
|
+
* Response data for DELETE /todos/{id}/sessions/{sessionId} — MINIMUM fields, extras pass through
|
|
1070
|
+
*
|
|
1071
|
+
* Returned by: api.basecamp2.todos.sessions.delete(id, sessionId)
|
|
1072
|
+
*/
|
|
1073
|
+
export type TodosSessionsDeleteData = TodosSessionsListItem;
|
|
1074
|
+
export interface Basecamp2ClientSpec {
|
|
1075
|
+
comments: {
|
|
1076
|
+
/**
|
|
1077
|
+
* List Comments
|
|
1078
|
+
* Call: api.basecamp2.comments.list(params)
|
|
1079
|
+
*
|
|
1080
|
+
* Errors:
|
|
1081
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1082
|
+
*
|
|
1083
|
+
* GET https://basecamp2.augur-api.com/comments
|
|
1084
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1comments/get
|
|
1085
|
+
*
|
|
1086
|
+
* @param params CommentsListParams (query string)
|
|
1087
|
+
* @returns BaseResponse whose `data` is CommentsListData
|
|
1088
|
+
*/
|
|
1089
|
+
list: (params?: CommentsListParams) => Promise<BaseResponse<CommentsListData>>;
|
|
1090
|
+
/**
|
|
1091
|
+
* Get Comment by ID
|
|
1092
|
+
* Call: api.basecamp2.comments.get(id)
|
|
1093
|
+
*
|
|
1094
|
+
* Errors:
|
|
1095
|
+
* 404: No comment with this id.
|
|
1096
|
+
*
|
|
1097
|
+
* GET https://basecamp2.augur-api.com/comments/{id}
|
|
1098
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1comments~1{id}/get
|
|
1099
|
+
*
|
|
1100
|
+
* @param id Comment ID
|
|
1101
|
+
* @param params CommentsGetParams (query string)
|
|
1102
|
+
* @returns BaseResponse whose `data` is CommentsGetData
|
|
1103
|
+
*/
|
|
1104
|
+
get: (id: number, params?: CommentsGetParams) => Promise<BaseResponse<CommentsGetData>>;
|
|
1105
|
+
};
|
|
1106
|
+
events: {
|
|
1107
|
+
/**
|
|
1108
|
+
* List Todo Events
|
|
1109
|
+
* Call: api.basecamp2.events.list(params)
|
|
1110
|
+
*
|
|
1111
|
+
* Errors:
|
|
1112
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1113
|
+
*
|
|
1114
|
+
* GET https://basecamp2.augur-api.com/events
|
|
1115
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1events/get
|
|
1116
|
+
*
|
|
1117
|
+
* @param params EventsListParams (query string)
|
|
1118
|
+
* @returns BaseResponse whose `data` is EventsListData
|
|
1119
|
+
*/
|
|
1120
|
+
list: (params?: EventsListParams) => Promise<BaseResponse<EventsListData>>;
|
|
1121
|
+
};
|
|
1122
|
+
metrics: {
|
|
1123
|
+
/**
|
|
1124
|
+
* List Todo Metrics
|
|
1125
|
+
* Call: api.basecamp2.metrics.list(params)
|
|
1126
|
+
*
|
|
1127
|
+
* Errors:
|
|
1128
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1129
|
+
*
|
|
1130
|
+
* GET https://basecamp2.augur-api.com/metrics
|
|
1131
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1metrics/get
|
|
1132
|
+
*
|
|
1133
|
+
* @param params MetricsListParams (query string)
|
|
1134
|
+
* @returns BaseResponse whose `data` is MetricsListData
|
|
1135
|
+
*/
|
|
1136
|
+
list: (params?: MetricsListParams) => Promise<BaseResponse<MetricsListData>>;
|
|
1137
|
+
};
|
|
1138
|
+
people: {
|
|
1139
|
+
/**
|
|
1140
|
+
* List People with filters
|
|
1141
|
+
* Call: api.basecamp2.people.list(params)
|
|
1142
|
+
*
|
|
1143
|
+
* Errors:
|
|
1144
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1145
|
+
*
|
|
1146
|
+
* GET https://basecamp2.augur-api.com/people
|
|
1147
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1people/get
|
|
1148
|
+
*
|
|
1149
|
+
* @param params PeopleListParams (query string)
|
|
1150
|
+
* @returns BaseResponse whose `data` is PeopleListData
|
|
1151
|
+
*/
|
|
1152
|
+
list: (params?: PeopleListParams) => Promise<BaseResponse<PeopleListData>>;
|
|
1153
|
+
/**
|
|
1154
|
+
* Get Person by ID
|
|
1155
|
+
* Call: api.basecamp2.people.get(id)
|
|
1156
|
+
*
|
|
1157
|
+
* Errors:
|
|
1158
|
+
* 404: No person with this id.
|
|
1159
|
+
*
|
|
1160
|
+
* GET https://basecamp2.augur-api.com/people/{id}
|
|
1161
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1people~1{id}/get
|
|
1162
|
+
*
|
|
1163
|
+
* @param id Person ID
|
|
1164
|
+
* @param params PeopleGetParams (query string)
|
|
1165
|
+
* @returns BaseResponse whose `data` is PeopleGetData
|
|
1166
|
+
*/
|
|
1167
|
+
get: (id: number, params?: PeopleGetParams) => Promise<BaseResponse<PeopleGetData>>;
|
|
1168
|
+
metrics: {
|
|
1169
|
+
/**
|
|
1170
|
+
* List Todo Metrics by Person
|
|
1171
|
+
* Call: api.basecamp2.people.metrics.list(id, params)
|
|
1172
|
+
*
|
|
1173
|
+
* Errors:
|
|
1174
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1175
|
+
* 404: No person with this id.
|
|
1176
|
+
*
|
|
1177
|
+
* GET https://basecamp2.augur-api.com/people/{id}/metrics
|
|
1178
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1people~1{id}~1metrics/get
|
|
1179
|
+
*
|
|
1180
|
+
* @param id Person ID (assignee)
|
|
1181
|
+
* @param params PeopleMetricsListParams (query string)
|
|
1182
|
+
* @returns BaseResponse whose `data` is PeopleMetricsListData
|
|
1183
|
+
*/
|
|
1184
|
+
list: (id: number, params?: PeopleMetricsListParams) => Promise<BaseResponse<PeopleMetricsListData>>;
|
|
1185
|
+
};
|
|
1186
|
+
projects: {
|
|
1187
|
+
todos: {
|
|
1188
|
+
/**
|
|
1189
|
+
* List Todos for Person on Project
|
|
1190
|
+
* Call: api.basecamp2.people.projects.todos.list(personId, projectId, params)
|
|
1191
|
+
*
|
|
1192
|
+
* Errors:
|
|
1193
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1194
|
+
* 404: No person with this personId, or no project with this projectId.
|
|
1195
|
+
*
|
|
1196
|
+
* GET https://basecamp2.augur-api.com/people/{personId}/projects/{projectId}/todos
|
|
1197
|
+
* Contract:
|
|
1198
|
+
* https://basecamp2.augur-api.com/openapi.json#/paths/~1people~1{personId}~1projects~1{projectId}~1todos/get
|
|
1199
|
+
*
|
|
1200
|
+
* @param personId Person ID (assignee)
|
|
1201
|
+
* @param projectId Basecamp project the todos belong to
|
|
1202
|
+
* @param params PeopleProjectsTodosListParams (query string)
|
|
1203
|
+
* @returns BaseResponse whose `data` is PeopleProjectsTodosListData
|
|
1204
|
+
*/
|
|
1205
|
+
list: (personId: number, projectId: number, params?: PeopleProjectsTodosListParams) => Promise<BaseResponse<PeopleProjectsTodosListData>>;
|
|
1206
|
+
};
|
|
1207
|
+
};
|
|
1208
|
+
todos: {
|
|
1209
|
+
/**
|
|
1210
|
+
* List Todos for Person
|
|
1211
|
+
* Call: api.basecamp2.people.todos.list(id, params)
|
|
1212
|
+
*
|
|
1213
|
+
* Errors:
|
|
1214
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1215
|
+
* 404: No person with this id.
|
|
1216
|
+
*
|
|
1217
|
+
* GET https://basecamp2.augur-api.com/people/{id}/todos
|
|
1218
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1people~1{id}~1todos/get
|
|
1219
|
+
*
|
|
1220
|
+
* @param id Person ID (assignee)
|
|
1221
|
+
* @param params PeopleTodosListParams (query string)
|
|
1222
|
+
* @returns BaseResponse whose `data` is PeopleTodosListData
|
|
1223
|
+
*/
|
|
1224
|
+
list: (id: number, params?: PeopleTodosListParams) => Promise<BaseResponse<PeopleTodosListData>>;
|
|
1225
|
+
};
|
|
1226
|
+
};
|
|
1227
|
+
projects: {
|
|
1228
|
+
/**
|
|
1229
|
+
* List Projects
|
|
1230
|
+
* Call: api.basecamp2.projects.list(params)
|
|
1231
|
+
*
|
|
1232
|
+
* Errors:
|
|
1233
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1234
|
+
*
|
|
1235
|
+
* GET https://basecamp2.augur-api.com/projects
|
|
1236
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1projects/get
|
|
1237
|
+
*
|
|
1238
|
+
* @param params ProjectsListParams (query string)
|
|
1239
|
+
* @returns BaseResponse whose `data` is ProjectsListData
|
|
1240
|
+
*/
|
|
1241
|
+
list: (params?: ProjectsListParams) => Promise<BaseResponse<ProjectsListData>>;
|
|
1242
|
+
/**
|
|
1243
|
+
* Get Project by ID
|
|
1244
|
+
* Call: api.basecamp2.projects.get(id)
|
|
1245
|
+
*
|
|
1246
|
+
* Errors:
|
|
1247
|
+
* 404: No project with this id.
|
|
1248
|
+
*
|
|
1249
|
+
* GET https://basecamp2.augur-api.com/projects/{id}
|
|
1250
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1projects~1{id}/get
|
|
1251
|
+
*
|
|
1252
|
+
* @param id Project ID
|
|
1253
|
+
* @param params ProjectsGetParams (query string)
|
|
1254
|
+
* @returns BaseResponse whose `data` is ProjectsGetData
|
|
1255
|
+
*/
|
|
1256
|
+
get: (id: number, params?: ProjectsGetParams) => Promise<BaseResponse<ProjectsGetData>>;
|
|
1257
|
+
metrics: {
|
|
1258
|
+
/**
|
|
1259
|
+
* List Todo Metrics by Project
|
|
1260
|
+
* Call: api.basecamp2.projects.metrics.list(id, params)
|
|
1261
|
+
*
|
|
1262
|
+
* Errors:
|
|
1263
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1264
|
+
* 404: No project with this id.
|
|
1265
|
+
*
|
|
1266
|
+
* GET https://basecamp2.augur-api.com/projects/{id}/metrics
|
|
1267
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1projects~1{id}~1metrics/get
|
|
1268
|
+
*
|
|
1269
|
+
* @param id Project ID
|
|
1270
|
+
* @param params ProjectsMetricsListParams (query string)
|
|
1271
|
+
* @returns BaseResponse whose `data` is ProjectsMetricsListData
|
|
1272
|
+
*/
|
|
1273
|
+
list: (id: number, params?: ProjectsMetricsListParams) => Promise<BaseResponse<ProjectsMetricsListData>>;
|
|
1274
|
+
};
|
|
1275
|
+
todolists: {
|
|
1276
|
+
/**
|
|
1277
|
+
* List Todolists for Project
|
|
1278
|
+
* Call: api.basecamp2.projects.todolists.list(id, params)
|
|
1279
|
+
*
|
|
1280
|
+
* Errors:
|
|
1281
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1282
|
+
* 404: No project with this id.
|
|
1283
|
+
*
|
|
1284
|
+
* GET https://basecamp2.augur-api.com/projects/{id}/todolists
|
|
1285
|
+
* Contract:
|
|
1286
|
+
* https://basecamp2.augur-api.com/openapi.json#/paths/~1projects~1{id}~1todolists/get
|
|
1287
|
+
*
|
|
1288
|
+
* @param id Project ID
|
|
1289
|
+
* @param params ProjectsTodolistsListParams (query string)
|
|
1290
|
+
* @returns BaseResponse whose `data` is ProjectsTodolistsListData
|
|
1291
|
+
*/
|
|
1292
|
+
list: (id: number, params?: ProjectsTodolistsListParams) => Promise<BaseResponse<ProjectsTodolistsListData>>;
|
|
1293
|
+
todos: {
|
|
1294
|
+
/**
|
|
1295
|
+
* List Todos in Todolist within Project
|
|
1296
|
+
* Call: api.basecamp2.projects.todolists.todos.list(projectId, todolistId, params)
|
|
1297
|
+
*
|
|
1298
|
+
* Errors:
|
|
1299
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1300
|
+
* 404: No project with this projectId, or no todolist with this todolistId.
|
|
1301
|
+
*
|
|
1302
|
+
* GET https://basecamp2.augur-api.com/projects/{projectId}/todolists/{todolistId}/todos
|
|
1303
|
+
* Contract:
|
|
1304
|
+
* https://basecamp2.augur-api.com/openapi.json#/paths/~1projects~1{projectId}~1todolists~1{todolistId}~1todos/get
|
|
1305
|
+
*
|
|
1306
|
+
* @param projectId Basecamp project that owns the todolist
|
|
1307
|
+
* @param todolistId Todolist whose todos are listed
|
|
1308
|
+
* @param params ProjectsTodolistsTodosListParams (query string)
|
|
1309
|
+
* @returns BaseResponse whose `data` is ProjectsTodolistsTodosListData
|
|
1310
|
+
*/
|
|
1311
|
+
list: (projectId: number, todolistId: number, params?: ProjectsTodolistsTodosListParams) => Promise<BaseResponse<ProjectsTodolistsTodosListData>>;
|
|
1312
|
+
};
|
|
1313
|
+
};
|
|
1314
|
+
todos: {
|
|
1315
|
+
/**
|
|
1316
|
+
* List Todos for Project
|
|
1317
|
+
* Call: api.basecamp2.projects.todos.list(id, params)
|
|
1318
|
+
*
|
|
1319
|
+
* Errors:
|
|
1320
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1321
|
+
* 404: No project with this id.
|
|
1322
|
+
*
|
|
1323
|
+
* GET https://basecamp2.augur-api.com/projects/{id}/todos
|
|
1324
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1projects~1{id}~1todos/get
|
|
1325
|
+
*
|
|
1326
|
+
* @param id Project ID
|
|
1327
|
+
* @param params ProjectsTodosListParams (query string)
|
|
1328
|
+
* @returns BaseResponse whose `data` is ProjectsTodosListData
|
|
1329
|
+
*/
|
|
1330
|
+
list: (id: number, params?: ProjectsTodosListParams) => Promise<BaseResponse<ProjectsTodosListData>>;
|
|
1331
|
+
};
|
|
1332
|
+
};
|
|
1333
|
+
todolists: {
|
|
1334
|
+
/**
|
|
1335
|
+
* List Todolists
|
|
1336
|
+
* Call: api.basecamp2.todolists.list(params)
|
|
1337
|
+
*
|
|
1338
|
+
* Errors:
|
|
1339
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1340
|
+
*
|
|
1341
|
+
* GET https://basecamp2.augur-api.com/todolists
|
|
1342
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todolists/get
|
|
1343
|
+
*
|
|
1344
|
+
* @param params TodolistsListParams (query string)
|
|
1345
|
+
* @returns BaseResponse whose `data` is TodolistsListData
|
|
1346
|
+
*/
|
|
1347
|
+
list: (params?: TodolistsListParams) => Promise<BaseResponse<TodolistsListData>>;
|
|
1348
|
+
/**
|
|
1349
|
+
* Get Todolist Details
|
|
1350
|
+
* Call: api.basecamp2.todolists.get(id)
|
|
1351
|
+
*
|
|
1352
|
+
* Errors:
|
|
1353
|
+
* 404: No todolist with this id.
|
|
1354
|
+
*
|
|
1355
|
+
* GET https://basecamp2.augur-api.com/todolists/{id}
|
|
1356
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todolists~1{id}/get
|
|
1357
|
+
*
|
|
1358
|
+
* @param id Todolist ID
|
|
1359
|
+
* @param params TodolistsGetParams (query string)
|
|
1360
|
+
* @returns BaseResponse whose `data` is TodolistsGetData
|
|
1361
|
+
*/
|
|
1362
|
+
get: (id: number, params?: TodolistsGetParams) => Promise<BaseResponse<TodolistsGetData>>;
|
|
1363
|
+
};
|
|
1364
|
+
todos: {
|
|
1365
|
+
/**
|
|
1366
|
+
* List Todos
|
|
1367
|
+
* Call: api.basecamp2.todos.list(params)
|
|
1368
|
+
*
|
|
1369
|
+
* Errors:
|
|
1370
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1371
|
+
*
|
|
1372
|
+
* GET https://basecamp2.augur-api.com/todos
|
|
1373
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todos/get
|
|
1374
|
+
*
|
|
1375
|
+
* @param params TodosListParams (query string)
|
|
1376
|
+
* @returns BaseResponse whose `data` is TodosListData
|
|
1377
|
+
*/
|
|
1378
|
+
list: (params?: TodosListParams) => Promise<BaseResponse<TodosListData>>;
|
|
1379
|
+
/**
|
|
1380
|
+
* Get Todo Details
|
|
1381
|
+
* Call: api.basecamp2.todos.get(id)
|
|
1382
|
+
*
|
|
1383
|
+
* Errors:
|
|
1384
|
+
* 404: No todo with this id.
|
|
1385
|
+
*
|
|
1386
|
+
* GET https://basecamp2.augur-api.com/todos/{id}
|
|
1387
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todos~1{id}/get
|
|
1388
|
+
*
|
|
1389
|
+
* @param id Todo ID
|
|
1390
|
+
* @param params TodosGetParams (query string)
|
|
1391
|
+
* @returns BaseResponse whose `data` is TodosGetData
|
|
1392
|
+
*/
|
|
1393
|
+
get: (id: number, params?: TodosGetParams) => Promise<BaseResponse<TodosGetData>>;
|
|
1394
|
+
comments: {
|
|
1395
|
+
/**
|
|
1396
|
+
* List Comments for Todo
|
|
1397
|
+
* Call: api.basecamp2.todos.comments.list(id, params)
|
|
1398
|
+
*
|
|
1399
|
+
* Errors:
|
|
1400
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1401
|
+
* 404: No todo with this id.
|
|
1402
|
+
*
|
|
1403
|
+
* GET https://basecamp2.augur-api.com/todos/{id}/comments
|
|
1404
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todos~1{id}~1comments/get
|
|
1405
|
+
*
|
|
1406
|
+
* @param id Todo ID
|
|
1407
|
+
* @param params TodosCommentsListParams (query string)
|
|
1408
|
+
* @returns BaseResponse whose `data` is TodosCommentsListData
|
|
1409
|
+
*/
|
|
1410
|
+
list: (id: number, params?: TodosCommentsListParams) => Promise<BaseResponse<TodosCommentsListData>>;
|
|
1411
|
+
};
|
|
1412
|
+
events: {
|
|
1413
|
+
/**
|
|
1414
|
+
* List Events for a Todo
|
|
1415
|
+
* Call: api.basecamp2.todos.events.list(id, params)
|
|
1416
|
+
*
|
|
1417
|
+
* Errors:
|
|
1418
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1419
|
+
* 404: No todo with this id.
|
|
1420
|
+
*
|
|
1421
|
+
* GET https://basecamp2.augur-api.com/todos/{id}/events
|
|
1422
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todos~1{id}~1events/get
|
|
1423
|
+
*
|
|
1424
|
+
* @param id Todos ID
|
|
1425
|
+
* @param params TodosEventsListParams (query string)
|
|
1426
|
+
* @returns BaseResponse whose `data` is TodosEventsListData
|
|
1427
|
+
*/
|
|
1428
|
+
list: (id: number, params?: TodosEventsListParams) => Promise<BaseResponse<TodosEventsListData>>;
|
|
1429
|
+
/**
|
|
1430
|
+
* Get Todo Event Details
|
|
1431
|
+
* Call: api.basecamp2.todos.events.get(id, eventNum)
|
|
1432
|
+
*
|
|
1433
|
+
* Errors:
|
|
1434
|
+
* 404: No row exists with this ID.
|
|
1435
|
+
*
|
|
1436
|
+
* GET https://basecamp2.augur-api.com/todos/{id}/events/{eventNum}
|
|
1437
|
+
* Contract:
|
|
1438
|
+
* https://basecamp2.augur-api.com/openapi.json#/paths/~1todos~1{id}~1events~1{eventNum}/get
|
|
1439
|
+
*
|
|
1440
|
+
* @param id Todos ID
|
|
1441
|
+
* @param eventNum Event sequence number (0=created, 1+=comments)
|
|
1442
|
+
* @param params TodosEventsGetParams (query string)
|
|
1443
|
+
* @returns BaseResponse whose `data` is TodosEventsGetData
|
|
1444
|
+
*/
|
|
1445
|
+
get: (id: number, eventNum: number, params?: TodosEventsGetParams) => Promise<BaseResponse<TodosEventsGetData>>;
|
|
1446
|
+
};
|
|
1447
|
+
metrics: {
|
|
1448
|
+
/**
|
|
1449
|
+
* Get Todo Metrics Detail
|
|
1450
|
+
* Call: api.basecamp2.todos.metrics.list(id)
|
|
1451
|
+
*
|
|
1452
|
+
* Errors:
|
|
1453
|
+
* 404: No todo metrics with this id.
|
|
1454
|
+
*
|
|
1455
|
+
* GET https://basecamp2.augur-api.com/todos/{id}/metrics
|
|
1456
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todos~1{id}~1metrics/get
|
|
1457
|
+
*
|
|
1458
|
+
* @param id Todo ID
|
|
1459
|
+
* @param params TodosMetricsListParams (query string)
|
|
1460
|
+
* @returns BaseResponse whose `data` is TodosMetricsListData
|
|
1461
|
+
*/
|
|
1462
|
+
list: (id: number, params?: TodosMetricsListParams) => Promise<BaseResponse<TodosMetricsListData>>;
|
|
1463
|
+
};
|
|
1464
|
+
sessions: {
|
|
1465
|
+
/**
|
|
1466
|
+
* List Sessions for Todo
|
|
1467
|
+
* Call: api.basecamp2.todos.sessions.list(id, params)
|
|
1468
|
+
*
|
|
1469
|
+
* Errors:
|
|
1470
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1471
|
+
* 404: No todo with this id.
|
|
1472
|
+
*
|
|
1473
|
+
* GET https://basecamp2.augur-api.com/todos/{id}/sessions
|
|
1474
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todos~1{id}~1sessions/get
|
|
1475
|
+
*
|
|
1476
|
+
* @param id Todo ID
|
|
1477
|
+
* @param params TodosSessionsListParams (query string)
|
|
1478
|
+
* @returns BaseResponse whose `data` is TodosSessionsListData
|
|
1479
|
+
*/
|
|
1480
|
+
list: (id: number, params?: TodosSessionsListParams) => Promise<BaseResponse<TodosSessionsListData>>;
|
|
1481
|
+
/**
|
|
1482
|
+
* Create Session for Todo
|
|
1483
|
+
* Call: api.basecamp2.todos.sessions.create(id, data)
|
|
1484
|
+
*
|
|
1485
|
+
* Request body: New work session on a todos record, which comes from the path; every body
|
|
1486
|
+
* field is optional
|
|
1487
|
+
*
|
|
1488
|
+
* Errors:
|
|
1489
|
+
* 404: No todo with this id.
|
|
1490
|
+
*
|
|
1491
|
+
* POST https://basecamp2.augur-api.com/todos/{id}/sessions
|
|
1492
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todos~1{id}~1sessions/post
|
|
1493
|
+
*
|
|
1494
|
+
* @param id Todo ID
|
|
1495
|
+
* @param data TodosSessionsCreateBody (request body)
|
|
1496
|
+
* @returns BaseResponse whose `data` is TodosSessionsCreateData
|
|
1497
|
+
*/
|
|
1498
|
+
create: (id: number, data: TodosSessionsCreateBody) => Promise<BaseResponse<TodosSessionsCreateData>>;
|
|
1499
|
+
/**
|
|
1500
|
+
* Get Session Details
|
|
1501
|
+
* Call: api.basecamp2.todos.sessions.get(id, sessionId)
|
|
1502
|
+
*
|
|
1503
|
+
* Errors:
|
|
1504
|
+
* 404: No todo with this id, or no session with this sessionId on that todo.
|
|
1505
|
+
*
|
|
1506
|
+
* GET https://basecamp2.augur-api.com/todos/{id}/sessions/{sessionId}
|
|
1507
|
+
* Contract:
|
|
1508
|
+
* https://basecamp2.augur-api.com/openapi.json#/paths/~1todos~1{id}~1sessions~1{sessionId}/get
|
|
1509
|
+
*
|
|
1510
|
+
* @param id Todo ID
|
|
1511
|
+
* @param sessionId Session UID
|
|
1512
|
+
* @param params TodosSessionsGetParams (query string)
|
|
1513
|
+
* @returns BaseResponse whose `data` is TodosSessionsGetData
|
|
1514
|
+
*/
|
|
1515
|
+
get: (id: number, sessionId: number, params?: TodosSessionsGetParams) => Promise<BaseResponse<TodosSessionsGetData>>;
|
|
1516
|
+
/**
|
|
1517
|
+
* Update Session
|
|
1518
|
+
* Call: api.basecamp2.todos.sessions.update(id, sessionId, data)
|
|
1519
|
+
*
|
|
1520
|
+
* Request body: Partial update of a work session; an absent field keeps its current value, an
|
|
1521
|
+
* explicit null clears a text field
|
|
1522
|
+
*
|
|
1523
|
+
* Errors:
|
|
1524
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1525
|
+
* 404: No todo with this id, or no session with this sessionId on that todo.
|
|
1526
|
+
*
|
|
1527
|
+
* PUT https://basecamp2.augur-api.com/todos/{id}/sessions/{sessionId}
|
|
1528
|
+
* Contract:
|
|
1529
|
+
* https://basecamp2.augur-api.com/openapi.json#/paths/~1todos~1{id}~1sessions~1{sessionId}/put
|
|
1530
|
+
*
|
|
1531
|
+
* @param id Todo ID
|
|
1532
|
+
* @param sessionId Session UID
|
|
1533
|
+
* @param data TodosSessionsUpdateBody (request body)
|
|
1534
|
+
* @returns BaseResponse whose `data` is TodosSessionsUpdateData
|
|
1535
|
+
*/
|
|
1536
|
+
update: (id: number, sessionId: number, data: TodosSessionsUpdateBody) => Promise<BaseResponse<TodosSessionsUpdateData>>;
|
|
1537
|
+
/**
|
|
1538
|
+
* Delete Session
|
|
1539
|
+
* Call: api.basecamp2.todos.sessions.delete(id, sessionId)
|
|
1540
|
+
*
|
|
1541
|
+
* Errors:
|
|
1542
|
+
* 404: No todo with this id, or no session with this sessionId on that todo.
|
|
1543
|
+
*
|
|
1544
|
+
* DELETE https://basecamp2.augur-api.com/todos/{id}/sessions/{sessionId}
|
|
1545
|
+
* Contract:
|
|
1546
|
+
* https://basecamp2.augur-api.com/openapi.json#/paths/~1todos~1{id}~1sessions~1{sessionId}/delete
|
|
1547
|
+
*
|
|
1548
|
+
* @param id Todo ID
|
|
1549
|
+
* @param sessionId Session UID
|
|
1550
|
+
* @returns BaseResponse whose `data` is TodosSessionsDeleteData
|
|
1551
|
+
*/
|
|
1552
|
+
delete: (id: number, sessionId: number) => Promise<BaseResponse<TodosSessionsDeleteData>>;
|
|
1553
|
+
};
|
|
1554
|
+
};
|
|
1555
|
+
todosSummary: {
|
|
1556
|
+
/**
|
|
1557
|
+
* List Todo Summaries
|
|
1558
|
+
* Call: api.basecamp2.todosSummary.list(params)
|
|
1559
|
+
*
|
|
1560
|
+
* Errors:
|
|
1561
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1562
|
+
*
|
|
1563
|
+
* GET https://basecamp2.augur-api.com/todos-summary
|
|
1564
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todos-summary/get
|
|
1565
|
+
*
|
|
1566
|
+
* @param params TodosSummaryListParams (query string)
|
|
1567
|
+
* @returns BaseResponse whose `data` is TodosSummaryListData
|
|
1568
|
+
*/
|
|
1569
|
+
list: (params?: TodosSummaryListParams) => Promise<BaseResponse<TodosSummaryListData>>;
|
|
1570
|
+
/**
|
|
1571
|
+
* Get Todo Summary Details
|
|
1572
|
+
* Call: api.basecamp2.todosSummary.get(id)
|
|
1573
|
+
*
|
|
1574
|
+
* Errors:
|
|
1575
|
+
* 404: No todo summary with this id.
|
|
1576
|
+
*
|
|
1577
|
+
* GET https://basecamp2.augur-api.com/todos-summary/{id}
|
|
1578
|
+
* Contract: https://basecamp2.augur-api.com/openapi.json#/paths/~1todos-summary~1{id}/get
|
|
1579
|
+
*
|
|
1580
|
+
* @param id Todo Summary ID
|
|
1581
|
+
* @param params TodosSummaryGetParams (query string)
|
|
1582
|
+
* @returns BaseResponse whose `data` is TodosSummaryGetData
|
|
1583
|
+
*/
|
|
1584
|
+
get: (id: number, params?: TodosSummaryGetParams) => Promise<BaseResponse<TodosSummaryGetData>>;
|
|
1585
|
+
};
|
|
1586
|
+
}
|
|
1587
|
+
//# sourceMappingURL=types.d.ts.map
|