phrase

package module
v2.27.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 22, 2024 License: MIT Imports: 24 Imported by: 1

README ¶

Go API client for phrase

Phrase Strings is a translation management platform for software projects. You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase Strings for your account.

Installation

go get github.com/phrase/phrase-go

Getting Started

package main

import (
	"context"
	"fmt"

	phrase "github.com/phrase/phrase-go/v2"
)

func main() {
	auth := context.WithValue(context.Background(), phrase.ContextAPIKey, phrase.APIKey{
		Key:    "YOUR_API_TOKEN",
		Prefix: "token",
	})

	cfg := phrase.NewConfiguration()
	client := phrase.NewAPIClient(cfg)

	var projectsListOpts phrase.ProjectsListOpts

	projects, apiResponse, err := client.ProjectsApi.ProjectsList(auth, &projectsListOpts)
	if err != nil {
		fmt.Println(err)
	} else {
		fmt.Printf("%+v\n", projects)
		fmt.Printf("%+v\n", apiResponse) // &{Response:0xc00011ccf0 NextPage:2 FirstPage:1 LastPage:4 Rate:{Limit:1000 Remaining:998 Reset:2020-04-25 00:35:00 +0200 CEST}}
	}
}

Datacenters

The API is only accessible via HTTPS and the current version is v2, which results in a base URL like: https://api.phrase.com/v2 depending on the datacenter.

EU Datacenter
https://api.phrase.com/v2

This is the default datacenter.

US Datacenter
https://api.us.app.phrase.com/v2/
Specifying US Datacenter

You can use the US datacenter by setting the following:

client.ChangeBasePath("https://api.us.app.phrase.com/v2/")

Documentation for API Endpoints

All URIs are relative to https://api.phrase.com/v2

Class Method HTTP request Description
AccountsApi AccountShow Get /accounts/{id} Get a single account
AccountsApi AccountsList Get /accounts List accounts
AuthorizationsApi AuthorizationCreate Post /authorizations Create an authorization
AuthorizationsApi AuthorizationDelete Delete /authorizations/{id} Delete an authorization
AuthorizationsApi AuthorizationShow Get /authorizations/{id} Get a single authorization
AuthorizationsApi AuthorizationUpdate Patch /authorizations/{id} Update an authorization
AuthorizationsApi AuthorizationsList Get /authorizations List authorizations
BitbucketSyncApi BitbucketSyncExport Post /bitbucket_syncs/{id}/export Export from Phrase Strings to Bitbucket
BitbucketSyncApi BitbucketSyncImport Post /bitbucket_syncs/{id}/import Import to Phrase Strings from Bitbucket
BitbucketSyncApi BitbucketSyncsList Get /bitbucket_syncs List Bitbucket syncs
BlacklistedKeysApi BlacklistedKeyCreate Post /projects/{project_id}/blacklisted_keys Create a blocked key
BlacklistedKeysApi BlacklistedKeyDelete Delete /projects/{project_id}/blacklisted_keys/{id} Delete a blocked key
BlacklistedKeysApi BlacklistedKeyShow Get /projects/{project_id}/blacklisted_keys/{id} Get a single blocked key
BlacklistedKeysApi BlacklistedKeyUpdate Patch /projects/{project_id}/blacklisted_keys/{id} Update a blocked key
BlacklistedKeysApi BlacklistedKeysList Get /projects/{project_id}/blacklisted_keys List blocked keys
BranchesApi BranchCompare Get /projects/{project_id}/branches/{name}/compare Compare branches
BranchesApi BranchCreate Post /projects/{project_id}/branches Create a branch
BranchesApi BranchDelete Delete /projects/{project_id}/branches/{name} Delete a branch
BranchesApi BranchMerge Patch /projects/{project_id}/branches/{name}/merge Merge a branch
BranchesApi BranchShow Get /projects/{project_id}/branches/{name} Get a single branch
BranchesApi BranchUpdate Patch /projects/{project_id}/branches/{name} Update a branch
BranchesApi BranchesList Get /projects/{project_id}/branches List branches
CommentReactionsApi ReactionCreate Post /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions Create a reaction
CommentReactionsApi ReactionDelete Delete /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id} Delete a reaction
CommentReactionsApi ReactionShow Get /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions/{id} Get a single reaction
CommentReactionsApi ReactionsList Get /projects/{project_id}/keys/{key_id}/comments/{comment_id}/reactions List reactions
CommentRepliesApi RepliesList Get /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies List replies
CommentRepliesApi ReplyCreate Post /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies Create a reply
CommentRepliesApi ReplyDelete Delete /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id} Delete a reply
CommentRepliesApi ReplyMarkAsRead Patch /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_read Mark a reply as read
CommentRepliesApi ReplyMarkAsUnread Patch /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id}/mark_as_unread Mark a reply as unread
CommentRepliesApi ReplyShow Get /projects/{project_id}/keys/{key_id}/comments/{comment_id}/replies/{id} Get a single reply
CommentsApi CommentCreate Post /projects/{project_id}/keys/{key_id}/comments Create a comment
CommentsApi CommentDelete Delete /projects/{project_id}/keys/{key_id}/comments/{id} Delete a comment
CommentsApi CommentMarkCheck Get /projects/{project_id}/keys/{key_id}/comments/{id}/read Check if comment is read
CommentsApi CommentMarkRead Patch /projects/{project_id}/keys/{key_id}/comments/{id}/read Mark a comment as read
CommentsApi CommentMarkUnread Delete /projects/{project_id}/keys/{key_id}/comments/{id}/read Mark a comment as unread
CommentsApi CommentShow Get /projects/{project_id}/keys/{key_id}/comments/{id} Get a single comment
CommentsApi CommentUpdate Patch /projects/{project_id}/keys/{key_id}/comments/{id} Update a comment
CommentsApi CommentsList Get /projects/{project_id}/keys/{key_id}/comments List comments
CustomMetadataApi CustomMetadataPropertiesDelete Delete /accounts/{account_id}/custom_metadata/properties/{id} Destroy property
CustomMetadataApi CustomMetadataPropertiesList Get /accounts/{account_id}/custom_metadata/properties List properties
CustomMetadataApi CustomMetadataPropertyCreate Post /accounts/{account_id}/custom_metadata/properties Create a property
CustomMetadataApi CustomMetadataPropertyShow Get /accounts/{account_id}/custom_metadata/properties/{id} Get a single property
CustomMetadataApi CustomMetadataPropertyUpdate Patch /accounts/{account_id}/custom_metadata/properties/{id} Update a property
DistributionsApi DistributionCreate Post /accounts/{account_id}/distributions Create a distribution
DistributionsApi DistributionDelete Delete /accounts/{account_id}/distributions/{id} Delete a distribution
DistributionsApi DistributionShow Get /accounts/{account_id}/distributions/{id} Get a single distribution
DistributionsApi DistributionUpdate Patch /accounts/{account_id}/distributions/{id} Update a distribution
DistributionsApi DistributionsList Get /accounts/{account_id}/distributions List distributions
DocumentsApi DocumentDelete Delete /projects/{project_id}/documents/{id} Delete document
DocumentsApi DocumentsList Get /projects/{project_id}/documents List documents
FigmaAttachmentsApi FigmaAttachmentCreate Post /projects/{project_id}/figma_attachments Create a Figma attachment
FigmaAttachmentsApi FigmaAttachmentDelete Delete /projects/{project_id}/figma_attachments/{id} Delete a Figma attachment
FigmaAttachmentsApi FigmaAttachmentShow Get /projects/{project_id}/figma_attachments/{id} Get a single Figma attachment
FigmaAttachmentsApi FigmaAttachmentUpdate Patch /projects/{project_id}/figma_attachments/{id} Update a Figma attachment
FigmaAttachmentsApi FigmaAttachmentsList Get /projects/{project_id}/figma_attachments List Figma attachments
FormatsApi FormatsList Get /formats List formats
GitHubSyncApi GithubSyncExport Post /github_syncs/export Export from Phrase Strings to GitHub
GitHubSyncApi GithubSyncImport Post /github_syncs/import Import to Phrase Strings from GitHub
GitLabSyncApi GitlabSyncDelete Delete /gitlab_syncs/{id} Delete single Sync Setting
GitLabSyncApi GitlabSyncExport Post /gitlab_syncs/{gitlab_sync_id}/export Export from Phrase Strings to GitLab
GitLabSyncApi GitlabSyncHistory Get /gitlab_syncs/{gitlab_sync_id}/history History of single Sync Setting
GitLabSyncApi GitlabSyncImport Post /gitlab_syncs/{gitlab_sync_id}/import Import from GitLab to Phrase
GitLabSyncApi GitlabSyncList Get /gitlab_syncs List GitLab syncs
GitLabSyncApi GitlabSyncShow Get /gitlab_syncs/{id} Get single Sync Setting
GitLabSyncApi GitlabSyncUpdate Put /gitlab_syncs/{id} Update single Sync Setting
GlossariesApi GlossariesList Get /accounts/{account_id}/glossaries List term bases
GlossariesApi GlossaryCreate Post /accounts/{account_id}/glossaries Create a term base
GlossariesApi GlossaryDelete Delete /accounts/{account_id}/glossaries/{id} Delete a term base
GlossariesApi GlossaryShow Get /accounts/{account_id}/glossaries/{id} Get a single term base
GlossariesApi GlossaryUpdate Patch /accounts/{account_id}/glossaries/{id} Update a term base
GlossaryTermTranslationsApi GlossaryTermTranslationCreate Post /accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations Create a translation for a term
GlossaryTermTranslationsApi GlossaryTermTranslationDelete Delete /accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations/{id} Delete a translation for a term
GlossaryTermTranslationsApi GlossaryTermTranslationUpdate Patch /accounts/{account_id}/glossaries/{glossary_id}/terms/{term_id}/translations/{id} Update a translation for a term
GlossaryTermsApi GlossaryTermCreate Post /accounts/{account_id}/glossaries/{glossary_id}/terms Create a term
GlossaryTermsApi GlossaryTermDelete Delete /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} Delete a term
GlossaryTermsApi GlossaryTermShow Get /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} Get a single term
GlossaryTermsApi GlossaryTermUpdate Patch /accounts/{account_id}/glossaries/{glossary_id}/terms/{id} Update a term
GlossaryTermsApi GlossaryTermsList Get /accounts/{account_id}/glossaries/{glossary_id}/terms List terms
ICUApi IcuSkeleton Post /icu/skeleton Build icu skeletons
InvitationsApi InvitationCreate Post /accounts/{account_id}/invitations Create a new invitation
InvitationsApi InvitationDelete Delete /accounts/{account_id}/invitations/{id} Delete an invitation
InvitationsApi InvitationResend Post /accounts/{account_id}/invitations/{id}/resend Resend an invitation
InvitationsApi InvitationShow Get /accounts/{account_id}/invitations/{id} Get a single invitation
InvitationsApi InvitationUpdate Patch /accounts/{account_id}/invitations/{id} Update an invitation
InvitationsApi InvitationUpdateSettings Patch /projects/{project_id}/invitations/{id} Update a member's invitation access
InvitationsApi InvitationsList Get /accounts/{account_id}/invitations List invitations
JobCommentsApi JobCommentCreate Post /projects/{project_id}/jobs/{job_id}/comments Create a job comment
JobCommentsApi JobCommentDelete Delete /projects/{project_id}/jobs/{job_id}/comments/{id} Delete a job comment
JobCommentsApi JobCommentShow Get /projects/{project_id}/jobs/{job_id}/comments/{id} Get a single job comment
JobCommentsApi JobCommentUpdate Patch /projects/{project_id}/jobs/{job_id}/comments/{id} Update a job comment
JobCommentsApi JobCommentsList Get /projects/{project_id}/jobs/{job_id}/comments List job comments
JobLocalesApi JobLocaleComplete Post /projects/{project_id}/jobs/{job_id}/locales/{id}/complete Complete a job locale
JobLocalesApi JobLocaleCompleteReview Post /projects/{project_id}/jobs/{job_id}/locales/{id}/complete_review Review a job locale
JobLocalesApi JobLocaleDelete Delete /projects/{project_id}/jobs/{job_id}/locales/{id} Remove a target locale from a job
JobLocalesApi JobLocaleReopen Post /projects/{project_id}/jobs/{job_id}/locales/{id}/reopen Reopen a job locale
JobLocalesApi JobLocaleShow Get /projects/{project_id}/jobs/{job_id}/locales/{id} Show single job target locale
JobLocalesApi JobLocaleUpdate Patch /projects/{project_id}/jobs/{job_id}/locales/{id} Update a job target locale
JobLocalesApi JobLocalesCreate Post /projects/{project_id}/jobs/{job_id}/locales Add a target locale to a job
JobLocalesApi JobLocalesList Get /projects/{project_id}/jobs/{job_id}/locales List job target locales
JobTemplateLocalesApi JobTemplateLocaleDelete Delete /projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} Delete a job template locale
JobTemplateLocalesApi JobTemplateLocaleShow Get /projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} Get a single job template locale
JobTemplateLocalesApi JobTemplateLocaleUpdate Patch /projects/{project_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} Update a job template locale
JobTemplateLocalesApi JobTemplateLocalesCreate Post /projects/{project_id}/job_templates/{job_template_id}/locales Create a job template locale
JobTemplateLocalesApi JobTemplateLocalesList Get /projects/{project_id}/job_templates/{job_template_id}/locales List job template locales
JobTemplatesApi JobTemplateCreate Post /projects/{project_id}/job_templates Create a job template
JobTemplatesApi JobTemplateDelete Delete /projects/{project_id}/job_templates/{id} Delete a job template
JobTemplatesApi JobTemplateUpdate Patch /projects/{project_id}/job_templates/{id} Update a job template
JobTemplatesApi JobTemplatesList Get /projects/{project_id}/job_templates List job templates
JobTemplatesApi JobTemplatesShow Get /projects/{project_id}/job_templates/{id} Get a single job template
JobsApi JobComplete Post /projects/{project_id}/jobs/{id}/complete Complete a job
JobsApi JobCreate Post /projects/{project_id}/jobs Create a job
JobsApi JobDelete Delete /projects/{project_id}/jobs/{id} Delete a job
JobsApi JobKeysCreate Post /projects/{project_id}/jobs/{id}/keys Add keys to job
JobsApi JobKeysDelete Delete /projects/{project_id}/jobs/{id}/keys Remove keys from job
JobsApi JobLock Post /projects/{project_id}/jobs/{id}/lock Lock a job
JobsApi JobReopen Post /projects/{project_id}/jobs/{id}/reopen Reopen a job
JobsApi JobShow Get /projects/{project_id}/jobs/{id} Get a single job
JobsApi JobStart Post /projects/{project_id}/jobs/{id}/start Start a job
JobsApi JobUnlock Post /projects/{project_id}/jobs/{id}/unlock Unlock a job
JobsApi JobUpdate Patch /projects/{project_id}/jobs/{id} Update a job
JobsApi JobsByAccount Get /accounts/{account_id}/jobs List account jobs
JobsApi JobsList Get /projects/{project_id}/jobs List jobs
KeysApi KeyCreate Post /projects/{project_id}/keys Create a key
KeysApi KeyDelete Delete /projects/{project_id}/keys/{id} Delete a key
KeysApi KeyShow Get /projects/{project_id}/keys/{id} Get a single key
KeysApi KeyUpdate Patch /projects/{project_id}/keys/{id} Update a key
KeysApi KeysDeleteCollection Delete /projects/{project_id}/keys Delete collection of keys
KeysApi KeysExclude Patch /projects/{project_id}/keys/exclude Exclude a locale on a collection of keys
KeysApi KeysInclude Patch /projects/{project_id}/keys/include Include a locale on a collection of keys
KeysApi KeysList Get /projects/{project_id}/keys List keys
KeysApi KeysSearch Post /projects/{project_id}/keys/search Search keys
KeysApi KeysTag Patch /projects/{project_id}/keys/tag Add tags to collection of keys
KeysApi KeysUntag Patch /projects/{project_id}/keys/untag Remove tags from collection of keys
KeysFigmaAttachmentsApi FigmaAttachmentAttachToKey Post /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys Attach the Figma attachment to a key
KeysFigmaAttachmentsApi FigmaAttachmentDetachFromKey Delete /projects/{project_id}/figma_attachments/{figma_attachment_id}/keys/{id} Detach the Figma attachment from a key
LinkedKeysApi KeyLinksBatchDestroy Delete /projects/{project_id}/keys/{id}/key_links Batch unlink child keys from a parent key
LinkedKeysApi KeyLinksCreate Post /projects/{project_id}/keys/{id}/key_links Link child keys to a parent key
LinkedKeysApi KeyLinksDestroy Delete /projects/{project_id}/keys/{id}/key_links/{child_key_id} Unlink a child key from a parent key
LinkedKeysApi KeyLinksIndex Get /projects/{project_id}/keys/{id}/key_links Retrieve all child keys linked to a specific parent key
LocalesApi AccountLocales Get /accounts/{id}/locales List locales used in account
LocalesApi LocaleCreate Post /projects/{project_id}/locales Create a locale
LocalesApi LocaleDelete Delete /projects/{project_id}/locales/{id} Delete a locale
LocalesApi LocaleDownload Get /projects/{project_id}/locales/{id}/download Download a locale
LocalesApi LocaleShow Get /projects/{project_id}/locales/{id} Get a single locale
LocalesApi LocaleUpdate Patch /projects/{project_id}/locales/{id} Update a locale
LocalesApi LocalesList Get /projects/{project_id}/locales List locales
MembersApi MemberDelete Delete /accounts/{account_id}/members/{id} Remove a user from the account
MembersApi MemberShow Get /accounts/{account_id}/members/{id} Get single member
MembersApi MemberUpdate Patch /accounts/{account_id}/members/{id} Update a member
MembersApi MemberUpdateSettings Patch /projects/{project_id}/members/{id} Update a member's project settings
MembersApi MembersList Get /accounts/{account_id}/members List members
NotificationGroupsApi NotificationGroupsList Get /notification_groups List notification groups
NotificationGroupsApi NotificationGroupsMarkAllAsRead Patch /notification_groups/mark_all_as_read Mark all notification groups as read
NotificationGroupsApi NotificationGroupsMarkAsRead Patch /notification_groups/{id}/mark_as_read Mark a notification group as read
NotificationsApi NotificationsList Get /notifications List notifications
NotificationsApi NotificationsMarkAllAsRead Post /notifications/mark_all_as_read Mark all notifications as read
NotificationsApi NotificationsShow Get /notifications/{id} Get a single notification
OrdersApi OrderConfirm Patch /projects/{project_id}/orders/{id}/confirm Confirm an order
OrdersApi OrderCreate Post /projects/{project_id}/orders Create a new order
OrdersApi OrderDelete Delete /projects/{project_id}/orders/{id} Cancel an order
OrdersApi OrderShow Get /projects/{project_id}/orders/{id} Get a single order
OrdersApi OrdersList Get /projects/{project_id}/orders List orders
OrganizationJobTemplateLocalesApi OrganizationJobTemplateLocaleDelete Delete /accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} Delete an organization job template locale
OrganizationJobTemplateLocalesApi OrganizationJobTemplateLocaleShow Get /accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} Get a single organization job template locale
OrganizationJobTemplateLocalesApi OrganizationJobTemplateLocaleUpdate Patch /accounts/{account_id}/job_templates/{job_template_id}/locales/{job_template_locale_id} Update an organization job template locale
OrganizationJobTemplateLocalesApi OrganizationJobTemplateLocalesCreate Post /accounts/{account_id}/job_templates/{job_template_id}/locales Create an organization job template locale
OrganizationJobTemplateLocalesApi OrganizationJobTemplateLocalesList Get /accounts/{account_id}/job_templates/{job_template_id}/locales List organization job template locales
OrganizationJobTemplatesApi OrganizationJobTemplateCreate Post /accounts/{account_id}/job_templates Create an organization job template
OrganizationJobTemplatesApi OrganizationJobTemplateDelete Delete /accounts/{account_id}/job_templates/{id} Delete an organization job template
OrganizationJobTemplatesApi OrganizationJobTemplateUpdate Patch /accounts/{account_id}/job_templates/{id} Update an organization job template
OrganizationJobTemplatesApi OrganizationJobTemplatesList Get /accounts/{account_id}/job_templates List organization job templates
OrganizationJobTemplatesApi OrganizationJobTemplatesShow Get /accounts/{account_id}/job_templates/{id} Get a single organization job template
ProjectsApi ProjectCreate Post /projects Create a project
ProjectsApi ProjectDelete Delete /projects/{id} Delete a project
ProjectsApi ProjectShow Get /projects/{id} Get a single project
ProjectsApi ProjectUpdate Patch /projects/{id} Update a project
ProjectsApi ProjectsList Get /projects List projects
QualityPerformanceScoreApi ProjectsQualityPerformanceScore Post /projects/{project_id}/quality_performance_score Get Translation Quality
ReleasesApi ReleaseCreate Post /accounts/{account_id}/distributions/{distribution_id}/releases Create a release
ReleasesApi ReleaseDelete Delete /accounts/{account_id}/distributions/{distribution_id}/releases/{id} Delete a release
ReleasesApi ReleasePublish Post /accounts/{account_id}/distributions/{distribution_id}/releases/{id}/publish Publish a release
ReleasesApi ReleaseShow Get /accounts/{account_id}/distributions/{distribution_id}/releases/{id} Get a single release
ReleasesApi ReleaseUpdate Patch /accounts/{account_id}/distributions/{distribution_id}/releases/{id} Update a release
ReleasesApi ReleasesList Get /accounts/{account_id}/distributions/{distribution_id}/releases List releases
RepoSyncsApi RepoSyncActivate Post /accounts/{account_id}/repo_syncs/{repo_sync_id}/activate Activate a Repo Sync
RepoSyncsApi RepoSyncDeactivate Post /accounts/{account_id}/repo_syncs/{repo_sync_id}/deactivate Deactivate a Repo Sync
RepoSyncsApi RepoSyncEvents Get /accounts/{account_id}/repo_syncs/{repo_sync_id}/events Repository Syncs History
RepoSyncsApi RepoSyncExport Post /accounts/{account_id}/repo_syncs/{repo_sync_id}/export Export to code repository
RepoSyncsApi RepoSyncImport Post /accounts/{account_id}/repo_syncs/{repo_sync_id}/import Import from code repository
RepoSyncsApi RepoSyncList Get /accounts/{account_id}/repo_syncs Get Repo Syncs
RepoSyncsApi RepoSyncShow Get /accounts/{account_id}/repo_syncs/{repo_sync_id} Get a single Repo Sync
ReportsApi ReportLocalesList Get /projects/{project_id}/report/locales List Locale Reports
ReportsApi ReportShow Get /projects/{project_id}/report Get Project Report
ScreenshotMarkersApi ScreenshotMarkerCreate Post /projects/{project_id}/screenshots/{screenshot_id}/markers Create a screenshot marker
ScreenshotMarkersApi ScreenshotMarkerDelete Delete /projects/{project_id}/screenshots/{screenshot_id}/markers Delete a screenshot marker
ScreenshotMarkersApi ScreenshotMarkerShow Get /projects/{project_id}/screenshots/{screenshot_id}/markers/{id} Get a single screenshot marker
ScreenshotMarkersApi ScreenshotMarkerUpdate Patch /projects/{project_id}/screenshots/{screenshot_id}/markers Update a screenshot marker
ScreenshotMarkersApi ScreenshotMarkersList Get /projects/{project_id}/screenshots/{id}/markers List screenshot markers
ScreenshotsApi ScreenshotCreate Post /projects/{project_id}/screenshots Create a screenshot
ScreenshotsApi ScreenshotDelete Delete /projects/{project_id}/screenshots/{id} Delete a screenshot
ScreenshotsApi ScreenshotShow Get /projects/{project_id}/screenshots/{id} Get a single screenshot
ScreenshotsApi ScreenshotUpdate Patch /projects/{project_id}/screenshots/{id} Update a screenshot
ScreenshotsApi ScreenshotsList Get /projects/{project_id}/screenshots List screenshots
SearchApi SearchInAccount Post /accounts/{account_id}/search Search across projects
SpacesApi SpaceCreate Post /accounts/{account_id}/spaces Create a Space
SpacesApi SpaceDelete Delete /accounts/{account_id}/spaces/{id} Delete Space
SpacesApi SpaceShow Get /accounts/{account_id}/spaces/{id} Get Space
SpacesApi SpaceUpdate Patch /accounts/{account_id}/spaces/{id} Update Space
SpacesApi SpacesList Get /accounts/{account_id}/spaces List Spaces
SpacesApi SpacesProjectsCreate Post /accounts/{account_id}/spaces/{space_id}/projects Add Project to Space
SpacesApi SpacesProjectsDelete Delete /accounts/{account_id}/spaces/{space_id}/projects/{id} Remove Project from Space
SpacesApi SpacesProjectsList Get /accounts/{account_id}/spaces/{space_id}/projects List Projects in Space
StyleGuidesApi StyleguideCreate Post /projects/{project_id}/styleguides Create a style guide
StyleGuidesApi StyleguideDelete Delete /projects/{project_id}/styleguides/{id} Delete a style guide
StyleGuidesApi StyleguideShow Get /projects/{project_id}/styleguides/{id} Get a single style guide
StyleGuidesApi StyleguideUpdate Patch /projects/{project_id}/styleguides/{id} Update a style guide
StyleGuidesApi StyleguidesList Get /projects/{project_id}/styleguides List style guides
TagsApi TagCreate Post /projects/{project_id}/tags Create a tag
TagsApi TagDelete Delete /projects/{project_id}/tags/{name} Delete a tag
TagsApi TagShow Get /projects/{project_id}/tags/{name} Get a single tag
TagsApi TagsList Get /projects/{project_id}/tags List tags
TeamsApi TeamCreate Post /accounts/{account_id}/teams Create a Team
TeamsApi TeamDelete Delete /accounts/{account_id}/teams/{id} Delete Team
TeamsApi TeamShow Get /accounts/{account_id}/teams/{id} Get Team
TeamsApi TeamUpdate Patch /accounts/{account_id}/teams/{id} Update Team
TeamsApi TeamsList Get /accounts/{account_id}/teams List Teams
TeamsApi TeamsProjectsCreate Post /accounts/{account_id}/teams/{team_id}/projects Add Project to Team
TeamsApi TeamsProjectsDelete Delete /accounts/{account_id}/teams/{team_id}/projects/{id} Remove Project from Team
TeamsApi TeamsSpacesCreate Post /accounts/{account_id}/teams/{team_id}/spaces Add Space
TeamsApi TeamsSpacesDelete Delete /accounts/{account_id}/teams/{team_id}/spaces/{id} Remove Space
TeamsApi TeamsUsersCreate Post /accounts/{account_id}/teams/{team_id}/users Add User
TeamsApi TeamsUsersDelete Delete /accounts/{account_id}/teams/{team_id}/users/{id} Remove User
TranslationsApi TranslationCreate Post /projects/{project_id}/translations Create a translation
TranslationsApi TranslationExclude Patch /projects/{project_id}/translations/{id}/exclude Exclude a translation from export
TranslationsApi TranslationInclude Patch /projects/{project_id}/translations/{id}/include Include a translation
TranslationsApi TranslationReview Patch /projects/{project_id}/translations/{id}/review Review a translation
TranslationsApi TranslationShow Get /projects/{project_id}/translations/{id} Get a single translation
TranslationsApi TranslationUnverify Patch /projects/{project_id}/translations/{id}/unverify Mark a translation as unverified
TranslationsApi TranslationUpdate Patch /projects/{project_id}/translations/{id} Update a translation
TranslationsApi TranslationVerify Patch /projects/{project_id}/translations/{id}/verify Verify a translation
TranslationsApi TranslationsByKey Get /projects/{project_id}/keys/{key_id}/translations List translations by key
TranslationsApi TranslationsByLocale Get /projects/{project_id}/locales/{locale_id}/translations List translations by locale
TranslationsApi TranslationsExcludeCollection Patch /projects/{project_id}/translations/exclude Exclude translations by query
TranslationsApi TranslationsIncludeCollection Patch /projects/{project_id}/translations/include Include translations by query
TranslationsApi TranslationsList Get /projects/{project_id}/translations List all translations
TranslationsApi TranslationsReviewCollection Patch /projects/{project_id}/translations/review Review translations selected by query
TranslationsApi TranslationsSearch Post /projects/{project_id}/translations/search Search translations
TranslationsApi TranslationsUnverifyCollection Patch /projects/{project_id}/translations/unverify Unverify translations by query
TranslationsApi TranslationsVerifyCollection Patch /projects/{project_id}/translations/verify Verify translations by query
UploadsApi UploadCreate Post /projects/{project_id}/uploads Upload a new file
UploadsApi UploadShow Get /projects/{project_id}/uploads/{id} Get a single upload
UploadsApi UploadsList Get /projects/{project_id}/uploads List uploads
UsersApi ShowUser Get /user Show current User
VariablesApi VariableCreate Post /projects/{project_id}/variables Create a variable
VariablesApi VariableDelete Delete /projects/{project_id}/variables/{name} Delete a variable
VariablesApi VariableShow Get /projects/{project_id}/variables/{name} Get a single variable
VariablesApi VariableUpdate Patch /projects/{project_id}/variables/{name} Update a variable
VariablesApi VariablesList Get /projects/{project_id}/variables List variables
VersionsHistoryApi VersionShow Get /projects/{project_id}/translations/{translation_id}/versions/{id} Get a single version
VersionsHistoryApi VersionsList Get /projects/{project_id}/translations/{translation_id}/versions List all versions
WebhookDeliveriesApi WebhookDeliveriesList Get /projects/{project_id}/webhooks/{webhook_id}/deliveries List webhook deliveries
WebhookDeliveriesApi WebhookDeliveriesRedeliver Post /projects/{project_id}/webhooks/{webhook_id}/deliveries/{id}/redeliver Redeliver a single webhook delivery
WebhookDeliveriesApi WebhookDeliveriesShow Get /projects/{project_id}/webhooks/{webhook_id}/deliveries/{id} Get a single webhook delivery
WebhooksApi WebhookCreate Post /projects/{project_id}/webhooks Create a webhook
WebhooksApi WebhookDelete Delete /projects/{project_id}/webhooks/{id} Delete a webhook
WebhooksApi WebhookShow Get /projects/{project_id}/webhooks/{id} Get a single webhook
WebhooksApi WebhookTest Post /projects/{project_id}/webhooks/{id}/test Test a webhook
WebhooksApi WebhookUpdate Patch /projects/{project_id}/webhooks/{id} Update a webhook
WebhooksApi WebhooksList Get /projects/{project_id}/webhooks List webhooks

Documentation For Models

More Information

This API client was generated by the OpenAPI Generator project.

  • API version: 2.0.0
  • Package version: 2.27.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://developers.phrase.com/api/

Author

support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com support@phrase.com

Get help / support

Please contact support@phrase.com and we can take more direct action toward finding a solution.

Documentation ¶

Index ¶

Constants ¶

This section is empty.

Variables ¶

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶ 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func ClientVersion ¶ 

func ClientVersion() string

func ConvertToStringMap ¶ 

func ConvertToStringMap(raw map[string]interface{}) (map[string]string, error)

func IsNil ¶ added in v2.17.0 

func IsNil(i interface{}) bool

IsNil checks if an input is nil

func ParseYAMLToMap ¶ 

func ParseYAMLToMap(unmarshal func(interface{}) error, keysToField map[string]interface{}) error

Calls the YAML parser function (see yaml.v2/Unmarshaler interface) with a map of string to interface. This map is then iterated to match against the given map of keys to fields, validates the type and sets the fields accordingly.

func PtrBool ¶ added in v2.17.0 

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32 ¶ added in v2.17.0 

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64 ¶ added in v2.17.0 

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt ¶ added in v2.17.0 

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32 ¶ added in v2.17.0 

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64 ¶ added in v2.17.0 

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString ¶ added in v2.17.0 

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime ¶ added in v2.17.0 

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

func ValidateIsBool ¶ 

func ValidateIsBool(k string, v interface{}) (bool, error)

func ValidateIsInt ¶ 

func ValidateIsInt(k string, v interface{}) (int, error)

func ValidateIsRawMap ¶ 

func ValidateIsRawMap(k string, v interface{}) (map[string]interface{}, error)

func ValidateIsString ¶ 

func ValidateIsString(k string, v interface{}) (string, error)

Types ¶

type APIClient ¶ 

type APIClient struct {
	AccountsApi *AccountsApiService

	AuthorizationsApi *AuthorizationsApiService

	BitbucketSyncApi *BitbucketSyncApiService

	BlacklistedKeysApi *BlacklistedKeysApiService

	BranchesApi *BranchesApiService

	CommentReactionsApi *CommentReactionsApiService

	CommentRepliesApi *CommentRepliesApiService

	CommentsApi *CommentsApiService

	CustomMetadataApi *CustomMetadataApiService

	DistributionsApi *DistributionsApiService

	DocumentsApi *DocumentsApiService

	FigmaAttachmentsApi *FigmaAttachmentsApiService

	FormatsApi *FormatsApiService

	GitHubSyncApi *GitHubSyncApiService

	GitLabSyncApi *GitLabSyncApiService

	GlossariesApi *GlossariesApiService

	GlossaryTermTranslationsApi *GlossaryTermTranslationsApiService

	GlossaryTermsApi *GlossaryTermsApiService

	ICUApi *ICUApiService

	InvitationsApi *InvitationsApiService

	JobCommentsApi *JobCommentsApiService

	JobLocalesApi *JobLocalesApiService

	JobTemplateLocalesApi *JobTemplateLocalesApiService

	JobTemplatesApi *JobTemplatesApiService

	JobsApi *JobsApiService

	KeysApi *KeysApiService

	KeysFigmaAttachmentsApi *KeysFigmaAttachmentsApiService

	LinkedKeysApi *LinkedKeysApiService

	LocalesApi *LocalesApiService

	MembersApi *MembersApiService

	NotificationGroupsApi *NotificationGroupsApiService

	NotificationsApi *NotificationsApiService

	OrdersApi *OrdersApiService

	OrganizationJobTemplateLocalesApi *OrganizationJobTemplateLocalesApiService

	OrganizationJobTemplatesApi *OrganizationJobTemplatesApiService

	ProjectsApi *ProjectsApiService

	QualityPerformanceScoreApi *QualityPerformanceScoreApiService

	ReleasesApi *ReleasesApiService

	RepoSyncsApi *RepoSyncsApiService

	ReportsApi *ReportsApiService

	ScreenshotMarkersApi *ScreenshotMarkersApiService

	ScreenshotsApi *ScreenshotsApiService

	SearchApi *SearchApiService

	SpacesApi *SpacesApiService

	StyleGuidesApi *StyleGuidesApiService

	TagsApi *TagsApiService

	TeamsApi *TeamsApiService

	TranslationsApi *TranslationsApiService

	UploadsApi *UploadsApiService

	UsersApi *UsersApiService

	VariablesApi *VariablesApiService

	VersionsHistoryApi *VersionsHistoryApiService

	WebhookDeliveriesApi *WebhookDeliveriesApiService

	WebhooksApi *WebhooksApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Phrase Strings API Reference API v2.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶ 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶ 

func (c *APIClient) ChangeBasePath(path string)

ChangeBasePath changes base path to allow switching to mocks

func (*APIClient) GetConfig ¶ 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey ¶ 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶ 

type APIResponse struct {
	*http.Response

	// These fields provide the page values for paginating through a set of
	// results. Any or all of these may be set to the zero value for
	// responses that are not part of a paginated set, or for which there
	// are no additional pages.
	//
	// These fields support what is called "offset pagination" and should
	// be used with the ListOptions struct.
	NextPage  int
	FirstPage int
	LastPage  int

	// Explicitly specify the Rate type so Rate's String() receiver doesn't
	// propagate to Response.
	Rate Rate
}

APIResponse stores the API response returned by the server.

func NewAPIResponse ¶ 

func NewAPIResponse(r *http.Response) *APIResponse

newResponse creates a new Response for the provided http.Response. r must not be nil.

type Account ¶ 

type Account struct {
	Id             string    `json:"id,omitempty"`
	Name           string    `json:"name,omitempty"`
	Slug           string    `json:"slug,omitempty"`
	Company        string    `json:"company,omitempty"`
	CreatedAt      time.Time `json:"created_at,omitempty"`
	UpdatedAt      time.Time `json:"updated_at,omitempty"`
	CompanyLogoUrl string    `json:"company_logo_url,omitempty"`
}

Account struct for Account

type AccountDetails ¶ 

type AccountDetails struct {
	Id             string       `json:"id,omitempty"`
	Name           string       `json:"name,omitempty"`
	Slug           string       `json:"slug,omitempty"`
	Company        string       `json:"company,omitempty"`
	CreatedAt      time.Time    `json:"created_at,omitempty"`
	UpdatedAt      time.Time    `json:"updated_at,omitempty"`
	CompanyLogoUrl string       `json:"company_logo_url,omitempty"`
	Subscription   Subscription `json:"subscription,omitempty"`
}

AccountDetails struct for AccountDetails

type AccountLocalesOpts ¶ added in v2.0.2 

type AccountLocalesOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

AccountLocalesOpts Optional parameters for the method 'AccountLocales'

type AccountSearchResult ¶ added in v2.1.0 

type AccountSearchResult struct {
	Query             string        `json:"query,omitempty"`
	Excerpt           string        `json:"excerpt,omitempty"`
	Key               KeyPreview    `json:"key,omitempty"`
	Locale            LocalePreview `json:"locale,omitempty"`
	Project           Project       `json:"project,omitempty"`
	Translation       Translation   `json:"translation,omitempty"`
	OtherTranslations []Translation `json:"other_translations,omitempty"`
}

AccountSearchResult struct for AccountSearchResult

type AccountShowOpts ¶ 

type AccountShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

AccountShowOpts Optional parameters for the method 'AccountShow'

type AccountsApiService ¶ 

type AccountsApiService service

AccountsApiService AccountsApi service

func (*AccountsApiService) AccountShow ¶ 

func (a *AccountsApiService) AccountShow(ctx _context.Context, id string, localVarOptionals *AccountShowOpts) (AccountDetails, *APIResponse, error)

AccountShow Get a single account Get details on a single account.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID
  • @param optional nil or *AccountShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return AccountDetails

func (*AccountsApiService) AccountsList ¶ 

func (a *AccountsApiService) AccountsList(ctx _context.Context, localVarOptionals *AccountsListOpts) ([]Account, *APIResponse, error)

AccountsList List accounts List all accounts the current user has access to.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AccountsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []Account

type AccountsListOpts ¶ 

type AccountsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

AccountsListOpts Optional parameters for the method 'AccountsList'

type AffectedCount ¶ 

type AffectedCount struct {
	RecordsAffected int32 `json:"records_affected,omitempty"`
}

AffectedCount struct for AffectedCount

type AffectedResources ¶ 

type AffectedResources struct {
	RecordsAffected int32 `json:"records_affected,omitempty"`
}

AffectedResources struct for AffectedResources

type Authorization ¶ 

type Authorization struct {
	Id             string    `json:"id,omitempty"`
	Note           string    `json:"note,omitempty"`
	TokenLastEight string    `json:"token_last_eight,omitempty"`
	HashedToken    string    `json:"hashed_token,omitempty"`
	Scopes         []string  `json:"scopes,omitempty"`
	ExpiresAt      time.Time `json:"expires_at,omitempty"`
	CreatedAt      time.Time `json:"created_at,omitempty"`
	UpdatedAt      time.Time `json:"updated_at,omitempty"`
}

Authorization struct for Authorization

type AuthorizationCreateOpts ¶ 

type AuthorizationCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

AuthorizationCreateOpts Optional parameters for the method 'AuthorizationCreate'

type AuthorizationCreateParameters ¶ 

type AuthorizationCreateParameters struct {
	// A note to help you remember what the access is used for.
	Note string `json:"note,omitempty"`
	// A list of scopes that the access can be used for.
	Scopes []string `json:"scopes,omitempty"`
	// Expiration date for the authorization token. Null means no expiration date (default).
	ExpiresAt time.Time `json:"expires_at,omitempty"`
}

AuthorizationCreateParameters struct for AuthorizationCreateParameters

type AuthorizationDeleteOpts ¶ 

type AuthorizationDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

AuthorizationDeleteOpts Optional parameters for the method 'AuthorizationDelete'

type AuthorizationShowOpts ¶ 

type AuthorizationShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

AuthorizationShowOpts Optional parameters for the method 'AuthorizationShow'

type AuthorizationUpdateOpts ¶ 

type AuthorizationUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

AuthorizationUpdateOpts Optional parameters for the method 'AuthorizationUpdate'

type AuthorizationUpdateParameters ¶ 

type AuthorizationUpdateParameters struct {
	// A note to help you remember what the access is used for.
	Note string `json:"note,omitempty"`
	// A list of scopes that the access can be used for.
	Scopes []string `json:"scopes,omitempty"`
	// Expiration date for the authorization token. Null means no expiration date (default).
	ExpiresAt time.Time `json:"expires_at,omitempty"`
}

AuthorizationUpdateParameters struct for AuthorizationUpdateParameters

type AuthorizationWithToken ¶ 

type AuthorizationWithToken struct {
	Id             string    `json:"id,omitempty"`
	Note           string    `json:"note,omitempty"`
	TokenLastEight string    `json:"token_last_eight,omitempty"`
	HashedToken    string    `json:"hashed_token,omitempty"`
	Scopes         []string  `json:"scopes,omitempty"`
	ExpiresAt      time.Time `json:"expires_at,omitempty"`
	CreatedAt      time.Time `json:"created_at,omitempty"`
	UpdatedAt      time.Time `json:"updated_at,omitempty"`
	Token          string    `json:"token,omitempty"`
}

AuthorizationWithToken struct for AuthorizationWithToken

type AuthorizationsApiService ¶ 

type AuthorizationsApiService service

AuthorizationsApiService AuthorizationsApi service

func (*AuthorizationsApiService) AuthorizationCreate ¶ 

func (a *AuthorizationsApiService) AuthorizationCreate(ctx _context.Context, authorizationCreateParameters AuthorizationCreateParameters, localVarOptionals *AuthorizationCreateOpts) (AuthorizationWithToken, *APIResponse, error)

AuthorizationCreate Create an authorization Create a new authorization.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param authorizationCreateParameters
  • @param optional nil or *AuthorizationCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return AuthorizationWithToken

func (*AuthorizationsApiService) AuthorizationDelete ¶ 

func (a *AuthorizationsApiService) AuthorizationDelete(ctx _context.Context, id string, localVarOptionals *AuthorizationDeleteOpts) ([]byte, *APIResponse, error)

AuthorizationDelete Delete an authorization Delete an existing authorization. API calls using that token will stop working.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID
  • @param optional nil or *AuthorizationDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*AuthorizationsApiService) AuthorizationShow ¶ 

func (a *AuthorizationsApiService) AuthorizationShow(ctx _context.Context, id string, localVarOptionals *AuthorizationShowOpts) (Authorization, *APIResponse, error)

AuthorizationShow Get a single authorization Get details on a single authorization.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID
  • @param optional nil or *AuthorizationShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Authorization

func (*AuthorizationsApiService) AuthorizationUpdate ¶ 

func (a *AuthorizationsApiService) AuthorizationUpdate(ctx _context.Context, id string, authorizationUpdateParameters AuthorizationUpdateParameters, localVarOptionals *AuthorizationUpdateOpts) (Authorization, *APIResponse, error)

AuthorizationUpdate Update an authorization Update an existing authorization.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID
  • @param authorizationUpdateParameters
  • @param optional nil or *AuthorizationUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Authorization

func (*AuthorizationsApiService) AuthorizationsList ¶ 

func (a *AuthorizationsApiService) AuthorizationsList(ctx _context.Context, localVarOptionals *AuthorizationsListOpts) ([]Authorization, *APIResponse, error)

AuthorizationsList List authorizations List all your authorizations.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *AuthorizationsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []Authorization

type AuthorizationsListOpts ¶ 

type AuthorizationsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

AuthorizationsListOpts Optional parameters for the method 'AuthorizationsList'

type BasicAuth ¶ 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BitbucketSync ¶ 

type BitbucketSync struct {
	Id                        string         `json:"id,omitempty"`
	RepositoryName            string         `json:"repository_name,omitempty"`
	LastExportToBitbucketAt   time.Time      `json:"last_export_to_bitbucket_at,omitempty"`
	LastImportFromBitbucketAt time.Time      `json:"last_import_from_bitbucket_at,omitempty"`
	ValidPhraseappYaml        *bool          `json:"valid_phraseapp_yaml,omitempty"`
	PhraseappProjects         []ProjectShort `json:"phraseapp_projects,omitempty"`
}

BitbucketSync struct for BitbucketSync

type BitbucketSyncApiService ¶ 

type BitbucketSyncApiService service

BitbucketSyncApiService BitbucketSyncApi service

func (*BitbucketSyncApiService) BitbucketSyncExport ¶ 

func (a *BitbucketSyncApiService) BitbucketSyncExport(ctx _context.Context, id string, bitbucketSyncExportParameters BitbucketSyncExportParameters, localVarOptionals *BitbucketSyncExportOpts) (BitbucketSyncExportResponse, *APIResponse, error)

BitbucketSyncExport Export from Phrase Strings to Bitbucket Export translations from Phrase Strings to Bitbucket according to the .phraseapp.yml file within the Bitbucket Repository. <br><br><i>Note: Export is done asynchronously and may take several seconds depending on the project size.</i>

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID
  • @param bitbucketSyncExportParameters
  • @param optional nil or *BitbucketSyncExportOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return BitbucketSyncExportResponse

func (*BitbucketSyncApiService) BitbucketSyncImport ¶ 

func (a *BitbucketSyncApiService) BitbucketSyncImport(ctx _context.Context, id string, bitbucketSyncImportParameters BitbucketSyncImportParameters, localVarOptionals *BitbucketSyncImportOpts) ([]byte, *APIResponse, error)

BitbucketSyncImport Import to Phrase Strings from Bitbucket Import translations from Bitbucket to Phrase Strings according to the .phraseapp.yml file within the Bitbucket repository. <br><br><i>Note: Import is done asynchronously and may take several seconds depending on the project size.</i>

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID
  • @param bitbucketSyncImportParameters
  • @param optional nil or *BitbucketSyncImportOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*BitbucketSyncApiService) BitbucketSyncsList ¶ 

func (a *BitbucketSyncApiService) BitbucketSyncsList(ctx _context.Context, localVarOptionals *BitbucketSyncsListOpts) ([]BitbucketSync, *APIResponse, error)

BitbucketSyncsList List Bitbucket syncs List all Bitbucket repositories for which synchronisation with Phrase Strings is activated.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *BitbucketSyncsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "AccountId" (optional.String) - Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts.

@return []BitbucketSync

type BitbucketSyncExportOpts ¶ 

type BitbucketSyncExportOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

BitbucketSyncExportOpts Optional parameters for the method 'BitbucketSyncExport'

type BitbucketSyncExportParameters ¶ 

type BitbucketSyncExportParameters struct {
	// Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts.
	AccountId string `json:"account_id,omitempty"`
}

BitbucketSyncExportParameters struct for BitbucketSyncExportParameters

type BitbucketSyncExportResponse ¶ 

type BitbucketSyncExportResponse struct {
	StatusPath string `json:"status_path,omitempty"`
}

BitbucketSyncExportResponse struct for BitbucketSyncExportResponse

type BitbucketSyncImportOpts ¶ 

type BitbucketSyncImportOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

BitbucketSyncImportOpts Optional parameters for the method 'BitbucketSyncImport'

type BitbucketSyncImportParameters ¶ 

type BitbucketSyncImportParameters struct {
	// Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts.
	AccountId string `json:"account_id,omitempty"`
}

BitbucketSyncImportParameters struct for BitbucketSyncImportParameters

type BitbucketSyncsListOpts ¶ 

type BitbucketSyncsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	AccountId     optional.String `json:"account_id,omitempty"`
}

BitbucketSyncsListOpts Optional parameters for the method 'BitbucketSyncsList'

type BlacklistedKey ¶ 

type BlacklistedKey struct {
	Id        string    `json:"id,omitempty"`
	Name      string    `json:"name,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

BlacklistedKey struct for BlacklistedKey

type BlacklistedKeyCreateOpts ¶ 

type BlacklistedKeyCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

BlacklistedKeyCreateOpts Optional parameters for the method 'BlacklistedKeyCreate'

type BlacklistedKeyCreateParameters ¶ 

type BlacklistedKeyCreateParameters struct {
	// Blocked key name
	Name string `json:"name,omitempty"`
}

BlacklistedKeyCreateParameters struct for BlacklistedKeyCreateParameters

type BlacklistedKeyDeleteOpts ¶ 

type BlacklistedKeyDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

BlacklistedKeyDeleteOpts Optional parameters for the method 'BlacklistedKeyDelete'

type BlacklistedKeyShowOpts ¶ 

type BlacklistedKeyShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

BlacklistedKeyShowOpts Optional parameters for the method 'BlacklistedKeyShow'

type BlacklistedKeyUpdateOpts ¶ 

type BlacklistedKeyUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

BlacklistedKeyUpdateOpts Optional parameters for the method 'BlacklistedKeyUpdate'

type BlacklistedKeyUpdateParameters ¶ 

type BlacklistedKeyUpdateParameters struct {
	// Blocked key name
	Name string `json:"name,omitempty"`
}

BlacklistedKeyUpdateParameters struct for BlacklistedKeyUpdateParameters

type BlacklistedKeysApiService ¶ 

type BlacklistedKeysApiService service

BlacklistedKeysApiService BlacklistedKeysApi service

func (*BlacklistedKeysApiService) BlacklistedKeyCreate ¶ 

func (a *BlacklistedKeysApiService) BlacklistedKeyCreate(ctx _context.Context, projectId string, blacklistedKeyCreateParameters BlacklistedKeyCreateParameters, localVarOptionals *BlacklistedKeyCreateOpts) (BlacklistedKey, *APIResponse, error)

BlacklistedKeyCreate Create a blocked key Create a new rule for blocking keys.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param blacklistedKeyCreateParameters
  • @param optional nil or *BlacklistedKeyCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return BlacklistedKey

func (*BlacklistedKeysApiService) BlacklistedKeyDelete ¶ 

func (a *BlacklistedKeysApiService) BlacklistedKeyDelete(ctx _context.Context, projectId string, id string, localVarOptionals *BlacklistedKeyDeleteOpts) ([]byte, *APIResponse, error)

BlacklistedKeyDelete Delete a blocked key Delete an existing rule for blocking keys.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *BlacklistedKeyDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*BlacklistedKeysApiService) BlacklistedKeyShow ¶ 

func (a *BlacklistedKeysApiService) BlacklistedKeyShow(ctx _context.Context, projectId string, id string, localVarOptionals *BlacklistedKeyShowOpts) (BlacklistedKey, *APIResponse, error)

BlacklistedKeyShow Get a single blocked key Get details on a single rule for blocking keys for a given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *BlacklistedKeyShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return BlacklistedKey

func (*BlacklistedKeysApiService) BlacklistedKeyUpdate ¶ 

func (a *BlacklistedKeysApiService) BlacklistedKeyUpdate(ctx _context.Context, projectId string, id string, blacklistedKeyUpdateParameters BlacklistedKeyUpdateParameters, localVarOptionals *BlacklistedKeyUpdateOpts) (BlacklistedKey, *APIResponse, error)

BlacklistedKeyUpdate Update a blocked key Update an existing rule for blocking keys.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param blacklistedKeyUpdateParameters
  • @param optional nil or *BlacklistedKeyUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return BlacklistedKey

func (*BlacklistedKeysApiService) BlacklistedKeysList ¶ 

func (a *BlacklistedKeysApiService) BlacklistedKeysList(ctx _context.Context, projectId string, localVarOptionals *BlacklistedKeysListOpts) ([]BlacklistedKey, *APIResponse, error)

BlacklistedKeysList List blocked keys List all rules for blocking keys for the given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *BlacklistedKeysListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use

@return []BlacklistedKey

type BlacklistedKeysListOpts ¶ 

type BlacklistedKeysListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

BlacklistedKeysListOpts Optional parameters for the method 'BlacklistedKeysList'

type Branch ¶ 

type Branch struct {
	BaseProjectId   string      `json:"base_project_id,omitempty"`
	BranchProjectId string      `json:"branch_project_id,omitempty"`
	Name            string      `json:"name,omitempty"`
	CreatedAt       time.Time   `json:"created_at,omitempty"`
	UpdatedAt       time.Time   `json:"updated_at,omitempty"`
	MergedAt        time.Time   `json:"merged_at,omitempty"`
	MergedBy        UserPreview `json:"merged_by,omitempty"`
	CreatedBy       UserPreview `json:"created_by,omitempty"`
	State           string      `json:"state,omitempty"`
}

Branch struct for Branch

type BranchCompareOpts ¶ 

type BranchCompareOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

BranchCompareOpts Optional parameters for the method 'BranchCompare'

type BranchCreateOpts ¶ 

type BranchCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

BranchCreateOpts Optional parameters for the method 'BranchCreate'

type BranchCreateParameters ¶ 

type BranchCreateParameters struct {
	// Name of the branch
	Name string `json:"name,omitempty"`
}

BranchCreateParameters struct for BranchCreateParameters

type BranchDeleteOpts ¶ 

type BranchDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

BranchDeleteOpts Optional parameters for the method 'BranchDelete'

type BranchMergeOpts ¶ 

type BranchMergeOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

BranchMergeOpts Optional parameters for the method 'BranchMerge'

type BranchMergeParameters ¶ 

type BranchMergeParameters struct {
	// strategy used for merge blocking, use_main or use_branch
	Strategy string `json:"strategy,omitempty"`
}

BranchMergeParameters struct for BranchMergeParameters

type BranchName ¶ 

type BranchName struct {
	Name string `json:"name,omitempty"`
}

BranchName struct for BranchName

type BranchShowOpts ¶ 

type BranchShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

BranchShowOpts Optional parameters for the method 'BranchShow'

type BranchUpdateOpts ¶ 

type BranchUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

BranchUpdateOpts Optional parameters for the method 'BranchUpdate'

type BranchUpdateParameters ¶ 

type BranchUpdateParameters struct {
	// Name of the branch
	Name string `json:"name,omitempty"`
}

BranchUpdateParameters struct for BranchUpdateParameters

type BranchesApiService ¶ 

type BranchesApiService service

BranchesApiService BranchesApi service

func (*BranchesApiService) BranchCompare ¶ 

func (a *BranchesApiService) BranchCompare(ctx _context.Context, projectId string, name string, localVarOptionals *BranchCompareOpts) ([]byte, *APIResponse, error)

BranchCompare Compare branches Compare branch with main branch. <br><br><i>Note: Comparing a branch may take several minutes depending on the project size.</i>

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param name name
  • @param optional nil or *BranchCompareOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*BranchesApiService) BranchCreate ¶ 

func (a *BranchesApiService) BranchCreate(ctx _context.Context, projectId string, branchCreateParameters BranchCreateParameters, localVarOptionals *BranchCreateOpts) (Branch, *APIResponse, error)

BranchCreate Create a branch Create a new branch. <br><br><i>Note: Creating a new branch may take several minutes depending on the project size.</i>

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param branchCreateParameters
  • @param optional nil or *BranchCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Branch

func (*BranchesApiService) BranchDelete ¶ 

func (a *BranchesApiService) BranchDelete(ctx _context.Context, projectId string, name string, localVarOptionals *BranchDeleteOpts) ([]byte, *APIResponse, error)

BranchDelete Delete a branch Delete an existing branch.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param name name
  • @param optional nil or *BranchDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*BranchesApiService) BranchMerge ¶ 

func (a *BranchesApiService) BranchMerge(ctx _context.Context, projectId string, name string, branchMergeParameters BranchMergeParameters, localVarOptionals *BranchMergeOpts) ([]byte, *APIResponse, error)

BranchMerge Merge a branch Merge an existing branch. <br><br><i>Note: Merging a branch may take several minutes depending on diff size.</i>

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param name name
  • @param branchMergeParameters
  • @param optional nil or *BranchMergeOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*BranchesApiService) BranchShow ¶ 

func (a *BranchesApiService) BranchShow(ctx _context.Context, projectId string, name string, localVarOptionals *BranchShowOpts) (Branch, *APIResponse, error)

BranchShow Get a single branch Get details on a single branch for a given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param name name
  • @param optional nil or *BranchShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Branch

func (*BranchesApiService) BranchUpdate ¶ 

func (a *BranchesApiService) BranchUpdate(ctx _context.Context, projectId string, name string, branchUpdateParameters BranchUpdateParameters, localVarOptionals *BranchUpdateOpts) (Branch, *APIResponse, error)

BranchUpdate Update a branch Update an existing branch.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param name name
  • @param branchUpdateParameters
  • @param optional nil or *BranchUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Branch

func (*BranchesApiService) BranchesList ¶ 

func (a *BranchesApiService) BranchesList(ctx _context.Context, projectId string, localVarOptionals *BranchesListOpts) ([]Branch, *APIResponse, error)

BranchesList List branches List all branches the of the current project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *BranchesListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []Branch

type BranchesListOpts ¶ 

type BranchesListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

BranchesListOpts Optional parameters for the method 'BranchesList'

type Comment ¶ 

type Comment struct {
	Id             string          `json:"id,omitempty"`
	Message        string          `json:"message,omitempty"`
	HasReplies     *bool           `json:"has_replies,omitempty"`
	User           UserPreview     `json:"user,omitempty"`
	CreatedAt      time.Time       `json:"created_at,omitempty"`
	UpdatedAt      time.Time       `json:"updated_at,omitempty"`
	MentionedUsers []UserPreview   `json:"mentioned_users,omitempty"`
	Locales        []LocalePreview `json:"locales,omitempty"`
}

Comment struct for Comment

type CommentCreateOpts ¶ 

type CommentCreateOpts struct {
	XPhraseAppOTP optional.String    `json:"X-PhraseApp-OTP,omitempty"`
	Message       optional.String    `json:"message,omitempty"`
	LocaleIds     optional.Interface `json:"locale_ids,omitempty"`
}

CommentCreateOpts Optional parameters for the method 'CommentCreate'

type CommentCreateParameters ¶ 

type CommentCreateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Comment message
	Message string `json:"message,omitempty"`
}

CommentCreateParameters struct for CommentCreateParameters

type CommentDeleteOpts ¶ 

type CommentDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

CommentDeleteOpts Optional parameters for the method 'CommentDelete'

type CommentMarkCheckOpts ¶ 

type CommentMarkCheckOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

CommentMarkCheckOpts Optional parameters for the method 'CommentMarkCheck'

type CommentMarkReadOpts ¶ 

type CommentMarkReadOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

CommentMarkReadOpts Optional parameters for the method 'CommentMarkRead'

type CommentMarkReadParameters ¶ 

type CommentMarkReadParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
}

CommentMarkReadParameters struct for CommentMarkReadParameters

type CommentMarkUnreadOpts ¶ 

type CommentMarkUnreadOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

CommentMarkUnreadOpts Optional parameters for the method 'CommentMarkUnread'

type CommentReaction ¶ added in v2.11.0 

type CommentReaction struct {
	Id        string      `json:"id,omitempty"`
	Emoji     string      `json:"emoji,omitempty"`
	CreatedAt time.Time   `json:"created_at,omitempty"`
	UpdatedAt time.Time   `json:"updated_at,omitempty"`
	Comment   Comment     `json:"comment,omitempty"`
	User      UserPreview `json:"user,omitempty"`
}

CommentReaction struct for CommentReaction

type CommentReactionsApiService ¶ added in v2.11.0 

type CommentReactionsApiService service

CommentReactionsApiService CommentReactionsApi service

func (*CommentReactionsApiService) ReactionCreate ¶ added in v2.11.0 

func (a *CommentReactionsApiService) ReactionCreate(ctx _context.Context, projectId string, keyId string, commentId string, localVarOptionals *ReactionCreateOpts) (CommentReaction, *APIResponse, error)

ReactionCreate Create a reaction Create a new reaction for a comment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param commentId Comment ID
  • @param optional nil or *ReactionCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use
  • @param "Emoji" (optional.String) - specify the emoji for the reaction

@return CommentReaction

func (*CommentReactionsApiService) ReactionDelete ¶ added in v2.11.0 

func (a *CommentReactionsApiService) ReactionDelete(ctx _context.Context, projectId string, keyId string, commentId string, id string, localVarOptionals *ReactionDeleteOpts) ([]byte, *APIResponse, error)

ReactionDelete Delete a reaction Delete an existing reaction.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param commentId Comment ID
  • @param id ID
  • @param optional nil or *ReactionDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*CommentReactionsApiService) ReactionShow ¶ added in v2.11.0 

func (a *CommentReactionsApiService) ReactionShow(ctx _context.Context, projectId string, keyId string, commentId string, id string, localVarOptionals *ReactionShowOpts) (CommentReaction, *APIResponse, error)

ReactionShow Get a single reaction Get details on a single reaction.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param commentId Comment ID
  • @param id ID
  • @param optional nil or *ReactionShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return CommentReaction

func (*CommentReactionsApiService) ReactionsList ¶ added in v2.11.0 

func (a *CommentReactionsApiService) ReactionsList(ctx _context.Context, projectId string, keyId string, commentId string, localVarOptionals *ReactionsListOpts) ([]CommentReaction, *APIResponse, error)

ReactionsList List reactions List all reactions for a comment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param commentId Comment ID
  • @param optional nil or *ReactionsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use

@return []CommentReaction

type CommentRepliesApiService ¶ added in v2.12.0 

type CommentRepliesApiService service

CommentRepliesApiService CommentRepliesApi service

func (*CommentRepliesApiService) RepliesList ¶ added in v2.12.0 

func (a *CommentRepliesApiService) RepliesList(ctx _context.Context, projectId string, keyId string, commentId string, repliesListParameters RepliesListParameters, localVarOptionals *RepliesListOpts) ([]Comment, *APIResponse, error)

RepliesList List replies List all replies for a comment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param commentId Comment ID
  • @param repliesListParameters
  • @param optional nil or *RepliesListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use
  • @param "Query" (optional.String) - Search query for comment messages
  • @param "Filters" (optional.Interface of []string) - Specify the filter for the comments
  • @param "Order" (optional.String) - Order direction. Can be one of: asc, desc.

@return []Comment

func (*CommentRepliesApiService) ReplyCreate ¶ added in v2.12.0 

func (a *CommentRepliesApiService) ReplyCreate(ctx _context.Context, projectId string, keyId string, commentId string, localVarOptionals *ReplyCreateOpts) (Comment, *APIResponse, error)

ReplyCreate Create a reply Create a new reply for a comment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param commentId Comment ID
  • @param optional nil or *ReplyCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use
  • @param "Message" (optional.String) - specify the message for the comment

@return Comment

func (*CommentRepliesApiService) ReplyDelete ¶ added in v2.12.0 

func (a *CommentRepliesApiService) ReplyDelete(ctx _context.Context, projectId string, keyId string, commentId string, id string, localVarOptionals *ReplyDeleteOpts) ([]byte, *APIResponse, error)

ReplyDelete Delete a reply Delete an existing reply.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param commentId Comment ID
  • @param id ID
  • @param optional nil or *ReplyDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*CommentRepliesApiService) ReplyMarkAsRead ¶ added in v2.12.0 

func (a *CommentRepliesApiService) ReplyMarkAsRead(ctx _context.Context, projectId string, keyId string, commentId string, id string, localVarOptionals *ReplyMarkAsReadOpts) ([]byte, *APIResponse, error)

ReplyMarkAsRead Mark a reply as read Mark a reply as read.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param commentId Comment ID
  • @param id ID
  • @param optional nil or *ReplyMarkAsReadOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*CommentRepliesApiService) ReplyMarkAsUnread ¶ added in v2.12.0 

func (a *CommentRepliesApiService) ReplyMarkAsUnread(ctx _context.Context, projectId string, keyId string, commentId string, id string, localVarOptionals *ReplyMarkAsUnreadOpts) ([]byte, *APIResponse, error)

ReplyMarkAsUnread Mark a reply as unread Mark a reply as unread.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param commentId Comment ID
  • @param id ID
  • @param optional nil or *ReplyMarkAsUnreadOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*CommentRepliesApiService) ReplyShow ¶ added in v2.12.0 

func (a *CommentRepliesApiService) ReplyShow(ctx _context.Context, projectId string, keyId string, commentId string, id string, localVarOptionals *ReplyShowOpts) (Comment, *APIResponse, error)

ReplyShow Get a single reply Get details on a single reply.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param commentId Comment ID
  • @param id ID
  • @param optional nil or *ReplyShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return Comment

type CommentShowOpts ¶ 

type CommentShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

CommentShowOpts Optional parameters for the method 'CommentShow'

type CommentUpdateOpts ¶ 

type CommentUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

CommentUpdateOpts Optional parameters for the method 'CommentUpdate'

type CommentUpdateParameters ¶ 

type CommentUpdateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Comment message
	Message string `json:"message,omitempty"`
}

CommentUpdateParameters struct for CommentUpdateParameters

type CommentsApiService ¶ 

type CommentsApiService service

CommentsApiService CommentsApi service

func (*CommentsApiService) CommentCreate ¶ 

func (a *CommentsApiService) CommentCreate(ctx _context.Context, projectId string, keyId string, commentCreateParameters CommentCreateParameters, localVarOptionals *CommentCreateOpts) (Comment, *APIResponse, error)

CommentCreate Create a comment Create a new comment for a key.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param commentCreateParameters
  • @param optional nil or *CommentCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Message" (optional.String) - specify the message for the comment
  • @param "LocaleIds" (optional.Interface of []string) - specify the locales for the comment

@return Comment

func (*CommentsApiService) CommentDelete ¶ 

func (a *CommentsApiService) CommentDelete(ctx _context.Context, projectId string, keyId string, id string, localVarOptionals *CommentDeleteOpts) ([]byte, *APIResponse, error)

CommentDelete Delete a comment Delete an existing comment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param id ID
  • @param optional nil or *CommentDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*CommentsApiService) CommentMarkCheck ¶ 

func (a *CommentsApiService) CommentMarkCheck(ctx _context.Context, projectId string, keyId string, id string, localVarOptionals *CommentMarkCheckOpts) ([]byte, *APIResponse, error)

CommentMarkCheck Check if comment is read Check if comment was marked as read. Returns 204 if read, 404 if unread.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param id ID
  • @param optional nil or *CommentMarkCheckOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*CommentsApiService) CommentMarkRead ¶ 

func (a *CommentsApiService) CommentMarkRead(ctx _context.Context, projectId string, keyId string, id string, commentMarkReadParameters CommentMarkReadParameters, localVarOptionals *CommentMarkReadOpts) ([]byte, *APIResponse, error)

CommentMarkRead Mark a comment as read Mark a comment as read.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param id ID
  • @param commentMarkReadParameters
  • @param optional nil or *CommentMarkReadOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*CommentsApiService) CommentMarkUnread ¶ 

func (a *CommentsApiService) CommentMarkUnread(ctx _context.Context, projectId string, keyId string, id string, localVarOptionals *CommentMarkUnreadOpts) ([]byte, *APIResponse, error)

CommentMarkUnread Mark a comment as unread Mark a comment as unread.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param id ID
  • @param optional nil or *CommentMarkUnreadOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*CommentsApiService) CommentShow ¶ 

func (a *CommentsApiService) CommentShow(ctx _context.Context, projectId string, keyId string, id string, localVarOptionals *CommentShowOpts) (Comment, *APIResponse, error)

CommentShow Get a single comment Get details on a single comment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param id ID
  • @param optional nil or *CommentShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return Comment

func (*CommentsApiService) CommentUpdate ¶ 

func (a *CommentsApiService) CommentUpdate(ctx _context.Context, projectId string, keyId string, id string, commentUpdateParameters CommentUpdateParameters, localVarOptionals *CommentUpdateOpts) (Comment, *APIResponse, error)

CommentUpdate Update a comment Update an existing comment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param id ID
  • @param commentUpdateParameters
  • @param optional nil or *CommentUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Comment

func (*CommentsApiService) CommentsList ¶ 

func (a *CommentsApiService) CommentsList(ctx _context.Context, projectId string, keyId string, commentsListParameters CommentsListParameters, localVarOptionals *CommentsListOpts) ([]Comment, *APIResponse, error)

CommentsList List comments List all comments for a key.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param commentsListParameters
  • @param optional nil or *CommentsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use
  • @param "Query" (optional.String) - Search query for comment messages
  • @param "LocaleIds" (optional.Interface of []string) - Search comments by their assigned locales
  • @param "Filters" (optional.Interface of []string) - Specify the filter for the comments
  • @param "Order" (optional.String) - Order direction. Can be one of: asc, desc.

@return []Comment

type CommentsListOpts ¶ 

type CommentsListOpts struct {
	XPhraseAppOTP optional.String    `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32     `json:"page,omitempty"`
	PerPage       optional.Int32     `json:"per_page,omitempty"`
	Branch        optional.String    `json:"branch,omitempty"`
	Query         optional.String    `json:"query,omitempty"`
	LocaleIds     optional.Interface `json:"locale_ids,omitempty"`
	Filters       optional.Interface `json:"filters,omitempty"`
	Order         optional.String    `json:"order,omitempty"`
}

CommentsListOpts Optional parameters for the method 'CommentsList'

type CommentsListParameters ¶ added in v2.13.0 

type CommentsListParameters struct {
	// Specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Search query for comment messages
	Query string `json:"query,omitempty"`
	// Search comments by their assigned locales
	LocaleIds []string `json:"locale_ids,omitempty"`
	// Specify filters to find comments by
	Filters []string `json:"filters,omitempty"`
	// Specify ordering of comments
	Order string `json:"order,omitempty"`
}

CommentsListParameters struct for CommentsListParameters

type Config ¶ 

type Config struct {
	Credentials
	Debug bool

	Page    *int
	PerPage *int

	DefaultProjectID  string
	DefaultFileFormat string

	Defaults map[string]map[string]interface{}

	Targets []byte
	Sources []byte

	UserAgent string
}

Config contains all information from a .phraseapp.yml config file

func ReadConfig ¶ 

func ReadConfig(cfgFilePath string) (*Config, error)

ReadConfig reads a .phrase.yml config file

func (*Config) UnmarshalYAML ¶ 

func (cfg *Config) UnmarshalYAML(unmarshal func(i interface{}) error) error

type Configuration ¶ 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration ¶ 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader ¶ 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerUrl ¶ 

func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error)

ServerUrl returns URL based on server settings

func (*Configuration) SetUserAgent ¶ 

func (c *Configuration) SetUserAgent(customUserAgent string)

type Credentials ¶ 

type Credentials struct {
	Username string
	Token    string
	TFA      bool
	TFAToken string
	Host     string
}

Credentials contains all information to authenticate against phrase.com or a custom host.

type CurrentUser ¶ 

type CurrentUser struct {
	Id        string    `json:"id,omitempty"`
	Username  string    `json:"username,omitempty"`
	Name      string    `json:"name,omitempty"`
	Email     string    `json:"email,omitempty"`
	Position  string    `json:"position,omitempty"`
	Language  string    `json:"language,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

CurrentUser struct for CurrentUser

type CustomMetadataApiService ¶ added in v2.21.0 

type CustomMetadataApiService service

CustomMetadataApiService CustomMetadataApi service

func (*CustomMetadataApiService) CustomMetadataPropertiesDelete ¶ added in v2.21.0 

func (a *CustomMetadataApiService) CustomMetadataPropertiesDelete(ctx _context.Context, accountId string, id string, localVarOptionals *CustomMetadataPropertiesDeleteOpts) ([]byte, *APIResponse, error)

CustomMetadataPropertiesDelete Destroy property Destroy a custom metadata property of an account. This endpoint is only available to accounts with advanced plans or above.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param optional nil or *CustomMetadataPropertiesDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*CustomMetadataApiService) CustomMetadataPropertiesList ¶ added in v2.21.0 

func (a *CustomMetadataApiService) CustomMetadataPropertiesList(ctx _context.Context, accountId string, localVarOptionals *CustomMetadataPropertiesListOpts) ([]CustomMetadataProperty, *APIResponse, error)

CustomMetadataPropertiesList List properties List all custom metadata properties for an account. This endpoint is only available to accounts with advanced plans or above.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param optional nil or *CustomMetadataPropertiesListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "DataType" (optional.Interface of CustomMetadataDataType) - Data Type of Custom Metadata Property
  • @param "ProjectId" (optional.String) - id of project that the properties belong to
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Q" (optional.String) - query to find a property by name
  • @param "Sort" (optional.String) - Sort criteria. Can be one of: name, data_type, created_at.
  • @param "Order" (optional.String) - Order direction. Can be one of: asc, desc.

@return []CustomMetadataProperty

func (*CustomMetadataApiService) CustomMetadataPropertyCreate ¶ added in v2.21.0 

func (a *CustomMetadataApiService) CustomMetadataPropertyCreate(ctx _context.Context, accountId string, customMetadataPropertiesCreateParameters CustomMetadataPropertiesCreateParameters, localVarOptionals *CustomMetadataPropertyCreateOpts) (CustomMetadataProperty, *APIResponse, error)

CustomMetadataPropertyCreate Create a property Create a new custom metadata property.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param customMetadataPropertiesCreateParameters
  • @param optional nil or *CustomMetadataPropertyCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return CustomMetadataProperty

func (*CustomMetadataApiService) CustomMetadataPropertyShow ¶ added in v2.21.0 

func (a *CustomMetadataApiService) CustomMetadataPropertyShow(ctx _context.Context, accountId string, id string, localVarOptionals *CustomMetadataPropertyShowOpts) (CustomMetadataProperty, *APIResponse, error)

CustomMetadataPropertyShow Get a single property Get details of a single custom property.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param optional nil or *CustomMetadataPropertyShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return CustomMetadataProperty

func (*CustomMetadataApiService) CustomMetadataPropertyUpdate ¶ added in v2.21.0 

func (a *CustomMetadataApiService) CustomMetadataPropertyUpdate(ctx _context.Context, accountId string, id string, customMetadataPropertiesUpdateParameters CustomMetadataPropertiesUpdateParameters, localVarOptionals *CustomMetadataPropertyUpdateOpts) (CustomMetadataProperty, *APIResponse, error)

CustomMetadataPropertyUpdate Update a property Update an existing custom metadata property.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param customMetadataPropertiesUpdateParameters
  • @param optional nil or *CustomMetadataPropertyUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return CustomMetadataProperty

type CustomMetadataDataType ¶ added in v2.21.0 

type CustomMetadataDataType string

CustomMetadataDataType data type of the property 

const (
	BOOLEAN       CustomMetadataDataType = "boolean"
	DATE          CustomMetadataDataType = "date"
	LINK          CustomMetadataDataType = "link"
	MULTI_SELECT  CustomMetadataDataType = "multi_select"
	NUMBER        CustomMetadataDataType = "number"
	SINGLE_SELECT CustomMetadataDataType = "single_select"
	STRING        CustomMetadataDataType = "string"
	TEXT          CustomMetadataDataType = "text"
)

List of custom_metadata_data_type

type CustomMetadataPropertiesCreateParameters ¶ added in v2.22.0 

type CustomMetadataPropertiesCreateParameters struct {
	// name of the property
	Name     string                 `json:"name"`
	DataType CustomMetadataDataType `json:"data_type"`
	// ids of projects that the property belongs to
	ProjectIds []string `json:"project_ids,omitempty"`
	// description of property
	Description string `json:"description,omitempty"`
	// value options of property (only applies to single or multi select properties)
	ValueOptions []string `json:"value_options,omitempty"`
}

CustomMetadataPropertiesCreateParameters struct for CustomMetadataPropertiesCreateParameters

type CustomMetadataPropertiesDeleteOpts ¶ added in v2.21.0 

type CustomMetadataPropertiesDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

CustomMetadataPropertiesDeleteOpts Optional parameters for the method 'CustomMetadataPropertiesDelete'

type CustomMetadataPropertiesListOpts ¶ added in v2.21.0 

type CustomMetadataPropertiesListOpts struct {
	XPhraseAppOTP optional.String    `json:"X-PhraseApp-OTP,omitempty"`
	DataType      optional.Interface `json:"data_type,omitempty"`
	ProjectId     optional.String    `json:"project_id,omitempty"`
	Page          optional.Int32     `json:"page,omitempty"`
	PerPage       optional.Int32     `json:"per_page,omitempty"`
	Q             optional.String    `json:"q,omitempty"`
	Sort          optional.String    `json:"sort,omitempty"`
	Order         optional.String    `json:"order,omitempty"`
}

CustomMetadataPropertiesListOpts Optional parameters for the method 'CustomMetadataPropertiesList'

type CustomMetadataPropertiesUpdateParameters ¶ added in v2.22.0 

type CustomMetadataPropertiesUpdateParameters struct {
	// name of the property
	Name string `json:"name,omitempty"`
	// ids of projects that the property belongs to
	ProjectIds []string `json:"project_ids,omitempty"`
	// description of property
	Description string `json:"description,omitempty"`
	// value options of property (only applies to single or multi select properties)
	ValueOptions []string `json:"value_options,omitempty"`
}

CustomMetadataPropertiesUpdateParameters struct for CustomMetadataPropertiesUpdateParameters

type CustomMetadataProperty ¶ added in v2.21.0 

type CustomMetadataProperty struct {
	Id           string                 `json:"id,omitempty"`
	Name         string                 `json:"name,omitempty"`
	Description  string                 `json:"description,omitempty"`
	DataType     CustomMetadataDataType `json:"data_type,omitempty"`
	User         UserPreview            `json:"user,omitempty"`
	Projects     []ProjectShort         `json:"projects,omitempty"`
	ValueOptions []string               `json:"value_options,omitempty"`
	CreatedAt    time.Time              `json:"created_at,omitempty"`
	UpdatedAt    time.Time              `json:"updated_at,omitempty"`
}

CustomMetadataProperty struct for CustomMetadataProperty

type CustomMetadataPropertyCreate422Response ¶ added in v2.21.0 

type CustomMetadataPropertyCreate422Response struct {
	Message string                                               `json:"message,omitempty"`
	Errors  []CustomMetadataPropertyCreate422ResponseErrorsInner `json:"errors,omitempty"`
}

CustomMetadataPropertyCreate422Response struct for CustomMetadataPropertyCreate422Response

type CustomMetadataPropertyCreate422ResponseErrorsInner ¶ added in v2.21.0 

type CustomMetadataPropertyCreate422ResponseErrorsInner struct {
	Resource string `json:"resource,omitempty"`
	Field    string `json:"field,omitempty"`
	Message  string `json:"message,omitempty"`
}

CustomMetadataPropertyCreate422ResponseErrorsInner struct for CustomMetadataPropertyCreate422ResponseErrorsInner

type CustomMetadataPropertyCreateOpts ¶ added in v2.21.0 

type CustomMetadataPropertyCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

CustomMetadataPropertyCreateOpts Optional parameters for the method 'CustomMetadataPropertyCreate'

type CustomMetadataPropertyShowOpts ¶ added in v2.21.0 

type CustomMetadataPropertyShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

CustomMetadataPropertyShowOpts Optional parameters for the method 'CustomMetadataPropertyShow'

type CustomMetadataPropertyUpdateOpts ¶ added in v2.21.0 

type CustomMetadataPropertyUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

CustomMetadataPropertyUpdateOpts Optional parameters for the method 'CustomMetadataPropertyUpdate'

type Distribution ¶ 

type Distribution struct {
	Id        string           `json:"id,omitempty"`
	Name      string           `json:"name,omitempty"`
	Project   ProjectShort     `json:"project,omitempty"`
	Platforms []string         `json:"platforms,omitempty"`
	Locales   []LocalePreview  `json:"locales,omitempty"`
	Releases  []ReleasePreview `json:"releases,omitempty"`
	CreatedAt time.Time        `json:"created_at,omitempty"`
	DeletedAt time.Time        `json:"deleted_at,omitempty"`
}

Distribution struct for Distribution

type DistributionCreateOpts ¶ 

type DistributionCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

DistributionCreateOpts Optional parameters for the method 'DistributionCreate'

type DistributionCreateParameters ¶ 

type DistributionCreateParameters struct {
	// Name of the distribution
	Name string `json:"name,omitempty"`
	// Project id the distribution should be assigned to.
	ProjectId string `json:"project_id,omitempty"`
	// List of platforms the distribution should support. Valid values are: * `android` * `ios` * `flutter` * `i18next` * `rails`
	Platforms []string `json:"platforms,omitempty"`
	// List of locale ids that will be part of distribution releases
	LocaleIds []string `json:"locale_ids,omitempty"`
	// Additional formatting and render options. Only <code>enclose_in_cdata</code> is available for platform <code>android</code>.
	FormatOptions map[string]string `json:"format_options,omitempty"`
	// Use fallback locale if there is no translation in the current locale.
	FallbackLocalesEnabled *bool `json:"fallback_locales_enabled,omitempty"`
	// Indicates whether to fallback to non regional locale when locale can not be found
	FallbackToNonRegionalLocale *bool `json:"fallback_to_non_regional_locale,omitempty"`
	// Indicates whether to fallback to projects default locale when locale can not be found
	FallbackToDefaultLocale *bool `json:"fallback_to_default_locale,omitempty"`
	// Use last reviewed instead of latest translation in a project
	UseLastReviewedVersion *bool `json:"use_last_reviewed_version,omitempty"`
}

DistributionCreateParameters struct for DistributionCreateParameters

type DistributionDeleteOpts ¶ 

type DistributionDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

DistributionDeleteOpts Optional parameters for the method 'DistributionDelete'

type DistributionPreview ¶ 

type DistributionPreview struct {
	Id           string       `json:"id,omitempty"`
	Name         string       `json:"name,omitempty"`
	Project      ProjectShort `json:"project,omitempty"`
	Platforms    []string     `json:"platforms,omitempty"`
	ReleaseCount int32        `json:"release_count,omitempty"`
	CreatedAt    time.Time    `json:"created_at,omitempty"`
	DeletedAt    time.Time    `json:"deleted_at,omitempty"`
}

DistributionPreview struct for DistributionPreview

type DistributionShowOpts ¶ 

type DistributionShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

DistributionShowOpts Optional parameters for the method 'DistributionShow'

type DistributionUpdateOpts ¶ 

type DistributionUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

DistributionUpdateOpts Optional parameters for the method 'DistributionUpdate'

type DistributionUpdateParameters ¶ 

type DistributionUpdateParameters struct {
	// Name of the distribution
	Name string `json:"name,omitempty"`
	// Project id the distribution should be assigned to.
	ProjectId string `json:"project_id,omitempty"`
	// List of platforms the distribution should support.
	Platforms []string `json:"platforms,omitempty"`
	// List of locale ids that will be part of distribution releases
	LocaleIds []string `json:"locale_ids,omitempty"`
	// Additional formatting and render options. Only <code>enclose_in_cdata</code> is available for platform <code>android</code>.
	FormatOptions map[string]string `json:"format_options,omitempty"`
	// Use fallback locale if there is no translation in the current locale.
	FallbackLocalesEnabled *bool `json:"fallback_locales_enabled,omitempty"`
	// Indicates whether to fallback to non regional locale when locale can not be found
	FallbackToNonRegionalLocale *bool `json:"fallback_to_non_regional_locale,omitempty"`
	// Indicates whether to fallback to projects default locale when locale can not be found
	FallbackToDefaultLocale *bool `json:"fallback_to_default_locale,omitempty"`
	// Use last reviewed instead of latest translation in a project
	UseLastReviewedVersion *bool `json:"use_last_reviewed_version,omitempty"`
}

DistributionUpdateParameters struct for DistributionUpdateParameters

type DistributionsApiService ¶ 

type DistributionsApiService service

DistributionsApiService DistributionsApi service

func (*DistributionsApiService) DistributionCreate ¶ 

func (a *DistributionsApiService) DistributionCreate(ctx _context.Context, accountId string, distributionCreateParameters DistributionCreateParameters, localVarOptionals *DistributionCreateOpts) (Distribution, *APIResponse, error)

DistributionCreate Create a distribution Create a new distribution.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param distributionCreateParameters
  • @param optional nil or *DistributionCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Distribution

func (*DistributionsApiService) DistributionDelete ¶ 

func (a *DistributionsApiService) DistributionDelete(ctx _context.Context, accountId string, id string, localVarOptionals *DistributionDeleteOpts) ([]byte, *APIResponse, error)

DistributionDelete Delete a distribution Delete an existing distribution.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param optional nil or *DistributionDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*DistributionsApiService) DistributionShow ¶ 

func (a *DistributionsApiService) DistributionShow(ctx _context.Context, accountId string, id string, localVarOptionals *DistributionShowOpts) (Distribution, *APIResponse, error)

DistributionShow Get a single distribution Get details on a single distribution.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param optional nil or *DistributionShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Distribution

func (*DistributionsApiService) DistributionUpdate ¶ 

func (a *DistributionsApiService) DistributionUpdate(ctx _context.Context, accountId string, id string, distributionUpdateParameters DistributionUpdateParameters, localVarOptionals *DistributionUpdateOpts) (Distribution, *APIResponse, error)

DistributionUpdate Update a distribution Update an existing distribution.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param distributionUpdateParameters
  • @param optional nil or *DistributionUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Distribution

func (*DistributionsApiService) DistributionsList ¶ 

func (a *DistributionsApiService) DistributionsList(ctx _context.Context, accountId string, localVarOptionals *DistributionsListOpts) ([]DistributionPreview, *APIResponse, error)

DistributionsList List distributions List all distributions for the given account.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param optional nil or *DistributionsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []DistributionPreview

type DistributionsListOpts ¶ 

type DistributionsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

DistributionsListOpts Optional parameters for the method 'DistributionsList'

type Document ¶ 

type Document struct {
	Id        string    `json:"id,omitempty"`
	Name      string    `json:"name,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

Document struct for Document

type DocumentDeleteOpts ¶ 

type DocumentDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

DocumentDeleteOpts Optional parameters for the method 'DocumentDelete'

type DocumentsApiService ¶ 

type DocumentsApiService service

DocumentsApiService DocumentsApi service

func (*DocumentsApiService) DocumentDelete ¶ 

func (a *DocumentsApiService) DocumentDelete(ctx _context.Context, projectId string, id string, localVarOptionals *DocumentDeleteOpts) ([]byte, *APIResponse, error)

DocumentDelete Delete document Delete an existing document.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *DocumentDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*DocumentsApiService) DocumentsList ¶ 

func (a *DocumentsApiService) DocumentsList(ctx _context.Context, projectId string, localVarOptionals *DocumentsListOpts) ([]Document, *APIResponse, error)

DocumentsList List documents List all documents the current user has access to.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *DocumentsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []Document

type DocumentsListOpts ¶ 

type DocumentsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

DocumentsListOpts Optional parameters for the method 'DocumentsList'

type ErrorError ¶ added in v2.23.0 

type ErrorError struct {
	Message string `json:"message,omitempty"`
	Code    string `json:"code,omitempty"`
}

ErrorError struct for ErrorError

type FigmaAttachment ¶ added in v2.15.0 

type FigmaAttachment struct {
	Id        string    `json:"id,omitempty"`
	Url       string    `json:"url,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

FigmaAttachment struct for FigmaAttachment

type FigmaAttachmentAttachToKeyOpts ¶ added in v2.15.0 

type FigmaAttachmentAttachToKeyOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

FigmaAttachmentAttachToKeyOpts Optional parameters for the method 'FigmaAttachmentAttachToKey'

type FigmaAttachmentCreateOpts ¶ added in v2.15.0 

type FigmaAttachmentCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

FigmaAttachmentCreateOpts Optional parameters for the method 'FigmaAttachmentCreate'

type FigmaAttachmentCreateParameters ¶ added in v2.15.0 

type FigmaAttachmentCreateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Figma file url
	Url string `json:"url,omitempty"`
}

FigmaAttachmentCreateParameters struct for FigmaAttachmentCreateParameters

type FigmaAttachmentDeleteOpts ¶ added in v2.15.0 

type FigmaAttachmentDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

FigmaAttachmentDeleteOpts Optional parameters for the method 'FigmaAttachmentDelete'

type FigmaAttachmentDetachFromKeyOpts ¶ added in v2.15.0 

type FigmaAttachmentDetachFromKeyOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

FigmaAttachmentDetachFromKeyOpts Optional parameters for the method 'FigmaAttachmentDetachFromKey'

type FigmaAttachmentShowOpts ¶ added in v2.15.0 

type FigmaAttachmentShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

FigmaAttachmentShowOpts Optional parameters for the method 'FigmaAttachmentShow'

type FigmaAttachmentUpdateOpts ¶ added in v2.15.0 

type FigmaAttachmentUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

FigmaAttachmentUpdateOpts Optional parameters for the method 'FigmaAttachmentUpdate'

type FigmaAttachmentUpdateParameters ¶ added in v2.15.0 

type FigmaAttachmentUpdateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Figma file url
	Url string `json:"url,omitempty"`
}

FigmaAttachmentUpdateParameters struct for FigmaAttachmentUpdateParameters

type FigmaAttachmentsApiService ¶ added in v2.15.0 

type FigmaAttachmentsApiService service

FigmaAttachmentsApiService FigmaAttachmentsApi service

func (*FigmaAttachmentsApiService) FigmaAttachmentCreate ¶ added in v2.15.0 

func (a *FigmaAttachmentsApiService) FigmaAttachmentCreate(ctx _context.Context, projectId string, figmaAttachmentCreateParameters FigmaAttachmentCreateParameters, localVarOptionals *FigmaAttachmentCreateOpts) (FigmaAttachment, *APIResponse, error)

FigmaAttachmentCreate Create a Figma attachment Create a new Figma attachment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param figmaAttachmentCreateParameters
  • @param optional nil or *FigmaAttachmentCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return FigmaAttachment

func (*FigmaAttachmentsApiService) FigmaAttachmentDelete ¶ added in v2.15.0 

func (a *FigmaAttachmentsApiService) FigmaAttachmentDelete(ctx _context.Context, projectId string, id string, localVarOptionals *FigmaAttachmentDeleteOpts) ([]byte, *APIResponse, error)

FigmaAttachmentDelete Delete a Figma attachment Delete an existing Figma attachment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *FigmaAttachmentDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*FigmaAttachmentsApiService) FigmaAttachmentShow ¶ added in v2.15.0 

func (a *FigmaAttachmentsApiService) FigmaAttachmentShow(ctx _context.Context, projectId string, id string, localVarOptionals *FigmaAttachmentShowOpts) (FigmaAttachment, *APIResponse, error)

FigmaAttachmentShow Get a single Figma attachment Get details on a single Figma attachment for a given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *FigmaAttachmentShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return FigmaAttachment

func (*FigmaAttachmentsApiService) FigmaAttachmentUpdate ¶ added in v2.15.0 

func (a *FigmaAttachmentsApiService) FigmaAttachmentUpdate(ctx _context.Context, projectId string, id string, figmaAttachmentUpdateParameters FigmaAttachmentUpdateParameters, localVarOptionals *FigmaAttachmentUpdateOpts) (FigmaAttachment, *APIResponse, error)

FigmaAttachmentUpdate Update a Figma attachment Update an existing Figma attachment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param figmaAttachmentUpdateParameters
  • @param optional nil or *FigmaAttachmentUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return FigmaAttachment

func (*FigmaAttachmentsApiService) FigmaAttachmentsList ¶ added in v2.15.0 

func (a *FigmaAttachmentsApiService) FigmaAttachmentsList(ctx _context.Context, projectId string, localVarOptionals *FigmaAttachmentsListOpts) ([]FigmaAttachment, *APIResponse, error)

FigmaAttachmentsList List Figma attachments List all Figma attachments for the given project

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *FigmaAttachmentsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use

@return []FigmaAttachment

type FigmaAttachmentsListOpts ¶ added in v2.15.0 

type FigmaAttachmentsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

FigmaAttachmentsListOpts Optional parameters for the method 'FigmaAttachmentsList'

type Format ¶ 

type Format struct {
	Name                      string `json:"name,omitempty"`
	ApiName                   string `json:"api_name,omitempty"`
	Description               string `json:"description,omitempty"`
	Extension                 string `json:"extension,omitempty"`
	DefaultEncoding           string `json:"default_encoding,omitempty"`
	Importable                *bool  `json:"importable,omitempty"`
	Exportable                *bool  `json:"exportable,omitempty"`
	DefaultFile               string `json:"default_file,omitempty"`
	RendersDefaultLocale      *bool  `json:"renders_default_locale,omitempty"`
	IncludesLocaleInformation *bool  `json:"includes_locale_information,omitempty"`
}

Format struct for Format

type FormatsApiService ¶ 

type FormatsApiService service

FormatsApiService FormatsApi service

func (*FormatsApiService) FormatsList ¶ 

func (a *FormatsApiService) FormatsList(ctx _context.Context, localVarOptionals *FormatsListOpts) ([]Format, *APIResponse, error)

FormatsList List formats Get a handy list of all localization file formats supported in Phrase.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *FormatsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return []Format

type FormatsListOpts ¶ 

type FormatsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

FormatsListOpts Optional parameters for the method 'FormatsList'

type GenericOpenAPIError ¶ 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body ¶ 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error ¶ 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model ¶ 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type GitHubSyncApiService ¶ 

type GitHubSyncApiService service

GitHubSyncApiService GitHubSyncApi service

func (*GitHubSyncApiService) GithubSyncExport ¶ 

func (a *GitHubSyncApiService) GithubSyncExport(ctx _context.Context, githubSyncExportParameters GithubSyncExportParameters, localVarOptionals *GithubSyncExportOpts) ([]byte, *APIResponse, error)

GithubSyncExport Export from Phrase Strings to GitHub Export translations from Phrase Strings to GitHub according to the .phraseapp.yml file within the GitHub repository. &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Export is done asynchronously and may take several seconds depending on the project size.&lt;/i&gt;

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param githubSyncExportParameters
  • @param optional nil or *GithubSyncExportOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*GitHubSyncApiService) GithubSyncImport ¶ 

func (a *GitHubSyncApiService) GithubSyncImport(ctx _context.Context, githubSyncImportParameters GithubSyncImportParameters, localVarOptionals *GithubSyncImportOpts) ([]byte, *APIResponse, error)

GithubSyncImport Import to Phrase Strings from GitHub Import files to Phrase Strings from your connected GitHub repository. &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Import is done asynchronously and may take several seconds depending on the project size.&lt;/i&gt;

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param githubSyncImportParameters
  • @param optional nil or *GithubSyncImportOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

type GitLabSyncApiService ¶ 

type GitLabSyncApiService service

GitLabSyncApiService GitLabSyncApi service

func (*GitLabSyncApiService) GitlabSyncDelete ¶ 

func (a *GitLabSyncApiService) GitlabSyncDelete(ctx _context.Context, id string, localVarOptionals *GitlabSyncDeleteOpts) ([]byte, *APIResponse, error)

GitlabSyncDelete Delete single Sync Setting Deletes a single GitLab Sync Setting.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID
  • @param optional nil or *GitlabSyncDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "AccountId" (optional.String) - Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.

func (*GitLabSyncApiService) GitlabSyncExport ¶ 

func (a *GitLabSyncApiService) GitlabSyncExport(ctx _context.Context, gitlabSyncId string, gitlabSyncExportParameters GitlabSyncExportParameters, localVarOptionals *GitlabSyncExportOpts) (GitlabSyncExport, *APIResponse, error)

GitlabSyncExport Export from Phrase Strings to GitLab Export translations from Phrase Strings to GitLab according to the .phraseapp.yml file within the GitLab repository. &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Export is done asynchronously and may take several seconds depending on the project size.&lt;/i&gt;

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param gitlabSyncId Gitlab Sync ID
  • @param gitlabSyncExportParameters
  • @param optional nil or *GitlabSyncExportOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return GitlabSyncExport

func (*GitLabSyncApiService) GitlabSyncHistory ¶ 

func (a *GitLabSyncApiService) GitlabSyncHistory(ctx _context.Context, gitlabSyncId string, localVarOptionals *GitlabSyncHistoryOpts) ([]GitlabSyncHistory, *APIResponse, error)

GitlabSyncHistory History of single Sync Setting List history for a single Sync Setting.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param gitlabSyncId Gitlab Sync ID
  • @param optional nil or *GitlabSyncHistoryOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "AccountId" (optional.String) - Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.

@return []GitlabSyncHistory

func (*GitLabSyncApiService) GitlabSyncImport ¶ 

func (a *GitLabSyncApiService) GitlabSyncImport(ctx _context.Context, gitlabSyncId string, gitlabSyncImportParameters GitlabSyncImportParameters, localVarOptionals *GitlabSyncImportOpts) ([]Upload, *APIResponse, error)

GitlabSyncImport Import from GitLab to Phrase Import translations from GitLab to Phrase Strings according to the .phraseapp.yml file within the GitLab repository. &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Import is done asynchronously and may take several seconds depending on the project size.&lt;/i&gt;

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param gitlabSyncId Gitlab Sync ID
  • @param gitlabSyncImportParameters
  • @param optional nil or *GitlabSyncImportOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return []Upload

func (*GitLabSyncApiService) GitlabSyncList ¶ 

func (a *GitLabSyncApiService) GitlabSyncList(ctx _context.Context, localVarOptionals *GitlabSyncListOpts) ([]GitlabSync, *APIResponse, error)

GitlabSyncList List GitLab syncs List all GitLab Sync Settings for which synchronisation with Phrase Strings and GitLab is activated.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *GitlabSyncListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "AccountId" (optional.String) - Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.

@return []GitlabSync

func (*GitLabSyncApiService) GitlabSyncShow ¶ 

func (a *GitLabSyncApiService) GitlabSyncShow(ctx _context.Context, id string, localVarOptionals *GitlabSyncShowOpts) (GitlabSync, *APIResponse, error)

GitlabSyncShow Get single Sync Setting Shows a single GitLab Sync Setting.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID
  • @param optional nil or *GitlabSyncShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "AccountId" (optional.String) - Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.

@return GitlabSync

func (*GitLabSyncApiService) GitlabSyncUpdate ¶ 

func (a *GitLabSyncApiService) GitlabSyncUpdate(ctx _context.Context, id string, localVarOptionals *GitlabSyncUpdateOpts) (GitlabSync, *APIResponse, error)

GitlabSyncUpdate Update single Sync Setting Updates a single GitLab Sync Setting.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID
  • @param optional nil or *GitlabSyncUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "AccountId" (optional.String) - Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.
  • @param "PhraseProjectCode" (optional.String) - Code of the related Phrase Strings Project.
  • @param "GitlabProjectId" (optional.Int32) - ID of the related GitLab Project.
  • @param "GitlabBranchName" (optional.String) - Name of the GitLab Branch.

@return GitlabSync

type GithubSyncExportOpts ¶ 

type GithubSyncExportOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

GithubSyncExportOpts Optional parameters for the method 'GithubSyncExport'

type GithubSyncExportParameters ¶ 

type GithubSyncExportParameters struct {
	// Project ID to specify the actual project the GitHub export should be triggered in.
	ProjectId string `json:"project_id,omitempty"`
}

GithubSyncExportParameters struct for GithubSyncExportParameters

type GithubSyncImportOpts ¶ 

type GithubSyncImportOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

GithubSyncImportOpts Optional parameters for the method 'GithubSyncImport'

type GithubSyncImportParameters ¶ 

type GithubSyncImportParameters struct {
	// Project ID to specify the actual project the GitHub import should be triggered in.
	ProjectId string `json:"project_id,omitempty"`
}

GithubSyncImportParameters struct for GithubSyncImportParameters

type GitlabSync ¶ 

type GitlabSync struct {
	Id               string    `json:"id,omitempty"`
	ProjectId        string    `json:"project_id,omitempty"`
	GitlabProjectId  int32     `json:"gitlab_project_id,omitempty"`
	GitlabBranchName string    `json:"gitlab_branch_name,omitempty"`
	AutoImport       *bool     `json:"auto_import,omitempty"`
	AutoImportSecret string    `json:"auto_import_secret,omitempty"`
	AutoImportUrl    string    `json:"auto_import_url,omitempty"`
	SelfHostedApiUrl string    `json:"self_hosted_api_url,omitempty"`
	LastExportedAt   time.Time `json:"last_exported_at,omitempty"`
	LastImportedAt   time.Time `json:"last_imported_at,omitempty"`
	LastStatus       string    `json:"last_status,omitempty"`
}

GitlabSync struct for GitlabSync

type GitlabSyncDeleteOpts ¶ 

type GitlabSyncDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	AccountId     optional.String `json:"account_id,omitempty"`
}

GitlabSyncDeleteOpts Optional parameters for the method 'GitlabSyncDelete'

type GitlabSyncExport ¶ 

type GitlabSyncExport struct {
	MergeRequestId     int32  `json:"merge_request_id,omitempty"`
	MergeRequestWebUrl string `json:"merge_request_web_url,omitempty"`
}

GitlabSyncExport struct for GitlabSyncExport

type GitlabSyncExportOpts ¶ 

type GitlabSyncExportOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

GitlabSyncExportOpts Optional parameters for the method 'GitlabSyncExport'

type GitlabSyncExportParameters ¶ 

type GitlabSyncExportParameters struct {
	// Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.
	AccountId string `json:"account_id,omitempty"`
}

GitlabSyncExportParameters struct for GitlabSyncExportParameters

type GitlabSyncHistory ¶ 

type GitlabSyncHistory struct {
	Status  string                         `json:"status,omitempty"`
	Action  string                         `json:"action,omitempty"`
	Errors  []GitlabSyncHistoryErrorsInner `json:"errors,omitempty"`
	Date    time.Time                      `json:"date,omitempty"`
	Details map[string]interface{}         `json:"details,omitempty"`
}

GitlabSyncHistory struct for GitlabSyncHistory

type GitlabSyncHistoryErrorsInner ¶ added in v2.17.0 

type GitlabSyncHistoryErrorsInner struct {
	Error   string `json:"error,omitempty"`
	Message string `json:"message,omitempty"`
}

GitlabSyncHistoryErrorsInner struct for GitlabSyncHistoryErrorsInner

type GitlabSyncHistoryOpts ¶ 

type GitlabSyncHistoryOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	AccountId     optional.String `json:"account_id,omitempty"`
}

GitlabSyncHistoryOpts Optional parameters for the method 'GitlabSyncHistory'

type GitlabSyncImportOpts ¶ 

type GitlabSyncImportOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

GitlabSyncImportOpts Optional parameters for the method 'GitlabSyncImport'

type GitlabSyncImportParameters ¶ 

type GitlabSyncImportParameters struct {
	// Account ID to specify the actual account the GitLab Sync should be created in. Required if the requesting user is a member of multiple accounts.
	AccountId string `json:"account_id,omitempty"`
}

GitlabSyncImportParameters struct for GitlabSyncImportParameters

type GitlabSyncListOpts ¶ 

type GitlabSyncListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	AccountId     optional.String `json:"account_id,omitempty"`
}

GitlabSyncListOpts Optional parameters for the method 'GitlabSyncList'

type GitlabSyncShowOpts ¶ 

type GitlabSyncShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	AccountId     optional.String `json:"account_id,omitempty"`
}

GitlabSyncShowOpts Optional parameters for the method 'GitlabSyncShow'

type GitlabSyncUpdateOpts ¶ 

type GitlabSyncUpdateOpts struct {
	XPhraseAppOTP     optional.String `json:"X-PhraseApp-OTP,omitempty"`
	AccountId         optional.String `json:"account_id,omitempty"`
	PhraseProjectCode optional.String `json:"phrase_project_code,omitempty"`
	GitlabProjectId   optional.Int32  `json:"gitlab_project_id,omitempty"`
	GitlabBranchName  optional.String `json:"gitlab_branch_name,omitempty"`
}

GitlabSyncUpdateOpts Optional parameters for the method 'GitlabSyncUpdate'

type GlossariesApiService ¶ 

type GlossariesApiService service

GlossariesApiService GlossariesApi service

func (*GlossariesApiService) GlossariesList ¶ 

func (a *GlossariesApiService) GlossariesList(ctx _context.Context, accountId string, localVarOptionals *GlossariesListOpts) ([]Glossary, *APIResponse, error)

GlossariesList List term bases List all term bases (previously: glossaries) the current user has access to.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param optional nil or *GlossariesListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []Glossary

func (*GlossariesApiService) GlossaryCreate ¶ 

func (a *GlossariesApiService) GlossaryCreate(ctx _context.Context, accountId string, glossaryCreateParameters GlossaryCreateParameters, localVarOptionals *GlossaryCreateOpts) (Glossary, *APIResponse, error)

GlossaryCreate Create a term base Create a new term base (previously: glossary).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param glossaryCreateParameters
  • @param optional nil or *GlossaryCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Glossary

func (*GlossariesApiService) GlossaryDelete ¶ 

func (a *GlossariesApiService) GlossaryDelete(ctx _context.Context, accountId string, id string, localVarOptionals *GlossaryDeleteOpts) ([]byte, *APIResponse, error)

GlossaryDelete Delete a term base Delete an existing term base (previously: glossary).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param optional nil or *GlossaryDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*GlossariesApiService) GlossaryShow ¶ 

func (a *GlossariesApiService) GlossaryShow(ctx _context.Context, accountId string, id string, localVarOptionals *GlossaryShowOpts) (Glossary, *APIResponse, error)

GlossaryShow Get a single term base Get details on a single term base (previously: glossary).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param optional nil or *GlossaryShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Glossary

func (*GlossariesApiService) GlossaryUpdate ¶ 

func (a *GlossariesApiService) GlossaryUpdate(ctx _context.Context, accountId string, id string, glossaryUpdateParameters GlossaryUpdateParameters, localVarOptionals *GlossaryUpdateOpts) (Glossary, *APIResponse, error)

GlossaryUpdate Update a term base Update an existing term base (previously: glossary).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param glossaryUpdateParameters
  • @param optional nil or *GlossaryUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Glossary

type GlossariesListOpts ¶ 

type GlossariesListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

GlossariesListOpts Optional parameters for the method 'GlossariesList'

type Glossary ¶ 

type Glossary struct {
	Id        string         `json:"id,omitempty"`
	Name      string         `json:"name,omitempty"`
	Projects  []ProjectShort `json:"projects,omitempty"`
	CreatedAt time.Time      `json:"created_at,omitempty"`
	UpdatedAt time.Time      `json:"updated_at,omitempty"`
}

Glossary struct for Glossary

type GlossaryCreateOpts ¶ 

type GlossaryCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

GlossaryCreateOpts Optional parameters for the method 'GlossaryCreate'

type GlossaryCreateParameters ¶ 

type GlossaryCreateParameters struct {
	// Name of the glossary
	Name string `json:"name,omitempty"`
	// List of project ids the glossary should be assigned to.
	ProjectIds string `json:"project_ids,omitempty"`
	// List of space ids the glossary should be assigned to.
	SpaceIds []string `json:"space_ids,omitempty"`
}

GlossaryCreateParameters struct for GlossaryCreateParameters

type GlossaryDeleteOpts ¶ 

type GlossaryDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

GlossaryDeleteOpts Optional parameters for the method 'GlossaryDelete'

type GlossaryShowOpts ¶ 

type GlossaryShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

GlossaryShowOpts Optional parameters for the method 'GlossaryShow'

type GlossaryTerm ¶ 

type GlossaryTerm struct {
	Id            string                    `json:"id,omitempty"`
	Term          string                    `json:"term,omitempty"`
	Description   string                    `json:"description,omitempty"`
	Translatable  *bool                     `json:"translatable,omitempty"`
	CaseSensitive *bool                     `json:"case_sensitive,omitempty"`
	Translations  []GlossaryTermTranslation `json:"translations,omitempty"`
	CreatedAt     time.Time                 `json:"created_at,omitempty"`
	UpdatedAt     time.Time                 `json:"updated_at,omitempty"`
}

GlossaryTerm struct for GlossaryTerm

type GlossaryTermCreateOpts ¶ 

type GlossaryTermCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

GlossaryTermCreateOpts Optional parameters for the method 'GlossaryTermCreate'

type GlossaryTermCreateParameters ¶ 

type GlossaryTermCreateParameters struct {
	// Glossary term
	Term string `json:"term,omitempty"`
	// Description of term
	Description string `json:"description,omitempty"`
	// Indicates whether the term should be used for all languages or can be translated
	Translatable *bool `json:"translatable,omitempty"`
	// Indicates whether the term is case sensitive
	CaseSensitive *bool `json:"case_sensitive,omitempty"`
}

GlossaryTermCreateParameters struct for GlossaryTermCreateParameters

type GlossaryTermDeleteOpts ¶ 

type GlossaryTermDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

GlossaryTermDeleteOpts Optional parameters for the method 'GlossaryTermDelete'

type GlossaryTermShowOpts ¶ 

type GlossaryTermShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

GlossaryTermShowOpts Optional parameters for the method 'GlossaryTermShow'

type GlossaryTermTranslation ¶ 

type GlossaryTermTranslation struct {
	Id         string    `json:"id,omitempty"`
	LocaleCode string    `json:"locale_code,omitempty"`
	Content    string    `json:"content,omitempty"`
	CreatedAt  time.Time `json:"created_at,omitempty"`
	UpdatedAt  time.Time `json:"updated_at,omitempty"`
}

GlossaryTermTranslation struct for GlossaryTermTranslation

type GlossaryTermTranslationCreateOpts ¶ 

type GlossaryTermTranslationCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

GlossaryTermTranslationCreateOpts Optional parameters for the method 'GlossaryTermTranslationCreate'

type GlossaryTermTranslationCreateParameters ¶ 

type GlossaryTermTranslationCreateParameters struct {
	// Identifies the language for this translation
	LocaleCode string `json:"locale_code,omitempty"`
	// The content of the translation
	Content string `json:"content,omitempty"`
}

GlossaryTermTranslationCreateParameters struct for GlossaryTermTranslationCreateParameters

type GlossaryTermTranslationDeleteOpts ¶ 

type GlossaryTermTranslationDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

GlossaryTermTranslationDeleteOpts Optional parameters for the method 'GlossaryTermTranslationDelete'

type GlossaryTermTranslationUpdateOpts ¶ 

type GlossaryTermTranslationUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

GlossaryTermTranslationUpdateOpts Optional parameters for the method 'GlossaryTermTranslationUpdate'

type GlossaryTermTranslationUpdateParameters ¶ 

type GlossaryTermTranslationUpdateParameters struct {
	// Identifies the language for this translation
	LocaleCode string `json:"locale_code,omitempty"`
	// The content of the translation
	Content string `json:"content,omitempty"`
}

GlossaryTermTranslationUpdateParameters struct for GlossaryTermTranslationUpdateParameters

type GlossaryTermTranslationsApiService ¶ 

type GlossaryTermTranslationsApiService service

GlossaryTermTranslationsApiService GlossaryTermTranslationsApi service

func (*GlossaryTermTranslationsApiService) GlossaryTermTranslationCreate ¶ 

func (a *GlossaryTermTranslationsApiService) GlossaryTermTranslationCreate(ctx _context.Context, accountId string, glossaryId string, termId string, glossaryTermTranslationCreateParameters GlossaryTermTranslationCreateParameters, localVarOptionals *GlossaryTermTranslationCreateOpts) (GlossaryTermTranslation, *APIResponse, error)

GlossaryTermTranslationCreate Create a translation for a term Create a new translation for a term in a term base (previously: glossary).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param glossaryId Glossary ID
  • @param termId Term ID
  • @param glossaryTermTranslationCreateParameters
  • @param optional nil or *GlossaryTermTranslationCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return GlossaryTermTranslation

func (*GlossaryTermTranslationsApiService) GlossaryTermTranslationDelete ¶ 

func (a *GlossaryTermTranslationsApiService) GlossaryTermTranslationDelete(ctx _context.Context, accountId string, glossaryId string, termId string, id string, localVarOptionals *GlossaryTermTranslationDeleteOpts) ([]byte, *APIResponse, error)

GlossaryTermTranslationDelete Delete a translation for a term Delete an existing translation of a term in a term base (previously: glossary).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param glossaryId Glossary ID
  • @param termId Term ID
  • @param id ID
  • @param optional nil or *GlossaryTermTranslationDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*GlossaryTermTranslationsApiService) GlossaryTermTranslationUpdate ¶ 

func (a *GlossaryTermTranslationsApiService) GlossaryTermTranslationUpdate(ctx _context.Context, accountId string, glossaryId string, termId string, id string, glossaryTermTranslationUpdateParameters GlossaryTermTranslationUpdateParameters, localVarOptionals *GlossaryTermTranslationUpdateOpts) (GlossaryTermTranslation, *APIResponse, error)

GlossaryTermTranslationUpdate Update a translation for a term Update an existing translation for a term in a term base (previously: glossary).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param glossaryId Glossary ID
  • @param termId Term ID
  • @param id ID
  • @param glossaryTermTranslationUpdateParameters
  • @param optional nil or *GlossaryTermTranslationUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return GlossaryTermTranslation

type GlossaryTermUpdateOpts ¶ 

type GlossaryTermUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

GlossaryTermUpdateOpts Optional parameters for the method 'GlossaryTermUpdate'

type GlossaryTermUpdateParameters ¶ 

type GlossaryTermUpdateParameters struct {
	// Glossary term
	Term string `json:"term,omitempty"`
	// Description of term
	Description string `json:"description,omitempty"`
	// Indicates whether the term should be used for all languages or can be translated
	Translatable *bool `json:"translatable,omitempty"`
	// Indicates whether the term is case sensitive
	CaseSensitive *bool `json:"case_sensitive,omitempty"`
}

GlossaryTermUpdateParameters struct for GlossaryTermUpdateParameters

type GlossaryTermsApiService ¶ 

type GlossaryTermsApiService service

GlossaryTermsApiService GlossaryTermsApi service

func (*GlossaryTermsApiService) GlossaryTermCreate ¶ 

func (a *GlossaryTermsApiService) GlossaryTermCreate(ctx _context.Context, accountId string, glossaryId string, glossaryTermCreateParameters GlossaryTermCreateParameters, localVarOptionals *GlossaryTermCreateOpts) (GlossaryTerm, *APIResponse, error)

GlossaryTermCreate Create a term Create a new term in a term base (previously: glossary).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param glossaryId Glossary ID
  • @param glossaryTermCreateParameters
  • @param optional nil or *GlossaryTermCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return GlossaryTerm

func (*GlossaryTermsApiService) GlossaryTermDelete ¶ 

func (a *GlossaryTermsApiService) GlossaryTermDelete(ctx _context.Context, accountId string, glossaryId string, id string, localVarOptionals *GlossaryTermDeleteOpts) ([]byte, *APIResponse, error)

GlossaryTermDelete Delete a term Delete an existing term in a term base (previously: glossary).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param glossaryId Glossary ID
  • @param id ID
  • @param optional nil or *GlossaryTermDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*GlossaryTermsApiService) GlossaryTermShow ¶ 

func (a *GlossaryTermsApiService) GlossaryTermShow(ctx _context.Context, accountId string, glossaryId string, id string, localVarOptionals *GlossaryTermShowOpts) (GlossaryTerm, *APIResponse, error)

GlossaryTermShow Get a single term Get details for a single term in the term base (previously: glossary).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param glossaryId Glossary ID
  • @param id ID
  • @param optional nil or *GlossaryTermShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return GlossaryTerm

func (*GlossaryTermsApiService) GlossaryTermUpdate ¶ 

func (a *GlossaryTermsApiService) GlossaryTermUpdate(ctx _context.Context, accountId string, glossaryId string, id string, glossaryTermUpdateParameters GlossaryTermUpdateParameters, localVarOptionals *GlossaryTermUpdateOpts) (GlossaryTerm, *APIResponse, error)

GlossaryTermUpdate Update a term Update an existing term in a term base (previously: glossary).

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param glossaryId Glossary ID
  • @param id ID
  • @param glossaryTermUpdateParameters
  • @param optional nil or *GlossaryTermUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return GlossaryTerm

func (*GlossaryTermsApiService) GlossaryTermsList ¶ 

func (a *GlossaryTermsApiService) GlossaryTermsList(ctx _context.Context, accountId string, glossaryId string, localVarOptionals *GlossaryTermsListOpts) ([]GlossaryTerm, *APIResponse, error)

GlossaryTermsList List terms List all terms in term bases (previously: glossary) that the current user has access to.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param glossaryId Glossary ID
  • @param optional nil or *GlossaryTermsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []GlossaryTerm

type GlossaryTermsListOpts ¶ 

type GlossaryTermsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

GlossaryTermsListOpts Optional parameters for the method 'GlossaryTermsList'

type GlossaryUpdateOpts ¶ 

type GlossaryUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

GlossaryUpdateOpts Optional parameters for the method 'GlossaryUpdate'

type GlossaryUpdateParameters ¶ 

type GlossaryUpdateParameters struct {
	// Name of the glossary
	Name string `json:"name,omitempty"`
	// List of project ids the glossary should be assigned to.
	ProjectIds string `json:"project_ids,omitempty"`
	// List of space ids the glossary should be assigned to.
	SpaceIds []string `json:"space_ids,omitempty"`
}

GlossaryUpdateParameters struct for GlossaryUpdateParameters

type ICUApiService ¶ added in v2.3.0 

type ICUApiService service

ICUApiService ICUApi service

func (*ICUApiService) IcuSkeleton ¶ added in v2.3.0 

func (a *ICUApiService) IcuSkeleton(ctx _context.Context, icuSkeletonParameters IcuSkeletonParameters, localVarOptionals *IcuSkeletonOpts) (Icu, *APIResponse, error)

IcuSkeleton Build icu skeletons Returns icu skeletons for multiple locale codes based on a source content.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param icuSkeletonParameters
  • @param optional nil or *IcuSkeletonOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Icu

type Icu ¶ added in v2.3.0 

type Icu struct {
	// Object keys are dynamic and based on requested locale codes, see example.
	LocaleCode string `json:"locale_code,omitempty"`
}

Icu struct for Icu

type IcuSkeletonOpts ¶ added in v2.3.0 

type IcuSkeletonOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

IcuSkeletonOpts Optional parameters for the method 'IcuSkeleton'

type IcuSkeletonParameters ¶ added in v2.3.0 

type IcuSkeletonParameters struct {
	// Source content
	Content string `json:"content,omitempty"`
	// Locale codes
	LocaleCodes []string `json:"locale_codes,omitempty"`
	// Keep the content and add missing plural forms for each locale
	KeepContent *bool `json:"keep_content,omitempty"`
	// Indicates whether the zero form should be included or excluded in the returned skeletons
	ZeroFormEnabled *bool `json:"zero_form_enabled,omitempty"`
	// Strings supports two CLDR variants, when it comes to pluralization rules. \\ You can choose which one you want to use when constructing the skeletons. Possible values \\ are `legacy` and `cldr_41`. Default value is `legacy`.
	CldrVersion string `json:"cldr_version,omitempty"`
}

IcuSkeletonParameters struct for IcuSkeletonParameters

type Invitation ¶ 

type Invitation struct {
	Id                 string                                 `json:"id,omitempty"`
	Email              string                                 `json:"email,omitempty"`
	Role               string                                 `json:"role,omitempty"`
	State              string                                 `json:"state,omitempty"`
	Projects           []ProjectShort                         `json:"projects,omitempty"`
	Locales            []LocalePreview                        `json:"locales,omitempty"`
	Teams              []TeamShort                            `json:"teams,omitempty"`
	DefaultLocaleCodes []string                               `json:"default_locale_codes,omitempty"`
	Permissions        map[string]interface{}                 `json:"permissions,omitempty"`
	LocaleIds          []string                               `json:"locale_ids,omitempty"`
	CreatedAt          time.Time                              `json:"created_at,omitempty"`
	UpdatedAt          time.Time                              `json:"updated_at,omitempty"`
	AcceptedAt         time.Time                              `json:"accepted_at,omitempty"`
	Spaces             []Space                                `json:"spaces,omitempty"`
	ProjectRole        []MemberProjectDetailProjectRolesInner `json:"project_role,omitempty"`
}

Invitation struct for Invitation

type InvitationCreateOpts ¶ 

type InvitationCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

InvitationCreateOpts Optional parameters for the method 'InvitationCreate'

type InvitationCreateParameters ¶ 

type InvitationCreateParameters struct {
	// The email of the invited user. The <code>email</code> can not be updated once created. Create a new invitation for each unique email.
	Email string `json:"email,omitempty"`
	// Invitiation role, can be any of Manager, Developer, Translator.
	Role string `json:"role,omitempty"`
	// List of project ids the invited user has access to.
	ProjectIds string `json:"project_ids,omitempty"`
	// List of locale ids the invited user has access to.
	LocaleIds string `json:"locale_ids,omitempty"`
	// List of spaces the user is assigned to.
	SpaceIds []string `json:"space_ids,omitempty"`
	// List of teams the user is assigned to.
	TeamIds []string `json:"team_ids,omitempty"`
	// List of default locales for the user.
	DefaultLocaleCodes []string `json:"default_locale_codes,omitempty"`
	// Additional permissions depending on invitation role. Available permissions are <code>create_upload</code> and <code>review_translations</code>
	Permissions map[string]string `json:"permissions,omitempty"`
}

InvitationCreateParameters struct for InvitationCreateParameters

type InvitationDeleteOpts ¶ 

type InvitationDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

InvitationDeleteOpts Optional parameters for the method 'InvitationDelete'

type InvitationResendOpts ¶ 

type InvitationResendOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

InvitationResendOpts Optional parameters for the method 'InvitationResend'

type InvitationShowOpts ¶ 

type InvitationShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

InvitationShowOpts Optional parameters for the method 'InvitationShow'

type InvitationUpdateOpts ¶ 

type InvitationUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

InvitationUpdateOpts Optional parameters for the method 'InvitationUpdate'

type InvitationUpdateParameters ¶ 

type InvitationUpdateParameters struct {
	// Invitiation role, can be any of Manager, Developer, Translator
	Role string `json:"role,omitempty"`
	// List of project ids the invited user has access to
	ProjectIds string `json:"project_ids,omitempty"`
	// List of locale ids the invited user has access to
	LocaleIds string `json:"locale_ids,omitempty"`
	// List of spaces the user is assigned to.
	SpaceIds []string `json:"space_ids,omitempty"`
	// List of teams the user is assigned to.
	TeamIds []string `json:"team_ids,omitempty"`
	// List of default locales for the user.
	DefaultLocaleCodes []string `json:"default_locale_codes,omitempty"`
	// Additional permissions depending on invitation role.
	Permissions map[string]string `json:"permissions,omitempty"`
}

InvitationUpdateParameters struct for InvitationUpdateParameters

type InvitationUpdateSettingsOpts ¶ 

type InvitationUpdateSettingsOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

InvitationUpdateSettingsOpts Optional parameters for the method 'InvitationUpdateSettings'

type InvitationUpdateSettingsParameters ¶ 

type InvitationUpdateSettingsParameters struct {
	// Member role, can be any of of Manager, Developer, Translator
	ProjectRole string `json:"project_role,omitempty"`
	// List of locale ids the user has access to.
	LocaleIds []string `json:"locale_ids,omitempty"`
}

InvitationUpdateSettingsParameters struct for InvitationUpdateSettingsParameters

type InvitationsApiService ¶ 

type InvitationsApiService service

InvitationsApiService InvitationsApi service

func (*InvitationsApiService) InvitationCreate ¶ 

func (a *InvitationsApiService) InvitationCreate(ctx _context.Context, accountId string, invitationCreateParameters InvitationCreateParameters, localVarOptionals *InvitationCreateOpts) (Invitation, *APIResponse, error)

InvitationCreate Create a new invitation Invite a person to an account. Developers and translators need &lt;code&gt;project_ids&lt;/code&gt; and &lt;code&gt;locale_ids&lt;/code&gt; assigned to access them. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param invitationCreateParameters
  • @param optional nil or *InvitationCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Invitation

func (*InvitationsApiService) InvitationDelete ¶ 

func (a *InvitationsApiService) InvitationDelete(ctx _context.Context, accountId string, id string, localVarOptionals *InvitationDeleteOpts) ([]byte, *APIResponse, error)

InvitationDelete Delete an invitation Delete an existing invitation (must not be accepted yet). Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param optional nil or *InvitationDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*InvitationsApiService) InvitationResend ¶ 

func (a *InvitationsApiService) InvitationResend(ctx _context.Context, accountId string, id string, localVarOptionals *InvitationResendOpts) (Invitation, *APIResponse, error)

InvitationResend Resend an invitation Resend the invitation email (must not be accepted yet). Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param optional nil or *InvitationResendOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Invitation

func (*InvitationsApiService) InvitationShow ¶ 

func (a *InvitationsApiService) InvitationShow(ctx _context.Context, accountId string, id string, localVarOptionals *InvitationShowOpts) (Invitation, *APIResponse, error)

InvitationShow Get a single invitation Get details on a single invitation. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param optional nil or *InvitationShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Invitation

func (*InvitationsApiService) InvitationUpdate ¶ 

func (a *InvitationsApiService) InvitationUpdate(ctx _context.Context, accountId string, id string, invitationUpdateParameters InvitationUpdateParameters, localVarOptionals *InvitationUpdateOpts) (Invitation, *APIResponse, error)

InvitationUpdate Update an invitation Update an existing invitation (must not be accepted yet). The &lt;code&gt;email&lt;/code&gt; cannot be updated. Developers and translators need &lt;code&gt;project_ids&lt;/code&gt; and &lt;code&gt;locale_ids&lt;/code&gt; assigned to access them. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param invitationUpdateParameters
  • @param optional nil or *InvitationUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Invitation

func (*InvitationsApiService) InvitationUpdateSettings ¶ 

func (a *InvitationsApiService) InvitationUpdateSettings(ctx _context.Context, projectId string, id string, invitationUpdateSettingsParameters InvitationUpdateSettingsParameters, localVarOptionals *InvitationUpdateSettingsOpts) (Invitation, *APIResponse, error)

InvitationUpdateSettings Update a member's invitation access Update member&#39;s settings in the invitations. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param invitationUpdateSettingsParameters
  • @param optional nil or *InvitationUpdateSettingsOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Invitation

func (*InvitationsApiService) InvitationsList ¶ 

func (a *InvitationsApiService) InvitationsList(ctx _context.Context, accountId string, localVarOptionals *InvitationsListOpts) ([]Invitation, *APIResponse, error)

InvitationsList List invitations List invitations for an account. It will also list the accessible resources like projects and locales the invited user has access to. In case nothing is shown the default access from the role is used. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param optional nil or *InvitationsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []Invitation

type InvitationsListOpts ¶ 

type InvitationsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

InvitationsListOpts Optional parameters for the method 'InvitationsList'

type Job ¶ 

type Job struct {
	Id        string        `json:"id,omitempty"`
	Name      string        `json:"name,omitempty"`
	Briefing  string        `json:"briefing,omitempty"`
	DueDate   *NullableTime `json:"due_date,omitempty"`
	State     string        `json:"state,omitempty"`
	TicketUrl string        `json:"ticket_url,omitempty"`
	Project   ProjectShort  `json:"project,omitempty"`
	Branch    BranchName    `json:"branch,omitempty"`
	CreatedAt time.Time     `json:"created_at,omitempty"`
	UpdatedAt time.Time     `json:"updated_at,omitempty"`
}

Job struct for Job

type JobComment ¶ added in v2.5.3 

type JobComment struct {
	Id             string        `json:"id,omitempty"`
	Message        string        `json:"message,omitempty"`
	JobId          string        `json:"job_id,omitempty"`
	User           UserPreview   `json:"user,omitempty"`
	CreatedAt      time.Time     `json:"created_at,omitempty"`
	UpdatedAt      time.Time     `json:"updated_at,omitempty"`
	MentionedUsers []UserPreview `json:"mentioned_users,omitempty"`
}

JobComment struct for JobComment

type JobCommentCreateOpts ¶ added in v2.5.3 

type JobCommentCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

JobCommentCreateOpts Optional parameters for the method 'JobCommentCreate'

type JobCommentCreateParameters ¶ added in v2.5.3 

type JobCommentCreateParameters struct {
	// Job comment message
	Message string `json:"message,omitempty"`
}

JobCommentCreateParameters struct for JobCommentCreateParameters

type JobCommentDeleteOpts ¶ added in v2.5.3 

type JobCommentDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

JobCommentDeleteOpts Optional parameters for the method 'JobCommentDelete'

type JobCommentShowOpts ¶ added in v2.5.3 

type JobCommentShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

JobCommentShowOpts Optional parameters for the method 'JobCommentShow'

type JobCommentUpdateOpts ¶ added in v2.5.3 

type JobCommentUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

JobCommentUpdateOpts Optional parameters for the method 'JobCommentUpdate'

type JobCommentUpdateParameters ¶ added in v2.5.3 

type JobCommentUpdateParameters struct {
	// Comment message
	Message string `json:"message,omitempty"`
}

JobCommentUpdateParameters struct for JobCommentUpdateParameters

type JobCommentsApiService ¶ added in v2.5.3 

type JobCommentsApiService service

JobCommentsApiService JobCommentsApi service

func (*JobCommentsApiService) JobCommentCreate ¶ added in v2.5.3 

func (a *JobCommentsApiService) JobCommentCreate(ctx _context.Context, projectId string, jobId string, jobCommentCreateParameters JobCommentCreateParameters, localVarOptionals *JobCommentCreateOpts) (JobComment, *APIResponse, error)

JobCommentCreate Create a job comment Create a new comment for a job.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobId Job ID
  • @param jobCommentCreateParameters
  • @param optional nil or *JobCommentCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobComment

func (*JobCommentsApiService) JobCommentDelete ¶ added in v2.5.3 

func (a *JobCommentsApiService) JobCommentDelete(ctx _context.Context, projectId string, jobId string, id string, localVarOptionals *JobCommentDeleteOpts) ([]byte, *APIResponse, error)

JobCommentDelete Delete a job comment Delete an existing job comment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobId Job ID
  • @param id ID
  • @param optional nil or *JobCommentDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*JobCommentsApiService) JobCommentShow ¶ added in v2.5.3 

func (a *JobCommentsApiService) JobCommentShow(ctx _context.Context, projectId string, jobId string, id string, localVarOptionals *JobCommentShowOpts) (JobComment, *APIResponse, error)

JobCommentShow Get a single job comment Get details on a single job comment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobId Job ID
  • @param id ID
  • @param optional nil or *JobCommentShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return JobComment

func (*JobCommentsApiService) JobCommentUpdate ¶ added in v2.5.3 

func (a *JobCommentsApiService) JobCommentUpdate(ctx _context.Context, projectId string, keyId string, id string, jobCommentUpdateParameters JobCommentUpdateParameters, localVarOptionals *JobCommentUpdateOpts) (JobComment, *APIResponse, error)

JobCommentUpdate Update a job comment Update an existing job comment.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param id ID
  • @param jobCommentUpdateParameters
  • @param optional nil or *JobCommentUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobComment

func (*JobCommentsApiService) JobCommentsList ¶ added in v2.5.3 

func (a *JobCommentsApiService) JobCommentsList(ctx _context.Context, projectId string, jobId string, localVarOptionals *JobCommentsListOpts) ([]JobComment, *APIResponse, error)

JobCommentsList List job comments List all comments for a job.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobId Job ID
  • @param optional nil or *JobCommentsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use
  • @param "Order" (optional.String) - Order direction. Can be one of: asc, desc.

@return []JobComment

type JobCommentsListOpts ¶ added in v2.5.3 

type JobCommentsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
	Order         optional.String `json:"order,omitempty"`
}

JobCommentsListOpts Optional parameters for the method 'JobCommentsList'

type JobCompleteOpts ¶ 

type JobCompleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

JobCompleteOpts Optional parameters for the method 'JobComplete'

type JobCompleteParameters ¶ 

type JobCompleteParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
}

JobCompleteParameters struct for JobCompleteParameters

type JobCreateOpts ¶ 

type JobCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

JobCreateOpts Optional parameters for the method 'JobCreate'

type JobCreateParameters ¶ 

type JobCreateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Job name
	Name string `json:"name,omitempty"`
	// The API id of the source language
	SourceLocaleId string `json:"source_locale_id,omitempty"`
	// Briefing for the translators
	Briefing string `json:"briefing,omitempty"`
	// Date the job should be finished
	DueDate *NullableTime `json:"due_date,omitempty"`
	// URL to a ticket for this job (e.g. Jira, Trello)
	TicketUrl string `json:"ticket_url,omitempty"`
	// tags of keys that should be included within the job
	Tags []string `json:"tags,omitempty"`
	// ids of keys that should be included within the job
	TranslationKeyIds []string `json:"translation_key_ids,omitempty"`
	// id of a job template you would like to model the created job after. Any manually added parameters will take preference over template attributes.
	JobTemplateId string `json:"job_template_id,omitempty"`
}

JobCreateParameters struct for JobCreateParameters

type JobDeleteOpts ¶ 

type JobDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

JobDeleteOpts Optional parameters for the method 'JobDelete'

type JobDetails ¶ 

type JobDetails struct {
	Id           string          `json:"id,omitempty"`
	Name         string          `json:"name,omitempty"`
	Briefing     string          `json:"briefing,omitempty"`
	DueDate      *NullableTime   `json:"due_date,omitempty"`
	State        string          `json:"state,omitempty"`
	TicketUrl    string          `json:"ticket_url,omitempty"`
	Project      ProjectShort    `json:"project,omitempty"`
	Branch       BranchName      `json:"branch,omitempty"`
	CreatedAt    time.Time       `json:"created_at,omitempty"`
	UpdatedAt    time.Time       `json:"updated_at,omitempty"`
	Owner        UserPreview     `json:"owner,omitempty"`
	JobTagName   string          `json:"job_tag_name,omitempty"`
	SourceLocale LocalePreview   `json:"source_locale,omitempty"`
	Locales      []LocalePreview `json:"locales,omitempty"`
	Keys         []KeyPreview    `json:"keys,omitempty"`
}

JobDetails struct for JobDetails

type JobKeysCreateOpts ¶ 

type JobKeysCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

JobKeysCreateOpts Optional parameters for the method 'JobKeysCreate'

type JobKeysCreateParameters ¶ 

type JobKeysCreateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// ids of keys that should added to the job
	TranslationKeyIds []string `json:"translation_key_ids,omitempty"`
}

JobKeysCreateParameters struct for JobKeysCreateParameters

type JobKeysDeleteOpts ¶ 

type JobKeysDeleteOpts struct {
	XPhraseAppOTP     optional.String    `json:"X-PhraseApp-OTP,omitempty"`
	Branch            optional.String    `json:"branch,omitempty"`
	TranslationKeyIds optional.Interface `json:"translation_key_ids,omitempty"`
}

JobKeysDeleteOpts Optional parameters for the method 'JobKeysDelete'

type JobLocale ¶ 

type JobLocale struct {
	Id                     string              `json:"id,omitempty"`
	Job                    JobPreview          `json:"job,omitempty"`
	Locale                 LocalePreview       `json:"locale,omitempty"`
	Users                  []LocaleUserPreview `json:"users,omitempty"`
	Teams                  []LocaleTeamPreview `json:"teams,omitempty"`
	Completed              *bool               `json:"completed,omitempty"`
	TranslationCompletedAt time.Time           `json:"translation_completed_at,omitempty"`
	ReviewCompletedAt      time.Time           `json:"review_completed_at,omitempty"`
}

JobLocale struct for JobLocale

type JobLocaleCompleteOpts ¶ 

type JobLocaleCompleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

JobLocaleCompleteOpts Optional parameters for the method 'JobLocaleComplete'

type JobLocaleCompleteParameters ¶ 

type JobLocaleCompleteParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
}

JobLocaleCompleteParameters struct for JobLocaleCompleteParameters

type JobLocaleCompleteReviewOpts ¶ added in v2.3.0 

type JobLocaleCompleteReviewOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

JobLocaleCompleteReviewOpts Optional parameters for the method 'JobLocaleCompleteReview'

type JobLocaleCompleteReviewParameters ¶ added in v2.3.0 

type JobLocaleCompleteReviewParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
}

JobLocaleCompleteReviewParameters struct for JobLocaleCompleteReviewParameters

type JobLocaleDeleteOpts ¶ 

type JobLocaleDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

JobLocaleDeleteOpts Optional parameters for the method 'JobLocaleDelete'

type JobLocaleReopenOpts ¶ 

type JobLocaleReopenOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

JobLocaleReopenOpts Optional parameters for the method 'JobLocaleReopen'

type JobLocaleReopenParameters ¶ 

type JobLocaleReopenParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
}

JobLocaleReopenParameters struct for JobLocaleReopenParameters

type JobLocaleShowOpts ¶ 

type JobLocaleShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

JobLocaleShowOpts Optional parameters for the method 'JobLocaleShow'

type JobLocaleUpdateOpts ¶ 

type JobLocaleUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

JobLocaleUpdateOpts Optional parameters for the method 'JobLocaleUpdate'

type JobLocaleUpdateParameters ¶ 

type JobLocaleUpdateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// ID of a target locale to update
	LocaleId string `json:"locale_id,omitempty"`
	// Array of user ids to be assigned to the job locale
	UserIds []string `json:"user_ids,omitempty"`
	// Array of reviewer ids to be assigned to the job locale as reviewers
	ReviewerIds []string `json:"reviewer_ids,omitempty"`
	// Array of team ids to be assigned to the job locale as translators
	TranslatorTeamIds []string `json:"translator_team_ids,omitempty"`
	// Array of team ids to be assigned to the job locale as reviewers
	ReviewerTeamIds []string `json:"reviewer_team_ids,omitempty"`
}

JobLocaleUpdateParameters struct for JobLocaleUpdateParameters

type JobLocalesApiService ¶ 

type JobLocalesApiService service

JobLocalesApiService JobLocalesApi service

func (*JobLocalesApiService) JobLocaleComplete ¶ 

func (a *JobLocalesApiService) JobLocaleComplete(ctx _context.Context, projectId string, jobId string, id string, jobLocaleCompleteParameters JobLocaleCompleteParameters, localVarOptionals *JobLocaleCompleteOpts) (JobLocale, *APIResponse, error)

JobLocaleComplete Complete a job locale Mark a job locale as completed.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobId Job ID
  • @param id ID
  • @param jobLocaleCompleteParameters
  • @param optional nil or *JobLocaleCompleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobLocale

func (*JobLocalesApiService) JobLocaleCompleteReview ¶ added in v2.3.0 

func (a *JobLocalesApiService) JobLocaleCompleteReview(ctx _context.Context, projectId string, jobId string, id string, jobLocaleCompleteReviewParameters JobLocaleCompleteReviewParameters, localVarOptionals *JobLocaleCompleteReviewOpts) (JobLocale, *APIResponse, error)

JobLocaleCompleteReview Review a job locale Mark job locale as reviewed.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobId Job ID
  • @param id ID
  • @param jobLocaleCompleteReviewParameters
  • @param optional nil or *JobLocaleCompleteReviewOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobLocale

func (*JobLocalesApiService) JobLocaleDelete ¶ 

func (a *JobLocalesApiService) JobLocaleDelete(ctx _context.Context, projectId string, jobId string, id string, localVarOptionals *JobLocaleDeleteOpts) ([]byte, *APIResponse, error)

JobLocaleDelete Remove a target locale from a job Removes a target locale from a job.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobId Job ID
  • @param id ID
  • @param optional nil or *JobLocaleDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*JobLocalesApiService) JobLocaleReopen ¶ 

func (a *JobLocalesApiService) JobLocaleReopen(ctx _context.Context, projectId string, jobId string, id string, jobLocaleReopenParameters JobLocaleReopenParameters, localVarOptionals *JobLocaleReopenOpts) (JobLocale, *APIResponse, error)

JobLocaleReopen Reopen a job locale Mark a job locale as uncompleted.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobId Job ID
  • @param id ID
  • @param jobLocaleReopenParameters
  • @param optional nil or *JobLocaleReopenOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobLocale

func (*JobLocalesApiService) JobLocaleShow ¶ 

func (a *JobLocalesApiService) JobLocaleShow(ctx _context.Context, projectId string, jobId string, id string, localVarOptionals *JobLocaleShowOpts) (JobLocale, *APIResponse, error)

JobLocaleShow Show single job target locale Get a single target locale for a given job.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobId Job ID
  • @param id ID
  • @param optional nil or *JobLocaleShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return JobLocale

func (*JobLocalesApiService) JobLocaleUpdate ¶ 

func (a *JobLocalesApiService) JobLocaleUpdate(ctx _context.Context, projectId string, jobId string, id string, jobLocaleUpdateParameters JobLocaleUpdateParameters, localVarOptionals *JobLocaleUpdateOpts) (JobLocale, *APIResponse, error)

JobLocaleUpdate Update a job target locale Update an existing job target locale.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobId Job ID
  • @param id ID
  • @param jobLocaleUpdateParameters
  • @param optional nil or *JobLocaleUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobLocale

func (*JobLocalesApiService) JobLocalesCreate ¶ 

func (a *JobLocalesApiService) JobLocalesCreate(ctx _context.Context, projectId string, jobId string, jobLocalesCreateParameters JobLocalesCreateParameters, localVarOptionals *JobLocalesCreateOpts) (JobLocale, *APIResponse, error)

JobLocalesCreate Add a target locale to a job Adds a target locale to a job.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobId Job ID
  • @param jobLocalesCreateParameters
  • @param optional nil or *JobLocalesCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobLocale

func (*JobLocalesApiService) JobLocalesList ¶ 

func (a *JobLocalesApiService) JobLocalesList(ctx _context.Context, projectId string, jobId string, localVarOptionals *JobLocalesListOpts) ([]JobLocale, *APIResponse, error)

JobLocalesList List job target locales List all target locales for a given job.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobId Job ID
  • @param optional nil or *JobLocalesListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use

@return []JobLocale

type JobLocalesCreateOpts ¶ 

type JobLocalesCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

JobLocalesCreateOpts Optional parameters for the method 'JobLocalesCreate'

type JobLocalesCreateParameters ¶ 

type JobLocalesCreateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// ID of a locale to be added
	LocaleId string `json:"locale_id"`
	// Array of user ids to be assigned to the job locale as translators
	UserIds []string `json:"user_ids,omitempty"`
	// Array of reviewer ids to be assigned to the job locale as reviewers
	ReviewerIds []string `json:"reviewer_ids,omitempty"`
	// Array of team ids to be assigned to the job locale as translators
	TranslatorTeamIds []string `json:"translator_team_ids,omitempty"`
	// Array of team ids to be assigned to the job locale as reviewers
	ReviewerTeamIds []string `json:"reviewer_team_ids,omitempty"`
}

JobLocalesCreateParameters struct for JobLocalesCreateParameters

type JobLocalesListOpts ¶ 

type JobLocalesListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

JobLocalesListOpts Optional parameters for the method 'JobLocalesList'

type JobLockOpts ¶ added in v2.5.0 

type JobLockOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

JobLockOpts Optional parameters for the method 'JobLock'

type JobPreview ¶ 

type JobPreview struct {
	Id    string `json:"id,omitempty"`
	Name  string `json:"name,omitempty"`
	State string `json:"state,omitempty"`
}

JobPreview struct for JobPreview

type JobReopenOpts ¶ 

type JobReopenOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

JobReopenOpts Optional parameters for the method 'JobReopen'

type JobReopenParameters ¶ 

type JobReopenParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
}

JobReopenParameters struct for JobReopenParameters

type JobShowOpts ¶ 

type JobShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

JobShowOpts Optional parameters for the method 'JobShow'

type JobStartOpts ¶ 

type JobStartOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

JobStartOpts Optional parameters for the method 'JobStart'

type JobStartParameters ¶ 

type JobStartParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
}

JobStartParameters struct for JobStartParameters

type JobTemplate ¶ added in v2.1.0 

type JobTemplate struct {
	Id        string       `json:"id,omitempty"`
	Name      string       `json:"name,omitempty"`
	Briefing  string       `json:"briefing,omitempty"`
	Project   ProjectShort `json:"project,omitempty"`
	Branch    Branch       `json:"branch,omitempty"`
	CreatedAt time.Time    `json:"created_at,omitempty"`
	UpdatedAt time.Time    `json:"updated_at,omitempty"`
}

JobTemplate struct for JobTemplate

type JobTemplateCreateOpts ¶ added in v2.1.0 

type JobTemplateCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

JobTemplateCreateOpts Optional parameters for the method 'JobTemplateCreate'

type JobTemplateCreateParameters ¶ added in v2.1.0 

type JobTemplateCreateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Job template name
	Name string `json:"name"`
	// Briefing for the translators
	Briefing string `json:"briefing,omitempty"`
}

JobTemplateCreateParameters struct for JobTemplateCreateParameters

type JobTemplateDeleteOpts ¶ added in v2.1.0 

type JobTemplateDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

JobTemplateDeleteOpts Optional parameters for the method 'JobTemplateDelete'

type JobTemplateDetails ¶ added in v2.6.6 

type JobTemplateDetails struct {
	Id        string          `json:"id,omitempty"`
	Name      string          `json:"name,omitempty"`
	Briefing  string          `json:"briefing,omitempty"`
	Project   ProjectShort    `json:"project,omitempty"`
	Branch    Branch          `json:"branch,omitempty"`
	CreatedAt time.Time       `json:"created_at,omitempty"`
	UpdatedAt time.Time       `json:"updated_at,omitempty"`
	Owner     UserPreview     `json:"owner,omitempty"`
	Creator   UserPreview     `json:"creator,omitempty"`
	Locales   []LocalePreview `json:"locales,omitempty"`
}

JobTemplateDetails struct for JobTemplateDetails

type JobTemplateLocaleDeleteOpts ¶ added in v2.1.0 

type JobTemplateLocaleDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

JobTemplateLocaleDeleteOpts Optional parameters for the method 'JobTemplateLocaleDelete'

type JobTemplateLocaleShowOpts ¶ added in v2.1.0 

type JobTemplateLocaleShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

JobTemplateLocaleShowOpts Optional parameters for the method 'JobTemplateLocaleShow'

type JobTemplateLocaleUpdateOpts ¶ added in v2.1.0 

type JobTemplateLocaleUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

JobTemplateLocaleUpdateOpts Optional parameters for the method 'JobTemplateLocaleUpdate'

type JobTemplateLocaleUpdateParameters ¶ added in v2.1.0 

type JobTemplateLocaleUpdateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// locale id
	LocaleId string `json:"locale_id,omitempty"`
	// Array of user ids to be assigned to the job template locale
	UserIds []string `json:"user_ids,omitempty"`
	// Array of reviewer ids to be assigned to the job template locale
	ReviewerIds []string `json:"reviewer_ids,omitempty"`
	// Array of team ids to be assigned to the job locale as translators
	TranslatorTeamIds []string `json:"translator_team_ids,omitempty"`
	// Array of team ids to be assigned to the job locale as reviewers
	ReviewerTeamIds []string `json:"reviewer_team_ids,omitempty"`
}

JobTemplateLocaleUpdateParameters struct for JobTemplateLocaleUpdateParameters

type JobTemplateLocales ¶ added in v2.6.6 

type JobTemplateLocales struct {
	Id          string              `json:"id,omitempty"`
	JobTemplate JobTemplatePreview  `json:"job_template,omitempty"`
	Locale      LocalePreview       `json:"locale,omitempty"`
	Users       []LocaleUserPreview `json:"users,omitempty"`
	Teams       []LocaleTeamPreview `json:"teams,omitempty"`
}

JobTemplateLocales struct for JobTemplateLocales

type JobTemplateLocalesApiService ¶ added in v2.1.0 

type JobTemplateLocalesApiService service

JobTemplateLocalesApiService JobTemplateLocalesApi service

func (*JobTemplateLocalesApiService) JobTemplateLocaleDelete ¶ added in v2.1.0 

func (a *JobTemplateLocalesApiService) JobTemplateLocaleDelete(ctx _context.Context, projectId string, jobTemplateId string, jobTemplateLocaleId string, localVarOptionals *JobTemplateLocaleDeleteOpts) ([]byte, *APIResponse, error)

JobTemplateLocaleDelete Delete a job template locale Delete an existing job template locale.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobTemplateId Job Template ID
  • @param jobTemplateLocaleId Job Template Locale ID
  • @param optional nil or *JobTemplateLocaleDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*JobTemplateLocalesApiService) JobTemplateLocaleShow ¶ added in v2.1.0 

func (a *JobTemplateLocalesApiService) JobTemplateLocaleShow(ctx _context.Context, projectId string, jobTemplateId string, jobTemplateLocaleId string, localVarOptionals *JobTemplateLocaleShowOpts) (JobTemplateLocales, *APIResponse, error)

JobTemplateLocaleShow Get a single job template locale Get a single job template locale for a given job template.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobTemplateId Job Template ID
  • @param jobTemplateLocaleId Job Template Locale ID
  • @param optional nil or *JobTemplateLocaleShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return JobTemplateLocales

func (*JobTemplateLocalesApiService) JobTemplateLocaleUpdate ¶ added in v2.1.0 

func (a *JobTemplateLocalesApiService) JobTemplateLocaleUpdate(ctx _context.Context, projectId string, jobTemplateId string, jobTemplateLocaleId string, jobTemplateLocaleUpdateParameters JobTemplateLocaleUpdateParameters, localVarOptionals *JobTemplateLocaleUpdateOpts) (JobTemplateLocales, *APIResponse, error)

JobTemplateLocaleUpdate Update a job template locale Update an existing job template locale.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobTemplateId Job Template ID
  • @param jobTemplateLocaleId Job Template Locale ID
  • @param jobTemplateLocaleUpdateParameters
  • @param optional nil or *JobTemplateLocaleUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobTemplateLocales

func (*JobTemplateLocalesApiService) JobTemplateLocalesCreate ¶ added in v2.1.0 

func (a *JobTemplateLocalesApiService) JobTemplateLocalesCreate(ctx _context.Context, projectId string, jobTemplateId string, jobTemplateLocalesCreateParameters JobTemplateLocalesCreateParameters, localVarOptionals *JobTemplateLocalesCreateOpts) (JobTemplateLocales, *APIResponse, error)

JobTemplateLocalesCreate Create a job template locale Create a new job template locale.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobTemplateId Job Template ID
  • @param jobTemplateLocalesCreateParameters
  • @param optional nil or *JobTemplateLocalesCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobTemplateLocales

func (*JobTemplateLocalesApiService) JobTemplateLocalesList ¶ added in v2.1.0 

func (a *JobTemplateLocalesApiService) JobTemplateLocalesList(ctx _context.Context, projectId string, jobTemplateId string, localVarOptionals *JobTemplateLocalesListOpts) ([]JobTemplateLocales, *APIResponse, error)

JobTemplateLocalesList List job template locales List all job template locales for a given job template.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobTemplateId Job Template ID
  • @param optional nil or *JobTemplateLocalesListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use

@return []JobTemplateLocales

type JobTemplateLocalesCreateOpts ¶ added in v2.1.0 

type JobTemplateLocalesCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

JobTemplateLocalesCreateOpts Optional parameters for the method 'JobTemplateLocalesCreate'

type JobTemplateLocalesCreateParameters ¶ added in v2.1.0 

type JobTemplateLocalesCreateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// locale id
	LocaleId string `json:"locale_id"`
	// Array of user ids to be assigned to the job template locale
	UserIds []string `json:"user_ids,omitempty"`
	// Array of reviewer ids to be assigned to the job template locale
	ReviewerIds []string `json:"reviewer_ids,omitempty"`
	// Array of team ids to be assigned to the job locale as translators
	TranslatorTeamIds []string `json:"translator_team_ids,omitempty"`
	// Array of team ids to be assigned to the job locale as reviewers
	ReviewerTeamIds []string `json:"reviewer_team_ids,omitempty"`
}

JobTemplateLocalesCreateParameters struct for JobTemplateLocalesCreateParameters

type JobTemplateLocalesListOpts ¶ added in v2.1.0 

type JobTemplateLocalesListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

JobTemplateLocalesListOpts Optional parameters for the method 'JobTemplateLocalesList'

type JobTemplatePreview ¶ added in v2.1.0 

type JobTemplatePreview struct {
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

JobTemplatePreview struct for JobTemplatePreview

type JobTemplateUpdateOpts ¶ added in v2.1.0 

type JobTemplateUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

JobTemplateUpdateOpts Optional parameters for the method 'JobTemplateUpdate'

type JobTemplateUpdateParameters ¶ added in v2.1.0 

type JobTemplateUpdateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Job template name
	Name string `json:"name"`
	// Briefing for the translators
	Briefing string `json:"briefing,omitempty"`
}

JobTemplateUpdateParameters struct for JobTemplateUpdateParameters

type JobTemplatesApiService ¶ added in v2.1.0 

type JobTemplatesApiService service

JobTemplatesApiService JobTemplatesApi service

func (*JobTemplatesApiService) JobTemplateCreate ¶ added in v2.1.0 

func (a *JobTemplatesApiService) JobTemplateCreate(ctx _context.Context, projectId string, jobTemplateCreateParameters JobTemplateCreateParameters, localVarOptionals *JobTemplateCreateOpts) (JobTemplateDetails, *APIResponse, error)

JobTemplateCreate Create a job template Create a new job template.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobTemplateCreateParameters
  • @param optional nil or *JobTemplateCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobTemplateDetails

func (*JobTemplatesApiService) JobTemplateDelete ¶ added in v2.1.0 

func (a *JobTemplatesApiService) JobTemplateDelete(ctx _context.Context, projectId string, id string, localVarOptionals *JobTemplateDeleteOpts) ([]byte, *APIResponse, error)

JobTemplateDelete Delete a job template Delete an existing job template.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *JobTemplateDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*JobTemplatesApiService) JobTemplateUpdate ¶ added in v2.1.0 

func (a *JobTemplatesApiService) JobTemplateUpdate(ctx _context.Context, projectId string, id string, jobTemplateUpdateParameters JobTemplateUpdateParameters, localVarOptionals *JobTemplateUpdateOpts) (JobTemplateDetails, *APIResponse, error)

JobTemplateUpdate Update a job template Update an existing job template.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param jobTemplateUpdateParameters
  • @param optional nil or *JobTemplateUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobTemplateDetails

func (*JobTemplatesApiService) JobTemplatesList ¶ added in v2.1.0 

func (a *JobTemplatesApiService) JobTemplatesList(ctx _context.Context, projectId string, localVarOptionals *JobTemplatesListOpts) ([]JobTemplate, *APIResponse, error)

JobTemplatesList List job templates List all job templates for the given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *JobTemplatesListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use

@return []JobTemplate

func (*JobTemplatesApiService) JobTemplatesShow ¶ added in v2.6.6 

func (a *JobTemplatesApiService) JobTemplatesShow(ctx _context.Context, projectId string, id string, localVarOptionals *JobTemplatesShowOpts) (JobTemplateDetails, *APIResponse, error)

JobTemplatesShow Get a single job template Get details on a single job template for a given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *JobTemplatesShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return JobTemplateDetails

type JobTemplatesListOpts ¶ added in v2.1.0 

type JobTemplatesListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

JobTemplatesListOpts Optional parameters for the method 'JobTemplatesList'

type JobTemplatesShowOpts ¶ added in v2.6.6 

type JobTemplatesShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

JobTemplatesShowOpts Optional parameters for the method 'JobTemplatesShow'

type JobUnlockOpts ¶ added in v2.5.0 

type JobUnlockOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

JobUnlockOpts Optional parameters for the method 'JobUnlock'

type JobUpdateOpts ¶ 

type JobUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

JobUpdateOpts Optional parameters for the method 'JobUpdate'

type JobUpdateParameters ¶ 

type JobUpdateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Job name
	Name string `json:"name,omitempty"`
	// Briefing for the translators
	Briefing string `json:"briefing,omitempty"`
	// Date the job should be finished
	DueDate *NullableTime `json:"due_date,omitempty"`
	// URL to a ticket for this job (e.g. Jira, Trello)
	TicketUrl string `json:"ticket_url,omitempty"`
}

JobUpdateParameters struct for JobUpdateParameters

type JobsApiService ¶ 

type JobsApiService service

JobsApiService JobsApi service

func (*JobsApiService) JobComplete ¶ 

func (a *JobsApiService) JobComplete(ctx _context.Context, projectId string, id string, jobCompleteParameters JobCompleteParameters, localVarOptionals *JobCompleteOpts) (JobDetails, *APIResponse, error)

JobComplete Complete a job Mark a job as completed.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param jobCompleteParameters
  • @param optional nil or *JobCompleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobDetails

func (*JobsApiService) JobCreate ¶ 

func (a *JobsApiService) JobCreate(ctx _context.Context, projectId string, jobCreateParameters JobCreateParameters, localVarOptionals *JobCreateOpts) (JobDetails, *APIResponse, error)

JobCreate Create a job Create a new job.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param jobCreateParameters
  • @param optional nil or *JobCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobDetails

func (*JobsApiService) JobDelete ¶ 

func (a *JobsApiService) JobDelete(ctx _context.Context, projectId string, id string, localVarOptionals *JobDeleteOpts) ([]byte, *APIResponse, error)

JobDelete Delete a job Delete an existing job.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *JobDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*JobsApiService) JobKeysCreate ¶ 

func (a *JobsApiService) JobKeysCreate(ctx _context.Context, projectId string, id string, jobKeysCreateParameters JobKeysCreateParameters, localVarOptionals *JobKeysCreateOpts) (JobDetails, *APIResponse, error)

JobKeysCreate Add keys to job Add multiple keys to a existing job.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param jobKeysCreateParameters
  • @param optional nil or *JobKeysCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobDetails

func (*JobsApiService) JobKeysDelete ¶ 

func (a *JobsApiService) JobKeysDelete(ctx _context.Context, projectId string, id string, localVarOptionals *JobKeysDeleteOpts) ([]byte, *APIResponse, error)

JobKeysDelete Remove keys from job Remove multiple keys from existing job.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *JobKeysDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use
  • @param "TranslationKeyIds" (optional.Interface of []string) - ids of keys that should added to the job

func (*JobsApiService) JobLock ¶ added in v2.5.0 

func (a *JobsApiService) JobLock(ctx _context.Context, projectId string, id string, localVarOptionals *JobLockOpts) ([]byte, *APIResponse, error)

JobLock Lock a job If you are the job owner, you may lock a job using this API request.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *JobLockOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*JobsApiService) JobReopen ¶ 

func (a *JobsApiService) JobReopen(ctx _context.Context, projectId string, id string, jobReopenParameters JobReopenParameters, localVarOptionals *JobReopenOpts) (JobDetails, *APIResponse, error)

JobReopen Reopen a job Mark a job as uncompleted.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param jobReopenParameters
  • @param optional nil or *JobReopenOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobDetails

func (*JobsApiService) JobShow ¶ 

func (a *JobsApiService) JobShow(ctx _context.Context, projectId string, id string, localVarOptionals *JobShowOpts) (JobDetails, *APIResponse, error)

JobShow Get a single job Get details on a single job for a given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *JobShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return JobDetails

func (*JobsApiService) JobStart ¶ 

func (a *JobsApiService) JobStart(ctx _context.Context, projectId string, id string, jobStartParameters JobStartParameters, localVarOptionals *JobStartOpts) (JobDetails, *APIResponse, error)

JobStart Start a job Starts an existing job in state draft.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param jobStartParameters
  • @param optional nil or *JobStartOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobDetails

func (*JobsApiService) JobUnlock ¶ added in v2.5.0 

func (a *JobsApiService) JobUnlock(ctx _context.Context, projectId string, id string, localVarOptionals *JobUnlockOpts) ([]byte, *APIResponse, error)

JobUnlock Unlock a job If you are the job owner, you may unlock a locked job using this API request.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *JobUnlockOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*JobsApiService) JobUpdate ¶ 

func (a *JobsApiService) JobUpdate(ctx _context.Context, projectId string, id string, jobUpdateParameters JobUpdateParameters, localVarOptionals *JobUpdateOpts) (JobDetails, *APIResponse, error)

JobUpdate Update a job Update an existing job.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param jobUpdateParameters
  • @param optional nil or *JobUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobDetails

func (*JobsApiService) JobsByAccount ¶ 

func (a *JobsApiService) JobsByAccount(ctx _context.Context, accountId string, localVarOptionals *JobsByAccountOpts) ([]Job, *APIResponse, error)

JobsByAccount List account jobs List all jobs for the given account.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param optional nil or *JobsByAccountOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "OwnedBy" (optional.String) - filter by user owning job
  • @param "AssignedTo" (optional.String) - filter by user assigned to job
  • @param "State" (optional.String) - filter by state of job Valid states are <code>draft</code>, <code>in_progress</code>, <code>completed</code>

@return []Job

func (*JobsApiService) JobsList ¶ 

func (a *JobsApiService) JobsList(ctx _context.Context, projectId string, localVarOptionals *JobsListOpts) ([]Job, *APIResponse, error)

JobsList List jobs List all jobs for the given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *JobsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use
  • @param "OwnedBy" (optional.String) - filter by user owning job
  • @param "AssignedTo" (optional.String) - filter by user assigned to job
  • @param "State" (optional.String) - filter by state of job Valid states are <code>draft</code>, <code>in_progress</code>, <code>completed</code>

@return []Job

type JobsByAccountOpts ¶ 

type JobsByAccountOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	OwnedBy       optional.String `json:"owned_by,omitempty"`
	AssignedTo    optional.String `json:"assigned_to,omitempty"`
	State         optional.String `json:"state,omitempty"`
}

JobsByAccountOpts Optional parameters for the method 'JobsByAccount'

type JobsListOpts ¶ 

type JobsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
	OwnedBy       optional.String `json:"owned_by,omitempty"`
	AssignedTo    optional.String `json:"assigned_to,omitempty"`
	State         optional.String `json:"state,omitempty"`
}

JobsListOpts Optional parameters for the method 'JobsList'

type KeyCreateOpts ¶ 

type KeyCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

KeyCreateOpts Optional parameters for the method 'KeyCreate'

type KeyCreateParameters ¶ 

type KeyCreateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Key name
	Name string `json:"name,omitempty"`
	// Key description (usually includes contextual information for translators)
	Description string `json:"description,omitempty"`
	// Indicates whether key supports pluralization
	Plural *bool `json:"plural,omitempty"`
	// Plural name for the key (used in some file formats, e.g. Gettext)
	NamePlural string `json:"name_plural,omitempty"`
	// Type of the key. Can be one of the following: string, number, boolean, array, markdown.
	DataType string `json:"data_type,omitempty"`
	// List of tags separated by comma to be associated with the key.
	Tags string `json:"tags,omitempty"`
	// Max. number of characters translations for this key can have.
	MaxCharactersAllowed int32 `json:"max_characters_allowed,omitempty"`
	// Screenshot/image for the key. This parameter is deprecated. Please use the Screenshots endpoint instead.
	Screenshot *os.File `json:"screenshot,omitempty"`
	// Indicates whether the screenshot will be deleted. This parameter is deprecated. Please use the Screenshots endpoint instead.
	RemoveScreenshot *bool `json:"remove_screenshot,omitempty"`
	// Indicates whether the key should be exported as \"unformatted\". Supported by Android XML and other formats.
	Unformatted *bool `json:"unformatted,omitempty"`
	// Creates a translation in the default locale with the specified content
	DefaultTranslationContent string `json:"default_translation_content,omitempty"`
	// Indicates whether the key should be exported with \"xml:space=preserve\". Supported by several XML-based formats.
	XmlSpacePreserve *bool `json:"xml_space_preserve,omitempty"`
	// Original file attribute. Used in some formats, e.g. XLIFF.
	OriginalFile string `json:"original_file,omitempty"`
	// NSStringLocalizedFormatKey attribute. Used in .stringsdict format.
	LocalizedFormatString string `json:"localized_format_string,omitempty"`
	// NSStringLocalizedFormatKey attribute. Used in .stringsdict format.
	LocalizedFormatKey string `json:"localized_format_key,omitempty"`
	// Custom metadata property name and value pairs to be associated with key.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`
}

KeyCreateParameters struct for KeyCreateParameters

type KeyDeleteOpts ¶ 

type KeyDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

KeyDeleteOpts Optional parameters for the method 'KeyDelete' 

type KeyLink struct {
	// The timestamp when the link was created.
	CreatedAt time.Time `json:"created_at"`
	// The timestamp when the link was last updated.
	UpdatedAt time.Time   `json:"updated_at"`
	CreatedBy UserPreview `json:"created_by"`
	UpdatedBy UserPreview `json:"updated_by"`
	Account   Account     `json:"account"`
	Parent    KeyPreview  `json:"parent"`
	// The child translation keys linked to the parent.
	Children []KeyPreview `json:"children"`
}

KeyLink struct for KeyLink

type KeyLinksBatchDestroyOpts ¶ added in v2.25.0 

type KeyLinksBatchDestroyOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	UnlinkParent  optional.Bool   `json:"unlink_parent,omitempty"`
}

KeyLinksBatchDestroyOpts Optional parameters for the method 'KeyLinksBatchDestroy'

type KeyLinksBatchDestroyParameters ¶ added in v2.25.0 

type KeyLinksBatchDestroyParameters struct {
	// The IDs of the child keys to unlink from the parent key.
	ChildKeyIds []string `json:"child_key_ids"`
}

KeyLinksBatchDestroyParameters struct for KeyLinksBatchDestroyParameters

type KeyLinksCreateOpts ¶ added in v2.25.0 

type KeyLinksCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

KeyLinksCreateOpts Optional parameters for the method 'KeyLinksCreate'

type KeyLinksCreateParameters ¶ added in v2.25.0 

type KeyLinksCreateParameters struct {
	// The IDs of the child keys to link to the parent key. Can be left empty, to only mark the given translation-key as parent
	ChildKeyIds []string `json:"child_key_ids"`
}

KeyLinksCreateParameters struct for KeyLinksCreateParameters

type KeyLinksDestroyOpts ¶ added in v2.25.0 

type KeyLinksDestroyOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

KeyLinksDestroyOpts Optional parameters for the method 'KeyLinksDestroy'

type KeyLinksIndex400Response ¶ added in v2.25.0 

type KeyLinksIndex400Response struct {
	Message string `json:"message,omitempty"`
}

KeyLinksIndex400Response struct for KeyLinksIndex400Response

type KeyLinksIndexOpts ¶ added in v2.25.0 

type KeyLinksIndexOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

KeyLinksIndexOpts Optional parameters for the method 'KeyLinksIndex'

type KeyPreview ¶ 

type KeyPreview struct {
	Id     string `json:"id,omitempty"`
	Name   string `json:"name,omitempty"`
	Plural *bool  `json:"plural,omitempty"`
}

KeyPreview struct for KeyPreview

type KeyShowOpts ¶ 

type KeyShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

KeyShowOpts Optional parameters for the method 'KeyShow'

type KeyUpdateOpts ¶ 

type KeyUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

KeyUpdateOpts Optional parameters for the method 'KeyUpdate'

type KeyUpdateParameters ¶ 

type KeyUpdateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Key name
	Name string `json:"name,omitempty"`
	// Key description (usually includes contextual information for translators)
	Description string `json:"description,omitempty"`
	// Indicates whether key supports pluralization
	Plural *bool `json:"plural,omitempty"`
	// Plural name for the key (used in some file formats, e.g. Gettext)
	NamePlural string `json:"name_plural,omitempty"`
	// Type of the key. Can be one of the following: string, number, boolean, array, markdown.
	DataType string `json:"data_type,omitempty"`
	// List of tags separated by comma to be associated with the key.
	Tags string `json:"tags,omitempty"`
	// Max. number of characters translations for this key can have.
	MaxCharactersAllowed int32 `json:"max_characters_allowed,omitempty"`
	// Screenshot/image for the key. This parameter is deprecated. Please use the Screenshots endpoint instead.
	Screenshot *os.File `json:"screenshot,omitempty"`
	// Indicates whether the screenshot will be deleted. This parameter is deprecated. Please use the Screenshots endpoint instead.
	RemoveScreenshot *bool `json:"remove_screenshot,omitempty"`
	// Indicates whether the key should be exported as \"unformatted\". Supported by Android XML and other formats.
	Unformatted *bool `json:"unformatted,omitempty"`
	// Indicates whether the key should be exported with \"xml:space=preserve\". Supported by several XML-based formats.
	XmlSpacePreserve *bool `json:"xml_space_preserve,omitempty"`
	// Original file attribute. Used in some formats, e.g. XLIFF.
	OriginalFile string `json:"original_file,omitempty"`
	// NSStringLocalizedFormatKey attribute. Used in .stringsdict format.
	LocalizedFormatString string `json:"localized_format_string,omitempty"`
	// NSStringLocalizedFormatKey attribute. Used in .stringsdict format.
	LocalizedFormatKey string `json:"localized_format_key,omitempty"`
	// Updates/Creates custom metadata property name and value pairs to be associated with key. If you want to delete a custom metadata property, you can set its value to null. If you want to update a custom metadata property, you can set its value to the new value.
	CustomMetadata map[string]interface{} `json:"custom_metadata,omitempty"`
}

KeyUpdateParameters struct for KeyUpdateParameters

type KeysApiService ¶ 

type KeysApiService service

KeysApiService KeysApi service

func (*KeysApiService) KeyCreate ¶ 

func (a *KeysApiService) KeyCreate(ctx _context.Context, projectId string, keyCreateParameters KeyCreateParameters, localVarOptionals *KeyCreateOpts) (TranslationKeyDetails, *APIResponse, error)

KeyCreate Create a key Create a new key.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyCreateParameters
  • @param optional nil or *KeyCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return TranslationKeyDetails

func (*KeysApiService) KeyDelete ¶ 

func (a *KeysApiService) KeyDelete(ctx _context.Context, projectId string, id string, localVarOptionals *KeyDeleteOpts) ([]byte, *APIResponse, error)

KeyDelete Delete a key Delete an existing key.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *KeyDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*KeysApiService) KeyShow ¶ 

func (a *KeysApiService) KeyShow(ctx _context.Context, projectId string, id string, localVarOptionals *KeyShowOpts) (TranslationKeyDetails, *APIResponse, error)

KeyShow Get a single key Get details on a single key for a given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *KeyShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return TranslationKeyDetails

func (*KeysApiService) KeyUpdate ¶ 

func (a *KeysApiService) KeyUpdate(ctx _context.Context, projectId string, id string, keyUpdateParameters KeyUpdateParameters, localVarOptionals *KeyUpdateOpts) (TranslationKeyDetails, *APIResponse, error)

KeyUpdate Update a key Update an existing key.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param keyUpdateParameters
  • @param optional nil or *KeyUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return TranslationKeyDetails

func (*KeysApiService) KeysDeleteCollection ¶ 

func (a *KeysApiService) KeysDeleteCollection(ctx _context.Context, projectId string, localVarOptionals *KeysDeleteCollectionOpts) (AffectedResources, *APIResponse, error)

KeysDeleteCollection Delete collection of keys Delete all keys matching query. Same constraints as list. Please limit the number of affected keys to about 1,000 as you might experience timeouts otherwise.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *KeysDeleteCollectionOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use
  • @param "Q" (optional.String) - Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name</code> to filter for keys with certain tags</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
  • @param "LocaleId" (optional.String) - Locale used to determine the translation state of a key when filtering for untranslated or translated keys.

@return AffectedResources

func (*KeysApiService) KeysExclude ¶ added in v2.1.0 

func (a *KeysApiService) KeysExclude(ctx _context.Context, projectId string, keysExcludeParameters KeysExcludeParameters, localVarOptionals *KeysExcludeOpts) (AffectedResources, *APIResponse, error)

KeysExclude Exclude a locale on a collection of keys Exclude a locale on keys matching query. Same constraints as list.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keysExcludeParameters
  • @param optional nil or *KeysExcludeOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return AffectedResources

func (*KeysApiService) KeysInclude ¶ added in v2.1.0 

func (a *KeysApiService) KeysInclude(ctx _context.Context, projectId string, keysIncludeParameters KeysIncludeParameters, localVarOptionals *KeysIncludeOpts) (AffectedResources, *APIResponse, error)

KeysInclude Include a locale on a collection of keys Include a locale on keys matching query. Same constraints as list.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keysIncludeParameters
  • @param optional nil or *KeysIncludeOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return AffectedResources

func (*KeysApiService) KeysList ¶ 

func (a *KeysApiService) KeysList(ctx _context.Context, projectId string, localVarOptionals *KeysListOpts) ([]TranslationKey, *APIResponse, error)

KeysList List keys List all keys for the given project. Alternatively you can POST requests to /search.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *KeysListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use
  • @param "Sort" (optional.String) - Sort by field. Can be one of: name, created_at, updated_at.
  • @param "Order" (optional.String) - Order direction. Can be one of: asc, desc.
  • @param "Q" (optional.String) - Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul> <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li> <li><code>name:key_name,...</code> for text queries on a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes</li> <li><code>tags:tag_name,...</code> to filter for keys with certain comma-seperated list of tags</li> <li><code>uploads:upload_id,...</code> to filter for keys with certain comma-seperated list of uploads</li> <li><code>job:{true|false}</code> to filter for keys mentioned in an active job</li> <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li> <li><code>updated_at:{&gt;=|&lt;=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
  • @param "LocaleId" (optional.String) - Locale used to determine the translation state of a key when filtering for untranslated or translated keys.

@return []TranslationKey

func (*KeysApiService) KeysSearch ¶ 

func (a *KeysApiService) KeysSearch(ctx _context.Context, projectId string, keysSearchParameters KeysSearchParameters, localVarOptionals *KeysSearchOpts) ([]TranslationKey, *APIResponse, error)

KeysSearch Search keys Search keys for the given project matching query.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keysSearchParameters
  • @param optional nil or *KeysSearchOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []TranslationKey

func (*KeysApiService) KeysTag ¶ 

func (a *KeysApiService) KeysTag(ctx _context.Context, projectId string, keysTagParameters KeysTagParameters, localVarOptionals *KeysTagOpts) (AffectedResources, *APIResponse, error)

KeysTag Add tags to collection of keys Tags all keys matching query. Same constraints as list.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keysTagParameters
  • @param optional nil or *KeysTagOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return AffectedResources

func (*KeysApiService) KeysUntag ¶ 

func (a *KeysApiService) KeysUntag(ctx _context.Context, projectId string, keysUntagParameters KeysUntagParameters, localVarOptionals *KeysUntagOpts) (AffectedResources, *APIResponse, error)

KeysUntag Remove tags from collection of keys Removes specified tags from keys matching query.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keysUntagParameters
  • @param optional nil or *KeysUntagOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return AffectedResources

type KeysDeleteCollectionOpts ¶ 

type KeysDeleteCollectionOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
	Q             optional.String `json:"q,omitempty"`
	LocaleId      optional.String `json:"locale_id,omitempty"`
}

KeysDeleteCollectionOpts Optional parameters for the method 'KeysDeleteCollection'

type KeysExcludeOpts ¶ added in v2.1.0 

type KeysExcludeOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

KeysExcludeOpts Optional parameters for the method 'KeysExclude'

type KeysExcludeParameters ¶ added in v2.1.0 

type KeysExcludeParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul>   <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes</li>   <li><code>tags:tag_name</code> to filter for keys with certain tags</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
	Q string `json:"q,omitempty"`
	// Locale used to exlcude or include keys.
	TargetLocaleId string `json:"target_locale_id,omitempty"`
	// Tag or comma-separated list of tags to add to the matching collection of keys
	Tags string `json:"tags,omitempty"`
}

KeysExcludeParameters struct for KeysExcludeParameters

type KeysFigmaAttachmentsApiService ¶ added in v2.15.0 

type KeysFigmaAttachmentsApiService service

KeysFigmaAttachmentsApiService KeysFigmaAttachmentsApi service

func (*KeysFigmaAttachmentsApiService) FigmaAttachmentAttachToKey ¶ added in v2.15.0 

func (a *KeysFigmaAttachmentsApiService) FigmaAttachmentAttachToKey(ctx _context.Context, projectId string, figmaAttachmentId string, id string, localVarOptionals *FigmaAttachmentAttachToKeyOpts) ([]byte, *APIResponse, error)

FigmaAttachmentAttachToKey Attach the Figma attachment to a key Attach the Figma attachment to a key

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param figmaAttachmentId Figma attachment ID
  • @param id ID
  • @param optional nil or *FigmaAttachmentAttachToKeyOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*KeysFigmaAttachmentsApiService) FigmaAttachmentDetachFromKey ¶ added in v2.15.0 

func (a *KeysFigmaAttachmentsApiService) FigmaAttachmentDetachFromKey(ctx _context.Context, projectId string, figmaAttachmentId string, id string, localVarOptionals *FigmaAttachmentDetachFromKeyOpts) ([]byte, *APIResponse, error)

FigmaAttachmentDetachFromKey Detach the Figma attachment from a key Detach the Figma attachment from a key

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param figmaAttachmentId Figma attachment ID
  • @param id ID
  • @param optional nil or *FigmaAttachmentDetachFromKeyOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

type KeysIncludeOpts ¶ added in v2.1.0 

type KeysIncludeOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

KeysIncludeOpts Optional parameters for the method 'KeysInclude'

type KeysIncludeParameters ¶ added in v2.1.0 

type KeysIncludeParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul>   <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes</li>   <li><code>tags:tag_name</code> to filter for keys with certain tags</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
	Q string `json:"q,omitempty"`
	// Locale used to exlcude or include keys.
	TargetLocaleId string `json:"target_locale_id,omitempty"`
	// Tag or comma-separated list of tags to add to the matching collection of keys
	Tags string `json:"tags,omitempty"`
}

KeysIncludeParameters struct for KeysIncludeParameters

type KeysListOpts ¶ 

type KeysListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
	Sort          optional.String `json:"sort,omitempty"`
	Order         optional.String `json:"order,omitempty"`
	Q             optional.String `json:"q,omitempty"`
	LocaleId      optional.String `json:"locale_id,omitempty"`
}

KeysListOpts Optional parameters for the method 'KeysList'

type KeysSearchOpts ¶ 

type KeysSearchOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

KeysSearchOpts Optional parameters for the method 'KeysSearch'

type KeysSearchParameters ¶ 

type KeysSearchParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Sort by field. Can be one of: name, created_at, updated_at.
	Sort string `json:"sort,omitempty"`
	// Order direction. Can be one of: asc, desc.
	Order string `json:"order,omitempty"`
	// Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul>   <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>name:key_name,...</code> for text queries on a comma-seperated list of exact key names - spaces, commas, and colons need to be escaped with double backslashes</li>   <li><code>tags:tag_name,...</code> to filter for keys with certain comma-seperated list of tags</li>   <li><code>uploads:upload_id,...</code> to filter for keys with certain comma-seperated list of uploads</li>   <li><code>job:{true|false}</code> to filter for keys mentioned in an active job</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{&gt;=|&lt;=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>. Please note: If <code>tags</code> are added to filter the search, the search will be limited to a maximum of 65,536 tagged keys.
	Q string `json:"q,omitempty"`
	// Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
	LocaleId string `json:"locale_id,omitempty"`
}

KeysSearchParameters struct for KeysSearchParameters

type KeysTagOpts ¶ 

type KeysTagOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

KeysTagOpts Optional parameters for the method 'KeysTag'

type KeysTagParameters ¶ 

type KeysTagParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul>   <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes</li>   <li><code>tags:tag_name</code> to filter for keys with certain tags</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
	Q string `json:"q,omitempty"`
	// Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
	LocaleId string `json:"locale_id,omitempty"`
	// Tag or comma-separated list of tags to add to the matching collection of keys
	Tags string `json:"tags,omitempty"`
}

KeysTagParameters struct for KeysTagParameters

type KeysUntagOpts ¶ 

type KeysUntagOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

KeysUntagOpts Optional parameters for the method 'KeysUntag'

type KeysUntagParameters ¶ 

type KeysUntagParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Specify a query to do broad search for keys by name (including wildcards).<br><br> The following qualifiers are also supported in the search term:<br> <ul>   <li><code>ids:key_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>name:key_name</code> for text queries on exact key names - spaces, commas, and colons  need to be escaped with double backslashes</li>   <li><code>tags:tag_name</code> to filter for keys with certain tags</li>   <li><code>translated:{true|false}</code> for translation status (also requires <code>locale_id</code> to be specified)</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li>   <li><code>unmentioned_in_upload:upload_id</code> to filter keys unmentioned within upload</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
	Q string `json:"q,omitempty"`
	// Locale used to determine the translation state of a key when filtering for untranslated or translated keys.
	LocaleId string `json:"locale_id,omitempty"`
	// Tag or comma-separated list of tags to remove from the matching collection of keys
	Tags string `json:"tags,omitempty"`
}

KeysUntagParameters struct for KeysUntagParameters

type LinkedKeysApiService ¶ added in v2.25.0 

type LinkedKeysApiService service

LinkedKeysApiService LinkedKeysApi service

func (*LinkedKeysApiService) KeyLinksBatchDestroy ¶ added in v2.25.0 

func (a *LinkedKeysApiService) KeyLinksBatchDestroy(ctx _context.Context, projectId string, id string, keyLinksBatchDestroyParameters KeyLinksBatchDestroyParameters, localVarOptionals *KeyLinksBatchDestroyOpts) ([]byte, *APIResponse, error)

KeyLinksBatchDestroy Batch unlink child keys from a parent key Unlinks multiple child keys from a given parent key in a single operation.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id Parent Translation Key ID
  • @param keyLinksBatchDestroyParameters
  • @param optional nil or *KeyLinksBatchDestroyOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "UnlinkParent" (optional.Bool) - Whether to unlink the parent key as well and unmark it as linked-key.

func (*LinkedKeysApiService) KeyLinksCreate ¶ added in v2.25.0 

func (a *LinkedKeysApiService) KeyLinksCreate(ctx _context.Context, projectId string, id string, keyLinksCreateParameters KeyLinksCreateParameters, localVarOptionals *KeyLinksCreateOpts) (KeyLink, *APIResponse, error)

KeyLinksCreate Link child keys to a parent key Creates links between a given parent key and one or more child keys.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id Parent Translation Key ID
  • @param keyLinksCreateParameters
  • @param optional nil or *KeyLinksCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return KeyLink

func (*LinkedKeysApiService) KeyLinksDestroy ¶ added in v2.25.0 

func (a *LinkedKeysApiService) KeyLinksDestroy(ctx _context.Context, projectId string, id string, childKeyId string, localVarOptionals *KeyLinksDestroyOpts) ([]byte, *APIResponse, error)

KeyLinksDestroy Unlink a child key from a parent key Unlinks a single child key from a given parent key.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id Parent Translation Key ID
  • @param childKeyId The ID of the child key to unlink.
  • @param optional nil or *KeyLinksDestroyOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*LinkedKeysApiService) KeyLinksIndex ¶ added in v2.25.0 

func (a *LinkedKeysApiService) KeyLinksIndex(ctx _context.Context, projectId string, id string, localVarOptionals *KeyLinksIndexOpts) (KeyLink, *APIResponse, error)

KeyLinksIndex Retrieve all child keys linked to a specific parent key Returns detailed information about a parent key, including its linked child keys.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id Parent Translation Key ID
  • @param optional nil or *KeyLinksIndexOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return KeyLink

type Locale ¶ 

type Locale struct {
	Id             string        `json:"id,omitempty"`
	Name           string        `json:"name,omitempty"`
	Code           string        `json:"code,omitempty"`
	Default        *bool         `json:"default,omitempty"`
	Main           *bool         `json:"main,omitempty"`
	Rtl            *bool         `json:"rtl,omitempty"`
	PluralForms    []string      `json:"plural_forms,omitempty"`
	SourceLocale   LocalePreview `json:"source_locale,omitempty"`
	FallbackLocale LocalePreview `json:"fallback_locale,omitempty"`
	CreatedAt      time.Time     `json:"created_at,omitempty"`
	UpdatedAt      time.Time     `json:"updated_at,omitempty"`
}

Locale struct for Locale

type LocaleCreateOpts ¶ 

type LocaleCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

LocaleCreateOpts Optional parameters for the method 'LocaleCreate'

type LocaleCreateParameters ¶ 

type LocaleCreateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Locale name
	Name string `json:"name,omitempty"`
	// Locale ISO code
	Code string `json:"code,omitempty"`
	// Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale.
	Default *bool `json:"default,omitempty"`
	// Indicates whether locale is a main locale. Main locales are part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Verification System</a> feature.
	Main *bool `json:"main,omitempty"`
	// Indicates whether locale is a RTL (Right-to-Left) locale.
	Rtl *bool `json:"rtl,omitempty"`
	// Source locale. Can be the name or public id of the locale. Preferred is the public id.
	SourceLocaleId string `json:"source_locale_id,omitempty"`
	// Fallback locale for empty translations. Can be a locale name or id.
	FallbackLocaleId string `json:"fallback_locale_id,omitempty"`
	// Indicates that new translations for this locale should be marked as unverified. Part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature.
	UnverifyNewTranslations *bool `json:"unverify_new_translations,omitempty"`
	// Indicates that updated translations for this locale should be marked as unverified. Part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature.
	UnverifyUpdatedTranslations *bool `json:"unverify_updated_translations,omitempty"`
	// If set, translations for this locale will be fetched automatically, right after creation.
	Autotranslate *bool `json:"autotranslate,omitempty"`
}

LocaleCreateParameters struct for LocaleCreateParameters

type LocaleDeleteOpts ¶ 

type LocaleDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

LocaleDeleteOpts Optional parameters for the method 'LocaleDelete'

type LocaleDetails ¶ 

type LocaleDetails struct {
	Id             string           `json:"id,omitempty"`
	Name           string           `json:"name,omitempty"`
	Code           string           `json:"code,omitempty"`
	Default        *bool            `json:"default,omitempty"`
	Main           *bool            `json:"main,omitempty"`
	Rtl            *bool            `json:"rtl,omitempty"`
	PluralForms    []string         `json:"plural_forms,omitempty"`
	SourceLocale   LocalePreview    `json:"source_locale,omitempty"`
	FallbackLocale LocalePreview    `json:"fallback_locale,omitempty"`
	CreatedAt      time.Time        `json:"created_at,omitempty"`
	UpdatedAt      time.Time        `json:"updated_at,omitempty"`
	Statistics     LocaleStatistics `json:"statistics,omitempty"`
}

LocaleDetails struct for LocaleDetails

type LocaleDownloadOpts ¶ 

type LocaleDownloadOpts struct {
	XPhraseAppOTP                 optional.String    `json:"X-PhraseApp-OTP,omitempty"`
	IfModifiedSince               optional.String    `json:"If-Modified-Since,omitempty"`
	IfNoneMatch                   optional.String    `json:"If-None-Match,omitempty"`
	Branch                        optional.String    `json:"branch,omitempty"`
	FileFormat                    optional.String    `json:"file_format,omitempty"`
	Tags                          optional.String    `json:"tags,omitempty"`
	Tag                           optional.String    `json:"tag,omitempty"`
	IncludeEmptyTranslations      optional.Bool      `json:"include_empty_translations,omitempty"`
	ExcludeEmptyZeroForms         optional.Bool      `json:"exclude_empty_zero_forms,omitempty"`
	IncludeTranslatedKeys         optional.Bool      `json:"include_translated_keys,omitempty"`
	KeepNotranslateTags           optional.Bool      `json:"keep_notranslate_tags,omitempty"`
	ConvertEmoji                  optional.Bool      `json:"convert_emoji,omitempty"`
	FormatOptions                 optional.Interface `json:"format_options,omitempty"`
	Encoding                      optional.String    `json:"encoding,omitempty"`
	SkipUnverifiedTranslations    optional.Bool      `json:"skip_unverified_translations,omitempty"`
	IncludeUnverifiedTranslations optional.Bool      `json:"include_unverified_translations,omitempty"`
	UseLastReviewedVersion        optional.Bool      `json:"use_last_reviewed_version,omitempty"`
	FallbackLocaleId              optional.String    `json:"fallback_locale_id,omitempty"`
	SourceLocaleId                optional.String    `json:"source_locale_id,omitempty"`
	CustomMetadataFilters         optional.Interface `json:"custom_metadata_filters,omitempty"`
}

LocaleDownloadOpts Optional parameters for the method 'LocaleDownload'

type LocalePreview ¶ 

type LocalePreview struct {
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
	Code string `json:"code,omitempty"`
}

LocalePreview struct for LocalePreview

type LocalePreview1 ¶ added in v2.0.2 

type LocalePreview1 struct {
	Id      string       `json:"id,omitempty"`
	Name    string       `json:"name,omitempty"`
	Code    string       `json:"code,omitempty"`
	Project ProjectShort `json:"project,omitempty"`
}

LocalePreview1 struct for LocalePreview1

type LocaleReport ¶ added in v2.19.0 

type LocaleReport struct {
	KeysCount                        int32         `json:"keys_count,omitempty"`
	TranslatedTranslationsPercentage int32         `json:"translated_translations_percentage,omitempty"`
	UnverifiedTranslationsPercentage int32         `json:"unverified_translations_percentage,omitempty"`
	ReviewedTranslationsPercentage   int32         `json:"reviewed_translations_percentage,omitempty"`
	UntranslatedKeysPercentage       int32         `json:"untranslated_keys_percentage,omitempty"`
	CompletedTranslationsCount       int32         `json:"completed_translations_count,omitempty"`
	UntranslatedKeysCount            int32         `json:"untranslated_keys_count,omitempty"`
	UnverifiedTranslationsCount      int32         `json:"unverified_translations_count,omitempty"`
	ReviewedTranslationsCount        int32         `json:"reviewed_translations_count,omitempty"`
	SourceWordCount                  int32         `json:"source_word_count,omitempty"`
	WordCount                        int32         `json:"word_count,omitempty"`
	WordCountUnverified              int32         `json:"word_count_unverified,omitempty"`
	WordCountMissing                 int32         `json:"word_count_missing,omitempty"`
	Locale                           LocalePreview `json:"locale,omitempty"`
}

LocaleReport struct for LocaleReport

type LocaleShowOpts ¶ 

type LocaleShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

LocaleShowOpts Optional parameters for the method 'LocaleShow'

type LocaleStatistics ¶ 

type LocaleStatistics struct {
	KeysTotalCount              int32 `json:"keys_total_count,omitempty"`
	KeysUntranslatedCount       int32 `json:"keys_untranslated_count,omitempty"`
	WordsTotalCount             int32 `json:"words_total_count,omitempty"`
	TranslationsCompletedCount  int32 `json:"translations_completed_count,omitempty"`
	TranslationsUnverifiedCount int32 `json:"translations_unverified_count,omitempty"`
	UnverifiedWordsCount        int32 `json:"unverified_words_count,omitempty"`
	MissingWordsCount           int32 `json:"missing_words_count,omitempty"`
}

LocaleStatistics struct for LocaleStatistics

type LocaleTeamPreview ¶ added in v2.6.7 

type LocaleTeamPreview struct {
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
	Role string `json:"role,omitempty"`
}

LocaleTeamPreview struct for LocaleTeamPreview

type LocaleUpdateOpts ¶ 

type LocaleUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

LocaleUpdateOpts Optional parameters for the method 'LocaleUpdate'

type LocaleUpdateParameters ¶ 

type LocaleUpdateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Locale name
	Name string `json:"name,omitempty"`
	// Locale ISO code
	Code string `json:"code,omitempty"`
	// Indicates whether locale is the default locale. If set to true, the previous default locale the project is no longer the default locale.
	Default *bool `json:"default,omitempty"`
	// Indicates whether locale is a main locale. Main locales are part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Verification System</a> feature.
	Main *bool `json:"main,omitempty"`
	// Indicates whether locale is a RTL (Right-to-Left) locale.
	Rtl *bool `json:"rtl,omitempty"`
	// Source locale. Can be the name or public id of the locale. Preferred is the public id.
	SourceLocaleId string `json:"source_locale_id,omitempty"`
	// Fallback locale for empty translations. Can be a locale name or id.
	FallbackLocaleId string `json:"fallback_locale_id,omitempty"`
	// Indicates that new translations for this locale should be marked as unverified. Part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature.
	UnverifyNewTranslations *bool `json:"unverify_new_translations,omitempty"`
	// Indicates that updated translations for this locale should be marked as unverified. Part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature.
	UnverifyUpdatedTranslations *bool `json:"unverify_updated_translations,omitempty"`
	// If set, translations for this locale will be fetched automatically, right after creation.
	Autotranslate *bool `json:"autotranslate,omitempty"`
}

LocaleUpdateParameters struct for LocaleUpdateParameters

type LocaleUserPreview ¶ added in v2.6.7 

type LocaleUserPreview struct {
	Id       string `json:"id,omitempty"`
	Username string `json:"username,omitempty"`
	Name     string `json:"name,omitempty"`
	Role     string `json:"role,omitempty"`
}

LocaleUserPreview struct for LocaleUserPreview

type LocalesApiService ¶ 

type LocalesApiService service

LocalesApiService LocalesApi service

func (*LocalesApiService) AccountLocales ¶ added in v2.0.2 

func (a *LocalesApiService) AccountLocales(ctx _context.Context, id string, localVarOptionals *AccountLocalesOpts) ([]LocalePreview1, *APIResponse, error)

AccountLocales List locales used in account List all locales unique by locale code used across all projects within an account.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID
  • @param optional nil or *AccountLocalesOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []LocalePreview1

func (*LocalesApiService) LocaleCreate ¶ 

func (a *LocalesApiService) LocaleCreate(ctx _context.Context, projectId string, localeCreateParameters LocaleCreateParameters, localVarOptionals *LocaleCreateOpts) (LocaleDetails, *APIResponse, error)

LocaleCreate Create a locale Create a new locale.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param localeCreateParameters
  • @param optional nil or *LocaleCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return LocaleDetails

func (*LocalesApiService) LocaleDelete ¶ 

func (a *LocalesApiService) LocaleDelete(ctx _context.Context, projectId string, id string, localVarOptionals *LocaleDeleteOpts) ([]byte, *APIResponse, error)

LocaleDelete Delete a locale Delete an existing locale.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id Locale ID or locale name
  • @param optional nil or *LocaleDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*LocalesApiService) LocaleDownload ¶ 

func (a *LocalesApiService) LocaleDownload(ctx _context.Context, projectId string, id string, localVarOptionals *LocaleDownloadOpts) (*os.File, *APIResponse, error)

LocaleDownload Download a locale Download a locale in a specific file format.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id Locale ID or locale name
  • @param optional nil or *LocaleDownloadOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "IfModifiedSince" (optional.String) - Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
  • @param "IfNoneMatch" (optional.String) - ETag condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
  • @param "Branch" (optional.String) - specify the branch to use
  • @param "FileFormat" (optional.String) - File format name. See the <a href=\"https://support.phrase.com/hc/en-us/sections/6111343326364\">format guide</a> for all supported file formats.
  • @param "Tags" (optional.String) - Limit results to keys tagged with a list of comma separated tag names.
  • @param "Tag" (optional.String) - Limit download to tagged keys. This parameter is deprecated. Please use the \"tags\" parameter instead
  • @param "IncludeEmptyTranslations" (optional.Bool) - Indicates whether keys without translations should be included in the output as well.
  • @param "ExcludeEmptyZeroForms" (optional.Bool) - Indicates whether zero forms should be included when empty in pluralized keys.
  • @param "IncludeTranslatedKeys" (optional.Bool) - Include translated keys in the locale file. Use in combination with include_empty_translations to obtain only untranslated keys.
  • @param "KeepNotranslateTags" (optional.Bool) - Indicates whether [NOTRANSLATE] tags should be kept.
  • @param "ConvertEmoji" (optional.Bool) - This option is obsolete. Projects that were created on or after Nov 29th 2019 or that did not contain emoji by then will not require this flag any longer since emoji are now supported natively.
  • @param "FormatOptions" (optional.Interface of map[string]interface{}) - Additional formatting and render options. See the <a href=\"https://support.phrase.com/hc/en-us/sections/6111343326364\">format guide</a> for a list of options available for each format. Specify format options like this: <code>...&format_options[foo]=bar</code>
  • @param "Encoding" (optional.String) - Enforces a specific encoding on the file contents. Valid options are \"UTF-8\", \"UTF-16\" and \"ISO-8859-1\".
  • @param "SkipUnverifiedTranslations" (optional.Bool) - Indicates whether the locale file should skip all unverified translations. This parameter is deprecated and should be replaced with <code>include_unverified_translations</code>.
  • @param "IncludeUnverifiedTranslations" (optional.Bool) - if set to false unverified translations are excluded
  • @param "UseLastReviewedVersion" (optional.Bool) - If set to true the last reviewed version of a translation is used. This is only available if the review workflow is enabled for the project.
  • @param "FallbackLocaleId" (optional.String) - If a key has no translation in the locale being downloaded the translation in the fallback locale will be used. Provide the public ID of the locale that should be used as the fallback. Requires include_empty_translations to be set to <code>true</code>.
  • @param "SourceLocaleId" (optional.String) - Provides the source language of a corresponding job as the source language of the generated locale file. This parameter will be ignored unless used in combination with a <code>tag</code> parameter indicating a specific job.
  • @param "CustomMetadataFilters" (optional.Interface of map[string]interface{}) - Custom metadata filters. Provide the name of the metadata field and the value to filter by. Only keys with matching metadata will be included in the download.

@return *os.File

func (*LocalesApiService) LocaleShow ¶ 

func (a *LocalesApiService) LocaleShow(ctx _context.Context, projectId string, id string, localVarOptionals *LocaleShowOpts) (LocaleDetails, *APIResponse, error)

LocaleShow Get a single locale Get details on a single locale for a given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id Locale ID or locale name
  • @param optional nil or *LocaleShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return LocaleDetails

func (*LocalesApiService) LocaleUpdate ¶ 

func (a *LocalesApiService) LocaleUpdate(ctx _context.Context, projectId string, id string, localeUpdateParameters LocaleUpdateParameters, localVarOptionals *LocaleUpdateOpts) (LocaleDetails, *APIResponse, error)

LocaleUpdate Update a locale Update an existing locale.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id Locale ID or locale name
  • @param localeUpdateParameters
  • @param optional nil or *LocaleUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return LocaleDetails

func (*LocalesApiService) LocalesList ¶ 

func (a *LocalesApiService) LocalesList(ctx _context.Context, projectId string, localVarOptionals *LocalesListOpts) ([]Locale, *APIResponse, error)

LocalesList List locales List all locales for the given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *LocalesListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "SortBy" (optional.String) - Sort locales. Valid options are \"name_asc\", \"name_desc\", \"default_asc\", \"default_desc\".
  • @param "Branch" (optional.String) - specify the branch to use

@return []Locale

type LocalesListOpts ¶ 

type LocalesListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	SortBy        optional.String `json:"sort_by,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

LocalesListOpts Optional parameters for the method 'LocalesList'

type MappedNullable ¶ added in v2.17.0 

type MappedNullable interface {
	ToMap() (map[string]interface{}, error)
}

type Member ¶ 

type Member struct {
	Id                 string                 `json:"id,omitempty"`
	Email              string                 `json:"email,omitempty"`
	Username           string                 `json:"username,omitempty"`
	CreatedAt          time.Time              `json:"created_at,omitempty"`
	LastActivityAt     time.Time              `json:"last_activity_at,omitempty"`
	Role               string                 `json:"role,omitempty"`
	Projects           []ProjectLocales       `json:"projects,omitempty"`
	Permissions        map[string]interface{} `json:"permissions,omitempty"`
	DefaultLocaleCodes []string               `json:"default_locale_codes,omitempty"`
	Teams              []TeamShort            `json:"teams,omitempty"`
	Spaces             []MemberSpacesInner    `json:"spaces,omitempty"`
}

Member struct for Member

type MemberDeleteOpts ¶ 

type MemberDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

MemberDeleteOpts Optional parameters for the method 'MemberDelete'

type MemberProjectDetail ¶ 

type MemberProjectDetail struct {
	Id                 string                                 `json:"id,omitempty"`
	Email              string                                 `json:"email,omitempty"`
	Username           string                                 `json:"username,omitempty"`
	Role               string                                 `json:"role,omitempty"`
	Projects           []ProjectLocales                       `json:"projects,omitempty"`
	Permissions        map[string]interface{}                 `json:"permissions,omitempty"`
	LocaleIds          []string                               `json:"locale_ids,omitempty"`
	DefaultLocaleCodes []string                               `json:"default_locale_codes,omitempty"`
	Spaces             []MemberSpacesInner                    `json:"spaces,omitempty"`
	ProjectRoles       []MemberProjectDetailProjectRolesInner `json:"project_roles,omitempty"`
}

MemberProjectDetail struct for MemberProjectDetail

type MemberProjectDetailProjectRolesInner ¶ added in v2.17.0 

type MemberProjectDetailProjectRolesInner struct {
	ProjectId string `json:"project_id,omitempty"`
	Role      string `json:"role,omitempty"`
}

MemberProjectDetailProjectRolesInner struct for MemberProjectDetailProjectRolesInner

type MemberShowOpts ¶ 

type MemberShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

MemberShowOpts Optional parameters for the method 'MemberShow'

type MemberSpacesInner ¶ added in v2.17.0 

type MemberSpacesInner struct {
	Id            string    `json:"id,omitempty"`
	Name          string    `json:"name,omitempty"`
	CreatedAt     time.Time `json:"created_at,omitempty"`
	UpdatedAt     time.Time `json:"updated_at,omitempty"`
	ProjectsCount int32     `json:"projects_count,omitempty"`
}

MemberSpacesInner struct for MemberSpacesInner

type MemberUpdateOpts ¶ 

type MemberUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

MemberUpdateOpts Optional parameters for the method 'MemberUpdate'

type MemberUpdateParameters ¶ 

type MemberUpdateParameters struct {
	// Update strategy, can be any of set, add, remove. If provided, it will set, add or remove given spaces, projects and locale ids from users access list.
	Strategy string `json:"strategy,omitempty"`
	// Member role, can be any of of Admin, ProjectManager, Developer, Designer, Translator
	Role string `json:"role,omitempty"`
	// List of project ids the user has access to.
	ProjectIds string `json:"project_ids,omitempty"`
	// List of locale ids the user has access to.
	LocaleIds string `json:"locale_ids,omitempty"`
	// List of default locales for the user.
	DefaultLocaleCodes []string `json:"default_locale_codes,omitempty"`
	// List of spaces the user is assigned to.
	SpaceIds []string `json:"space_ids,omitempty"`
	// Additional permissions depending on member role. Available permissions are <code>create_upload</code> and <code>review_translations</code>
	Permissions map[string]string `json:"permissions,omitempty"`
}

MemberUpdateParameters struct for MemberUpdateParameters

type MemberUpdateSettingsOpts ¶ 

type MemberUpdateSettingsOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

MemberUpdateSettingsOpts Optional parameters for the method 'MemberUpdateSettings'

type MemberUpdateSettingsParameters ¶ 

type MemberUpdateSettingsParameters struct {
	// Member role, can be any of of Manager, Developer, Translator
	ProjectRole string `json:"project_role,omitempty"`
	// List of locale ids the user has access to.
	LocaleIds []string `json:"locale_ids,omitempty"`
}

MemberUpdateSettingsParameters struct for MemberUpdateSettingsParameters

type MembersApiService ¶ 

type MembersApiService service

MembersApiService MembersApi service

func (*MembersApiService) MemberDelete ¶ 

func (a *MembersApiService) MemberDelete(ctx _context.Context, accountId string, id string, localVarOptionals *MemberDeleteOpts) ([]byte, *APIResponse, error)

MemberDelete Remove a user from the account Remove a user from the account. The user will be removed from the account but not deleted from Phrase. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param optional nil or *MemberDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*MembersApiService) MemberShow ¶ 

func (a *MembersApiService) MemberShow(ctx _context.Context, accountId string, id string, localVarOptionals *MemberShowOpts) (Member, *APIResponse, error)

MemberShow Get single member Get details on a single user in the account. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param optional nil or *MemberShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Member

func (*MembersApiService) MemberUpdate ¶ 

func (a *MembersApiService) MemberUpdate(ctx _context.Context, accountId string, id string, memberUpdateParameters MemberUpdateParameters, localVarOptionals *MemberUpdateOpts) (Member, *APIResponse, error)

MemberUpdate Update a member Update user permissions in the account. Developers and translators need &lt;code&gt;project_ids&lt;/code&gt; and &lt;code&gt;locale_ids&lt;/code&gt; assigned to access them. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param memberUpdateParameters
  • @param optional nil or *MemberUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Member

func (*MembersApiService) MemberUpdateSettings ¶ 

func (a *MembersApiService) MemberUpdateSettings(ctx _context.Context, projectId string, id string, memberUpdateSettingsParameters MemberUpdateSettingsParameters, localVarOptionals *MemberUpdateSettingsOpts) (MemberProjectDetail, *APIResponse, error)

MemberUpdateSettings Update a member's project settings Update user settings in the project. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param memberUpdateSettingsParameters
  • @param optional nil or *MemberUpdateSettingsOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return MemberProjectDetail

func (*MembersApiService) MembersList ¶ 

func (a *MembersApiService) MembersList(ctx _context.Context, accountId string, localVarOptionals *MembersListOpts) ([]Member, *APIResponse, error)

MembersList List members Get all users active in the account. It also lists resources like projects and locales the member has access to. In case nothing is shown the default access from the role is used. Access token scope must include &lt;code&gt;team.manage&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param optional nil or *MembersListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []Member

type MembersListOpts ¶ 

type MembersListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

MembersListOpts Optional parameters for the method 'MembersList'

type ModelError ¶ added in v2.23.0 

type ModelError struct {
	Error ErrorError `json:"error,omitempty"`
}

ModelError Error field for when the request completely fails

type Notification ¶ added in v2.0.2 

type Notification struct {
	Id          string                 `json:"id,omitempty"`
	EventName   string                 `json:"event_name,omitempty"`
	CreatedAt   time.Time              `json:"created_at,omitempty"`
	UpdatedAt   time.Time              `json:"updated_at,omitempty"`
	DeliveredAt time.Time              `json:"delivered_at,omitempty"`
	SeenAt      time.Time              `json:"seen_at,omitempty"`
	Data        map[string]interface{} `json:"data,omitempty"`
	Resource    map[string]interface{} `json:"resource,omitempty"`
	Locale      Locale                 `json:"locale,omitempty"`
	User        UserPreview            `json:"user,omitempty"`
	Project     Project                `json:"project,omitempty"`
	Account     Account                `json:"account,omitempty"`
	Group       NotificationGroup      `json:"group,omitempty"`
}

Notification struct for Notification

type NotificationGroup ¶ added in v2.0.2 

type NotificationGroup struct {
	Id        string    `json:"id,omitempty"`
	EventName string    `json:"event_name,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

NotificationGroup struct for NotificationGroup

type NotificationGroupDetail ¶ added in v2.0.2 

type NotificationGroupDetail struct {
	Id                 string       `json:"id,omitempty"`
	EventName          string       `json:"event_name,omitempty"`
	CreatedAt          time.Time    `json:"created_at,omitempty"`
	UpdatedAt          time.Time    `json:"updated_at,omitempty"`
	NotificationsCount int32        `json:"notifications_count,omitempty"`
	LatestNotification Notification `json:"latest_notification,omitempty"`
}

NotificationGroupDetail struct for NotificationGroupDetail

type NotificationGroupsApiService ¶ added in v2.0.2 

type NotificationGroupsApiService service

NotificationGroupsApiService NotificationGroupsApi service

func (*NotificationGroupsApiService) NotificationGroupsList ¶ added in v2.0.2 

func (a *NotificationGroupsApiService) NotificationGroupsList(ctx _context.Context, localVarOptionals *NotificationGroupsListOpts) ([]NotificationGroupDetail, *APIResponse, error)

NotificationGroupsList List notification groups List all notification groups from the current user

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *NotificationGroupsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []NotificationGroupDetail

func (*NotificationGroupsApiService) NotificationGroupsMarkAllAsRead ¶ added in v2.0.2 

func (a *NotificationGroupsApiService) NotificationGroupsMarkAllAsRead(ctx _context.Context, localVarOptionals *NotificationGroupsMarkAllAsReadOpts) ([]NotificationGroupDetail, *APIResponse, error)

NotificationGroupsMarkAllAsRead Mark all notification groups as read Mark all notification groups of the current user as read

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *NotificationGroupsMarkAllAsReadOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return []NotificationGroupDetail

func (*NotificationGroupsApiService) NotificationGroupsMarkAsRead ¶ added in v2.0.2 

func (a *NotificationGroupsApiService) NotificationGroupsMarkAsRead(ctx _context.Context, id string, localVarOptionals *NotificationGroupsMarkAsReadOpts) (NotificationGroupDetail, *APIResponse, error)

NotificationGroupsMarkAsRead Mark a notification group as read Mark a notifications group of the current user as read

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID
  • @param optional nil or *NotificationGroupsMarkAsReadOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return NotificationGroupDetail

type NotificationGroupsListOpts ¶ added in v2.0.2 

type NotificationGroupsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

NotificationGroupsListOpts Optional parameters for the method 'NotificationGroupsList'

type NotificationGroupsMarkAllAsReadOpts ¶ added in v2.0.2 

type NotificationGroupsMarkAllAsReadOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

NotificationGroupsMarkAllAsReadOpts Optional parameters for the method 'NotificationGroupsMarkAllAsRead'

type NotificationGroupsMarkAsReadOpts ¶ added in v2.0.2 

type NotificationGroupsMarkAsReadOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

NotificationGroupsMarkAsReadOpts Optional parameters for the method 'NotificationGroupsMarkAsRead'

type NotificationsApiService ¶ added in v2.0.2 

type NotificationsApiService service

NotificationsApiService NotificationsApi service

func (*NotificationsApiService) NotificationsList ¶ added in v2.0.2 

func (a *NotificationsApiService) NotificationsList(ctx _context.Context, localVarOptionals *NotificationsListOpts) ([]Notification, *APIResponse, error)

NotificationsList List notifications List all notifications from the current user

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *NotificationsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Unseen" (optional.Bool) - Include only unseen notifications

@return []Notification

func (*NotificationsApiService) NotificationsMarkAllAsRead ¶ added in v2.0.2 

func (a *NotificationsApiService) NotificationsMarkAllAsRead(ctx _context.Context, localVarOptionals *NotificationsMarkAllAsReadOpts) ([]Notification, *APIResponse, error)

NotificationsMarkAllAsRead Mark all notifications as read Mark all notifications of the current user as read

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *NotificationsMarkAllAsReadOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return []Notification

func (*NotificationsApiService) NotificationsShow ¶ added in v2.0.2 

func (a *NotificationsApiService) NotificationsShow(ctx _context.Context, id string, localVarOptionals *NotificationsShowOpts) (Notification, *APIResponse, error)

NotificationsShow Get a single notification Get details on a single notification.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID
  • @param optional nil or *NotificationsShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Notification

type NotificationsListOpts ¶ added in v2.0.2 

type NotificationsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	Unseen        optional.Bool   `json:"unseen,omitempty"`
}

NotificationsListOpts Optional parameters for the method 'NotificationsList'

type NotificationsMarkAllAsReadOpts ¶ added in v2.0.2 

type NotificationsMarkAllAsReadOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

NotificationsMarkAllAsReadOpts Optional parameters for the method 'NotificationsMarkAllAsRead'

type NotificationsShowOpts ¶ added in v2.0.2 

type NotificationsShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

NotificationsShowOpts Optional parameters for the method 'NotificationsShow'

type NullableBool ¶ added in v2.17.0 

type NullableBool struct {
	// contains filtered or unexported fields
}

func NewNullableBool ¶ added in v2.17.0 

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get ¶ added in v2.17.0 

func (v NullableBool) Get() *bool

func (NullableBool) IsSet ¶ added in v2.17.0 

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON ¶ added in v2.17.0 

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set ¶ added in v2.17.0 

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON ¶ added in v2.17.0 

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset ¶ added in v2.17.0 

func (v *NullableBool) Unset()

type NullableFloat32 ¶ added in v2.17.0 

type NullableFloat32 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat32 ¶ added in v2.17.0 

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get ¶ added in v2.17.0 

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet ¶ added in v2.17.0 

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON ¶ added in v2.17.0 

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set ¶ added in v2.17.0 

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON ¶ added in v2.17.0 

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset ¶ added in v2.17.0 

func (v *NullableFloat32) Unset()

type NullableFloat64 ¶ added in v2.17.0 

type NullableFloat64 struct {
	// contains filtered or unexported fields
}

func NewNullableFloat64 ¶ added in v2.17.0 

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get ¶ added in v2.17.0 

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet ¶ added in v2.17.0 

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON ¶ added in v2.17.0 

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set ¶ added in v2.17.0 

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON ¶ added in v2.17.0 

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset ¶ added in v2.17.0 

func (v *NullableFloat64) Unset()

type NullableInt ¶ added in v2.17.0 

type NullableInt struct {
	// contains filtered or unexported fields
}

func NewNullableInt ¶ added in v2.17.0 

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get ¶ added in v2.17.0 

func (v NullableInt) Get() *int

func (NullableInt) IsSet ¶ added in v2.17.0 

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON ¶ added in v2.17.0 

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set ¶ added in v2.17.0 

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON ¶ added in v2.17.0 

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset ¶ added in v2.17.0 

func (v *NullableInt) Unset()

type NullableInt32 ¶ added in v2.17.0 

type NullableInt32 struct {
	// contains filtered or unexported fields
}

func NewNullableInt32 ¶ added in v2.17.0 

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get ¶ added in v2.17.0 

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet ¶ added in v2.17.0 

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON ¶ added in v2.17.0 

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set ¶ added in v2.17.0 

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON ¶ added in v2.17.0 

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset ¶ added in v2.17.0 

func (v *NullableInt32) Unset()

type NullableInt64 ¶ added in v2.17.0 

type NullableInt64 struct {
	// contains filtered or unexported fields
}

func NewNullableInt64 ¶ added in v2.17.0 

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get ¶ added in v2.17.0 

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet ¶ added in v2.17.0 

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON ¶ added in v2.17.0 

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set ¶ added in v2.17.0 

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON ¶ added in v2.17.0 

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset ¶ added in v2.17.0 

func (v *NullableInt64) Unset()

type NullableString ¶ added in v2.17.0 

type NullableString struct {
	// contains filtered or unexported fields
}

func NewNullableString ¶ added in v2.17.0 

func NewNullableString(val *string) *NullableString

func (NullableString) Get ¶ added in v2.17.0 

func (v NullableString) Get() *string

func (NullableString) IsSet ¶ added in v2.17.0 

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON ¶ added in v2.17.0 

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set ¶ added in v2.17.0 

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON ¶ added in v2.17.0 

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset ¶ added in v2.17.0 

func (v *NullableString) Unset()

type NullableTime ¶ added in v2.17.0 

type NullableTime struct {
	// contains filtered or unexported fields
}

func NewNullableTime ¶ added in v2.17.0 

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get ¶ added in v2.17.0 

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet ¶ added in v2.17.0 

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON ¶ added in v2.17.0 

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set ¶ added in v2.17.0 

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON ¶ added in v2.17.0 

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset ¶ added in v2.17.0 

func (v *NullableTime) Unset()

type OrderConfirmOpts ¶ 

type OrderConfirmOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

OrderConfirmOpts Optional parameters for the method 'OrderConfirm'

type OrderConfirmParameters ¶ 

type OrderConfirmParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
}

OrderConfirmParameters struct for OrderConfirmParameters

type OrderCreateOpts ¶ 

type OrderCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

OrderCreateOpts Optional parameters for the method 'OrderCreate'

type OrderCreateParameters ¶ 

type OrderCreateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// the name of the order, default name is: Translation order from 'current datetime'
	Name string `json:"name,omitempty"`
	// Name of the LSP that should process this order. Can be one of gengo, textmaster.
	Lsp string `json:"lsp,omitempty"`
	// Source locale for the order. Can be the name or public id of the source locale. Preferred is the public id.
	SourceLocaleId string `json:"source_locale_id,omitempty"`
	// List of target locales you want the source content translate to. Can be the name or public id of the target locales. Preferred is the public id.
	TargetLocaleIds []string `json:"target_locale_ids,omitempty"`
	// Name of the quality level, availability depends on the LSP. Can be one of:  standard, pro (for orders processed by Gengo) and one of regular, premium, enterprise (for orders processed by TextMaster)
	TranslationType string `json:"translation_type,omitempty"`
	// Tag you want to order translations for.
	Tag string `json:"tag,omitempty"`
	// Message that is displayed to the translators for description.
	Message string `json:"message,omitempty"`
	// Style guide for translators to be sent with the order.
	StyleguideId string `json:"styleguide_id,omitempty"`
	// Unverify translations upon delivery.
	UnverifyTranslationsUponDelivery *bool `json:"unverify_translations_upon_delivery,omitempty"`
	// Order translations for keys with untranslated content in the selected target locales.
	IncludeUntranslatedKeys *bool `json:"include_untranslated_keys,omitempty"`
	// Order translations for keys with unverified content in the selected target locales.
	IncludeUnverifiedTranslations *bool `json:"include_unverified_translations,omitempty"`
	// Category to use (required for orders processed by TextMaster).
	Category string `json:"category,omitempty"`
	// Extra proofreading option to ensure consistency in vocabulary and style. Only available for orders processed by TextMaster.
	Quality *bool `json:"quality,omitempty"`
	// Indicates whether the priority option should be ordered which decreases turnaround time by 30%. Available only for orders processed by TextMaster.
	Priority *bool `json:"priority,omitempty"`
}

OrderCreateParameters struct for OrderCreateParameters

type OrderDeleteOpts ¶ 

type OrderDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

OrderDeleteOpts Optional parameters for the method 'OrderDelete'

type OrderShowOpts ¶ 

type OrderShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

OrderShowOpts Optional parameters for the method 'OrderShow'

type OrdersApiService ¶ 

type OrdersApiService service

OrdersApiService OrdersApi service

func (*OrdersApiService) OrderConfirm ¶ 

func (a *OrdersApiService) OrderConfirm(ctx _context.Context, projectId string, id string, orderConfirmParameters OrderConfirmParameters, localVarOptionals *OrderConfirmOpts) (TranslationOrder, *APIResponse, error)

OrderConfirm Confirm an order Confirm an existing order and send it to the provider for translation. Same constraints as for create.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param orderConfirmParameters
  • @param optional nil or *OrderConfirmOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return TranslationOrder

func (*OrdersApiService) OrderCreate ¶ 

func (a *OrdersApiService) OrderCreate(ctx _context.Context, projectId string, orderCreateParameters OrderCreateParameters, localVarOptionals *OrderCreateOpts) (TranslationOrder, *APIResponse, error)

OrderCreate Create a new order Create a new order. Access token scope must include &lt;code&gt;orders.create&lt;/code&gt;.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param orderCreateParameters
  • @param optional nil or *OrderCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return TranslationOrder

func (*OrdersApiService) OrderDelete ¶ 

func (a *OrdersApiService) OrderDelete(ctx _context.Context, projectId string, id string, localVarOptionals *OrderDeleteOpts) ([]byte, *APIResponse, error)

OrderDelete Cancel an order Cancel an existing order. Must not yet be confirmed.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *OrderDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*OrdersApiService) OrderShow ¶ 

func (a *OrdersApiService) OrderShow(ctx _context.Context, projectId string, id string, localVarOptionals *OrderShowOpts) (TranslationOrder, *APIResponse, error)

OrderShow Get a single order Get details on a single order.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *OrderShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return TranslationOrder

func (*OrdersApiService) OrdersList ¶ 

func (a *OrdersApiService) OrdersList(ctx _context.Context, projectId string, localVarOptionals *OrdersListOpts) ([]TranslationOrder, *APIResponse, error)

OrdersList List orders List all orders for the given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *OrdersListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use

@return []TranslationOrder

type OrdersListOpts ¶ 

type OrdersListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

OrdersListOpts Optional parameters for the method 'OrdersList'

type OrganizationJobTemplate ¶ added in v2.7.0 

type OrganizationJobTemplate struct {
	Id        string    `json:"id,omitempty"`
	Name      string    `json:"name,omitempty"`
	Briefing  string    `json:"briefing,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

OrganizationJobTemplate struct for OrganizationJobTemplate

type OrganizationJobTemplateCreateOpts ¶ added in v2.7.0 

type OrganizationJobTemplateCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

OrganizationJobTemplateCreateOpts Optional parameters for the method 'OrganizationJobTemplateCreate'

type OrganizationJobTemplateCreateParameters ¶ added in v2.7.0 

type OrganizationJobTemplateCreateParameters struct {
	// Job template name
	Name string `json:"name"`
	// Briefing for the translators
	Briefing string `json:"briefing,omitempty"`
}

OrganizationJobTemplateCreateParameters struct for OrganizationJobTemplateCreateParameters

type OrganizationJobTemplateDeleteOpts ¶ added in v2.7.0 

type OrganizationJobTemplateDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

OrganizationJobTemplateDeleteOpts Optional parameters for the method 'OrganizationJobTemplateDelete'

type OrganizationJobTemplateDetails ¶ added in v2.7.0 

type OrganizationJobTemplateDetails struct {
	Id        string          `json:"id,omitempty"`
	Name      string          `json:"name,omitempty"`
	Briefing  string          `json:"briefing,omitempty"`
	CreatedAt time.Time       `json:"created_at,omitempty"`
	UpdatedAt time.Time       `json:"updated_at,omitempty"`
	Owner     UserPreview     `json:"owner,omitempty"`
	Creator   UserPreview     `json:"creator,omitempty"`
	Locales   []LocalePreview `json:"locales,omitempty"`
}

OrganizationJobTemplateDetails struct for OrganizationJobTemplateDetails

type OrganizationJobTemplateLocaleDeleteOpts ¶ added in v2.7.0 

type OrganizationJobTemplateLocaleDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

OrganizationJobTemplateLocaleDeleteOpts Optional parameters for the method 'OrganizationJobTemplateLocaleDelete'

type OrganizationJobTemplateLocaleShowOpts ¶ added in v2.7.0 

type OrganizationJobTemplateLocaleShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

OrganizationJobTemplateLocaleShowOpts Optional parameters for the method 'OrganizationJobTemplateLocaleShow'

type OrganizationJobTemplateLocaleUpdateOpts ¶ added in v2.7.0 

type OrganizationJobTemplateLocaleUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

OrganizationJobTemplateLocaleUpdateOpts Optional parameters for the method 'OrganizationJobTemplateLocaleUpdate'

type OrganizationJobTemplateLocaleUpdateParameters ¶ added in v2.7.0 

type OrganizationJobTemplateLocaleUpdateParameters struct {
	// locale name
	LocaleName string `json:"locale_name,omitempty"`
	// locale code
	LocaleCode string `json:"locale_code,omitempty"`
	// Array of user ids to be assigned to the job template locale
	UserIds []string `json:"user_ids,omitempty"`
	// Array of reviewer ids to be assigned to the job template locale
	ReviewerIds []string `json:"reviewer_ids,omitempty"`
	// Array of team ids to be assigned to the job locale as translators
	TranslatorTeamIds []string `json:"translator_team_ids,omitempty"`
	// Array of team ids to be assigned to the job locale as reviewers
	ReviewerTeamIds []string `json:"reviewer_team_ids,omitempty"`
}

OrganizationJobTemplateLocaleUpdateParameters struct for OrganizationJobTemplateLocaleUpdateParameters

type OrganizationJobTemplateLocalesApiService ¶ added in v2.7.0 

type OrganizationJobTemplateLocalesApiService service

OrganizationJobTemplateLocalesApiService OrganizationJobTemplateLocalesApi service

func (*OrganizationJobTemplateLocalesApiService) OrganizationJobTemplateLocaleDelete ¶ added in v2.7.0 

func (a *OrganizationJobTemplateLocalesApiService) OrganizationJobTemplateLocaleDelete(ctx _context.Context, accountId string, jobTemplateId string, jobTemplateLocaleId string, localVarOptionals *OrganizationJobTemplateLocaleDeleteOpts) ([]byte, *APIResponse, error)

OrganizationJobTemplateLocaleDelete Delete an organization job template locale Delete an existing organization job template locale.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param jobTemplateId Job Template ID
  • @param jobTemplateLocaleId Job Template Locale ID
  • @param optional nil or *OrganizationJobTemplateLocaleDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*OrganizationJobTemplateLocalesApiService) OrganizationJobTemplateLocaleShow ¶ added in v2.7.0 

func (a *OrganizationJobTemplateLocalesApiService) OrganizationJobTemplateLocaleShow(ctx _context.Context, accountId string, jobTemplateId string, jobTemplateLocaleId string, localVarOptionals *OrganizationJobTemplateLocaleShowOpts) (JobTemplateLocales, *APIResponse, error)

OrganizationJobTemplateLocaleShow Get a single organization job template locale Get a single job template locale for a given organization job template.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param jobTemplateId Job Template ID
  • @param jobTemplateLocaleId Job Template Locale ID
  • @param optional nil or *OrganizationJobTemplateLocaleShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobTemplateLocales

func (*OrganizationJobTemplateLocalesApiService) OrganizationJobTemplateLocaleUpdate ¶ added in v2.7.0 

func (a *OrganizationJobTemplateLocalesApiService) OrganizationJobTemplateLocaleUpdate(ctx _context.Context, accountId string, jobTemplateId string, jobTemplateLocaleId string, organizationJobTemplateLocaleUpdateParameters OrganizationJobTemplateLocaleUpdateParameters, localVarOptionals *OrganizationJobTemplateLocaleUpdateOpts) (JobTemplateLocales, *APIResponse, error)

OrganizationJobTemplateLocaleUpdate Update an organization job template locale Update an existing organization job template locale.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param jobTemplateId Job Template ID
  • @param jobTemplateLocaleId Job Template Locale ID
  • @param organizationJobTemplateLocaleUpdateParameters
  • @param optional nil or *OrganizationJobTemplateLocaleUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobTemplateLocales

func (*OrganizationJobTemplateLocalesApiService) OrganizationJobTemplateLocalesCreate ¶ added in v2.7.0 

func (a *OrganizationJobTemplateLocalesApiService) OrganizationJobTemplateLocalesCreate(ctx _context.Context, accountId string, jobTemplateId string, organizationJobTemplateLocalesCreateParameters OrganizationJobTemplateLocalesCreateParameters, localVarOptionals *OrganizationJobTemplateLocalesCreateOpts) (JobTemplateLocales, *APIResponse, error)

OrganizationJobTemplateLocalesCreate Create an organization job template locale Create a new organization job template locale.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param jobTemplateId Job Template ID
  • @param organizationJobTemplateLocalesCreateParameters
  • @param optional nil or *OrganizationJobTemplateLocalesCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return JobTemplateLocales

func (*OrganizationJobTemplateLocalesApiService) OrganizationJobTemplateLocalesList ¶ added in v2.7.0 

func (a *OrganizationJobTemplateLocalesApiService) OrganizationJobTemplateLocalesList(ctx _context.Context, accountId string, jobTemplateId string, localVarOptionals *OrganizationJobTemplateLocalesListOpts) ([]JobTemplateLocales, *APIResponse, error)

OrganizationJobTemplateLocalesList List organization job template locales List all job template locales for a given organization job template.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param jobTemplateId Job Template ID
  • @param optional nil or *OrganizationJobTemplateLocalesListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []JobTemplateLocales

type OrganizationJobTemplateLocalesCreateOpts ¶ added in v2.7.0 

type OrganizationJobTemplateLocalesCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

OrganizationJobTemplateLocalesCreateOpts Optional parameters for the method 'OrganizationJobTemplateLocalesCreate'

type OrganizationJobTemplateLocalesCreateParameters ¶ added in v2.7.0 

type OrganizationJobTemplateLocalesCreateParameters struct {
	// locale name
	LocaleName string `json:"locale_name"`
	// locale code
	LocaleCode string `json:"locale_code"`
	// Array of user ids to be assigned to the job template locale
	UserIds []string `json:"user_ids,omitempty"`
	// Array of reviewer ids to be assigned to the job template locale
	ReviewerIds []string `json:"reviewer_ids,omitempty"`
	// Array of team ids to be assigned to the job locale as translators
	TranslatorTeamIds []string `json:"translator_team_ids,omitempty"`
	// Array of team ids to be assigned to the job locale as reviewers
	ReviewerTeamIds []string `json:"reviewer_team_ids,omitempty"`
}

OrganizationJobTemplateLocalesCreateParameters struct for OrganizationJobTemplateLocalesCreateParameters

type OrganizationJobTemplateLocalesListOpts ¶ added in v2.7.0 

type OrganizationJobTemplateLocalesListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

OrganizationJobTemplateLocalesListOpts Optional parameters for the method 'OrganizationJobTemplateLocalesList'

type OrganizationJobTemplateUpdateOpts ¶ added in v2.7.0 

type OrganizationJobTemplateUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

OrganizationJobTemplateUpdateOpts Optional parameters for the method 'OrganizationJobTemplateUpdate'

type OrganizationJobTemplateUpdateParameters ¶ added in v2.7.0 

type OrganizationJobTemplateUpdateParameters struct {
	// Job template name
	Name string `json:"name"`
	// Briefing for the translators
	Briefing string `json:"briefing,omitempty"`
}

OrganizationJobTemplateUpdateParameters struct for OrganizationJobTemplateUpdateParameters

type OrganizationJobTemplatesApiService ¶ added in v2.7.0 

type OrganizationJobTemplatesApiService service

OrganizationJobTemplatesApiService OrganizationJobTemplatesApi service

func (*OrganizationJobTemplatesApiService) OrganizationJobTemplateCreate ¶ added in v2.7.0 

func (a *OrganizationJobTemplatesApiService) OrganizationJobTemplateCreate(ctx _context.Context, accountId string, organizationJobTemplateCreateParameters OrganizationJobTemplateCreateParameters, localVarOptionals *OrganizationJobTemplateCreateOpts) (OrganizationJobTemplateDetails, *APIResponse, error)

OrganizationJobTemplateCreate Create an organization job template Create a new organization job template.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param organizationJobTemplateCreateParameters
  • @param optional nil or *OrganizationJobTemplateCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return OrganizationJobTemplateDetails

func (*OrganizationJobTemplatesApiService) OrganizationJobTemplateDelete ¶ added in v2.7.0 

func (a *OrganizationJobTemplatesApiService) OrganizationJobTemplateDelete(ctx _context.Context, accountId string, id string, localVarOptionals *OrganizationJobTemplateDeleteOpts) ([]byte, *APIResponse, error)

OrganizationJobTemplateDelete Delete an organization job template Delete an existing organization job template.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param optional nil or *OrganizationJobTemplateDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*OrganizationJobTemplatesApiService) OrganizationJobTemplateUpdate ¶ added in v2.7.0 

func (a *OrganizationJobTemplatesApiService) OrganizationJobTemplateUpdate(ctx _context.Context, accountId string, id string, organizationJobTemplateUpdateParameters OrganizationJobTemplateUpdateParameters, localVarOptionals *OrganizationJobTemplateUpdateOpts) (OrganizationJobTemplateDetails, *APIResponse, error)

OrganizationJobTemplateUpdate Update an organization job template Update an existing organization job template.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param organizationJobTemplateUpdateParameters
  • @param optional nil or *OrganizationJobTemplateUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return OrganizationJobTemplateDetails

func (*OrganizationJobTemplatesApiService) OrganizationJobTemplatesList ¶ added in v2.7.0 

func (a *OrganizationJobTemplatesApiService) OrganizationJobTemplatesList(ctx _context.Context, accountId string, localVarOptionals *OrganizationJobTemplatesListOpts) ([]OrganizationJobTemplate, *APIResponse, error)

OrganizationJobTemplatesList List organization job templates List all job templates for the given account.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param optional nil or *OrganizationJobTemplatesListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []OrganizationJobTemplate

func (*OrganizationJobTemplatesApiService) OrganizationJobTemplatesShow ¶ added in v2.7.0 

func (a *OrganizationJobTemplatesApiService) OrganizationJobTemplatesShow(ctx _context.Context, accountId string, id string, localVarOptionals *OrganizationJobTemplatesShowOpts) (OrganizationJobTemplateDetails, *APIResponse, error)

OrganizationJobTemplatesShow Get a single organization job template Get details on a single organization job template for a given account.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param optional nil or *OrganizationJobTemplatesShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return OrganizationJobTemplateDetails

type OrganizationJobTemplatesListOpts ¶ added in v2.7.0 

type OrganizationJobTemplatesListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

OrganizationJobTemplatesListOpts Optional parameters for the method 'OrganizationJobTemplatesList'

type OrganizationJobTemplatesShowOpts ¶ added in v2.7.0 

type OrganizationJobTemplatesShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

OrganizationJobTemplatesShowOpts Optional parameters for the method 'OrganizationJobTemplatesShow'

type Project ¶ 

type Project struct {
	Id              string      `json:"id,omitempty"`
	Name            string      `json:"name,omitempty"`
	Slug            string      `json:"slug,omitempty"`
	MainFormat      string      `json:"main_format,omitempty"`
	ProjectImageUrl string      `json:"project_image_url,omitempty"`
	Media           string      `json:"media,omitempty"`
	Account         Account     `json:"account,omitempty"`
	Space           Space1      `json:"space,omitempty"`
	PointOfContact  UserPreview `json:"point_of_contact,omitempty"`
	CreatedAt       time.Time   `json:"created_at,omitempty"`
	UpdatedAt       time.Time   `json:"updated_at,omitempty"`
}

Project struct for Project

type ProjectCreateOpts ¶ 

type ProjectCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

ProjectCreateOpts Optional parameters for the method 'ProjectCreate'

type ProjectCreateParameters ¶ 

type ProjectCreateParameters struct {
	// Name of the project
	Name string `json:"name,omitempty"`
	// Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see <a href=\"https://support.phrase.com/hc/en-us/sections/6111343326364\">Format Guide</a> or our <a href=\"#formats\">Formats API Endpoint</a>.
	MainFormat string `json:"main_format,omitempty"`
	// (Optional) Main technology stack used in the project. It affects for example the suggested placeholder style. Predefined values include: `Ruby`, `JavaScript`, `AngularJS`, `React`, `iOS`, `Android`, `Python`, `PHP`, `Java`, `Go`, `Windows Phone`, `Rails`, `Node.js`, `.NET`, `Django`, `Symfony`, `Yii Framework`, `Zend Framework`, `Apple App Store Description`, `Google Play Description`, but it can also take any other value.
	Media string `json:"media,omitempty"`
	// Indicates whether the project should share the account's translation memory
	SharesTranslationMemory *bool `json:"shares_translation_memory,omitempty"`
	// Image to identify the project
	ProjectImage *os.File `json:"project_image,omitempty"`
	// Indicates whether the project image should be deleted.
	RemoveProjectImage *bool `json:"remove_project_image,omitempty"`
	// Account ID to specify the actual account the project should be created in. Required if the requesting user is a member of multiple accounts.
	AccountId string `json:"account_id,omitempty"`
	// (Optional) User ID of the point of contact for the project.
	PointOfContact string `json:"point_of_contact,omitempty"`
	// When a source project ID is given, a clone of that project will be created, including all locales, keys and translations as well as the main project settings if they are not defined otherwise through the params.
	SourceProjectId string `json:"source_project_id,omitempty"`
	// (Optional) Review Workflow. \"simple\" / \"review\". <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\">Read more</a>
	Workflow string `json:"workflow,omitempty"`
	// (Optional) Enable machine translation support in the project. Required for Autopilot and Smart Suggest
	MachineTranslationEnabled *bool `json:"machine_translation_enabled,omitempty"`
	// (Optional) Enable branching in the project
	EnableBranching *bool `json:"enable_branching,omitempty"`
	// (Optional) Protect the master branch in project where branching is enabled
	ProtectMasterBranch *bool `json:"protect_master_branch,omitempty"`
	// (Optional) Otherwise, translators are not allowed to edit translations other than strings
	EnableAllDataTypeTranslationKeysForTranslators *bool `json:"enable_all_data_type_translation_keys_for_translators,omitempty"`
	// (Optional) We can validate and highlight your ICU messages. <a href=\"https://support.phrase.com/hc/en-us/articles/5822319545116\">Read more</a>
	EnableIcuMessageFormat *bool `json:"enable_icu_message_format,omitempty"`
	// (Optional) Displays the input fields for the 'ZERO' plural form for every key as well although only some languages require the 'ZERO' explicitly.
	ZeroPluralFormEnabled *bool `json:"zero_plural_form_enabled,omitempty"`
	// (Optional) Autopilot, requires machine_translation_enabled. <a href=\"https://support.phrase.com/hc/en-us/articles/5822187934364\">Read more</a>
	AutotranslateEnabled *bool `json:"autotranslate_enabled,omitempty"`
	// (Optional) Requires autotranslate_enabled to be true
	AutotranslateCheckNewTranslationKeys *bool `json:"autotranslate_check_new_translation_keys,omitempty"`
	// (Optional) Requires autotranslate_enabled to be true
	AutotranslateCheckNewUploads *bool `json:"autotranslate_check_new_uploads,omitempty"`
	// (Optional) Requires autotranslate_enabled to be true
	AutotranslateCheckNewLocales *bool `json:"autotranslate_check_new_locales,omitempty"`
	// (Optional) Requires autotranslate_enabled to be true
	AutotranslateMarkAsUnverified *bool `json:"autotranslate_mark_as_unverified,omitempty"`
	// (Optional) Requires autotranslate_enabled to be true
	AutotranslateUseMachineTranslation *bool `json:"autotranslate_use_machine_translation,omitempty"`
	// (Optional) Requires autotranslate_enabled to be true
	AutotranslateUseTranslationMemory *bool `json:"autotranslate_use_translation_memory,omitempty"`
	// (Optional) Smart Suggest, requires machine_translation_enabled
	SmartSuggestEnabled *bool `json:"smart_suggest_enabled,omitempty"`
	// (Optional) Requires smart_suggest_enabled to be true
	SmartSuggestUseGlossary *bool `json:"smart_suggest_use_glossary,omitempty"`
	// (Optional) Requires smart_suggest_enabled to be true
	SmartSuggestUseMachineTranslation *bool `json:"smart_suggest_use_machine_translation,omitempty"`
}

ProjectCreateParameters struct for ProjectCreateParameters

type ProjectDeleteOpts ¶ 

type ProjectDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

ProjectDeleteOpts Optional parameters for the method 'ProjectDelete'

type ProjectDetails ¶ 

type ProjectDetails struct {
	Id                      string      `json:"id,omitempty"`
	Name                    string      `json:"name,omitempty"`
	Slug                    string      `json:"slug,omitempty"`
	MainFormat              string      `json:"main_format,omitempty"`
	ProjectImageUrl         string      `json:"project_image_url,omitempty"`
	Media                   string      `json:"media,omitempty"`
	Account                 Account     `json:"account,omitempty"`
	Space                   Space1      `json:"space,omitempty"`
	PointOfContact          UserPreview `json:"point_of_contact,omitempty"`
	CreatedAt               time.Time   `json:"created_at,omitempty"`
	UpdatedAt               time.Time   `json:"updated_at,omitempty"`
	SharesTranslationMemory *bool       `json:"shares_translation_memory,omitempty"`
}

ProjectDetails struct for ProjectDetails

type ProjectLocales ¶ 

type ProjectLocales struct {
	Id          string          `json:"id,omitempty"`
	Name        string          `json:"name,omitempty"`
	ProjectRole string          `json:"project_role,omitempty"`
	MainFormat  string          `json:"main_format,omitempty"`
	CreatedAt   time.Time       `json:"created_at,omitempty"`
	UpdatedAt   time.Time       `json:"updated_at,omitempty"`
	Locales     []LocalePreview `json:"locales,omitempty"`
}

ProjectLocales struct for ProjectLocales

type ProjectReport ¶ added in v2.19.0 

type ProjectReport struct {
	LocalesCount                int32        `json:"locales_count,omitempty"`
	KeysCount                   int32        `json:"keys_count,omitempty"`
	TranslationsCount           int32        `json:"translations_count,omitempty"`
	UntranslatedKeysCount       int32        `json:"untranslated_keys_count,omitempty"`
	UnverifiedTranslationsCount int32        `json:"unverified_translations_count,omitempty"`
	ReviewedTranslationsCount   int32        `json:"reviewed_translations_count,omitempty"`
	ManagedWordsCount           int32        `json:"managed_words_count,omitempty"`
	Project                     ProjectShort `json:"project,omitempty"`
}

ProjectReport struct for ProjectReport

type ProjectShort ¶ 

type ProjectShort struct {
	Id         string    `json:"id,omitempty"`
	Name       string    `json:"name,omitempty"`
	MainFormat string    `json:"main_format,omitempty"`
	CreatedAt  time.Time `json:"created_at,omitempty"`
	UpdatedAt  time.Time `json:"updated_at,omitempty"`
}

ProjectShort struct for ProjectShort

type ProjectShowOpts ¶ 

type ProjectShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

ProjectShowOpts Optional parameters for the method 'ProjectShow'

type ProjectUpdateOpts ¶ 

type ProjectUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

ProjectUpdateOpts Optional parameters for the method 'ProjectUpdate'

type ProjectUpdateParameters ¶ 

type ProjectUpdateParameters struct {
	// Required if the requesting user is a member of multiple accounts. Account ID to specify the actual account the project should be created in.
	AccountId string `json:"account_id,omitempty"`
	// (Optional) Name of the project
	Name string `json:"name,omitempty"`
	// (Optional) User ID of the point of contact for the project. Pass `null` to unset.
	PointOfContact string `json:"point_of_contact,omitempty"`
	// (Optional) Main file format specified by its API Extension name. Used for locale downloads if no format is specified. For API Extension names of available file formats see <a href=\"https://support.phrase.com/hc/en-us/sections/6111343326364\">Format Guide</a> or our <a href=\"#formats\">Formats API Endpoint</a>.
	MainFormat string `json:"main_format,omitempty"`
	// (Optional) Main technology stack used in the project. It affects for example the suggested placeholder style. Predefined values include: `Ruby`, `JavaScript`, `AngularJS`, `React`, `iOS`, `Android`, `Python`, `PHP`, `Java`, `Go`, `Windows Phone`, `Rails`, `Node.js`, `.NET`, `Django`, `Symfony`, `Yii Framework`, `Zend Framework`, `Apple App Store Description`, `Google Play Description`, but it can also take any other value.
	Media string `json:"media,omitempty"`
	// (Optional) Indicates whether the project should share the account's translation memory
	SharesTranslationMemory *bool `json:"shares_translation_memory,omitempty"`
	// (Optional) Image to identify the project
	ProjectImage *os.File `json:"project_image,omitempty"`
	// (Optional) Indicates whether the project image should be deleted.
	RemoveProjectImage *bool `json:"remove_project_image,omitempty"`
	// (Optional) Review Workflow. \"simple\" / \"review\". <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\">Read more</a>
	Workflow string `json:"workflow,omitempty"`
	// (Optional) Enable machine translation support in the project. Required for Autopilot and Smart Suggest
	MachineTranslationEnabled *bool `json:"machine_translation_enabled,omitempty"`
	// (Optional) Enable branching in the project
	EnableBranching *bool `json:"enable_branching,omitempty"`
	// (Optional) Protect the master branch in project where branching is enabled
	ProtectMasterBranch *bool `json:"protect_master_branch,omitempty"`
	// (Optional) Otherwise, translators are not allowed to edit translations other than strings
	EnableAllDataTypeTranslationKeysForTranslators *bool `json:"enable_all_data_type_translation_keys_for_translators,omitempty"`
	// (Optional) We can validate and highlight your ICU messages. <a href=\"https://support.phrase.com/hc/en-us/articles/5822319545116\">Read more</a>
	EnableIcuMessageFormat *bool `json:"enable_icu_message_format,omitempty"`
	// (Optional) Displays the input fields for the 'ZERO' plural form for every key as well although only some languages require the 'ZERO' explicitly.
	ZeroPluralFormEnabled *bool `json:"zero_plural_form_enabled,omitempty"`
	// (Optional) Autopilot, requires machine_translation_enabled. <a href=\"https://support.phrase.com/hc/en-us/articles/5822187934364\">Read more</a>
	AutotranslateEnabled *bool `json:"autotranslate_enabled,omitempty"`
	// (Optional) Requires autotranslate_enabled to be true
	AutotranslateCheckNewTranslationKeys *bool `json:"autotranslate_check_new_translation_keys,omitempty"`
	// (Optional) Requires autotranslate_enabled to be true
	AutotranslateCheckNewUploads *bool `json:"autotranslate_check_new_uploads,omitempty"`
	// (Optional) Requires autotranslate_enabled to be true
	AutotranslateCheckNewLocales *bool `json:"autotranslate_check_new_locales,omitempty"`
	// (Optional) Requires autotranslate_enabled to be true
	AutotranslateMarkAsUnverified *bool `json:"autotranslate_mark_as_unverified,omitempty"`
	// (Optional) Requires autotranslate_enabled to be true
	AutotranslateUseMachineTranslation *bool `json:"autotranslate_use_machine_translation,omitempty"`
	// (Optional) Requires autotranslate_enabled to be true
	AutotranslateUseTranslationMemory *bool `json:"autotranslate_use_translation_memory,omitempty"`
	// (Optional) Smart Suggest, requires machine_translation_enabled
	SmartSuggestEnabled *bool `json:"smart_suggest_enabled,omitempty"`
	// (Optional) Requires smart_suggest_enabled to be true
	SmartSuggestUseGlossary *bool `json:"smart_suggest_use_glossary,omitempty"`
	// (Optional) Requires smart_suggest_enabled to be true
	SmartSuggestUseMachineTranslation *bool `json:"smart_suggest_use_machine_translation,omitempty"`
}

ProjectUpdateParameters struct for ProjectUpdateParameters

type ProjectsApiService ¶ 

type ProjectsApiService service

ProjectsApiService ProjectsApi service

func (*ProjectsApiService) ProjectCreate ¶ 

func (a *ProjectsApiService) ProjectCreate(ctx _context.Context, projectCreateParameters ProjectCreateParameters, localVarOptionals *ProjectCreateOpts) (ProjectDetails, *APIResponse, error)

ProjectCreate Create a project Create a new project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectCreateParameters
  • @param optional nil or *ProjectCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return ProjectDetails

func (*ProjectsApiService) ProjectDelete ¶ 

func (a *ProjectsApiService) ProjectDelete(ctx _context.Context, id string, localVarOptionals *ProjectDeleteOpts) ([]byte, *APIResponse, error)

ProjectDelete Delete a project Delete an existing project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID
  • @param optional nil or *ProjectDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*ProjectsApiService) ProjectShow ¶ 

func (a *ProjectsApiService) ProjectShow(ctx _context.Context, id string, localVarOptionals *ProjectShowOpts) (ProjectDetails, *APIResponse, error)

ProjectShow Get a single project Get details on a single project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID
  • @param optional nil or *ProjectShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return ProjectDetails

func (*ProjectsApiService) ProjectUpdate ¶ 

func (a *ProjectsApiService) ProjectUpdate(ctx _context.Context, id string, projectUpdateParameters ProjectUpdateParameters, localVarOptionals *ProjectUpdateOpts) (ProjectDetails, *APIResponse, error)

ProjectUpdate Update a project Update an existing project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param id ID
  • @param projectUpdateParameters
  • @param optional nil or *ProjectUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return ProjectDetails

func (*ProjectsApiService) ProjectsList ¶ 

func (a *ProjectsApiService) ProjectsList(ctx _context.Context, localVarOptionals *ProjectsListOpts) ([]Project, *APIResponse, error)

ProjectsList List projects List all projects the current user has access to.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *ProjectsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "AccountId" (optional.String) - Filter by Account ID
  • @param "SortBy" (optional.String) - Sort projects. Valid options are \"name_asc\", \"name_desc\", \"updated_at_asc\", \"updated_at_desc\", \"space_asc\" and \"space_desc\".
  • @param "Filters" (optional.Interface of []string) - Filter projects. Valid options are [\"favorites\"].

@return []Project

type ProjectsListOpts ¶ 

type ProjectsListOpts struct {
	XPhraseAppOTP optional.String    `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32     `json:"page,omitempty"`
	PerPage       optional.Int32     `json:"per_page,omitempty"`
	AccountId     optional.String    `json:"account_id,omitempty"`
	SortBy        optional.String    `json:"sort_by,omitempty"`
	Filters       optional.Interface `json:"filters,omitempty"`
}

ProjectsListOpts Optional parameters for the method 'ProjectsList'

type ProjectsQualityPerformanceScore200Response ¶ added in v2.23.0 

type ProjectsQualityPerformanceScore200Response struct {
	Error ErrorError                                          `json:"error,omitempty"`
	Data  ProjectsQualityPerformanceScore200ResponseAnyOfData `json:"data,omitempty"`
	// Array of errors for any failing translation IDs
	Errors []ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner `json:"errors,omitempty"`
}

ProjectsQualityPerformanceScore200Response struct for ProjectsQualityPerformanceScore200Response

type ProjectsQualityPerformanceScore200ResponseAnyOf ¶ added in v2.23.0 

type ProjectsQualityPerformanceScore200ResponseAnyOf struct {
	Data ProjectsQualityPerformanceScore200ResponseAnyOfData `json:"data,omitempty"`
	// Array of errors for any failing translation IDs
	Errors []ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner `json:"errors,omitempty"`
}

ProjectsQualityPerformanceScore200ResponseAnyOf struct for ProjectsQualityPerformanceScore200ResponseAnyOf

type ProjectsQualityPerformanceScore200ResponseAnyOfData ¶ added in v2.23.0 

type ProjectsQualityPerformanceScore200ResponseAnyOfData struct {
	Translations []ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner `json:"translations,omitempty"`
}

ProjectsQualityPerformanceScore200ResponseAnyOfData struct for ProjectsQualityPerformanceScore200ResponseAnyOfData

type ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner ¶ added in v2.23.0 

type ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner struct {
	// Engine used for the translation scoring
	Engine string `json:"engine,omitempty"`
	// Quality score for the translation
	Score float32 `json:"score,omitempty"`
	// One of the translation ids passed in arguments
	Id string `json:"id,omitempty"`
}

ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner struct for ProjectsQualityPerformanceScore200ResponseAnyOfDataTranslationsInner

type ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner ¶ added in v2.23.0 

type ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner struct {
	Message string `json:"message,omitempty"`
	Code    string `json:"code,omitempty"`
	// One of the translation ids passed in arguments
	Id string `json:"id,omitempty"`
}

ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner struct for ProjectsQualityPerformanceScore200ResponseAnyOfErrorsInner

type ProjectsQualityPerformanceScoreOpts ¶ added in v2.23.0 

type ProjectsQualityPerformanceScoreOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

ProjectsQualityPerformanceScoreOpts Optional parameters for the method 'ProjectsQualityPerformanceScore'

type ProjectsQualityPerformanceScoreRequest ¶ added in v2.23.0 

type ProjectsQualityPerformanceScoreRequest struct {
	// Translation ids you want to get the quality performance score for
	TranslationIds []string `json:"translation_ids,omitempty"`
}

ProjectsQualityPerformanceScoreRequest struct for ProjectsQualityPerformanceScoreRequest

type QualityPerformanceScoreApiService ¶ added in v2.23.0 

type QualityPerformanceScoreApiService service

QualityPerformanceScoreApiService QualityPerformanceScoreApi service

func (*QualityPerformanceScoreApiService) ProjectsQualityPerformanceScore ¶ added in v2.23.0 

func (a *QualityPerformanceScoreApiService) ProjectsQualityPerformanceScore(ctx _context.Context, projectId string, projectsQualityPerformanceScoreRequest ProjectsQualityPerformanceScoreRequest, localVarOptionals *ProjectsQualityPerformanceScoreOpts) (ProjectsQualityPerformanceScore200Response, *APIResponse, error)

ProjectsQualityPerformanceScore Get Translation Quality Retrieves the quality scores for your Strings translations. Returns a score, measured by Phrase QPS

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param projectsQualityPerformanceScoreRequest
  • @param optional nil or *ProjectsQualityPerformanceScoreOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return ProjectsQualityPerformanceScore200Response

type Rate ¶ 

type Rate struct {
	// The number of requests per hour the client is currently limited to.
	Limit int `json:"limit"`

	// The number of remaining requests the client can make this hour.
	Remaining int `json:"remaining"`

	// The time at which the current rate limit will reset.
	Reset Timestamp `json:"reset"`
}

Rate represents the rate limit for the current client.

type ReactionCreateOpts ¶ added in v2.11.0 

type ReactionCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
	Emoji         optional.String `json:"emoji,omitempty"`
}

ReactionCreateOpts Optional parameters for the method 'ReactionCreate'

type ReactionDeleteOpts ¶ added in v2.11.0 

type ReactionDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

ReactionDeleteOpts Optional parameters for the method 'ReactionDelete'

type ReactionShowOpts ¶ added in v2.11.0 

type ReactionShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

ReactionShowOpts Optional parameters for the method 'ReactionShow'

type ReactionsListOpts ¶ added in v2.11.0 

type ReactionsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

ReactionsListOpts Optional parameters for the method 'ReactionsList'

type Release ¶ 

type Release struct {
	Id            string          `json:"id,omitempty"`
	Version       int32           `json:"version,omitempty"`
	AppMinVersion string          `json:"app_min_version,omitempty"`
	AppMaxVersion string          `json:"app_max_version,omitempty"`
	Description   string          `json:"description,omitempty"`
	Platforms     []string        `json:"platforms,omitempty"`
	Environments  []string        `json:"environments,omitempty"`
	Locales       []LocalePreview `json:"locales,omitempty"`
	Tags          []string        `json:"tags,omitempty"`
	Project       ProjectShort    `json:"project,omitempty"`
	CreatedAt     time.Time       `json:"created_at,omitempty"`
	UpdatedAt     time.Time       `json:"updated_at,omitempty"`
}

Release struct for Release

type ReleaseCreateOpts ¶ 

type ReleaseCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

ReleaseCreateOpts Optional parameters for the method 'ReleaseCreate'

type ReleaseCreateParameters ¶ 

type ReleaseCreateParameters struct {
	// Description of the release
	Description string `json:"description,omitempty"`
	// List of platforms the release should support.
	Platforms []string `json:"platforms,omitempty"`
	// List of locale ids that will be included in the release. If empty, distribution locales will be used
	LocaleIds []string `json:"locale_ids,omitempty"`
	// Only include tagged keys in the release. For a key to be included it must be tagged with all tags provided
	Tags []string `json:"tags,omitempty"`
	// Branch used for release
	Branch string `json:"branch,omitempty"`
}

ReleaseCreateParameters struct for ReleaseCreateParameters

type ReleaseDeleteOpts ¶ 

type ReleaseDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

ReleaseDeleteOpts Optional parameters for the method 'ReleaseDelete'

type ReleasePreview ¶ 

type ReleasePreview struct {
	Id            string       `json:"id,omitempty"`
	Version       int32        `json:"version,omitempty"`
	AppMinVersion string       `json:"app_min_version,omitempty"`
	AppMaxVersion string       `json:"app_max_version,omitempty"`
	Description   string       `json:"description,omitempty"`
	Platforms     []string     `json:"platforms,omitempty"`
	Environments  []string     `json:"environments,omitempty"`
	LocaleCodes   []string     `json:"locale_codes,omitempty"`
	Tags          []string     `json:"tags,omitempty"`
	Project       ProjectShort `json:"project,omitempty"`
	CreatedAt     time.Time    `json:"created_at,omitempty"`
	UpdatedAt     time.Time    `json:"updated_at,omitempty"`
}

ReleasePreview struct for ReleasePreview

type ReleasePublishOpts ¶ 

type ReleasePublishOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

ReleasePublishOpts Optional parameters for the method 'ReleasePublish'

type ReleaseShowOpts ¶ 

type ReleaseShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

ReleaseShowOpts Optional parameters for the method 'ReleaseShow'

type ReleaseUpdateOpts ¶ 

type ReleaseUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

ReleaseUpdateOpts Optional parameters for the method 'ReleaseUpdate'

type ReleaseUpdateParameters ¶ 

type ReleaseUpdateParameters struct {
	// Description of the release
	Description string `json:"description,omitempty"`
	// List of platforms the release should support.
	Platforms []string `json:"platforms,omitempty"`
	// Branch used for release
	Branch string `json:"branch,omitempty"`
}

ReleaseUpdateParameters struct for ReleaseUpdateParameters

type ReleasesApiService ¶ 

type ReleasesApiService service

ReleasesApiService ReleasesApi service

func (*ReleasesApiService) ReleaseCreate ¶ 

func (a *ReleasesApiService) ReleaseCreate(ctx _context.Context, accountId string, distributionId string, releaseCreateParameters ReleaseCreateParameters, localVarOptionals *ReleaseCreateOpts) (Release, *APIResponse, error)

ReleaseCreate Create a release Create a new release.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param distributionId Distribution ID
  • @param releaseCreateParameters
  • @param optional nil or *ReleaseCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Release

func (*ReleasesApiService) ReleaseDelete ¶ 

func (a *ReleasesApiService) ReleaseDelete(ctx _context.Context, accountId string, distributionId string, id string, localVarOptionals *ReleaseDeleteOpts) ([]byte, *APIResponse, error)

ReleaseDelete Delete a release Delete an existing release.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param distributionId Distribution ID
  • @param id ID
  • @param optional nil or *ReleaseDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*ReleasesApiService) ReleasePublish ¶ 

func (a *ReleasesApiService) ReleasePublish(ctx _context.Context, accountId string, distributionId string, id string, localVarOptionals *ReleasePublishOpts) (Release, *APIResponse, error)

ReleasePublish Publish a release Publish a release for production.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param distributionId Distribution ID
  • @param id ID
  • @param optional nil or *ReleasePublishOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Release

func (*ReleasesApiService) ReleaseShow ¶ 

func (a *ReleasesApiService) ReleaseShow(ctx _context.Context, accountId string, distributionId string, id string, localVarOptionals *ReleaseShowOpts) (Release, *APIResponse, error)

ReleaseShow Get a single release Get details on a single release.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param distributionId Distribution ID
  • @param id ID
  • @param optional nil or *ReleaseShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Release

func (*ReleasesApiService) ReleaseUpdate ¶ 

func (a *ReleasesApiService) ReleaseUpdate(ctx _context.Context, accountId string, distributionId string, id string, releaseUpdateParameters ReleaseUpdateParameters, localVarOptionals *ReleaseUpdateOpts) (Release, *APIResponse, error)

ReleaseUpdate Update a release Update an existing release.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param distributionId Distribution ID
  • @param id ID
  • @param releaseUpdateParameters
  • @param optional nil or *ReleaseUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Release

func (*ReleasesApiService) ReleasesList ¶ 

func (a *ReleasesApiService) ReleasesList(ctx _context.Context, accountId string, distributionId string, localVarOptionals *ReleasesListOpts) ([]ReleasePreview, *APIResponse, error)

ReleasesList List releases List all releases for the given distribution.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param distributionId Distribution ID
  • @param optional nil or *ReleasesListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []ReleasePreview

type ReleasesListOpts ¶ 

type ReleasesListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

ReleasesListOpts Optional parameters for the method 'ReleasesList'

type RepliesListOpts ¶ added in v2.12.0 

type RepliesListOpts struct {
	XPhraseAppOTP optional.String    `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32     `json:"page,omitempty"`
	PerPage       optional.Int32     `json:"per_page,omitempty"`
	Branch        optional.String    `json:"branch,omitempty"`
	Query         optional.String    `json:"query,omitempty"`
	Filters       optional.Interface `json:"filters,omitempty"`
	Order         optional.String    `json:"order,omitempty"`
}

RepliesListOpts Optional parameters for the method 'RepliesList'

type RepliesListParameters ¶ added in v2.13.0 

type RepliesListParameters struct {
	// Specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Search query for comment messages
	Query string `json:"query,omitempty"`
	// Specify filters to find comments by
	Filters []string `json:"filters,omitempty"`
	// Specify ordering of comments
	Order string `json:"order,omitempty"`
}

RepliesListParameters struct for RepliesListParameters

type ReplyCreateOpts ¶ added in v2.12.0 

type ReplyCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
	Message       optional.String `json:"message,omitempty"`
}

ReplyCreateOpts Optional parameters for the method 'ReplyCreate'

type ReplyDeleteOpts ¶ added in v2.12.0 

type ReplyDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

ReplyDeleteOpts Optional parameters for the method 'ReplyDelete'

type ReplyMarkAsReadOpts ¶ added in v2.12.0 

type ReplyMarkAsReadOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

ReplyMarkAsReadOpts Optional parameters for the method 'ReplyMarkAsRead'

type ReplyMarkAsUnreadOpts ¶ added in v2.12.0 

type ReplyMarkAsUnreadOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

ReplyMarkAsUnreadOpts Optional parameters for the method 'ReplyMarkAsUnread'

type ReplyShowOpts ¶ added in v2.12.0 

type ReplyShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

ReplyShowOpts Optional parameters for the method 'ReplyShow'

type RepoSync ¶ added in v2.26.0 

type RepoSync struct {
	Id           string       `json:"id,omitempty"`
	Project      ProjectShort `json:"project,omitempty"`
	Provider     string       `json:"provider,omitempty"`
	Enabled      *bool        `json:"enabled,omitempty"`
	AutoImport   *bool        `json:"auto_import,omitempty"`
	RepoName     string       `json:"repo_name,omitempty"`
	CreatedAt    time.Time    `json:"created_at,omitempty"`
	LastImportAt time.Time    `json:"last_import_at,omitempty"`
	LastExportAt time.Time    `json:"last_export_at,omitempty"`
}

RepoSync struct for RepoSync

type RepoSyncActivateOpts ¶ added in v2.26.0 

type RepoSyncActivateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

RepoSyncActivateOpts Optional parameters for the method 'RepoSyncActivate'

type RepoSyncDeactivateOpts ¶ added in v2.26.0 

type RepoSyncDeactivateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

RepoSyncDeactivateOpts Optional parameters for the method 'RepoSyncDeactivate'

type RepoSyncEvent ¶ added in v2.26.0 

type RepoSyncEvent struct {
	EventType string    `json:"event_type,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	Status    string    `json:"status,omitempty"`
	// URL of the pull request created on export
	PullRequestUrl string `json:"pull_request_url,omitempty"`
	// Whether the import was triggered by the repo push event
	AutoImport *bool `json:"auto_import,omitempty"`
	// List of error messages, in case of failure
	Errors []RepoSyncEventErrorsInner `json:"errors,omitempty"`
}

RepoSyncEvent struct for RepoSyncEvent

type RepoSyncEventErrorsInner ¶ added in v2.26.0 

type RepoSyncEventErrorsInner struct {
}

RepoSyncEventErrorsInner struct for RepoSyncEventErrorsInner

type RepoSyncEventsOpts ¶ added in v2.26.0 

type RepoSyncEventsOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

RepoSyncEventsOpts Optional parameters for the method 'RepoSyncEvents'

type RepoSyncExport ¶ added in v2.26.0 

type RepoSyncExport struct {
	Message string `json:"message,omitempty"`
}

RepoSyncExport struct for RepoSyncExport

type RepoSyncExportOpts ¶ added in v2.26.0 

type RepoSyncExportOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

RepoSyncExportOpts Optional parameters for the method 'RepoSyncExport'

type RepoSyncImport ¶ added in v2.26.0 

type RepoSyncImport struct {
	Message string `json:"message,omitempty"`
}

RepoSyncImport struct for RepoSyncImport

type RepoSyncImportOpts ¶ added in v2.26.0 

type RepoSyncImportOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

RepoSyncImportOpts Optional parameters for the method 'RepoSyncImport'

type RepoSyncListOpts ¶ added in v2.26.0 

type RepoSyncListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

RepoSyncListOpts Optional parameters for the method 'RepoSyncList'

type RepoSyncShowOpts ¶ added in v2.26.0 

type RepoSyncShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

RepoSyncShowOpts Optional parameters for the method 'RepoSyncShow'

type RepoSyncsApiService ¶ added in v2.26.0 

type RepoSyncsApiService service

RepoSyncsApiService RepoSyncsApi service

func (*RepoSyncsApiService) RepoSyncActivate ¶ added in v2.26.0 

func (a *RepoSyncsApiService) RepoSyncActivate(ctx _context.Context, accountId string, repoSyncId string, localVarOptionals *RepoSyncActivateOpts) (RepoSync, *APIResponse, error)

RepoSyncActivate Activate a Repo Sync Activate a deactivated Repo Sync. Active syncs can be used to import and export translations, and imports to Phrase are automatically triggered by pushes to the repository, if configured.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param repoSyncId Repo Sync ID
  • @param optional nil or *RepoSyncActivateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return RepoSync

func (*RepoSyncsApiService) RepoSyncDeactivate ¶ added in v2.26.0 

func (a *RepoSyncsApiService) RepoSyncDeactivate(ctx _context.Context, accountId string, repoSyncId string, localVarOptionals *RepoSyncDeactivateOpts) (RepoSync, *APIResponse, error)

RepoSyncDeactivate Deactivate a Repo Sync Deactivate an active Repo Sync. Import and export can&#39;t be performed on deactivated syncs and the pushes to the repository won&#39;t trigger the import to Phrase.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param repoSyncId Repo Sync ID
  • @param optional nil or *RepoSyncDeactivateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return RepoSync

func (*RepoSyncsApiService) RepoSyncEvents ¶ added in v2.26.0 

func (a *RepoSyncsApiService) RepoSyncEvents(ctx _context.Context, accountId string, repoSyncId string, localVarOptionals *RepoSyncEventsOpts) ([]RepoSyncEvent, *APIResponse, error)

RepoSyncEvents Repository Syncs History Get the history of a single Repo Sync. The history includes all imports and exports performed by the Repo Sync.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param repoSyncId Repo Sync ID
  • @param optional nil or *RepoSyncEventsOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return []RepoSyncEvent

func (*RepoSyncsApiService) RepoSyncExport ¶ added in v2.26.0 

func (a *RepoSyncsApiService) RepoSyncExport(ctx _context.Context, accountId string, repoSyncId string, localVarOptionals *RepoSyncExportOpts) (RepoSyncExport, *APIResponse, error)

RepoSyncExport Export to code repository &gt; Beta: this feature will change in the future. Export translations from Phrase Strings to repository provider according to the .phrase.yml file within the code repository. *Export is done asynchronously and may take several seconds depending on the project size.*

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param repoSyncId Repo Sync ID
  • @param optional nil or *RepoSyncExportOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return RepoSyncExport

func (*RepoSyncsApiService) RepoSyncImport ¶ added in v2.26.0 

func (a *RepoSyncsApiService) RepoSyncImport(ctx _context.Context, accountId string, repoSyncId string, localVarOptionals *RepoSyncImportOpts) (RepoSyncImport, *APIResponse, error)

RepoSyncImport Import from code repository &gt; Beta: this feature will change in the future. Import translations from repository provider to Phrase Strings according to the .phrase.yml file within the code repository. _Import is done asynchronously and may take several seconds depending on the project size._

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param repoSyncId Repo Sync ID
  • @param optional nil or *RepoSyncImportOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return RepoSyncImport

func (*RepoSyncsApiService) RepoSyncList ¶ added in v2.26.0 

func (a *RepoSyncsApiService) RepoSyncList(ctx _context.Context, accountId string, localVarOptionals *RepoSyncListOpts) ([]RepoSync, *APIResponse, error)

RepoSyncList Get Repo Syncs Lists all Repo Syncs from an account

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param optional nil or *RepoSyncListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return []RepoSync

func (*RepoSyncsApiService) RepoSyncShow ¶ added in v2.26.0 

func (a *RepoSyncsApiService) RepoSyncShow(ctx _context.Context, accountId string, repoSyncId string, localVarOptionals *RepoSyncShowOpts) (RepoSync, *APIResponse, error)

RepoSyncShow Get a single Repo Sync Shows a single Repo Sync setting.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param repoSyncId Repo Sync ID
  • @param optional nil or *RepoSyncShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return RepoSync

type ReportLocalesListOpts ¶ added in v2.19.0 

type ReportLocalesListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	LocaleCodes   optional.String `json:"locale_codes,omitempty"`
	Tag           optional.String `json:"tag,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

ReportLocalesListOpts Optional parameters for the method 'ReportLocalesList'

type ReportShowOpts ¶ added in v2.19.0 

type ReportShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

ReportShowOpts Optional parameters for the method 'ReportShow'

type ReportsApiService ¶ added in v2.19.0 

type ReportsApiService service

ReportsApiService ReportsApi service

func (*ReportsApiService) ReportLocalesList ¶ added in v2.19.0 

func (a *ReportsApiService) ReportLocalesList(ctx _context.Context, projectId string, localVarOptionals *ReportLocalesListOpts) ([]LocaleReport, *APIResponse, error)

ReportLocalesList List Locale Reports List all locale reports for the given project

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *ReportLocalesListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "LocaleCodes" (optional.String) - Locale Code
  • @param "Tag" (optional.String) - tag
  • @param "Branch" (optional.String) - specify the branch to use

@return []LocaleReport

func (*ReportsApiService) ReportShow ¶ added in v2.19.0 

func (a *ReportsApiService) ReportShow(ctx _context.Context, projectId string, localVarOptionals *ReportShowOpts) (ProjectReport, *APIResponse, error)

ReportShow Get Project Report Get report of a single project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *ReportShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return ProjectReport

type Screenshot ¶ 

type Screenshot struct {
	Id            string    `json:"id,omitempty"`
	Name          string    `json:"name,omitempty"`
	Description   string    `json:"description,omitempty"`
	ScreenshotUrl string    `json:"screenshot_url,omitempty"`
	CreatedAt     time.Time `json:"created_at,omitempty"`
	UpdatedAt     time.Time `json:"updated_at,omitempty"`
	MarkersCount  int32     `json:"markers_count,omitempty"`
}

Screenshot struct for Screenshot

type ScreenshotCreateOpts ¶ 

type ScreenshotCreateOpts struct {
	XPhraseAppOTP optional.String    `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String    `json:"branch,omitempty"`
	Name          optional.String    `json:"name,omitempty"`
	Description   optional.String    `json:"description,omitempty"`
	Filename      optional.Interface `json:"filename,omitempty"`
}

ScreenshotCreateOpts Optional parameters for the method 'ScreenshotCreate'

type ScreenshotDeleteOpts ¶ 

type ScreenshotDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

ScreenshotDeleteOpts Optional parameters for the method 'ScreenshotDelete'

type ScreenshotMarker ¶ 

type ScreenshotMarker struct {
	Id               string         `json:"id,omitempty"`
	Presentation     string         `json:"presentation,omitempty"`
	PresentationType string         `json:"presentation_type,omitempty"`
	CreatedAt        time.Time      `json:"created_at,omitempty"`
	UpdatedAt        time.Time      `json:"updated_at,omitempty"`
	TranslationKey   TranslationKey `json:"translation_key,omitempty"`
}

ScreenshotMarker struct for ScreenshotMarker

type ScreenshotMarkerCreateOpts ¶ 

type ScreenshotMarkerCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

ScreenshotMarkerCreateOpts Optional parameters for the method 'ScreenshotMarkerCreate'

type ScreenshotMarkerCreateParameters ¶ 

type ScreenshotMarkerCreateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project.
	KeyId string `json:"key_id,omitempty"`
	// Presentation details of the screenshot marker in JSON format.<br/><br/>Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (<code>x</code>-axis and <code>y</code>-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (<code>w</code> and <code>h</code> in pixels).
	Presentation string `json:"presentation,omitempty"`
}

ScreenshotMarkerCreateParameters struct for ScreenshotMarkerCreateParameters

type ScreenshotMarkerDeleteOpts ¶ 

type ScreenshotMarkerDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

ScreenshotMarkerDeleteOpts Optional parameters for the method 'ScreenshotMarkerDelete'

type ScreenshotMarkerShowOpts ¶ 

type ScreenshotMarkerShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

ScreenshotMarkerShowOpts Optional parameters for the method 'ScreenshotMarkerShow'

type ScreenshotMarkerUpdateOpts ¶ 

type ScreenshotMarkerUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

ScreenshotMarkerUpdateOpts Optional parameters for the method 'ScreenshotMarkerUpdate'

type ScreenshotMarkerUpdateParameters ¶ 

type ScreenshotMarkerUpdateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Specify the Key ID which should be highlighted on the specified screenshot. The Key must belong to the project.
	KeyId string `json:"key_id,omitempty"`
	// Presentation details of the screenshot marker in JSON format.<br/><br/>Each Screenshot Marker is represented as a rectangular shaped highlight box with the name of the specified Key attached. You can specify the marker position on the screenshot (<code>x</code>-axis and <code>y</code>-axis in pixels) from the top left corner of the screenshot and the dimensions of the marker itself (<code>w</code> and <code>h</code> in pixels).
	Presentation string `json:"presentation,omitempty"`
}

ScreenshotMarkerUpdateParameters struct for ScreenshotMarkerUpdateParameters

type ScreenshotMarkersApiService ¶ 

type ScreenshotMarkersApiService service

ScreenshotMarkersApiService ScreenshotMarkersApi service

func (*ScreenshotMarkersApiService) ScreenshotMarkerCreate ¶ 

func (a *ScreenshotMarkersApiService) ScreenshotMarkerCreate(ctx _context.Context, projectId string, screenshotId string, screenshotMarkerCreateParameters ScreenshotMarkerCreateParameters, localVarOptionals *ScreenshotMarkerCreateOpts) (ScreenshotMarker, *APIResponse, error)

ScreenshotMarkerCreate Create a screenshot marker Create a new screenshot marker.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param screenshotId Screenshot ID
  • @param screenshotMarkerCreateParameters
  • @param optional nil or *ScreenshotMarkerCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return ScreenshotMarker

func (*ScreenshotMarkersApiService) ScreenshotMarkerDelete ¶ 

func (a *ScreenshotMarkersApiService) ScreenshotMarkerDelete(ctx _context.Context, projectId string, screenshotId string, localVarOptionals *ScreenshotMarkerDeleteOpts) ([]byte, *APIResponse, error)

ScreenshotMarkerDelete Delete a screenshot marker Delete an existing screenshot marker.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param screenshotId Screenshot ID
  • @param optional nil or *ScreenshotMarkerDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*ScreenshotMarkersApiService) ScreenshotMarkerShow ¶ 

func (a *ScreenshotMarkersApiService) ScreenshotMarkerShow(ctx _context.Context, projectId string, screenshotId string, id string, localVarOptionals *ScreenshotMarkerShowOpts) (ScreenshotMarker, *APIResponse, error)

ScreenshotMarkerShow Get a single screenshot marker Get details on a single screenshot marker for a given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param screenshotId Screenshot ID
  • @param id ID
  • @param optional nil or *ScreenshotMarkerShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return ScreenshotMarker

func (*ScreenshotMarkersApiService) ScreenshotMarkerUpdate ¶ 

func (a *ScreenshotMarkersApiService) ScreenshotMarkerUpdate(ctx _context.Context, projectId string, screenshotId string, screenshotMarkerUpdateParameters ScreenshotMarkerUpdateParameters, localVarOptionals *ScreenshotMarkerUpdateOpts) (ScreenshotMarker, *APIResponse, error)

ScreenshotMarkerUpdate Update a screenshot marker Update an existing screenshot marker.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param screenshotId Screenshot ID
  • @param screenshotMarkerUpdateParameters
  • @param optional nil or *ScreenshotMarkerUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return ScreenshotMarker

func (*ScreenshotMarkersApiService) ScreenshotMarkersList ¶ 

func (a *ScreenshotMarkersApiService) ScreenshotMarkersList(ctx _context.Context, projectId string, id string, localVarOptionals *ScreenshotMarkersListOpts) ([]ScreenshotMarker, *APIResponse, error)

ScreenshotMarkersList List screenshot markers List all screenshot markers for the given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *ScreenshotMarkersListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use

@return []ScreenshotMarker

type ScreenshotMarkersListOpts ¶ 

type ScreenshotMarkersListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

ScreenshotMarkersListOpts Optional parameters for the method 'ScreenshotMarkersList'

type ScreenshotShowOpts ¶ 

type ScreenshotShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

ScreenshotShowOpts Optional parameters for the method 'ScreenshotShow'

type ScreenshotUpdateOpts ¶ 

type ScreenshotUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

ScreenshotUpdateOpts Optional parameters for the method 'ScreenshotUpdate'

type ScreenshotUpdateParameters ¶ 

type ScreenshotUpdateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Name of the screenshot
	Name string `json:"name,omitempty"`
	// Description of the screenshot
	Description string `json:"description,omitempty"`
	// Screenshot file
	Filename *os.File `json:"filename,omitempty"`
}

ScreenshotUpdateParameters struct for ScreenshotUpdateParameters

type ScreenshotsApiService ¶ 

type ScreenshotsApiService service

ScreenshotsApiService ScreenshotsApi service

func (*ScreenshotsApiService) ScreenshotCreate ¶ 

func (a *ScreenshotsApiService) ScreenshotCreate(ctx _context.Context, projectId string, localVarOptionals *ScreenshotCreateOpts) (Screenshot, *APIResponse, error)

ScreenshotCreate Create a screenshot Create a new screenshot.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *ScreenshotCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use
  • @param "Name" (optional.String) - Name of the screenshot
  • @param "Description" (optional.String) - Description of the screenshot
  • @param "Filename" (optional.Interface of *os.File) - Screenshot file

@return Screenshot

func (*ScreenshotsApiService) ScreenshotDelete ¶ 

func (a *ScreenshotsApiService) ScreenshotDelete(ctx _context.Context, projectId string, id string, localVarOptionals *ScreenshotDeleteOpts) ([]byte, *APIResponse, error)

ScreenshotDelete Delete a screenshot Delete an existing screenshot.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *ScreenshotDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*ScreenshotsApiService) ScreenshotShow ¶ 

func (a *ScreenshotsApiService) ScreenshotShow(ctx _context.Context, projectId string, id string, localVarOptionals *ScreenshotShowOpts) (Screenshot, *APIResponse, error)

ScreenshotShow Get a single screenshot Get details on a single screenshot for a given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *ScreenshotShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return Screenshot

func (*ScreenshotsApiService) ScreenshotUpdate ¶ 

func (a *ScreenshotsApiService) ScreenshotUpdate(ctx _context.Context, projectId string, id string, screenshotUpdateParameters ScreenshotUpdateParameters, localVarOptionals *ScreenshotUpdateOpts) (Screenshot, *APIResponse, error)

ScreenshotUpdate Update a screenshot Update an existing screenshot.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param screenshotUpdateParameters
  • @param optional nil or *ScreenshotUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Screenshot

func (*ScreenshotsApiService) ScreenshotsList ¶ 

func (a *ScreenshotsApiService) ScreenshotsList(ctx _context.Context, projectId string, localVarOptionals *ScreenshotsListOpts) ([]Screenshot, *APIResponse, error)

ScreenshotsList List screenshots List all screenshots for the given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *ScreenshotsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use
  • @param "KeyId" (optional.String) - filter by key

@return []Screenshot

type ScreenshotsListOpts ¶ 

type ScreenshotsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
	KeyId         optional.String `json:"key_id,omitempty"`
}

ScreenshotsListOpts Optional parameters for the method 'ScreenshotsList'

type SearchApiService ¶ added in v2.1.0 

type SearchApiService service

SearchApiService SearchApi service

func (*SearchApiService) SearchInAccount ¶ added in v2.1.0 

func (a *SearchApiService) SearchInAccount(ctx _context.Context, accountId string, searchInAccountParameters SearchInAccountParameters, localVarOptionals *SearchInAccountOpts) (AccountSearchResult, *APIResponse, error)

SearchInAccount Search across projects Search for keys and translations in all account projects &lt;br&gt;&lt;br&gt;&lt;i&gt;Note: Search is limited to 10000 results and may not include recently updated data depending on the project sizes.&lt;/i&gt;

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param searchInAccountParameters
  • @param optional nil or *SearchInAccountOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return AccountSearchResult

type SearchInAccountOpts ¶ added in v2.1.0 

type SearchInAccountOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

SearchInAccountOpts Optional parameters for the method 'SearchInAccount'

type SearchInAccountParameters ¶ added in v2.1.0 

type SearchInAccountParameters struct {
	// Search query
	Query string `json:"query,omitempty"`
	// Locale code
	LocaleCode string `json:"locale_code,omitempty"`
	// Page
	Page int32 `json:"page,omitempty"`
	// Number of results per page
	PerPage int32 `json:"per_page,omitempty"`
}

SearchInAccountParameters struct for SearchInAccountParameters

type ServerConfiguration ¶ 

type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerVariable ¶ 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type ShowUserOpts ¶ 

type ShowUserOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

ShowUserOpts Optional parameters for the method 'ShowUser'

type Space ¶ 

type Space struct {
	Id            string    `json:"id,omitempty"`
	Name          string    `json:"name,omitempty"`
	CreatedAt     time.Time `json:"created_at,omitempty"`
	UpdatedAt     time.Time `json:"updated_at,omitempty"`
	ProjectsCount int32     `json:"projects_count,omitempty"`
	Projects      []Project `json:"projects,omitempty"`
}

Space struct for Space

type Space1 ¶ added in v2.0.1 

type Space1 struct {
	Id            string    `json:"id,omitempty"`
	Name          string    `json:"name,omitempty"`
	CreatedAt     time.Time `json:"created_at,omitempty"`
	UpdatedAt     time.Time `json:"updated_at,omitempty"`
	ProjectsCount int32     `json:"projects_count,omitempty"`
}

Space1 struct for Space1

type SpaceCreateOpts ¶ 

type SpaceCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

SpaceCreateOpts Optional parameters for the method 'SpaceCreate'

type SpaceCreateParameters ¶ 

type SpaceCreateParameters struct {
	// Name of the space
	Name string `json:"name,omitempty"`
}

SpaceCreateParameters struct for SpaceCreateParameters

type SpaceDeleteOpts ¶ 

type SpaceDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

SpaceDeleteOpts Optional parameters for the method 'SpaceDelete'

type SpaceShowOpts ¶ 

type SpaceShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

SpaceShowOpts Optional parameters for the method 'SpaceShow'

type SpaceUpdateOpts ¶ 

type SpaceUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

SpaceUpdateOpts Optional parameters for the method 'SpaceUpdate'

type SpaceUpdateParameters ¶ 

type SpaceUpdateParameters struct {
	// New name of the space
	Name string `json:"name,omitempty"`
}

SpaceUpdateParameters struct for SpaceUpdateParameters

type SpacesApiService ¶ 

type SpacesApiService service

SpacesApiService SpacesApi service

func (*SpacesApiService) SpaceCreate ¶ 

func (a *SpacesApiService) SpaceCreate(ctx _context.Context, accountId string, spaceCreateParameters SpaceCreateParameters, localVarOptionals *SpaceCreateOpts) (Space, *APIResponse, error)

SpaceCreate Create a Space Create a new Space.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param spaceCreateParameters
  • @param optional nil or *SpaceCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Space

func (*SpacesApiService) SpaceDelete ¶ 

func (a *SpacesApiService) SpaceDelete(ctx _context.Context, accountId string, id string, localVarOptionals *SpaceDeleteOpts) ([]byte, *APIResponse, error)

SpaceDelete Delete Space Delete the specified Space.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param optional nil or *SpaceDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*SpacesApiService) SpaceShow ¶ 

func (a *SpacesApiService) SpaceShow(ctx _context.Context, accountId string, id string, localVarOptionals *SpaceShowOpts) (Space, *APIResponse, error)

SpaceShow Get Space Show the specified Space.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param optional nil or *SpaceShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Space

func (*SpacesApiService) SpaceUpdate ¶ 

func (a *SpacesApiService) SpaceUpdate(ctx _context.Context, accountId string, id string, spaceUpdateParameters SpaceUpdateParameters, localVarOptionals *SpaceUpdateOpts) (Space, *APIResponse, error)

SpaceUpdate Update Space Update the specified Space.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param spaceUpdateParameters
  • @param optional nil or *SpaceUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Space

func (*SpacesApiService) SpacesList ¶ 

func (a *SpacesApiService) SpacesList(ctx _context.Context, accountId string, localVarOptionals *SpacesListOpts) ([]Space, *APIResponse, error)

SpacesList List Spaces List all Spaces for the given account.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param optional nil or *SpacesListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []Space

func (*SpacesApiService) SpacesProjectsCreate ¶ 

func (a *SpacesApiService) SpacesProjectsCreate(ctx _context.Context, accountId string, spaceId string, spacesProjectsCreateParameters SpacesProjectsCreateParameters, localVarOptionals *SpacesProjectsCreateOpts) ([]byte, *APIResponse, error)

SpacesProjectsCreate Add Project to Space Adds an existing project to the space.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param spaceId Space ID
  • @param spacesProjectsCreateParameters
  • @param optional nil or *SpacesProjectsCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*SpacesApiService) SpacesProjectsDelete ¶ 

func (a *SpacesApiService) SpacesProjectsDelete(ctx _context.Context, accountId string, spaceId string, id string, localVarOptionals *SpacesProjectsDeleteOpts) ([]byte, *APIResponse, error)

SpacesProjectsDelete Remove Project from Space Removes a specified project from the specified space.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param spaceId Space ID
  • @param id ID
  • @param optional nil or *SpacesProjectsDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*SpacesApiService) SpacesProjectsList ¶ 

func (a *SpacesApiService) SpacesProjectsList(ctx _context.Context, accountId string, spaceId string, localVarOptionals *SpacesProjectsListOpts) ([]Project, *APIResponse, error)

SpacesProjectsList List Projects in Space List all projects for the specified Space.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param spaceId Space ID
  • @param optional nil or *SpacesProjectsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []Project

type SpacesListOpts ¶ 

type SpacesListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

SpacesListOpts Optional parameters for the method 'SpacesList'

type SpacesProjectsCreateOpts ¶ 

type SpacesProjectsCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

SpacesProjectsCreateOpts Optional parameters for the method 'SpacesProjectsCreate'

type SpacesProjectsCreateParameters ¶ 

type SpacesProjectsCreateParameters struct {
	// Project ID to add or to the Space
	Id string `json:"id,omitempty"`
}

SpacesProjectsCreateParameters struct for SpacesProjectsCreateParameters

type SpacesProjectsDeleteOpts ¶ 

type SpacesProjectsDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

SpacesProjectsDeleteOpts Optional parameters for the method 'SpacesProjectsDelete'

type SpacesProjectsListOpts ¶ 

type SpacesProjectsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

SpacesProjectsListOpts Optional parameters for the method 'SpacesProjectsList'

type StyleGuidesApiService ¶ 

type StyleGuidesApiService service

StyleGuidesApiService StyleGuidesApi service

func (*StyleGuidesApiService) StyleguideCreate ¶ 

func (a *StyleGuidesApiService) StyleguideCreate(ctx _context.Context, projectId string, styleguideCreateParameters StyleguideCreateParameters, localVarOptionals *StyleguideCreateOpts) (StyleguideDetails, *APIResponse, error)

StyleguideCreate Create a style guide Create a new style guide.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param styleguideCreateParameters
  • @param optional nil or *StyleguideCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return StyleguideDetails

func (*StyleGuidesApiService) StyleguideDelete ¶ 

func (a *StyleGuidesApiService) StyleguideDelete(ctx _context.Context, projectId string, id string, localVarOptionals *StyleguideDeleteOpts) ([]byte, *APIResponse, error)

StyleguideDelete Delete a style guide Delete an existing style guide.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *StyleguideDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*StyleGuidesApiService) StyleguideShow ¶ 

func (a *StyleGuidesApiService) StyleguideShow(ctx _context.Context, projectId string, id string, localVarOptionals *StyleguideShowOpts) (StyleguideDetails, *APIResponse, error)

StyleguideShow Get a single style guide Get details on a single style guide.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *StyleguideShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return StyleguideDetails

func (*StyleGuidesApiService) StyleguideUpdate ¶ 

func (a *StyleGuidesApiService) StyleguideUpdate(ctx _context.Context, projectId string, id string, styleguideUpdateParameters StyleguideUpdateParameters, localVarOptionals *StyleguideUpdateOpts) (StyleguideDetails, *APIResponse, error)

StyleguideUpdate Update a style guide Update an existing style guide.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param styleguideUpdateParameters
  • @param optional nil or *StyleguideUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return StyleguideDetails

func (*StyleGuidesApiService) StyleguidesList ¶ 

func (a *StyleGuidesApiService) StyleguidesList(ctx _context.Context, projectId string, localVarOptionals *StyleguidesListOpts) ([]Styleguide, *APIResponse, error)

StyleguidesList List style guides List all styleguides for the given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *StyleguidesListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []Styleguide

type Styleguide ¶ 

type Styleguide struct {
	Id        string    `json:"id,omitempty"`
	Title     string    `json:"title,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

Styleguide struct for Styleguide

type StyleguideCreateOpts ¶ 

type StyleguideCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

StyleguideCreateOpts Optional parameters for the method 'StyleguideCreate'

type StyleguideCreateParameters ¶ 

type StyleguideCreateParameters struct {
	// Style guide title
	Title string `json:"title,omitempty"`
	// Audience description
	Audience string `json:"audience,omitempty"`
	// Can be one of: not_specified, children, teenager, young_adults, adults, old_adults.
	TargetAudience string `json:"target_audience,omitempty"`
	// Can be one of: not_specified, first_person_singular, second_person_singular, third_person_singular_masculine, third_person_singular_feminine, third_person_singular_neuter, first_person_plural, second_person_plural, third_person_plural.
	GrammaticalPerson string `json:"grammatical_person,omitempty"`
	// Can be one of: not_specified, popular, technical, fictional.
	VocabularyType string `json:"vocabulary_type,omitempty"`
	// Description of the business
	Business string `json:"business,omitempty"`
	// Company branding to remain consistent.
	CompanyBranding string `json:"company_branding,omitempty"`
	// Formatting requirements and character limitations.
	Formatting string `json:"formatting,omitempty"`
	// List of terms and/or phrases that need to be translated consistently.
	GlossaryTerms string `json:"glossary_terms,omitempty"`
	// Formal or informal pronouns, consistent conjugation, grammatical gender
	GrammarConsistency string `json:"grammar_consistency,omitempty"`
	// Can be one of: Cultural/Conversational, Literal, Neutral.
	LiteralTranslation string `json:"literal_translation,omitempty"`
	// Tone requirement descriptions
	OverallTone string `json:"overall_tone,omitempty"`
	// Provide links to sample product pages, FAQ pages, etc. to give the translator a point of reference. You can also provide past translations. Even snippets or short paragraphs are helpful for maintaining consistency.
	Samples string `json:"samples,omitempty"`
}

StyleguideCreateParameters struct for StyleguideCreateParameters

type StyleguideDeleteOpts ¶ 

type StyleguideDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

StyleguideDeleteOpts Optional parameters for the method 'StyleguideDelete'

type StyleguideDetails ¶ 

type StyleguideDetails struct {
	Id                 string    `json:"id,omitempty"`
	Title              string    `json:"title,omitempty"`
	CreatedAt          time.Time `json:"created_at,omitempty"`
	UpdatedAt          time.Time `json:"updated_at,omitempty"`
	PublicUrl          string    `json:"public_url,omitempty"`
	Audience           string    `json:"audience,omitempty"`
	TargetAudience     string    `json:"target_audience,omitempty"`
	GrammaticalPerson  string    `json:"grammatical_person,omitempty"`
	VocabularyType     string    `json:"vocabulary_type,omitempty"`
	Business           string    `json:"business,omitempty"`
	CompanyBranding    string    `json:"company_branding,omitempty"`
	Formatting         string    `json:"formatting,omitempty"`
	GlossaryTerms      string    `json:"glossary_terms,omitempty"`
	GrammarConsistency string    `json:"grammar_consistency,omitempty"`
	LiteralTranslation string    `json:"literal_translation,omitempty"`
	OverallTone        string    `json:"overall_tone,omitempty"`
	Samples            string    `json:"samples,omitempty"`
}

StyleguideDetails struct for StyleguideDetails

type StyleguidePreview ¶ 

type StyleguidePreview struct {
	Id    string `json:"id,omitempty"`
	Title string `json:"title,omitempty"`
}

StyleguidePreview struct for StyleguidePreview

type StyleguideShowOpts ¶ 

type StyleguideShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

StyleguideShowOpts Optional parameters for the method 'StyleguideShow'

type StyleguideUpdateOpts ¶ 

type StyleguideUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

StyleguideUpdateOpts Optional parameters for the method 'StyleguideUpdate'

type StyleguideUpdateParameters ¶ 

type StyleguideUpdateParameters struct {
	// Style guide title
	Title string `json:"title,omitempty"`
	// Audience description
	Audience string `json:"audience,omitempty"`
	// Can be one of: not_specified, children, teenager, young_adults, adults, old_adults.
	TargetAudience string `json:"target_audience,omitempty"`
	// Can be one of: not_specified, first_person_singular, second_person_singular, third_person_singular_masculine, third_person_singular_feminine, third_person_singular_neuter, first_person_plural, second_person_plural, third_person_plural.
	GrammaticalPerson string `json:"grammatical_person,omitempty"`
	// Can be one of: not_specified, popular, technical, fictional.
	VocabularyType string `json:"vocabulary_type,omitempty"`
	// Description of the business
	Business string `json:"business,omitempty"`
	// Company branding to remain consistent.
	CompanyBranding string `json:"company_branding,omitempty"`
	// Formatting requirements and character limitations.
	Formatting string `json:"formatting,omitempty"`
	// List of terms and/or phrases that need to be translated consistently.
	GlossaryTerms string `json:"glossary_terms,omitempty"`
	// Formal or informal pronouns, consistent conjugation, grammatical gender
	GrammarConsistency string `json:"grammar_consistency,omitempty"`
	// Can be one of: Cultural/Conversational, Literal, Neutral.
	LiteralTranslation string `json:"literal_translation,omitempty"`
	// Tone requirement descriptions
	OverallTone string `json:"overall_tone,omitempty"`
	// Provide links to sample product pages, FAQ pages, etc. to give the translator a point of reference. You can also provide past translations. Even snippets or short paragraphs are helpful for maintaining consistency.
	Samples string `json:"samples,omitempty"`
}

StyleguideUpdateParameters struct for StyleguideUpdateParameters

type StyleguidesListOpts ¶ 

type StyleguidesListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

StyleguidesListOpts Optional parameters for the method 'StyleguidesList'

type Subscription ¶ added in v2.0.2 

type Subscription struct {
	IsCurrent    *bool `json:"is_current,omitempty"`
	TrialExpired *bool `json:"trial_expired,omitempty"`
}

Subscription struct for Subscription

type Tag ¶ 

type Tag struct {
	Name      string    `json:"name,omitempty"`
	KeysCount int32     `json:"keys_count,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

Tag struct for Tag

type TagCreateOpts ¶ 

type TagCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TagCreateOpts Optional parameters for the method 'TagCreate'

type TagCreateParameters ¶ 

type TagCreateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Name of the tag
	Name string `json:"name,omitempty"`
}

TagCreateParameters struct for TagCreateParameters

type TagDeleteOpts ¶ 

type TagDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

TagDeleteOpts Optional parameters for the method 'TagDelete'

type TagShowOpts ¶ 

type TagShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

TagShowOpts Optional parameters for the method 'TagShow'

type TagWithStats ¶ 

type TagWithStats struct {
	Name       string                     `json:"name,omitempty"`
	KeysCount  int32                      `json:"keys_count,omitempty"`
	CreatedAt  time.Time                  `json:"created_at,omitempty"`
	UpdatedAt  time.Time                  `json:"updated_at,omitempty"`
	Statistics []TagWithStats1Statistics1 `json:"statistics,omitempty"`
}

TagWithStats struct for TagWithStats

type TagWithStats1Statistics ¶ 

type TagWithStats1Statistics struct {
	KeysTotalCount              int32 `json:"keys_total_count,omitempty"`
	TranslationsCompletedCount  int32 `json:"translations_completed_count,omitempty"`
	TranslationsUnverifiedCount int32 `json:"translations_unverified_count,omitempty"`
	KeysUntranslatedCount       int32 `json:"keys_untranslated_count,omitempty"`
}

TagWithStats1Statistics struct for TagWithStats1Statistics

type TagWithStats1Statistics1 ¶ 

type TagWithStats1Statistics1 struct {
	Locale     LocalePreview           `json:"locale,omitempty"`
	Statistics TagWithStats1Statistics `json:"statistics,omitempty"`
}

TagWithStats1Statistics1 struct for TagWithStats1Statistics1

type TagsApiService ¶ 

type TagsApiService service

TagsApiService TagsApi service

func (*TagsApiService) TagCreate ¶ 

func (a *TagsApiService) TagCreate(ctx _context.Context, projectId string, tagCreateParameters TagCreateParameters, localVarOptionals *TagCreateOpts) (TagWithStats, *APIResponse, error)

TagCreate Create a tag Create a new tag.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param tagCreateParameters
  • @param optional nil or *TagCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return TagWithStats

func (*TagsApiService) TagDelete ¶ 

func (a *TagsApiService) TagDelete(ctx _context.Context, projectId string, name string, localVarOptionals *TagDeleteOpts) ([]byte, *APIResponse, error)

TagDelete Delete a tag Delete an existing tag.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param name name
  • @param optional nil or *TagDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

func (*TagsApiService) TagShow ¶ 

func (a *TagsApiService) TagShow(ctx _context.Context, projectId string, name string, localVarOptionals *TagShowOpts) (TagWithStats, *APIResponse, error)

TagShow Get a single tag Get details and progress information on a single tag for a given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param name name
  • @param optional nil or *TagShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return TagWithStats

func (*TagsApiService) TagsList ¶ 

func (a *TagsApiService) TagsList(ctx _context.Context, projectId string, localVarOptionals *TagsListOpts) ([]Tag, *APIResponse, error)

TagsList List tags List all tags for the given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *TagsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use

@return []Tag

type TagsListOpts ¶ 

type TagsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

TagsListOpts Optional parameters for the method 'TagsList'

type Team ¶ 

type Team struct {
	Id        string        `json:"id,omitempty"`
	Name      string        `json:"name,omitempty"`
	CreatedAt time.Time     `json:"created_at,omitempty"`
	UpdatedAt time.Time     `json:"updated_at,omitempty"`
	Projects  []Project     `json:"projects,omitempty"`
	Spaces    []Space       `json:"spaces,omitempty"`
	Users     []UserPreview `json:"users,omitempty"`
}

Team struct for Team

type TeamCreateOpts ¶ 

type TeamCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TeamCreateOpts Optional parameters for the method 'TeamCreate'

type TeamCreateParameters ¶ 

type TeamCreateParameters struct {
	// Name of the team
	Name string `json:"name,omitempty"`
}

TeamCreateParameters struct for TeamCreateParameters

type TeamDeleteOpts ¶ 

type TeamDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TeamDeleteOpts Optional parameters for the method 'TeamDelete'

type TeamDetail ¶ 

type TeamDetail struct {
	Id        string    `json:"id,omitempty"`
	Name      string    `json:"name,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	Projects  []Project `json:"projects,omitempty"`
	Spaces    []Space   `json:"spaces,omitempty"`
	Users     []User    `json:"users,omitempty"`
}

TeamDetail struct for TeamDetail

type TeamShort ¶ added in v2.5.0 

type TeamShort struct {
	Id        string    `json:"id,omitempty"`
	Name      string    `json:"name,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

TeamShort struct for TeamShort

type TeamShowOpts ¶ 

type TeamShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TeamShowOpts Optional parameters for the method 'TeamShow'

type TeamUpdateOpts ¶ 

type TeamUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TeamUpdateOpts Optional parameters for the method 'TeamUpdate'

type TeamUpdateParameters ¶ 

type TeamUpdateParameters struct {
	// New name of the team
	Name string `json:"name,omitempty"`
}

TeamUpdateParameters struct for TeamUpdateParameters

type TeamsApiService ¶ 

type TeamsApiService service

TeamsApiService TeamsApi service

func (*TeamsApiService) TeamCreate ¶ 

func (a *TeamsApiService) TeamCreate(ctx _context.Context, accountId string, teamCreateParameters TeamCreateParameters, localVarOptionals *TeamCreateOpts) (TeamDetail, *APIResponse, error)

TeamCreate Create a Team Create a new Team.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param teamCreateParameters
  • @param optional nil or *TeamCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return TeamDetail

func (*TeamsApiService) TeamDelete ¶ 

func (a *TeamsApiService) TeamDelete(ctx _context.Context, accountId string, id string, localVarOptionals *TeamDeleteOpts) ([]byte, *APIResponse, error)

TeamDelete Delete Team Delete the specified Team.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param optional nil or *TeamDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*TeamsApiService) TeamShow ¶ 

func (a *TeamsApiService) TeamShow(ctx _context.Context, accountId string, id string, localVarOptionals *TeamShowOpts) (TeamDetail, *APIResponse, error)

TeamShow Get Team Show the specified Team.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param optional nil or *TeamShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return TeamDetail

func (*TeamsApiService) TeamUpdate ¶ 

func (a *TeamsApiService) TeamUpdate(ctx _context.Context, accountId string, id string, teamUpdateParameters TeamUpdateParameters, localVarOptionals *TeamUpdateOpts) (TeamDetail, *APIResponse, error)

TeamUpdate Update Team Update the specified Team.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param id ID
  • @param teamUpdateParameters
  • @param optional nil or *TeamUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return TeamDetail

func (*TeamsApiService) TeamsList ¶ 

func (a *TeamsApiService) TeamsList(ctx _context.Context, accountId string, localVarOptionals *TeamsListOpts) ([]Team, *APIResponse, error)

TeamsList List Teams List all Teams for the given account.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param optional nil or *TeamsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []Team

func (*TeamsApiService) TeamsProjectsCreate ¶ 

func (a *TeamsApiService) TeamsProjectsCreate(ctx _context.Context, accountId string, teamId string, teamsProjectsCreateParameters TeamsProjectsCreateParameters, localVarOptionals *TeamsProjectsCreateOpts) ([]byte, *APIResponse, error)

TeamsProjectsCreate Add Project to Team Adds an existing project to the team.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param teamId Team ID
  • @param teamsProjectsCreateParameters
  • @param optional nil or *TeamsProjectsCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*TeamsApiService) TeamsProjectsDelete ¶ 

func (a *TeamsApiService) TeamsProjectsDelete(ctx _context.Context, accountId string, teamId string, id string, localVarOptionals *TeamsProjectsDeleteOpts) ([]byte, *APIResponse, error)

TeamsProjectsDelete Remove Project from Team Removes a specified project from the specified team.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param teamId Team ID
  • @param id ID
  • @param optional nil or *TeamsProjectsDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*TeamsApiService) TeamsSpacesCreate ¶ 

func (a *TeamsApiService) TeamsSpacesCreate(ctx _context.Context, accountId string, teamId string, teamsSpacesCreateParameters TeamsSpacesCreateParameters, localVarOptionals *TeamsSpacesCreateOpts) ([]byte, *APIResponse, error)

TeamsSpacesCreate Add Space Adds an existing space to the team.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param teamId Team ID
  • @param teamsSpacesCreateParameters
  • @param optional nil or *TeamsSpacesCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*TeamsApiService) TeamsSpacesDelete ¶ 

func (a *TeamsApiService) TeamsSpacesDelete(ctx _context.Context, accountId string, teamId string, id string, localVarOptionals *TeamsSpacesDeleteOpts) ([]byte, *APIResponse, error)

TeamsSpacesDelete Remove Space Removes a specified space from the specified team.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param teamId Team ID
  • @param id ID
  • @param optional nil or *TeamsSpacesDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*TeamsApiService) TeamsUsersCreate ¶ 

func (a *TeamsApiService) TeamsUsersCreate(ctx _context.Context, accountId string, teamId string, teamsUsersCreateParameters TeamsUsersCreateParameters, localVarOptionals *TeamsUsersCreateOpts) ([]byte, *APIResponse, error)

TeamsUsersCreate Add User Adds an existing user to the team.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param teamId Team ID
  • @param teamsUsersCreateParameters
  • @param optional nil or *TeamsUsersCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*TeamsApiService) TeamsUsersDelete ¶ 

func (a *TeamsApiService) TeamsUsersDelete(ctx _context.Context, accountId string, teamId string, id string, localVarOptionals *TeamsUsersDeleteOpts) ([]byte, *APIResponse, error)

TeamsUsersDelete Remove User Removes a specified user from the specified team.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param accountId Account ID
  • @param teamId Team ID
  • @param id ID
  • @param optional nil or *TeamsUsersDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

type TeamsListOpts ¶ 

type TeamsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

TeamsListOpts Optional parameters for the method 'TeamsList'

type TeamsProjectsCreateOpts ¶ 

type TeamsProjectsCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TeamsProjectsCreateOpts Optional parameters for the method 'TeamsProjectsCreate'

type TeamsProjectsCreateParameters ¶ 

type TeamsProjectsCreateParameters struct {
	// Project ID to add to the Team
	Id string `json:"id,omitempty"`
}

TeamsProjectsCreateParameters struct for TeamsProjectsCreateParameters

type TeamsProjectsDeleteOpts ¶ 

type TeamsProjectsDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TeamsProjectsDeleteOpts Optional parameters for the method 'TeamsProjectsDelete'

type TeamsSpacesCreateOpts ¶ 

type TeamsSpacesCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TeamsSpacesCreateOpts Optional parameters for the method 'TeamsSpacesCreate'

type TeamsSpacesCreateParameters ¶ 

type TeamsSpacesCreateParameters struct {
	// Space ID to add to the Team
	Id string `json:"id,omitempty"`
}

TeamsSpacesCreateParameters struct for TeamsSpacesCreateParameters

type TeamsSpacesDeleteOpts ¶ 

type TeamsSpacesDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TeamsSpacesDeleteOpts Optional parameters for the method 'TeamsSpacesDelete'

type TeamsUsersCreateOpts ¶ 

type TeamsUsersCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TeamsUsersCreateOpts Optional parameters for the method 'TeamsUsersCreate'

type TeamsUsersCreateParameters ¶ 

type TeamsUsersCreateParameters struct {
	// User ID to add to the Team
	Id string `json:"id,omitempty"`
}

TeamsUsersCreateParameters struct for TeamsUsersCreateParameters

type TeamsUsersDeleteOpts ¶ 

type TeamsUsersDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TeamsUsersDeleteOpts Optional parameters for the method 'TeamsUsersDelete'

type Timestamp ¶ 

type Timestamp struct {
	time.Time
}

Timestamp represents a time that can be unmarshalled from a JSON string formatted as either an RFC3339 or Unix timestamp. This is necessary for some fields since the GitHub API is inconsistent in how it represents times. All exported methods of time.Time can be called on Timestamp.

func (Timestamp) Equal ¶ 

func (t Timestamp) Equal(u Timestamp) bool

Equal reports whether t and u are equal based on time.Equal

func (Timestamp) String ¶ 

func (t Timestamp) String() string

func (*Timestamp) UnmarshalJSON ¶ 

func (t *Timestamp) UnmarshalJSON(data []byte) (err error)

UnmarshalJSON implements the json.Unmarshaler interface. Time is expected in RFC3339 or Unix format.

type Translation ¶ 

type Translation struct {
	Id           string        `json:"id,omitempty"`
	Content      string        `json:"content"`
	Unverified   *bool         `json:"unverified,omitempty"`
	Excluded     *bool         `json:"excluded,omitempty"`
	PluralSuffix string        `json:"plural_suffix,omitempty"`
	Key          KeyPreview    `json:"key,omitempty"`
	Locale       LocalePreview `json:"locale,omitempty"`
	Placeholders []string      `json:"placeholders,omitempty"`
	State        string        `json:"state,omitempty"`
	CreatedAt    time.Time     `json:"created_at,omitempty"`
	UpdatedAt    time.Time     `json:"updated_at,omitempty"`
}

Translation struct for Translation

type TranslationCreateOpts ¶ 

type TranslationCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TranslationCreateOpts Optional parameters for the method 'TranslationCreate'

type TranslationCreateParameters ¶ 

type TranslationCreateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Locale. Can be the name or public id of the locale. Preferred is the public id.
	LocaleId string `json:"locale_id,omitempty"`
	// Key
	KeyId string `json:"key_id,omitempty"`
	// Translation content
	Content string `json:"content,omitempty"`
	// Plural suffix. Can be one of: zero, one, two, few, many, other. Must be specified if the key associated to the translation is pluralized.
	PluralSuffix string `json:"plural_suffix,omitempty"`
	// Indicates whether translation is unverified. Part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature.
	Unverified *bool `json:"unverified,omitempty"`
	// Indicates whether translation is excluded.
	Excluded *bool `json:"excluded,omitempty"`
	// Indicates whether the translation should be auto-translated. Responses with status 422 if provided for translation within a non-default locale or the project does not have the Autopilot feature enabled.
	Autotranslate *bool `json:"autotranslate,omitempty"`
}

TranslationCreateParameters struct for TranslationCreateParameters

type TranslationDetails ¶ 

type TranslationDetails struct {
	Id                string            `json:"id,omitempty"`
	Content           string            `json:"content"`
	Unverified        *bool             `json:"unverified,omitempty"`
	Excluded          *bool             `json:"excluded,omitempty"`
	PluralSuffix      string            `json:"plural_suffix,omitempty"`
	Key               KeyPreview        `json:"key,omitempty"`
	Locale            LocalePreview     `json:"locale,omitempty"`
	Placeholders      []string          `json:"placeholders,omitempty"`
	State             string            `json:"state,omitempty"`
	CreatedAt         time.Time         `json:"created_at,omitempty"`
	UpdatedAt         time.Time         `json:"updated_at,omitempty"`
	User              UserPreview       `json:"user,omitempty"`
	WordCount         int32             `json:"word_count,omitempty"`
	LinkedTranslation TranslationParent `json:"linked_translation,omitempty"`
}

TranslationDetails struct for TranslationDetails

type TranslationExcludeOpts ¶ 

type TranslationExcludeOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TranslationExcludeOpts Optional parameters for the method 'TranslationExclude'

type TranslationExcludeParameters ¶ 

type TranslationExcludeParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
}

TranslationExcludeParameters struct for TranslationExcludeParameters

type TranslationIncludeOpts ¶ 

type TranslationIncludeOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TranslationIncludeOpts Optional parameters for the method 'TranslationInclude'

type TranslationIncludeParameters ¶ 

type TranslationIncludeParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
}

TranslationIncludeParameters struct for TranslationIncludeParameters

type TranslationKey ¶ 

type TranslationKey struct {
	Id          string    `json:"id,omitempty"`
	Name        string    `json:"name,omitempty"`
	Description string    `json:"description,omitempty"`
	NameHash    string    `json:"name_hash,omitempty"`
	Plural      *bool     `json:"plural,omitempty"`
	Tags        []string  `json:"tags,omitempty"`
	DataType    string    `json:"data_type,omitempty"`
	CreatedAt   time.Time `json:"created_at,omitempty"`
	UpdatedAt   time.Time `json:"updated_at,omitempty"`
}

TranslationKey struct for TranslationKey

type TranslationKeyDetails ¶ 

type TranslationKeyDetails struct {
	Id                   string            `json:"id,omitempty"`
	Name                 string            `json:"name,omitempty"`
	Description          string            `json:"description,omitempty"`
	NameHash             string            `json:"name_hash,omitempty"`
	Plural               *bool             `json:"plural,omitempty"`
	Tags                 []string          `json:"tags,omitempty"`
	DataType             string            `json:"data_type,omitempty"`
	CreatedAt            time.Time         `json:"created_at,omitempty"`
	UpdatedAt            time.Time         `json:"updated_at,omitempty"`
	NamePlural           string            `json:"name_plural,omitempty"`
	CommentsCount        int32             `json:"comments_count,omitempty"`
	MaxCharactersAllowed int32             `json:"max_characters_allowed,omitempty"`
	ScreenshotUrl        string            `json:"screenshot_url,omitempty"`
	Unformatted          *bool             `json:"unformatted,omitempty"`
	XmlSpacePreserve     *bool             `json:"xml_space_preserve,omitempty"`
	OriginalFile         string            `json:"original_file,omitempty"`
	FormatValueType      string            `json:"format_value_type,omitempty"`
	Creator              UserPreview       `json:"creator,omitempty"`
	CustomMetadata       map[string]string `json:"custom_metadata,omitempty"`
}

TranslationKeyDetails struct for TranslationKeyDetails

type TranslationOrder ¶ 

type TranslationOrder struct {
	Id                               string            `json:"id,omitempty"`
	Name                             string            `json:"name,omitempty"`
	Lsp                              string            `json:"lsp,omitempty"`
	AmountInCents                    int32             `json:"amount_in_cents,omitempty"`
	Currency                         string            `json:"currency,omitempty"`
	Message                          string            `json:"message,omitempty"`
	State                            string            `json:"state,omitempty"`
	TranslationType                  string            `json:"translation_type,omitempty"`
	ProgressPercent                  int32             `json:"progress_percent,omitempty"`
	SourceLocale                     LocalePreview     `json:"source_locale,omitempty"`
	TargetLocales                    []LocalePreview   `json:"target_locales,omitempty"`
	Tag                              string            `json:"tag,omitempty"`
	Styleguide                       StyleguidePreview `json:"styleguide,omitempty"`
	UnverifyTranslationsUponDelivery *bool             `json:"unverify_translations_upon_delivery,omitempty"`
	Quality                          *bool             `json:"quality,omitempty"`
	Priority                         *bool             `json:"priority,omitempty"`
	CreatedAt                        time.Time         `json:"created_at,omitempty"`
	UpdatedAt                        time.Time         `json:"updated_at,omitempty"`
}

TranslationOrder struct for TranslationOrder

type TranslationParent ¶ added in v2.27.0 

type TranslationParent struct {
	Id      string `json:"id,omitempty"`
	Content string `json:"content,omitempty"`
}

TranslationParent struct for TranslationParent

type TranslationReviewOpts ¶ 

type TranslationReviewOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TranslationReviewOpts Optional parameters for the method 'TranslationReview'

type TranslationReviewParameters ¶ 

type TranslationReviewParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
}

TranslationReviewParameters struct for TranslationReviewParameters

type TranslationShowOpts ¶ 

type TranslationShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

TranslationShowOpts Optional parameters for the method 'TranslationShow'

type TranslationUnverifyOpts ¶ 

type TranslationUnverifyOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TranslationUnverifyOpts Optional parameters for the method 'TranslationUnverify'

type TranslationUnverifyParameters ¶ 

type TranslationUnverifyParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
}

TranslationUnverifyParameters struct for TranslationUnverifyParameters

type TranslationUpdateOpts ¶ 

type TranslationUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TranslationUpdateOpts Optional parameters for the method 'TranslationUpdate'

type TranslationUpdateParameters ¶ 

type TranslationUpdateParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Translation content
	Content string `json:"content,omitempty"`
	// Plural suffix. Can be one of: zero, one, two, few, many, other. Must be specified if the key associated to the translation is pluralized.
	PluralSuffix string `json:"plural_suffix,omitempty"`
	// Indicates whether translation is unverified. Part of the <a href=\"https://support.phrase.com/hc/en-us/articles/5784094755484\" target=\"_blank\">Advanced Workflows</a> feature.
	Unverified *bool `json:"unverified,omitempty"`
	// Indicates whether translation is excluded.
	Excluded *bool `json:"excluded,omitempty"`
	// Indicates whether the translation should be auto-translated. Responses with status 422 if provided for translation within a non-default locale or the project does not have the Autopilot feature enabled.
	Autotranslate *bool `json:"autotranslate,omitempty"`
}

TranslationUpdateParameters struct for TranslationUpdateParameters

type TranslationVerifyOpts ¶ 

type TranslationVerifyOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TranslationVerifyOpts Optional parameters for the method 'TranslationVerify'

type TranslationVerifyParameters ¶ 

type TranslationVerifyParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
}

TranslationVerifyParameters struct for TranslationVerifyParameters

type TranslationVersion ¶ 

type TranslationVersion struct {
	Id           string        `json:"id,omitempty"`
	Content      string        `json:"content,omitempty"`
	PluralSuffix string        `json:"plural_suffix,omitempty"`
	Key          KeyPreview    `json:"key,omitempty"`
	Locale       LocalePreview `json:"locale,omitempty"`
	CreatedAt    time.Time     `json:"created_at,omitempty"`
	UpdatedAt    time.Time     `json:"updated_at,omitempty"`
	ChangedAt    time.Time     `json:"changed_at,omitempty"`
}

TranslationVersion struct for TranslationVersion

type TranslationVersionWithUser ¶ 

type TranslationVersionWithUser struct {
	Id           string        `json:"id,omitempty"`
	Content      string        `json:"content,omitempty"`
	PluralSuffix string        `json:"plural_suffix,omitempty"`
	Key          KeyPreview    `json:"key,omitempty"`
	Locale       LocalePreview `json:"locale,omitempty"`
	CreatedAt    time.Time     `json:"created_at,omitempty"`
	UpdatedAt    time.Time     `json:"updated_at,omitempty"`
	ChangedAt    time.Time     `json:"changed_at,omitempty"`
	User         UserPreview   `json:"user,omitempty"`
}

TranslationVersionWithUser struct for TranslationVersionWithUser

type TranslationsApiService ¶ 

type TranslationsApiService service

TranslationsApiService TranslationsApi service

func (*TranslationsApiService) TranslationCreate ¶ 

func (a *TranslationsApiService) TranslationCreate(ctx _context.Context, projectId string, translationCreateParameters TranslationCreateParameters, localVarOptionals *TranslationCreateOpts) (TranslationDetails, *APIResponse, error)

TranslationCreate Create a translation Create a translation.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param translationCreateParameters
  • @param optional nil or *TranslationCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return TranslationDetails

func (*TranslationsApiService) TranslationExclude ¶ 

func (a *TranslationsApiService) TranslationExclude(ctx _context.Context, projectId string, id string, translationExcludeParameters TranslationExcludeParameters, localVarOptionals *TranslationExcludeOpts) (TranslationDetails, *APIResponse, error)

TranslationExclude Exclude a translation from export Set exclude from export flag on an existing translation.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param translationExcludeParameters
  • @param optional nil or *TranslationExcludeOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return TranslationDetails

func (*TranslationsApiService) TranslationInclude ¶ 

func (a *TranslationsApiService) TranslationInclude(ctx _context.Context, projectId string, id string, translationIncludeParameters TranslationIncludeParameters, localVarOptionals *TranslationIncludeOpts) (TranslationDetails, *APIResponse, error)

TranslationInclude Include a translation Remove exclude from export flag from an existing translation.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param translationIncludeParameters
  • @param optional nil or *TranslationIncludeOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return TranslationDetails

func (*TranslationsApiService) TranslationReview ¶ 

func (a *TranslationsApiService) TranslationReview(ctx _context.Context, projectId string, id string, translationReviewParameters TranslationReviewParameters, localVarOptionals *TranslationReviewOpts) (TranslationDetails, *APIResponse, error)

TranslationReview Review a translation Mark an existing translation as reviewed.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param translationReviewParameters
  • @param optional nil or *TranslationReviewOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return TranslationDetails

func (*TranslationsApiService) TranslationShow ¶ 

func (a *TranslationsApiService) TranslationShow(ctx _context.Context, projectId string, id string, localVarOptionals *TranslationShowOpts) (TranslationDetails, *APIResponse, error)

TranslationShow Get a single translation Get details on a single translation.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *TranslationShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return TranslationDetails

func (*TranslationsApiService) TranslationUnverify ¶ 

func (a *TranslationsApiService) TranslationUnverify(ctx _context.Context, projectId string, id string, translationUnverifyParameters TranslationUnverifyParameters, localVarOptionals *TranslationUnverifyOpts) (TranslationDetails, *APIResponse, error)

TranslationUnverify Mark a translation as unverified Mark an existing translation as unverified.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param translationUnverifyParameters
  • @param optional nil or *TranslationUnverifyOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return TranslationDetails

func (*TranslationsApiService) TranslationUpdate ¶ 

func (a *TranslationsApiService) TranslationUpdate(ctx _context.Context, projectId string, id string, translationUpdateParameters TranslationUpdateParameters, localVarOptionals *TranslationUpdateOpts) (TranslationDetails, *APIResponse, error)

TranslationUpdate Update a translation Update an existing translation.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param translationUpdateParameters
  • @param optional nil or *TranslationUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return TranslationDetails

func (*TranslationsApiService) TranslationVerify ¶ 

func (a *TranslationsApiService) TranslationVerify(ctx _context.Context, projectId string, id string, translationVerifyParameters TranslationVerifyParameters, localVarOptionals *TranslationVerifyOpts) (TranslationDetails, *APIResponse, error)

TranslationVerify Verify a translation Verify an existing translation.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param translationVerifyParameters
  • @param optional nil or *TranslationVerifyOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return TranslationDetails

func (*TranslationsApiService) TranslationsByKey ¶ 

func (a *TranslationsApiService) TranslationsByKey(ctx _context.Context, projectId string, keyId string, localVarOptionals *TranslationsByKeyOpts) ([]Translation, *APIResponse, error)

TranslationsByKey List translations by key List translations for a specific key.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param keyId Translation Key ID
  • @param optional nil or *TranslationsByKeyOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use
  • @param "Sort" (optional.String) - Sort criteria. Can be one of: key_name, created_at, updated_at.
  • @param "Order" (optional.String) - Order direction. Can be one of: asc, desc.
  • @param "Q" (optional.String) - Specify a query to find translations by content (including wildcards).<br><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.

@return []Translation

func (*TranslationsApiService) TranslationsByLocale ¶ 

func (a *TranslationsApiService) TranslationsByLocale(ctx _context.Context, projectId string, localeId string, localVarOptionals *TranslationsByLocaleOpts) ([]Translation, *APIResponse, error)

TranslationsByLocale List translations by locale List translations for a specific locale. If you want to download all translations for one locale we recommend to use the &lt;code&gt;locales#download&lt;/code&gt; endpoint.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param localeId Locale ID
  • @param optional nil or *TranslationsByLocaleOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use
  • @param "Sort" (optional.String) - Sort criteria. Can be one of: key_name, created_at, updated_at.
  • @param "Order" (optional.String) - Order direction. Can be one of: asc, desc.
  • @param "Q" (optional.String) - Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.

@return []Translation

func (*TranslationsApiService) TranslationsExcludeCollection ¶ 

func (a *TranslationsApiService) TranslationsExcludeCollection(ctx _context.Context, projectId string, translationsExcludeParameters TranslationsExcludeParameters, localVarOptionals *TranslationsExcludeCollectionOpts) (AffectedCount, *APIResponse, error)

TranslationsExcludeCollection Exclude translations by query Exclude translations matching query from locale export.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param translationsExcludeParameters
  • @param optional nil or *TranslationsExcludeCollectionOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return AffectedCount

func (*TranslationsApiService) TranslationsIncludeCollection ¶ 

func (a *TranslationsApiService) TranslationsIncludeCollection(ctx _context.Context, projectId string, translationsIncludeParameters TranslationsIncludeParameters, localVarOptionals *TranslationsIncludeCollectionOpts) (AffectedCount, *APIResponse, error)

TranslationsIncludeCollection Include translations by query Include translations matching query in locale export.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param translationsIncludeParameters
  • @param optional nil or *TranslationsIncludeCollectionOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return AffectedCount

func (*TranslationsApiService) TranslationsList ¶ 

func (a *TranslationsApiService) TranslationsList(ctx _context.Context, projectId string, localVarOptionals *TranslationsListOpts) ([]Translation, *APIResponse, error)

TranslationsList List all translations List translations for the given project. If you want to download all translations for one locale we recommend to use the &lt;code&gt;locales#download&lt;/code&gt; endpoint.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *TranslationsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "IfModifiedSince" (optional.String) - Last modified condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
  • @param "IfNoneMatch" (optional.String) - ETag condition, see <a href=\"#overview--conditional-get-requests--http-caching\">Conditional GET requests / HTTP Caching</a> (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use
  • @param "Sort" (optional.String) - Sort criteria. Can be one of: key_name, created_at, updated_at.
  • @param "Order" (optional.String) - Order direction. Can be one of: asc, desc.
  • @param "Q" (optional.String) - Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul> <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li> <li><code>tags:XYZ</code> for tags on the translation</li> <li><code>unverified:{true|false}</code> for verification status</li> <li><code>excluded:{true|false}</code> for exclusion status</li> <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> <li><code>reviewed_after:2013-02-21T00:00:00Z</code> for fetching translations that were reviewed after the given timestamp</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.

@return []Translation

func (*TranslationsApiService) TranslationsReviewCollection ¶ 

func (a *TranslationsApiService) TranslationsReviewCollection(ctx _context.Context, projectId string, translationsReviewParameters TranslationsReviewParameters, localVarOptionals *TranslationsReviewCollectionOpts) (AffectedCount, *APIResponse, error)

TranslationsReviewCollection Review translations selected by query Review translations matching query.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param translationsReviewParameters
  • @param optional nil or *TranslationsReviewCollectionOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return AffectedCount

func (*TranslationsApiService) TranslationsSearch ¶ 

func (a *TranslationsApiService) TranslationsSearch(ctx _context.Context, projectId string, translationsSearchParameters TranslationsSearchParameters, localVarOptionals *TranslationsSearchOpts) ([]Translation, *APIResponse, error)

TranslationsSearch Search translations Search translations for the given project. Provides the same search interface as &lt;code&gt;translations#index&lt;/code&gt; but allows POST requests to avoid limitations imposed by GET requests. If you want to download all translations for one locale we recommend to use the &lt;code&gt;locales#download&lt;/code&gt; endpoint.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param translationsSearchParameters
  • @param optional nil or *TranslationsSearchOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []Translation

func (*TranslationsApiService) TranslationsUnverifyCollection ¶ 

func (a *TranslationsApiService) TranslationsUnverifyCollection(ctx _context.Context, projectId string, translationsUnverifyParameters TranslationsUnverifyParameters, localVarOptionals *TranslationsUnverifyCollectionOpts) (AffectedCount, *APIResponse, error)

TranslationsUnverifyCollection Unverify translations by query Mark translations matching query as unverified.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param translationsUnverifyParameters
  • @param optional nil or *TranslationsUnverifyCollectionOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return AffectedCount

func (*TranslationsApiService) TranslationsVerifyCollection ¶ 

func (a *TranslationsApiService) TranslationsVerifyCollection(ctx _context.Context, projectId string, translationsVerifyParameters TranslationsVerifyParameters, localVarOptionals *TranslationsVerifyCollectionOpts) (AffectedCount, *APIResponse, error)

TranslationsVerifyCollection Verify translations by query Verify translations matching query.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param translationsVerifyParameters
  • @param optional nil or *TranslationsVerifyCollectionOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return AffectedCount

type TranslationsByKeyOpts ¶ 

type TranslationsByKeyOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
	Sort          optional.String `json:"sort,omitempty"`
	Order         optional.String `json:"order,omitempty"`
	Q             optional.String `json:"q,omitempty"`
}

TranslationsByKeyOpts Optional parameters for the method 'TranslationsByKey'

type TranslationsByLocaleOpts ¶ 

type TranslationsByLocaleOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
	Sort          optional.String `json:"sort,omitempty"`
	Order         optional.String `json:"order,omitempty"`
	Q             optional.String `json:"q,omitempty"`
}

TranslationsByLocaleOpts Optional parameters for the method 'TranslationsByLocale'

type TranslationsExcludeCollectionOpts ¶ 

type TranslationsExcludeCollectionOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TranslationsExcludeCollectionOpts Optional parameters for the method 'TranslationsExcludeCollection'

type TranslationsExcludeParameters ¶ 

type TranslationsExcludeParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul>   <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>tags:XYZ</code> for tags on the translation</li>   <li><code>unverified:{true|false}</code> for verification status</li>   <li><code>excluded:{true|false}</code> for exclusion status</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
	Q string `json:"q,omitempty"`
	// Sort criteria. Can be one of: key_name, created_at, updated_at.
	Sort string `json:"sort,omitempty"`
	// Order direction. Can be one of: asc, desc.
	Order string `json:"order,omitempty"`
}

TranslationsExcludeParameters struct for TranslationsExcludeParameters

type TranslationsIncludeCollectionOpts ¶ 

type TranslationsIncludeCollectionOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TranslationsIncludeCollectionOpts Optional parameters for the method 'TranslationsIncludeCollection'

type TranslationsIncludeParameters ¶ 

type TranslationsIncludeParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul>   <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>tags:XYZ</code> for tags on the translation</li>   <li><code>unverified:{true|false}</code> for verification status</li>   <li><code>excluded:{true|false}</code> for exclusion status</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
	Q string `json:"q,omitempty"`
	// Sort criteria. Can be one of: key_name, created_at, updated_at.
	Sort string `json:"sort,omitempty"`
	// Order direction. Can be one of: asc, desc.
	Order string `json:"order,omitempty"`
}

TranslationsIncludeParameters struct for TranslationsIncludeParameters

type TranslationsListOpts ¶ 

type TranslationsListOpts struct {
	XPhraseAppOTP   optional.String `json:"X-PhraseApp-OTP,omitempty"`
	IfModifiedSince optional.String `json:"If-Modified-Since,omitempty"`
	IfNoneMatch     optional.String `json:"If-None-Match,omitempty"`
	Page            optional.Int32  `json:"page,omitempty"`
	PerPage         optional.Int32  `json:"per_page,omitempty"`
	Branch          optional.String `json:"branch,omitempty"`
	Sort            optional.String `json:"sort,omitempty"`
	Order           optional.String `json:"order,omitempty"`
	Q               optional.String `json:"q,omitempty"`
}

TranslationsListOpts Optional parameters for the method 'TranslationsList'

type TranslationsReviewCollectionOpts ¶ 

type TranslationsReviewCollectionOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TranslationsReviewCollectionOpts Optional parameters for the method 'TranslationsReviewCollection'

type TranslationsReviewParameters ¶ 

type TranslationsReviewParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul>   <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>tags:XYZ</code> for tags on the translation</li>   <li><code>unverified:{true|false}</code> for verification status</li>   <li><code>excluded:{true|false}</code> for exclusion status</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
	Q string `json:"q,omitempty"`
}

TranslationsReviewParameters struct for TranslationsReviewParameters

type TranslationsSearchOpts ¶ 

type TranslationsSearchOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

TranslationsSearchOpts Optional parameters for the method 'TranslationsSearch'

type TranslationsSearchParameters ¶ 

type TranslationsSearchParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Sort criteria. Can be one of: key_name, created_at, updated_at.
	Sort string `json:"sort,omitempty"`
	// Order direction. Can be one of: asc, desc.
	Order string `json:"order,omitempty"`
	// Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul>   <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>tags:XYZ</code> for tags on the translation</li>   <li><code>unverified:{true|false}</code> for verification status</li>   <li><code>excluded:{true|false}</code> for exclusion status</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
	Q string `json:"q,omitempty"`
}

TranslationsSearchParameters struct for TranslationsSearchParameters

type TranslationsUnverifyCollectionOpts ¶ 

type TranslationsUnverifyCollectionOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TranslationsUnverifyCollectionOpts Optional parameters for the method 'TranslationsUnverifyCollection'

type TranslationsUnverifyParameters ¶ 

type TranslationsUnverifyParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul>   <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>tags:XYZ</code> for tags on the translation</li>   <li><code>unverified:{true|false}</code> for verification status</li>   <li><code>excluded:{true|false}</code> for exclusion status</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
	Q string `json:"q,omitempty"`
	// Sort criteria. Can be one of: key_name, created_at, updated_at.
	Sort string `json:"sort,omitempty"`
	// Order direction. Can be one of: asc, desc.
	Order string `json:"order,omitempty"`
}

TranslationsUnverifyParameters struct for TranslationsUnverifyParameters

type TranslationsVerifyCollectionOpts ¶ 

type TranslationsVerifyCollectionOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

TranslationsVerifyCollectionOpts Optional parameters for the method 'TranslationsVerifyCollection'

type TranslationsVerifyParameters ¶ 

type TranslationsVerifyParameters struct {
	// specify the branch to use
	Branch string `json:"branch,omitempty"`
	// specify the locale of the translations to be verified
	LocaleId string `json:"locale_id,omitempty"`
	// Specify a query to find translations by content (including wildcards).<br><br> <i>Note: Search is limited to 10000 results and may not include recently updated data (depending on the project size).</i><br> The following qualifiers are supported in the query:<br> <ul>   <li><code>id:translation_id,...</code> for queries on a comma-separated list of ids</li>   <li><code>tags:XYZ</code> for tags on the translation</li>   <li><code>unverified:{true|false}</code> for verification status</li>   <li><code>excluded:{true|false}</code> for exclusion status</li>   <li><code>updated_at:{>=|<=}2013-02-21T00:00:00Z</code> for date range queries</li> </ul> Find more examples <a href=\"#overview--usage-examples\">here</a>.
	Q string `json:"q,omitempty"`
}

TranslationsVerifyParameters struct for TranslationsVerifyParameters

type Upload ¶ 

type Upload struct {
	Id       string `json:"id,omitempty"`
	Filename string `json:"filename,omitempty"`
	Format   string `json:"format,omitempty"`
	State    string `json:"state,omitempty"`
	Tag      string `json:"tag,omitempty"`
	// The URL to the upload in Phrase Strings app.
	Url       string        `json:"url,omitempty"`
	Summary   UploadSummary `json:"summary,omitempty"`
	CreatedAt time.Time     `json:"created_at,omitempty"`
	UpdatedAt time.Time     `json:"updated_at,omitempty"`
}

Upload struct for Upload

type UploadCreateOpts ¶ 

type UploadCreateOpts struct {
	XPhraseAppOTP       optional.String    `json:"X-PhraseApp-OTP,omitempty"`
	Branch              optional.String    `json:"branch,omitempty"`
	File                optional.Interface `json:"file,omitempty"`
	FileFormat          optional.String    `json:"file_format,omitempty"`
	LocaleId            optional.String    `json:"locale_id,omitempty"`
	Tags                optional.String    `json:"tags,omitempty"`
	UpdateTranslations  optional.Bool      `json:"update_translations,omitempty"`
	UpdateDescriptions  optional.Bool      `json:"update_descriptions,omitempty"`
	ConvertEmoji        optional.Bool      `json:"convert_emoji,omitempty"`
	SkipUploadTags      optional.Bool      `json:"skip_upload_tags,omitempty"`
	SkipUnverification  optional.Bool      `json:"skip_unverification,omitempty"`
	FileEncoding        optional.String    `json:"file_encoding,omitempty"`
	LocaleMapping       optional.Interface `json:"locale_mapping,omitempty"`
	FormatOptions       optional.Interface `json:"format_options,omitempty"`
	Autotranslate       optional.Bool      `json:"autotranslate,omitempty"`
	MarkReviewed        optional.Bool      `json:"mark_reviewed,omitempty"`
	TagOnlyAffectedKeys optional.Bool      `json:"tag_only_affected_keys,omitempty"`
}

UploadCreateOpts Optional parameters for the method 'UploadCreate'

type UploadShowOpts ¶ 

type UploadShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

UploadShowOpts Optional parameters for the method 'UploadShow'

type UploadSummary ¶ 

type UploadSummary struct {
	LocalesCreated             int32 `json:"locales_created,omitempty"`
	TranslationKeysCreated     int32 `json:"translation_keys_created,omitempty"`
	TranslationKeysUpdated     int32 `json:"translation_keys_updated,omitempty"`
	TranslationKeysUnmentioned int32 `json:"translation_keys_unmentioned,omitempty"`
	TranslationsCreated        int32 `json:"translations_created,omitempty"`
	TranslationsUpdated        int32 `json:"translations_updated,omitempty"`
	TagsCreated                int32 `json:"tags_created,omitempty"`
	TranslationKeysIgnored     int32 `json:"translation_keys_ignored,omitempty"`
}

UploadSummary struct for UploadSummary

type UploadsApiService ¶ 

type UploadsApiService service

UploadsApiService UploadsApi service

func (*UploadsApiService) UploadCreate ¶ 

func (a *UploadsApiService) UploadCreate(ctx _context.Context, projectId string, localVarOptionals *UploadCreateOpts) (Upload, *APIResponse, error)

UploadCreate Upload a new file Upload a new language file. Creates necessary resources in your project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *UploadCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use
  • @param "File" (optional.Interface of *os.File) - File to be imported
  • @param "FileFormat" (optional.String) - File format. Auto-detected when possible and not specified.
  • @param "LocaleId" (optional.String) - Locale of the file's content. Can be the name or public id of the locale. Preferred is the public id.
  • @param "Tags" (optional.String) - List of tags separated by comma to be associated with the new keys contained in the upload.
  • @param "UpdateTranslations" (optional.Bool) - Indicates whether existing translations should be updated with the file content.
  • @param "UpdateDescriptions" (optional.Bool) - Existing key descriptions will be updated with the file content. Empty descriptions overwrite existing descriptions.
  • @param "ConvertEmoji" (optional.Bool) - This option is obsolete. Providing the option will cause a bad request error.
  • @param "SkipUploadTags" (optional.Bool) - Indicates whether the upload should not create upload tags.
  • @param "SkipUnverification" (optional.Bool) - Indicates whether the upload should unverify updated translations.
  • @param "FileEncoding" (optional.String) - Enforces a specific encoding on the file contents. Valid options are \\\"UTF-8\\\", \\\"UTF-16\\\" and \\\"ISO-8859-1\\\".
  • @param "LocaleMapping" (optional.Interface of map[string]interface{}) - Optional, format specific mapping between locale names and the columns the translations to those locales are contained in.
  • @param "FormatOptions" (optional.Interface of map[string]interface{}) - Additional options available for specific formats. See our format guide for complete list.
  • @param "Autotranslate" (optional.Bool) - If set, translations for the uploaded language will be fetched automatically.
  • @param "MarkReviewed" (optional.Bool) - Indicated whether the imported translations should be marked as reviewed. This setting is available if the review workflow is enabled for the project.
  • @param "TagOnlyAffectedKeys" (optional.Bool) - Indicates whether only keys affected (created or updated) by the upload should be tagged. The default is `false`

@return Upload

func (*UploadsApiService) UploadShow ¶ 

func (a *UploadsApiService) UploadShow(ctx _context.Context, projectId string, id string, localVarOptionals *UploadShowOpts) (Upload, *APIResponse, error)

UploadShow Get a single upload View details and summary for a single upload.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *UploadShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return Upload

func (*UploadsApiService) UploadsList ¶ 

func (a *UploadsApiService) UploadsList(ctx _context.Context, projectId string, localVarOptionals *UploadsListOpts) ([]Upload, *APIResponse, error)

UploadsList List uploads List all uploads for the given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *UploadsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use

@return []Upload

type UploadsListOpts ¶ 

type UploadsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

UploadsListOpts Optional parameters for the method 'UploadsList'

type User ¶ 

type User struct {
	Id        string    `json:"id,omitempty"`
	Username  string    `json:"username,omitempty"`
	Name      string    `json:"name,omitempty"`
	Position  string    `json:"position,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

User struct for User

type UserPreview ¶ 

type UserPreview struct {
	Id          string `json:"id,omitempty"`
	Username    string `json:"username,omitempty"`
	Name        string `json:"name,omitempty"`
	GravatarUid string `json:"gravatar_uid,omitempty"`
}

UserPreview struct for UserPreview

type UsersApiService ¶ 

type UsersApiService service

UsersApiService UsersApi service

func (*UsersApiService) ShowUser ¶ 

func (a *UsersApiService) ShowUser(ctx _context.Context, localVarOptionals *ShowUserOpts) (CurrentUser, *APIResponse, error)

ShowUser Show current User Show details for current User.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param optional nil or *ShowUserOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return CurrentUser

type Variable ¶ 

type Variable struct {
	Name      string    `json:"name,omitempty"`
	Value     string    `json:"value,omitempty"`
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
}

Variable struct for Variable

type VariableCreateOpts ¶ 

type VariableCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

VariableCreateOpts Optional parameters for the method 'VariableCreate'

type VariableCreateParameters ¶ 

type VariableCreateParameters struct {
	// Name of the variable
	Name string `json:"name,omitempty"`
	// Value of the variable
	Value string `json:"value,omitempty"`
}

VariableCreateParameters struct for VariableCreateParameters

type VariableDeleteOpts ¶ 

type VariableDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

VariableDeleteOpts Optional parameters for the method 'VariableDelete'

type VariableShowOpts ¶ 

type VariableShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

VariableShowOpts Optional parameters for the method 'VariableShow'

type VariableUpdateOpts ¶ 

type VariableUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

VariableUpdateOpts Optional parameters for the method 'VariableUpdate'

type VariableUpdateParameters ¶ 

type VariableUpdateParameters struct {
	// Name of the variable
	Name string `json:"name,omitempty"`
	// Value of the variable
	Value string `json:"value,omitempty"`
}

VariableUpdateParameters struct for VariableUpdateParameters

type VariablesApiService ¶ 

type VariablesApiService service

VariablesApiService VariablesApi service

func (*VariablesApiService) VariableCreate ¶ 

func (a *VariablesApiService) VariableCreate(ctx _context.Context, projectId string, variableCreateParameters VariableCreateParameters, localVarOptionals *VariableCreateOpts) (Variable, *APIResponse, error)

VariableCreate Create a variable Create a new variable.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param variableCreateParameters
  • @param optional nil or *VariableCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Variable

func (*VariablesApiService) VariableDelete ¶ 

func (a *VariablesApiService) VariableDelete(ctx _context.Context, projectId string, name string, localVarOptionals *VariableDeleteOpts) ([]byte, *APIResponse, error)

VariableDelete Delete a variable Delete an existing variable.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param name name
  • @param optional nil or *VariableDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*VariablesApiService) VariableShow ¶ 

func (a *VariablesApiService) VariableShow(ctx _context.Context, projectId string, name string, localVarOptionals *VariableShowOpts) (Variable, *APIResponse, error)

VariableShow Get a single variable Get details on a single variable for a given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param name name
  • @param optional nil or *VariableShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Variable

func (*VariablesApiService) VariableUpdate ¶ 

func (a *VariablesApiService) VariableUpdate(ctx _context.Context, projectId string, name string, variableUpdateParameters VariableUpdateParameters, localVarOptionals *VariableUpdateOpts) (Variable, *APIResponse, error)

VariableUpdate Update a variable Update an existing variable.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param name name
  • @param variableUpdateParameters
  • @param optional nil or *VariableUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Variable

func (*VariablesApiService) VariablesList ¶ 

func (a *VariablesApiService) VariablesList(ctx _context.Context, projectId string, localVarOptionals *VariablesListOpts) ([]Variable, *APIResponse, error)

VariablesList List variables List all variables for the current project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *VariablesListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []Variable

type VariablesListOpts ¶ 

type VariablesListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

VariablesListOpts Optional parameters for the method 'VariablesList'

type VersionShowOpts ¶ 

type VersionShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

VersionShowOpts Optional parameters for the method 'VersionShow'

type VersionsHistoryApiService ¶ 

type VersionsHistoryApiService service

VersionsHistoryApiService VersionsHistoryApi service

func (*VersionsHistoryApiService) VersionShow ¶ 

func (a *VersionsHistoryApiService) VersionShow(ctx _context.Context, projectId string, translationId string, id string, localVarOptionals *VersionShowOpts) (TranslationVersionWithUser, *APIResponse, error)

VersionShow Get a single version Get details on a single version.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param translationId Translation ID
  • @param id ID
  • @param optional nil or *VersionShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Branch" (optional.String) - specify the branch to use

@return TranslationVersionWithUser

func (*VersionsHistoryApiService) VersionsList ¶ 

func (a *VersionsHistoryApiService) VersionsList(ctx _context.Context, projectId string, translationId string, localVarOptionals *VersionsListOpts) ([]TranslationVersion, *APIResponse, error)

VersionsList List all versions List all changes done to a given translation.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param translationId Translation ID
  • @param optional nil or *VersionsListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default
  • @param "Branch" (optional.String) - specify the branch to use

@return []TranslationVersion

type VersionsListOpts ¶ 

type VersionsListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
	Branch        optional.String `json:"branch,omitempty"`
}

VersionsListOpts Optional parameters for the method 'VersionsList'

type Webhook ¶ 

type Webhook struct {
	Id              string    `json:"id,omitempty"`
	CallbackUrl     string    `json:"callback_url,omitempty"`
	Description     string    `json:"description,omitempty"`
	Events          []string  `json:"events,omitempty"`
	Active          *bool     `json:"active,omitempty"`
	IncludeBranches *bool     `json:"include_branches,omitempty"`
	CreatedAt       time.Time `json:"created_at,omitempty"`
	UpdatedAt       time.Time `json:"updated_at,omitempty"`
}

Webhook struct for Webhook

type WebhookCreateOpts ¶ 

type WebhookCreateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

WebhookCreateOpts Optional parameters for the method 'WebhookCreate'

type WebhookCreateParameters ¶ 

type WebhookCreateParameters struct {
	// Callback URL to send requests to
	CallbackUrl string `json:"callback_url,omitempty"`
	// Webhook secret used to calculate signature. If empty, the default project secret will be used.
	Secret string `json:"secret,omitempty"`
	// Webhook description
	Description string `json:"description,omitempty"`
	// List of event names to trigger the webhook (separated by comma)
	Events string `json:"events,omitempty"`
	// Whether webhook is active or inactive
	Active *bool `json:"active,omitempty"`
	// If enabled, webhook will also be triggered for events from branches of the project specified.
	IncludeBranches *bool `json:"include_branches,omitempty"`
}

WebhookCreateParameters struct for WebhookCreateParameters

type WebhookDeleteOpts ¶ 

type WebhookDeleteOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

WebhookDeleteOpts Optional parameters for the method 'WebhookDelete'

type WebhookDeliveriesApiService ¶ added in v2.6.0 

type WebhookDeliveriesApiService service

WebhookDeliveriesApiService WebhookDeliveriesApi service

func (*WebhookDeliveriesApiService) WebhookDeliveriesList ¶ added in v2.6.0 

func (a *WebhookDeliveriesApiService) WebhookDeliveriesList(ctx _context.Context, projectId string, webhookId string, localVarOptionals *WebhookDeliveriesListOpts) ([]WebhookDelivery, *APIResponse, error)

WebhookDeliveriesList List webhook deliveries List all webhook deliveries for the given webhook_id.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param webhookId Webhook ID
  • @param optional nil or *WebhookDeliveriesListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "ResponseStatusCodes" (optional.String) - List of Response Status Codes

@return []WebhookDelivery

func (*WebhookDeliveriesApiService) WebhookDeliveriesRedeliver ¶ added in v2.6.0 

func (a *WebhookDeliveriesApiService) WebhookDeliveriesRedeliver(ctx _context.Context, projectId string, webhookId string, id string, localVarOptionals *WebhookDeliveriesRedeliverOpts) (WebhookDelivery, *APIResponse, error)

WebhookDeliveriesRedeliver Redeliver a single webhook delivery Trigger an individual webhook delivery to be redelivered.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param webhookId Webhook ID
  • @param id ID
  • @param optional nil or *WebhookDeliveriesRedeliverOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return WebhookDelivery

func (*WebhookDeliveriesApiService) WebhookDeliveriesShow ¶ added in v2.6.0 

func (a *WebhookDeliveriesApiService) WebhookDeliveriesShow(ctx _context.Context, projectId string, webhookId string, id string, localVarOptionals *WebhookDeliveriesShowOpts) (WebhookDelivery, *APIResponse, error)

WebhookDeliveriesShow Get a single webhook delivery Get all information about a single webhook delivery for the given ID.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param webhookId Webhook ID
  • @param id ID
  • @param optional nil or *WebhookDeliveriesShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return WebhookDelivery

type WebhookDeliveriesListOpts ¶ added in v2.6.0 

type WebhookDeliveriesListOpts struct {
	XPhraseAppOTP       optional.String `json:"X-PhraseApp-OTP,omitempty"`
	ResponseStatusCodes optional.String `json:"response_status_codes,omitempty"`
}

WebhookDeliveriesListOpts Optional parameters for the method 'WebhookDeliveriesList'

type WebhookDeliveriesRedeliverOpts ¶ added in v2.6.0 

type WebhookDeliveriesRedeliverOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

WebhookDeliveriesRedeliverOpts Optional parameters for the method 'WebhookDeliveriesRedeliver'

type WebhookDeliveriesShowOpts ¶ added in v2.6.0 

type WebhookDeliveriesShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

WebhookDeliveriesShowOpts Optional parameters for the method 'WebhookDeliveriesShow'

type WebhookDelivery ¶ added in v2.6.0 

type WebhookDelivery struct {
	Id                 string    `json:"id,omitempty"`
	WebhookId          string    `json:"webhook_id,omitempty"`
	ResponseStatusCode int32     `json:"response_status_code,omitempty"`
	DeliveredAt        time.Time `json:"delivered_at,omitempty"`
	DurationMs         int32     `json:"duration_ms,omitempty"`
	CreatedAt          time.Time `json:"created_at,omitempty"`
	UpdatedAt          time.Time `json:"updated_at,omitempty"`
}

WebhookDelivery struct for WebhookDelivery

type WebhookShowOpts ¶ 

type WebhookShowOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

WebhookShowOpts Optional parameters for the method 'WebhookShow'

type WebhookTestOpts ¶ 

type WebhookTestOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

WebhookTestOpts Optional parameters for the method 'WebhookTest'

type WebhookUpdateOpts ¶ 

type WebhookUpdateOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
}

WebhookUpdateOpts Optional parameters for the method 'WebhookUpdate'

type WebhookUpdateParameters ¶ 

type WebhookUpdateParameters struct {
	// Callback URL to send requests to
	CallbackUrl string `json:"callback_url,omitempty"`
	// Webhook secret used to calculate signature. If empty, the default project secret will be used.
	Secret string `json:"secret,omitempty"`
	// Webhook description
	Description string `json:"description,omitempty"`
	// List of event names to trigger the webhook (separated by comma)
	Events string `json:"events,omitempty"`
	// Whether webhook is active or inactive
	Active *bool `json:"active,omitempty"`
	// If enabled, webhook will also be triggered for events from branches of the project specified.
	IncludeBranches *bool `json:"include_branches,omitempty"`
}

WebhookUpdateParameters struct for WebhookUpdateParameters

type WebhooksApiService ¶ 

type WebhooksApiService service

WebhooksApiService WebhooksApi service

func (*WebhooksApiService) WebhookCreate ¶ 

func (a *WebhooksApiService) WebhookCreate(ctx _context.Context, projectId string, webhookCreateParameters WebhookCreateParameters, localVarOptionals *WebhookCreateOpts) (Webhook, *APIResponse, error)

WebhookCreate Create a webhook Create a new webhook.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param webhookCreateParameters
  • @param optional nil or *WebhookCreateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Webhook

func (*WebhooksApiService) WebhookDelete ¶ 

func (a *WebhooksApiService) WebhookDelete(ctx _context.Context, projectId string, id string, localVarOptionals *WebhookDeleteOpts) ([]byte, *APIResponse, error)

WebhookDelete Delete a webhook Delete an existing webhook.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *WebhookDeleteOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*WebhooksApiService) WebhookShow ¶ 

func (a *WebhooksApiService) WebhookShow(ctx _context.Context, projectId string, id string, localVarOptionals *WebhookShowOpts) (Webhook, *APIResponse, error)

WebhookShow Get a single webhook Get details on a single webhook.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *WebhookShowOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Webhook

func (*WebhooksApiService) WebhookTest ¶ 

func (a *WebhooksApiService) WebhookTest(ctx _context.Context, projectId string, id string, localVarOptionals *WebhookTestOpts) ([]byte, *APIResponse, error)

WebhookTest Test a webhook Perform a test request for a webhook.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param optional nil or *WebhookTestOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

func (*WebhooksApiService) WebhookUpdate ¶ 

func (a *WebhooksApiService) WebhookUpdate(ctx _context.Context, projectId string, id string, webhookUpdateParameters WebhookUpdateParameters, localVarOptionals *WebhookUpdateOpts) (Webhook, *APIResponse, error)

WebhookUpdate Update a webhook Update an existing webhook.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param id ID
  • @param webhookUpdateParameters
  • @param optional nil or *WebhookUpdateOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)

@return Webhook

func (*WebhooksApiService) WebhooksList ¶ 

func (a *WebhooksApiService) WebhooksList(ctx _context.Context, projectId string, localVarOptionals *WebhooksListOpts) ([]Webhook, *APIResponse, error)

WebhooksList List webhooks List all webhooks for the given project.

  • @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
  • @param projectId Project ID
  • @param optional nil or *WebhooksListOpts - Optional Parameters:
  • @param "XPhraseAppOTP" (optional.String) - Two-Factor-Authentication token (optional)
  • @param "Page" (optional.Int32) - Page number
  • @param "PerPage" (optional.Int32) - Limit on the number of objects to be returned, between 1 and 100. 25 by default

@return []Webhook

type WebhooksListOpts ¶ 

type WebhooksListOpts struct {
	XPhraseAppOTP optional.String `json:"X-PhraseApp-OTP,omitempty"`
	Page          optional.Int32  `json:"page,omitempty"`
	PerPage       optional.Int32  `json:"per_page,omitempty"`
}

WebhooksListOpts Optional parameters for the method 'WebhooksList'

Source Files ¶

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.