From c63461b1044c80cb47f2d36ba39d2efa9ac8fa65 Mon Sep 17 00:00:00 2001 From: Mads Rasmussen Date: Tue, 30 Apr 2024 08:53:21 +0200 Subject: [PATCH] generate new server models --- .../src/external/backend-api/src/models.ts | 147 +++++---- .../src/external/backend-api/src/services.ts | 285 ++++++++++-------- 2 files changed, 223 insertions(+), 209 deletions(-) diff --git a/src/Umbraco.Web.UI.Client/src/external/backend-api/src/models.ts b/src/Umbraco.Web.UI.Client/src/external/backend-api/src/models.ts index 1bcb75c327..1ea8d622d6 100644 --- a/src/Umbraco.Web.UI.Client/src/external/backend-api/src/models.ts +++ b/src/Umbraco.Web.UI.Client/src/external/backend-api/src/models.ts @@ -14,31 +14,14 @@ description?: string | null icon?: string | null }; -export type AuditLogEntityModel = { - id?: string | null -type?: string | null - }; - export type AuditLogResponseModel = { user: ReferenceByIdModel -entity?: AuditLogEntityModel | null timestamp: string logType: AuditTypeModel comment?: string | null parameters?: string | null }; -export type AuditLogWithUsernameResponseModel = { - user: ReferenceByIdModel -entity?: AuditLogEntityModel | null -timestamp: string -logType: AuditTypeModel -comment?: string | null -parameters?: string | null -userName?: string | null -userAvatars: Array - }; - export enum AuditTypeModel { NEW = 'New', SAVE = 'Save', @@ -625,8 +608,7 @@ updater?: string | null }; export type DocumentConfigurationResponseModel = { - sanitizeTinyMce: boolean -disableDeleteWhenReferenced: boolean + disableDeleteWhenReferenced: boolean disableUnpublishWhenReferenced: boolean allowEditInvariantFromNonDefault: boolean allowNonExistingSegmentsCreation: boolean @@ -1124,7 +1106,6 @@ mediaType: MediaTypeCollectionReferenceResponseModel export type MediaConfigurationResponseModel = { disableDeleteWhenReferenced: boolean disableUnpublishWhenReferenced: boolean -sanitizeTinyMce: boolean reservedFieldNames: Array }; @@ -1548,11 +1529,6 @@ export type PagedAuditLogResponseModel = { items: Array }; -export type PagedAuditLogWithUsernameResponseModel = { - total: number -items: Array - }; - export type PagedCultureReponseModel = { total: number items: Array @@ -1788,6 +1764,11 @@ export type PagedSearcherResponseModel = { items: Array }; +export type PagedSegmentResponseModel = { + total: number +items: Array + }; + export type PagedTagResponseModel = { total: number items: Array @@ -1894,6 +1875,13 @@ memberUserNames: Array memberGroupNames: Array }; +export type PublicAccessResponseModel = { + loginDocument: ReferenceByIdModel +errorDocument: ReferenceByIdModel +members: Array +groups: Array + }; + export type PublishDocumentRequestModel = { publishSchedules: Array }; @@ -2052,6 +2040,11 @@ export type SecurityConfigurationResponseModel = { passwordConfiguration: PasswordConfigurationResponseModel }; +export type SegmentResponseModel = { + name: string +alias: string + }; + export type ServerConfigurationItemResponseModel = { name: string data: string @@ -2688,43 +2681,6 @@ id: string events: Array }; -export type AuditLogData = { - - payloads: { - GetAuditLog: { - orderDirection?: DirectionModel -sinceDate?: string -skip?: number -take?: number - - }; -GetAuditLogById: { - id: string -orderDirection?: DirectionModel -sinceDate?: string -skip?: number -take?: number - - }; -GetAuditLogTypeByLogType: { - logType: AuditTypeModel -sinceDate?: string -skip?: number -take?: number - - }; - } - - - responses: { - GetAuditLog: PagedAuditLogWithUsernameResponseModel - ,GetAuditLogById: PagedAuditLogResponseModel - ,GetAuditLogTypeByLogType: PagedAuditLogResponseModel - - } - - } - export type CultureData = { payloads: { @@ -3227,6 +3183,14 @@ PutDocumentById: { id: string requestBody?: UpdateDocumentRequestModel + }; +GetDocumentByIdAuditLog: { + id: string +orderDirection?: DirectionModel +sinceDate?: string +skip?: number +take?: number + }; PostDocumentByIdCopy: { id: string @@ -3388,6 +3352,7 @@ take?: number ,GetDocumentById: DocumentResponseModel ,DeleteDocumentById: string ,PutDocumentById: string + ,GetDocumentByIdAuditLog: PagedAuditLogResponseModel ,PostDocumentByIdCopy: string ,GetDocumentByIdDomains: DomainsResponseModel ,PutDocumentByIdDomains: string @@ -3397,7 +3362,7 @@ take?: number ,PutDocumentByIdNotifications: string ,PostDocumentByIdPublicAccess: string ,DeleteDocumentByIdPublicAccess: string - ,GetDocumentByIdPublicAccess: void + ,GetDocumentByIdPublicAccess: PublicAccessResponseModel ,PutDocumentByIdPublicAccess: string ,PutDocumentByIdPublish: string ,PutDocumentByIdPublishWithDescendants: string @@ -3583,6 +3548,7 @@ requestBody?: UpdateLanguageRequestModel responses: { GetItemLanguage: Array + ,GetItemLanguageDefault: LanguageItemResponseModel ,GetLanguage: PagedLanguageResponseModel ,PostLanguage: string ,GetLanguageByIsoCode: LanguageResponseModel @@ -3835,6 +3801,14 @@ PutMediaById: { id: string requestBody?: UpdateMediaRequestModel + }; +GetMediaByIdAuditLog: { + id: string +orderDirection?: DirectionModel +sinceDate?: string +skip?: number +take?: number + }; PutMediaByIdMove: { id: string @@ -3932,6 +3906,7 @@ take?: number ,GetMediaById: MediaResponseModel ,DeleteMediaById: string ,PutMediaById: string + ,GetMediaByIdAuditLog: PagedAuditLogResponseModel ,PutMediaByIdMove: string ,PutMediaByIdMoveToRecycleBin: string ,GetMediaByIdReferencedBy: PagedIReferenceResponseModel @@ -3996,10 +3971,10 @@ take?: number responses: { GetItemMemberGroup: Array ,GetMemberGroup: PagedMemberGroupResponseModel - ,PostMemberGroup: MemberGroupResponseModel + ,PostMemberGroup: string ,GetMemberGroupById: MemberGroupResponseModel ,DeleteMemberGroupById: string - ,PutMemberGroupById: MemberGroupResponseModel + ,PutMemberGroupById: string ,GetTreeMemberGroupRoot: PagedNamedEntityTreeItemResponseModel } @@ -4591,6 +4566,24 @@ PostSecurityForgotPasswordVerify: { } +export type SegmentData = { + + payloads: { + GetSegment: { + skip?: number +take?: number + + }; + } + + + responses: { + GetSegment: PagedSegmentResponseModel + + } + + } + export type ServerData = { @@ -4879,10 +4872,6 @@ export type UserDataData = { PostUserData: { requestBody?: CreateUserDataRequestModel - }; -PutUserData: { - requestBody?: UpdateUserDataRequestModel - }; GetUserData: { groups?: Array @@ -4890,6 +4879,10 @@ identifiers?: Array skip?: number take?: number + }; +PutUserData: { + requestBody?: UpdateUserDataRequestModel + }; GetUserDataById: { id: string @@ -4900,8 +4893,8 @@ GetUserDataById: { responses: { PostUserData: string - ,PutUserData: string ,GetUserData: PagedUserDataResponseModel + ,PutUserData: string ,GetUserDataById: UserDataModel } @@ -5152,7 +5145,11 @@ PostUserUnlock: { export type WebhookData = { payloads: { - GetWebhook: { + GetItemWebhook: { + id?: Array + + }; +GetWebhook: { skip?: number take?: number @@ -5173,21 +5170,17 @@ requestBody?: UpdateWebhookRequestModel DeleteWebhookById: { id: string - }; -GetWebhookItem: { - ids?: Array - }; } responses: { - GetWebhook: PagedWebhookResponseModel + GetItemWebhook: Array + ,GetWebhook: PagedWebhookResponseModel ,PostWebhook: string ,GetWebhookById: WebhookResponseModel ,PutWebhookById: string ,DeleteWebhookById: string - ,GetWebhookItem: Array } diff --git a/src/Umbraco.Web.UI.Client/src/external/backend-api/src/services.ts b/src/Umbraco.Web.UI.Client/src/external/backend-api/src/services.ts index b00b6aad71..e50c387513 100644 --- a/src/Umbraco.Web.UI.Client/src/external/backend-api/src/services.ts +++ b/src/Umbraco.Web.UI.Client/src/external/backend-api/src/services.ts @@ -1,91 +1,7 @@ import type { CancelablePromise } from './core/CancelablePromise'; import { OpenAPI } from './core/OpenAPI'; import { request as __request } from './core/request'; -import type { AuditLogData, CultureData, DataTypeData, DictionaryData, DocumentBlueprintData, DocumentTypeData, DocumentVersionData, DocumentData, DynamicRootData, HealthCheckData, HelpData, IndexerData, InstallData, LanguageData, LogViewerData, ManifestData, MediaTypeData, MediaData, MemberGroupData, MemberTypeData, MemberData, ModelsBuilderData, ObjectTypesData, PackageData, PartialViewData, PreviewData, ProfilingData, PropertyTypeData, PublishedCacheData, RedirectManagementData, RelationTypeData, RelationData, ScriptData, SearcherData, SecurityData, ServerData, StaticFileData, StylesheetData, TagData, TelemetryData, TemplateData, TemporaryFileData, UpgradeData, UserDataData, UserGroupData, UserData, WebhookData } from './models'; - -export class AuditLogService { - - /** - * @returns unknown Success - * @throws ApiError - */ - public static getAuditLog(data: AuditLogData['payloads']['GetAuditLog'] = {}): CancelablePromise { - const { - - orderDirection, -sinceDate, -skip, -take - } = data; - return __request(OpenAPI, { - method: 'GET', - url: '/umbraco/management/api/v1/audit-log', - query: { - orderDirection, sinceDate, skip, take - }, - errors: { - 401: `The resource is protected and requires an authentication token`, - }, - }); - } - - /** - * @returns unknown Success - * @throws ApiError - */ - public static getAuditLogById(data: AuditLogData['payloads']['GetAuditLogById']): CancelablePromise { - const { - - id, -orderDirection, -sinceDate, -skip, -take - } = data; - return __request(OpenAPI, { - method: 'GET', - url: '/umbraco/management/api/v1/audit-log/{id}', - path: { - id - }, - query: { - orderDirection, sinceDate, skip, take - }, - errors: { - 401: `The resource is protected and requires an authentication token`, - 403: `The authenticated user do not have access to this resource`, - }, - }); - } - - /** - * @returns unknown Success - * @throws ApiError - */ - public static getAuditLogTypeByLogType(data: AuditLogData['payloads']['GetAuditLogTypeByLogType']): CancelablePromise { - const { - - logType, -sinceDate, -skip, -take - } = data; - return __request(OpenAPI, { - method: 'GET', - url: '/umbraco/management/api/v1/audit-log/type/{logType}', - path: { - logType - }, - query: { - sinceDate, skip, take - }, - errors: { - 401: `The resource is protected and requires an authentication token`, - }, - }); - } - -} +import type { CultureData, DataTypeData, DictionaryData, DocumentBlueprintData, DocumentTypeData, DocumentVersionData, DocumentData, DynamicRootData, HealthCheckData, HelpData, IndexerData, InstallData, LanguageData, LogViewerData, ManifestData, MediaTypeData, MediaData, MemberGroupData, MemberTypeData, MemberData, ModelsBuilderData, ObjectTypesData, PackageData, PartialViewData, PreviewData, ProfilingData, PropertyTypeData, PublishedCacheData, RedirectManagementData, RelationTypeData, RelationData, ScriptData, SearcherData, SecurityData, SegmentData, ServerData, StaticFileData, StylesheetData, TagData, TelemetryData, TemplateData, TemporaryFileData, UpgradeData, UserDataData, UserGroupData, UserData, WebhookData } from './models'; export class CultureService { @@ -1987,6 +1903,35 @@ requestBody }); } + /** + * @returns unknown Success + * @throws ApiError + */ + public static getDocumentByIdAuditLog(data: DocumentData['payloads']['GetDocumentByIdAuditLog']): CancelablePromise { + const { + + id, +orderDirection, +sinceDate, +skip, +take + } = data; + return __request(OpenAPI, { + method: 'GET', + url: '/umbraco/management/api/v1/document/{id}/audit-log', + path: { + id + }, + query: { + orderDirection, sinceDate, skip, take + }, + errors: { + 401: `The resource is protected and requires an authentication token`, + 403: `The authenticated user do not have access to this resource`, + }, + }); + } + /** * @returns string Created * @throws ApiError @@ -2220,6 +2165,7 @@ requestBody } /** + * @returns unknown Success * @throws ApiError */ public static getDocumentByIdPublicAccess(data: DocumentData['payloads']['GetDocumentByIdPublicAccess']): CancelablePromise { @@ -3129,6 +3075,22 @@ export class LanguageService { }); } + /** + * @returns unknown Success + * @throws ApiError + */ + public static getItemLanguageDefault(): CancelablePromise { + + return __request(OpenAPI, { + method: 'GET', + url: '/umbraco/management/api/v1/item/language/default', + errors: { + 401: `The resource is protected and requires an authentication token`, + 403: `The authenticated user do not have access to this resource`, + }, + }); + } + /** * @returns unknown Success * @throws ApiError @@ -4172,6 +4134,35 @@ requestBody }); } + /** + * @returns unknown Success + * @throws ApiError + */ + public static getMediaByIdAuditLog(data: MediaData['payloads']['GetMediaByIdAuditLog']): CancelablePromise { + const { + + id, +orderDirection, +sinceDate, +skip, +take + } = data; + return __request(OpenAPI, { + method: 'GET', + url: '/umbraco/management/api/v1/media/{id}/audit-log', + path: { + id + }, + query: { + orderDirection, sinceDate, skip, take + }, + errors: { + 401: `The resource is protected and requires an authentication token`, + 403: `The authenticated user do not have access to this resource`, + }, + }); + } + /** * @returns string Success * @throws ApiError @@ -4679,7 +4670,7 @@ take } /** - * @returns unknown Success + * @returns string Created * @throws ApiError */ public static postMemberGroup(data: MemberGroupData['payloads']['PostMemberGroup'] = {}): CancelablePromise { @@ -4692,6 +4683,7 @@ take url: '/umbraco/management/api/v1/member-group', body: requestBody, mediaType: 'application/json', + responseHeader: 'Umb-Generated-Resource', errors: { 400: `Bad Request`, 401: `The resource is protected and requires an authentication token`, @@ -4749,7 +4741,7 @@ take } /** - * @returns unknown Success + * @returns string Success * @throws ApiError */ public static putMemberGroupById(data: MemberGroupData['payloads']['PutMemberGroupById']): CancelablePromise { @@ -4766,6 +4758,7 @@ requestBody }, body: requestBody, mediaType: 'application/json', + responseHeader: 'Umb-Notifications', errors: { 400: `Bad Request`, 401: `The resource is protected and requires an authentication token`, @@ -6756,6 +6749,34 @@ export class SecurityService { } +export class SegmentService { + + /** + * @returns unknown Success + * @throws ApiError + */ + public static getSegment(data: SegmentData['payloads']['GetSegment'] = {}): CancelablePromise { + const { + + skip, +take + } = data; + return __request(OpenAPI, { + method: 'GET', + url: '/umbraco/management/api/v1/segment', + query: { + skip, take + }, + errors: { + 400: `Bad Request`, + 401: `The resource is protected and requires an authentication token`, + 403: `The authenticated user do not have access to this resource`, + }, + }); + } + +} + export class ServerService { /** @@ -7726,29 +7747,6 @@ export class UserDataService { }); } - /** - * @returns string Success - * @throws ApiError - */ - public static putUserData(data: UserDataData['payloads']['PutUserData'] = {}): CancelablePromise { - const { - - requestBody - } = data; - return __request(OpenAPI, { - method: 'PUT', - url: '/umbraco/management/api/v1/user-data', - body: requestBody, - mediaType: 'application/json', - responseHeader: 'Umb-Notifications', - errors: { - 400: `Bad Request`, - 401: `The resource is protected and requires an authentication token`, - 404: `Not Found`, - }, - }); - } - /** * @returns unknown Success * @throws ApiError @@ -7773,6 +7771,29 @@ take }); } + /** + * @returns string Success + * @throws ApiError + */ + public static putUserData(data: UserDataData['payloads']['PutUserData'] = {}): CancelablePromise { + const { + + requestBody + } = data; + return __request(OpenAPI, { + method: 'PUT', + url: '/umbraco/management/api/v1/user-data', + body: requestBody, + mediaType: 'application/json', + responseHeader: 'Umb-Notifications', + errors: { + 400: `Bad Request`, + 401: `The resource is protected and requires an authentication token`, + 404: `Not Found`, + }, + }); + } + /** * @returns unknown Success * @throws ApiError @@ -8829,6 +8850,28 @@ requestBody export class WebhookService { + /** + * @returns unknown Success + * @throws ApiError + */ + public static getItemWebhook(data: WebhookData['payloads']['GetItemWebhook'] = {}): CancelablePromise { + const { + + id + } = data; + return __request(OpenAPI, { + method: 'GET', + url: '/umbraco/management/api/v1/item/webhook', + query: { + id + }, + errors: { + 401: `The resource is protected and requires an authentication token`, + 403: `The authenticated user do not have access to this resource`, + }, + }); + } + /** * @returns unknown Success * @throws ApiError @@ -8950,26 +8993,4 @@ requestBody }); } - /** - * @returns unknown Success - * @throws ApiError - */ - public static getWebhookItem(data: WebhookData['payloads']['GetWebhookItem'] = {}): CancelablePromise { - const { - - ids - } = data; - return __request(OpenAPI, { - method: 'GET', - url: '/umbraco/management/api/v1/webhook/item', - query: { - ids - }, - errors: { - 401: `The resource is protected and requires an authentication token`, - 403: `The authenticated user do not have access to this resource`, - }, - }); - } - } \ No newline at end of file