DeeplTranslate

1.4.0

Public/Get-DeeplGlossaryDetail.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 <#PSScriptInfo
 
.VERSION 1.1.0
 
.GUID 4cdcfd9f-4923-456a-a4cd-091a658fcd11
 
.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
 
    1.0.1
    Fixed issue with empty Uri in verbose output.
 
    1.1.0
    Updated way to get DeepL Api Uri and Http Status codes.
 
#>


<#
 
.DESCRIPTION
    Contains a function to retrieve a glossary and its 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-DeeplGlossaryDetail {
    <#
    .SYNOPSIS
        Retrieves a glossary and its meta-information, but not the glossary entries.
 
    .DESCRIPTION
        The 'Get-DeeplGlossaryDetail' function retrieves a glossary and its 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.
 
    .PARAMETER GlossaryId
        The glossary id for which you want to retrieve information.
 
    .EXAMPLE
        Get-DeeplGlossaryDetail -ApiKey "<MyApiKey>" -GlossaryId 46fd68a5-63cc-42b2-86f0-5b84bfd4bbd3
 
        glossary_id : 46fd68a5-63cc-42b2-86f0-5b84bfd4bbd3
        name : My Glossary
        ready : True
        source_lang : en
        target_lang : de
        creation_time : 29.10.2022 21:06:35
        entry_count : 1
 
        This example shows how to retrieve details for a glossary.
 
    .EXAMPLE
        "46fd68a5-63cc-42b2-86f0-5b84bfd4bbd3", "66d06460-29b5-46c4-b822-c2c7c1494088" | Get-DeeplGlossaryDetail -Verbose -ApiKey "<MyApiKey>"
 
        glossary_id : 46fd68a5-63cc-42b2-86f0-5b84bfd4bbd3
        name : My Glossary
        ready : True
        source_lang : en
        target_lang : de
        creation_time : 29.10.2022 21:06:35
        entry_count : 1
 
        glossary_id : 66d06460-29b5-46c4-b822-c2c7c1494088
        name : MyGlossary
        ready : True
        source_lang : en
        target_lang : de
        creation_time : 01.11.2022 18:31:05
        entry_count : 1
 
        This example shows how to retrieve glossary details for two glossaries via pipline input.
 
    .INPUTS
        System.Guid for parameter 'GlossaryID'
 
    .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-DeeplGlossaryDetail.txt
 
    #>

    [CmdletBinding()]
    param (
        [Parameter(Mandatory)]
        [ValidateNotNullOrEmpty()]
        [string]
        $ApiKey,

        [Parameter(Mandatory, ValueFromPipeline)]
        [ValidateNotNullOrEmpty()]
        [System.Guid[]]
        $GlossaryId
    )

    process {
        foreach ($GlossaryIdItem in $GlossaryId) {
            $BaseUri = Get-DeeplApiUri -ApiKey $ApiKey

            try {
                # Set the authorization header.
                $Headers = @{ Authorization = "DeepL-Auth-Key $ApiKey" }

                # Set parameters for the Invoke-RestMethod cmdlet.
                $Params = @{
                    Method  = 'GET'
                    Uri     = "$BaseUri/glossaries/$GlossaryIdItem"
                    Headers = $Headers
                }

                # Try to retrieve the details for the given glossary id.
                Write-Verbose -Message "Calling Uri: $($Params.Uri)"
                $Glossary = Invoke-RestMethod @Params
                $Glossary
            }
            catch [Microsoft.PowerShell.Commands.HttpResponseException] {
                $ErrorMessage = Get-DeeplStatusCode -StatusCode $_.Exception.Response.StatusCode
                if ($null -ne $ErrorMessage) {
                    Write-Error -Message $ErrorMessage
                }
                else {
                    Write-Error -Message "Http Status Code: $_"
                }
            }
            catch {
                Write-Verbose -Message "An unknown error occured."
                $_
            }
        }
    }
}


#region EndOfScript
<#
################################################################################
################################################################################
#
# ______ _ __ _____ _ _
# | ____| | | / _| / ____| (_) | |
# | |__ _ __ __| | ___ | |_ | (___ ___ _ __ _ _ __ | |_
# | __| | '_ \ / _` | / _ \| _| \___ \ / __| '__| | '_ \| __|
# | |____| | | | (_| | | (_) | | ____) | (__| | | | |_) | |_
# |______|_| |_|\__,_| \___/|_| |_____/ \___|_| |_| .__/ \__|
# | |
# |_|
################################################################################
################################################################################
# created with help of http://patorjk.com/software/taag/
#>
#endregion