diff --git a/DattoAPI/DattoAPI.psd1 b/DattoAPI/DattoAPI.psd1 index 7142842..1312380 100644 Binary files a/DattoAPI/DattoAPI.psd1 and b/DattoAPI/DattoAPI.psd1 differ diff --git a/DattoAPI/Private/APICalls.ps1 b/DattoAPI/Private/APICalls.ps1 index 7e5c9fe..fa29caf 100644 --- a/DattoAPI/Private/APICalls.ps1 +++ b/DattoAPI/Private/APICalls.ps1 @@ -1,15 +1,15 @@ -function ConvertTo-QueryString { +function ConvertTo-DattoQueryString { <# .SYNOPSIS Converts uri filter parameters .DESCRIPTION - The Invoke-ApiRequest cmdlet converts & formats uri filter parameters + The Invoke-DattoRequest cmdlet converts & formats uri filter parameters from a function which are later used to make the full resource uri for an API call This is an internal helper function the ties in directly with the - Invoke-ApiRequest & any public functions that define parameters + Invoke-DattoRequest & any public functions that define parameters .PARAMETER uri_Filter Hashtable of values to combine a functions parameters with @@ -21,7 +21,7 @@ function ConvertTo-QueryString { Defines the short resource uri (url) to use when creating the API call .EXAMPLE - ConvertTo-QueryString -uri_Filter $uri_Filter -resource_Uri '/account' + ConvertTo-DattoQueryString -uri_Filter $uri_Filter -resource_Uri '/account' Example: (From public function) $uri_Filter = @{} @@ -38,7 +38,7 @@ function ConvertTo-QueryString { N\A .LINK - https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/ConvertTo-QueryString.html + https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/ConvertTo-DattoQueryString.html #> @@ -98,13 +98,13 @@ param( -function Invoke-ApiRequest { +function Invoke-DattoRequest { <# .SYNOPSIS Makes an API request .DESCRIPTION - The Invoke-ApiRequest cmdlet invokes an API request to Datto API. + The Invoke-DattoRequest cmdlet invokes an API request to Datto API. This is an internal function that is used by all public functions @@ -120,13 +120,13 @@ function Invoke-ApiRequest { Defines the resource uri (url) to use when creating the API call .PARAMETER uri_Filter - Used with the internal function [ ConvertTo-QueryString ] to combine + Used with the internal function [ ConvertTo-DattoQueryString ] to combine a functions parameters with the resource_Uri parameter. This allows for the full uri query to occur The full resource path is made with the following data - $Datto_Base_URI + $resource_Uri + ConvertTo-QueryString + $Datto_Base_URI + $resource_Uri + ConvertTo-DattoQueryString .PARAMETER data Place holder parameter to use when other methods are supported @@ -139,7 +139,7 @@ function Invoke-ApiRequest { parameters .EXAMPLE - Invoke-ApiRequest -method GET -resource_Uri '/account' -uri_Filter $uri_Filter + Invoke-DattoRequest -method GET -resource_Uri '/account' -uri_Filter $uri_Filter Invoke a rest method against the defined resource using any of the provided parameters @@ -156,7 +156,7 @@ function Invoke-ApiRequest { N\A .LINK - https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Invoke-ApiRequest.html + https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Invoke-DattoRequest.html #> @@ -184,7 +184,7 @@ function Invoke-ApiRequest { process{ - $query_string = ConvertTo-QueryString -uri_Filter $uri_Filter -resource_Uri $resource_Uri + $query_string = ConvertTo-DattoQueryString -uri_Filter $uri_Filter -resource_Uri $resource_Uri Set-Variable -Name 'Datto_queryString' -Value $query_string -Scope Global -Force @@ -241,9 +241,9 @@ function Invoke-ApiRequest { Write-Warning 'The [ Datto_invokeParameters, Datto_queryString, & Datto_CmdletNameParameters ] variables can provide extra details' switch -Wildcard ($exceptionError) { - '*404*' { Write-Error "Invoke-ApiRequest : [ $resource_Uri ] not found!" } - '*429*' { Write-Error 'Invoke-ApiRequest : API rate limited' } - '*504*' { Write-Error "Invoke-ApiRequest : Gateway Timeout" } + '*404*' { Write-Error "Invoke-DattoRequest : [ $resource_Uri ] not found!" } + '*429*' { Write-Error 'Invoke-DattoRequest : API rate limited' } + '*504*' { Write-Error "Invoke-DattoRequest : Gateway Timeout" } default { Write-Error $_ } } @@ -278,13 +278,13 @@ function Invoke-ApiRequest { -function Get-InvokeMetaData { +function Get-DattoMetaData { <# .SYNOPSIS Gets various Api metadata values .DESCRIPTION - The Get-InvokeMetaData cmdlet gets various Api metadata values from an + The Get-DattoMetaData cmdlet gets various Api metadata values from an Invoke-WebRequest to assist in various troubleshooting scenarios such as rate-limiting. @@ -294,7 +294,7 @@ function Get-InvokeMetaData { The default base URI is https://api.datto.com/v1 .EXAMPLE - Get-InvokeMetaData + Get-DattoMetaData Gets various Api metadata values from an Invoke-WebRequest to assist in various troubleshooting scenarios such as rate-limiting. @@ -303,7 +303,7 @@ function Get-InvokeMetaData { https://api.datto.com/v1 .EXAMPLE - Get-InvokeMetaData -base_uri http://myapi.gateway.example.com + Get-DattoMetaData -base_uri http://myapi.gateway.example.com Gets various Api metadata values from an Invoke-WebRequest to assist in various troubleshooting scenarios such as rate-limiting. @@ -315,7 +315,7 @@ function Get-InvokeMetaData { N\A .LINK - https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Get-InvokeMetaData.html + https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Get-DattoMetaData.html #> [CmdletBinding()] diff --git a/DattoAPI/Public/BCDR_ActivityLog.ps1 b/DattoAPI/Public/BCDR_ActivityLog.ps1 index 94e175f..77907a3 100644 --- a/DattoAPI/Public/BCDR_ActivityLog.ps1 +++ b/DattoAPI/Public/BCDR_ActivityLog.ps1 @@ -147,8 +147,8 @@ function Get-DattoActivityLog { Set-Variable -Name 'Datto_activityLogParameters' -Value $PSBoundParameters -Scope Global -Force switch ($allPages) { - $true { Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters -allPages } - $false { Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } + $true { Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters -allPages } + $false { Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } } } diff --git a/DattoAPI/Public/BCDR_Agent.ps1 b/DattoAPI/Public/BCDR_Agent.ps1 index 3ee1a1d..9c942d9 100644 --- a/DattoAPI/Public/BCDR_Agent.ps1 +++ b/DattoAPI/Public/BCDR_Agent.ps1 @@ -103,8 +103,8 @@ function Get-DattoAgent { Set-Variable -Name 'Datto_agentParameters' -Value $PSBoundParameters -Scope Global -Force switch ($allPages) { - $true { Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters -allPages } - $false { Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } + $true { Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters -allPages } + $false { Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } } } diff --git a/DattoAPI/Public/BCDR_Alert.ps1 b/DattoAPI/Public/BCDR_Alert.ps1 index 5928ff6..d413097 100644 --- a/DattoAPI/Public/BCDR_Alert.ps1 +++ b/DattoAPI/Public/BCDR_Alert.ps1 @@ -84,8 +84,8 @@ function Get-DattoAlert { Set-Variable -Name 'Datto_alertParameters' -Value $PSBoundParameters -Scope Global -Force switch ($allPages) { - $true { Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters -allPages } - $false { Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } + $true { Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters -allPages } + $false { Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } } } diff --git a/DattoAPI/Public/BCDR_Asset.ps1 b/DattoAPI/Public/BCDR_Asset.ps1 index 1ba324b..b106777 100644 --- a/DattoAPI/Public/BCDR_Asset.ps1 +++ b/DattoAPI/Public/BCDR_Asset.ps1 @@ -84,8 +84,8 @@ function Get-DattoAsset { Set-Variable -Name 'Datto_assetParameters' -Value $PSBoundParameters -Scope Global -Force switch ($allPages) { - $true { Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters -allPages } - $false { Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } + $true { Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters -allPages } + $false { Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } } } diff --git a/DattoAPI/Public/BCDR_BCDR.ps1 b/DattoAPI/Public/BCDR_BCDR.ps1 index 5fd0d52..94c266f 100644 --- a/DattoAPI/Public/BCDR_BCDR.ps1 +++ b/DattoAPI/Public/BCDR_BCDR.ps1 @@ -255,8 +255,8 @@ function Get-DattoBCDR { Set-Variable -Name 'Datto_bcdrParameters' -Value $PSBoundParameters -Scope Global -Force switch ($allPages) { - $true { Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters -allPages } - $false { Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } + $true { Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters -allPages } + $false { Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } } } diff --git a/DattoAPI/Public/BCDR_Device.ps1 b/DattoAPI/Public/BCDR_Device.ps1 index 525c3bb..af5ba89 100644 --- a/DattoAPI/Public/BCDR_Device.ps1 +++ b/DattoAPI/Public/BCDR_Device.ps1 @@ -121,8 +121,8 @@ function Get-DattoDevice { Set-Variable -Name 'Datto_deviceParameters' -Value $PSBoundParameters -Scope Global -Force switch ($allPages) { - $true { Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters -allPages } - $false { Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } + $true { Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters -allPages } + $false { Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } } } diff --git a/DattoAPI/Public/BCDR_Share.ps1 b/DattoAPI/Public/BCDR_Share.ps1 index 7012621..a39a73c 100644 --- a/DattoAPI/Public/BCDR_Share.ps1 +++ b/DattoAPI/Public/BCDR_Share.ps1 @@ -84,8 +84,8 @@ function Get-DattoShare { Set-Variable -Name 'Datto_assetShareParameters' -Value $PSBoundParameters -Scope Global -Force switch ($allPages) { - $true { Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters -allPages } - $false { Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } + $true { Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters -allPages } + $false { Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } } } diff --git a/DattoAPI/Public/BCDR_Volume.ps1 b/DattoAPI/Public/BCDR_Volume.ps1 index 5cf29f2..4756cf6 100644 --- a/DattoAPI/Public/BCDR_Volume.ps1 +++ b/DattoAPI/Public/BCDR_Volume.ps1 @@ -55,7 +55,7 @@ function Get-DattoVolume { Set-Variable -Name 'Datto_assetVolumeParameters' -Value $PSBoundParameters -Scope Global -Force - Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters + Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } diff --git a/DattoAPI/Public/SaaS_Application.ps1 b/DattoAPI/Public/SaaS_Application.ps1 index 6f2b454..3909f78 100644 --- a/DattoAPI/Public/SaaS_Application.ps1 +++ b/DattoAPI/Public/SaaS_Application.ps1 @@ -43,7 +43,7 @@ function Get-DattoApplication { Set-Variable -Name 'Datto_applicationParameters' -Value $PSBoundParameters -Scope Global -Force - Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters + Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } diff --git a/DattoAPI/Public/SaaS_Domain.ps1 b/DattoAPI/Public/SaaS_Domain.ps1 index 2043d09..ba30dad 100644 --- a/DattoAPI/Public/SaaS_Domain.ps1 +++ b/DattoAPI/Public/SaaS_Domain.ps1 @@ -34,7 +34,7 @@ function Get-DattoDomain { Set-Variable -Name 'Datto_domainParameters' -Value $PSBoundParameters -Scope Global -Force - Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters + Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } diff --git a/DattoAPI/Public/SaaS_SaaS.ps1 b/DattoAPI/Public/SaaS_SaaS.ps1 index 78f5f70..7ac64ef 100644 --- a/DattoAPI/Public/SaaS_SaaS.ps1 +++ b/DattoAPI/Public/SaaS_SaaS.ps1 @@ -87,7 +87,7 @@ function Get-DattoSaaS { Set-Variable -Name 'Datto_bcdrParameters' -Value $PSBoundParameters -Scope Global -Force - Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters + Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } diff --git a/DattoAPI/Public/SaaS_Seat.ps1 b/DattoAPI/Public/SaaS_Seat.ps1 index dba2030..d488f30 100644 --- a/DattoAPI/Public/SaaS_Seat.ps1 +++ b/DattoAPI/Public/SaaS_Seat.ps1 @@ -43,7 +43,7 @@ function Get-DattoSeat { Set-Variable -Name 'Datto_seatParameters' -Value $PSBoundParameters -Scope Global -Force - Invoke-ApiRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters + Invoke-DattoRequest -method GET -resource_Uri $resource_Uri -uri_Filter $PSBoundParameters } diff --git a/docs/DattoAPI.md b/docs/DattoAPI.md index a4b6207..e70d953 100644 --- a/docs/DattoAPI.md +++ b/docs/DattoAPI.md @@ -18,7 +18,7 @@ Sets the API public & secret keys used to authenticate API calls. ### [Add-DattoBaseURI](site/Internal/Add-DattoBaseURI.md) Sets the base URI for the Datto API connection. -### [ConvertTo-QueryString](site/Internal/ConvertTo-QueryString.md) +### [ConvertTo-DattoQueryString](site/Internal/ConvertTo-DattoQueryString.md) Converts uri filter parameters ### [Export-DattoModuleSettings](site/Internal/Export-DattoModuleSettings.md) @@ -54,6 +54,9 @@ Gets Datto BCDR devices from the the Datto API. ### [Get-DattoDomain](site/SaaS/Get-DattoDomain.md) Get Datto SaaS protection data about what domains are being protected +### [Get-DattoMetaData](site/Internal/Get-DattoMetaData.md) +Gets various Api metadata values + ### [Get-DattoModuleSettings](site/Internal/Get-DattoModuleSettings.md) Gets the saved Datto configuration settings @@ -69,13 +72,10 @@ Gets Datto BCDR shares for a given device ### [Get-DattoVolume](site/BCDR/Get-DattoVolume.md) Gets an asset(s)(agent or share) for a specific volume on a device -### [Get-InvokeMetaData](site/Internal/Get-InvokeMetaData.md) -Gets various Api metadata values - ### [Import-DattoModuleSettings](site/Internal/Import-DattoModuleSettings.md) Imports the Datto BaseURI, API, & JSON configuration information to the current session. -### [Invoke-ApiRequest](site/Internal/Invoke-ApiRequest.md) +### [Invoke-DattoRequest](site/Internal/Invoke-DattoRequest.md) Makes an API request ### [Remove-DattoAPIKey](site/Internal/Remove-DattoAPIKey.md) diff --git a/docs/Endpoints.csv b/docs/Endpoints.csv index 65f1196..ee974a1 100644 --- a/docs/Endpoints.csv +++ b/docs/Endpoints.csv @@ -10,18 +10,18 @@ BCDR,/bcdr/device/{serialNumber}/asset/share,GET,Get-DattoShare,YES, BCDR,/bcdr/device/{serialNumber}/asset/{volumeName},GET,Get-DattoVolume,YES, Internal,,POST,Add-DattoAPIKey,YES, Internal,,POST,Add-DattoBaseURI,YES, -Internal,,PUT,ConvertTo-QueryString,YES, +Internal,,PUT,ConvertTo-DattoQueryString,YES, Internal,,GET,Export-DattoModuleSettings,YES, Internal,,GET,Get-DattoAPIKey,YES, Internal,,GET,Get-DattoBaseURI,YES, Internal,,GET,Get-DattoModuleSettings,YES, Internal,,GET,Import-DattoModuleSettings,YES, -Internal,,GET,Invoke-APIRequest,YES, +Internal,,GET,Invoke-DattoRequest,YES, Internal,,DELETE,Remove-DattoAPIKey,YES, Internal,,DELETE,Remove-DattoBaseURI,YES, Internal,,DELETE,Remove-DattoModuleSettings,YES, Internal,,GET,Test-DattoAPIKey,YES, -Internal,,GET,Get-InvokeMetaData,YES, +Internal,,GET,Get-DattoMetaData,YES, Reporting,/report/activity-log,GET,Get-DattoActivityLog,YES, SaaS,/sass/{sassCustomerId}/applications,GET,Get-DattoApplication,YES, SaaS,/sass/domains,GET,Get-DattoDomain,YES, diff --git a/docs/TrackingCSV.md b/docs/TrackingCSV.md index c89d3df..f8d5f3e 100644 --- a/docs/TrackingCSV.md +++ b/docs/TrackingCSV.md @@ -30,18 +30,18 @@ I recommend downloading the CSV from the link provided rather then viewing the t |BCDR |/bcdr/device/{serialNumber}/asset/{volumeName}|GET |Get-DattoVolume |YES | | |Internal | |POST |Add-DattoAPIKey |YES | | |Internal | |POST |Add-DattoBaseURI |YES | | -|Internal | |PUT |ConvertTo-QueryString |YES | | +|Internal | |PUT |ConvertTo-DattoQueryString |YES | | |Internal | |GET |Export-DattoModuleSettings|YES | | |Internal | |GET |Get-DattoAPIKey |YES | | |Internal | |GET |Get-DattoBaseURI |YES | | |Internal | |GET |Get-DattoModuleSettings |YES | | |Internal | |GET |Import-DattoModuleSettings|YES | | -|Internal | |GET |Invoke-APIRequest |YES | | +|Internal | |GET |Invoke-DattoRequest |YES | | |Internal | |DELETE|Remove-DattoAPIKey |YES | | |Internal | |DELETE|Remove-DattoBaseURI |YES | | |Internal | |DELETE|Remove-DattoModuleSettings|YES | | |Internal | |GET |Test-DattoAPIKey |YES | | -|Internal | |GET |Get-InvokeMetaData |YES | | +|Internal | |GET |Get-DattoMetaData |YES | | |Reporting|/report/activity-log |GET |Get-DattoActivityLog |YES | | |SaaS |/sass/{sassCustomerId}/applications |GET |Get-DattoApplication |YES | | |SaaS |/sass/domains |GET |Get-DattoDomain |YES | | diff --git a/docs/cab/DattoAPI_d536355d-2a81-444f-9e08-9eeeda6db819_en-US_HelpContent.cab b/docs/cab/DattoAPI_d536355d-2a81-444f-9e08-9eeeda6db819_en-US_HelpContent.cab index 4c22daf..4eaed72 100644 Binary files a/docs/cab/DattoAPI_d536355d-2a81-444f-9e08-9eeeda6db819_en-US_HelpContent.cab and b/docs/cab/DattoAPI_d536355d-2a81-444f-9e08-9eeeda6db819_en-US_HelpContent.cab differ diff --git a/docs/cab/DattoAPI_d536355d-2a81-444f-9e08-9eeeda6db819_en-US_HelpContent.zip b/docs/cab/DattoAPI_d536355d-2a81-444f-9e08-9eeeda6db819_en-US_HelpContent.zip index 51cb242..be275fe 100644 Binary files a/docs/cab/DattoAPI_d536355d-2a81-444f-9e08-9eeeda6db819_en-US_HelpContent.zip and b/docs/cab/DattoAPI_d536355d-2a81-444f-9e08-9eeeda6db819_en-US_HelpContent.zip differ diff --git a/docs/en-US/DattoAPI-help.xml b/docs/en-US/DattoAPI-help.xml index 3d80731..fdbbd11 100644 --- a/docs/en-US/DattoAPI-help.xml +++ b/docs/en-US/DattoAPI-help.xml @@ -1904,20 +1904,20 @@ - ConvertTo-QueryString + ConvertTo-DattoQueryString ConvertTo - QueryString + DattoQueryString Converts uri filter parameters - The Invoke-ApiRequest cmdlet converts & formats uri filter parameters from a function which are later used to make the full resource uri for an API call - This is an internal helper function the ties in directly with the Invoke-ApiRequest & any public functions that define parameters + The Invoke-DattoRequest cmdlet converts & formats uri filter parameters from a function which are later used to make the full resource uri for an API call + This is an internal helper function the ties in directly with the Invoke-DattoRequest & any public functions that define parameters - ConvertTo-QueryString + ConvertTo-DattoQueryString uri_Filter @@ -1982,7 +1982,7 @@ -------------------------- EXAMPLE 1 -------------------------- - ConvertTo-QueryString -uri_Filter $uri_Filter -resource_Uri '/account' + ConvertTo-DattoQueryString -uri_Filter $uri_Filter -resource_Uri '/account' Example: (From public function) $uri_Filter = @{} ForEach ( $Key in $PSBoundParameters.GetEnumerator() ){ if( $excludedParameters -contains $Key.Key ){$null} else{ $uri_Filter += @{ $Key.Key = $Key.Value } } } @@ -1992,8 +1992,8 @@ - https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/ConvertTo-QueryString.html - https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/ConvertTo-QueryString.html + https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/ConvertTo-DattoQueryString.html + https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/ConvertTo-DattoQueryString.html @@ -2212,6 +2212,83 @@ + + + Get-DattoMetaData + Get + DattoMetaData + + Gets various Api metadata values + + + + The Get-DattoMetaData cmdlet gets various Api metadata values from an Invoke-WebRequest to assist in various troubleshooting scenarios such as rate-limiting. + + + + Get-DattoMetaData + + base_uri + + Define the base URI for the Datto API connection using Datto's URI or a custom URI. + The default base URI is https://api.datto.com/v1 + + String + + String + + + $Datto_Base_URI + + + + + + base_uri + + Define the base URI for the Datto API connection using Datto's URI or a custom URI. + The default base URI is https://api.datto.com/v1 + + String + + String + + + $Datto_Base_URI + + + + + + + N\A + + + + + -------------------------- EXAMPLE 1 -------------------------- + Get-DattoMetaData + + Gets various Api metadata values from an Invoke-WebRequest to assist in various troubleshooting scenarios such as rate-limiting. + The default full base uri test path is: https://api.datto.com/v1 + + + + -------------------------- EXAMPLE 2 -------------------------- + Get-DattoMetaData -base_uri http://myapi.gateway.example.com + + Gets various Api metadata values from an Invoke-WebRequest to assist in various troubleshooting scenarios such as rate-limiting. + The full base uri test path in this example is: http://myapi.gateway.example.com/device + + + + + + https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Get-DattoMetaData.html + https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Get-DattoMetaData.html + + + Get-DattoModuleSettings @@ -2342,83 +2419,6 @@ - - - Get-InvokeMetaData - Get - InvokeMetaData - - Gets various Api metadata values - - - - The Get-InvokeMetaData cmdlet gets various Api metadata values from an Invoke-WebRequest to assist in various troubleshooting scenarios such as rate-limiting. - - - - Get-InvokeMetaData - - base_uri - - Define the base URI for the Datto API connection using Datto's URI or a custom URI. - The default base URI is https://api.datto.com/v1 - - String - - String - - - $Datto_Base_URI - - - - - - base_uri - - Define the base URI for the Datto API connection using Datto's URI or a custom URI. - The default base URI is https://api.datto.com/v1 - - String - - String - - - $Datto_Base_URI - - - - - - - N\A - - - - - -------------------------- EXAMPLE 1 -------------------------- - Get-InvokeMetaData - - Gets various Api metadata values from an Invoke-WebRequest to assist in various troubleshooting scenarios such as rate-limiting. - The default full base uri test path is: https://api.datto.com/v1 - - - - -------------------------- EXAMPLE 2 -------------------------- - Get-InvokeMetaData -base_uri http://myapi.gateway.example.com - - Gets various Api metadata values from an Invoke-WebRequest to assist in various troubleshooting scenarios such as rate-limiting. - The full base uri test path in this example is: http://myapi.gateway.example.com/device - - - - - - https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Get-InvokeMetaData.html - https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Get-InvokeMetaData.html - - - Import-DattoModuleSettings @@ -2525,21 +2525,21 @@ - Invoke-ApiRequest + Invoke-DattoRequest Invoke - ApiRequest + DattoRequest Makes an API request - The Invoke-ApiRequest cmdlet invokes an API request to Datto API. + The Invoke-DattoRequest cmdlet invokes an API request to Datto API. This is an internal function that is used by all public functions As of 2023-08 the Datto v1 API only supports GET requests - Invoke-ApiRequest + Invoke-DattoRequest method @@ -2568,9 +2568,9 @@ uri_Filter - Used with the internal function [ ConvertTo-QueryString ] to combine a functions parameters with the resource_Uri parameter. + Used with the internal function [ ConvertTo-DattoQueryString ] to combine a functions parameters with the resource_Uri parameter. This allows for the full uri query to occur - The full resource path is made with the following data $Datto_Base_URI + $resource_Uri + ConvertTo-QueryString + The full resource path is made with the following data $Datto_Base_URI + $resource_Uri + ConvertTo-DattoQueryString Hashtable @@ -2634,9 +2634,9 @@ uri_Filter - Used with the internal function [ ConvertTo-QueryString ] to combine a functions parameters with the resource_Uri parameter. + Used with the internal function [ ConvertTo-DattoQueryString ] to combine a functions parameters with the resource_Uri parameter. This allows for the full uri query to occur - The full resource path is made with the following data $Datto_Base_URI + $resource_Uri + ConvertTo-QueryString + The full resource path is made with the following data $Datto_Base_URI + $resource_Uri + ConvertTo-DattoQueryString Hashtable @@ -2681,7 +2681,7 @@ -------------------------- EXAMPLE 1 -------------------------- - Invoke-ApiRequest -method GET -resource_Uri '/account' -uri_Filter $uri_Filter + Invoke-DattoRequest -method GET -resource_Uri '/account' -uri_Filter $uri_Filter Invoke a rest method against the defined resource using any of the provided parameters Example: Name Value ---- ----- Method GET Uri https://api.datto.com/v1/account?accountId=12345&details=True Headers {Authorization = Bearer 123456789} Body @@ -2690,8 +2690,8 @@ - https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Invoke-ApiRequest.html - https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Invoke-ApiRequest.html + https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Invoke-DattoRequest.html + https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Invoke-DattoRequest.html diff --git a/docs/site/Internal/ConvertTo-QueryString.md b/docs/site/Internal/ConvertTo-DattoQueryString.md similarity index 77% rename from docs/site/Internal/ConvertTo-QueryString.md rename to docs/site/Internal/ConvertTo-DattoQueryString.md index 6f3be93..98b505d 100644 --- a/docs/site/Internal/ConvertTo-QueryString.md +++ b/docs/site/Internal/ConvertTo-DattoQueryString.md @@ -2,13 +2,13 @@ external help file: DattoAPI-help.xml grand_parent: Internal Module Name: DattoAPI -online version: https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/ConvertTo-QueryString.html +online version: https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/ConvertTo-DattoQueryString.html parent: PUT schema: 2.0.0 -title: ConvertTo-QueryString +title: ConvertTo-DattoQueryString --- -# ConvertTo-QueryString +# ConvertTo-DattoQueryString ## SYNOPSIS Converts uri filter parameters @@ -16,22 +16,22 @@ Converts uri filter parameters ## SYNTAX ```powershell -ConvertTo-QueryString [-uri_Filter] [-resource_Uri] [] +ConvertTo-DattoQueryString [-uri_Filter] [-resource_Uri] [] ``` ## DESCRIPTION -The Invoke-ApiRequest cmdlet converts & formats uri filter parameters +The Invoke-DattoRequest cmdlet converts & formats uri filter parameters from a function which are later used to make the full resource uri for an API call This is an internal helper function the ties in directly with the -Invoke-ApiRequest & any public functions that define parameters +Invoke-DattoRequest & any public functions that define parameters ## EXAMPLES ### EXAMPLE 1 ```powershell -ConvertTo-QueryString -uri_Filter $uri_Filter -resource_Uri '/account' +ConvertTo-DattoQueryString -uri_Filter $uri_Filter -resource_Uri '/account' ``` Example: (From public function) @@ -92,5 +92,5 @@ N\A ## RELATED LINKS -[https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/ConvertTo-QueryString.html](https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/ConvertTo-QueryString.html) +[https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/ConvertTo-DattoQueryString.html](https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/ConvertTo-DattoQueryString.html) diff --git a/docs/site/Internal/Get-InvokeMetaData.md b/docs/site/Internal/Get-DattoMetaData.md similarity index 79% rename from docs/site/Internal/Get-InvokeMetaData.md rename to docs/site/Internal/Get-DattoMetaData.md index 156fa64..2890036 100644 --- a/docs/site/Internal/Get-InvokeMetaData.md +++ b/docs/site/Internal/Get-DattoMetaData.md @@ -2,13 +2,13 @@ external help file: DattoAPI-help.xml grand_parent: Internal Module Name: DattoAPI -online version: https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Get-InvokeMetaData.html +online version: https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Get-DattoMetaData.html parent: GET schema: 2.0.0 -title: Get-InvokeMetaData +title: Get-DattoMetaData --- -# Get-InvokeMetaData +# Get-DattoMetaData ## SYNOPSIS Gets various Api metadata values @@ -16,11 +16,11 @@ Gets various Api metadata values ## SYNTAX ```powershell -Get-InvokeMetaData [[-base_uri] ] [] +Get-DattoMetaData [[-base_uri] ] [] ``` ## DESCRIPTION -The Get-InvokeMetaData cmdlet gets various Api metadata values from an +The Get-DattoMetaData cmdlet gets various Api metadata values from an Invoke-WebRequest to assist in various troubleshooting scenarios such as rate-limiting. @@ -28,7 +28,7 @@ as rate-limiting. ### EXAMPLE 1 ```powershell -Get-InvokeMetaData +Get-DattoMetaData ``` Gets various Api metadata values from an Invoke-WebRequest to assist @@ -39,7 +39,7 @@ The default full base uri test path is: ### EXAMPLE 2 ```powershell -Get-InvokeMetaData -base_uri http://myapi.gateway.example.com +Get-DattoMetaData -base_uri http://myapi.gateway.example.com ``` Gets various Api metadata values from an Invoke-WebRequest to assist @@ -79,5 +79,5 @@ N\A ## RELATED LINKS -[https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Get-InvokeMetaData.html](https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Get-InvokeMetaData.html) +[https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Get-DattoMetaData.html](https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Get-DattoMetaData.html) diff --git a/docs/site/Internal/Invoke-ApiRequest.md b/docs/site/Internal/Invoke-DattoRequest.md similarity index 82% rename from docs/site/Internal/Invoke-ApiRequest.md rename to docs/site/Internal/Invoke-DattoRequest.md index ce5e396..785de1c 100644 --- a/docs/site/Internal/Invoke-ApiRequest.md +++ b/docs/site/Internal/Invoke-DattoRequest.md @@ -2,13 +2,13 @@ external help file: DattoAPI-help.xml grand_parent: Internal Module Name: DattoAPI -online version: https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Invoke-ApiRequest.html +online version: https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Invoke-DattoRequest.html parent: GET schema: 2.0.0 -title: Invoke-ApiRequest +title: Invoke-DattoRequest --- -# Invoke-ApiRequest +# Invoke-DattoRequest ## SYNOPSIS Makes an API request @@ -16,12 +16,12 @@ Makes an API request ## SYNTAX ```powershell -Invoke-ApiRequest [[-method] ] [-resource_Uri] [[-uri_Filter] ] +Invoke-DattoRequest [[-method] ] [-resource_Uri] [[-uri_Filter] ] [[-data] ] [-allPages] [] ``` ## DESCRIPTION -The Invoke-ApiRequest cmdlet invokes an API request to Datto API. +The Invoke-DattoRequest cmdlet invokes an API request to Datto API. This is an internal function that is used by all public functions @@ -31,7 +31,7 @@ As of 2023-08 the Datto v1 API only supports GET requests ### EXAMPLE 1 ```powershell -Invoke-ApiRequest -method GET -resource_Uri '/account' -uri_Filter $uri_Filter +Invoke-DattoRequest -method GET -resource_Uri '/account' -uri_Filter $uri_Filter ``` Invoke a rest method against the defined resource using any of the provided parameters @@ -80,13 +80,13 @@ Accept wildcard characters: False ``` ### -uri_Filter -Used with the internal function \[ ConvertTo-QueryString \] to combine +Used with the internal function \[ ConvertTo-DattoQueryString \] to combine a functions parameters with the resource_Uri parameter. This allows for the full uri query to occur The full resource path is made with the following data -$Datto_Base_URI + $resource_Uri + ConvertTo-QueryString +$Datto_Base_URI + $resource_Uri + ConvertTo-DattoQueryString ```yaml Type: Hashtable @@ -146,5 +146,5 @@ N\A ## RELATED LINKS -[https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Invoke-ApiRequest.html](https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Invoke-ApiRequest.html) +[https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Invoke-DattoRequest.html](https://celerium.github.io/Datto-PowerShellWrapper/site/Internal/Invoke-DattoRequest.html)