Add comment-based help for New-IdleLifecycleRequestObject (public API)

[blindzero]

Problem Statement

New-IdleLifecycleRequestObject is a public function but lacks complete comment-based help (CBH). This violates the project's documentation consistency expectations and reduces usability (help discovery, generated docs, examples).

Proposed Solution

Add full CBH to New-IdleLifecycleRequestObject following the project's conventions:

• .SYNOPSIS, .DESCRIPTION
• Parameter docs for all parameters
• At least 2 examples:
  1. Minimal request creation
  2. Request creation with identity keys / attributes relevant to typical workflows
• Notes about:
  • Data-only expectations (no ScriptBlocks in user-provided config)
  • Security considerations (do not embed secrets in messages / outputs; rely on redaction boundaries where applicable)

Additionally:

• Ensure the function appears correctly in generated documentation (if the project generates API docs from CBH).
• If there is a docs “reference” page for request objects, link it or update it (single source of truth).

Alternatives Considered

• Leaving CBH minimal and relying on README snippets.
  • Rejected: drift risk and inconsistent user experience.

Impact

• Does this affect existing workflows?
  • No runtime behavior change.
• Any backward compatibility concerns?
  • None.

Acceptance Criteria:

• Get-Help New-IdleLifecycleRequestObject -Full provides meaningful, complete help.
• Examples run successfully in a pwsh environment with IdLE imported.
• Doc generation (if applicable) includes/updates the function reference.

Additional Context

Testing:

• Add or update a lightweight Pester test to assert CBH presence for public functions (if such tests already exist). If not, limit to verifying this function only.

Definition of Done:

• CBH implemented in English.
• Examples validated.
• Any generated docs updated (if applicable).