Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API Updates: new endpoints (concordance, alignment) #137

Merged
merged 1 commit into from
May 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 19 additions & 0 deletions src/Crowdin.Api/Glossaries/ConcordanceSearchRequest.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

using JetBrains.Annotations;
using Newtonsoft.Json;

namespace Crowdin.Api.Glossaries
{
[PublicAPI]
public class ConcordanceSearchRequest
{
[JsonProperty("sourceLanguageId")]
public string SourceLanguageId { get; set; }

[JsonProperty("targetLanguageId")]
public string TargetLanguageId { get; set; }

[JsonProperty("expression")]
public string Expression { get; set; }
}
}
15 changes: 15 additions & 0 deletions src/Crowdin.Api/Glossaries/GlossariesApiExecutor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,21 @@ public async Task<Glossary> EditGlossary(int glossaryId, IEnumerable<GlossaryPat
return _jsonParser.ParseResponseObject<Glossary>(result.JsonObject);
}

/// <summary>
/// Concordance search in Glossaries. Documentation:
/// <a href="https://developer.crowdin.com/api/v2/#operation/api.projects.glossaries.concordance.post">Crowdin API</a>
/// <a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.glossaries.concordance.post">Crowdin Enterprise API</a>
/// </summary>
[PublicAPI]
public async Task<ResponseList<GlossaryConcordanceResultResource>> ConcordanceSearch(
int projectId,
ConcordanceSearchRequest request)
{
var url = $"/projects/{projectId}/glossaries/concordance";
CrowdinApiResult result = await _apiClient.SendPostRequest(url, request);
return _jsonParser.ParseResponseList<GlossaryConcordanceResultResource>(result.JsonObject);
}

#endregion

#region Glossaries : Export
Expand Down
22 changes: 22 additions & 0 deletions src/Crowdin.Api/Glossaries/GlossaryConcordanceResultResource.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@

using JetBrains.Annotations;
using Newtonsoft.Json;

namespace Crowdin.Api.Glossaries
{
[PublicAPI]
public class GlossaryConcordanceResultResource
{
[JsonProperty("glossary")]
public Glossary Glossary { get; set; }

[JsonProperty("concept")]
public Concept Concept { get; set; }

[JsonProperty("sourceTerms")]
public Term[] SourceTerms { get; set; }

[JsonProperty("targetTerms")]
public Term[] TargetTerms { get; set; }
}
}
28 changes: 28 additions & 0 deletions src/Crowdin.Api/StringTranslations/Alignment.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@

using JetBrains.Annotations;
using Newtonsoft.Json;

namespace Crowdin.Api.StringTranslations
{
[PublicAPI]
public class Alignment
{
[JsonProperty("sourceWord")]
public string SourceWord { get; set; }

[JsonProperty("sourceLemma")]
public string SourceLemma { get; set; }

[JsonProperty("targetWord")]
public string TargetWord { get; set; }

[JsonProperty("targetLemma")]
public string TargetLemma { get; set; }

[JsonProperty("match")]
public int Match { get; set; }

[JsonProperty("probability")]
public float Probability { get; set; }
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,19 @@ private static string FormUrl_ApprovalId(int projectId, int approvalId)

#region Translations

/// <summary>
/// Translation Alignment. Documentation:
/// <a href="https://developer.crowdin.com/api/v2/#operation/api.projects.translations.alignment.post">Crowdin API</a>
/// <a href="https://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.translations.alignment.post">Crowdin Enterprise API</a>
/// </summary>
[PublicAPI]
public async Task<TranslationAlignment> TranslationAlignment(int projectId, TranslationAlignmentRequest request)
{
var url = $"/projects/{projectId}/translations/alignment";
CrowdinApiResult result = await _apiClient.SendPostRequest(url, request);
return _jsonParser.ParseResponseObject<TranslationAlignment>(result.JsonObject);
}

/// <summary>
/// List string translations. Documentation:
/// <a href="https://support.crowdin.com/api/v2/#operation/api.projects.translations.getMany">Crowdin API</a>
Expand Down
13 changes: 13 additions & 0 deletions src/Crowdin.Api/StringTranslations/TranslationAlignment.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

using JetBrains.Annotations;
using Newtonsoft.Json;

namespace Crowdin.Api.StringTranslations
{
[PublicAPI]
public class TranslationAlignment
{
[JsonProperty("words")]
public WordAlignment[] Words { get; set; }
}
}
19 changes: 19 additions & 0 deletions src/Crowdin.Api/StringTranslations/TranslationAlignmentRequest.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@

using JetBrains.Annotations;
using Newtonsoft.Json;

namespace Crowdin.Api.StringTranslations
{
[PublicAPI]
public class TranslationAlignmentRequest
{
[JsonProperty("sourceLanguageId")]
public string SourceLanguageId { get; set; }

[JsonProperty("targetLanguageId")]
public string TargetLanguageId { get; set; }

[JsonProperty("text")]
public string Text { get; set; }
}
}
16 changes: 16 additions & 0 deletions src/Crowdin.Api/StringTranslations/WordAlignment.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

using JetBrains.Annotations;
using Newtonsoft.Json;

namespace Crowdin.Api.StringTranslations
{
[PublicAPI]
public class WordAlignment
{
[JsonProperty("text")]
public string Text { get; set; }

[JsonProperty("alignments")]
public Alignment[] Alignments { get; set; }
}
}
25 changes: 25 additions & 0 deletions src/Crowdin.Api/TranslationMemory/ConcordanceSearchRequest.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@

using JetBrains.Annotations;
using Newtonsoft.Json;

namespace Crowdin.Api.TranslationMemory
{
[PublicAPI]
public class ConcordanceSearchRequest
{
[JsonProperty("sourceLanguageId")]
public string SourceLanguageId { get; set; }

[JsonProperty("targetLanguageId")]
public string TargetLanguageId { get; set; }

[JsonProperty("autoSubstitution")]
public bool AutoSubstitution { get; set; }

[JsonProperty("minRelevant")]
public int MinRelevant { get; set; }

[JsonProperty("expression")]
public string Expression { get; set; }
}
}
32 changes: 32 additions & 0 deletions src/Crowdin.Api/TranslationMemory/TmConcordanceResultResource.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@

using System;
using JetBrains.Annotations;
using Newtonsoft.Json;

namespace Crowdin.Api.TranslationMemory
{
[PublicAPI]
public class TmConcordanceResultResource
{
[JsonProperty("tm")]
public TranslationMemory Tm { get; set; }

[JsonProperty("recordId")]
public int RecordId { get; set; }

[JsonProperty("source")]
public string Source { get; set; }

[JsonProperty("target")]
public string Target { get; set; }

[JsonProperty("relevant")]
public int Relevant { get; set; }

[JsonProperty("substituted")]
public string Substituted { get; set; }

[JsonProperty("updatedAt")]
public DateTimeOffset UpdatedAt { get; set; }
}
}
15 changes: 15 additions & 0 deletions src/Crowdin.Api/TranslationMemory/TranslationMemoryApiExecutor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,21 @@ public async Task<DownloadLink> DownloadTm(int tmId, string exportId)
return _jsonParser.ParseResponseObject<DownloadLink>(result.JsonObject);
}

/// <summary>
/// Concordance search in TMs. Documentation:
/// <a href="https://developer.crowdin.com/api/v2/#operation/api.projects.tms.concordance.post">Crowdin API</a>
/// <a href="hhttps://developer.crowdin.com/enterprise/api/v2/#operation/api.projects.tms.concordance.post">Crowdin Enterprise API</a>
/// </summary>
[PublicAPI]
public async Task<ResponseList<TmConcordanceResultResource>> ConcordanceSearch(
int projectId,
ConcordanceSearchRequest request)
{
var url = $"/projects/{projectId}/tms/concordance";
CrowdinApiResult result = await _apiClient.SendPostRequest(url, request);
return _jsonParser.ParseResponseList<TmConcordanceResultResource>(result.JsonObject);
}

/// <summary>
/// Import TM. Documentation:
/// <a href="https://support.crowdin.com/api/v2/#operation/api.tms.imports.post">Crowdin API</a>
Expand Down
46 changes: 45 additions & 1 deletion tests/Crowdin.Api.Tests/Core/Resources/Glossaries.Designer.cs

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.