Merge pull request #36 from Readify/api-token

Rename `ApiKey` to `ApiToken` to match the terminology Zendesk doco uses
Readify · Mar 22, 2020 · d37ce8d · d37ce8d
2 parents 92c01a9 + daa722b
commit d37ce8d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/functions/Connect-.ps1 b/functions/Connect-.ps1
@@ -25,11 +25,12 @@ function Connect- {
         [String]
         $Username,
 
-        # Zendesk API key retrieved from https://<organization>.zendesk.com/agent/admin/api/settings
+        # Zendesk API token retrieved from https://<organization>.zendesk.com/agent/admin/api/settings
         [Parameter(Mandatory = $true)]
+        [Alias('ApiKey')]
         [ValidateNotNullOrEmpty()]
         [SecureString]
-        $ApiKey
+        $ApiToken
     )
 
     $Script:Context = Get-Connection @PSBoundParameters

diff --git a/functions/Get-Connection.ps1 b/functions/Get-Connection.ps1
@@ -25,17 +25,18 @@ function Get-Connection {
         [String]
         $Username,
 
-        # Zendesk API key retrieved from https://<organization>.zendesk.com/agent/admin/api/settings
+        # Zendesk API token retrieved from https://<organization>.zendesk.com/agent/admin/api/settings
         [Parameter(Mandatory = $true)]
+        [Alias('ApiKey')]
         [ValidateNotNullOrEmpty()]
         [SecureString]
-        $ApiKey
+        $ApiToken
     )
 
     $context = [PSCustomObject]@{
         Organization = $Organization
         BaseUrl      = "https://$Organization.zendesk.com"
-        Credential   = [System.Management.Automation.PSCredential]::New("$Username/token", $ApiKey)
+        Credential   = [System.Management.Automation.PSCredential]::New("$Username/token", $ApiToken)
         User         = $null
     }