@rippling/rippling-sdk 0.2.0-alpha.28 → 0.2.0-alpha.30

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.
Files changed (431) hide show
  1. package/client.d.mts +25 -25
  2. package/client.d.mts.map +1 -1
  3. package/client.d.ts +25 -25
  4. package/client.d.ts.map +1 -1
  5. package/client.js +23 -23
  6. package/client.js.map +1 -1
  7. package/client.mjs +23 -23
  8. package/client.mjs.map +1 -1
  9. package/internal/utils/env.js +2 -2
  10. package/internal/utils/env.js.map +1 -1
  11. package/internal/utils/env.mjs +2 -2
  12. package/internal/utils/env.mjs.map +1 -1
  13. package/package.json +1 -1
  14. package/resources/business-partner-groups.d.mts +1 -1
  15. package/resources/business-partner-groups.d.ts +1 -1
  16. package/resources/business-partner-groups.js +1 -1
  17. package/resources/business-partner-groups.mjs +1 -1
  18. package/resources/business-partners.d.mts +1 -1
  19. package/resources/business-partners.d.ts +1 -1
  20. package/resources/business-partners.js +1 -1
  21. package/resources/business-partners.mjs +1 -1
  22. package/resources/candidate-applications.d.mts +1 -1
  23. package/resources/candidate-applications.d.ts +1 -1
  24. package/resources/candidate-applications.js +1 -1
  25. package/resources/candidate-applications.mjs +1 -1
  26. package/resources/candidates.d.mts +1 -1
  27. package/resources/candidates.d.ts +1 -1
  28. package/resources/candidates.js +1 -1
  29. package/resources/candidates.mjs +1 -1
  30. package/resources/companies.d.mts +1 -1
  31. package/resources/companies.d.ts +1 -1
  32. package/resources/companies.js +1 -1
  33. package/resources/companies.mjs +1 -1
  34. package/resources/compensation-bands-details.d.mts +1 -1
  35. package/resources/compensation-bands-details.d.ts +1 -1
  36. package/resources/compensation-bands-details.js +1 -1
  37. package/resources/compensation-bands-details.mjs +1 -1
  38. package/resources/compensations.d.mts +1 -1
  39. package/resources/compensations.d.ts +1 -1
  40. package/resources/compensations.js +1 -1
  41. package/resources/compensations.mjs +1 -1
  42. package/resources/custom-apps.d.mts +3 -3
  43. package/resources/custom-apps.d.ts +3 -3
  44. package/resources/custom-apps.js +3 -3
  45. package/resources/custom-apps.mjs +3 -3
  46. package/resources/custom-fields.d.mts +1 -1
  47. package/resources/custom-fields.d.ts +1 -1
  48. package/resources/custom-fields.js +1 -1
  49. package/resources/custom-fields.mjs +1 -1
  50. package/resources/custom-objects/custom-objects.d.mts +29 -5
  51. package/resources/custom-objects/custom-objects.d.mts.map +1 -1
  52. package/resources/custom-objects/custom-objects.d.ts +29 -5
  53. package/resources/custom-objects/custom-objects.d.ts.map +1 -1
  54. package/resources/custom-objects/custom-objects.js +5 -5
  55. package/resources/custom-objects/custom-objects.js.map +1 -1
  56. package/resources/custom-objects/custom-objects.mjs +5 -5
  57. package/resources/custom-objects/custom-objects.mjs.map +1 -1
  58. package/resources/custom-objects/fields.d.mts +71 -5
  59. package/resources/custom-objects/fields.d.mts.map +1 -1
  60. package/resources/custom-objects/fields.d.ts +71 -5
  61. package/resources/custom-objects/fields.d.ts.map +1 -1
  62. package/resources/custom-objects/fields.js +5 -5
  63. package/resources/custom-objects/fields.mjs +5 -5
  64. package/resources/custom-objects/records.d.mts +68 -11
  65. package/resources/custom-objects/records.d.mts.map +1 -1
  66. package/resources/custom-objects/records.d.ts +68 -11
  67. package/resources/custom-objects/records.d.ts.map +1 -1
  68. package/resources/custom-objects/records.js +10 -10
  69. package/resources/custom-objects/records.mjs +10 -10
  70. package/resources/custom-pages.d.mts +3 -3
  71. package/resources/custom-pages.d.ts +3 -3
  72. package/resources/custom-pages.js +3 -3
  73. package/resources/custom-pages.mjs +3 -3
  74. package/resources/custom-settings.d.mts +2 -2
  75. package/resources/custom-settings.d.ts +2 -2
  76. package/resources/custom-settings.js +2 -2
  77. package/resources/custom-settings.mjs +2 -2
  78. package/resources/departments.d.mts +2 -2
  79. package/resources/departments.d.ts +2 -2
  80. package/resources/departments.js +2 -2
  81. package/resources/departments.mjs +2 -2
  82. package/resources/draft-hires.d.mts +8 -0
  83. package/resources/draft-hires.d.mts.map +1 -1
  84. package/resources/draft-hires.d.ts +8 -0
  85. package/resources/draft-hires.d.ts.map +1 -1
  86. package/resources/earning-types.d.mts +48 -0
  87. package/resources/earning-types.d.mts.map +1 -0
  88. package/resources/earning-types.d.ts +48 -0
  89. package/resources/earning-types.d.ts.map +1 -0
  90. package/resources/earning-types.js +21 -0
  91. package/resources/earning-types.js.map +1 -0
  92. package/resources/earning-types.mjs +17 -0
  93. package/resources/earning-types.mjs.map +1 -0
  94. package/resources/employment-types.d.mts +1 -1
  95. package/resources/employment-types.d.ts +1 -1
  96. package/resources/employment-types.js +1 -1
  97. package/resources/employment-types.mjs +1 -1
  98. package/resources/entitlements.d.mts +1 -1
  99. package/resources/entitlements.d.ts +1 -1
  100. package/resources/entitlements.js +1 -1
  101. package/resources/entitlements.mjs +1 -1
  102. package/resources/functions/deployments.d.mts +10 -4
  103. package/resources/functions/deployments.d.mts.map +1 -1
  104. package/resources/functions/deployments.d.ts +10 -4
  105. package/resources/functions/deployments.d.ts.map +1 -1
  106. package/resources/functions/deployments.js +4 -4
  107. package/resources/functions/deployments.mjs +4 -4
  108. package/resources/functions/executions.d.mts +10 -4
  109. package/resources/functions/executions.d.mts.map +1 -1
  110. package/resources/functions/executions.d.ts +10 -4
  111. package/resources/functions/executions.d.ts.map +1 -1
  112. package/resources/functions/executions.js +4 -4
  113. package/resources/functions/executions.mjs +4 -4
  114. package/resources/functions/functions.d.mts +8 -14
  115. package/resources/functions/functions.d.mts.map +1 -1
  116. package/resources/functions/functions.d.ts +8 -14
  117. package/resources/functions/functions.d.ts.map +1 -1
  118. package/resources/functions/functions.js +6 -6
  119. package/resources/functions/functions.js.map +1 -1
  120. package/resources/functions/functions.mjs +6 -6
  121. package/resources/functions/functions.mjs.map +1 -1
  122. package/resources/functions/index.d.mts +1 -1
  123. package/resources/functions/index.d.mts.map +1 -1
  124. package/resources/functions/index.d.ts +1 -1
  125. package/resources/functions/index.d.ts.map +1 -1
  126. package/resources/functions/index.js.map +1 -1
  127. package/resources/functions/index.mjs.map +1 -1
  128. package/resources/headcount-positions.d.mts +1 -1
  129. package/resources/headcount-positions.d.ts +1 -1
  130. package/resources/headcount-positions.js +1 -1
  131. package/resources/headcount-positions.mjs +1 -1
  132. package/resources/headcount-priorities.d.mts +1 -1
  133. package/resources/headcount-priorities.d.ts +1 -1
  134. package/resources/headcount-priorities.js +1 -1
  135. package/resources/headcount-priorities.mjs +1 -1
  136. package/resources/index.d.mts +5 -5
  137. package/resources/index.d.mts.map +1 -1
  138. package/resources/index.d.ts +5 -5
  139. package/resources/index.d.ts.map +1 -1
  140. package/resources/index.js +10 -10
  141. package/resources/index.js.map +1 -1
  142. package/resources/index.mjs +4 -4
  143. package/resources/index.mjs.map +1 -1
  144. package/resources/job-assignments.d.mts +3 -3
  145. package/resources/job-assignments.d.ts +3 -3
  146. package/resources/job-assignments.js +3 -3
  147. package/resources/job-assignments.mjs +3 -3
  148. package/resources/job-codes.d.mts +3 -3
  149. package/resources/job-codes.d.ts +3 -3
  150. package/resources/job-codes.js +3 -3
  151. package/resources/job-codes.mjs +3 -3
  152. package/resources/job-dimensions.d.mts +2 -2
  153. package/resources/job-dimensions.d.ts +2 -2
  154. package/resources/job-dimensions.js +2 -2
  155. package/resources/job-dimensions.mjs +2 -2
  156. package/resources/job-functions.d.mts +1 -1
  157. package/resources/job-functions.d.ts +1 -1
  158. package/resources/job-functions.js +1 -1
  159. package/resources/job-functions.mjs +1 -1
  160. package/resources/job-pay-rate-exceptions.d.mts +2 -2
  161. package/resources/job-pay-rate-exceptions.d.ts +2 -2
  162. package/resources/job-pay-rate-exceptions.js +2 -2
  163. package/resources/job-pay-rate-exceptions.mjs +2 -2
  164. package/resources/job-requisitions.d.mts +1 -1
  165. package/resources/job-requisitions.d.ts +1 -1
  166. package/resources/job-requisitions.js +1 -1
  167. package/resources/job-requisitions.mjs +1 -1
  168. package/resources/kiosk-badges.d.mts +2 -2
  169. package/resources/kiosk-badges.d.ts +2 -2
  170. package/resources/kiosk-badges.js +2 -2
  171. package/resources/kiosk-badges.mjs +2 -2
  172. package/resources/leave-accruals.d.mts +1 -1
  173. package/resources/leave-accruals.d.ts +1 -1
  174. package/resources/leave-accruals.js +1 -1
  175. package/resources/leave-accruals.mjs +1 -1
  176. package/resources/leave-balances.d.mts +1 -1
  177. package/resources/leave-balances.d.ts +1 -1
  178. package/resources/leave-balances.js +1 -1
  179. package/resources/leave-balances.mjs +1 -1
  180. package/resources/leave-requests.d.mts +2 -2
  181. package/resources/leave-requests.d.ts +2 -2
  182. package/resources/leave-requests.js +2 -2
  183. package/resources/leave-requests.mjs +2 -2
  184. package/resources/leave-types.d.mts +1 -1
  185. package/resources/leave-types.d.ts +1 -1
  186. package/resources/leave-types.js +1 -1
  187. package/resources/leave-types.mjs +1 -1
  188. package/resources/legal-entities.d.mts +1 -1
  189. package/resources/legal-entities.d.ts +1 -1
  190. package/resources/legal-entities.js +1 -1
  191. package/resources/legal-entities.mjs +1 -1
  192. package/resources/levels.d.mts +1 -1
  193. package/resources/levels.d.ts +1 -1
  194. package/resources/levels.js +1 -1
  195. package/resources/levels.mjs +1 -1
  196. package/resources/location-factors.d.mts +1 -1
  197. package/resources/location-factors.d.ts +1 -1
  198. package/resources/location-factors.js +1 -1
  199. package/resources/location-factors.mjs +1 -1
  200. package/resources/metadata/components.d.mts +2 -2
  201. package/resources/metadata/components.d.ts +2 -2
  202. package/resources/metadata/components.js +2 -2
  203. package/resources/metadata/components.mjs +2 -2
  204. package/resources/metadata/metadata.d.mts +2 -2
  205. package/resources/metadata/metadata.d.ts +2 -2
  206. package/resources/metadata/metadata.js +2 -2
  207. package/resources/metadata/metadata.mjs +2 -2
  208. package/resources/metadata/summary.d.mts +2 -2
  209. package/resources/metadata/summary.d.ts +2 -2
  210. package/resources/metadata/summary.js +2 -2
  211. package/resources/metadata/summary.mjs +2 -2
  212. package/resources/metadata/types.d.mts +2 -2
  213. package/resources/metadata/types.d.ts +2 -2
  214. package/resources/metadata/types.js +2 -2
  215. package/resources/metadata/types.mjs +2 -2
  216. package/resources/object-categories.d.mts +17 -5
  217. package/resources/object-categories.d.mts.map +1 -1
  218. package/resources/object-categories.d.ts +17 -5
  219. package/resources/object-categories.d.ts.map +1 -1
  220. package/resources/object-categories.js +5 -5
  221. package/resources/object-categories.mjs +5 -5
  222. package/resources/payroll-runs.d.mts +195 -0
  223. package/resources/payroll-runs.d.mts.map +1 -0
  224. package/resources/payroll-runs.d.ts +195 -0
  225. package/resources/payroll-runs.d.ts.map +1 -0
  226. package/resources/payroll-runs.js +32 -0
  227. package/resources/payroll-runs.js.map +1 -0
  228. package/resources/payroll-runs.mjs +28 -0
  229. package/resources/payroll-runs.mjs.map +1 -0
  230. package/resources/platform-capabilities.d.mts +2 -2
  231. package/resources/platform-capabilities.d.ts +2 -2
  232. package/resources/platform-capabilities.js +2 -2
  233. package/resources/platform-capabilities.mjs +2 -2
  234. package/resources/report-runs.d.mts +60 -0
  235. package/resources/report-runs.d.mts.map +1 -1
  236. package/resources/report-runs.d.ts +60 -0
  237. package/resources/report-runs.d.ts.map +1 -1
  238. package/resources/reports/available-filters.d.mts +49 -0
  239. package/resources/reports/available-filters.d.mts.map +1 -0
  240. package/resources/reports/available-filters.d.ts +49 -0
  241. package/resources/reports/available-filters.d.ts.map +1 -0
  242. package/resources/reports/available-filters.js +20 -0
  243. package/resources/reports/available-filters.js.map +1 -0
  244. package/resources/reports/available-filters.mjs +16 -0
  245. package/resources/reports/available-filters.mjs.map +1 -0
  246. package/resources/reports/index.d.mts +3 -0
  247. package/resources/reports/index.d.mts.map +1 -0
  248. package/resources/reports/index.d.ts +3 -0
  249. package/resources/reports/index.d.ts.map +1 -0
  250. package/resources/reports/index.js +9 -0
  251. package/resources/reports/index.js.map +1 -0
  252. package/resources/reports/index.mjs +4 -0
  253. package/resources/reports/index.mjs.map +1 -0
  254. package/resources/reports/reports.d.mts +85 -0
  255. package/resources/reports/reports.d.mts.map +1 -0
  256. package/resources/reports/reports.d.ts +85 -0
  257. package/resources/reports/reports.d.ts.map +1 -0
  258. package/resources/reports/reports.js +27 -0
  259. package/resources/reports/reports.js.map +1 -0
  260. package/resources/reports/reports.mjs +22 -0
  261. package/resources/reports/reports.mjs.map +1 -0
  262. package/resources/reports.d.mts +2 -0
  263. package/resources/reports.d.mts.map +1 -0
  264. package/resources/reports.d.ts +2 -0
  265. package/resources/reports.d.ts.map +1 -0
  266. package/resources/reports.js +6 -0
  267. package/resources/reports.js.map +1 -0
  268. package/resources/reports.mjs +3 -0
  269. package/resources/reports.mjs.map +1 -0
  270. package/resources/schedules.d.mts +2 -2
  271. package/resources/schedules.d.ts +2 -2
  272. package/resources/schedules.js +2 -2
  273. package/resources/schedules.mjs +2 -2
  274. package/resources/shift-inputs.d.mts +2 -2
  275. package/resources/shift-inputs.d.ts +2 -2
  276. package/resources/shift-inputs.js +2 -2
  277. package/resources/shift-inputs.mjs +2 -2
  278. package/resources/shiftassignments.d.mts +2 -2
  279. package/resources/shiftassignments.d.ts +2 -2
  280. package/resources/shiftassignments.js +2 -2
  281. package/resources/shiftassignments.mjs +2 -2
  282. package/resources/teams.d.mts +1 -1
  283. package/resources/teams.d.ts +1 -1
  284. package/resources/teams.js +1 -1
  285. package/resources/teams.mjs +1 -1
  286. package/resources/time-cards.d.mts +1 -1
  287. package/resources/time-cards.d.ts +1 -1
  288. package/resources/time-cards.js +1 -1
  289. package/resources/time-cards.mjs +1 -1
  290. package/resources/time-entries.d.mts +2 -2
  291. package/resources/time-entries.d.ts +2 -2
  292. package/resources/time-entries.js +2 -2
  293. package/resources/time-entries.mjs +2 -2
  294. package/resources/titles.d.mts +2 -2
  295. package/resources/titles.d.ts +2 -2
  296. package/resources/titles.js +2 -2
  297. package/resources/titles.mjs +2 -2
  298. package/resources/tracks.d.mts +1 -1
  299. package/resources/tracks.d.ts +1 -1
  300. package/resources/tracks.js +1 -1
  301. package/resources/tracks.mjs +1 -1
  302. package/resources/unassignedshifts.d.mts +2 -2
  303. package/resources/unassignedshifts.d.ts +2 -2
  304. package/resources/unassignedshifts.js +2 -2
  305. package/resources/unassignedshifts.mjs +2 -2
  306. package/resources/users.d.mts +1 -1
  307. package/resources/users.d.ts +1 -1
  308. package/resources/users.js +1 -1
  309. package/resources/users.mjs +1 -1
  310. package/resources/work-locations.d.mts +2 -2
  311. package/resources/work-locations.d.ts +2 -2
  312. package/resources/work-locations.js +2 -2
  313. package/resources/work-locations.mjs +2 -2
  314. package/resources/workers.d.mts +1 -1
  315. package/resources/workers.d.ts +1 -1
  316. package/resources/workers.js +1 -1
  317. package/resources/workers.mjs +1 -1
  318. package/resources/workflow-action-executions.d.mts +572 -0
  319. package/resources/workflow-action-executions.d.mts.map +1 -0
  320. package/resources/workflow-action-executions.d.ts +572 -0
  321. package/resources/workflow-action-executions.d.ts.map +1 -0
  322. package/resources/{send-email.js → workflow-action-executions.js} +6 -6
  323. package/resources/workflow-action-executions.js.map +1 -0
  324. package/resources/{send-slack.mjs → workflow-action-executions.mjs} +4 -4
  325. package/resources/workflow-action-executions.mjs.map +1 -0
  326. package/src/client.ts +61 -51
  327. package/src/internal/utils/env.ts +2 -2
  328. package/src/resources/business-partner-groups.ts +1 -1
  329. package/src/resources/business-partners.ts +1 -1
  330. package/src/resources/candidate-applications.ts +1 -1
  331. package/src/resources/candidates.ts +1 -1
  332. package/src/resources/companies.ts +1 -1
  333. package/src/resources/compensation-bands-details.ts +1 -1
  334. package/src/resources/compensations.ts +1 -1
  335. package/src/resources/custom-apps.ts +3 -3
  336. package/src/resources/custom-fields.ts +1 -1
  337. package/src/resources/custom-objects/custom-objects.ts +29 -5
  338. package/src/resources/custom-objects/fields.ts +71 -5
  339. package/src/resources/custom-objects/records.ts +68 -11
  340. package/src/resources/custom-pages.ts +3 -3
  341. package/src/resources/custom-settings.ts +2 -2
  342. package/src/resources/departments.ts +2 -2
  343. package/src/resources/draft-hires.ts +10 -0
  344. package/src/resources/earning-types.ts +64 -0
  345. package/src/resources/employment-types.ts +1 -1
  346. package/src/resources/entitlements.ts +1 -1
  347. package/src/resources/functions/deployments.ts +10 -4
  348. package/src/resources/functions/executions.ts +10 -4
  349. package/src/resources/functions/functions.ts +9 -15
  350. package/src/resources/functions/index.ts +1 -0
  351. package/src/resources/headcount-positions.ts +1 -1
  352. package/src/resources/headcount-priorities.ts +1 -1
  353. package/src/resources/index.ts +19 -8
  354. package/src/resources/job-assignments.ts +3 -3
  355. package/src/resources/job-codes.ts +3 -3
  356. package/src/resources/job-dimensions.ts +2 -2
  357. package/src/resources/job-functions.ts +1 -1
  358. package/src/resources/job-pay-rate-exceptions.ts +2 -2
  359. package/src/resources/job-requisitions.ts +1 -1
  360. package/src/resources/kiosk-badges.ts +2 -2
  361. package/src/resources/leave-accruals.ts +1 -1
  362. package/src/resources/leave-balances.ts +1 -1
  363. package/src/resources/leave-requests.ts +2 -2
  364. package/src/resources/leave-types.ts +1 -1
  365. package/src/resources/legal-entities.ts +1 -1
  366. package/src/resources/levels.ts +1 -1
  367. package/src/resources/location-factors.ts +1 -1
  368. package/src/resources/metadata/components.ts +2 -2
  369. package/src/resources/metadata/metadata.ts +2 -2
  370. package/src/resources/metadata/summary.ts +2 -2
  371. package/src/resources/metadata/types.ts +2 -2
  372. package/src/resources/object-categories.ts +17 -5
  373. package/src/resources/payroll-runs.ts +251 -0
  374. package/src/resources/platform-capabilities.ts +2 -2
  375. package/src/resources/report-runs.ts +90 -0
  376. package/src/resources/reports/available-filters.ts +60 -0
  377. package/src/resources/reports/index.ts +4 -0
  378. package/src/resources/reports/reports.ts +112 -0
  379. package/src/resources/reports.ts +3 -0
  380. package/src/resources/schedules.ts +2 -2
  381. package/src/resources/shift-inputs.ts +2 -2
  382. package/src/resources/shiftassignments.ts +2 -2
  383. package/src/resources/teams.ts +1 -1
  384. package/src/resources/time-cards.ts +1 -1
  385. package/src/resources/time-entries.ts +2 -2
  386. package/src/resources/titles.ts +2 -2
  387. package/src/resources/tracks.ts +1 -1
  388. package/src/resources/unassignedshifts.ts +2 -2
  389. package/src/resources/users.ts +1 -1
  390. package/src/resources/work-locations.ts +2 -2
  391. package/src/resources/workers.ts +1 -1
  392. package/src/resources/workflow-action-executions.ts +925 -0
  393. package/src/version.ts +1 -1
  394. package/version.d.mts +1 -1
  395. package/version.d.ts +1 -1
  396. package/version.js +1 -1
  397. package/version.mjs +1 -1
  398. package/resources/create-app-notification.d.mts +0 -29
  399. package/resources/create-app-notification.d.mts.map +0 -1
  400. package/resources/create-app-notification.d.ts +0 -29
  401. package/resources/create-app-notification.d.ts.map +0 -1
  402. package/resources/create-app-notification.js +0 -18
  403. package/resources/create-app-notification.js.map +0 -1
  404. package/resources/create-app-notification.mjs +0 -14
  405. package/resources/create-app-notification.mjs.map +0 -1
  406. package/resources/run-query.d.mts +0 -39
  407. package/resources/run-query.d.mts.map +0 -1
  408. package/resources/run-query.d.ts +0 -39
  409. package/resources/run-query.d.ts.map +0 -1
  410. package/resources/run-query.js +0 -21
  411. package/resources/run-query.js.map +0 -1
  412. package/resources/run-query.mjs +0 -17
  413. package/resources/run-query.mjs.map +0 -1
  414. package/resources/send-email.d.mts +0 -33
  415. package/resources/send-email.d.mts.map +0 -1
  416. package/resources/send-email.d.ts +0 -33
  417. package/resources/send-email.d.ts.map +0 -1
  418. package/resources/send-email.js.map +0 -1
  419. package/resources/send-email.mjs +0 -14
  420. package/resources/send-email.mjs.map +0 -1
  421. package/resources/send-slack.d.mts +0 -30
  422. package/resources/send-slack.d.mts.map +0 -1
  423. package/resources/send-slack.d.ts +0 -30
  424. package/resources/send-slack.d.ts.map +0 -1
  425. package/resources/send-slack.js +0 -18
  426. package/resources/send-slack.js.map +0 -1
  427. package/resources/send-slack.mjs.map +0 -1
  428. package/src/resources/create-app-notification.ts +0 -46
  429. package/src/resources/run-query.ts +0 -51
  430. package/src/resources/send-email.ts +0 -48
  431. package/src/resources/send-slack.ts +0 -42
@@ -1,42 +0,0 @@
1
- // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
-
3
- import { APIResource } from '../core/resource';
4
- import { APIPromise } from '../core/api-promise';
5
- import { RequestOptions } from '../internal/request-options';
6
-
7
- /**
8
- * Execute workflow actions like sending emails, Slack messages, and notifications
9
- */
10
- export class SendSlack extends APIResource {
11
- /**
12
- * Send a Slack message to the specified recipients.
13
- */
14
- create(body: SendSlackCreateParams, options?: RequestOptions): APIPromise<SendSlackCreateResponse> {
15
- return this._client.post('/send-slack/', { body, ...options });
16
- }
17
- }
18
-
19
- export interface SendSlackCreateResponse {
20
- /**
21
- * Result of the send Slack message action
22
- */
23
- result: unknown;
24
- }
25
-
26
- export interface SendSlackCreateParams {
27
- /**
28
- * An enumeration.
29
- */
30
- action_type: 'SINGLE_DIRECT_MESSAGE' | 'GROUP_DIRECT_MESSAGE' | 'PUBLIC_CHANNEL_MESSAGE';
31
-
32
- body: string;
33
-
34
- recipients: Array<string>;
35
- }
36
-
37
- export declare namespace SendSlack {
38
- export {
39
- type SendSlackCreateResponse as SendSlackCreateResponse,
40
- type SendSlackCreateParams as SendSlackCreateParams,
41
- };
42
- }