@resolution/jira-api-client 0.4.2 → 0.4.5

package/lib/openapi/platform/services/AvatarsService.d.ts

@@ -24,14 +24,14 @@ export declare class AvatarsService extends CommonHttpService {
      * @scopes-beta delete:avatar:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars#api-rest-api-3-universal-avatar-type-type-owner-owningobjectid-avatar-id-delete
      */
-    deleteAvatar({ type, owningObjectId, id, }: {
+    deleteAvatar: ({ type, owningObjectId, id, }: {
         /** The avatar type. */
         type: "project" | "issuetype";
         /** The ID of the item the avatar is associated with. */
         owningObjectId: string;
         /** The ID of the avatar. */
         id: number;
-    }): Promise<void>;
+    }) => Promise<void>;
     /**
      * Returns a list of system avatar details by owner type, where the owner types
      * are issue type, project, or user.
@@ -66,10 +66,10 @@ export declare class AvatarsService extends CommonHttpService {
      * @scopes-beta read:avatar:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars#api-rest-api-3-avatar-type-system-get
      */
-    getAllSystemAvatars({ type, }: {
+    getAllSystemAvatars: ({ type, }: {
         /** The avatar type. */
         type: "issuetype" | "project" | "user";
-    }): Promise<SystemAvatars>;
+    }) => Promise<SystemAvatars>;
     /**
      * Returns a project or issue type avatar image by ID.
      *
@@ -105,19 +105,19 @@ export declare class AvatarsService extends CommonHttpService {
      * @scopes-beta read:avatar:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars#api-rest-api-3-universal-avatar-view-type-type-avatar-id-get
      */
-    getAvatarImageById({ type, id, size, format, }: {
+    getAvatarImageById: ({ type, id, size, format, }: {
         /** The icon type of the avatar. */
         type: "issuetype" | "project";
         /** The ID of the avatar. */
         id: number;
         /** The size of the avatar image. If not provided the default size is returned. */
-        size?: "xsmall" | "small" | "medium" | "large" | "xlarge";
+        size?: "small" | "medium" | "xsmall" | "large" | "xlarge" | undefined;
         /**
          * The format to return the avatar image in. If not provided the original content
          * format is returned.
          */
-        format?: "png" | "svg";
-    }): Promise<commonHttpClient.WithResponse<{
+        format?: "svg" | "png" | undefined;
+    }) => Promise<commonHttpClient.WithResponse<{
         status: 200;
         mediaType: "*/*" | "image/png" | "image/svg+xml";
         body: Blob;
@@ -161,19 +161,19 @@ export declare class AvatarsService extends CommonHttpService {
      * @scopes-beta read:avatar:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars#api-rest-api-3-universal-avatar-view-type-type-owner-entityid-get
      */
-    getAvatarImageByOwner({ type, entityId, size, format, }: {
+    getAvatarImageByOwner: ({ type, entityId, size, format, }: {
         /** The icon type of the avatar. */
         type: "issuetype" | "project";
         /** The ID of the project or issue type the avatar belongs to. */
         entityId: string;
         /** The size of the avatar image. If not provided the default size is returned. */
-        size?: "xsmall" | "small" | "medium" | "large" | "xlarge";
+        size?: "small" | "medium" | "xsmall" | "large" | "xlarge" | undefined;
         /**
          * The format to return the avatar image in. If not provided the original content
          * format is returned.
          */
-        format?: "png" | "svg";
-    }): Promise<commonHttpClient.WithResponse<{
+        format?: "svg" | "png" | undefined;
+    }) => Promise<commonHttpClient.WithResponse<{
         status: 200;
         mediaType: "*/*" | "image/png" | "image/svg+xml";
         body: Blob;
@@ -209,17 +209,17 @@ export declare class AvatarsService extends CommonHttpService {
      * @scopes-beta read:avatar:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars#api-rest-api-3-universal-avatar-view-type-type-get
      */
-    getAvatarImageByType({ type, size, format, }: {
+    getAvatarImageByType: ({ type, size, format, }: {
         /** The icon type of the avatar. */
         type: "issuetype" | "project";
         /** The size of the avatar image. If not provided the default size is returned. */
-        size?: "xsmall" | "small" | "medium" | "large" | "xlarge";
+        size?: "small" | "medium" | "xsmall" | "large" | "xlarge" | undefined;
         /**
          * The format to return the avatar image in. If not provided the original content
          * format is returned.
          */
-        format?: "png" | "svg";
-    }): Promise<commonHttpClient.WithResponse<{
+        format?: "svg" | "png" | undefined;
+    }) => Promise<commonHttpClient.WithResponse<{
         status: 200;
         mediaType: "*/*" | "image/png" | "image/svg+xml";
         body: Blob;
@@ -288,12 +288,12 @@ export declare class AvatarsService extends CommonHttpService {
      * @scopes-beta read:avatar:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars#api-rest-api-3-universal-avatar-type-type-owner-entityid-get
      */
-    getAvatars({ type, entityId, }: {
+    getAvatars: ({ type, entityId, }: {
         /** The avatar type. */
         type: "project" | "issuetype";
         /** The ID of the item the avatar is associated with. */
         entityId: string;
-    }): Promise<Avatars>;
+    }) => Promise<Avatars>;
     /**
      * Loads a custom avatar for a project or issue type.
      *
@@ -338,35 +338,29 @@ export declare class AvatarsService extends CommonHttpService {
      * @returns Returned if the request is successful.
      *
      * example: {
-     *   "id": "1000",
-     *   "isDeletable": false,
+     *   "id": "1010",
+     *   "isDeletable": true,
      *   "isSelected": false,
-     *   "isSystemAvatar": true,
-     *   "urls": {
-     *     "16x16": "/secure/useravatar?size=xsmall&avatarId=10040&avatarType=project",
-     *     "24x24": "/secure/useravatar?size=small&avatarId=10040&avatarType=project",
-     *     "32x32": "/secure/useravatar?size=medium&avatarId=10040&avatarType=project",
-     *     "48x48": "/secure/useravatar?avatarId=10040&avatarType=project"
-     *   }
+     *   "isSystemAvatar": false
      * }
      * @path {POST} /rest/api/3/universal_avatar/type/{type}/owner/{entityId}
      * @scopes-current manage:jira-configuration
      * @scopes-beta write:avatar:jira, read:avatar:jira
      * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-avatars#api-rest-api-3-universal-avatar-type-type-owner-entityid-post
      */
-    storeAvatar({ type, entityId, x, y, size, mediaType, requestBody, }: {
+    storeAvatar: ({ type, entityId, x, y, size, mediaType, requestBody, }: {
         /** The avatar type. */
         type: "project" | "issuetype";
         /** The ID of the item the avatar is associated with. */
         entityId: string;
         /** The X coordinate of the top-left corner of the crop region. */
-        x?: number;
+        x?: number | undefined;
         /** The Y coordinate of the top-left corner of the crop region. */
-        y?: number;
+        y?: number | undefined;
         /** The length of each side of the crop region. */
         size: number;
         mediaType: string;
         requestBody: Blob | Stream;
-    }): Promise<Avatar>;
+    }) => Promise<Avatar>;
     static initialize(): void;
 }