spitfirepm 23.9600.11 → 23.9600.13

package/README.md

@@ -25,7 +25,9 @@ apiResult.then( (a) => {
 ### Change Log
 
 ```
-23.9600.11  - Adds Admin Tool menu
+23.9600.13  - ARR cleanup
+23.9600.12  - ARR endpoints
+23.9600.11  - Adds Admin and Manage Tool Data Models and Endpoints
 23.9600.10  - Adds csi-maintenance
 23.9600.9   - Adds BuildWCCInfoTableHTML
 23.9600.8   - Project SOP links and Send Log Endpoint

package/dist/SwaggerClients.d.ts

@@ -26,6 +26,14 @@ export declare class AccountClient extends APIClientBase {
     private getAccessAllowsWithCallbacks;
     private processGetAccessAllowsWithCallbacks;
     protected processGetAccessAllows(xhr: any): PermissionFlags | null;
+    /**
+     * Mint a short-lived download-ticket cookie
+     * @return Download ticket cookie set
+     */
+    postDownloadSession(): Promise<string>;
+    private postDownloadSessionWithCallbacks;
+    private processPostDownloadSessionWithCallbacks;
+    protected processPostDownloadSession(xhr: any): string | null;
     /**
      * Digest an identity from an Google token
      * @param subId google nonvolatile id
@@ -370,6 +378,36 @@ export declare class LookupClient extends APIClientBase {
     private processGetDisplayValueCollectionWithCallbacks;
     protected processGetDisplayValueCollection(xhr: any): Suggestion[] | null | null;
 }
+export declare class ARRClient extends APIClientBase {
+    baseUrl: string;
+    beforeSend: any;
+    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
+    constructor(baseUrl?: string);
+    /**
+     * Build the routed-content download package
+     * @param data download request {RouteID}
+     */
+    getContent(data: ArrResponseData): Promise<string | null>;
+    private getContentWithCallbacks;
+    private processGetContentWithCallbacks;
+    protected processGetContent(xhr: any): string | null | null;
+    /**
+     * Open a route-response link
+     * @param request open request {StepKey, RouteID}
+     */
+    openRoute(request: ArrOpenRequest): Promise<ArrOpenResult | null>;
+    private openRouteWithCallbacks;
+    private processOpenRouteWithCallbacks;
+    protected processOpenRoute(xhr: any): ArrOpenResult | null | null;
+    /**
+     * Record a route response
+     * @param data response data
+     */
+    recordResponse(data: ArrResponseData): Promise<ArrResponseResult | null>;
+    private recordResponseWithCallbacks;
+    private processRecordResponseWithCallbacks;
+    protected processRecordResponse(xhr: any): ArrResponseResult | null | null;
+}
 export declare class CatalogClient extends APIClientBase {
     baseUrl: string;
     beforeSend: any;
@@ -3351,6 +3389,17 @@ export declare class SystemClient extends APIClientBase {
     private getPublicResourceWithCallbacks;
     private processGetPublicResourceWithCallbacks;
     protected processGetPublicResource(xhr: any): string | null | null;
+    /**
+     * Returns the reCAPTCHA Enterprise site key
+     */
+    getRecaptchaConfig(): Promise<{
+        [key: string]: string;
+    } | null>;
+    private getRecaptchaConfigWithCallbacks;
+    private processGetRecaptchaConfigWithCallbacks;
+    protected processGetRecaptchaConfig(xhr: any): {
+        [key: string]: string;
+    } | null | null;
     /**
      * Returns statistical data
      * @param withDetails (optional)
@@ -3732,6 +3781,90 @@ export interface APIData {
     /** when true, data has been uri encoded (encodeURIComponent) */
     IsURIEncoded?: boolean;
 }
+/** Route Response Wizard (ARR / case 36631) data-transfer objects, shared between the sfPMS web app (ARRController) and the OpenAPI/Swagger client. Moved here from ARRController.vb so they live with the rest of the DataSupportModels. */
+export interface ArrOpenRequest {
+    /** RouteStepKey from the link. */
+    StepKey?: string;
+    /** RouteID from the link. */
+    RouteID?: string;
+    /** reCAPTCHA Enterprise token from the client, assessed before the route is resolved. */
+    RecaptchaToken?: string | undefined;
+}
+/** Everything the Webix arr view needs to render, plus the (optional) ARR session token. */
+export interface ArrOpenResult {
+    /** RouteStepKey echoed back. */
+    StepKey?: string;
+    /** RouteID echoed back. */
+    RouteID?: string;
+    /** Document the route belongs to. */
+    DocMasterKey?: string;
+    /** Document type of the document. */
+    DocTypeKey?: string;
+    /** Document title for display. */
+    DocTitle?: string | undefined;
+    /** Display name of the routee (the "For" person). */
+    RouteeUserName?: string | undefined;
+    /** Routee email (used for the confirmation checkbox; also a phase-2 verification target). */
+    RouteeEmail?: string | undefined;
+    /** Display name of the person the route replies to. */
+    FromUserName?: string | undefined;
+    /** Route instructions/request text. */
+    Instructions?: string | undefined;
+    /** Timestamp the routed content was set/resolved. */
+    ContentAsOf?: Date;
+    /** True when there is routed content available to download. */
+    HasContent?: boolean;
+    /** When the routee first viewed this route, if ever. */
+    FirstViewed?: Date | undefined;
+    /** When the routee last responded to this route, if ever. */
+    Responded?: Date | undefined;
+    /** True when the document is confidential. */
+    IsConfidential?: boolean;
+    /** Phase 1: when true, no AccessToken is issued and the view shows a "verification coming soon" state. */
+    RequiresVerification?: boolean;
+    /** Whether the free-form response area should be shown. */
+    ShowRouteResponseArea?: boolean;
+    /** Whether the response-code dropdown should be shown. */
+    ShowRouteResponseCode?: boolean;
+    /** Whether the response text may still be edited. */
+    CanEditRouteResponse?: boolean;
+    /** Whether the response code may still be changed. */
+    CanEditRouteResponseCode?: boolean;
+    /** Whether the routee is permitted to send the document back. */
+    AllowSendBack?: boolean;
+    /** Whether the routee is permitted to restart the route. */
+    AllowRestart?: boolean;
+    /** Existing response HTML, if any. */
+    ResponseHtml?: string | undefined;
+    /** Existing response code, if any. */
+    ResponseCode?: string | undefined;
+    /** Available response-code choices (Key = code, Value = description). */
+    ResponseCodeChoices?: SelectCodeNode[] | undefined;
+    /** 59-minute MachineKey-protected token; sent back as the X-SF-ARR header on subsequent ARR calls. */
+    AccessToken?: string | undefined;
+}
+/** Request body for ARRController.RecordResponse. */
+export interface ArrResponseData {
+    /** SendOn | SendBack | Restart */
+    Mode?: string | undefined;
+    /** Route being acted on (must match the ARR token's route). */
+    RouteID?: string;
+    /** Response HTML produced by the editor. */
+    ResponseHtml?: string | undefined;
+    /** Selected response code, if any. */
+    ResponseCode?: string | undefined;
+    /** When true, email a confirmation to the routee. */
+    SendConfirmation?: boolean;
+}
+/** Result of ARRController.RecordResponse. */
+export interface ArrResponseResult {
+    /** True when the response was saved. */
+    Saved?: boolean;
+    /** Resulting route status code. */
+    Status?: string | undefined;
+    /** Human-readable result message. */
+    Message?: string | undefined;
+}
 export interface AuthenticationExchangeData {
     XID?: string | undefined;
     IsValid?: boolean;