Update docs

appveyor.yml

@@ -10,8 +10,9 @@
 # This tells AppVeyor that we need WMF 5 and PowerShell 5.0
 os: WMF 5
 
-#environment:
+environment:
-    # To encrypt a value in AppVeyor, go to the Account menu and choose "Encrypt data"
+  PSGalleryAPIKey:
+    secure: UdM6qhf5B0G8liHhUrwWERCZr44iSqmg4jUq0lwlTjZs4KyeoiwnBzdej0phqIAm
 
 version: 1.0.{build}
 
@@ -58,3 +59,17 @@ build_script:
 test_script:
     - ps: Invoke-Build -Task Test
 
+before_deploy:
+    - ps: Invoke-Build -Task Deploy
+
+deploy:
+    provider: GitHub
+    release: v$(appveyor_build_version)
+    description: ''
+    auth_token:
+        secure: m72Ke3nJcSxZkc36UwRIw+q0NtNvERfQYHZUBNDvLP/kjW+mWmVueR6tmgBujyBM
+    draft: false
+    prerelease: false
+    on:
+        branch: master                  # release from master branch only
+        appveyor_repo_tag: false        # deploy on tag push only

docs/Get-Category.md

@@ -5,7 +5,7 @@ online version:
 schema: 2.0.0
 ---
 
-# Get-Categories
+# Get-Category
 
 ## SYNOPSIS
 {{Fill in the Synopsis}}
@@ -13,7 +13,7 @@ schema: 2.0.0
 ## SYNTAX
 
 ```
-Get-Categories [-url] <String> [-apiKey] <String>
+Get-Category [-url] <String> [-apiKey] <String>
 ```
 
 ## DESCRIPTION

docs/Get-Manufacturer.md

@@ -5,7 +5,7 @@ online version:
 schema: 2.0.0
 ---
 
-# Get-Manufacturers
+# Get-Manufacturer
 
 ## SYNOPSIS
 {{Fill in the Synopsis}}
@@ -13,7 +13,7 @@ schema: 2.0.0
 ## SYNTAX
 
 ```
-Get-Manufacturers [-url] <String> [-apiKey] <String>
+Get-Manufacturer [-url] <String> [-apiKey] <String>
 ```
 
 ## DESCRIPTION

docs/Get-Model.md

@@ -5,7 +5,7 @@ online version:
 schema: 2.0.0
 ---
 
-# Get-Models
+# Get-Model
 
 ## SYNOPSIS
 {{Fill in the Synopsis}}
@@ -13,7 +13,7 @@ schema: 2.0.0
 ## SYNTAX
 
 ```
-Get-Models [-url] <String> [-apiKey] <String>
+Get-Model [-url] <String> [-apiKey] <String>
 ```
 
 ## DESCRIPTION

docs/Get-User.md

@@ -5,7 +5,7 @@ online version:
 schema: 2.0.0
 ---
 
-# Get-Users
+# Get-User
 
 ## SYNOPSIS
 # Gets a list of Snipe-it Users
@@ -13,7 +13,7 @@ schema: 2.0.0
 ## SYNTAX
 
 ```
-Get-Users [-url] <String> [-apiKey] <String>
+Get-User [-url] <String> [-apiKey] <String>
 ```
 
 ## DESCRIPTION

docs/Invoke-Method.md

@@ -1,102 +0,0 @@
----
-external help file: SnipeItPS-help.xml
-Module Name: SnipeItPS
-online version: 
-schema: 2.0.0
----
-
-# Invoke-Method
-
-## SYNOPSIS
-Extracted invokation of the REST method to own function.
-
-## SYNTAX
-
-```
-Invoke-Method [-URi] <Uri> [[-Method] <String>] [[-Body] <String>] [[-Token] <String>]
-```
-
-## DESCRIPTION
-{{Fill in the Description}}
-
-## EXAMPLES
-
-### Example 1
-```
-PS C:\> {{ Add example code here }}
-```
-
-{{ Add example description here }}
-
-## PARAMETERS
-
-### -URi
-REST API to invoke
-
-```yaml
-Type: Uri
-Parameter Sets: (All)
-Aliases: 
-
-Required: True
-Position: 1
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
-### -Method
-Method of the invokation
-
-```yaml
-Type: String
-Parameter Sets: (All)
-Aliases: 
-
-Required: False
-Position: 2
-Default value: GET
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
-### -Body
-Body of the request
-
-```yaml
-Type: String
-Parameter Sets: (All)
-Aliases: 
-
-Required: False
-Position: 3
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
-### -Token
-{{Fill Token Description}}
-
-```yaml
-Type: String
-Parameter Sets: (All)
-Aliases: 
-
-Required: False
-Position: 4
-Default value: None
-Accept pipeline input: False
-Accept wildcard characters: False
-```
-
-## INPUTS
-
-## OUTPUTS
-
-### System.Management.Automation.PSObject
-
-## NOTES
-
-## RELATED LINKS
-

docs/New-Asset.md

@@ -14,7 +14,7 @@ schema: 2.0.0
 
 ```
 New-Asset [-Name] <String> [-Status_id] <String> [-Model_id] <String> [-url] <String> [-apiKey] <String>
- [[-customfields] <Hashtable>]
+ [[-customfields] <Hashtable>] [-WhatIf] [-Confirm]
 ```
 
 ## DESCRIPTION
@@ -31,6 +31,21 @@ PS C:\> {{ Add example code here }}
 
 ## PARAMETERS
 
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Model_id
 {{Fill Model_id Description}}
 
@@ -76,6 +91,22 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -WhatIf
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -apiKey
 {{Fill apiKey Description}}
 

docs/New-Component.md

@@ -14,6 +14,7 @@ schema: 2.0.0
 
 ```
 New-Component [-name] <String> [-category_id] <String> [-qty] <String> [-url] <String> [-apiKey] <String>
+ [-WhatIf] [-Confirm]
 ```
 
 ## DESCRIPTION
@@ -30,6 +31,37 @@ PS C:\> {{ Add example code here }}
 
 ## PARAMETERS
 
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -WhatIf
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -apiKey
 {{Fill apiKey Description}}
 

docs/New-Manufacturer.md

@@ -13,7 +13,7 @@ schema: 2.0.0
 ## SYNTAX
 
 ```
-New-Manufacturer [-Name] <String> [-url] <String> [-apiKey] <String>
+New-Manufacturer [-Name] <String> [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
 ```
 
 ## DESCRIPTION
@@ -30,6 +30,21 @@ PS C:\> {{ Add example code here }}
 
 ## PARAMETERS
 
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Name
 {{Fill Name Description}}
 
@@ -45,6 +60,22 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -WhatIf
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -apiKey
 {{Fill apiKey Description}}
 

docs/New-Model.md

@@ -14,7 +14,7 @@ schema: 2.0.0
 
 ```
 New-Model [-name] <String> [-category_id] <Int32> [-manufacturer_id] <Int32> [-fieldset_id] <Int32>
- [-url] <String> [-apiKey] <String>
+ [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
 ```
 
 ## DESCRIPTION
@@ -31,6 +31,37 @@ PS C:\> {{ Add example code here }}
 
 ## PARAMETERS
 
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -WhatIf
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -apiKey
 {{Fill apiKey Description}}
 

docs/Set-Asset.md

@@ -14,7 +14,7 @@ schema: 2.0.0
 
 ```
 Set-Asset [-id] <Int32> [-Name] <String> [-Status_id] <String> [-Model_id] <String> [-url] <String>
- [-apiKey] <String> [[-customfields] <Hashtable>]
+ [-apiKey] <String> [[-customfields] <Hashtable>] [-WhatIf] [-Confirm]
 ```
 
 ## DESCRIPTION
@@ -31,6 +31,21 @@ PS C:\> {{ Add example code here }}
 
 ## PARAMETERS
 
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Model_id
 {{Fill Model_id Description}}
 
@@ -76,6 +91,22 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -WhatIf
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -apiKey
 {{Fill apiKey Description}}
 

docs/Set-AssetOwner.md

@@ -13,7 +13,7 @@ schema: 2.0.0
 ## SYNTAX
 
 ```
-Set-AssetOwner [-id] <Int32> [-user_id] <Int32> [-url] <String> [-apiKey] <String>
+Set-AssetOwner [-id] <Int32> [-user_id] <Int32> [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
 ```
 
 ## DESCRIPTION
@@ -30,6 +30,37 @@ PS C:\> {{ Add example code here }}
 
 ## PARAMETERS
 
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -WhatIf
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -apiKey
 {{Fill apiKey Description}}
 

docs/Set-Component.md

@@ -5,7 +5,7 @@ online version:
 schema: 2.0.0
 ---
 
-# Update-Component
+# Set-Component
 
 ## SYNOPSIS
 {{Fill in the Synopsis}}
@@ -13,7 +13,7 @@ schema: 2.0.0
 ## SYNTAX
 
 ```
-Update-Component [-id] <String> [-qty] <String> [-url] <String> [-apiKey] <String>
+Set-Component [-id] <String> [-qty] <String> [-url] <String> [-apiKey] <String> [-WhatIf] [-Confirm]
 ```
 
 ## DESCRIPTION
@@ -30,6 +30,37 @@ PS C:\> {{ Add example code here }}
 
 ## PARAMETERS
 
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -WhatIf
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -apiKey
 {{Fill apiKey Description}}