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

package/src/v1/client.ts

@@ -0,0 +1,260 @@
+// 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 {
+  BudgetConfiguration,
+  CreateBudgetConfigurationRequest,
+  CreateBudgetConfigurationRequest_Response,
+  DeleteBudgetConfigurationRequest,
+  DeleteBudgetConfigurationRequest_Response,
+  GetBudgetConfigurationRequest,
+  GetBudgetConfigurationRequest_Response,
+  ListBudgetConfigurationsRequest,
+  ListBudgetConfigurationsRequest_Response,
+  UpdateBudgetConfigurationRequest,
+  UpdateBudgetConfigurationRequest_Response,
+} from './model';
+import {
+  marshalCreateBudgetConfigurationRequestSchema,
+  marshalUpdateBudgetConfigurationRequestSchema,
+  unmarshalCreateBudgetConfigurationRequest_ResponseSchema,
+  unmarshalDeleteBudgetConfigurationRequest_ResponseSchema,
+  unmarshalGetBudgetConfigurationRequest_ResponseSchema,
+  unmarshalListBudgetConfigurationsRequest_ResponseSchema,
+  unmarshalUpdateBudgetConfigurationRequest_ResponseSchema,
+} 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 BudgetsClient {
+  private readonly host: string;
+  // Fallback for endpoints whose path contains {account_id}. If the request
+  // already carries an accountId, that value wins.
+  private readonly accountId: 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.accountId = options.accountId;
+    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);
+  }
+
+  /** Create a new budget configuration for an account. For full details, see https://docs.databricks.com/en/admin/account-settings/budgets.html. */
+  async createBudgetConfiguration(
+    req: CreateBudgetConfigurationRequest,
+    options?: CallOptions
+  ): Promise<CreateBudgetConfigurationRequest_Response> {
+    const url = `${this.host}/api/2.1/accounts/${req.budget?.accountId ?? this.accountId ?? ''}/budgets`;
+    const body = marshalRequest(
+      req,
+      marshalCreateBudgetConfigurationRequestSchema
+    );
+    let resp: CreateBudgetConfigurationRequest_Response | undefined;
+    const call = async (callSignal?: AbortSignal): Promise<void> => {
+      const headers = new Headers({'Content-Type': 'application/json'});
+      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,
+        unmarshalCreateBudgetConfigurationRequest_ResponseSchema
+      );
+    };
+    await executeCall(call, options);
+    if (resp === undefined) {
+      throw new Error('operation completed without a result.');
+    }
+    return resp;
+  }
+
+  /** Deletes a budget configuration for an account. Both account and budget configuration are specified by ID. This cannot be undone. */
+  async deleteBudgetConfiguration(
+    req: DeleteBudgetConfigurationRequest,
+    options?: CallOptions
+  ): Promise<DeleteBudgetConfigurationRequest_Response> {
+    const url = `${this.host}/api/2.1/accounts/${req.accountId ?? this.accountId ?? ''}/budgets/${req.budgetId ?? ''}`;
+    let resp: DeleteBudgetConfigurationRequest_Response | undefined;
+    const call = async (callSignal?: AbortSignal): Promise<void> => {
+      const headers = new Headers();
+      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,
+        unmarshalDeleteBudgetConfigurationRequest_ResponseSchema
+      );
+    };
+    await executeCall(call, options);
+    if (resp === undefined) {
+      throw new Error('operation completed without a result.');
+    }
+    return resp;
+  }
+
+  /** Gets a budget configuration for an account. Both account and budget configuration are specified by ID. */
+  async getBudgetConfiguration(
+    req: GetBudgetConfigurationRequest,
+    options?: CallOptions
+  ): Promise<GetBudgetConfigurationRequest_Response> {
+    const url = `${this.host}/api/2.1/accounts/${req.accountId ?? this.accountId ?? ''}/budgets/${req.budgetId ?? ''}`;
+    const params = new URLSearchParams();
+    if (req.includeSpendStatus !== undefined) {
+      params.append('include_spend_status', String(req.includeSpendStatus));
+    }
+    const query = params.toString();
+    const fullUrl = query !== '' ? `${url}?${query}` : url;
+    let resp: GetBudgetConfigurationRequest_Response | undefined;
+    const call = async (callSignal?: AbortSignal): Promise<void> => {
+      const headers = new Headers();
+      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,
+        unmarshalGetBudgetConfigurationRequest_ResponseSchema
+      );
+    };
+    await executeCall(call, options);
+    if (resp === undefined) {
+      throw new Error('operation completed without a result.');
+    }
+    return resp;
+  }
+
+  /** Gets all budgets associated with this account. */
+  async listBudgetConfigurations(
+    req: ListBudgetConfigurationsRequest,
+    options?: CallOptions
+  ): Promise<ListBudgetConfigurationsRequest_Response> {
+    const url = `${this.host}/api/2.1/accounts/${req.accountId ?? this.accountId ?? ''}/budgets`;
+    const params = new URLSearchParams();
+    if (req.pageToken !== undefined) {
+      params.append('page_token', req.pageToken);
+    }
+    if (req.includeSpendStatus !== undefined) {
+      params.append('include_spend_status', String(req.includeSpendStatus));
+    }
+    if (req.includeWorkspaceBudgets !== undefined) {
+      params.append(
+        'include_workspace_budgets',
+        String(req.includeWorkspaceBudgets)
+      );
+    }
+    const query = params.toString();
+    const fullUrl = query !== '' ? `${url}?${query}` : url;
+    let resp: ListBudgetConfigurationsRequest_Response | undefined;
+    const call = async (callSignal?: AbortSignal): Promise<void> => {
+      const headers = new Headers();
+      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,
+        unmarshalListBudgetConfigurationsRequest_ResponseSchema
+      );
+    };
+    await executeCall(call, options);
+    if (resp === undefined) {
+      throw new Error('operation completed without a result.');
+    }
+    return resp;
+  }
+
+  async *listBudgetConfigurationsIter(
+    req: ListBudgetConfigurationsRequest,
+    options?: CallOptions
+  ): AsyncGenerator<BudgetConfiguration> {
+    const pageReq: ListBudgetConfigurationsRequest = {...req};
+    for (;;) {
+      const resp = await this.listBudgetConfigurations(pageReq, options);
+      for (const item of resp.budgets ?? []) {
+        yield item;
+      }
+      if (resp.nextPageToken === undefined || resp.nextPageToken === '') {
+        return;
+      }
+      pageReq.pageToken = resp.nextPageToken;
+    }
+  }
+
+  /** Updates a budget configuration for an account. Both account and budget configuration are specified by ID. */
+  async updateBudgetConfiguration(
+    req: UpdateBudgetConfigurationRequest,
+    options?: CallOptions
+  ): Promise<UpdateBudgetConfigurationRequest_Response> {
+    const url = `${this.host}/api/2.1/accounts/${req.budget?.accountId ?? this.accountId ?? ''}/budgets/${req.budgetId ?? ''}`;
+    const body = marshalRequest(
+      req,
+      marshalUpdateBudgetConfigurationRequestSchema
+    );
+    let resp: UpdateBudgetConfigurationRequest_Response | undefined;
+    const call = async (callSignal?: AbortSignal): Promise<void> => {
+      const headers = new Headers({'Content-Type': 'application/json'});
+      headers.set('User-Agent', this.userAgent);
+      const httpReq = buildHttpRequest('PUT', url, headers, callSignal, body);
+      const respBody = await executeHttpCall({
+        request: httpReq,
+        httpClient: this.httpClient,
+        logger: this.logger,
+      });
+      resp = parseResponse(
+        respBody,
+        unmarshalUpdateBudgetConfigurationRequest_ResponseSchema
+      );
+    };
+    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,33 @@
+// Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
+
+export {BudgetsClient} from './client';
+
+export {
+  ActionConfigurationType,
+  AlertConfigurationQuantityType,
+  AlertConfigurationTimePeriod,
+  AlertConfigurationTriggerType,
+  BudgetConfigurationFilter_Operator,
+} from './model';
+
+export type {
+  ActionConfiguration,
+  AlertConfiguration,
+  BudgetConfiguration,
+  BudgetConfigurationFilter,
+  BudgetConfigurationFilter_Clause,
+  BudgetConfigurationFilter_TagClause,
+  BudgetConfigurationFilter_WorkspaceIdClause,
+  CreateBudgetConfigurationBudget,
+  CreateBudgetConfigurationRequest,
+  CreateBudgetConfigurationRequest_Response,
+  DeleteBudgetConfigurationRequest,
+  DeleteBudgetConfigurationRequest_Response,
+  GetBudgetConfigurationRequest,
+  GetBudgetConfigurationRequest_Response,
+  ListBudgetConfigurationsRequest,
+  ListBudgetConfigurationsRequest_Response,
+  UpdateBudgetConfigurationBudget,
+  UpdateBudgetConfigurationRequest,
+  UpdateBudgetConfigurationRequest_Response,
+} from './model';