Repository navigation
Release 0.5.0 - #83
Merged
Merged
Conversation
#81, #56) On PowerShell 7.4+ ConnectWise-cloud create (POST) calls can fail with 'Cannot follow an insecure redirection'. Adds an opt-in switch, feature detected at module load, that sets AllowInsecureRedirect with MaximumRedirection 0 on non-GET requests so no http redirect is ever followed. Clearer errors for the insecure-redirect and unfollowed-3xx cases warn that the record may already exist. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…iles Adds comment-based help to the authentication, Invoke master, ticket and company functions (including help for -AllowInsecureRedirect), regenerates Docs/ with PlatyPS, removes the duplicate Get-CWMCompanyState file, and adds README, CHANGELOG, CONTRIBUTING-adjacent community files, templates, TODO, MAP and BLOG drafts. Accuracy review findings (C:\_Code\docs-wip-review.md) are addressed in a later commit before release. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Private helpers isolate edition differences: ConvertFrom-CWMJson (array emission), Get-CWMResponseHeader (string vs string[]), Get-CWMErrorBody, Test-CWMRetryable, Get-CWMRetryDelay, Write-CWMWebRequestError; all masters and Invoke-CWMAllResult route through them. - Request bodies send application/json; charset=utf-8 so 5.1 no longer mangles non-Latin-1 text (#78). - Error messages include the CWM code/message and HTTP status on PS 7. - Retry: 429 on any method, 502/503/504 on GET/HEAD only, Retry-After aware, backoff in seconds. Non-idempotent requests are never retried on 5xx. - Fixes -all returning nested per-page arrays on 5.1. - Connect-CWM impersonation (-MemberID) branch is now reachable. - Desktop-only TLS 1.2 when SecurityProtocol is not SystemDefault. - PowerShellVersion 5.1 (breaking for WMF 4/5.0), CompatiblePSEditions. - Pester 5 harness, GitHub Actions CI (5.1 + pwsh on Windows, pwsh on Ubuntu), PSScriptAnalyzer compatibility settings and a 7-only-parameter lint. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…Document (#65, #43, #45) - Get-CWMReportColumn: initialize the result hashtable (#65). - New-CWMProjectTicket: POST /project/tickets so tickets land on a project (#43). - Clarify Update/New-CWMCompanyConfigurationTypeQuestionValue help: they edit a configuration type question's allowed values, not a configuration's answer; show the Update-CWMCompanyConfiguration -Path questions workflow (#45). - New-CWMDocument: build the multipart body as byte[] so uploads are byte-exact on 5.1 and 7.4+ (previously corrupted on 7.4+). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…, #38) - Get/New/Update/Remove-CWMKnowledgeBaseArticle (#59). - Get-CWMInvoice, Get-CWMOpportunityNote, Get-CWMProjectTicketAllNote and Get-CWMServiceTemplate, re-implemented from PR #77. - Examples/Get-TicketsForConfiguration.ps1 shows two ways to list tickets attached to a configuration (#38). Co-authored-by: Adam Wilson <467720+jadamwilson@users.noreply.github.com> Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…, #23) - Set-CWMConfigurationLastUser.ps1: reworked from PR #79 with parameterized exclusions/config type, exact contact matching, -WhatIf and object output. - TimeSucks.ps1: optional LunchStart/LunchEnd window; fix the scheduled task duration dropping minutes (#23). Co-authored-by: Andrew Kolhoff <53915088+epiphanyplx@users.noreply.github.com> Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…e templates (#53) - Invoke-CWMUpdateMaster accepts -PatchOperations for several operations in one PATCH; remove ops omit value; body is always a JSON array (#53). - Update-CWMProductCatalog gains -PatchOperations; Update template defines the Single/Bulk parameter-set pattern with explicit positions. - Invoke-CWMGetMaster builds the id URL from $Arguments.id instead of a caller-scope $id leak; adds pageId. - New Invoke-CWMSetMaster (PUT) and Invoke-CWMActionMaster (bodyless POST); NewMaster warns when the API returns id 0. - CompanyServiceTemplate and ServiceTemplateResource functions from PR #82, adapted to the shared helpers (redirect rewrite not ported). Co-authored-by: mdewart-Centre <149630552+mdewart-Centre@users.noreply.github.com> Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- New-CWMTicketChild: mandatory ticket ids, declared -StatusName, nested status serialized correctly via Invoke-CWMNewMaster, mismatched -OperationType now errors instead of sending status 0; help covers bundle, merge and an unverified unbundle example (#34). - Disconnect-CWM clears the cookie session as well and is a quiet no-op when not connected. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Nine files had plural names (Get-CWMAgreementTypes.ps1, ...Details.ps1, Get-CWMOpportunityStages.ps1, Get-CWMOpportunityStatuses.ps1) while the functions inside were singular, so the manifest exported names that did not exist and these functions were never callable. Rename the files to match. FunctionsToExport is now generated from the Public files by Tools/Update-CWMManifestExport.ps1 (-Check for CI), which also adds the functions introduced on this branch. Tests/Manifest.Tests.ps1 fails when a file and its function disagree or the export list is stale. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ve (#53) All 33 PATCH wrappers now offer a Bulk parameter set (-PatchOperations) next to the existing Single set, with explicit positions matching the previous implicit binding so positional calls keep working. -Value is optional for 'remove'; Invoke-CWMUpdateMaster errors when an add/replace has no Value key (explicit -Value $null still clears a field) instead of silently sending null. Wrappers that only had placeholder MAML help get full comment-based help. Tests/UpdateSweep.Tests.ps1 covers every wrapper. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Remove invented help dates and unverified API claims, correct the update pattern (-Operation/-Path/-Value or -PatchOperations) everywhere it was documented as an operations array, replace examples that used cmdlets or parameters that do not exist, fix the SearchMaster and BLOG -Parallel examples, bring TODO/MAP/CLAUDE.md in line with the branch, and date 0.4.16 in the CHANGELOG with working links. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Extract ConvertTo-CWMRequestBody for the body/skip-list logic duplicated in Invoke-CWMNewMaster and Invoke-CWMSetMaster, flatten Write-CWMWebRequestError's branches (same messages), and drop SearchMaster's redundant header copy. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Update/Remove-CWMProductPickingShippingDetail sent a literal '{parentId}'
and could never have worked; add mandatory parentId (alias productId).
- New-CWMDocument goes back through Invoke-CWMNewMaster (now byte[]-safe).
- Remove-CWMKnowledgeBaseArticle follows the module-wide Remove-* pattern.
- Get-CWMTicketAllNote uses the documented /allNotes casing.
- Remove boilerplate help (.INPUTS 'none', .NOTES that repeated the endpoint)
and broken example blocks.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Shared Tests/Helpers/TestSetup.ps1; tests reorganized by subject (MasterFunctions, Endpoints, UpdateFunctions, TicketChild, Connection) and redundant assertions removed; legacy file keeps only Integration tests. - Templates match the module's real patterns. - Set-CWMConfigurationLastUser: one alias set per contact, ambiguous matches are skipped. - appveyor.yml marked redundant with GitHub Actions CI. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Connect-CWM detects the server's API version from /system/info and now sends it in the Accept header; that is the only place a version is set. Remove the per-function version tracking: Test-ParameterVersioning, New-CWMTicket's 2019.1/2020.1 parameter sets (-Version, -VersionAutomatic and the 2019.1-only -project/-phase/-wbsCode/-locationId/-businessUnitId; project tickets use New-CWMProjectTicket), per-request Version overrides (a stale Version key is now ignored), Connect-CWM -Version, and '# 20xx.x' API-version comments. BREAKING: Connect-CWM -Version and the New-CWMTicket parameters above are removed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…enAPI spec Statically maps every public function to its HTTP method and path and compares them, and New-* request bodies, with the ConnectWise Manage OpenAPI spec (downloaded on demand; not vendored). Reports calls missing from the spec, path casing mismatches, body field mismatches, and uncovered endpoints. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…tChild (#34) Fixes found by Tools/Test-CWMApiCoverage.ps1 (now clean apart from the uncovered-endpoint backlog): - New-CWMAgreementType posts to /finance/agreements/types. - Path casing: warehouseBins, inventoryOnHand, holidayLists, myMembers, mySecurity. - Update-CWMTimeSheet no longer sends its action switches in the body; reverse/submit are bodyless actions. - Request fields renamed to schema names with the old names as aliases (billSeparateFlag, mobileGuid, _info, location/department, managerContact/assistantContact; ints become references); casing fixed. - Removed parameters the API does not accept (BREAKING): -id on the AllNote getters, New-CWMTicket -dateEntered/-enteredBy, New-CWMProductCatalog -dateEntered, New-CWMMember -TimeZoneSetupReference/-remotePackage*. - New Remove-CWMTicketChild uses /detachChildren to unbundle tickets (#34). - New-CWMProjectTicket gains workRole/workType/location/department. - Get-TicketsForConfiguration example documents the per-ticket method (#38). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- UpdateMaster keeps PSCustomObject values (e.g. $ticket.board) instead of
sending {}; masters no longer return a caller-scope $Result under -WhatIf.
- Mask password/token/privateKey/secret/memberHash values in debug, verbose
and -WhatIf output.
- -all paging only follows next-page links on the connected host without a
scheme downgrade.
- Connect-CWM: no partial state after a failed connect; reconnects when the
server, company, sign-in method or member differs; resets a stale cookie
session; Secure cookies; validates -Server; escapes Company/MemberID.
-MemberID now really impersonates (0.4.16 silently used the API key).
- Redirect errors are method-aware and warn on writes that the record may
already exist (#70).
- SearchMaster no longer leaks a caller's $URLParameters; searches are
retried like other reads. ProgressAction is never sent in a body.
- New-CWMDebugReport omits headers, session and errors.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Submit-CWMTimeSheet delegates to Update-CWMTimeSheet -Submit (-WhatIf). - Get-CWMContactType's filter is applied (condition, alias conditions). - -count works on Get-CWMAuditTrail/Get-CWMDocument; values are escaped. - Mandatory route ids where a missing id built a broken URL; fixes Get-CWMProductAdjustmentDetail (always //details) and New-CWMMarketingGroupCompany (sent groupId in the body). - Replace wrong aliases (BREAKING: somethingId, companyId on State/Country, catalogId, agreementId) with correct ones. - New-CWMCompanyContact -portalPassword works (SecureString converted). - New-CWMDocument sanitizes multipart header values; string path values are URL-escaped. - Test-CWMApiCoverage runs on 5.1 without pinning TLS. - CLAUDE.md trimmed and corrected (PowerShell 5.1 minimum). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ult nulls Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…e-tenant reconnect - -Server accepts a pasted full URL (reduced to the host, as in 0.4.16) and underscore hostnames; userinfo and @#?\ in the host are still rejected. - A failed Connect-CWM -Force to the same server/company restores the previous connection; a failed connect to another tenant still clears it. - -all paging also requires the next-page link's port to match. - Searches get read-style redirect errors and redacted verbose output. - Tests assert the -count URLs; CLAUDE.md restores the PlatyPS cleanup step and the retry / latest-API / -childConditions rules; template placeholder alias removed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…dentity A failed reconnect restored the previous connection whenever the server and company matched, so a failed impersonation of another member (or a switch from API key to impersonation) silently left the caller acting as the old identity. Restore only when server, company, sign-in method and member all match and the previous connection has not expired; otherwise clear it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- SECURITY: private vulnerability reporting, no promised response times. - CODE_OF_CONDUCT: reference the Contributor Covenant 2.1. - FUNDING points to the Donate folder; drop the nonexistent Sponsors entry. - Shorter bug report and PR templates; replace the dead MSPGeek link. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- CHANGELOG [0.5.0] with breaking changes and migration hints, additions, fixes, security notes and contributor credits (date set at publish). - ModuleVersion 0.5.0; ReleaseNotes summarize breaking changes. - README: upgrade notes, PowerShell 7.4 insecure-redirect troubleshooting, requirements (5.1+, 7.4+ recommended). - Docs regenerated once with PlatyPS (34 new pages, changed functions regenerated fresh, -ProgressAction stripped), help XML and the function list rebuilt; help text reworded where PlatyPS misread a '#'. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
GitHub Actions (5.1 and pwsh on Windows, pwsh on Ubuntu) replaces AppVeyor. Tests/appveyor.pester.ps1 becomes Tests/Invoke-Tests.ps1 without the AppVeyor upload. README shows the Actions badge. The defunct MSPGeek Slack links and empty placeholder links in CONTRIBUTING are replaced with the help, Docs, Wiki and issue search. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Replace the remotely downloaded logging helper (Invoke-Expression from a GitHub master branch) with a small local Write-TSLog. Remove the .vbs and self auto-update downloads; the scheduled task runs the locally installed copy hidden via conhost --headless at limited privilege. Lunch window behaviour is unchanged (the clock restarts at LunchEnd). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
153 functions that had no or partial help now have a synopsis, a description with the HTTP method and endpoint, every parameter documented (body parameters from the 2026.11 OpenAPI schema), and at least one example. Docs/*.md and the help XML regenerated; no PlatyPS placeholders remain. Comments only; no code changes. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
From a review of the module against ConnectWise PSA API guidance: - Get-CWMDocument -download returns the file (byte[] or -OutFile) instead of parsing it as JSON. New private Invoke-CWMDownload sends Accept */*. - New-CWMDocument: fix the malformed PrivateFlag multipart header. -Private (default $true) now reaches the server (listed under Breaking changes). - Connect-CWM: impersonation token and cookie login use the server's codebase instead of a hard-coded v4_6_release; companyinfo gets ClientID and a clear error when no codebase comes back. - -all asks for pageSize 1000 (API max), keeps a smaller -pageSize, and follows the rel="next" Link entry. - [datetime] values in request bodies and patch values are sent as ISO 8601 UTC on both editions; unspecified-kind dates keep their calendar day. - Every request sends User-Agent ConnectWiseManageAPI/<ver> PowerShell/<ver>. - Get masters no longer emit the error record as a result on bad JSON. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Generated from the OpenAPI spec in the module's existing style and checked
with Tools/Test-CWMApiCoverage.ps1 (0 issues; 427 of 3132 operations covered,
was 376):
- Custom fields: Get/New/Update/Remove-CWMUserDefinedField.
- Agreements: Get/New/Update/Remove-CWMAgreementAdjustment, -WorkRole and
-WorkType.
- Invoices: New-CWMInvoice, Update-CWMInvoice, Get-CWMInvoice -pdf [-OutFile].
- Ticket children: Get-CWMTicketTimeEntry, -ScheduleEntry, -Document and
-Product. These return full records from /time/entries, /schedule/entries,
/system/documents and /procurement/products (filtered on ticket/id; the
spec's chargeToType hint names fields ProductItem lacks), not the id-only
/service/tickets/{id}/... endpoints the API documentation redirects from.
- Lookups: Get-CWMWorkRole, Get-CWMWorkType, Get-CWMExpenseType,
Get-CWMConfigurationStatus, Get-CWMWorkflow.
- Expenses: Update-CWMExpenseEntry, Remove-CWMExpenseEntry.
Offline tests, regenerated PlatyPS docs, function index and CHANGELOG.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…docs Update-MarkdownHelp keeps existing text, so docs for functions whose help was rewritten after first generation (the four Get-CWMTicket* children, Get-CWMDocument, Get-CWMInvoice, Invoke-CWMAllResult) still showed the old descriptions. Recreated them with New-MarkdownHelp and rebuilt the external help. Adds the missing .PARAMETER PageSize help that the conventions test caught. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…meouts Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Live tests have not yet been run against a ConnectWise server. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Connect-CWM: compute cached-connection identity/expiry once; new private ConvertTo-CWMBasicAuth replaces three copies of the Basic header. - Endpoint wrappers: template-consistent parameter names/types, route ids renamed to parentId/id with the old names kept as aliases, Get-CWMReport escapes the report name, Get-CWMSSOConfiguration -id is [int], Opportunity getters take [string[]] -fields, -customFields takes an array everywhere, New-CWMOpportunityForecastItem -id is mandatory, New-CWMAgreementType no longer prompts twice. Added warehouseBinId/purchaseOrderId/opportunityId aliases. - Tests: fold duplicate rows into tables; regression tests for the above. - README/CONTRIBUTING/CHANGELOG: accuracy and TOC fixes. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Money parameters are [double], not single-precision [float] (1234567.89 was sent as 1234567.9 on pwsh 7). New-CWMOpportunity -totalSalesTax and New-CWMOpportunityForecastItem -quantity are [double] too. - Array/enum types match the spec: New-CWMProductAdjustment -adjustmentDetails, -serialNumberIds/-serialNumbers on New-CWMProduct and New-CWMProductPickingShippingDetail, New-CWMProductCatalog -priceAttribute (string enum), New-CWMMember ValidateSets gain Email, TEL and CALLTO. - New-CWMCompanyNote no longer sends the company id in the body: the route id is -parentId, with -companyId and the old -id as aliases. - New-CWM(Project)TicketConfiguration: -id is [int] and -deviceIdentifier is its own body property (it was an alias of -id). - ConvertTo-CWMTime formats with the invariant culture. - Connect-CWM connects again when -ClientID or -BasePath changes. - New-CWMDocument resolves -FilePath against the PowerShell location. - New-CWMDebugReport hashes with SHA-256 (MD5 throws under FIPS on 5.1). - Get-CWMCompany help filters company types with -childConditions. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- New-CWMDocument -FilePath takes a FileInfo by its FullName again. As a [string], a FileInfo from Get-ChildItem converted to its bare name on 5.1 and could upload the wrong file. Strings resolve against the current PowerShell location. - CHANGELOG: list the new breaking changes (mandatory forecast item id, priceAttribute enum, ticket configuration -id/-deviceIdentifier, SSO id, a fifth positional shift) and the pass 1 fixes; drop two "breaks" that never reached users (Update-CWMAgreementType was not exported; the Get-CWMCompanyState alias was never loaded); name the spec source. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- New-CWMCompanyContact -country is a [hashtable] reference; as a [string] a hashtable was sent as "System.Collections.Hashtable". - New-CWMTicket -integratorTags is [string[]] (an array was joined). - New-CWMCompanyConfiguration -backupBillableSpaceGb is [double]. - New-CWMTimeEntry -chargeToType accepts Company. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- Get-CWMOpportunity, Get-CWMOpportunityStatus and Get-CWMOpportunityStage take -id and -count (adding [CmdletBinding()] made those calls throw; before, they were silently ignored and returned every record). - New-CWMDocument rejects several files with a clear message. - CHANGELOG: New-CWMCompanyContact -country listed as a breaking type change. - Tests: the "passes a copy" table checks the exact reference id again. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…eview passes Recreated Docs/*.md with New-MarkdownHelp for the 66 functions changed since a7524fb (Update-MarkdownHelp keeps stale descriptions), then rebuilt en-US/ConnectWiseManageAPI-help.xml with New-ExternalHelp. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…t child getters Get-CWMAgreementAdjustment/WorkRole/WorkType and Get-CWMTicketDocument/ Product/ScheduleEntry/TimeEntry need -parentId; the live test called them without one. Resolvers also use the current route-id names. Live read run against a production server (read-only API member), pwsh 7 and Windows PowerShell 5.1: 0 failed; 51 inconclusive (403 for the member's security role). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ting error Invoke-CWMAllResult used Write-Error (non-terminating) when the server's next-page link failed the host check, so `$x = Get-CWMTicket -all` got only the first page and the script carried on. It now throws: the assignment never receives a partial result and try/catch sees the failure. The missing forward-only Link header case throws too. The host/port/https check itself is unchanged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Release 0.5.0. The full notes, including breaking changes and migration steps, are in CHANGELOG.md.
Highlights
Connect-CWM -Versionremoved).New-CWMProjectTicket. The project parameters are removed fromNew-CWMTicket.Connect-CWM -MemberIDnow really impersonates the member.-allpaging only follows next-page links on the connected host. A link to anywhere else stops the call with a terminating error.Verification
After merge
Publish
./ConnectWiseManageAPIto the PowerShell Gallery (dry run first withPublish-Module -WhatIf).🤖 Generated with Claude Code