@smartytalent/openai-tools 0.9.34 → 0.9.36
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/dist/tools.json +177 -18
- package/package.json +1 -1
package/dist/tools.json
CHANGED
|
@@ -166,20 +166,24 @@
|
|
|
166
166
|
"type": "object",
|
|
167
167
|
"properties": {
|
|
168
168
|
"ad": {
|
|
169
|
-
"type": "object"
|
|
169
|
+
"type": "object",
|
|
170
|
+
"description": "DEPRECATED (2026-09-24, S.K., PLAN_TENANT_SETTINGS_CLEANUP): ignored by the backend and stripped on write. Ads and their images are built for every recruitment process; `enabled` never gated anything, `generateImages` is always on (the env kill switch AD_IMAGE_GENERATION remains), `platforms` were never read (the platform lists are fixed in code). Removed in a later, breaking release together with settings.feedback; declared until then because the generated model whitelists keys."
|
|
170
171
|
},
|
|
171
172
|
"brand": {
|
|
172
173
|
"type": "object",
|
|
173
174
|
"description": "Brand rules the ad and careers generators read. Split by who can\nact on what: exact colours are applied by CODE (an image model\nonly ever approximates a hex), while the look-and-feel strings\nare fed to the image prompt. Keys: primaryColor / secondaryColor\n(^#[0-9a-fA-F]{6}$), photography, avoid, tone. Freeform for now;\na dedicated brand service is the endgame once logo variants,\ntypefaces and versioning arrive."
|
|
174
175
|
},
|
|
175
176
|
"conversation": {
|
|
176
|
-
"type": "object"
|
|
177
|
+
"type": "object",
|
|
178
|
+
"description": "DEPRECATED (2026-09-24, S.K., PLAN_TENANT_SETTINGS_CLEANUP): ignored by the backend and stripped on write. The AI interview is part of the recruitment process (settings.automation on the job); `jobInterview.enabled` never had a reader. Removed in a later, breaking release; declared until then because the generated model whitelists keys."
|
|
177
179
|
},
|
|
178
180
|
"report": {
|
|
179
|
-
"type": "object"
|
|
181
|
+
"type": "object",
|
|
182
|
+
"description": "DEPRECATED (2026-09-24, S.K., PLAN_TENANT_SETTINGS_CLEANUP): ignored by the backend and stripped on write. Reports run for EVERY active tenant (daily, weekly, monthly) and are downloaded in the report app (showReport meta.pdf); e-mail delivery is gone (a per-user preference is a later phase), so `emails` and `period` gate nothing. Removed in a later, breaking release; declared until then because the generated model whitelists keys."
|
|
180
183
|
},
|
|
181
184
|
"email": {
|
|
182
|
-
"type": "object"
|
|
185
|
+
"type": "object",
|
|
186
|
+
"description": "DEPRECATED (2026-09-24, S.K., PLAN_TENANT_SETTINGS_CLEANUP): ignored by the backend and stripped on write. `domains` (trusted e-mail domains) never had a reader - inbound trust comes from the user registry and SPF/DKIM alignment. Removed in a later, breaking release; declared until then because the generated model whitelists keys."
|
|
183
187
|
},
|
|
184
188
|
"operation": {
|
|
185
189
|
"type": "object",
|
|
@@ -188,13 +192,48 @@
|
|
|
188
192
|
"feedback": {
|
|
189
193
|
"title": "TenantAttributesSettingsFeedbackSchema",
|
|
190
194
|
"type": "object",
|
|
191
|
-
"description": "Organisation-wide switch for outbound candidate feedback
|
|
195
|
+
"description": "DEPRECATED (2026-09-24, S.K.: settings.automation.feedback is the ONE control of feedback; this field will be removed in a later, breaking release). Organisation-wide legacy switch for outbound candidate feedback: absent = enabled; enabled=false makes feedback:resolve return enabled=false with reason disabled:tenant ONLY while settings.automation.feedback is absent on both the job and the tenant - once the new key is set at either level this field is ignored; default and per-job feedback rows stay stored. Explicitly validated: enabled must be a JSON boolean (a string is a 400). NOTE: the generated model whitelists keys, so this property MUST stay declared until the removal release.",
|
|
192
196
|
"properties": {
|
|
193
197
|
"enabled": {
|
|
194
198
|
"type": "boolean"
|
|
195
199
|
}
|
|
196
200
|
}
|
|
197
201
|
},
|
|
202
|
+
"automation": {
|
|
203
|
+
"title": "TenantAttributesSettingsAutomationSchema",
|
|
204
|
+
"type": "object",
|
|
205
|
+
"description": "The organisation's DEFAULT automation switches (PLAN_PROCESS_AUTOMATION, 2026-09-24), the same seven keys and values as job.settings.automation: auto = Boe runs the stage, manual = a human runs it (a task on the RecOps board), off = the stage is not part of the process. A job overrides these in BOTH directions (a tenant on manual pilots auto on one job); absent = the platform default (sourcing manual, everything else auto). PATCH merges this block PER KEY (a key sent as null clears the default). Validated in code like the job block: interview and offer accept auto|manual, surveys accepts auto|off, the rest auto|manual|off. NOTE: the generated model whitelists keys, so this property MUST be declared for the SDK to carry it.",
|
|
206
|
+
"properties": {
|
|
207
|
+
"sourcing": {
|
|
208
|
+
"type": "string",
|
|
209
|
+
"description": "auto | manual | off"
|
|
210
|
+
},
|
|
211
|
+
"screeningCall": {
|
|
212
|
+
"type": "string",
|
|
213
|
+
"description": "auto | manual | off"
|
|
214
|
+
},
|
|
215
|
+
"assessment": {
|
|
216
|
+
"type": "string",
|
|
217
|
+
"description": "auto | manual | off"
|
|
218
|
+
},
|
|
219
|
+
"interview": {
|
|
220
|
+
"type": "string",
|
|
221
|
+
"description": "auto | manual"
|
|
222
|
+
},
|
|
223
|
+
"offer": {
|
|
224
|
+
"type": "string",
|
|
225
|
+
"description": "auto | manual"
|
|
226
|
+
},
|
|
227
|
+
"surveys": {
|
|
228
|
+
"type": "string",
|
|
229
|
+
"description": "auto | off"
|
|
230
|
+
},
|
|
231
|
+
"feedback": {
|
|
232
|
+
"type": "string",
|
|
233
|
+
"description": "auto | manual | off"
|
|
234
|
+
}
|
|
235
|
+
}
|
|
236
|
+
},
|
|
198
237
|
"sso": {
|
|
199
238
|
"type": "object",
|
|
200
239
|
"description": "Enterprise SSO configuration. READ-ONLY here: the generic tenant PATCH strips this key, the only writers are the /v1/tenants/{tenantId}/sso doors. Sending it in a PATCH is ignored (not an error).",
|
|
@@ -697,20 +736,24 @@
|
|
|
697
736
|
"type": "object",
|
|
698
737
|
"properties": {
|
|
699
738
|
"ad": {
|
|
700
|
-
"type": "object"
|
|
739
|
+
"type": "object",
|
|
740
|
+
"description": "DEPRECATED (2026-09-24, S.K., PLAN_TENANT_SETTINGS_CLEANUP): ignored by the backend and stripped on write. Ads and their images are built for every recruitment process; `enabled` never gated anything, `generateImages` is always on (the env kill switch AD_IMAGE_GENERATION remains), `platforms` were never read (the platform lists are fixed in code). Removed in a later, breaking release together with settings.feedback; declared until then because the generated model whitelists keys."
|
|
701
741
|
},
|
|
702
742
|
"brand": {
|
|
703
743
|
"type": "object",
|
|
704
744
|
"description": "Brand rules the ad and careers generators read. Split by who can\nact on what: exact colours are applied by CODE (an image model\nonly ever approximates a hex), while the look-and-feel strings\nare fed to the image prompt. Keys: primaryColor / secondaryColor\n(^#[0-9a-fA-F]{6}$), photography, avoid, tone. Freeform for now;\na dedicated brand service is the endgame once logo variants,\ntypefaces and versioning arrive."
|
|
705
745
|
},
|
|
706
746
|
"conversation": {
|
|
707
|
-
"type": "object"
|
|
747
|
+
"type": "object",
|
|
748
|
+
"description": "DEPRECATED (2026-09-24, S.K., PLAN_TENANT_SETTINGS_CLEANUP): ignored by the backend and stripped on write. The AI interview is part of the recruitment process (settings.automation on the job); `jobInterview.enabled` never had a reader. Removed in a later, breaking release; declared until then because the generated model whitelists keys."
|
|
708
749
|
},
|
|
709
750
|
"report": {
|
|
710
|
-
"type": "object"
|
|
751
|
+
"type": "object",
|
|
752
|
+
"description": "DEPRECATED (2026-09-24, S.K., PLAN_TENANT_SETTINGS_CLEANUP): ignored by the backend and stripped on write. Reports run for EVERY active tenant (daily, weekly, monthly) and are downloaded in the report app (showReport meta.pdf); e-mail delivery is gone (a per-user preference is a later phase), so `emails` and `period` gate nothing. Removed in a later, breaking release; declared until then because the generated model whitelists keys."
|
|
711
753
|
},
|
|
712
754
|
"email": {
|
|
713
|
-
"type": "object"
|
|
755
|
+
"type": "object",
|
|
756
|
+
"description": "DEPRECATED (2026-09-24, S.K., PLAN_TENANT_SETTINGS_CLEANUP): ignored by the backend and stripped on write. `domains` (trusted e-mail domains) never had a reader - inbound trust comes from the user registry and SPF/DKIM alignment. Removed in a later, breaking release; declared until then because the generated model whitelists keys."
|
|
714
757
|
},
|
|
715
758
|
"operation": {
|
|
716
759
|
"type": "object",
|
|
@@ -719,13 +762,48 @@
|
|
|
719
762
|
"feedback": {
|
|
720
763
|
"title": "TenantAttributesSettingsFeedbackSchema",
|
|
721
764
|
"type": "object",
|
|
722
|
-
"description": "Organisation-wide switch for outbound candidate feedback
|
|
765
|
+
"description": "DEPRECATED (2026-09-24, S.K.: settings.automation.feedback is the ONE control of feedback; this field will be removed in a later, breaking release). Organisation-wide legacy switch for outbound candidate feedback: absent = enabled; enabled=false makes feedback:resolve return enabled=false with reason disabled:tenant ONLY while settings.automation.feedback is absent on both the job and the tenant - once the new key is set at either level this field is ignored; default and per-job feedback rows stay stored. Explicitly validated: enabled must be a JSON boolean (a string is a 400). NOTE: the generated model whitelists keys, so this property MUST stay declared until the removal release.",
|
|
723
766
|
"properties": {
|
|
724
767
|
"enabled": {
|
|
725
768
|
"type": "boolean"
|
|
726
769
|
}
|
|
727
770
|
}
|
|
728
771
|
},
|
|
772
|
+
"automation": {
|
|
773
|
+
"title": "TenantAttributesSettingsAutomationSchema",
|
|
774
|
+
"type": "object",
|
|
775
|
+
"description": "The organisation's DEFAULT automation switches (PLAN_PROCESS_AUTOMATION, 2026-09-24), the same seven keys and values as job.settings.automation: auto = Boe runs the stage, manual = a human runs it (a task on the RecOps board), off = the stage is not part of the process. A job overrides these in BOTH directions (a tenant on manual pilots auto on one job); absent = the platform default (sourcing manual, everything else auto). PATCH merges this block PER KEY (a key sent as null clears the default). Validated in code like the job block: interview and offer accept auto|manual, surveys accepts auto|off, the rest auto|manual|off. NOTE: the generated model whitelists keys, so this property MUST be declared for the SDK to carry it.",
|
|
776
|
+
"properties": {
|
|
777
|
+
"sourcing": {
|
|
778
|
+
"type": "string",
|
|
779
|
+
"description": "auto | manual | off"
|
|
780
|
+
},
|
|
781
|
+
"screeningCall": {
|
|
782
|
+
"type": "string",
|
|
783
|
+
"description": "auto | manual | off"
|
|
784
|
+
},
|
|
785
|
+
"assessment": {
|
|
786
|
+
"type": "string",
|
|
787
|
+
"description": "auto | manual | off"
|
|
788
|
+
},
|
|
789
|
+
"interview": {
|
|
790
|
+
"type": "string",
|
|
791
|
+
"description": "auto | manual"
|
|
792
|
+
},
|
|
793
|
+
"offer": {
|
|
794
|
+
"type": "string",
|
|
795
|
+
"description": "auto | manual"
|
|
796
|
+
},
|
|
797
|
+
"surveys": {
|
|
798
|
+
"type": "string",
|
|
799
|
+
"description": "auto | off"
|
|
800
|
+
},
|
|
801
|
+
"feedback": {
|
|
802
|
+
"type": "string",
|
|
803
|
+
"description": "auto | manual | off"
|
|
804
|
+
}
|
|
805
|
+
}
|
|
806
|
+
},
|
|
729
807
|
"sso": {
|
|
730
808
|
"type": "object",
|
|
731
809
|
"description": "Enterprise SSO configuration. READ-ONLY here: the generic tenant PATCH strips this key, the only writers are the /v1/tenants/{tenantId}/sso doors. Sending it in a PATCH is ignored (not an error).",
|
|
@@ -5161,12 +5239,47 @@
|
|
|
5161
5239
|
"feedback": {
|
|
5162
5240
|
"title": "JobAttributesSettingsFeedbackSchema",
|
|
5163
5241
|
"type": "object",
|
|
5164
|
-
"description": "Per-job switch for outbound candidate feedback
|
|
5242
|
+
"description": "DEPRECATED (2026-09-24, S.K.: settings.automation.feedback is the ONE control of feedback; this field will be removed in a later, breaking release). Per-job legacy switch for outbound candidate feedback: absent = enabled; enabled=false makes feedback:resolve return enabled=false with reason disabled:job ONLY while settings.automation.feedback is absent on both the job and the tenant - once the new key is set at either level this field is ignored. Between the two legacy switches the tenant's wins. Explicitly validated: enabled must be a JSON boolean.",
|
|
5165
5243
|
"properties": {
|
|
5166
5244
|
"enabled": {
|
|
5167
5245
|
"type": "boolean"
|
|
5168
5246
|
}
|
|
5169
5247
|
}
|
|
5248
|
+
},
|
|
5249
|
+
"automation": {
|
|
5250
|
+
"title": "JobAttributesSettingsAutomationSchema",
|
|
5251
|
+
"type": "object",
|
|
5252
|
+
"description": "Per-job automation switches (PLAN_PROCESS_AUTOMATION, 2026-09-24): who runs each stage of THIS recruitment process. Values per key: auto = Boe runs the stage, manual = a human runs it (Boe leaves a task on the RecOps board and waits), off = the stage is not part of this process (the candidate moves on). Every key is optional: absent = the organisation's default (tenant.settings.automation), else the platform default (sourcing manual, everything else auto); the job overrides the tenant in BOTH directions. Read by the automation:resolve action at the head of the candidate-facing workflows and by feedback:resolve (feedback). PATCH merges this block PER KEY (send one switch at a time; a key sent as null clears the override). Writable only by sysowner / owner / admin / recops - any other role gets 403 on a payload that carries it, on POST and PATCH. Validated in code: interview and offer accept auto|manual, surveys accepts auto|off, the rest auto|manual|off; an unknown key or value is a 400 naming it. `feedback` here is the ONE control of feedback e-mails (S.K. 2026-09-24): the deprecated settings.feedback.enabled counts only while this key is absent on both the job and the tenant. The job build (Create Job From Brief) never generates this block: it keeps the row's values and seeds `off` for the stages the manager declared out of the process in the intake (brief.intakeContext.process).",
|
|
5253
|
+
"properties": {
|
|
5254
|
+
"sourcing": {
|
|
5255
|
+
"type": "string",
|
|
5256
|
+
"description": "auto | manual | off. Talent-pool sourcing at job activation: auto = the matched people are invited at once, manual = a draft invitation the recops activate (the platform default), off = no pool match."
|
|
5257
|
+
},
|
|
5258
|
+
"screeningCall": {
|
|
5259
|
+
"type": "string",
|
|
5260
|
+
"description": "auto | manual | off. The SMS + AI phone screening after a passed CV screening: manual = a board task and the candidate stays at screening, off = the candidate advances to assessment (or interview when assessment is off)."
|
|
5261
|
+
},
|
|
5262
|
+
"assessment": {
|
|
5263
|
+
"type": "string",
|
|
5264
|
+
"description": "auto | manual | off. The competency test: manual = a board task and the candidate stays at assessment, off = the candidate advances to interview whatever templates exist (settings.assessment.enabled only governs template generation at build)."
|
|
5265
|
+
},
|
|
5266
|
+
"interview": {
|
|
5267
|
+
"type": "string",
|
|
5268
|
+
"description": "auto | manual. The HM consent ask and the autonomous interview booking: manual = no HM e-mail, no booking, a board task, the candidate stays at interview (the shortlist). No off in v1."
|
|
5269
|
+
},
|
|
5270
|
+
"offer": {
|
|
5271
|
+
"type": "string",
|
|
5272
|
+
"description": "auto | manual. After the HM's yes: auto = offer document draft + congratulation e-mail, manual = the stage move and the audit note only, plus a board task. No off in v1."
|
|
5273
|
+
},
|
|
5274
|
+
"surveys": {
|
|
5275
|
+
"type": "string",
|
|
5276
|
+
"description": "auto | off. cNPS surveys: off = no survey invitation after a hire and no survey link in rejection e-mails."
|
|
5277
|
+
},
|
|
5278
|
+
"feedback": {
|
|
5279
|
+
"type": "string",
|
|
5280
|
+
"description": "auto | manual | off. Candidate feedback e-mails the feedback policy allows: auto = composed, scheduled and sent by the workflow, manual = composed by Boe and HELD as a draft in the candidate's thread with a board task, released by the operator's emails:send order, off = no feedback e-mail."
|
|
5281
|
+
}
|
|
5282
|
+
}
|
|
5170
5283
|
}
|
|
5171
5284
|
}
|
|
5172
5285
|
}
|
|
@@ -6020,12 +6133,47 @@
|
|
|
6020
6133
|
"feedback": {
|
|
6021
6134
|
"title": "JobAttributesSettingsFeedbackSchema",
|
|
6022
6135
|
"type": "object",
|
|
6023
|
-
"description": "Per-job switch for outbound candidate feedback
|
|
6136
|
+
"description": "DEPRECATED (2026-09-24, S.K.: settings.automation.feedback is the ONE control of feedback; this field will be removed in a later, breaking release). Per-job legacy switch for outbound candidate feedback: absent = enabled; enabled=false makes feedback:resolve return enabled=false with reason disabled:job ONLY while settings.automation.feedback is absent on both the job and the tenant - once the new key is set at either level this field is ignored. Between the two legacy switches the tenant's wins. Explicitly validated: enabled must be a JSON boolean.",
|
|
6024
6137
|
"properties": {
|
|
6025
6138
|
"enabled": {
|
|
6026
6139
|
"type": "boolean"
|
|
6027
6140
|
}
|
|
6028
6141
|
}
|
|
6142
|
+
},
|
|
6143
|
+
"automation": {
|
|
6144
|
+
"title": "JobAttributesSettingsAutomationSchema",
|
|
6145
|
+
"type": "object",
|
|
6146
|
+
"description": "Per-job automation switches (PLAN_PROCESS_AUTOMATION, 2026-09-24): who runs each stage of THIS recruitment process. Values per key: auto = Boe runs the stage, manual = a human runs it (Boe leaves a task on the RecOps board and waits), off = the stage is not part of this process (the candidate moves on). Every key is optional: absent = the organisation's default (tenant.settings.automation), else the platform default (sourcing manual, everything else auto); the job overrides the tenant in BOTH directions. Read by the automation:resolve action at the head of the candidate-facing workflows and by feedback:resolve (feedback). PATCH merges this block PER KEY (send one switch at a time; a key sent as null clears the override). Writable only by sysowner / owner / admin / recops - any other role gets 403 on a payload that carries it, on POST and PATCH. Validated in code: interview and offer accept auto|manual, surveys accepts auto|off, the rest auto|manual|off; an unknown key or value is a 400 naming it. `feedback` here is the ONE control of feedback e-mails (S.K. 2026-09-24): the deprecated settings.feedback.enabled counts only while this key is absent on both the job and the tenant. The job build (Create Job From Brief) never generates this block: it keeps the row's values and seeds `off` for the stages the manager declared out of the process in the intake (brief.intakeContext.process).",
|
|
6147
|
+
"properties": {
|
|
6148
|
+
"sourcing": {
|
|
6149
|
+
"type": "string",
|
|
6150
|
+
"description": "auto | manual | off. Talent-pool sourcing at job activation: auto = the matched people are invited at once, manual = a draft invitation the recops activate (the platform default), off = no pool match."
|
|
6151
|
+
},
|
|
6152
|
+
"screeningCall": {
|
|
6153
|
+
"type": "string",
|
|
6154
|
+
"description": "auto | manual | off. The SMS + AI phone screening after a passed CV screening: manual = a board task and the candidate stays at screening, off = the candidate advances to assessment (or interview when assessment is off)."
|
|
6155
|
+
},
|
|
6156
|
+
"assessment": {
|
|
6157
|
+
"type": "string",
|
|
6158
|
+
"description": "auto | manual | off. The competency test: manual = a board task and the candidate stays at assessment, off = the candidate advances to interview whatever templates exist (settings.assessment.enabled only governs template generation at build)."
|
|
6159
|
+
},
|
|
6160
|
+
"interview": {
|
|
6161
|
+
"type": "string",
|
|
6162
|
+
"description": "auto | manual. The HM consent ask and the autonomous interview booking: manual = no HM e-mail, no booking, a board task, the candidate stays at interview (the shortlist). No off in v1."
|
|
6163
|
+
},
|
|
6164
|
+
"offer": {
|
|
6165
|
+
"type": "string",
|
|
6166
|
+
"description": "auto | manual. After the HM's yes: auto = offer document draft + congratulation e-mail, manual = the stage move and the audit note only, plus a board task. No off in v1."
|
|
6167
|
+
},
|
|
6168
|
+
"surveys": {
|
|
6169
|
+
"type": "string",
|
|
6170
|
+
"description": "auto | off. cNPS surveys: off = no survey invitation after a hire and no survey link in rejection e-mails."
|
|
6171
|
+
},
|
|
6172
|
+
"feedback": {
|
|
6173
|
+
"type": "string",
|
|
6174
|
+
"description": "auto | manual | off. Candidate feedback e-mails the feedback policy allows: auto = composed, scheduled and sent by the workflow, manual = composed by Boe and HELD as a draft in the candidate's thread with a board task, released by the operator's emails:send order, off = no feedback e-mail."
|
|
6175
|
+
}
|
|
6176
|
+
}
|
|
6029
6177
|
}
|
|
6030
6178
|
}
|
|
6031
6179
|
}
|
|
@@ -21716,12 +21864,23 @@
|
|
|
21716
21864
|
"properties": {
|
|
21717
21865
|
"filterStatus": {
|
|
21718
21866
|
"type": "string",
|
|
21719
|
-
"description": "Returns reports with the
|
|
21867
|
+
"description": "Returns reports with the given status. Pass it explicitly - the backend applies NO default, so without it pending and failed rows come back too. The report app's history query is `filterStatus=active&sort=-created` (newest first; the status index carries the sort). One filter at a time: the backend serves a single index per request.",
|
|
21720
21868
|
"enum": [
|
|
21721
21869
|
"active",
|
|
21722
|
-
"
|
|
21870
|
+
"inactive",
|
|
21871
|
+
"pending",
|
|
21872
|
+
"archived",
|
|
21873
|
+
"failed"
|
|
21723
21874
|
]
|
|
21724
21875
|
},
|
|
21876
|
+
"filterResourceId": {
|
|
21877
|
+
"type": "string",
|
|
21878
|
+
"description": "Returns the reports of ONE resource (a job id, or the tenant id for the scheduled tenant reports). Served from the ResourceIndex in index order: `sort` is IGNORED next to it, and it cannot be combined with filterStatus or the created/modified window (one filter at a time). For the tenant history use `filterStatus=active&sort=-created` instead and read `resourceType` / `period` off the rows."
|
|
21879
|
+
},
|
|
21880
|
+
"sort": {
|
|
21881
|
+
"type": "string",
|
|
21882
|
+
"description": "`created` / `-created` / `modified` / `-modified`. Honoured alone and next to filterStatus; ignored next to filterResourceId (index order) and the date windows keep their own index order."
|
|
21883
|
+
},
|
|
21725
21884
|
"filterCreatedFrom": {
|
|
21726
21885
|
"type": "string",
|
|
21727
21886
|
"description": "Filters results to include only those created from the specified date and time. The value must be in ISO 8601 format."
|
|
@@ -21794,7 +21953,7 @@
|
|
|
21794
21953
|
"properties": {
|
|
21795
21954
|
"resourceId": {
|
|
21796
21955
|
"type": "string",
|
|
21797
|
-
"description": "Identifier of the resource this report is associated with (job
|
|
21956
|
+
"description": "Identifier of the resource this report is associated with: the tenant id for the scheduled tenant reports (resourceType tenants), a job id for a job report. On the wire since 2026-09-24 (it was stored but not returned)."
|
|
21798
21957
|
},
|
|
21799
21958
|
"resourceType": {
|
|
21800
21959
|
"type": "string",
|
|
@@ -21821,7 +21980,7 @@
|
|
|
21821
21980
|
},
|
|
21822
21981
|
"settings": {
|
|
21823
21982
|
"type": "string",
|
|
21824
|
-
"description": "
|
|
21983
|
+
"description": "The analysis window the broker stamps at creation (startDate, endDate, reportPeriod, displayName and the period's own fields such as isoWeek or monthName). Since 2026-09-24 (PLAN_TENANT_SETTINGS_CLEANUP) no `emails`: reports are downloaded in the report app, not mailed."
|
|
21825
21984
|
},
|
|
21826
21985
|
"shortCode": {
|
|
21827
21986
|
"type": "string",
|
|
@@ -21955,7 +22114,7 @@
|
|
|
21955
22114
|
"properties": {
|
|
21956
22115
|
"resourceId": {
|
|
21957
22116
|
"type": "string",
|
|
21958
|
-
"description": "Identifier of the resource this report is associated with (job
|
|
22117
|
+
"description": "Identifier of the resource this report is associated with: the tenant id for the scheduled tenant reports (resourceType tenants), a job id for a job report. On the wire since 2026-09-24 (it was stored but not returned)."
|
|
21959
22118
|
},
|
|
21960
22119
|
"resourceType": {
|
|
21961
22120
|
"type": "string",
|
|
@@ -21982,7 +22141,7 @@
|
|
|
21982
22141
|
},
|
|
21983
22142
|
"settings": {
|
|
21984
22143
|
"type": "string",
|
|
21985
|
-
"description": "
|
|
22144
|
+
"description": "The analysis window the broker stamps at creation (startDate, endDate, reportPeriod, displayName and the period's own fields such as isoWeek or monthName). Since 2026-09-24 (PLAN_TENANT_SETTINGS_CLEANUP) no `emails`: reports are downloaded in the report app, not mailed."
|
|
21986
22145
|
},
|
|
21987
22146
|
"shortCode": {
|
|
21988
22147
|
"type": "string",
|