@stack-spot/portal-network 0.20.0 → 0.22.0

package/src/api/notification.ts

@@ -0,0 +1,278 @@
+/**
+ * Notification Engine
+ * 1.0.0
+ * DO NOT MODIFY - This file has been generated using oazapfts.
+ * See https://www.npmjs.com/package/oazapfts
+ */
+import * as Oazapfts from "@oazapfts/runtime";
+import * as QS from "@oazapfts/runtime/query";
+export const defaults: Oazapfts.Defaults<Oazapfts.CustomHeaders> = {
+    headers: {},
+    baseUrl: "https://account-notification-engine.dev.stackspot.com",
+};
+const oazapfts = Oazapfts.runtime(defaults);
+export const servers = {
+    generatedServerUrl: "https://account-notification-engine.dev.stackspot.com"
+};
+export type GetTenantNotificationsResponse = {
+    id: string;
+    title: string;
+    description: string;
+    broadcast_level: "ACCOUNT" | "INDIVIDUAL" | "PLATFORM" | "RESOURCE";
+    context: "ACCOUNT" | "STUDIO" | "WORKSPACE" | "AI";
+    target?: string;
+    criticality: "LOW" | "MEDIUM" | "HIGH";
+    call_to_action: string;
+    persistent: boolean;
+    committed: boolean;
+    last_until?: string;
+    trigger_at: string;
+    created_at?: string;
+};
+export type PagingResponseModelGetTenantNotificationsResponse = {
+    items: GetTenantNotificationsResponse[];
+    size: number;
+    total_elements: number;
+};
+export type ErrorDetails = {
+    code: "INTEGRATION_EXCEPTION" | "INVALID_TENANT" | "VALIDATION_ERROR" | "MANDATORY_FIELD_NOT_INFORMED" | "INVALID_REQUEST" | "NOTIFICATION_NOT_FOUND" | "INVALID_FIELD" | "MISSING_TOKEN";
+    field?: string;
+    details?: string;
+    values?: string[];
+};
+export type ApiErrorResponse = {
+    code?: "INTEGRATION_EXCEPTION" | "INVALID_TENANT" | "VALIDATION_ERROR" | "MANDATORY_FIELD_NOT_INFORMED" | "INVALID_REQUEST" | "NOTIFICATION_NOT_FOUND" | "INVALID_FIELD" | "MISSING_TOKEN";
+    status: number;
+    message: string;
+    details?: ErrorDetails[];
+};
+export type CreateTenantNotificationRequest = {
+    /** User friendly title for the notification */
+    title: string;
+    /** User friendly description for the notification (allows the use of markdown) */
+    description: string;
+    /** Level of broadcasting to the notification. */
+    broadcast_level: "ACCOUNT" | "INDIVIDUAL" | "PLATFORM" | "RESOURCE" | "ACCOUNT" | "INDIVIDUAL" | "RESOURCE";
+    /** The target of the notification, user id for 'individual', resource id for 'resource', leave empty for any other */
+    target: string;
+    /** Criticality of the notification. */
+    criticality: "LOW" | "MEDIUM" | "HIGH" | "LOW" | "MEDIUM" | "HIGH";
+    /** Which context to publish the notification */
+    context: "ACCOUNT" | "STUDIO" | "WORKSPACE" | "AI" | "Account" | "Studio" | "Workspace";
+    /** Possible redirect link for the notification button. */
+    call_to_action: string;
+    /** If the notification should be re-consumed until 'last_until' is reached. */
+    persistent: boolean;
+    /** UTC formatted timestamp to when the notification should finally end, if the persistent is set to true. */
+    last_until?: string;
+    /** UTC formatted timestamp for when to triggers the notification. */
+    trigger_at: string;
+};
+export type CreatePlatformNotificationRequest = {
+    /** User friendly title for the notification */
+    title: string;
+    /** User friendly description for the notification (allows the use of markdown) */
+    description: string;
+    /** Criticality of the notification. */
+    criticality: "LOW" | "MEDIUM" | "HIGH" | "LOW" | "MEDIUM" | "HIGH";
+    /** Which context to publish the notification */
+    context: "ACCOUNT" | "STUDIO" | "WORKSPACE" | "AI" | "Account" | "Studio" | "Workspace";
+    /** Possible redirect link for the notification button. */
+    call_to_action: string;
+    /** If the notification should be re-consumed until last_until is reached. */
+    persistent: boolean;
+    /** UTC formatted timestamp to when the notification should finally ended if the persistent is set to true. */
+    last_until?: string;
+    /** UTC formatted timestamp for when to triggers the notification. */
+    trigger_at: string;
+};
+export type CreatePlatformNotificationResponse = {
+    id: string;
+};
+export type GetCommittedNotificationsResponse = {
+    /** If there are uncommitted notifications for the user */
+    uncommitted_messages: boolean;
+};
+/**
+ * Get notifications for tenant
+ */
+export function findAll({ size, page, createdSince, context, criticality, content, committed, tenantId }: {
+    size?: number;
+    page?: number;
+    createdSince?: number;
+    context?: "ACCOUNT" | "STUDIO" | "WORKSPACE" | "AI";
+    criticality?: "LOW" | "MEDIUM" | "HIGH";
+    content?: string;
+    committed?: boolean;
+    tenantId: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: PagingResponseModelGetTenantNotificationsResponse;
+    } | {
+        status: 403;
+        data: ApiErrorResponse;
+    } | {
+        status: 500;
+        data: ApiErrorResponse;
+    }>(`/v1/tenants/${encodeURIComponent(tenantId)}/notifications${QS.query(QS.explode({
+        size,
+        page,
+        createdSince,
+        context,
+        criticality,
+        content,
+        committed
+    }))}`, {
+        ...opts
+    }));
+}
+/**
+ * Generate a new notification intent to the specified tenant
+ */
+export function create({ tenantId, createTenantNotificationRequest }: {
+    tenantId: string;
+    createTenantNotificationRequest: CreateTenantNotificationRequest;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 201;
+        data: object;
+    } | {
+        status: 403;
+        data: ApiErrorResponse;
+    } | {
+        status: 500;
+        data: ApiErrorResponse;
+    }>(`/v1/tenants/${encodeURIComponent(tenantId)}/notifications`, oazapfts.json({
+        ...opts,
+        method: "POST",
+        body: createTenantNotificationRequest
+    })));
+}
+/**
+ * Allows to mark a notification as committed
+ */
+export function commit({ notificationId, tenantId }: {
+    notificationId: string;
+    tenantId: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 204;
+    } | {
+        status: 403;
+        data: ApiErrorResponse;
+    } | {
+        status: 500;
+        data: ApiErrorResponse;
+    }>(`/v1/tenants/${encodeURIComponent(tenantId)}/notifications/${encodeURIComponent(notificationId)}/commit`, {
+        ...opts,
+        method: "POST"
+    }));
+}
+/**
+ * Generate a new notification intent to the specified tenant
+ */
+export function create1({ createPlatformNotificationRequest }: {
+    createPlatformNotificationRequest: CreatePlatformNotificationRequest;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: CreatePlatformNotificationResponse;
+    }>("/v1/notifications", oazapfts.json({
+        ...opts,
+        method: "POST",
+        body: createPlatformNotificationRequest
+    })));
+}
+/**
+ * Allows to check if there are any uncommitted notifications for the user
+ */
+export function committedNotifications({ tenantId }: {
+    tenantId: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: GetCommittedNotificationsResponse;
+    } | {
+        status: 403;
+        data: ApiErrorResponse;
+    } | {
+        status: 500;
+        data: ApiErrorResponse;
+    }>(`/v1/tenants/${encodeURIComponent(tenantId)}/notifications/committed`, {
+        ...opts
+    }));
+}
+/**
+ * Actuator web endpoint 'health'
+ */
+export function health(opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: object;
+    }>("/healthz", {
+        ...opts
+    }));
+}
+/**
+ * Actuator web endpoint 'health-path'
+ */
+export function getHealthz(opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 200;
+        data: object;
+    }>("/healthz/**", {
+        ...opts
+    }));
+}
+/**
+ * Delete notification by id
+ */
+export function deleteV1TenantsByTenantIdNotificationsAndNotificationId({ notificationId, tenantId }: {
+    notificationId: string;
+    tenantId: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 204;
+    } | {
+        status: 403;
+        data: ApiErrorResponse;
+    } | {
+        status: 500;
+        data: ApiErrorResponse;
+    }>(`/v1/tenants/${encodeURIComponent(tenantId)}/notifications/${encodeURIComponent(notificationId)}`, {
+        ...opts,
+        method: "DELETE"
+    }));
+}
+/**
+ * Allows to unmark a notification as committed
+ */
+export function uncommit({ notificationId, tenantId }: {
+    notificationId: string;
+    tenantId: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchJson<{
+        status: 204;
+    } | {
+        status: 403;
+        data: ApiErrorResponse;
+    } | {
+        status: 500;
+        data: ApiErrorResponse;
+    }>(`/v1/tenants/${encodeURIComponent(tenantId)}/notifications/${encodeURIComponent(notificationId)}/uncommit`, {
+        ...opts,
+        method: "DELETE"
+    }));
+}
+/**
+ * Batches deletes the notification in all tenants
+ */
+export function delete1({ notificationId }: {
+    notificationId: string;
+}, opts?: Oazapfts.RequestOpts) {
+    return oazapfts.ok(oazapfts.fetchText(`/v1/notifications/${encodeURIComponent(notificationId)}`, {
+        ...opts,
+        method: "DELETE"
+    }));
+}

package/src/api/workspace.ts

@@ -1047,7 +1047,7 @@ export type ActivityResponse = {
     title?: string;
     version?: string;
     owner?: string;
-    status: "SUCCESS" | "FAILED" | "SKIPPED" | "CANCELLED" | "RUNTIME_ERROR" | "INTERNAL_ERROR" | "EXTERNAL_ERROR" | "ABORTED" | "ABORTING" | "SUCCEEDED" | "USER_ERROR" | "DRIFT" | "RUNNING" | "READY_TO_RUN" | "PENDING" | "NONE";
+    status: "SUCCESS" | "FAILED" | "SKIPPED" | "CANCELLED" | "RUNTIME_ERROR" | "INTERNAL_ERROR" | "EXTERNAL_ERROR" | "ABORTED" | "ABORTING" | "SUCCEEDED" | "USER_ERROR" | "DRIFT" | "TIMEOUT" | "RUNNING" | "READY_TO_RUN" | "PENDING" | "NONE";
     "type"?: "DEPLOY" | "ACTION" | "WORKFLOW" | "DRIFT" | "DESTROY" | "ROLLBACK" | "IAC" | "DEPLOY_SELF_HOSTED" | "DESTROY_SELF_HOSTED" | "ROLLBACK_SELF_HOSTED" | "IAC_SELF_HOSTED" | "CUSTOMER_WORKFLOW";
     requestedBy?: string;
     action?: "CREATE" | "UPDATE" | "DELETE" | "RUN";

package/src/apis.json

@@ -133,5 +133,13 @@
       "prd": "https://secrets-api.v1.stackspot.com"
     },
     "docs": "/v3/api-docs"
+  },
+  "notification": {
+    "url": {
+      "dev": "https://account-notification-engine.dev.stackspot.com",
+      "stg": "https://account-notification-engine.stg.stackspot.com",
+      "prd": "https://account-notification-engine.stackspot.com"
+    },
+    "docs": "/v3/api-docs"
   }
 }

package/src/client/account.ts

@@ -47,6 +47,7 @@ import {
   isCreatedScmCredentials,
   isCreatedScmCredentials1, listScmCredentials, listScmCredentials1, partialUpdateSso, personalAccessTokenAuthorization,
   removeRoleFromMember,
+  resetOtp,
   resetPassword, revokeServiceCredential1, save,
   scmCredentialSave, scmCredentialSave1, scmCredentialUpdate, scmCredentialUpdate1, scmDelete, sendDownloadEmail, ssoAddAttributes,
   ssoConfigure, ssoGetAttributesConfig, ssoParseConfigurationFile, update1,
@@ -187,6 +188,10 @@ class AccountClient extends ReactQueryNetworkClient {
    * Sends an e-mail to reset the password of the member with the provided e-mail address.
    */
   resetMemberPassword = this.mutation(resetPassword)
+  /**
+   * Reset member OTP
+   */
+  resetOtp = this.mutation(resetOtp)
   /**
    * Enables Fido credentials for the given member.
    */

package/src/client/content.ts

@@ -5,6 +5,7 @@ import { DefaultAPIError } from '../error/DefaultAPIError'
 import { cntDictionary } from '../error/dictionary/cnt'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
+import { removeAuthorizationParam } from '../utils/remove-authorization-param'
 
 class ContentClient extends ReactQueryNetworkClient {
   constructor() {
@@ -33,11 +34,11 @@ class ContentClient extends ReactQueryNetworkClient {
   /**
    * Gets all studios
    */
-  studios = this.query(getStudios1)
+  studios = this.query(removeAuthorizationParam(getStudios1))
   /**
    * Gets all studios
    */
-  studiosUserHasCreatePermission = this.query(getStudiosToCreateButton)
+  studiosUserHasCreatePermission = this.query(removeAuthorizationParam(getStudiosToCreateButton))
   /**
    * Gets a studio
    */
@@ -45,7 +46,7 @@ class ContentClient extends ReactQueryNetworkClient {
   /**
    * Creates a studio
    */
-  createStudio = this.mutation(createStudio)
+  createStudio = this.mutation(removeAuthorizationParam(createStudio))
   /**
    * Updates a studio
    */

package/src/client/notification.ts

@@ -0,0 +1,32 @@
+import { HttpError } from '@oazapfts/runtime'
+import { commit, committedNotifications, defaults, findAll } from '../api/notification'
+import apis from '../apis.json'
+import { DefaultAPIError } from '../error/DefaultAPIError'
+import { baseDictionary } from '../error/dictionary/base'
+import { StackspotAPIError } from '../error/StackspotAPIError'
+import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
+
+class NotificationClient extends ReactQueryNetworkClient {
+
+  constructor() {
+    super(apis.notification.url, defaults)
+  } 
+
+  protected buildStackSpotError(error: HttpError): StackspotAPIError {
+    return new DefaultAPIError(error.data, error.status, baseDictionary, error.headers)
+  }
+  /**
+   * Gets all notification by tenant
+   */
+  notifications = this.query(findAll)
+  /**
+   * Gets all committed notifications by tenant
+   */
+  committedNotifications = this.query(committedNotifications)
+  /**
+   * Mark a notification as committed (mark as read)
+   */
+  commit = this.mutation(commit)
+}
+
+export const notificationClient = new NotificationClient()

package/src/client/workflow.ts

@@ -5,6 +5,7 @@ import { DefaultAPIError } from '../error/DefaultAPIError'
 import { actionDictionary } from '../error/dictionary/action'
 import { StackspotAPIError } from '../error/StackspotAPIError'
 import { ReactQueryNetworkClient } from '../network/ReactQueryNetworkClient'
+import { removeAuthorizationParam } from '../utils/remove-authorization-param'
 
 class WorkflowClient extends ReactQueryNetworkClient {
   constructor() {
@@ -18,7 +19,7 @@ class WorkflowClient extends ReactQueryNetworkClient {
   /**
    * Runs an action
    */
-  runAction = this.mutation(runActionServiceWorkflowsRunActionDispatchPost)
+  runAction = this.mutation(removeAuthorizationParam(runActionServiceWorkflowsRunActionDispatchPost))
   
   /**
    * Creates an api
@@ -28,17 +29,17 @@ class WorkflowClient extends ReactQueryNetworkClient {
   /**
    * Gets the execution status of a workflow by id
    */
-  executionStatus = this.query(getExecutionStatusServiceWorkflowsExecutionStatusExecutionIdGet)
+  executionStatus = this.query(removeAuthorizationParam(getExecutionStatusServiceWorkflowsExecutionStatusExecutionIdGet))
 
   /**
    * Gets the execution dispatch service
    */
-  executionDispatchInfo = this.query(getExecutionDispatchRequestServiceWorkflowsExecutionIdRequestGet)
+  executionDispatchInfo = this.query(removeAuthorizationParam(getExecutionDispatchRequestServiceWorkflowsExecutionIdRequestGet))
  
   /**
    * Gets the health check of an execution id
    */
-  executionHealthCheck = this.mutation(healthCheckServiceWorkflowsHealthCheckDispatchPost)
+  executionHealthCheck = this.mutation(removeAuthorizationParam(healthCheckServiceWorkflowsHealthCheckDispatchPost))
 }
 
 export const workflowClient = new WorkflowClient()

package/src/index.ts

@@ -7,6 +7,7 @@ export { runtimeManagerClient } from './client/runtime-manager'
 export { workspaceSearchClient } from './client/workspace-search'
 export { workflowClient } from './client/workflow'
 export { eventBusClient } from './client/event-bus'
+export { notificationClient } from './client/notification'
 export * from './client/types'
 export { UseQueryObjectOptions } from './network/types'
 export { DefaultAPIError } from './error/DefaultAPIError'

package/src/utils/remove-authorization-param.ts

@@ -0,0 +1,5 @@
+import { FixVariables, OazapftsFunction } from '../client/types'
+
+export function removeAuthorizationParam<T extends OazapftsFunction>(fn: T): FixVariables<T, { authorization: never }> {
+  return fn
+}