@resolution/jira-api-client 0.4.5 → 0.4.6

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.4.6](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.4.5...v0.4.6) (2024-06-14)
+
+
+### Bug Fixes
+
+* use more optimized / lightweight api client version ([8c628d3](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/8c628d3c80ca6c89572eb003ae6f7cb5c634b4d5))
+
+
+
+
+
 ## [0.4.5](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.4.4...v0.4.5) (2024-06-14)
 
 

package/README.md

@@ -126,6 +126,66 @@ export const handler = async ({ payload }) => {
 };
 ```
 
+### Impersonalization
+
+When using API on the server side, you can impersonalize the API client.
+This is useful when you need to access API resources on behalf of a different user or app.
+
+### `atlassian-connect-express`
+
+By default, `atlassian-connect-express` makes requests on behalf of the app.
+To impersonalize the API client, you need to provide the `userAccountId` to the API client:
+
+```typescript
+// ...
+app.get('/sprint-issues/:sprintId', async () => {
+  const jiraSoftwareApi = new JiraSoftwareApi({
+    ace,
+    clientKey: req.context.clientKey,
+    userAccountId: req.context.userAccountId
+  });
+  res.status(200).send(await jiraSoftwareApi.sprint.getIssuesForSprint({
+    sprintId: 1
+  }));
+});
+// ...
+```
+
+This can also be achieved by calling `asUser` method on the API client:
+
+```typescript
+const jiraSoftwareApi = new JiraSoftwareApi({
+  ace,
+  clientKey: req.context.clientKey
+});
+const issues = await jiraSoftwareApi.sprint.getIssuesForSprint({
+  sprintId: 1
+});
+```
+
+### `@forge/api`
+
+By default, `@forge/api` makes requests on behalf of the current user.
+To perform requests on behalf of the app, you need to provide the `asApp` to the API client:
+
+```typescript
+// ...
+export const handler = async ({ payload }) => {
+  const jiraSoftwareApi = new JiraSoftwareApi({
+    forgeApi,
+    asApp: true
+  });
+  return await jiraSoftwareApi.sprint.getIssuesForSprint({ sprintId: 1 });
+};
+```
+
+This can also be achieved by calling `asApp` method on the API client:
+
+```typescript
+const jiraSoftwareApi = new JiraSoftwareApi({ forgeApi });
+const issues = await jiraSoftwareApi.sprint.getIssuesForSprint({ sprintId: 1 });
+```
+
 ## References
 
  * [Jira Platform API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/)