@jumoo/translate 17.9.2 → 18.3.1

package/dist/api/types.gen.d.ts

@@ -1,12 +1,12 @@
 export type ClientOptions = {
-    baseUrl: 'http://localhost:30095' | (string & {});
+    baseUrl: 'https://localhost:44380/' | (string & {});
 };
 export type BulkSelectionNode = {
     key: string;
     name: string;
     friendlyPath: string;
-    setKey?: string | null;
-    setName?: string | null;
+    setKey?: null | string;
+    setName?: null | string;
     hasChildren: boolean;
     includeChildren: boolean;
     descendantCount: number;
@@ -19,8 +19,8 @@ export type BulkSelectionResult = {
     roots: Array<BulkSelectionNode>;
     contentIds: Array<string>;
     valid: boolean;
-    setKey?: string | null;
-    setName?: string | null;
+    setKey?: null | string;
+    setName?: null | string;
     errors: Array<string>;
 };
 export type CloneNodeOptions = {
@@ -60,21 +60,22 @@ export type GlossaryLanguageStats = {
     missingCount: number;
 };
 export type GlossaryTerm = {
-    id: number;
-    key: string;
     sourceLanguage: string;
     sourceText: string;
-    notes?: string | null;
+    notes?: null | string;
     caseSensitive: boolean;
     values: Array<GlossaryTermValue>;
+    key: string;
+    id: number;
 };
 export type GlossaryTermValue = {
-    id: number;
     termKey: string;
     language: string;
     value: string;
     doNotTranslate: boolean;
+    id: number;
 };
+export type IFormFile = Blob | File;
 export declare enum JobApprovalStatus {
     NONE = "None",
     REVIEW = "Review",
@@ -110,13 +111,8 @@ export type JobStatusStats = {
     nodeCount: number;
     wordCount: number;
 };
-export type JsonNode = {
-    options?: JsonNodeOptions | null;
-    parent?: JsonNode | null;
-    root: JsonNode;
-};
-export type JsonNodeOptions = {
-    propertyNameCaseInsensitive: boolean;
+export type JsonObject = {
+    [key: string]: unknown;
 };
 export type LicenceInfo = {
     name: string;
@@ -132,7 +128,7 @@ export type LicenceInfo = {
     requiresKey: boolean;
     message: string;
     autoRenews: boolean;
-    checkedDomains?: string | null;
+    checkedDomains?: null | string;
     licenceType: LicenceType;
     providers: {
         [key: string]: LicenceInfo;
@@ -192,18 +188,17 @@ export type PagedTranslationLanguageItemResponseModel = {
     items: Array<TranslationLanguageItemResponseModel>;
 };
 export type ProblemDetails = {
-    type?: string | null;
-    title?: string | null;
-    status?: number | null;
-    detail?: string | null;
-    instance?: string | null;
-    [key: string]: unknown;
+    type?: null | string;
+    title?: null | string;
+    status?: null | number | string;
+    detail?: null | string;
+    instance?: null | string;
 };
 export type SaveGlossaryTermRequest = {
-    key?: string | null;
+    key?: null | string;
     sourceLanguage: string;
     sourceText: string;
-    notes?: string | null;
+    notes?: null | string;
     caseSensitive: boolean;
     values: Array<SaveGlossaryTermValueRequest>;
 };
@@ -220,7 +215,7 @@ export type SiteDetail = {
 export type SiteItemView = {
     id: number;
     icon: string;
-    name: string | null;
+    name: null | string;
     cultureCode: string;
     cultureName: string;
 };
@@ -273,6 +268,7 @@ export type TranslateSettings = {
     tagSettings: TagSettings;
     backgroundApproval: boolean;
     useLegacySubmit: boolean;
+    inPlaceTranslation: boolean;
 };
 export type TranslateSettingsLinks = {
     updatePicked: boolean;
@@ -293,20 +289,24 @@ export type TranslateSetupInfo = {
     };
 };
 export type TranslateUpdate = {
-    version: string;
-    message?: string | null;
-    link?: string | null;
     isLatest: boolean;
+    version: string;
+    message?: null | string;
+    link?: null | string;
 };
 export type TranslationAuditItem = {
-    id: number;
     jobId: number;
     userKey: string;
     username: string;
     eventDate: string;
     eventType: TranslationEventType;
     comment: string;
+    id: number;
 };
+export declare enum TranslationEntityType {
+    DOCUMENT = "Document",
+    ELEMENT = "Element"
+}
 export declare enum TranslationEventType {
     NONE = "None",
     CREATED = "Created",
@@ -328,8 +328,7 @@ export declare enum TranslationEventType {
     CUSTOM = "Custom"
 }
 export type TranslationJobView = {
-    id: number;
-    key: string;
+    username: string;
     name: string;
     setKey: string;
     sourceCulture: CultureInfoView;
@@ -337,9 +336,9 @@ export type TranslationJobView = {
     nodeCount: number;
     nodes: Array<TranslationNode>;
     created: string;
-    submitted?: string | null;
-    received?: string | null;
-    readonly statusIsDirty: boolean;
+    submitted?: null | string;
+    received?: null | string;
+    statusIsDirty: boolean;
     status: JobStatus;
     providerKey: string;
     providerName: string;
@@ -350,12 +349,13 @@ export type TranslationJobView = {
     userKey: string;
     options: JobOptions;
     groupId: string;
-    username: string;
+    key: string;
+    id: number;
 };
 export type TranslationLanguageItemResponseModel = {
     id: string;
     name: string;
-    parent?: TranslationReferenceByNameModel | null;
+    parent?: null | TranslationReferenceByNameModel;
     flags: Array<FlagModel>;
     hasChildren: boolean;
     isFolder: boolean;
@@ -363,22 +363,21 @@ export type TranslationLanguageItemResponseModel = {
     entityType: string;
 };
 export type TranslationMemory = {
-    id: number;
     reference: string;
     approved: boolean;
     sourceLanguage: string;
     targetLanguage: string;
-    translationSource: string | null;
+    translationSource: null | string;
     sourceText: string;
     translation: string;
+    id: number;
 };
 export type TranslationNode = {
-    id: number;
-    key: string;
     setKey: string;
     culture: CultureInfoView;
     masterNodeId: number;
     targetNodeId: number;
+    entityType: TranslationEntityType;
     status: NodeStatus;
     created: string;
     updated: string;
@@ -392,6 +391,8 @@ export type TranslationNode = {
     groups: Array<TranslationPropertyGroup>;
     hasOpenSiblings: boolean;
     targetNodePermissions: string;
+    key: string;
+    id: number;
 };
 export type TranslationNodeStatus = {
     id: number;
@@ -418,39 +419,40 @@ export type TranslationProcessingOptions = {
     primaryType: string;
     runInBackground: boolean;
     set: number;
-    sites?: Array<SiteDetail> | null;
-    cultures?: Array<string> | null;
-    contentIds?: Array<string> | null;
-    nodeIds?: Array<string> | null;
-    contentNames?: Array<string> | null;
+    sites?: null | Array<SiteDetail>;
+    cultures?: null | Array<string>;
+    inPlace: boolean;
+    sourceCulture?: null | string;
+    contentIds?: null | Array<string>;
+    nodeIds?: null | Array<string>;
+    contentNames?: null | Array<string>;
     includeChildren: boolean;
     includeUnpublished: boolean;
     createJob: boolean;
     lockProvider: boolean;
-    providerKey?: string | null;
+    providerKey?: null | string;
     providerSettings?: unknown;
     providerOptions?: unknown;
-    jobName?: string | null;
-    groupId?: string | null;
+    jobName?: null | string;
+    groupId?: null | string;
     autoApprove: boolean;
     replaceNodeName: boolean;
     copyProperties: boolean;
-    clientId?: string | null;
+    clientId?: null | string;
     backgroundApproval: boolean;
     canApprove: boolean;
     canPublish: boolean;
     blockedPublishCount: number;
     selectedCount: number;
-    [key: string]: unknown;
 };
 export type TranslationProperty = {
-    id: number;
     nodeKey: string;
     alias: string;
     group: string;
     sortOrder: number;
-    source?: TranslationValue | null;
-    target?: TranslationValue | null;
+    source?: null | TranslationValue;
+    target?: null | TranslationValue;
+    id: number;
 };
 export type TranslationPropertyGroup = {
     name: string;
@@ -459,7 +461,7 @@ export type TranslationPropertyGroup = {
     properties: Array<TranslationProperty>;
 };
 export type TranslationProviderInfo = {
-    icon?: string | null;
+    icon?: null | string;
     supportsGlossary: boolean;
     supportsTranslationMemory: boolean;
     name: string;
@@ -483,12 +485,11 @@ export type TranslationReferenceByNameModel = {
     id: string;
 };
 export type TranslationSet = {
-    id: number;
-    key: string;
     icon: string;
     name: string;
     masterId: number;
-    culture?: CultureInfoView | null;
+    entityType: TranslationEntityType;
+    culture?: null | CultureInfoView;
     sites: Array<TranslationSetSite>;
     copyOnCreate: boolean;
     translateNodeName: boolean;
@@ -499,8 +500,8 @@ export type TranslationSet = {
     alwaysSend: boolean;
     properties: string;
     useRegExProperties: boolean;
-    ignoreDocTypes?: string | null;
-    providerKey?: string | null;
+    ignoreDocTypes?: null | string;
+    providerKey?: null | string;
     masterSite: Array<SiteUpdateValues>;
     siteIds: Array<SiteUpdateValues>;
     options: {
@@ -509,10 +510,10 @@ export type TranslationSet = {
     providerOptions: {
         [key: string]: unknown;
     };
+    key: string;
+    id: number;
 };
 export type TranslationSetNotifications = {
-    id: number;
-    key: string;
     setKey: string;
     inherit: boolean;
     pending: string;
@@ -520,6 +521,8 @@ export type TranslationSetNotifications = {
     received: string;
     approved: string;
     notifyCreator: boolean;
+    key: string;
+    id: number;
 };
 export type TranslationSetSite = {
     id: number;
@@ -543,7 +546,7 @@ export type TranslationValue = {
     htmlControl: boolean;
     translated: boolean;
     sortOrder: number;
-    source?: string | null;
+    source?: null | string;
     innerValues: {
         [key: string]: TranslationValue;
     };
@@ -559,37 +562,6 @@ export type WordCountInfo = {
     properties: number;
     message: string;
 };
-export type JsonNodeWritable = {
-    [key: string]: never;
-};
-export type PagedModelTranslationJobViewModelWritable = {
-    items: Array<TranslationJobViewWritable>;
-    total: number;
-};
-export type TranslationJobViewWritable = {
-    id: number;
-    key: string;
-    name: string;
-    setKey: string;
-    sourceCulture: CultureInfoView;
-    targetCulture: CultureInfoView;
-    nodeCount: number;
-    nodes: Array<TranslationNode>;
-    created: string;
-    submitted?: string | null;
-    received?: string | null;
-    status: JobStatus;
-    providerKey: string;
-    providerName: string;
-    providerProperties: string;
-    providerStatus: string;
-    note: string;
-    statusLocalName: string;
-    userKey: string;
-    options: JobOptions;
-    groupId: string;
-    username: string;
-};
 export type CulturesGetInfoData = {
     body?: never;
     path?: never;
@@ -671,7 +643,7 @@ export type GlossaryDeleteResponses = {
 };
 export type GlossaryDeleteResponse = GlossaryDeleteResponses[keyof GlossaryDeleteResponses];
 export type GlossaryDeleteManyData = {
-    body?: Array<string>;
+    body: Array<string>;
     path?: never;
     query?: never;
     url: '/umbraco/jumoo-translate/api/v1/glossary/DeleteMany';
@@ -762,7 +734,7 @@ export type GlossaryExportTbxErrors = {
     /**
      * Bad Request
      */
-    400: unknown;
+    400: Blob | File;
     /**
      * The resource is protected and requires an authentication token
      */
@@ -774,14 +746,16 @@ export type GlossaryExportTbxErrors = {
     /**
      * Not Found
      */
-    404: unknown;
+    404: Blob | File;
 };
+export type GlossaryExportTbxError = GlossaryExportTbxErrors[keyof GlossaryExportTbxErrors];
 export type GlossaryExportTbxResponses = {
     /**
      * OK
      */
-    200: unknown;
+    200: Blob | File;
 };
+export type GlossaryExportTbxResponse = GlossaryExportTbxResponses[keyof GlossaryExportTbxResponses];
 export type GlossaryGetData = {
     body?: never;
     path?: never;
@@ -846,10 +820,10 @@ export type GlossaryGetAllResponses = {
 };
 export type GlossaryGetAllResponse = GlossaryGetAllResponses[keyof GlossaryGetAllResponses];
 export type GlossaryImportData = {
-    body?: {
-        File: Blob | File;
-        SourceLanguage: string;
-        TargetLanguage: string;
+    body: {
+        File?: IFormFile;
+        SourceLanguage?: string;
+        TargetLanguage?: string;
         CreateMissingTerms?: boolean;
     };
     path?: never;
@@ -878,9 +852,9 @@ export type GlossaryImportResponses = {
 };
 export type GlossaryImportResponse = GlossaryImportResponses[keyof GlossaryImportResponses];
 export type GlossaryImportTbxData = {
-    body?: {
-        File: Blob | File;
-        SourceLanguage: string;
+    body: {
+        File?: IFormFile;
+        SourceLanguage?: string;
         CreateMissingTerms?: boolean;
         TargetLanguages?: Array<string>;
     };
@@ -910,7 +884,7 @@ export type GlossaryImportTbxResponses = {
 };
 export type GlossaryImportTbxResponse = GlossaryImportTbxResponses[keyof GlossaryImportTbxResponses];
 export type GlossarySaveData = {
-    body?: SaveGlossaryTermRequest;
+    body: SaveGlossaryTermRequest;
     path?: never;
     query?: never;
     url: '/umbraco/jumoo-translate/api/v1/glossary/Save';
@@ -1049,7 +1023,7 @@ export type JobArchiveResponses = {
 };
 export type JobArchiveResponse = JobArchiveResponses[keyof JobArchiveResponses];
 export type JobBulkCancelData = {
-    body?: Array<string>;
+    body: Array<string>;
     path?: never;
     query?: never;
     url: '/umbraco/jumoo-translate/api/v1/jobs/BulkCancel';
@@ -1068,7 +1042,7 @@ export type JobBulkCancelResponses = {
 };
 export type JobBulkCancelResponse = JobBulkCancelResponses[keyof JobBulkCancelResponses];
 export type JobBulkCheckData = {
-    body?: Array<string>;
+    body: Array<string>;
     path?: never;
     query?: never;
     url: '/umbraco/jumoo-translate/api/v1/jobs/BulkCheck';
@@ -1087,7 +1061,7 @@ export type JobBulkCheckResponses = {
 };
 export type JobBulkCheckResponse = JobBulkCheckResponses[keyof JobBulkCheckResponses];
 export type JobBulkRemoveData = {
-    body?: Array<string>;
+    body: Array<string>;
     path?: never;
     query?: never;
     url: '/umbraco/jumoo-translate/api/v1/jobs/BulkRemove';
@@ -1730,7 +1704,7 @@ export type LicenceValidResponses = {
 };
 export type LicenceValidResponse = LicenceValidResponses[keyof LicenceValidResponses];
 export type MemoryCopyData = {
-    body?: CopyMemoryRequest;
+    body: CopyMemoryRequest;
     path?: never;
     query?: never;
     url: '/umbraco/jumoo-translate/api/v1/memory/Copy';
@@ -2009,7 +1983,7 @@ export type MemorySourcesResponses = {
 };
 export type MemorySourcesResponse = MemorySourcesResponses[keyof MemorySourcesResponses];
 export type MemoryUpdateData = {
-    body?: UpdateMemoryRequest;
+    body: UpdateMemoryRequest;
     path?: never;
     query?: never;
     url: '/umbraco/jumoo-translate/api/v1/memory/Update';
@@ -2036,7 +2010,7 @@ export type MemoryUpdateResponses = {
 };
 export type MemoryUpdateResponse = MemoryUpdateResponses[keyof MemoryUpdateResponses];
 export type NodeCloneData = {
-    body?: CloneNodeOptions;
+    body: CloneNodeOptions;
     path?: never;
     query?: {
         id?: number;
@@ -2085,7 +2059,7 @@ export type NodeDeleteResponses = {
     200: unknown;
 };
 export type NodeDeleteByKeyData = {
-    body?: Array<string>;
+    body: Array<string>;
     path?: never;
     query?: never;
     url: '/umbraco/jumoo-translate/api/v1/nodes/DeleteByKey';
@@ -2166,7 +2140,7 @@ export type NodeGetAllCulturesResponses = {
 };
 export type NodeGetAllCulturesResponse = NodeGetAllCulturesResponses[keyof NodeGetAllCulturesResponses];
 export type NodeGetBulkSelectionData = {
-    body?: Array<BulkSelectionRequestItem>;
+    body: Array<BulkSelectionRequestItem>;
     path?: never;
     query?: never;
     url: '/umbraco/jumoo-translate/api/v1/nodes/GetBulkSelection';
@@ -2299,7 +2273,7 @@ export type NodeGetByNodeAndStatusPagedResponses = {
 };
 export type NodeGetByNodeAndStatusPagedResponse = NodeGetByNodeAndStatusPagedResponses[keyof NodeGetByNodeAndStatusPagedResponses];
 export type NodeGetPathsData = {
-    body?: Array<number>;
+    body: Array<number>;
     path?: never;
     query?: never;
     url: '/umbraco/jumoo-translate/api/v1/nodes/GetPaths';
@@ -2367,6 +2341,7 @@ export type NodeGetWordCountInfoData = {
     query?: {
         contentKey?: string;
         includeChildren?: boolean;
+        entityType?: TranslationEntityType;
     };
     url: '/umbraco/jumoo-translate/api/v1/nodes/GetWordCountInfo';
 };
@@ -2425,7 +2400,7 @@ export type NodeRemoveByCultureResponses = {
 };
 export type NodeRemoveByCultureResponse = NodeRemoveByCultureResponses[keyof NodeRemoveByCultureResponses];
 export type NodeSavePropertyData = {
-    body?: TranslationProperty;
+    body: TranslationProperty;
     path?: never;
     query?: {
         nodeId?: number;
@@ -2449,7 +2424,7 @@ export type NodeSavePropertyResponses = {
     200: unknown;
 };
 export type NodeUpdatePropertiesData = {
-    body?: Array<TranslationProperty>;
+    body: Array<TranslationProperty>;
     path?: never;
     query?: {
         nodeId?: number;
@@ -2478,7 +2453,7 @@ export type NodeUpdatePropertiesResponses = {
     200: unknown;
 };
 export type NodeUpdateTranslationValueData = {
-    body?: TranslationValue;
+    body: TranslationValue;
     path?: never;
     query?: {
         id?: number;
@@ -2632,7 +2607,7 @@ export type ProviderGetSettingsByAliasResponses = {
 };
 export type ProviderGetSettingsByAliasResponse = ProviderGetSettingsByAliasResponses[keyof ProviderGetSettingsByAliasResponses];
 export type ProviderSaveSettingsData = {
-    body?: {
+    body: {
         [key: string]: unknown;
     };
     path?: never;
@@ -2762,6 +2737,7 @@ export type SetGetByContentKeyData = {
     path?: never;
     query?: {
         id?: string;
+        entityType?: TranslationEntityType;
     };
     url: '/umbraco/jumoo-translate/api/v1/sets/GetByContentKey';
 };
@@ -2879,6 +2855,7 @@ export type SetGetContentCultureInfoData = {
     path?: never;
     query?: {
         key?: string;
+        entityType?: TranslationEntityType;
     };
     url: '/umbraco/jumoo-translate/api/v1/sets/GetContentCultureInfo';
 };
@@ -2933,6 +2910,27 @@ export type SetGetInstalledCulturesResponses = {
     200: Array<CultureInfoView>;
 };
 export type SetGetInstalledCulturesResponse = SetGetInstalledCulturesResponses[keyof SetGetInstalledCulturesResponses];
+export type SetGetNewSetData = {
+    body?: never;
+    path?: never;
+    query?: {
+        entityType?: TranslationEntityType;
+    };
+    url: '/umbraco/jumoo-translate/api/v1/sets/GetNewSet';
+};
+export type SetGetNewSetErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type SetGetNewSetResponses = {
+    /**
+     * OK
+     */
+    200: TranslationSet;
+};
+export type SetGetNewSetResponse = SetGetNewSetResponses[keyof SetGetNewSetResponses];
 export type SetGetNotifySettingsData = {
     body?: never;
     path?: never;
@@ -2956,9 +2954,11 @@ export type SetGetNotifySettingsResponses = {
 };
 export type SetGetNotifySettingsResponse = SetGetNotifySettingsResponses[keyof SetGetNotifySettingsResponses];
 export type SetGetSetNodesData = {
-    body?: Array<SiteUpdateValues>;
+    body: Array<SiteUpdateValues>;
     path?: never;
-    query?: never;
+    query?: {
+        entityType?: TranslationEntityType;
+    };
     url: '/umbraco/jumoo-translate/api/v1/sets/GetSetNodes';
 };
 export type SetGetSetNodesErrors = {
@@ -2975,7 +2975,7 @@ export type SetGetSetNodesResponses = {
 };
 export type SetGetSetNodesResponse = SetGetSetNodesResponses[keyof SetGetSetNodesResponses];
 export type SetSaveNotifiySettingsData = {
-    body?: TranslationSetNotifications;
+    body: TranslationSetNotifications;
     path?: never;
     query?: never;
     url: '/umbraco/jumoo-translate/api/v1/sets/SaveNotifiySettings';
@@ -2999,7 +2999,7 @@ export type SetSaveNotifiySettingsResponses = {
 };
 export type SetSaveNotifiySettingsResponse = SetSaveNotifiySettingsResponses[keyof SetSaveNotifiySettingsResponses];
 export type SetSaveSettingsData = {
-    body?: TranslationSet;
+    body: TranslationSet;
     path?: never;
     query?: never;
     url: '/umbraco/jumoo-translate/api/v1/sets/SaveSettings';
@@ -3157,9 +3157,7 @@ export type SettingsGetProvidersContentResponses = {
     /**
      * OK
      */
-    200: {
-        [key: string]: JsonNode;
-    };
+    200: JsonObject;
 };
 export type SettingsGetProvidersContentResponse = SettingsGetProvidersContentResponses[keyof SettingsGetProvidersContentResponses];
 export type SettingsGetSetupData = {
@@ -3201,7 +3199,7 @@ export type SettingsGetUpdateResponses = {
 };
 export type SettingsGetUpdateResponse = SettingsGetUpdateResponses[keyof SettingsGetUpdateResponses];
 export type SettingsSaveData = {
-    body?: TranslateSettings;
+    body: TranslateSettings;
     path?: never;
     query?: never;
     url: '/umbraco/jumoo-translate/api/v1/settings/Save';
@@ -3219,7 +3217,7 @@ export type SettingsSaveResponses = {
     200: unknown;
 };
 export type SettingsSaveLicenceData = {
-    body?: LicenceInfo;
+    body: LicenceInfo;
     path?: never;
     query?: never;
     url: '/umbraco/jumoo-translate/api/v1/settings/SaveLicence';
@@ -3241,6 +3239,7 @@ export type StatusGetStatusData = {
     path?: never;
     query?: {
         key?: string;
+        entityType?: TranslationEntityType;
     };
     url: '/umbraco/jumoo-translate/api/v1/status/GetStatus';
 };
@@ -3257,3 +3256,22 @@ export type StatusGetStatusResponses = {
     200: Array<TranslationNodeStatus>;
 };
 export type StatusGetStatusResponse = StatusGetStatusResponses[keyof StatusGetStatusResponses];
+export type StatusProcessingStatusData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: '/umbraco/jumoo-translate/api/v1/status/ProcessingStatus';
+};
+export type StatusProcessingStatusErrors = {
+    /**
+     * The resource is protected and requires an authentication token
+     */
+    401: unknown;
+};
+export type StatusProcessingStatusResponses = {
+    /**
+     * OK
+     */
+    200: TranslationProcessingOptions;
+};
+export type StatusProcessingStatusResponse = StatusProcessingStatusResponses[keyof StatusProcessingStatusResponses];