@databricks/sdk-notificationdestinations 0.0.0-dev → 0.1.0-dev.2

package/src/v1/client.ts

@@ -0,0 +1,248 @@
+// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
+
+import {VERSION as AUTH_VERSION} from '@databricks/sdk-auth';
+import {createDefault} from '@databricks/sdk-core/clientinfo';
+import type {Logger} from '@databricks/sdk-core/logger';
+import {NoOpLogger} from '@databricks/sdk-core/logger';
+import type {CallOptions} from '@databricks/sdk-options/call';
+import type {ClientOptions} from '@databricks/sdk-options/client';
+import type {HttpClient} from '@databricks/sdk-core/http';
+import {newHttpClient} from './transport';
+import {
+  buildHttpRequest,
+  executeCall,
+  executeHttpCall,
+  marshalRequest,
+  parseResponse,
+} from './utils';
+import pkgJson from '../../package.json' with {type: 'json'};
+import type {
+  CreateNotificationDestinationRequest,
+  DeleteNotificationDestinationRequest,
+  Empty,
+  GetNotificationDestinationRequest,
+  ListNotificationDestinationsRequest,
+  ListNotificationDestinationsResponse,
+  ListNotificationDestinationsResult,
+  NotificationDestination,
+  UpdateNotificationDestinationRequest,
+} from './model';
+import {
+  marshalCreateNotificationDestinationRequestSchema,
+  marshalUpdateNotificationDestinationRequestSchema,
+  unmarshalEmptySchema,
+  unmarshalListNotificationDestinationsResponseSchema,
+  unmarshalNotificationDestinationSchema,
+} from './model';
+
+// Package identity segment for this client to be used in the User-Agent header.
+const PACKAGE_SEGMENT = {
+  key: 'sdk-js-' + pkgJson.name.replace(/^@[^/]+\/sdk-/, ''),
+  value: pkgJson.version,
+};
+
+export class NotificationDestinationsClient {
+  private readonly host: string;
+  // Workspace ID used to route workspace-level calls on unified hosts (SPOG).
+  // When set, workspace-level methods send X-Databricks-Org-Id on every
+  // request.
+  private readonly workspaceId: string | undefined;
+  private readonly httpClient: HttpClient;
+  private readonly logger: Logger;
+  // User-Agent header value. Composed once at construction from
+  // createDefault() merged with this package's identity and the active
+  // credential's name.
+  private readonly userAgent: string;
+
+  constructor(options: ClientOptions) {
+    if (options.host === undefined) {
+      throw new Error('Host is required.');
+    }
+    this.host = options.host.replace(/\/$/, '');
+    this.workspaceId = options.workspaceId;
+    this.logger = options.logger ?? new NoOpLogger();
+    const info = createDefault()
+      .with(PACKAGE_SEGMENT)
+      .with({key: 'sdk-js-auth', value: AUTH_VERSION})
+      .with({key: 'auth', value: options.credentials?.name() ?? 'default'});
+    this.userAgent = info.toString();
+    this.httpClient = newHttpClient(options);
+  }
+
+  /** Creates a notification destination. Requires workspace admin permissions. */
+  async createNotificationDestination(
+    req: CreateNotificationDestinationRequest,
+    options?: CallOptions
+  ): Promise<NotificationDestination> {
+    const url = `${this.host}/api/2.0/notification-destinations`;
+    const body = marshalRequest(
+      req,
+      marshalCreateNotificationDestinationRequestSchema
+    );
+    let resp: NotificationDestination | undefined;
+    const call = async (callSignal?: AbortSignal): Promise<void> => {
+      const headers = new Headers({'Content-Type': 'application/json'});
+      if (this.workspaceId !== undefined) {
+        headers.set('X-Databricks-Org-Id', this.workspaceId);
+      }
+      headers.set('User-Agent', this.userAgent);
+      const httpReq = buildHttpRequest('POST', url, headers, callSignal, body);
+      const respBody = await executeHttpCall({
+        request: httpReq,
+        httpClient: this.httpClient,
+        logger: this.logger,
+      });
+      resp = parseResponse(respBody, unmarshalNotificationDestinationSchema);
+    };
+    await executeCall(call, options);
+    if (resp === undefined) {
+      throw new Error('operation completed without a result.');
+    }
+    return resp;
+  }
+
+  /** Deletes a notification destination. Requires workspace admin permissions. */
+  async deleteNotificationDestination(
+    req: DeleteNotificationDestinationRequest,
+    options?: CallOptions
+  ): Promise<Empty> {
+    const url = `${this.host}/api/2.0/notification-destinations/${req.id ?? ''}`;
+    let resp: Empty | undefined;
+    const call = async (callSignal?: AbortSignal): Promise<void> => {
+      const headers = new Headers();
+      if (this.workspaceId !== undefined) {
+        headers.set('X-Databricks-Org-Id', this.workspaceId);
+      }
+      headers.set('User-Agent', this.userAgent);
+      const httpReq = buildHttpRequest('DELETE', url, headers, callSignal);
+      const respBody = await executeHttpCall({
+        request: httpReq,
+        httpClient: this.httpClient,
+        logger: this.logger,
+      });
+      resp = parseResponse(respBody, unmarshalEmptySchema);
+    };
+    await executeCall(call, options);
+    if (resp === undefined) {
+      throw new Error('operation completed without a result.');
+    }
+    return resp;
+  }
+
+  /** Gets a notification destination. */
+  async getNotificationDestination(
+    req: GetNotificationDestinationRequest,
+    options?: CallOptions
+  ): Promise<NotificationDestination> {
+    const url = `${this.host}/api/2.0/notification-destinations/${req.id ?? ''}`;
+    let resp: NotificationDestination | undefined;
+    const call = async (callSignal?: AbortSignal): Promise<void> => {
+      const headers = new Headers();
+      if (this.workspaceId !== undefined) {
+        headers.set('X-Databricks-Org-Id', this.workspaceId);
+      }
+      headers.set('User-Agent', this.userAgent);
+      const httpReq = buildHttpRequest('GET', url, headers, callSignal);
+      const respBody = await executeHttpCall({
+        request: httpReq,
+        httpClient: this.httpClient,
+        logger: this.logger,
+      });
+      resp = parseResponse(respBody, unmarshalNotificationDestinationSchema);
+    };
+    await executeCall(call, options);
+    if (resp === undefined) {
+      throw new Error('operation completed without a result.');
+    }
+    return resp;
+  }
+
+  /** Lists notification destinations. */
+  async listNotificationDestinations(
+    req: ListNotificationDestinationsRequest,
+    options?: CallOptions
+  ): Promise<ListNotificationDestinationsResponse> {
+    const url = `${this.host}/api/2.0/notification-destinations`;
+    const params = new URLSearchParams();
+    if (req.pageToken !== undefined) {
+      params.append('page_token', req.pageToken);
+    }
+    if (req.pageSize !== undefined) {
+      params.append('page_size', String(req.pageSize));
+    }
+    const query = params.toString();
+    const fullUrl = query !== '' ? `${url}?${query}` : url;
+    let resp: ListNotificationDestinationsResponse | undefined;
+    const call = async (callSignal?: AbortSignal): Promise<void> => {
+      const headers = new Headers();
+      if (this.workspaceId !== undefined) {
+        headers.set('X-Databricks-Org-Id', this.workspaceId);
+      }
+      headers.set('User-Agent', this.userAgent);
+      const httpReq = buildHttpRequest('GET', fullUrl, headers, callSignal);
+      const respBody = await executeHttpCall({
+        request: httpReq,
+        httpClient: this.httpClient,
+        logger: this.logger,
+      });
+      resp = parseResponse(
+        respBody,
+        unmarshalListNotificationDestinationsResponseSchema
+      );
+    };
+    await executeCall(call, options);
+    if (resp === undefined) {
+      throw new Error('operation completed without a result.');
+    }
+    return resp;
+  }
+
+  async *listNotificationDestinationsIter(
+    req: ListNotificationDestinationsRequest,
+    options?: CallOptions
+  ): AsyncGenerator<ListNotificationDestinationsResult> {
+    const pageReq: ListNotificationDestinationsRequest = {...req};
+    for (;;) {
+      const resp = await this.listNotificationDestinations(pageReq, options);
+      for (const item of resp.results ?? []) {
+        yield item;
+      }
+      if (resp.nextPageToken === undefined || resp.nextPageToken === '') {
+        return;
+      }
+      pageReq.pageToken = resp.nextPageToken;
+    }
+  }
+
+  /** Updates a notification destination. Requires workspace admin permissions. At least one field is required in the request body. */
+  async updateNotificationDestination(
+    req: UpdateNotificationDestinationRequest,
+    options?: CallOptions
+  ): Promise<NotificationDestination> {
+    const url = `${this.host}/api/2.0/notification-destinations/${req.id ?? ''}`;
+    const body = marshalRequest(
+      req,
+      marshalUpdateNotificationDestinationRequestSchema
+    );
+    let resp: NotificationDestination | undefined;
+    const call = async (callSignal?: AbortSignal): Promise<void> => {
+      const headers = new Headers({'Content-Type': 'application/json'});
+      if (this.workspaceId !== undefined) {
+        headers.set('X-Databricks-Org-Id', this.workspaceId);
+      }
+      headers.set('User-Agent', this.userAgent);
+      const httpReq = buildHttpRequest('PATCH', url, headers, callSignal, body);
+      const respBody = await executeHttpCall({
+        request: httpReq,
+        httpClient: this.httpClient,
+        logger: this.logger,
+      });
+      resp = parseResponse(respBody, unmarshalNotificationDestinationSchema);
+    };
+    await executeCall(call, options);
+    if (resp === undefined) {
+      throw new Error('operation completed without a result.');
+    }
+    return resp;
+  }
+}

package/src/v1/index.ts

@@ -0,0 +1,23 @@
+// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
+
+export {NotificationDestinationsClient} from './client';
+
+export {DestinationType} from './model';
+
+export type {
+  Config,
+  CreateNotificationDestinationRequest,
+  DeleteNotificationDestinationRequest,
+  EmailConfig,
+  Empty,
+  GenericWebhookConfig,
+  GetNotificationDestinationRequest,
+  ListNotificationDestinationsRequest,
+  ListNotificationDestinationsResponse,
+  ListNotificationDestinationsResult,
+  MicrosoftTeamsConfig,
+  NotificationDestination,
+  PagerdutyConfig,
+  SlackConfig,
+  UpdateNotificationDestinationRequest,
+} from './model';