Fixing Required Attachments

[GradyD]

Description

closes #336

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• My code follows the code style of this project.
• I have added Pester Tests that describe what my changes should do.
• I have updated the documentation accordingly.

[lipkau]

I added a few inline comments in your code.
Additionally, please consider:

• I didn't test it, but I am reasonably confident, that the 400 response contains the information why the request failed (missing required fields). Why can't we use this information for our output? Adding our own business logic for identifying why a request failed should be avoided as long as the information returned by the API is not good enough. As I don't know how the response looks like (without looking it up), please state your case why you deem necessary to add this logic to the module.
• I have an improvement for the error handling staged on my local machine to improve it a bit. take a look if your code could benefit from it (I didn't check):

        $allErrors = ($responseObject.errorMessages + $responseObject.message + $responseObject.errors)

                if ($allErrors.Count -eq 0) {
                    throw "Unable to handle error"
                }

                foreach ($_error in $allErrors) {
                    if ($_error.Count -gt 0) {
                        $writeErrorSplat = @{
                            Exception    = $exception
                            ErrorId      = $errorId
                            Category     = $errorCategory
                            Message      = Out-String -InputObject $_error
                            TargetObject = $targetObject
                            Cmdlet       = $Cmdlet
                        }
                        WriteError @writeErrorSplat
                    }
                }

• You must still update the existing tests to pass with these changes
• You should add new tests (with a mocked 400 response) showing how these errors are handled

[lipkau]

Please use the same exception type as Invoke-WebRequest returns
(System.Net.WebException for PSVersion -lt 6 and Microsoft.PowerShell.Commands.HttpResponseException for PSVersion -ge 6)

[lipkau]

Please use [System.Collections.ArrayList]

Reading material on why: https://gist.github.com/kevinblumenfeld/4a698dbc90272a336ed9367b11d91f1c

[lipkau]

I don't trust parsing text from the answer. What happens when the system is installed in another language?
(Unfortunately I can't test that)

Is there any other way we can identify this?

[lipkau]

You shouldn't use throw here. Throw will cause the entire script to fail when this happens (unless used with try {} catch {}.
Please use WriteError (can have the same behavior if wanted, by adding -ErrorAction Stop to the script)