@rippling/rippling-sdk 0.2.0-alpha.58 → 0.2.0-alpha.60

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 (168) hide show
  1. package/client.d.mts +6 -0
  2. package/client.d.mts.map +1 -1
  3. package/client.d.ts +6 -0
  4. package/client.d.ts.map +1 -1
  5. package/client.js +6 -0
  6. package/client.js.map +1 -1
  7. package/client.mjs +6 -0
  8. package/client.mjs.map +1 -1
  9. package/examples/manifest/dental-practice-management/dental-practice-management.ts +5 -10
  10. package/examples/manifest/dental-practice-management/functions/chair-schedule.ts +7 -10
  11. package/examples/manifest/dental-practice-management/functions/operatory-list.ts +7 -10
  12. package/examples/manifest/dental-practice-management/functions/patient-list.ts +7 -10
  13. package/examples/manifest/dental-practice-management/functions/treatment-plan-list.ts +7 -10
  14. package/examples/manifest/gym-membership-management/functions/check-in-desk.ts +7 -10
  15. package/examples/manifest/gym-membership-management/functions/member-list.ts +7 -10
  16. package/examples/manifest/gym-membership-management/functions/today-schedule.ts +7 -10
  17. package/examples/manifest/gym-membership-management/functions/trainer-list.ts +7 -10
  18. package/examples/manifest/gym-membership-management/gym-membership-management.ts +5 -10
  19. package/examples/manifest/simple-todo-app/functions/todo-list.ts +7 -10
  20. package/examples/manifest/simple-todo-app/simple-todo-app.ts +2 -3
  21. package/internal/tslib.js +0 -4
  22. package/lib/manifest/manifest-function.d.mts +3 -3
  23. package/lib/manifest/manifest-function.d.ts +3 -3
  24. package/lib/manifest/manifest-function.js +3 -3
  25. package/lib/manifest/manifest-function.mjs +3 -3
  26. package/lib/manifest/sdui-page.d.mts +0 -8
  27. package/lib/manifest/sdui-page.d.mts.map +1 -1
  28. package/lib/manifest/sdui-page.d.ts +0 -8
  29. package/lib/manifest/sdui-page.d.ts.map +1 -1
  30. package/lib/manifest/sdui-page.js +0 -4
  31. package/lib/manifest/sdui-page.js.map +1 -1
  32. package/lib/manifest/sdui-page.mjs +1 -5
  33. package/lib/manifest/sdui-page.mjs.map +1 -1
  34. package/package.json +1 -1
  35. package/resources/business-structure-paths.d.mts +109 -0
  36. package/resources/business-structure-paths.d.mts.map +1 -0
  37. package/resources/business-structure-paths.d.ts +109 -0
  38. package/resources/business-structure-paths.d.ts.map +1 -0
  39. package/resources/business-structure-paths.js +30 -0
  40. package/resources/business-structure-paths.js.map +1 -0
  41. package/resources/business-structure-paths.mjs +26 -0
  42. package/resources/business-structure-paths.mjs.map +1 -0
  43. package/resources/employee-documents.d.mts +14 -10
  44. package/resources/employee-documents.d.mts.map +1 -1
  45. package/resources/employee-documents.d.ts +14 -10
  46. package/resources/employee-documents.d.ts.map +1 -1
  47. package/resources/index.d.mts +1 -0
  48. package/resources/index.d.mts.map +1 -1
  49. package/resources/index.d.ts +1 -0
  50. package/resources/index.d.ts.map +1 -1
  51. package/resources/index.js +4 -2
  52. package/resources/index.js.map +1 -1
  53. package/resources/index.mjs +1 -0
  54. package/resources/index.mjs.map +1 -1
  55. package/src/client.ts +22 -0
  56. package/src/lib/manifest/manifest-function.ts +3 -3
  57. package/src/lib/manifest/sdui-page.ts +1 -12
  58. package/src/resources/business-structure-paths.ts +157 -0
  59. package/src/resources/employee-documents.ts +14 -10
  60. package/src/resources/index.ts +8 -0
  61. package/src/version.ts +1 -1
  62. package/version.d.mts +1 -1
  63. package/version.d.ts +1 -1
  64. package/version.js +1 -1
  65. package/version.mjs +1 -1
  66. package/examples/sdui/sdui-crud-todo/rippling-function.ts +0 -358
  67. package/examples/sdui/sdui-showcase/rippling-function.ts +0 -366
  68. package/examples/sdui/sdui-tab-multi-view/rippling-function.ts +0 -1042
  69. package/examples/sdui/vote/rippling-function.ts +0 -315
  70. package/lib/sdui/actions.d.mts +0 -25
  71. package/lib/sdui/actions.d.mts.map +0 -1
  72. package/lib/sdui/actions.d.ts +0 -25
  73. package/lib/sdui/actions.d.ts.map +0 -1
  74. package/lib/sdui/actions.js +0 -63
  75. package/lib/sdui/actions.js.map +0 -1
  76. package/lib/sdui/actions.mjs +0 -52
  77. package/lib/sdui/actions.mjs.map +0 -1
  78. package/lib/sdui/component.d.mts +0 -58
  79. package/lib/sdui/component.d.mts.map +0 -1
  80. package/lib/sdui/component.d.ts +0 -58
  81. package/lib/sdui/component.d.ts.map +0 -1
  82. package/lib/sdui/component.js +0 -128
  83. package/lib/sdui/component.js.map +0 -1
  84. package/lib/sdui/component.mjs +0 -124
  85. package/lib/sdui/component.mjs.map +0 -1
  86. package/lib/sdui/components.d.mts +0 -1047
  87. package/lib/sdui/components.d.mts.map +0 -1
  88. package/lib/sdui/components.d.ts +0 -1047
  89. package/lib/sdui/components.d.ts.map +0 -1
  90. package/lib/sdui/components.js +0 -845
  91. package/lib/sdui/components.js.map +0 -1
  92. package/lib/sdui/components.mjs +0 -840
  93. package/lib/sdui/components.mjs.map +0 -1
  94. package/lib/sdui/conditions.d.mts +0 -25
  95. package/lib/sdui/conditions.d.mts.map +0 -1
  96. package/lib/sdui/conditions.d.ts +0 -25
  97. package/lib/sdui/conditions.d.ts.map +0 -1
  98. package/lib/sdui/conditions.js +0 -47
  99. package/lib/sdui/conditions.js.map +0 -1
  100. package/lib/sdui/conditions.mjs +0 -35
  101. package/lib/sdui/conditions.mjs.map +0 -1
  102. package/lib/sdui/directives.d.mts +0 -18
  103. package/lib/sdui/directives.d.mts.map +0 -1
  104. package/lib/sdui/directives.d.ts +0 -18
  105. package/lib/sdui/directives.d.ts.map +0 -1
  106. package/lib/sdui/directives.js +0 -31
  107. package/lib/sdui/directives.js.map +0 -1
  108. package/lib/sdui/directives.mjs +0 -24
  109. package/lib/sdui/directives.mjs.map +0 -1
  110. package/lib/sdui/index.d.mts +0 -375
  111. package/lib/sdui/index.d.mts.map +0 -1
  112. package/lib/sdui/index.d.ts +0 -375
  113. package/lib/sdui/index.d.ts.map +0 -1
  114. package/lib/sdui/index.js +0 -386
  115. package/lib/sdui/index.js.map +0 -1
  116. package/lib/sdui/index.mjs +0 -215
  117. package/lib/sdui/index.mjs.map +0 -1
  118. package/lib/sdui/propTypes.d.mts +0 -5971
  119. package/lib/sdui/propTypes.d.mts.map +0 -1
  120. package/lib/sdui/propTypes.d.ts +0 -5971
  121. package/lib/sdui/propTypes.d.ts.map +0 -1
  122. package/lib/sdui/propTypes.js +0 -14
  123. package/lib/sdui/propTypes.js.map +0 -1
  124. package/lib/sdui/propTypes.mjs +0 -13
  125. package/lib/sdui/propTypes.mjs.map +0 -1
  126. package/lib/sdui/props.d.mts +0 -12
  127. package/lib/sdui/props.d.mts.map +0 -1
  128. package/lib/sdui/props.d.ts +0 -12
  129. package/lib/sdui/props.d.ts.map +0 -1
  130. package/lib/sdui/props.js +0 -25
  131. package/lib/sdui/props.js.map +0 -1
  132. package/lib/sdui/props.mjs +0 -21
  133. package/lib/sdui/props.mjs.map +0 -1
  134. package/lib/sdui/render.d.mts +0 -23
  135. package/lib/sdui/render.d.mts.map +0 -1
  136. package/lib/sdui/render.d.ts +0 -23
  137. package/lib/sdui/render.d.ts.map +0 -1
  138. package/lib/sdui/render.js +0 -48
  139. package/lib/sdui/render.js.map +0 -1
  140. package/lib/sdui/render.mjs +0 -45
  141. package/lib/sdui/render.mjs.map +0 -1
  142. package/lib/sdui/state.d.mts +0 -22
  143. package/lib/sdui/state.d.mts.map +0 -1
  144. package/lib/sdui/state.d.ts +0 -22
  145. package/lib/sdui/state.d.ts.map +0 -1
  146. package/lib/sdui/state.js +0 -59
  147. package/lib/sdui/state.js.map +0 -1
  148. package/lib/sdui/state.mjs +0 -55
  149. package/lib/sdui/state.mjs.map +0 -1
  150. package/lib/sdui.d.mts +0 -3
  151. package/lib/sdui.d.mts.map +0 -1
  152. package/lib/sdui.d.ts +0 -3
  153. package/lib/sdui.d.ts.map +0 -1
  154. package/lib/sdui.js +0 -8
  155. package/lib/sdui.js.map +0 -1
  156. package/lib/sdui.mjs +0 -3
  157. package/lib/sdui.mjs.map +0 -1
  158. package/src/lib/sdui/actions.ts +0 -71
  159. package/src/lib/sdui/component.ts +0 -162
  160. package/src/lib/sdui/components.ts +0 -1572
  161. package/src/lib/sdui/conditions.ts +0 -59
  162. package/src/lib/sdui/directives.ts +0 -45
  163. package/src/lib/sdui/index.ts +0 -650
  164. package/src/lib/sdui/propTypes.ts +0 -8087
  165. package/src/lib/sdui/props.ts +0 -32
  166. package/src/lib/sdui/render.ts +0 -66
  167. package/src/lib/sdui/state.ts +0 -66
  168. package/src/lib/sdui.ts +0 -2
@@ -7,9 +7,9 @@ import { optionalStringComponentField, requireStringComponentField } from "./_ex
7
7
  * serverless infrastructure. The handler must export `onRipplingEvent`.
8
8
  *
9
9
  * Functions have two primary uses:
10
- * 1. **Authoring SDUI for Custom Apps** — the function returns an SDUI spec
11
- * (built with `@rippling/rippling-sdk/lib/sdui`) that renders as a page tab.
12
- * Wrap the function in an {@link SduiPage} and reference it from an {@link App}.
10
+ * 1. **Rendering SDUI for Custom Apps** — the function returns an SDUI spec
11
+ * payload that renders as a page tab. Wrap the function in an {@link SduiPage}
12
+ * and reference it from an {@link App}.
13
13
  * 2. **Workflow / event handlers** — functions invoked from rules, automations,
14
14
  * or callbacks that do not render UI.
15
15
  *
@@ -24,12 +24,6 @@ export interface SduiPageProps {
24
24
  * Required.
25
25
  */
26
26
  function: ManifestFunction | string;
27
- /**
28
- * Human-readable description of what this page shows.
29
- *
30
- * Required.
31
- */
32
- description: string;
33
27
  }
34
28
  /**
35
29
  * Defines an SDUI page and registers it with the manifest.
@@ -44,7 +38,6 @@ export interface SduiPageProps {
44
38
  * sduiPageId: 'gym_today_schedule',
45
39
  * name: 'Today\'s schedule',
46
40
  * function: todayScheduleFn,
47
- * description: 'SDUI list of class sessions for front desk',
48
41
  * });
49
42
  * const memberListPage = new SduiPage(manifest, {
50
43
  * sduiPageId: 'gym_members',
@@ -68,7 +61,6 @@ export declare class SduiPage {
68
61
  private readonly _sduiPageId;
69
62
  private readonly _name;
70
63
  private readonly _functionApiName;
71
- private readonly _description;
72
64
  /**
73
65
  * @param scope - The manifest to register this page with.
74
66
  * @param props - Initialization properties.
@@ -1 +1 @@
1
- {"version":3,"file":"sdui-page.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/sdui-page.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,KAAK,8BAA8B,EAAE,wCAAoC;AAC9G,OAAO,KAAK,EAAE,gBAAgB,EAAE,gCAA4B;AAC5D,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,+BAA2B;AAGnF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAAC;IACpC;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,QAAQ;IACnB,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,WAAW,CAAU;IAErD,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,yBAAyB;IAO1E,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAC1C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IAEtC;;;;OAIG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa;IAWtD;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,GAAE,8BAAmC,GAAG,QAAQ;IAInG,wEAAwE;IACxE,MAAM,CAAC,sBAAsB,CAC3B,KAAK,EAAE,aAAa,EACpB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC9B,eAAe,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,gBAAgB,GACrD,QAAQ;IAeX;;OAEG;IACH,aAAa,IAAI,MAAM;IAIvB;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;OAEG;IACH,kBAAkB,IAAI,MAAM;IAI5B;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAS9B"}
1
+ {"version":3,"file":"sdui-page.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/sdui-page.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,KAAK,8BAA8B,EAAE,wCAAoC;AAC9G,OAAO,KAAK,EAAE,gBAAgB,EAAE,gCAA4B;AAC5D,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,+BAA2B;AAGnF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAAC;CACrC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,QAAQ;IACnB,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,WAAW,CAAU;IAErD,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,yBAAyB;IAO1E,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAE1C;;;;OAIG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa;IAUtD;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,GAAE,8BAAmC,GAAG,QAAQ;IAInG,wEAAwE;IACxE,MAAM,CAAC,sBAAsB,CAC3B,KAAK,EAAE,aAAa,EACpB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC9B,eAAe,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,gBAAgB,GACrD,QAAQ;IAcX;;OAEG;IACH,aAAa,IAAI,MAAM;IAIvB;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;OAEG;IACH,kBAAkB,IAAI,MAAM;IAI5B;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAQ9B"}
@@ -24,12 +24,6 @@ export interface SduiPageProps {
24
24
  * Required.
25
25
  */
26
26
  function: ManifestFunction | string;
27
- /**
28
- * Human-readable description of what this page shows.
29
- *
30
- * Required.
31
- */
32
- description: string;
33
27
  }
34
28
  /**
35
29
  * Defines an SDUI page and registers it with the manifest.
@@ -44,7 +38,6 @@ export interface SduiPageProps {
44
38
  * sduiPageId: 'gym_today_schedule',
45
39
  * name: 'Today\'s schedule',
46
40
  * function: todayScheduleFn,
47
- * description: 'SDUI list of class sessions for front desk',
48
41
  * });
49
42
  * const memberListPage = new SduiPage(manifest, {
50
43
  * sduiPageId: 'gym_members',
@@ -68,7 +61,6 @@ export declare class SduiPage {
68
61
  private readonly _sduiPageId;
69
62
  private readonly _name;
70
63
  private readonly _functionApiName;
71
- private readonly _description;
72
64
  /**
73
65
  * @param scope - The manifest to register this page with.
74
66
  * @param props - Initialization properties.
@@ -1 +1 @@
1
- {"version":3,"file":"sdui-page.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/sdui-page.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,KAAK,8BAA8B,EAAE,uCAAoC;AAC9G,OAAO,KAAK,EAAE,gBAAgB,EAAE,+BAA4B;AAC5D,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,8BAA2B;AAGnF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAAC;IACpC;;;;OAIG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,qBAAa,QAAQ;IACnB,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,WAAW,CAAU;IAErD,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,yBAAyB;IAO1E,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAC1C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IAEtC;;;;OAIG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa;IAWtD;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,GAAE,8BAAmC,GAAG,QAAQ;IAInG,wEAAwE;IACxE,MAAM,CAAC,sBAAsB,CAC3B,KAAK,EAAE,aAAa,EACpB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC9B,eAAe,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,gBAAgB,GACrD,QAAQ;IAeX;;OAEG;IACH,aAAa,IAAI,MAAM;IAIvB;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;OAEG;IACH,kBAAkB,IAAI,MAAM;IAI5B;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAS9B"}
1
+ {"version":3,"file":"sdui-page.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/sdui-page.ts"],"names":[],"mappings":"AAAA,OAAO,EAA8B,KAAK,8BAA8B,EAAE,uCAAoC;AAC9G,OAAO,KAAK,EAAE,gBAAgB,EAAE,+BAA4B;AAC5D,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,8BAA2B;AAGnF;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAAC;CACrC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,QAAQ;IACnB,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,WAAW,CAAU;IAErD,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,yBAAyB;IAO1E,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAE1C;;;;OAIG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa;IAUtD;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,GAAE,8BAAmC,GAAG,QAAQ;IAInG,wEAAwE;IACxE,MAAM,CAAC,sBAAsB,CAC3B,KAAK,EAAE,aAAa,EACpB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC9B,eAAe,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,gBAAgB,GACrD,QAAQ;IAcX;;OAEG;IACH,aAAa,IAAI,MAAM;IAIvB;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;OAEG;IACH,kBAAkB,IAAI,MAAM;IAI5B;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAQ9B"}
@@ -16,7 +16,6 @@ const _existing_component_fields_1 = require("./_existing-component-fields.js");
16
16
  * sduiPageId: 'gym_today_schedule',
17
17
  * name: 'Today\'s schedule',
18
18
  * function: todayScheduleFn,
19
- * description: 'SDUI list of class sessions for front desk',
20
19
  * });
21
20
  * const memberListPage = new SduiPage(manifest, {
22
21
  * sduiPageId: 'gym_members',
@@ -56,7 +55,6 @@ class SduiPage {
56
55
  this._sduiPageId = props.sduiPageId;
57
56
  this._name = props.name;
58
57
  this._functionApiName = typeof props.function === 'string' ? props.function : props.function.getApiName();
59
- this._description = props.description;
60
58
  scope._register(this);
61
59
  }
62
60
  /**
@@ -72,7 +70,6 @@ class SduiPage {
72
70
  sduiPageId: (0, _existing_component_fields_1.requireStringComponentField)(component, 'sdui_page_id', SduiPage.componentType),
73
71
  name: (0, _existing_component_fields_1.requireStringComponentField)(component, 'name', SduiPage.componentType),
74
72
  function: resolveFunction(functionApiName),
75
- description: (0, _existing_component_fields_1.optionalStringComponentField)(component, 'description'),
76
73
  };
77
74
  return new SduiPage(scope, props);
78
75
  }
@@ -105,7 +102,6 @@ class SduiPage {
105
102
  name: this._name,
106
103
  sdui_page_id: this._sduiPageId,
107
104
  function_api_name: this._functionApiName,
108
- description: this._description,
109
105
  };
110
106
  }
111
107
  }
@@ -1 +1 @@
1
- {"version":3,"file":"sdui-page.js","sourceRoot":"","sources":["../../src/lib/manifest/sdui-page.ts"],"names":[],"mappings":";;;AAAA,8EAA8G;AAG9G,gFAAyG;AAiCzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAa,QAAQ;IAGnB,MAAM,CAAC,oBAAoB,CAAC,UAAkB;QAC5C,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,YAAY,EAAE,UAAU;SACzB,CAAC;IACJ,CAAC;IAOD;;;;OAIG;IACH,YAAY,KAAoB,EAAE,KAAoB;QACpD,IAAI,CAAC,KAAK,CAAC,UAAU;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACjE,IAAI,CAAC,KAAK,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACrD,IAAI,CAAC,KAAK,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC7D,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,gBAAgB,GAAG,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QAC1G,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,UAAkB,EAAE,UAA0C,EAAE;QACtF,OAAO,IAAA,sDAA0B,EAAC,OAAO,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IACtE,CAAC;IAED,wEAAwE;IACxE,MAAM,CAAC,sBAAsB,CAC3B,KAAoB,EACpB,SAA8B,EAC9B,eAAsD;QAEtD,MAAM,eAAe,GAAG,IAAA,wDAA2B,EACjD,SAAS,EACT,mBAAmB,EACnB,QAAQ,CAAC,aAAa,CACvB,CAAC;QACF,MAAM,KAAK,GAAkB;YAC3B,UAAU,EAAE,IAAA,wDAA2B,EAAC,SAAS,EAAE,cAAc,EAAE,QAAQ,CAAC,aAAa,CAAC;YAC1F,IAAI,EAAE,IAAA,wDAA2B,EAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,aAAa,CAAC;YAC5E,QAAQ,EAAE,eAAe,CAAC,eAAe,CAAC;YAC1C,WAAW,EAAE,IAAA,yDAA4B,EAAC,SAAS,EAAE,aAAa,CAAC;SACpE,CAAC;QACF,OAAO,IAAI,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,YAAY,EAAE,IAAI,CAAC,WAAW;YAC9B,iBAAiB,EAAE,IAAI,CAAC,gBAAgB;YACxC,WAAW,EAAE,IAAI,CAAC,YAAY;SAC/B,CAAC;IACJ,CAAC;;AA5FH,4BA6FC;AA5FiB,sBAAa,GAAG,WAAoB,CAAC"}
1
+ {"version":3,"file":"sdui-page.js","sourceRoot":"","sources":["../../src/lib/manifest/sdui-page.ts"],"names":[],"mappings":";;;AAAA,8EAA8G;AAG9G,gFAA2E;AA2B3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAa,QAAQ;IAGnB,MAAM,CAAC,oBAAoB,CAAC,UAAkB;QAC5C,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,YAAY,EAAE,UAAU;SACzB,CAAC;IACJ,CAAC;IAMD;;;;OAIG;IACH,YAAY,KAAoB,EAAE,KAAoB;QACpD,IAAI,CAAC,KAAK,CAAC,UAAU;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACjE,IAAI,CAAC,KAAK,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACrD,IAAI,CAAC,KAAK,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC7D,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,gBAAgB,GAAG,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QAC1G,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,UAAkB,EAAE,UAA0C,EAAE;QACtF,OAAO,IAAA,sDAA0B,EAAC,OAAO,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IACtE,CAAC;IAED,wEAAwE;IACxE,MAAM,CAAC,sBAAsB,CAC3B,KAAoB,EACpB,SAA8B,EAC9B,eAAsD;QAEtD,MAAM,eAAe,GAAG,IAAA,wDAA2B,EACjD,SAAS,EACT,mBAAmB,EACnB,QAAQ,CAAC,aAAa,CACvB,CAAC;QACF,MAAM,KAAK,GAAkB;YAC3B,UAAU,EAAE,IAAA,wDAA2B,EAAC,SAAS,EAAE,cAAc,EAAE,QAAQ,CAAC,aAAa,CAAC;YAC1F,IAAI,EAAE,IAAA,wDAA2B,EAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,aAAa,CAAC;YAC5E,QAAQ,EAAE,eAAe,CAAC,eAAe,CAAC;SAC3C,CAAC;QACF,OAAO,IAAI,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,YAAY,EAAE,IAAI,CAAC,WAAW;YAC9B,iBAAiB,EAAE,IAAI,CAAC,gBAAgB;SACzC,CAAC;IACJ,CAAC;;AAxFH,4BAyFC;AAxFiB,sBAAa,GAAG,WAAoB,CAAC"}
@@ -1,5 +1,5 @@
1
1
  import { getExistingManifestContext } from "./existing-manifest-context.mjs";
2
- import { optionalStringComponentField, requireStringComponentField } from "./_existing-component-fields.mjs";
2
+ import { requireStringComponentField } from "./_existing-component-fields.mjs";
3
3
  /**
4
4
  * Defines an SDUI page and registers it with the manifest.
5
5
  *
@@ -13,7 +13,6 @@ import { optionalStringComponentField, requireStringComponentField } from "./_ex
13
13
  * sduiPageId: 'gym_today_schedule',
14
14
  * name: 'Today\'s schedule',
15
15
  * function: todayScheduleFn,
16
- * description: 'SDUI list of class sessions for front desk',
17
16
  * });
18
17
  * const memberListPage = new SduiPage(manifest, {
19
18
  * sduiPageId: 'gym_members',
@@ -53,7 +52,6 @@ export class SduiPage {
53
52
  this._sduiPageId = props.sduiPageId;
54
53
  this._name = props.name;
55
54
  this._functionApiName = typeof props.function === 'string' ? props.function : props.function.getApiName();
56
- this._description = props.description;
57
55
  scope._register(this);
58
56
  }
59
57
  /**
@@ -69,7 +67,6 @@ export class SduiPage {
69
67
  sduiPageId: requireStringComponentField(component, 'sdui_page_id', SduiPage.componentType),
70
68
  name: requireStringComponentField(component, 'name', SduiPage.componentType),
71
69
  function: resolveFunction(functionApiName),
72
- description: optionalStringComponentField(component, 'description'),
73
70
  };
74
71
  return new SduiPage(scope, props);
75
72
  }
@@ -102,7 +99,6 @@ export class SduiPage {
102
99
  name: this._name,
103
100
  sdui_page_id: this._sduiPageId,
104
101
  function_api_name: this._functionApiName,
105
- description: this._description,
106
102
  };
107
103
  }
108
104
  }
@@ -1 +1 @@
1
- {"version":3,"file":"sdui-page.mjs","sourceRoot":"","sources":["../../src/lib/manifest/sdui-page.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAuC,wCAAoC;AAG9G,OAAO,EAAE,4BAA4B,EAAE,2BAA2B,EAAE,yCAAqC;AAiCzG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,OAAO,QAAQ;IAGnB,MAAM,CAAC,oBAAoB,CAAC,UAAkB;QAC5C,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,YAAY,EAAE,UAAU;SACzB,CAAC;IACJ,CAAC;IAOD;;;;OAIG;IACH,YAAY,KAAoB,EAAE,KAAoB;QACpD,IAAI,CAAC,KAAK,CAAC,UAAU;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACjE,IAAI,CAAC,KAAK,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACrD,IAAI,CAAC,KAAK,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC7D,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,gBAAgB,GAAG,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QAC1G,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,UAAkB,EAAE,UAA0C,EAAE;QACtF,OAAO,0BAA0B,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IACtE,CAAC;IAED,wEAAwE;IACxE,MAAM,CAAC,sBAAsB,CAC3B,KAAoB,EACpB,SAA8B,EAC9B,eAAsD;QAEtD,MAAM,eAAe,GAAG,2BAA2B,CACjD,SAAS,EACT,mBAAmB,EACnB,QAAQ,CAAC,aAAa,CACvB,CAAC;QACF,MAAM,KAAK,GAAkB;YAC3B,UAAU,EAAE,2BAA2B,CAAC,SAAS,EAAE,cAAc,EAAE,QAAQ,CAAC,aAAa,CAAC;YAC1F,IAAI,EAAE,2BAA2B,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,aAAa,CAAC;YAC5E,QAAQ,EAAE,eAAe,CAAC,eAAe,CAAC;YAC1C,WAAW,EAAE,4BAA4B,CAAC,SAAS,EAAE,aAAa,CAAC;SACpE,CAAC;QACF,OAAO,IAAI,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,YAAY,EAAE,IAAI,CAAC,WAAW;YAC9B,iBAAiB,EAAE,IAAI,CAAC,gBAAgB;YACxC,WAAW,EAAE,IAAI,CAAC,YAAY;SAC/B,CAAC;IACJ,CAAC;;AA3Fe,sBAAa,GAAG,WAAoB,CAAC"}
1
+ {"version":3,"file":"sdui-page.mjs","sourceRoot":"","sources":["../../src/lib/manifest/sdui-page.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAuC,wCAAoC;AAG9G,OAAO,EAAE,2BAA2B,EAAE,yCAAqC;AA2B3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,OAAO,QAAQ;IAGnB,MAAM,CAAC,oBAAoB,CAAC,UAAkB;QAC5C,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,YAAY,EAAE,UAAU;SACzB,CAAC;IACJ,CAAC;IAMD;;;;OAIG;IACH,YAAY,KAAoB,EAAE,KAAoB;QACpD,IAAI,CAAC,KAAK,CAAC,UAAU;YAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACjE,IAAI,CAAC,KAAK,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACrD,IAAI,CAAC,KAAK,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAC7D,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,UAAU,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,gBAAgB,GAAG,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QAC1G,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,UAAkB,EAAE,UAA0C,EAAE;QACtF,OAAO,0BAA0B,CAAC,OAAO,CAAC,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;IACtE,CAAC;IAED,wEAAwE;IACxE,MAAM,CAAC,sBAAsB,CAC3B,KAAoB,EACpB,SAA8B,EAC9B,eAAsD;QAEtD,MAAM,eAAe,GAAG,2BAA2B,CACjD,SAAS,EACT,mBAAmB,EACnB,QAAQ,CAAC,aAAa,CACvB,CAAC;QACF,MAAM,KAAK,GAAkB;YAC3B,UAAU,EAAE,2BAA2B,CAAC,SAAS,EAAE,cAAc,EAAE,QAAQ,CAAC,aAAa,CAAC;YAC1F,IAAI,EAAE,2BAA2B,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,aAAa,CAAC;YAC5E,QAAQ,EAAE,eAAe,CAAC,eAAe,CAAC;SAC3C,CAAC;QACF,OAAO,IAAI,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,aAAa;QACX,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,aAAa;YAC5B,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,YAAY,EAAE,IAAI,CAAC,WAAW;YAC9B,iBAAiB,EAAE,IAAI,CAAC,gBAAgB;SACzC,CAAC;IACJ,CAAC;;AAvFe,sBAAa,GAAG,WAAoB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rippling/rippling-sdk",
3
- "version": "0.2.0-alpha.58",
3
+ "version": "0.2.0-alpha.60",
4
4
  "description": "The official TypeScript library for the Rippling SDK API",
5
5
  "author": "Rippling SDK <no-reply@rippling.com>",
6
6
  "types": "./index.d.ts",
@@ -0,0 +1,109 @@
1
+ import { APIResource } from "../core/resource.mjs";
2
+ import * as BusinessPartnersAPI from "./business-partners.mjs";
3
+ import * as JobCodesAPI from "./job-codes.mjs";
4
+ import { APIPromise } from "../core/api-promise.mjs";
5
+ import { PageCursorURL, PagePromise } from "../core/pagination.mjs";
6
+ import { RequestOptions } from "../internal/request-options.mjs";
7
+ /**
8
+ * Business structure used for defining hierarchy of company's org attributes
9
+ */
10
+ export declare class BusinessStructurePaths extends APIResource {
11
+ /**
12
+ * A list of business-structure-paths.
13
+ *
14
+ * - Requires: `API Tier 2`
15
+ * - Expandable fields: `parent`, `job_codes`
16
+ * - Sortable fields: `id`, `created_at`, `updated_at`
17
+ */
18
+ list(query?: BusinessStructurePathListParams | null | undefined, options?: RequestOptions): PagePromise<BusinessStructurePathListResponsesPageCursorURL, BusinessStructurePathListResponse>;
19
+ /**
20
+ * Retrieve a specific business-structure-path
21
+ */
22
+ retrieve(id: string, query?: BusinessStructurePathRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<BusinessStructurePathRetrieveResponse>;
23
+ }
24
+ export type BusinessStructurePathListResponsesPageCursorURL = PageCursorURL<BusinessStructurePathListResponse>;
25
+ export interface BusinessStructurePathListResponse {
26
+ /**
27
+ * Identifier field
28
+ */
29
+ id: string;
30
+ /**
31
+ * Record creation date
32
+ */
33
+ created_at: string;
34
+ /**
35
+ * Record update date
36
+ */
37
+ updated_at: string;
38
+ /**
39
+ * Ordered list of full JobCode objects for each job in the path, top to bottom.
40
+ * Populate via ?expand=job_codes. Requires both business-structure-paths.read and
41
+ * job-codes.read scopes.
42
+ *
43
+ * Expandable field
44
+ */
45
+ job_codes?: Array<JobCodesAPI.JobCode>;
46
+ /**
47
+ * Ordered list of Job code IDs from top to bottom.
48
+ */
49
+ job_codes_id?: Array<string>;
50
+ /**
51
+ * Name of the path (e.g. 'SF Office > Coffee > Barista').
52
+ */
53
+ name?: string;
54
+ parent?: unknown;
55
+ /**
56
+ * Id of the parent BusinessStructurePath. None for root path.
57
+ */
58
+ parent_id?: string;
59
+ }
60
+ /**
61
+ * Meta information for the response.
62
+ */
63
+ export interface BusinessStructurePathRetrieveResponse extends BusinessPartnersAPI.Meta {
64
+ /**
65
+ * Identifier field
66
+ */
67
+ id: string;
68
+ /**
69
+ * Record creation date
70
+ */
71
+ created_at: string;
72
+ /**
73
+ * Record update date
74
+ */
75
+ updated_at: string;
76
+ /**
77
+ * Ordered list of full JobCode objects for each job in the path, top to bottom.
78
+ * Populate via ?expand=job_codes. Requires both business-structure-paths.read and
79
+ * job-codes.read scopes.
80
+ *
81
+ * Expandable field
82
+ */
83
+ job_codes?: Array<JobCodesAPI.JobCode>;
84
+ /**
85
+ * Ordered list of Job code IDs from top to bottom.
86
+ */
87
+ job_codes_id?: Array<string>;
88
+ /**
89
+ * Name of the path (e.g. 'SF Office > Coffee > Barista').
90
+ */
91
+ name?: string;
92
+ parent?: unknown;
93
+ /**
94
+ * Id of the parent BusinessStructurePath. None for root path.
95
+ */
96
+ parent_id?: string;
97
+ }
98
+ export interface BusinessStructurePathListParams {
99
+ cursor?: string;
100
+ expand?: string;
101
+ order_by?: string;
102
+ }
103
+ export interface BusinessStructurePathRetrieveParams {
104
+ expand?: string;
105
+ }
106
+ export declare namespace BusinessStructurePaths {
107
+ export { type BusinessStructurePathListResponse as BusinessStructurePathListResponse, type BusinessStructurePathRetrieveResponse as BusinessStructurePathRetrieveResponse, type BusinessStructurePathListResponsesPageCursorURL as BusinessStructurePathListResponsesPageCursorURL, type BusinessStructurePathListParams as BusinessStructurePathListParams, type BusinessStructurePathRetrieveParams as BusinessStructurePathRetrieveParams, };
108
+ }
109
+ //# sourceMappingURL=business-structure-paths.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"business-structure-paths.d.mts","sourceRoot":"","sources":["../src/resources/business-structure-paths.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,KAAK,mBAAmB,gCAA4B;AAC3D,OAAO,KAAK,WAAW,wBAAoB;AAC3C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,+BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;IACrD;;;;;;OAMG;IACH,IAAI,CACF,KAAK,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+CAA+C,EAAE,iCAAiC,CAAC;IAQlG;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mCAAmC,GAAG,IAAI,GAAG,SAAc,EAClE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;CAGrD;AAED,MAAM,MAAM,+CAA+C,GACzD,aAAa,CAAC,iCAAiC,CAAC,CAAC;AAEnD,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,qCAAsC,SAAQ,mBAAmB,CAAC,IAAI;IACrF;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,+BAA+B;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mCAAmC;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC;IAC9C,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,+CAA+C,IAAI,+CAA+C,EACvG,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}
@@ -0,0 +1,109 @@
1
+ import { APIResource } from "../core/resource.js";
2
+ import * as BusinessPartnersAPI from "./business-partners.js";
3
+ import * as JobCodesAPI from "./job-codes.js";
4
+ import { APIPromise } from "../core/api-promise.js";
5
+ import { PageCursorURL, PagePromise } from "../core/pagination.js";
6
+ import { RequestOptions } from "../internal/request-options.js";
7
+ /**
8
+ * Business structure used for defining hierarchy of company's org attributes
9
+ */
10
+ export declare class BusinessStructurePaths extends APIResource {
11
+ /**
12
+ * A list of business-structure-paths.
13
+ *
14
+ * - Requires: `API Tier 2`
15
+ * - Expandable fields: `parent`, `job_codes`
16
+ * - Sortable fields: `id`, `created_at`, `updated_at`
17
+ */
18
+ list(query?: BusinessStructurePathListParams | null | undefined, options?: RequestOptions): PagePromise<BusinessStructurePathListResponsesPageCursorURL, BusinessStructurePathListResponse>;
19
+ /**
20
+ * Retrieve a specific business-structure-path
21
+ */
22
+ retrieve(id: string, query?: BusinessStructurePathRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<BusinessStructurePathRetrieveResponse>;
23
+ }
24
+ export type BusinessStructurePathListResponsesPageCursorURL = PageCursorURL<BusinessStructurePathListResponse>;
25
+ export interface BusinessStructurePathListResponse {
26
+ /**
27
+ * Identifier field
28
+ */
29
+ id: string;
30
+ /**
31
+ * Record creation date
32
+ */
33
+ created_at: string;
34
+ /**
35
+ * Record update date
36
+ */
37
+ updated_at: string;
38
+ /**
39
+ * Ordered list of full JobCode objects for each job in the path, top to bottom.
40
+ * Populate via ?expand=job_codes. Requires both business-structure-paths.read and
41
+ * job-codes.read scopes.
42
+ *
43
+ * Expandable field
44
+ */
45
+ job_codes?: Array<JobCodesAPI.JobCode>;
46
+ /**
47
+ * Ordered list of Job code IDs from top to bottom.
48
+ */
49
+ job_codes_id?: Array<string>;
50
+ /**
51
+ * Name of the path (e.g. 'SF Office > Coffee > Barista').
52
+ */
53
+ name?: string;
54
+ parent?: unknown;
55
+ /**
56
+ * Id of the parent BusinessStructurePath. None for root path.
57
+ */
58
+ parent_id?: string;
59
+ }
60
+ /**
61
+ * Meta information for the response.
62
+ */
63
+ export interface BusinessStructurePathRetrieveResponse extends BusinessPartnersAPI.Meta {
64
+ /**
65
+ * Identifier field
66
+ */
67
+ id: string;
68
+ /**
69
+ * Record creation date
70
+ */
71
+ created_at: string;
72
+ /**
73
+ * Record update date
74
+ */
75
+ updated_at: string;
76
+ /**
77
+ * Ordered list of full JobCode objects for each job in the path, top to bottom.
78
+ * Populate via ?expand=job_codes. Requires both business-structure-paths.read and
79
+ * job-codes.read scopes.
80
+ *
81
+ * Expandable field
82
+ */
83
+ job_codes?: Array<JobCodesAPI.JobCode>;
84
+ /**
85
+ * Ordered list of Job code IDs from top to bottom.
86
+ */
87
+ job_codes_id?: Array<string>;
88
+ /**
89
+ * Name of the path (e.g. 'SF Office > Coffee > Barista').
90
+ */
91
+ name?: string;
92
+ parent?: unknown;
93
+ /**
94
+ * Id of the parent BusinessStructurePath. None for root path.
95
+ */
96
+ parent_id?: string;
97
+ }
98
+ export interface BusinessStructurePathListParams {
99
+ cursor?: string;
100
+ expand?: string;
101
+ order_by?: string;
102
+ }
103
+ export interface BusinessStructurePathRetrieveParams {
104
+ expand?: string;
105
+ }
106
+ export declare namespace BusinessStructurePaths {
107
+ export { type BusinessStructurePathListResponse as BusinessStructurePathListResponse, type BusinessStructurePathRetrieveResponse as BusinessStructurePathRetrieveResponse, type BusinessStructurePathListResponsesPageCursorURL as BusinessStructurePathListResponsesPageCursorURL, type BusinessStructurePathListParams as BusinessStructurePathListParams, type BusinessStructurePathRetrieveParams as BusinessStructurePathRetrieveParams, };
108
+ }
109
+ //# sourceMappingURL=business-structure-paths.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"business-structure-paths.d.ts","sourceRoot":"","sources":["../src/resources/business-structure-paths.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,mBAAmB,+BAA4B;AAC3D,OAAO,KAAK,WAAW,uBAAoB;AAC3C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,8BAA2B;AAChE,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,sBAAuB,SAAQ,WAAW;IACrD;;;;;;OAMG;IACH,IAAI,CACF,KAAK,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,+CAA+C,EAAE,iCAAiC,CAAC;IAQlG;;OAEG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,mCAAmC,GAAG,IAAI,GAAG,SAAc,EAClE,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,qCAAqC,CAAC;CAGrD;AAED,MAAM,MAAM,+CAA+C,GACzD,aAAa,CAAC,iCAAiC,CAAC,CAAC;AAEnD,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,qCAAsC,SAAQ,mBAAmB,CAAC,IAAI;IACrF;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,+BAA+B;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,mCAAmC;IAClD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,CAAC,OAAO,WAAW,sBAAsB,CAAC;IAC9C,OAAO,EACL,KAAK,iCAAiC,IAAI,iCAAiC,EAC3E,KAAK,qCAAqC,IAAI,qCAAqC,EACnF,KAAK,+CAA+C,IAAI,+CAA+C,EACvG,KAAK,+BAA+B,IAAI,+BAA+B,EACvE,KAAK,mCAAmC,IAAI,mCAAmC,GAChF,CAAC;CACH"}
@@ -0,0 +1,30 @@
1
+ "use strict";
2
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.BusinessStructurePaths = void 0;
5
+ const resource_1 = require("../core/resource.js");
6
+ const pagination_1 = require("../core/pagination.js");
7
+ const path_1 = require("../internal/utils/path.js");
8
+ /**
9
+ * Business structure used for defining hierarchy of company's org attributes
10
+ */
11
+ class BusinessStructurePaths extends resource_1.APIResource {
12
+ /**
13
+ * A list of business-structure-paths.
14
+ *
15
+ * - Requires: `API Tier 2`
16
+ * - Expandable fields: `parent`, `job_codes`
17
+ * - Sortable fields: `id`, `created_at`, `updated_at`
18
+ */
19
+ list(query = {}, options) {
20
+ return this._client.getAPIList('/business-structure-paths/', (pagination_1.PageCursorURL), { query, ...options });
21
+ }
22
+ /**
23
+ * Retrieve a specific business-structure-path
24
+ */
25
+ retrieve(id, query = {}, options) {
26
+ return this._client.get((0, path_1.path) `/business-structure-paths/${id}/`, { query, ...options });
27
+ }
28
+ }
29
+ exports.BusinessStructurePaths = BusinessStructurePaths;
30
+ //# sourceMappingURL=business-structure-paths.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"business-structure-paths.js","sourceRoot":"","sources":["../src/resources/business-structure-paths.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,sDAAgE;AAEhE,oDAA8C;AAE9C;;GAEG;AACH,MAAa,sBAAuB,SAAQ,sBAAW;IACrD;;;;;;OAMG;IACH,IAAI,CACF,QAA4D,EAAE,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,4BAA4B,EAC5B,CAAA,0BAAgD,CAAA,EAChD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,QAAgE,EAAE,EAClE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,6BAA6B,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;CACF;AA7BD,wDA6BC"}
@@ -0,0 +1,26 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+ import { APIResource } from "../core/resource.mjs";
3
+ import { PageCursorURL } from "../core/pagination.mjs";
4
+ import { path } from "../internal/utils/path.mjs";
5
+ /**
6
+ * Business structure used for defining hierarchy of company's org attributes
7
+ */
8
+ export class BusinessStructurePaths extends APIResource {
9
+ /**
10
+ * A list of business-structure-paths.
11
+ *
12
+ * - Requires: `API Tier 2`
13
+ * - Expandable fields: `parent`, `job_codes`
14
+ * - Sortable fields: `id`, `created_at`, `updated_at`
15
+ */
16
+ list(query = {}, options) {
17
+ return this._client.getAPIList('/business-structure-paths/', (PageCursorURL), { query, ...options });
18
+ }
19
+ /**
20
+ * Retrieve a specific business-structure-path
21
+ */
22
+ retrieve(id, query = {}, options) {
23
+ return this._client.get(path `/business-structure-paths/${id}/`, { query, ...options });
24
+ }
25
+ }
26
+ //# sourceMappingURL=business-structure-paths.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"business-structure-paths.mjs","sourceRoot":"","sources":["../src/resources/business-structure-paths.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAI/C,OAAO,EAAE,aAAa,EAAe,+BAA2B;AAEhE,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,sBAAuB,SAAQ,WAAW;IACrD;;;;;;OAMG;IACH,IAAI,CACF,QAA4D,EAAE,EAC9D,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAC5B,4BAA4B,EAC5B,CAAA,aAAgD,CAAA,EAChD,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CACtB,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,QAAQ,CACN,EAAU,EACV,QAAgE,EAAE,EAClE,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,6BAA6B,EAAE,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzF,CAAC;CACF"}
@@ -47,11 +47,13 @@ export declare namespace EmployeeDocumentCreateResponse {
47
47
  */
48
48
  worker_id: string;
49
49
  /**
50
- * Optional ObjectId of the destination sub-folder on the worker's documents
51
- * profile. When omitted, documents land at the root of the worker's profile
52
- * (current default behavior). When supplied, the folder must exist, be in an
53
- * active state, be provisioned for the target worker, and the caller must have
54
- * UPLOAD permission on it — otherwise behavior is governed by `on_invalid_folder`.
50
+ * Optional destination folder for documents. Accepts either: (1) an ObjectId
51
+ * string for custom folders, or (2) a default folder identifier ('root',
52
+ * 'confidential_documents', 'notices', 'work_authorization'). When omitted,
53
+ * documents land at the root of the worker's profile (current default behavior).
54
+ * When supplied, the folder must exist, be in an active state, be provisioned for
55
+ * the target worker, and the caller must have UPLOAD permission on it — otherwise
56
+ * behavior is governed by `on_invalid_folder`.
55
57
  */
56
58
  folder_id?: string;
57
59
  /**
@@ -106,11 +108,13 @@ export declare namespace EmployeeDocumentCreateParams {
106
108
  */
107
109
  worker_id: string;
108
110
  /**
109
- * Optional ObjectId of the destination sub-folder on the worker's documents
110
- * profile. When omitted, documents land at the root of the worker's profile
111
- * (current default behavior). When supplied, the folder must exist, be in an
112
- * active state, be provisioned for the target worker, and the caller must have
113
- * UPLOAD permission on it — otherwise behavior is governed by `on_invalid_folder`.
111
+ * Optional destination folder for documents. Accepts either: (1) an ObjectId
112
+ * string for custom folders, or (2) a default folder identifier ('root',
113
+ * 'confidential_documents', 'notices', 'work_authorization'). When omitted,
114
+ * documents land at the root of the worker's profile (current default behavior).
115
+ * When supplied, the folder must exist, be in an active state, be provisioned for
116
+ * the target worker, and the caller must have UPLOAD permission on it — otherwise
117
+ * behavior is governed by `on_invalid_folder`.
114
118
  */
115
119
  folder_id?: string;
116
120
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"employee-documents.d.mts","sourceRoot":"","sources":["../src/resources/employee-documents.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,WAAW;IAChD;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,EAAE,KAAK,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;IAElD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,8BAA8B,CAAC;IAC9C;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEhC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;;;WAMG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;WAMG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;KACjD;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;SACzB;KACF;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,KAAK,EAAE,KAAK,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;CACjD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEhC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;;;WAMG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;WAMG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;KACjD;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;SACzB;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,iBAAiB,CAAC;IACzC,OAAO,EACL,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
1
+ {"version":3,"file":"employee-documents.d.mts","sourceRoot":"","sources":["../src/resources/employee-documents.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAE7D;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,WAAW;IAChD;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,EAAE,KAAK,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;IAElD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,8BAA8B,CAAC;IAC9C;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEhC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;;;;;WAQG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;WAMG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;KACjD;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;SACzB;KACF;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,KAAK,EAAE,KAAK,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;CACjD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEhC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;;;;;WAQG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;WAMG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;KACjD;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;SACzB;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,iBAAiB,CAAC;IACzC,OAAO,EACL,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
@@ -47,11 +47,13 @@ export declare namespace EmployeeDocumentCreateResponse {
47
47
  */
48
48
  worker_id: string;
49
49
  /**
50
- * Optional ObjectId of the destination sub-folder on the worker's documents
51
- * profile. When omitted, documents land at the root of the worker's profile
52
- * (current default behavior). When supplied, the folder must exist, be in an
53
- * active state, be provisioned for the target worker, and the caller must have
54
- * UPLOAD permission on it — otherwise behavior is governed by `on_invalid_folder`.
50
+ * Optional destination folder for documents. Accepts either: (1) an ObjectId
51
+ * string for custom folders, or (2) a default folder identifier ('root',
52
+ * 'confidential_documents', 'notices', 'work_authorization'). When omitted,
53
+ * documents land at the root of the worker's profile (current default behavior).
54
+ * When supplied, the folder must exist, be in an active state, be provisioned for
55
+ * the target worker, and the caller must have UPLOAD permission on it — otherwise
56
+ * behavior is governed by `on_invalid_folder`.
55
57
  */
56
58
  folder_id?: string;
57
59
  /**
@@ -106,11 +108,13 @@ export declare namespace EmployeeDocumentCreateParams {
106
108
  */
107
109
  worker_id: string;
108
110
  /**
109
- * Optional ObjectId of the destination sub-folder on the worker's documents
110
- * profile. When omitted, documents land at the root of the worker's profile
111
- * (current default behavior). When supplied, the folder must exist, be in an
112
- * active state, be provisioned for the target worker, and the caller must have
113
- * UPLOAD permission on it — otherwise behavior is governed by `on_invalid_folder`.
111
+ * Optional destination folder for documents. Accepts either: (1) an ObjectId
112
+ * string for custom folders, or (2) a default folder identifier ('root',
113
+ * 'confidential_documents', 'notices', 'work_authorization'). When omitted,
114
+ * documents land at the root of the worker's profile (current default behavior).
115
+ * When supplied, the folder must exist, be in an active state, be provisioned for
116
+ * the target worker, and the caller must have UPLOAD permission on it — otherwise
117
+ * behavior is governed by `on_invalid_folder`.
114
118
  */
115
119
  folder_id?: string;
116
120
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"employee-documents.d.ts","sourceRoot":"","sources":["../src/resources/employee-documents.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,WAAW;IAChD;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,EAAE,KAAK,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;IAElD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,8BAA8B,CAAC;IAC9C;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEhC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;;;WAMG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;WAMG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;KACjD;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;SACzB;KACF;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,KAAK,EAAE,KAAK,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;CACjD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEhC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;;;WAMG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;WAMG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;KACjD;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;SACzB;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,iBAAiB,CAAC;IACzC,OAAO,EACL,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
1
+ {"version":3,"file":"employee-documents.d.ts","sourceRoot":"","sources":["../src/resources/employee-documents.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAE7D;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,WAAW;IAChD;;OAEG;IACH,MAAM,CACJ,IAAI,EAAE,4BAA4B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,8BAA8B,CAAC;CAG9C;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,KAAK,EAAE,KAAK,CAAC,8BAA8B,CAAC,IAAI,CAAC,CAAC;IAElD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,yBAAiB,8BAA8B,CAAC;IAC9C;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEhC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;;;;;WAQG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;WAMG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;KACjD;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;SACzB;KACF;CACF;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,KAAK,EAAE,KAAK,CAAC,4BAA4B,CAAC,IAAI,CAAC,CAAC;CACjD;AAED,yBAAiB,4BAA4B,CAAC;IAC5C;;OAEG;IACH,UAAiB,IAAI;QACnB;;;WAGG;QACH,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEhC;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;;;;;WAQG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;;;;WAMG;QACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,kBAAkB,CAAC;KACjD;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,QAAQ;YACvB;;;eAGG;YACH,OAAO,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,cAAc,CAAC,EAAE,MAAM,CAAC;SACzB;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,iBAAiB,CAAC;IACzC,OAAO,EACL,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,GAClE,CAAC;CACH"}
@@ -3,6 +3,7 @@ export { BreakPolicies, type BreakPolicyListResponse, type BreakPolicyRetrieveRe
3
3
  export { BreakTypes, type BreakTypeListResponse, type BreakTypeRetrieveResponse, type BreakTypeListParams, type BreakTypeRetrieveParams, type BreakTypeListResponsesPageCursorURL, } from "./break-types.mjs";
4
4
  export { BusinessPartnerGroups, type BusinessPartnerGroup, type BusinessPartnerGroupRetrieveResponse, type BusinessPartnerGroupListParams, type BusinessPartnerGroupCreateParams, type BusinessPartnerGroupRetrieveParams, type BusinessPartnerGroupsPageCursorURL, } from "./business-partner-groups.mjs";
5
5
  export { BusinessPartners, type BusinessPartner, type Meta, type BusinessPartnerRetrieveResponse, type BusinessPartnerListParams, type BusinessPartnerCreateParams, type BusinessPartnerRetrieveParams, type BusinessPartnersPageCursorURL, } from "./business-partners.mjs";
6
+ export { BusinessStructurePaths, type BusinessStructurePathListResponse, type BusinessStructurePathRetrieveResponse, type BusinessStructurePathListParams, type BusinessStructurePathRetrieveParams, type BusinessStructurePathListResponsesPageCursorURL, } from "./business-structure-paths.mjs";
6
7
  export { CandidateApplications, type CandidateApplicationListResponse, type CandidateApplicationListParams, type CandidateApplicationListResponsesPageCursorURL, } from "./candidate-applications.mjs";
7
8
  export { Candidates, type CandidateListResponse, type CandidateListParams, type CandidateListResponsesPageCursorURL, } from "./candidates.mjs";
8
9
  export { Companies, type Company, type CompanyListParams, type CompaniesPageCursorURL } from "./companies.mjs";