Public/Get-DeeplGlossary.ps1
|
<#PSScriptInfo
.VERSION 1.0.0 .GUID 24ec36da-f272-484c-a80a-2006aedcc016 .AUTHOR diko@admins-little-helper.de .COMPANYNAME .COPYRIGHT (c) 2022 All rights reserved. .TAGS DeepL Translate Translation .LICENSEURI https://github.com/admins-little-helper/DeeplTranslate/blob/main/LICENSE .PROJECTURI https://github.com/admins-little-helper/DeeplTranslate .ICONURI .EXTERNALMODULEDEPENDENCIES .REQUIREDSCRIPTS .EXTERNALSCRIPTDEPENDENCIES .RELEASENOTES 1.0.0 Initial release #> <# .DESCRIPTION Contains a function to retrieve all glossaries and their meta-information, but not the glossary entries for a DeepL account. More information about the DeepL API can be found here: https://www.deepl.com/de/docs-api/introduction/. To use this PowerShell function, a DeepL ApiKey is needed which requires an account. To register for an account, go to www.deepl.com. .LINK https://github.com/admins-little-helper/DeeplTranslate .LINK https://www.deepl.com .LINK https://www.deepl.com/de/docs-api/introduction/ #> function Get-DeeplGlossary { <# .SYNOPSIS Retrieves all glossaries and their meta-information, but not the glossary entries. .DESCRIPTION The 'Get-DeeplGlossary' function retrieves all glossaries and their meta-information, but not the glossary entries. .PARAMETER ApiKey API authentication key. You need an authentication key to access the DeepL API. Refer to the DeepL API documentation for more information. .EXAMPLE Get-DeeplGlossary -ApiKey "<MyApiKey>" glossary_id : f9a2a12f-9dec-4ca0-b9bd-cb3d9c645aed name : My Glossary ready : True source_lang : en target_lang : de creation_time : 31.10.2022 21:39:37 entry_count : 1 This example shows how to retrieve a list of all glossaries of a DeepL account. .EXAMPLE Get-DeeplGlossary -ApiKey "<MyApiKey>" | ft glossary_id name ready source_lang target_lang creation_time entry_count ----------- ---- ----- ----------- ----------- ------------- ----------- f9a2a12f-9dec-4ca0-b9bd-cb3d9c645aed My Glossary True en de 31.10.2022 21:39:37 1 f9077ca0-66ab-4a16-afaf-1ce332feab50 My Glossary True en de 31.10.2022 21:43:56 1 This example shows how to retrieve a list of glossaries and format the output as table. .INPUTS Nothing .OUTPUTS System.Management.Automation.PSCustomObject .NOTES Author: Dieter Koch Email: diko@admins-little-helper.de .LINK https://github.com/admins-little-helper/DeeplTranslate/blob/main/Help/Get-DeeplGlossary.txt #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [string] $ApiKey ) # Set the base URI to either the DeepL API Pro or DeepL API Free service depending on the ApiKey value specified. # DeepL API Free authentication keys can be identified easily by the suffix ":fx" (e.g., 279a2e9d-83b3-c416-7e2d-f721593e42a0:fx). # For more information refer to https://www.deepl.com/docs-api/api-access/authentication/. $BaseUri = if ($ApiKey -match "(:fx)$") { Write-Verbose -Message "The ApiKey specified ends with ':fx'. Using DeepL Api Free service URI." 'https://api-free.deepl.com/v2' } else { Write-Verbose -Message "The ApiKey specified does not end with ':fx'. Using DeepL Api Pro service URI." 'https://api.deepl.com/v2' } try { # Set the authorization header. $Headers = @{ Authorization = "DeepL-Auth-Key $ApiKey" } # Set parameters for the Invoke-RestMethod cmdlet. $Params = @{ Method = 'GET' Uri = "$BaseUri/glossaries" Headers = $Headers } # Try to retrieve the list of glossaries. Write-Verbose -Message "Calling Uri: $Uri" $Glossary = Invoke-RestMethod @Params # Return the result $Result = $Glossary.glossaries $Result } catch [Microsoft.PowerShell.Commands.HttpResponseException] { switch ( $_.Exception.Response.StatusCode ) { 400 { Write-Error -Message "Bad Request." } 401 { Write-Error -Message "Unauthorized." } 403 { Write-Error -Message "Authorization failed. Please supply a valid ApiKey." } 404 { Write-Error -Message "Not found." } 413 { Write-Error -Message "Payload too large." } 414 { Write-Error -Message "URI too long." } 429 { Write-Error -Message "Too many requests. Please wait and resend your request." } 429 { Write-Error -Message "Quota exceeded." } 500 { Write-Error -Message "Internal Server error." } 503 { Write-Error -Message "Resource currently unavailable. Try again later." } 504 { Write-Error -Message "Service unavailable." } 529 { Write-Error -Message "Too many requests. Please wait and resend your request." } default { $_ } } } catch { Write-Verbose -Message "An unknown error occured." $_ } } #region EndOfScript <# ################################################################################ ################################################################################ # # ______ _ __ _____ _ _ # | ____| | | / _| / ____| (_) | | # | |__ _ __ __| | ___ | |_ | (___ ___ _ __ _ _ __ | |_ # | __| | '_ \ / _` | / _ \| _| \___ \ / __| '__| | '_ \| __| # | |____| | | | (_| | | (_) | | ____) | (__| | | | |_) | |_ # |______|_| |_|\__,_| \___/|_| |_____/ \___|_| |_| .__/ \__| # | | # |_| ################################################################################ ################################################################################ # created with help of http://patorjk.com/software/taag/ #> #endregion |