@databricks/sdk-sharing 0.1.0-dev.1 → 0.1.0-dev.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/v1/index.ts CHANGED
@@ -21,11 +21,11 @@ export type {
21
21
  CreateShareRequest,
22
22
  DeleteFederationPolicyRequest,
23
23
  DeleteProviderRequest,
24
- DeleteProviderRequest_Response,
24
+ DeleteProviderResponse,
25
25
  DeleteRecipientRequest,
26
- DeleteRecipientRequest_Response,
26
+ DeleteRecipientResponse,
27
27
  DeleteShareRequest,
28
- DeleteShareRequest_Response,
28
+ DeleteShareResponse,
29
29
  Dependency,
30
30
  DependencyList,
31
31
  FederationPolicy,
@@ -34,14 +34,12 @@ export type {
34
34
  FunctionParameterInfo,
35
35
  FunctionParameterInfos,
36
36
  GetActivationUrlInfoRequest,
37
- GetActivationUrlInfoRequest_Response,
37
+ GetActivationUrlInfoResponse,
38
38
  GetFederationPolicyRequest,
39
39
  GetProviderRequest,
40
40
  GetRecipientRequest,
41
- GetRecipientSharePermissionsRequest,
42
- GetRecipientSharePermissionsRequest_Response,
43
- GetSharePermissionsRequest,
44
- GetSharePermissionsRequest_Response,
41
+ GetRecipientSharePermissionsResponse,
42
+ GetSharePermissionsResponse,
45
43
  GetShareRequest,
46
44
  IpAccessList,
47
45
  ListFederationPoliciesRequest,
@@ -49,13 +47,15 @@ export type {
49
47
  ListProviderShareAssetsRequest,
50
48
  ListProviderShareAssetsResponse,
51
49
  ListProviderSharesRequest,
52
- ListProviderSharesRequest_Response,
50
+ ListProviderSharesResponse,
53
51
  ListProvidersRequest,
54
- ListProvidersRequest_Response,
52
+ ListProvidersResponse,
53
+ ListRecipientSharePermissionsRequest,
55
54
  ListRecipientsRequest,
56
- ListRecipientsRequest_Response,
55
+ ListRecipientsResponse,
56
+ ListSharePermissionsRequest,
57
57
  ListSharesRequest,
58
- ListSharesRequest_Response,
58
+ ListSharesResponse,
59
59
  NotebookFile,
60
60
  OidcFederationPolicy,
61
61
  PartitionSpecification,
@@ -72,7 +72,7 @@ export type {
72
72
  RecipientTokenInfo,
73
73
  RegisteredModelAlias,
74
74
  RetrieveToken,
75
- RetrieveToken_Response,
75
+ RetrieveTokenResponse,
76
76
  RotateRecipientTokenRequest,
77
77
  Share,
78
78
  ShareInfo,
@@ -86,7 +86,7 @@ export type {
86
86
  UpdateProviderRequest,
87
87
  UpdateRecipientRequest,
88
88
  UpdateSharePermissionsRequest,
89
- UpdateSharePermissionsRequest_Response,
89
+ UpdateSharePermissionsResponse,
90
90
  UpdateShareRequest,
91
91
  UpdateShareRequest_SharedDataObjectUpdate,
92
92
  Volume,
package/src/v1/model.ts CHANGED
@@ -230,24 +230,24 @@ export interface DeleteProviderRequest {
230
230
  nameArg?: string | undefined;
231
231
  }
232
232
 
233
- // eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-object-type -- Proto-style nested message name.
234
- export interface DeleteProviderRequest_Response {}
233
+ // eslint-disable-next-line @typescript-eslint/no-empty-object-type
234
+ export interface DeleteProviderResponse {}
235
235
 
236
236
  export interface DeleteRecipientRequest {
237
237
  /** Name of the recipient. */
238
238
  name?: string | undefined;
239
239
  }
240
240
 
241
- // eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-object-type -- Proto-style nested message name.
242
- export interface DeleteRecipientRequest_Response {}
241
+ // eslint-disable-next-line @typescript-eslint/no-empty-object-type
242
+ export interface DeleteRecipientResponse {}
243
243
 
244
244
  export interface DeleteShareRequest {
245
245
  /** The name of the share. */
246
246
  name?: string | undefined;
247
247
  }
248
248
 
249
- // eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-object-type -- Proto-style nested message name.
250
- export interface DeleteShareRequest_Response {}
249
+ // eslint-disable-next-line @typescript-eslint/no-empty-object-type
250
+ export interface DeleteShareResponse {}
251
251
 
252
252
  /** Represents a UC dependency. */
253
253
  export interface Dependency {
@@ -365,8 +365,8 @@ export interface GetActivationUrlInfoRequest {
365
365
  activationUrl?: string | undefined;
366
366
  }
367
367
 
368
- // eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-object-type -- Proto-style nested message name.
369
- export interface GetActivationUrlInfoRequest_Response {}
368
+ // eslint-disable-next-line @typescript-eslint/no-empty-object-type
369
+ export interface GetActivationUrlInfoResponse {}
370
370
 
371
371
  export interface GetFederationPolicyRequest {
372
372
  /** Name of the recipient. This is the name of the recipient for which the policy is being retrieved. */
@@ -385,25 +385,7 @@ export interface GetRecipientRequest {
385
385
  name?: string | undefined;
386
386
  }
387
387
 
388
- export interface GetRecipientSharePermissionsRequest {
389
- /** The name of the Recipient. */
390
- name?: string | undefined;
391
- /**
392
- * Maximum number of permissions to return.
393
- * - when set to 0, the page length is set to a server configured value (recommended);
394
- * - when set to a value greater than 0, the page length is the minimum of this value and a server configured value;
395
- * - when set to a value less than 0, an invalid parameter error is returned;
396
- * - If not set, all valid permissions are returned (not recommended).
397
- * - Note: The number of returned permissions might be less than the specified max_results size, even zero.
398
- * The only definitive indication that no further permissions can be fetched is when the next_page_token is unset from the response.
399
- */
400
- maxResults?: number | undefined;
401
- /** Opaque pagination token to go to next page based on previous query. */
402
- pageToken?: string | undefined;
403
- }
404
-
405
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
406
- export interface GetRecipientSharePermissionsRequest_Response {
388
+ export interface GetRecipientSharePermissionsResponse {
407
389
  /** An array of data share permissions for a recipient. */
408
390
  permissionsOut?: ShareToPrivilegeAssignment[] | undefined;
409
391
  /**
@@ -413,25 +395,7 @@ export interface GetRecipientSharePermissionsRequest_Response {
413
395
  nextPageToken?: string | undefined;
414
396
  }
415
397
 
416
- export interface GetSharePermissionsRequest {
417
- /** The name of the share. */
418
- name?: string | undefined;
419
- /**
420
- * Maximum number of permissions to return.
421
- * - when set to 0, the page length is set to a server configured value (recommended);
422
- * - when set to a value greater than 0, the page length is the minimum of this value and a server configured value;
423
- * - when set to a value less than 0, an invalid parameter error is returned;
424
- * - If not set, all valid permissions are returned (not recommended).
425
- * - Note: The number of returned permissions might be less than the specified max_results size, even zero.
426
- * The only definitive indication that no further permissions can be fetched is when the next_page_token is unset from the response.
427
- */
428
- maxResults?: number | undefined;
429
- /** Opaque pagination token to go to next page based on previous query. */
430
- pageToken?: string | undefined;
431
- }
432
-
433
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
434
- export interface GetSharePermissionsRequest_Response {
398
+ export interface GetSharePermissionsResponse {
435
399
  /**
436
400
  * Opaque token to retrieve the next page of results. Absent if there are no more pages.
437
401
  * __page_token__ should be set to this value for the next request (for the next page of results).
@@ -512,8 +476,7 @@ export interface ListProviderSharesRequest {
512
476
  pageToken?: string | undefined;
513
477
  }
514
478
 
515
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
516
- export interface ListProviderSharesRequest_Response {
479
+ export interface ListProviderSharesResponse {
517
480
  /** An array of provider shares. */
518
481
  shares?: ProviderShare[] | undefined;
519
482
  /**
@@ -543,8 +506,7 @@ export interface ListProvidersRequest {
543
506
  pageToken?: string | undefined;
544
507
  }
545
508
 
546
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
547
- export interface ListProvidersRequest_Response {
509
+ export interface ListProvidersResponse {
548
510
  /** An array of provider information objects. */
549
511
  providers?: ProviderInfo[] | undefined;
550
512
  /**
@@ -554,6 +516,23 @@ export interface ListProvidersRequest_Response {
554
516
  nextPageToken?: string | undefined;
555
517
  }
556
518
 
519
+ export interface ListRecipientSharePermissionsRequest {
520
+ /** The name of the Recipient. */
521
+ name?: string | undefined;
522
+ /**
523
+ * Maximum number of permissions to return.
524
+ * - when set to 0, the page length is set to a server configured value (recommended);
525
+ * - when set to a value greater than 0, the page length is the minimum of this value and a server configured value;
526
+ * - when set to a value less than 0, an invalid parameter error is returned;
527
+ * - If not set, all valid permissions are returned (not recommended).
528
+ * - Note: The number of returned permissions might be less than the specified max_results size, even zero.
529
+ * The only definitive indication that no further permissions can be fetched is when the next_page_token is unset from the response.
530
+ */
531
+ maxResults?: number | undefined;
532
+ /** Opaque pagination token to go to next page based on previous query. */
533
+ pageToken?: string | undefined;
534
+ }
535
+
557
536
  export interface ListRecipientsRequest {
558
537
  /**
559
538
  * If not provided, all recipients will be returned.
@@ -574,8 +553,7 @@ export interface ListRecipientsRequest {
574
553
  pageToken?: string | undefined;
575
554
  }
576
555
 
577
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
578
- export interface ListRecipientsRequest_Response {
556
+ export interface ListRecipientsResponse {
579
557
  /** An array of recipient information objects. */
580
558
  recipients?: RecipientInfo[] | undefined;
581
559
  /**
@@ -585,6 +563,23 @@ export interface ListRecipientsRequest_Response {
585
563
  nextPageToken?: string | undefined;
586
564
  }
587
565
 
566
+ export interface ListSharePermissionsRequest {
567
+ /** The name of the share. */
568
+ name?: string | undefined;
569
+ /**
570
+ * Maximum number of permissions to return.
571
+ * - when set to 0, the page length is set to a server configured value (recommended);
572
+ * - when set to a value greater than 0, the page length is the minimum of this value and a server configured value;
573
+ * - when set to a value less than 0, an invalid parameter error is returned;
574
+ * - If not set, all valid permissions are returned (not recommended).
575
+ * - Note: The number of returned permissions might be less than the specified max_results size, even zero.
576
+ * The only definitive indication that no further permissions can be fetched is when the next_page_token is unset from the response.
577
+ */
578
+ maxResults?: number | undefined;
579
+ /** Opaque pagination token to go to next page based on previous query. */
580
+ pageToken?: string | undefined;
581
+ }
582
+
588
583
  export interface ListSharesRequest {
589
584
  /**
590
585
  * Maximum number of shares to return.
@@ -600,8 +595,7 @@ export interface ListSharesRequest {
600
595
  pageToken?: string | undefined;
601
596
  }
602
597
 
603
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
604
- export interface ListSharesRequest_Response {
598
+ export interface ListSharesResponse {
605
599
  /** An array of data share information objects. */
606
600
  shares?: ShareInfo[] | undefined;
607
601
  /**
@@ -871,8 +865,7 @@ export interface RetrieveToken {
871
865
  activationUrl?: string | undefined;
872
866
  }
873
867
 
874
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
875
- export interface RetrieveToken_Response {
868
+ export interface RetrieveTokenResponse {
876
869
  /** These field names must follow the delta sharing protocol. */
877
870
  shareCredentialsVersion?: number | undefined;
878
871
  /** The token used to authorize the recipient. */
@@ -1176,8 +1169,7 @@ export interface UpdateSharePermissionsRequest {
1176
1169
  changes?: PermissionsChange[] | undefined;
1177
1170
  }
1178
1171
 
1179
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
1180
- export interface UpdateSharePermissionsRequest_Response {
1172
+ export interface UpdateSharePermissionsResponse {
1181
1173
  /** The privileges assigned to each principal */
1182
1174
  privilegeAssignments?: PrivilegeAssignment[] | undefined;
1183
1175
  }
@@ -1240,16 +1232,13 @@ export interface Volume {
1240
1232
  tags?: TagKeyValue[] | undefined;
1241
1233
  }
1242
1234
 
1243
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
1244
- export const unmarshalDeleteProviderRequest_ResponseSchema: z.ZodType<DeleteProviderRequest_Response> =
1235
+ export const unmarshalDeleteProviderResponseSchema: z.ZodType<DeleteProviderResponse> =
1245
1236
  z.object({});
1246
1237
 
1247
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
1248
- export const unmarshalDeleteRecipientRequest_ResponseSchema: z.ZodType<DeleteRecipientRequest_Response> =
1238
+ export const unmarshalDeleteRecipientResponseSchema: z.ZodType<DeleteRecipientResponse> =
1249
1239
  z.object({});
1250
1240
 
1251
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
1252
- export const unmarshalDeleteShareRequest_ResponseSchema: z.ZodType<DeleteShareRequest_Response> =
1241
+ export const unmarshalDeleteShareResponseSchema: z.ZodType<DeleteShareResponse> =
1253
1242
  z.object({});
1254
1243
 
1255
1244
  export const unmarshalDependencySchema: z.ZodType<Dependency> = z
@@ -1396,12 +1385,10 @@ export const unmarshalFunctionParameterInfosSchema: z.ZodType<FunctionParameterI
1396
1385
  parameters: d.parameters,
1397
1386
  }));
1398
1387
 
1399
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
1400
- export const unmarshalGetActivationUrlInfoRequest_ResponseSchema: z.ZodType<GetActivationUrlInfoRequest_Response> =
1388
+ export const unmarshalGetActivationUrlInfoResponseSchema: z.ZodType<GetActivationUrlInfoResponse> =
1401
1389
  z.object({});
1402
1390
 
1403
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
1404
- export const unmarshalGetRecipientSharePermissionsRequest_ResponseSchema: z.ZodType<GetRecipientSharePermissionsRequest_Response> =
1391
+ export const unmarshalGetRecipientSharePermissionsResponseSchema: z.ZodType<GetRecipientSharePermissionsResponse> =
1405
1392
  z
1406
1393
  .object({
1407
1394
  permissions_out: z
@@ -1414,8 +1401,7 @@ export const unmarshalGetRecipientSharePermissionsRequest_ResponseSchema: z.ZodT
1414
1401
  nextPageToken: d.next_page_token,
1415
1402
  }));
1416
1403
 
1417
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
1418
- export const unmarshalGetSharePermissionsRequest_ResponseSchema: z.ZodType<GetSharePermissionsRequest_Response> =
1404
+ export const unmarshalGetSharePermissionsResponseSchema: z.ZodType<GetSharePermissionsResponse> =
1419
1405
  z
1420
1406
  .object({
1421
1407
  next_page_token: z.string().optional(),
@@ -1466,8 +1452,7 @@ export const unmarshalListProviderShareAssetsResponseSchema: z.ZodType<ListProvi
1466
1452
  share: d.share,
1467
1453
  }));
1468
1454
 
1469
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
1470
- export const unmarshalListProviderSharesRequest_ResponseSchema: z.ZodType<ListProviderSharesRequest_Response> =
1455
+ export const unmarshalListProviderSharesResponseSchema: z.ZodType<ListProviderSharesResponse> =
1471
1456
  z
1472
1457
  .object({
1473
1458
  shares: z.array(z.lazy(() => unmarshalProviderShareSchema)).optional(),
@@ -1478,8 +1463,7 @@ export const unmarshalListProviderSharesRequest_ResponseSchema: z.ZodType<ListPr
1478
1463
  nextPageToken: d.next_page_token,
1479
1464
  }));
1480
1465
 
1481
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
1482
- export const unmarshalListProvidersRequest_ResponseSchema: z.ZodType<ListProvidersRequest_Response> =
1466
+ export const unmarshalListProvidersResponseSchema: z.ZodType<ListProvidersResponse> =
1483
1467
  z
1484
1468
  .object({
1485
1469
  providers: z.array(z.lazy(() => unmarshalProviderInfoSchema)).optional(),
@@ -1490,8 +1474,7 @@ export const unmarshalListProvidersRequest_ResponseSchema: z.ZodType<ListProvide
1490
1474
  nextPageToken: d.next_page_token,
1491
1475
  }));
1492
1476
 
1493
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
1494
- export const unmarshalListRecipientsRequest_ResponseSchema: z.ZodType<ListRecipientsRequest_Response> =
1477
+ export const unmarshalListRecipientsResponseSchema: z.ZodType<ListRecipientsResponse> =
1495
1478
  z
1496
1479
  .object({
1497
1480
  recipients: z
@@ -1504,8 +1487,7 @@ export const unmarshalListRecipientsRequest_ResponseSchema: z.ZodType<ListRecipi
1504
1487
  nextPageToken: d.next_page_token,
1505
1488
  }));
1506
1489
 
1507
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
1508
- export const unmarshalListSharesRequest_ResponseSchema: z.ZodType<ListSharesRequest_Response> =
1490
+ export const unmarshalListSharesResponseSchema: z.ZodType<ListSharesResponse> =
1509
1491
  z
1510
1492
  .object({
1511
1493
  shares: z.array(z.lazy(() => unmarshalShareInfoSchema)).optional(),
@@ -1763,8 +1745,7 @@ export const unmarshalRegisteredModelAliasSchema: z.ZodType<RegisteredModelAlias
1763
1745
  versionNum: d.version_num,
1764
1746
  }));
1765
1747
 
1766
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
1767
- export const unmarshalRetrieveToken_ResponseSchema: z.ZodType<RetrieveToken_Response> =
1748
+ export const unmarshalRetrieveTokenResponseSchema: z.ZodType<RetrieveTokenResponse> =
1768
1749
  z
1769
1750
  .object({
1770
1751
  shareCredentialsVersion: z.number().optional(),
@@ -1920,8 +1901,7 @@ export const unmarshalTagKeyValueSchema: z.ZodType<TagKeyValue> = z
1920
1901
  value: d.value,
1921
1902
  }));
1922
1903
 
1923
- // eslint-disable-next-line @typescript-eslint/naming-convention -- Proto-style nested message name.
1924
- export const unmarshalUpdateSharePermissionsRequest_ResponseSchema: z.ZodType<UpdateSharePermissionsRequest_Response> =
1904
+ export const unmarshalUpdateSharePermissionsResponseSchema: z.ZodType<UpdateSharePermissionsResponse> =
1925
1905
  z
1926
1906
  .object({
1927
1907
  privilege_assignments: z
package/src/v1/utils.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  // Code generated from API definition by Databricks SDK Generator. DO NOT EDIT.
2
2
 
3
- import type {Call, Options} from '@databricks/sdk-core/api';
4
- import {execute} from '@databricks/sdk-core/api';
3
+ import type {Options} from '@databricks/sdk-core/ops';
4
+ import {execute} from '@databricks/sdk-core/ops';
5
5
  import {ApiError} from '@databricks/sdk-core/apierror';
6
6
  import type {
7
7
  HttpClient,
@@ -30,7 +30,7 @@ export interface HttpCallOptions {
30
30
  * API from the executor's internal type so they can diverge.
31
31
  */
32
32
  export async function executeCall(
33
- call: Call,
33
+ call: (signal?: AbortSignal) => Promise<void>,
34
34
  options?: CallOptions
35
35
  ): Promise<void> {
36
36
  const opts: Options = {