@databricks/sdk-accessmanagement 0.1.0-dev.1 → 0.1.0-dev.2

package/src/v1/client.ts

@@ -1,7 +1,6 @@
 // Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
 
 import {VERSION as AUTH_VERSION} from '@databricks/sdk-auth';
-import type {Call} from '@databricks/sdk-core/api';
 import {createDefault} from '@databricks/sdk-core/clientinfo';
 import type {Logger} from '@databricks/sdk-core/logger';
 import {NoOpLogger} from '@databricks/sdk-core/logger';
@@ -23,14 +22,14 @@ import type {
   CheckPolicyResponse,
   DeleteWorkspacePermissionAssignmentRequest,
   DeleteWorkspacePermissionAssignmentRequest_Response,
-  GetAssignableRolesForResourceRequest,
-  GetAssignableRolesForResourceResponse,
   GetObjectPermissionsRequest,
-  GetPermissionLevelsRequest,
-  GetPermissionLevelsRequest_Response,
   GetRuleSetRequest,
-  GetWorkspacePermissionAssignmentsRequest,
-  GetWorkspacePermissionAssignmentsRequest_Response,
+  ListAssignableRolesForResourceRequest,
+  ListAssignableRolesForResourceResponse,
+  ListPermissionLevelsRequest,
+  ListPermissionLevelsRequest_Response,
+  ListWorkspacePermissionAssignmentsRequest,
+  ListWorkspacePermissionAssignmentsRequest_Response,
   ListWorkspacePermissionsRequest,
   ListWorkspacePermissionsRequest_Response,
   PermissionsResponse,
@@ -51,9 +50,9 @@ import {
   marshalUpdateWorkspacePermissionAssignmentRequestSchema,
   unmarshalCheckPolicyResponseSchema,
   unmarshalDeleteWorkspacePermissionAssignmentRequest_ResponseSchema,
-  unmarshalGetAssignableRolesForResourceResponseSchema,
-  unmarshalGetPermissionLevelsRequest_ResponseSchema,
-  unmarshalGetWorkspacePermissionAssignmentsRequest_ResponseSchema,
+  unmarshalListAssignableRolesForResourceResponseSchema,
+  unmarshalListPermissionLevelsRequest_ResponseSchema,
+  unmarshalListWorkspacePermissionAssignmentsRequest_ResponseSchema,
   unmarshalListWorkspacePermissionsRequest_ResponseSchema,
   unmarshalPermissionsResponseSchema,
   unmarshalRuleSetSchema,
@@ -66,7 +65,7 @@ const PACKAGE_SEGMENT = {
   value: pkgJson.version,
 };
 
-export class AccessmanagementClient {
+export class AccessManagementClient {
   private readonly host: string;
   // Fallback for endpoints whose path contains {account_id}. If the request
   // already carries an accountId, that value wins.
@@ -105,7 +104,7 @@ export class AccessmanagementClient {
   ): Promise<DeleteWorkspacePermissionAssignmentRequest_Response> {
     const url = `${this.host}/api/2.0/accounts/${req.accountId ?? this.accountId ?? ''}/workspaces/${String(req.workspaceId ?? '')}/permissionassignments/principals/${String(req.principalId ?? '')}`;
     let resp: DeleteWorkspacePermissionAssignmentRequest_Response | undefined;
-    const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
+    const call = async (callSignal?: AbortSignal): Promise<void> => {
       const headers = new Headers();
       headers.set('User-Agent', this.userAgent);
       const httpReq = buildHttpRequest('DELETE', url, headers, callSignal);
@@ -121,19 +120,19 @@ export class AccessmanagementClient {
     };
     await executeCall(call, options);
     if (resp === undefined) {
-      throw new Error('API call completed without a result.');
+      throw new Error('operation completed without a result.');
     }
     return resp;
   }
 
   /** Get the permission assignments for the specified <Account> and <Workspace>. */
-  async getWorkspacePermissionAssignments(
-    req: GetWorkspacePermissionAssignmentsRequest,
+  async listWorkspacePermissionAssignments(
+    req: ListWorkspacePermissionAssignmentsRequest,
     options?: CallOptions
-  ): Promise<GetWorkspacePermissionAssignmentsRequest_Response> {
+  ): Promise<ListWorkspacePermissionAssignmentsRequest_Response> {
     const url = `${this.host}/api/2.0/accounts/${req.accountId ?? this.accountId ?? ''}/workspaces/${String(req.workspaceId ?? '')}/permissionassignments`;
-    let resp: GetWorkspacePermissionAssignmentsRequest_Response | undefined;
-    const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
+    let resp: ListWorkspacePermissionAssignmentsRequest_Response | undefined;
+    const call = async (callSignal?: AbortSignal): Promise<void> => {
       const headers = new Headers();
       headers.set('User-Agent', this.userAgent);
       const httpReq = buildHttpRequest('GET', url, headers, callSignal);
@@ -144,12 +143,12 @@ export class AccessmanagementClient {
       });
       resp = parseResponse(
         respBody,
-        unmarshalGetWorkspacePermissionAssignmentsRequest_ResponseSchema
+        unmarshalListWorkspacePermissionAssignmentsRequest_ResponseSchema
       );
     };
     await executeCall(call, options);
     if (resp === undefined) {
-      throw new Error('API call completed without a result.');
+      throw new Error('operation completed without a result.');
     }
     return resp;
   }
@@ -161,7 +160,7 @@ export class AccessmanagementClient {
   ): Promise<ListWorkspacePermissionsRequest_Response> {
     const url = `${this.host}/api/2.0/accounts/${req.accountId ?? this.accountId ?? ''}/workspaces/${String(req.workspaceId ?? '')}/permissionassignments/permissions`;
     let resp: ListWorkspacePermissionsRequest_Response | undefined;
-    const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
+    const call = async (callSignal?: AbortSignal): Promise<void> => {
       const headers = new Headers();
       headers.set('User-Agent', this.userAgent);
       const httpReq = buildHttpRequest('GET', url, headers, callSignal);
@@ -177,7 +176,7 @@ export class AccessmanagementClient {
     };
     await executeCall(call, options);
     if (resp === undefined) {
-      throw new Error('API call completed without a result.');
+      throw new Error('operation completed without a result.');
     }
     return resp;
   }
@@ -193,7 +192,7 @@ export class AccessmanagementClient {
       marshalUpdateWorkspacePermissionAssignmentRequestSchema
     );
     let resp: WorkspacePermissionAssignmentOutput | undefined;
-    const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
+    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);
@@ -209,28 +208,31 @@ export class AccessmanagementClient {
     };
     await executeCall(call, options);
     if (resp === undefined) {
-      throw new Error('API call completed without a result.');
+      throw new Error('operation completed without a result.');
     }
     return resp;
   }
 
   /**
-   * Gets all the roles that can be granted on an account level resource. A role is grantable if the rule set on the
-   * resource can contain an access rule of the role.
+   * Get a rule set by its name. A rule set is always attached to a resource and contains a list of access rules on the
+   * said resource. Currently only a default rule set for each resource is supported.
    */
-  async getAssignableRolesForResource(
-    req: GetAssignableRolesForResourceRequest,
+  async getRuleSet(
+    req: GetRuleSetRequest,
     options?: CallOptions
-  ): Promise<GetAssignableRolesForResourceResponse> {
-    const url = `${this.host}/api/2.0/preview/accounts/${req.accountId ?? this.accountId ?? ''}/access-control/assignable-roles`;
+  ): Promise<RuleSet> {
+    const url = `${this.host}/api/2.0/preview/accounts/${req.accountId ?? this.accountId ?? ''}/access-control/rule-sets`;
     const params = new URLSearchParams();
-    if (req.resource !== undefined) {
-      params.append('resource', req.resource);
+    if (req.name !== undefined) {
+      params.append('name', req.name);
+    }
+    if (req.etag !== undefined) {
+      params.append('etag', req.etag);
     }
     const query = params.toString();
     const fullUrl = query !== '' ? `${url}?${query}` : url;
-    let resp: GetAssignableRolesForResourceResponse | undefined;
-    const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
+    let resp: RuleSet | 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);
@@ -239,35 +241,35 @@ export class AccessmanagementClient {
         httpClient: this.httpClient,
         logger: this.logger,
       });
-      resp = parseResponse(
-        respBody,
-        unmarshalGetAssignableRolesForResourceResponseSchema
-      );
+      resp = parseResponse(respBody, unmarshalRuleSetSchema);
     };
     await executeCall(call, options);
     if (resp === undefined) {
-      throw new Error('API call completed without a result.');
+      throw new Error('operation completed without a result.');
     }
     return resp;
   }
 
   /**
-   * Gets all the roles that can be granted on an account level resource. A role is grantable if the rule set on the
-   * resource can contain an access rule of the role.
+   * Get a rule set by its name. A rule set is always attached to a resource and contains a list of access rules on the
+   * said resource. Currently only a default rule set for each resource is supported.
    */
-  async getAssignableRolesForResourceProxy(
-    req: GetAssignableRolesForResourceRequest,
+  async getRuleSetProxy(
+    req: GetRuleSetRequest,
     options?: CallOptions
-  ): Promise<GetAssignableRolesForResourceResponse> {
-    const url = `${this.host}/api/2.0/preview/accounts/${req.accountId ?? this.accountId ?? ''}/access-control/assignable-roles`;
+  ): Promise<RuleSet> {
+    const url = `${this.host}/api/2.0/preview/accounts/${req.accountId ?? this.accountId ?? ''}/access-control/rule-sets`;
     const params = new URLSearchParams();
-    if (req.resource !== undefined) {
-      params.append('resource', req.resource);
+    if (req.name !== undefined) {
+      params.append('name', req.name);
+    }
+    if (req.etag !== undefined) {
+      params.append('etag', req.etag);
     }
     const query = params.toString();
     const fullUrl = query !== '' ? `${url}?${query}` : url;
-    let resp: GetAssignableRolesForResourceResponse | undefined;
-    const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
+    let resp: RuleSet | 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);
@@ -276,38 +278,32 @@ export class AccessmanagementClient {
         httpClient: this.httpClient,
         logger: this.logger,
       });
-      resp = parseResponse(
-        respBody,
-        unmarshalGetAssignableRolesForResourceResponseSchema
-      );
+      resp = parseResponse(respBody, unmarshalRuleSetSchema);
     };
     await executeCall(call, options);
     if (resp === undefined) {
-      throw new Error('API call completed without a result.');
+      throw new Error('operation completed without a result.');
     }
     return resp;
   }
 
   /**
-   * Get a rule set by its name. A rule set is always attached to a resource and contains a list of access rules on the
-   * said resource. Currently only a default rule set for each resource is supported.
+   * Gets all the roles that can be granted on an account level resource. A role is grantable if the rule set on the
+   * resource can contain an access rule of the role.
    */
-  async getRuleSet(
-    req: GetRuleSetRequest,
+  async listAssignableRolesForResource(
+    req: ListAssignableRolesForResourceRequest,
     options?: CallOptions
-  ): Promise<RuleSet> {
-    const url = `${this.host}/api/2.0/preview/accounts/${req.accountId ?? this.accountId ?? ''}/access-control/rule-sets`;
+  ): Promise<ListAssignableRolesForResourceResponse> {
+    const url = `${this.host}/api/2.0/preview/accounts/${req.accountId ?? this.accountId ?? ''}/access-control/assignable-roles`;
     const params = new URLSearchParams();
-    if (req.name !== undefined) {
-      params.append('name', req.name);
-    }
-    if (req.etag !== undefined) {
-      params.append('etag', req.etag);
+    if (req.resource !== undefined) {
+      params.append('resource', req.resource);
     }
     const query = params.toString();
     const fullUrl = query !== '' ? `${url}?${query}` : url;
-    let resp: RuleSet | undefined;
-    const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
+    let resp: ListAssignableRolesForResourceResponse | 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);
@@ -316,35 +312,35 @@ export class AccessmanagementClient {
         httpClient: this.httpClient,
         logger: this.logger,
       });
-      resp = parseResponse(respBody, unmarshalRuleSetSchema);
+      resp = parseResponse(
+        respBody,
+        unmarshalListAssignableRolesForResourceResponseSchema
+      );
     };
     await executeCall(call, options);
     if (resp === undefined) {
-      throw new Error('API call completed without a result.');
+      throw new Error('operation completed without a result.');
     }
     return resp;
   }
 
   /**
-   * Get a rule set by its name. A rule set is always attached to a resource and contains a list of access rules on the
-   * said resource. Currently only a default rule set for each resource is supported.
+   * Gets all the roles that can be granted on an account level resource. A role is grantable if the rule set on the
+   * resource can contain an access rule of the role.
    */
-  async getRuleSetProxy(
-    req: GetRuleSetRequest,
+  async listAssignableRolesForResourceProxy(
+    req: ListAssignableRolesForResourceRequest,
     options?: CallOptions
-  ): Promise<RuleSet> {
-    const url = `${this.host}/api/2.0/preview/accounts/${req.accountId ?? this.accountId ?? ''}/access-control/rule-sets`;
+  ): Promise<ListAssignableRolesForResourceResponse> {
+    const url = `${this.host}/api/2.0/preview/accounts/${req.accountId ?? this.accountId ?? ''}/access-control/assignable-roles`;
     const params = new URLSearchParams();
-    if (req.name !== undefined) {
-      params.append('name', req.name);
-    }
-    if (req.etag !== undefined) {
-      params.append('etag', req.etag);
+    if (req.resource !== undefined) {
+      params.append('resource', req.resource);
     }
     const query = params.toString();
     const fullUrl = query !== '' ? `${url}?${query}` : url;
-    let resp: RuleSet | undefined;
-    const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
+    let resp: ListAssignableRolesForResourceResponse | 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);
@@ -353,11 +349,14 @@ export class AccessmanagementClient {
         httpClient: this.httpClient,
         logger: this.logger,
       });
-      resp = parseResponse(respBody, unmarshalRuleSetSchema);
+      resp = parseResponse(
+        respBody,
+        unmarshalListAssignableRolesForResourceResponseSchema
+      );
     };
     await executeCall(call, options);
     if (resp === undefined) {
-      throw new Error('API call completed without a result.');
+      throw new Error('operation completed without a result.');
     }
     return resp;
   }
@@ -373,7 +372,7 @@ export class AccessmanagementClient {
     const url = `${this.host}/api/2.0/preview/accounts/${req.accountId ?? this.accountId ?? ''}/access-control/rule-sets`;
     const body = marshalRequest(req, marshalUpdateRuleSetRequestSchema);
     let resp: RuleSet | undefined;
-    const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
+    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);
@@ -386,7 +385,7 @@ export class AccessmanagementClient {
     };
     await executeCall(call, options);
     if (resp === undefined) {
-      throw new Error('API call completed without a result.');
+      throw new Error('operation completed without a result.');
     }
     return resp;
   }
@@ -402,7 +401,7 @@ export class AccessmanagementClient {
     const url = `${this.host}/api/2.0/preview/accounts/${req.accountId ?? this.accountId ?? ''}/access-control/rule-sets`;
     const body = marshalRequest(req, marshalUpdateRuleSetRequestSchema);
     let resp: RuleSet | undefined;
-    const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
+    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);
@@ -415,7 +414,7 @@ export class AccessmanagementClient {
     };
     await executeCall(call, options);
     if (resp === undefined) {
-      throw new Error('API call completed without a result.');
+      throw new Error('operation completed without a result.');
     }
     return resp;
   }
@@ -427,7 +426,7 @@ export class AccessmanagementClient {
   ): Promise<PermissionsResponse> {
     const url = `${this.host}/api/2.0/permissions/${req.requestObjectType ?? ''}/${req.requestObjectId ?? ''}`;
     let resp: PermissionsResponse | undefined;
-    const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
+    const call = async (callSignal?: AbortSignal): Promise<void> => {
       const headers = new Headers();
       if (this.workspaceId !== undefined) {
         headers.set('X-Databricks-Org-Id', this.workspaceId);
@@ -443,19 +442,19 @@ export class AccessmanagementClient {
     };
     await executeCall(call, options);
     if (resp === undefined) {
-      throw new Error('API call completed without a result.');
+      throw new Error('operation completed without a result.');
     }
     return resp;
   }
 
   /** Gets the permission levels that a user can have on an object. */
-  async getPermissionLevels(
-    req: GetPermissionLevelsRequest,
+  async listPermissionLevels(
+    req: ListPermissionLevelsRequest,
     options?: CallOptions
-  ): Promise<GetPermissionLevelsRequest_Response> {
+  ): Promise<ListPermissionLevelsRequest_Response> {
     const url = `${this.host}/api/2.0/permissions/${req.requestObjectType ?? ''}/${req.requestObjectId ?? ''}/permissionLevels`;
-    let resp: GetPermissionLevelsRequest_Response | undefined;
-    const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
+    let resp: ListPermissionLevelsRequest_Response | undefined;
+    const call = async (callSignal?: AbortSignal): Promise<void> => {
       const headers = new Headers();
       if (this.workspaceId !== undefined) {
         headers.set('X-Databricks-Org-Id', this.workspaceId);
@@ -469,12 +468,12 @@ export class AccessmanagementClient {
       });
       resp = parseResponse(
         respBody,
-        unmarshalGetPermissionLevelsRequest_ResponseSchema
+        unmarshalListPermissionLevelsRequest_ResponseSchema
       );
     };
     await executeCall(call, options);
     if (resp === undefined) {
-      throw new Error('API call completed without a result.');
+      throw new Error('operation completed without a result.');
     }
     return resp;
   }
@@ -487,7 +486,7 @@ export class AccessmanagementClient {
     const url = `${this.host}/api/2.0/permissions/${req.requestObjectType ?? ''}/${req.requestObjectId ?? ''}`;
     const body = marshalRequest(req, marshalSetObjectPermissionsRequestSchema);
     let resp: PermissionsResponse | undefined;
-    const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
+    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);
@@ -503,7 +502,7 @@ export class AccessmanagementClient {
     };
     await executeCall(call, options);
     if (resp === undefined) {
-      throw new Error('API call completed without a result.');
+      throw new Error('operation completed without a result.');
     }
     return resp;
   }
@@ -519,7 +518,7 @@ export class AccessmanagementClient {
       marshalUpdateObjectPermissionsRequestSchema
     );
     let resp: PermissionsResponse | undefined;
-    const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
+    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);
@@ -535,7 +534,7 @@ export class AccessmanagementClient {
     };
     await executeCall(call, options);
     if (resp === undefined) {
-      throw new Error('API call completed without a result.');
+      throw new Error('operation completed without a result.');
     }
     return resp;
   }
@@ -576,7 +575,7 @@ export class AccessmanagementClient {
     const query = params.toString();
     const fullUrl = query !== '' ? `${url}?${query}` : url;
     let resp: CheckPolicyResponse | undefined;
-    const call: Call = async (callSignal?: AbortSignal): Promise<void> => {
+    const call = async (callSignal?: AbortSignal): Promise<void> => {
       const headers = new Headers();
       if (this.workspaceId !== undefined) {
         headers.set('X-Databricks-Org-Id', this.workspaceId);
@@ -592,7 +591,7 @@ export class AccessmanagementClient {
     };
     await executeCall(call, options);
     if (resp === undefined) {
-      throw new Error('API call completed without a result.');
+      throw new Error('operation completed without a result.');
     }
     return resp;
   }

package/src/v1/index.ts

@@ -1,6 +1,6 @@
 // Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
 
-export {AccessmanagementClient} from './client';
+export {AccessManagementClient} from './client';
 
 export {
   PermissionLevel,
@@ -17,15 +17,15 @@ export type {
   ConsistencyToken,
   DeleteWorkspacePermissionAssignmentRequest,
   DeleteWorkspacePermissionAssignmentRequest_Response,
-  GetAssignableRolesForResourceRequest,
-  GetAssignableRolesForResourceResponse,
   GetObjectPermissionsRequest,
-  GetPermissionLevelsRequest,
-  GetPermissionLevelsRequest_Response,
   GetRuleSetRequest,
-  GetWorkspacePermissionAssignmentsRequest,
-  GetWorkspacePermissionAssignmentsRequest_Response,
   GrantRule,
+  ListAssignableRolesForResourceRequest,
+  ListAssignableRolesForResourceResponse,
+  ListPermissionLevelsRequest,
+  ListPermissionLevelsRequest_Response,
+  ListWorkspacePermissionAssignmentsRequest,
+  ListWorkspacePermissionAssignmentsRequest_Response,
   ListWorkspacePermissionsRequest,
   ListWorkspacePermissionsRequest_Response,
   Permission,