@qlik/api 1.28.0 → 1.29.0

package/spaces.d.ts

@@ -4,7 +4,7 @@ import './auth-types-PkN9CAF_.js';
 /**
  * The supported actions for user-created spaces.
  */
-type ActionName = "change_owner" | "create" | "read" | "update" | "delete" | "publish";
+type ActionName = "change_owner" | "create" | "read" | "update" | "delete" | "publish" | "link_environment";
 type Assignment = {
     /** The userId or groupId based on the type. */
     assigneeId: string;
@@ -58,32 +58,6 @@ type Assignments = {
         count: number;
     };
 };
-/**
- * An Environment is an environment context simplifying the grouping of spaces into environments by allowing users to control it on the environment instead of on the spaces themselves.
- */
-type Environment = {
-    /** The date and time when the environment was created. */
-    readonly createdAt?: string;
-    /** The ID of the user who created the environment. */
-    readonly createdBy?: string;
-    /** The description of the environment. */
-    description?: string;
-    /** A unique identifier for the environment, for example, 62716f4b39b865ece543cd45. */
-    readonly id: string;
-    readonly links: {
-        self: Link;
-    };
-    /** The name of the environment. */
-    name: string;
-    /** The ID for the environment owner. */
-    readonly ownerId?: string;
-    /** The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct. */
-    readonly tenantId: string;
-    /** The date and time when the environment was updated. */
-    readonly updatedAt?: string;
-    /** The name of the environment. */
-    variables?: Variable[];
-};
 /**
  * An error object.
  */
@@ -140,10 +114,78 @@ type Link = {
  * - Data: consumer, dataconsumer, datapreview, facilitator, operator, producer, publisher
  */
 type RoleType = "consumer" | "contributor" | "dataconsumer" | "datapreview" | "facilitator" | "operator" | "producer" | "publisher" | "basicconsumer" | "codeveloper";
+type Share = {
+    /** The userId or groupId based on the type. */
+    assigneeId: string;
+    readonly createdAt?: string;
+    /** The ID of the user who created the share. */
+    readonly createdBy?: string;
+    /** If the share is disabled (effective ONLY for link shares). */
+    disabled?: boolean;
+    readonly id: string;
+    readonly links?: {
+        self: Link;
+        space?: Link;
+    };
+    /** The ID of the shared resource. */
+    resourceId: string;
+    /** The name of the shared resource. */
+    resourceName?: string;
+    /** The type of the shared resource. */
+    resourceType: "app";
+    /** The roles assigned to the assigneeId. */
+    roles?: ShareRoleType[];
+    readonly spaceId: string;
+    readonly tenantId: string;
+    type: ShareType;
+    readonly updatedAt?: string;
+    /** The ID of the user who updated the share. */
+    readonly updatedBy?: string;
+};
+type ShareCreate = {
+    /** The userId or groupId based on the type. */
+    assigneeId: string;
+    /** The resource id for the shared item. */
+    resourceId: string;
+    /** The resource type for the shared item. */
+    resourceType: string;
+    /** The roles assigned to the assigneeId. */
+    roles: ShareRoleType[];
+    type: ShareType;
+};
+type SharePatch = {
+    /** The operation to be performed. */
+    op: "replace";
+    /** Field of Share to be patched (updated). */
+    path: "/roles" | "/disabled";
+    /** The value to be used within the operations.
+     * - roles: The roles assigned to the assigneeId.
+     * - disabled: To disable the share (effective ONLY for link shares). */
+    value: string;
+}[];
+/**
+ * Supported roles by space type:
+ * - Shared: consumer
+ * - Managed: consumer, contributor
+ */
+type ShareRoleType = unknown;
+type ShareType = "user" | "group" | "link";
 /**
  * The supported roles for Shared spaces.
  */
 type SharedSpaceRoleType = "facilitator" | "consumer" | "producer" | "dataconsumer" | "codeveloper";
+type Shares = {
+    data?: Share[];
+    readonly links?: {
+        next?: Link;
+        prev?: Link;
+        self: Link;
+    };
+    readonly meta?: {
+        /** The total number of Shares matching the current filter. */
+        count: number;
+    };
+};
 /**
  * A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
  */
@@ -154,8 +196,6 @@ type Space = {
     readonly createdBy?: string;
     /** The description of the space. Personal spaces do not have a description. */
     description?: string;
-    /** An Environment is an environment context simplifying the grouping of spaces into environments by allowing users to control it on the environment instead of on the spaces themselves. */
-    environment?: Environment;
     /** A unique identifier for the space, for example, 62716f4b39b865ece543cd45. */
     readonly id: string;
     readonly links: {
@@ -238,12 +278,6 @@ type Spaces = {
         };
     };
 };
-type Variable = {
-    /** The Key */
-    readonly key?: string;
-    /** The value. */
-    readonly value?: string;
-};
 /**
  * Retrieves spaces that the current user has access to and match the query.
  *
@@ -316,7 +350,7 @@ type GetSpaceTypesHttpError = {
     status: 401 | 500;
 };
 /**
- * Deletes a space.
+ * Deletes a space. Ensure that you first delete all resources from the space to avoid orphaning content.
  *
  * @param spaceId The ID of the space to delete.
  * @throws DeleteSpaceHttpError
@@ -489,6 +523,118 @@ type UpdateSpaceAssignmentHttpError = {
     headers: Headers;
     status: 401 | 403 | 404 | 500;
 };
+/**
+ * Retrieves the shares of the space matching the query.
+ *
+ * @param spaceId The ID of the space containing the shares.
+ * @param query an object with query parameters
+ * @throws GetSpaceSharesHttpError
+ */
+declare const getSpaceShares: (spaceId: string, query: {
+    /** The ID of the group to which the resource is shared. */
+    groupId?: string;
+    /** Maximum number of shares to return. */
+    limit?: number;
+    /** The name of the shared resource. */
+    name?: string;
+    /** The next page cursor. Next links make use of this. */
+    next?: string;
+    /** The previous page cursor. Previous links make use of this. */
+    prev?: string;
+    /** The ID of the shared resource. */
+    resourceId?: string;
+    /** The type of the shared resource. */
+    resourceType?: string;
+    /** The type of share. `user` shares assign to a specific user, `group` shares assign to a specific group, and `link` shares provide anonymous access to a resource. */
+    type?: ShareType;
+    /** The ID of the user to which the resource is shared. */
+    userId?: string;
+}, options?: ApiCallOptions) => Promise<GetSpaceSharesHttpResponse>;
+type GetSpaceSharesHttpResponse = {
+    data: Shares;
+    headers: Headers;
+    status: 200;
+    prev?: (options?: ApiCallOptions) => Promise<GetSpaceSharesHttpResponse>;
+    next?: (options?: ApiCallOptions) => Promise<GetSpaceSharesHttpResponse>;
+};
+type GetSpaceSharesHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: 401 | 403 | 404 | 500;
+};
+/**
+ * Create a space share
+ *
+ * @param spaceId The ID of the space of the share.
+ * @param body an object with the body content
+ * @throws CreateSpaceShareHttpError
+ */
+declare const createSpaceShare: (spaceId: string, body: ShareCreate, options?: ApiCallOptions) => Promise<CreateSpaceShareHttpResponse>;
+type CreateSpaceShareHttpResponse = {
+    data: Share;
+    headers: Headers;
+    status: 201;
+};
+type CreateSpaceShareHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: 401 | 403 | 404 | 409 | 500;
+};
+/**
+ * Deletes a space share.
+ *
+ * @param spaceId The ID of the space to which the share belongs.
+ * @param shareId The ID of the share to delete.
+ * @throws DeleteSpaceShareHttpError
+ */
+declare const deleteSpaceShare: (spaceId: string, shareId: string, options?: ApiCallOptions) => Promise<DeleteSpaceShareHttpResponse>;
+type DeleteSpaceShareHttpResponse = {
+    data: void;
+    headers: Headers;
+    status: 204;
+};
+type DeleteSpaceShareHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: 401 | 403 | 404 | 500;
+};
+/**
+ * Retrieves a single space share by ID.
+ *
+ * @param spaceId The ID of the space to which the share belongs.
+ * @param shareId The ID of the share to retrieve.
+ * @throws GetSpaceShareHttpError
+ */
+declare const getSpaceShare: (spaceId: string, shareId: string, options?: ApiCallOptions) => Promise<GetSpaceShareHttpResponse>;
+type GetSpaceShareHttpResponse = {
+    data: Share;
+    headers: Headers;
+    status: 200;
+};
+type GetSpaceShareHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: 401 | 403 | 404 | 500;
+};
+/**
+ * Updates properties of a space share (roles, and disabled state for link shares).
+ *
+ * @param spaceId The ID of the space to which the share belongs.
+ * @param shareId The ID of the share to update.
+ * @param body an object with the body content
+ * @throws PatchShareHttpError
+ */
+declare const patchShare: (spaceId: string, shareId: string, body: SharePatch, options?: ApiCallOptions) => Promise<PatchShareHttpResponse>;
+type PatchShareHttpResponse = {
+    data: Share;
+    headers: Headers;
+    status: 200;
+};
+type PatchShareHttpError = {
+    data: Errors;
+    headers: Headers;
+    status: 401 | 403 | 404 | 500;
+};
 /**
  * Clears the cache for spaces api requests.
  */
@@ -515,7 +661,7 @@ interface SpacesAPI {
      */
     getSpaceTypes: typeof getSpaceTypes;
     /**
-     * Deletes a space.
+     * Deletes a space. Ensure that you first delete all resources from the space to avoid orphaning content.
      *
      * @param spaceId The ID of the space to delete.
      * @throws DeleteSpaceHttpError
@@ -585,6 +731,47 @@ interface SpacesAPI {
      * @throws UpdateSpaceAssignmentHttpError
      */
     updateSpaceAssignment: typeof updateSpaceAssignment;
+    /**
+     * Retrieves the shares of the space matching the query.
+     *
+     * @param spaceId The ID of the space containing the shares.
+     * @param query an object with query parameters
+     * @throws GetSpaceSharesHttpError
+     */
+    getSpaceShares: typeof getSpaceShares;
+    /**
+     * Create a space share
+     *
+     * @param spaceId The ID of the space of the share.
+     * @param body an object with the body content
+     * @throws CreateSpaceShareHttpError
+     */
+    createSpaceShare: typeof createSpaceShare;
+    /**
+     * Deletes a space share.
+     *
+     * @param spaceId The ID of the space to which the share belongs.
+     * @param shareId The ID of the share to delete.
+     * @throws DeleteSpaceShareHttpError
+     */
+    deleteSpaceShare: typeof deleteSpaceShare;
+    /**
+     * Retrieves a single space share by ID.
+     *
+     * @param spaceId The ID of the space to which the share belongs.
+     * @param shareId The ID of the share to retrieve.
+     * @throws GetSpaceShareHttpError
+     */
+    getSpaceShare: typeof getSpaceShare;
+    /**
+     * Updates properties of a space share (roles, and disabled state for link shares).
+     *
+     * @param spaceId The ID of the space to which the share belongs.
+     * @param shareId The ID of the share to update.
+     * @param body an object with the body content
+     * @throws PatchShareHttpError
+     */
+    patchShare: typeof patchShare;
     /**
      * Clears the cache for spaces api requests.
      */
@@ -595,4 +782,4 @@ interface SpacesAPI {
  */
 declare const spacesExport: SpacesAPI;
 
-export { type ActionName, type Assignment, type AssignmentCreate, type AssignmentType, type AssignmentUpdate, type Assignments, type CreateSpaceAssignmentHttpError, type CreateSpaceAssignmentHttpResponse, type CreateSpaceHttpError, type CreateSpaceHttpResponse, type DeleteSpaceAssignmentHttpError, type DeleteSpaceAssignmentHttpResponse, type DeleteSpaceHttpError, type DeleteSpaceHttpResponse, type Environment, type Error, type Errors, type GetSpaceAssignmentHttpError, type GetSpaceAssignmentHttpResponse, type GetSpaceAssignmentsHttpError, type GetSpaceAssignmentsHttpResponse, type GetSpaceHttpError, type GetSpaceHttpResponse, type GetSpaceTypesHttpError, type GetSpaceTypesHttpResponse, type GetSpacesHttpError, type GetSpacesHttpResponse, type Link, type PatchSpaceHttpError, type PatchSpaceHttpResponse, type RoleType, type SharedSpaceRoleType, type Space, type SpaceCreate, type SpacePatch, type SpaceType, type SpaceTypes, type SpaceUpdate, type Spaces, type SpacesAPI, type UpdateSpaceAssignmentHttpError, type UpdateSpaceAssignmentHttpResponse, type UpdateSpaceHttpError, type UpdateSpaceHttpResponse, type Variable, clearCache, createSpace, createSpaceAssignment, spacesExport as default, deleteSpace, deleteSpaceAssignment, getSpace, getSpaceAssignment, getSpaceAssignments, getSpaceTypes, getSpaces, patchSpace, updateSpace, updateSpaceAssignment };
+export { type ActionName, type Assignment, type AssignmentCreate, type AssignmentType, type AssignmentUpdate, type Assignments, type CreateSpaceAssignmentHttpError, type CreateSpaceAssignmentHttpResponse, type CreateSpaceHttpError, type CreateSpaceHttpResponse, type CreateSpaceShareHttpError, type CreateSpaceShareHttpResponse, type DeleteSpaceAssignmentHttpError, type DeleteSpaceAssignmentHttpResponse, type DeleteSpaceHttpError, type DeleteSpaceHttpResponse, type DeleteSpaceShareHttpError, type DeleteSpaceShareHttpResponse, type Error, type Errors, type GetSpaceAssignmentHttpError, type GetSpaceAssignmentHttpResponse, type GetSpaceAssignmentsHttpError, type GetSpaceAssignmentsHttpResponse, type GetSpaceHttpError, type GetSpaceHttpResponse, type GetSpaceShareHttpError, type GetSpaceShareHttpResponse, type GetSpaceSharesHttpError, type GetSpaceSharesHttpResponse, type GetSpaceTypesHttpError, type GetSpaceTypesHttpResponse, type GetSpacesHttpError, type GetSpacesHttpResponse, type Link, type PatchShareHttpError, type PatchShareHttpResponse, type PatchSpaceHttpError, type PatchSpaceHttpResponse, type RoleType, type Share, type ShareCreate, type SharePatch, type ShareRoleType, type ShareType, type SharedSpaceRoleType, type Shares, type Space, type SpaceCreate, type SpacePatch, type SpaceType, type SpaceTypes, type SpaceUpdate, type Spaces, type SpacesAPI, type UpdateSpaceAssignmentHttpError, type UpdateSpaceAssignmentHttpResponse, type UpdateSpaceHttpError, type UpdateSpaceHttpResponse, clearCache, createSpace, createSpaceAssignment, createSpaceShare, spacesExport as default, deleteSpace, deleteSpaceAssignment, deleteSpaceShare, getSpace, getSpaceAssignment, getSpaceAssignments, getSpaceShare, getSpaceShares, getSpaceTypes, getSpaces, patchShare, patchSpace, updateSpace, updateSpaceAssignment };

package/spaces.js

@@ -87,6 +87,41 @@ var updateSpaceAssignment = async (spaceId, assignmentId, body, options) => invo
   contentType: "application/json",
   options
 });
+var getSpaceShares = async (spaceId, query, options) => invokeFetch("spaces", {
+  method: "get",
+  pathTemplate: "/api/v1/spaces/{spaceId}/shares",
+  pathVariables: { spaceId },
+  query,
+  options
+});
+var createSpaceShare = async (spaceId, body, options) => invokeFetch("spaces", {
+  method: "post",
+  pathTemplate: "/api/v1/spaces/{spaceId}/shares",
+  pathVariables: { spaceId },
+  body,
+  contentType: "application/json",
+  options
+});
+var deleteSpaceShare = async (spaceId, shareId, options) => invokeFetch("spaces", {
+  method: "delete",
+  pathTemplate: "/api/v1/spaces/{spaceId}/shares/{shareId}",
+  pathVariables: { spaceId, shareId },
+  options
+});
+var getSpaceShare = async (spaceId, shareId, options) => invokeFetch("spaces", {
+  method: "get",
+  pathTemplate: "/api/v1/spaces/{spaceId}/shares/{shareId}",
+  pathVariables: { spaceId, shareId },
+  options
+});
+var patchShare = async (spaceId, shareId, body, options) => invokeFetch("spaces", {
+  method: "patch",
+  pathTemplate: "/api/v1/spaces/{spaceId}/shares/{shareId}",
+  pathVariables: { spaceId, shareId },
+  body,
+  contentType: "application/json",
+  options
+});
 function clearCache() {
   return clearApiCache("spaces");
 }
@@ -103,6 +138,11 @@ var spacesExport = {
   deleteSpaceAssignment,
   getSpaceAssignment,
   updateSpaceAssignment,
+  getSpaceShares,
+  createSpaceShare,
+  deleteSpaceShare,
+  getSpaceShare,
+  patchShare,
   clearCache
 };
 var spaces_default = spacesExport;
@@ -110,14 +150,19 @@ export {
   clearCache,
   createSpace,
   createSpaceAssignment,
+  createSpaceShare,
   spaces_default as default,
   deleteSpace,
   deleteSpaceAssignment,
+  deleteSpaceShare,
   getSpace,
   getSpaceAssignment,
   getSpaceAssignments,
+  getSpaceShare,
+  getSpaceShares,
   getSpaceTypes,
   getSpaces,
+  patchShare,
   patchSpace,
   updateSpace,
   updateSpaceAssignment

package/tenants.d.ts

@@ -25,6 +25,16 @@ type Error = {
 };
 /**
  * The error response object describing the error from the handling of an HTTP request.
+ * @example
+ * {
+ *   errors: [
+ *     {
+ *       code: "TENANTS-8",
+ *       title: "Not found"
+ *     }
+ *   ],
+ *   traceId: "000000000000000079cf1ebeae103de1"
+ * }
  */
 type Errors = {
     /** An array of errors related to the operation. */
@@ -43,6 +53,7 @@ type Tenant = {
     /** The datacenter where the tenant is located. */
     datacenter?: string;
     enableAnalyticCreation?: boolean;
+    enableAppOpeningFeedback?: boolean;
     /** List of case insensitive hostnames that are mapped to the tenant. The first record maps to the display name and the subsequent entries are aliases. */
     hostnames?: string[];
     /** The unique tenant identifier. */
@@ -116,11 +127,46 @@ type TenantPatchErrors = {
         title: string;
     }[];
 };
+/**
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     path: "/name",
+ *     value: "Corp"
+ *   },
+ *   {
+ *     op: "replace",
+ *     path: "/hostnames/1",
+ *     value: "example-tenant.us.qlikcloud.com"
+ *   },
+ *   {
+ *     op: "replace",
+ *     path: "/autoAssignCreateSharedSpacesRoleToProfessionals",
+ *     value: true
+ *   },
+ *   {
+ *     op: "replace",
+ *     path: "/autoAssignPrivateAnalyticsContentCreatorRoleToProfessionals",
+ *     value: false
+ *   },
+ *   {
+ *     op: "replace",
+ *     path: "/autoAssignDataServicesContributorRoleToProfessionals",
+ *     value: true
+ *   },
+ *   {
+ *     op: "replace",
+ *     path: "/enableAnalyticCreation",
+ *     value: false
+ *   }
+ * ]
+ */
 type TenantPatchSchema = {
     /** The operation to be performed. */
     op: "replace";
     /** A JSON Pointer value that references a location within the target document where the operation is performed. */
-    path: "/name" | "/hostnames/1" | "/autoAssignCreateSharedSpacesRoleToProfessionals" | "/autoAssignPrivateAnalyticsContentCreatorRoleToProfessionals" | "/autoAssignDataServicesContributorRoleToProfessionals" | "/enableAnalyticCreation";
+    path: "/name" | "/hostnames/1" | "/autoAssignCreateSharedSpacesRoleToProfessionals" | "/autoAssignPrivateAnalyticsContentCreatorRoleToProfessionals" | "/autoAssignDataServicesContributorRoleToProfessionals" | "/enableAnalyticCreation" | "/enableAppOpeningFeedback";
     /** The value to be used for this operation. */
     value: string | boolean;
 }[];

package/transports.d.ts

@@ -72,6 +72,15 @@ type EmailConfigFieldPatch = {
     /** The value to be used for this operation. */
     value: string;
 };
+/**
+ * @example
+ * [
+ *   {
+ *     path: "/username",
+ *     value: "New name"
+ *   }
+ * ]
+ */
 type EmailConfigPatch = EmailConfigFieldPatch[];
 type GetBasicAuthConfig = {
     /** The email address that should appear in From field when sending emails with this account */

package/users.d.ts

@@ -16,6 +16,13 @@ type AssignedGroups = {
 }[];
 /**
  * An array of group reference names and provider type.
+ * @example
+ * [
+ *   {
+ *     name: "Developers",
+ *     providerType: "custom"
+ *   }
+ * ]
  */
 type AssignedGroupsRefNames = {
     /** The name of the group */
@@ -75,6 +82,17 @@ type ErrorItem = {
 };
 /**
  * The error response object describing the error from the handling of an HTTP request.
+ * @example
+ * {
+ *   errors: [
+ *     {
+ *       code: "USERS-7",
+ *       status: 404,
+ *       title: "Not found"
+ *     }
+ *   ],
+ *   traceId: "000000000000000079cf1ebeae103de1"
+ * }
  */
 type Errors = {
     /** An array of errors related to the operation. */
@@ -136,10 +154,58 @@ type JSONPatch = {
 };
 /**
  * An array of JSON Patch documents
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     path: "/name",
+ *     value: "John"
+ *   },
+ *   {
+ *     op: "replace",
+ *     path: "/assignedRoles",
+ *     value: [
+ *       {
+ *         "name": "Developer"
+ *       }
+ *     ]
+ *   },
+ *   {
+ *     op: "replace",
+ *     value: "unicorn@corp.example"
+ *   },
+ *   {
+ *     op: "replace",
+ *     value: "America/Halifax"
+ *   },
+ *   {
+ *     op: "replace",
+ *     path: "/preferredLocale",
+ *     value: "en_US_POSIX"
+ *   },
+ *   {
+ *     op: "replace",
+ *     path: "/status",
+ *     value: "active"
+ *   },
+ *   {
+ *     op: "add"
+ *   },
+ *   {
+ *     op: "remove-value",
+ *     path: "/assignedRoles"
+ *   }
+ * ]
  */
 type JSONPatchArray = JSONPatch[];
 /**
  * An array of entity reference identifiers (e.g. roles, groups).
+ * @example
+ * [
+ *   {
+ *     id: "507f191e810c19729de860ea"
+ *   }
+ * ]
  */
 type RefIDs = {
     /** The unique identitier */
@@ -147,6 +213,12 @@ type RefIDs = {
 }[];
 /**
  * An array of reference names (e.g. roles).
+ * @example
+ * [
+ *   {
+ *     name: "TenantAdmin"
+ *   }
+ * ]
  */
 type RefNames = {
     /** The name of the entity */
@@ -228,6 +300,22 @@ type UserCount = {
     /** The total number of users in the tenant. */
     total: number;
 };
+/**
+ * @example
+ * {
+ *   assignedRoles: [
+ *     {
+ *       name: "Developer"
+ *     }
+ *   ],
+ *   email: "john.smith@corp.example",
+ *   name: "John Smith",
+ *   picture: "https://corp.example/docs/jsmith.png",
+ *   status: "invited",
+ *   subject: "1234asdasa6789",
+ *   tenantId: "q3VRZ4YMixRaLKEPhkZWM-XMIDN7cO8f"
+ * }
+ */
 type UserPostSchema = {
     /** The roles to assign to the user. */
     assignedRoles?: RefIDs | RefNames;

package/web-integrations.d.ts

@@ -25,6 +25,16 @@ type Error = {
 };
 /**
  * The error response object describing the error from the handling of an HTTP request.
+ * @example
+ * {
+ *   errors: [
+ *     {
+ *       code: "TENANTS-8",
+ *       title: "Not found"
+ *     }
+ *   ],
+ *   traceId: "000000000000000079cf1ebeae103de1"
+ * }
  */
 type Errors = {
     /** An array of errors related to the operation. */
@@ -62,6 +72,16 @@ type WebIntegrationPatch = {
     /** New value to be used for this operation. */
     value: string;
 };
+/**
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     path: "/name",
+ *     value: "New name"
+ *   }
+ * ]
+ */
 type WebIntegrationPatchSchema = WebIntegrationPatch[];
 /**
  * The creation of a web integration response.

package/web-notifications.d.ts

@@ -70,6 +70,13 @@ type NotificationPatch = {
 };
 /**
  * An array of JSON Patch documents
+ * @example
+ * [
+ *   {
+ *     op: "replace",
+ *     path: "/read"
+ *   }
+ * ]
  */
 type NotificationPatchSchema = NotificationPatch[];
 type Notifications = {
@@ -81,6 +88,12 @@ type Notifications = {
 };
 /**
  * Retrieve notifications matching the query.
+ * @example
+ * getNotifications(
+ *   {
+ *     resourceType: "app,space"
+ *   }
+ * )
  *
  * @param query an object with query parameters
  * @throws GetNotificationsHttpError
@@ -201,6 +214,12 @@ declare function clearCache(): void;
 interface WebNotificationsAPI {
     /**
      * Retrieve notifications matching the query.
+     * @example
+     * getNotifications(
+     *   {
+     *     resourceType: "app,space"
+     *   }
+     * )
      *
      * @param query an object with query parameters
      * @throws GetNotificationsHttpError