@milaboratories/pl-client 3.14.6 → 3.15.0

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.
Files changed (101) hide show
  1. package/dist/core/PromiseTracker.d.ts +1 -2
  2. package/dist/core/PromiseTracker.d.ts.map +1 -1
  3. package/dist/core/abstract_stream.d.ts +2 -3
  4. package/dist/core/abstract_stream.d.ts.map +1 -1
  5. package/dist/core/auth.d.ts +2 -4
  6. package/dist/core/auth.d.ts.map +1 -1
  7. package/dist/core/cache.d.ts +1 -3
  8. package/dist/core/cache.d.ts.map +1 -1
  9. package/dist/core/capabilities.d.ts +2 -3
  10. package/dist/core/capabilities.d.ts.map +1 -1
  11. package/dist/core/client.cjs +7 -0
  12. package/dist/core/client.cjs.map +1 -1
  13. package/dist/core/client.d.ts +8 -5
  14. package/dist/core/client.d.ts.map +1 -1
  15. package/dist/core/client.js +7 -0
  16. package/dist/core/client.js.map +1 -1
  17. package/dist/core/config.d.ts +29 -31
  18. package/dist/core/config.d.ts.map +1 -1
  19. package/dist/core/default_client.d.ts +2 -4
  20. package/dist/core/default_client.d.ts.map +1 -1
  21. package/dist/core/driver.d.ts +4 -6
  22. package/dist/core/driver.d.ts.map +1 -1
  23. package/dist/core/errors.d.ts +20 -22
  24. package/dist/core/errors.d.ts.map +1 -1
  25. package/dist/core/final.d.ts +4 -5
  26. package/dist/core/final.d.ts.map +1 -1
  27. package/dist/core/ll_client.cjs +10 -0
  28. package/dist/core/ll_client.cjs.map +1 -1
  29. package/dist/core/ll_client.d.ts +9 -5
  30. package/dist/core/ll_client.d.ts.map +1 -1
  31. package/dist/core/ll_client.js +10 -0
  32. package/dist/core/ll_client.js.map +1 -1
  33. package/dist/core/ll_transaction.d.ts +4 -6
  34. package/dist/core/ll_transaction.d.ts.map +1 -1
  35. package/dist/core/stat.d.ts +2 -3
  36. package/dist/core/stat.d.ts.map +1 -1
  37. package/dist/core/transaction.d.ts +30 -32
  38. package/dist/core/transaction.d.ts.map +1 -1
  39. package/dist/core/tree_filter.d.ts +14 -10
  40. package/dist/core/tree_filter.d.ts.map +1 -1
  41. package/dist/core/types.d.ts +54 -55
  42. package/dist/core/types.d.ts.map +1 -1
  43. package/dist/core/unauth_client.d.ts +4 -6
  44. package/dist/core/unauth_client.d.ts.map +1 -1
  45. package/dist/core/user_resources.cjs +23 -0
  46. package/dist/core/user_resources.cjs.map +1 -1
  47. package/dist/core/user_resources.d.ts +33 -7
  48. package/dist/core/user_resources.d.ts.map +1 -1
  49. package/dist/core/user_resources.js +23 -0
  50. package/dist/core/user_resources.js.map +1 -1
  51. package/dist/core/wire.d.ts +5 -7
  52. package/dist/core/wire.d.ts.map +1 -1
  53. package/dist/helpers/pl.d.ts +32 -34
  54. package/dist/helpers/pl.d.ts.map +1 -1
  55. package/dist/helpers/poll.d.ts +8 -9
  56. package/dist/helpers/poll.d.ts.map +1 -1
  57. package/dist/helpers/tx_helpers.d.ts +2 -4
  58. package/dist/helpers/tx_helpers.d.ts.map +1 -1
  59. package/dist/index.d.ts +2 -2
  60. package/dist/proto-grpc/github.com/googleapis/googleapis/google/rpc/status.d.ts +2 -4
  61. package/dist/proto-grpc/github.com/googleapis/googleapis/google/rpc/status.d.ts.map +1 -1
  62. package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api.cjs +163 -0
  63. package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api.cjs.map +1 -1
  64. package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api.client.cjs +19 -3
  65. package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api.client.cjs.map +1 -1
  66. package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api.client.d.ts +29 -5
  67. package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api.client.d.ts.map +1 -1
  68. package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api.client.js +19 -3
  69. package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api.client.js.map +1 -1
  70. package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api.d.ts +2217 -428
  71. package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api.d.ts.map +1 -1
  72. package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api.js +162 -1
  73. package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api.js.map +1 -1
  74. package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api_types.d.ts +51 -30
  75. package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api_types.d.ts.map +1 -1
  76. package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/base_types.d.ts +7 -9
  77. package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/base_types.d.ts.map +1 -1
  78. package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/resource_types.d.ts +6 -8
  79. package/dist/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/resource_types.d.ts.map +1 -1
  80. package/dist/proto-grpc/google/protobuf/any.d.ts +2 -4
  81. package/dist/proto-grpc/google/protobuf/any.d.ts.map +1 -1
  82. package/dist/proto-grpc/google/protobuf/duration.d.ts +2 -4
  83. package/dist/proto-grpc/google/protobuf/duration.d.ts.map +1 -1
  84. package/dist/proto-grpc/google/protobuf/timestamp.d.ts +2 -4
  85. package/dist/proto-grpc/google/protobuf/timestamp.d.ts.map +1 -1
  86. package/dist/proto-grpc/google/rpc/code.d.ts +1 -2
  87. package/dist/proto-grpc/google/rpc/code.d.ts.map +1 -1
  88. package/dist/proto-rest/index.d.ts +6 -8
  89. package/dist/proto-rest/index.d.ts.map +1 -1
  90. package/dist/proto-rest/plapi.d.ts +241 -122
  91. package/dist/proto-rest/plapi.d.ts.map +1 -1
  92. package/dist/test/tcp-proxy.d.ts +3 -5
  93. package/dist/test/tcp-proxy.d.ts.map +1 -1
  94. package/dist/test/test_config.d.ts +13 -14
  95. package/dist/test/test_config.d.ts.map +1 -1
  96. package/package.json +7 -7
  97. package/src/core/client.ts +9 -0
  98. package/src/core/ll_client.ts +15 -0
  99. package/src/core/user_resources.ts +39 -0
  100. package/src/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api.client.ts +34 -3
  101. package/src/proto-grpc/github.com/milaboratory/pl/plapi/plapiproto/api.ts +206 -0
@@ -3,7 +3,7 @@
3
3
  * This file was auto-generated by openapi-typescript.
4
4
  * Do not make direct changes to the file.
5
5
  */
6
- interface paths {
6
+ export interface paths {
7
7
  "/v1/auth/grant-access": {
8
8
  parameters: {
9
9
  query?: never;
@@ -68,7 +68,8 @@ interface paths {
68
68
  header?: never;
69
69
  path?: never;
70
70
  cookie?: never;
71
- }; /** @description Authentication */
71
+ };
72
+ /** @description Authentication */
72
73
  get: operations["Platform_AuthMethods"];
73
74
  put?: never;
74
75
  post?: never;
@@ -326,7 +327,8 @@ interface paths {
326
327
  cookie?: never;
327
328
  };
328
329
  get?: never;
329
- put?: never; /** @description Controllers */
330
+ put?: never;
331
+ /** @description Controllers */
330
332
  post: operations["Platform_ControllerRegister"];
331
333
  delete?: never;
332
334
  options?: never;
@@ -489,7 +491,8 @@ interface paths {
489
491
  header?: never;
490
492
  path?: never;
491
493
  cookie?: never;
492
- }; /** @description Various service requests */
494
+ };
495
+ /** @description Various service requests */
493
496
  get: operations["Platform_Ping"];
494
497
  put?: never;
495
498
  post?: never;
@@ -505,7 +508,8 @@ interface paths {
505
508
  header?: never;
506
509
  path?: never;
507
510
  cookie?: never;
508
- }; /** @description Other stuff */
511
+ };
512
+ /** @description Other stuff */
509
513
  get: operations["Platform_ListResourceTypes"];
510
514
  put?: never;
511
515
  post?: never;
@@ -523,7 +527,8 @@ interface paths {
523
527
  cookie?: never;
524
528
  };
525
529
  get?: never;
526
- put?: never; /** @description Subscriptions */
530
+ put?: never;
531
+ /** @description Subscriptions */
527
532
  post: operations["Platform_SubscriptionAttachFilter"];
528
533
  delete?: never;
529
534
  options?: never;
@@ -564,10 +569,11 @@ interface paths {
564
569
  trace?: never;
565
570
  };
566
571
  }
567
- interface components {
572
+ export interface components {
568
573
  schemas: {
569
574
  AuthAPI_BeginSSOLogin_PublicPKCE: {
570
- nonce: string; /** Format: date-time */
575
+ nonce: string;
576
+ /** Format: date-time */
571
577
  expiresAt: string;
572
578
  /**
573
579
  * @description Confidential-client secret for the IdP token exchange; absent for public clients.
@@ -584,7 +590,8 @@ interface components {
584
590
  publicPkce: components["schemas"]["AuthAPI_BeginSSOLogin_PublicPKCE"];
585
591
  };
586
592
  AuthAPI_GetJWTToken_Request: {
587
- expiration: string; /** Format: enum */
593
+ expiration: string;
594
+ /** Format: enum */
588
595
  requestedRole: number;
589
596
  };
590
597
  AuthAPI_GetJWTToken_Response: {
@@ -593,12 +600,15 @@ interface components {
593
600
  * Format: bytes
594
601
  * @description Session info fields
595
602
  */
596
- sessionId: string; /** Format: enum */
603
+ sessionId: string;
604
+ /** Format: enum */
597
605
  role: number;
598
606
  };
599
607
  AuthAPI_GetSessionInfo_Request: Record<string, never>;
600
608
  AuthAPI_GetSessionInfo_Response: {
601
- /** Format: bytes */sessionId: string; /** Format: enum */
609
+ /** Format: bytes */
610
+ sessionId: string;
611
+ /** Format: enum */
602
612
  role: number;
603
613
  };
604
614
  AuthAPI_GetUserRoot_Request: {
@@ -609,13 +619,16 @@ interface components {
609
619
  userRoot: components["schemas"]["AuthAPI_UserRoot"];
610
620
  };
611
621
  AuthAPI_GrantAccess_Request: {
612
- resourceId: string; /** Format: bytes */
622
+ resourceId: string;
623
+ /** Format: bytes */
613
624
  resourceSignature: string;
614
625
  targetUser: string;
615
- permissions: components["schemas"]["AuthAPI_Grant_Permissions"]; /** Format: enum */
626
+ permissions: components["schemas"]["AuthAPI_Grant_Permissions"];
627
+ /** Format: enum */
616
628
  grantType: number;
617
629
  };
618
- AuthAPI_GrantAccess_Response: Record<string, never>; /** @description Permissions describes access level for a grant. */
630
+ AuthAPI_GrantAccess_Response: Record<string, never>;
631
+ /** @description Permissions describes access level for a grant. */
619
632
  AuthAPI_Grant_Permissions: {
620
633
  writable: boolean;
621
634
  };
@@ -625,7 +638,8 @@ interface components {
625
638
  * @description id is the stable, machine-readable identifier of the login method
626
639
  * instance. Unique across the entire server.
627
640
  */
628
- id: string; /** @description description is the human-readable label in case we'd like to render it in UI. */
641
+ id: string;
642
+ /** @description description is the human-readable label in case we'd like to render it in UI. */
629
643
  description: string;
630
644
  basic: components["schemas"]["AuthAPI_ListMethods_BasicAuthMethod"];
631
645
  token: components["schemas"]["AuthAPI_ListMethods_TokenAuthMethod"];
@@ -648,7 +662,8 @@ interface components {
648
662
  redirectPorts: number[];
649
663
  subjectTokenSource: string;
650
664
  userIdClaim: string;
651
- groupsClaim: string; /** Format: enum */
665
+ groupsClaim: string;
666
+ /** Format: enum */
652
667
  flowType: number;
653
668
  accessType: string;
654
669
  };
@@ -661,12 +676,15 @@ interface components {
661
676
  basic: components["schemas"]["AuthAPI_Login_BasicCredentials"];
662
677
  token: components["schemas"]["AuthAPI_Login_TokenCredentials"];
663
678
  sso: components["schemas"]["AuthAPI_Login_SSOCredentials"];
664
- expiration: string; /** Format: enum */
679
+ expiration: string;
680
+ /** Format: enum */
665
681
  requestedRole: number;
666
682
  };
667
683
  AuthAPI_Login_Response: {
668
- token: string; /** Format: bytes */
669
- sessionId: string; /** Format: enum */
684
+ token: string;
685
+ /** Format: bytes */
686
+ sessionId: string;
687
+ /** Format: enum */
670
688
  role: number;
671
689
  };
672
690
  /**
@@ -674,22 +692,26 @@ interface components {
674
692
  * endpoint after the desktop completes a PKCE exchange.
675
693
  */
676
694
  AuthAPI_Login_SSOCredentials: {
677
- /** Format: bytes */tokenResponse: string;
695
+ /** Format: bytes */
696
+ tokenResponse: string;
678
697
  };
679
698
  /**
680
699
  * @description TokenCredentials accepts any opaque bearer-style string: a controller
681
700
  * pre-shared secret, an existing Platforma JWT, or a future OIDC id-token.
682
701
  */
683
702
  AuthAPI_Login_TokenCredentials: {
684
- /** Format: bytes */token: string;
703
+ /** Format: bytes */
704
+ token: string;
685
705
  };
686
706
  AuthAPI_MintSignature_Request: {
687
- resourceId: string; /** Format: bytes */
707
+ resourceId: string;
708
+ /** Format: bytes */
688
709
  targetSid: string;
689
710
  color: components["schemas"]["Color"];
690
711
  };
691
712
  AuthAPI_MintSignature_Response: {
692
- resourceId: string; /** Format: bytes */
713
+ resourceId: string;
714
+ /** Format: bytes */
693
715
  resourceSignature: string;
694
716
  };
695
717
  AuthAPI_RefreshToken_Request: {
@@ -697,22 +719,27 @@ interface components {
697
719
  expiration: string;
698
720
  };
699
721
  AuthAPI_RefreshToken_Response: {
700
- token: string; /** Format: bytes */
701
- sessionId: string; /** Format: enum */
722
+ token: string;
723
+ /** Format: bytes */
724
+ sessionId: string;
725
+ /** Format: enum */
702
726
  role: number;
703
727
  };
704
728
  AuthAPI_RevokeAccess_Request: {
705
- resourceId: string; /** Format: bytes */
729
+ resourceId: string;
730
+ /** Format: bytes */
706
731
  resourceSignature: string;
707
732
  targetUser: string;
708
733
  };
709
734
  AuthAPI_RevokeAccess_Response: Record<string, never>;
710
735
  AuthAPI_UserRoot: {
711
- resourceId: string; /** Format: bytes */
736
+ resourceId: string;
737
+ /** Format: bytes */
712
738
  resourceSignature: string;
713
739
  };
714
740
  Color: {
715
- root: string; /** Format: uint32 */
741
+ root: string;
742
+ /** Format: uint32 */
716
743
  permissions: number;
717
744
  };
718
745
  Controller: {
@@ -747,7 +774,8 @@ interface components {
747
774
  exists: boolean;
748
775
  };
749
776
  ControllerAPI_GetNotifications_Request: {
750
- controllerType: string; /** Format: uint32 */
777
+ controllerType: string;
778
+ /** Format: uint32 */
751
779
  maxNotifications: number;
752
780
  };
753
781
  ControllerAPI_GetNotifications_Response: {
@@ -801,7 +829,9 @@ interface components {
801
829
  };
802
830
  ControllerAPI_WriteAliasesAndUrls_Response: Record<string, never>;
803
831
  Field: {
804
- /** @description field ID is always combination of parent resource ID and field name */id: components["schemas"]["FieldRef"]; /** Format: enum */
832
+ /** @description field ID is always combination of parent resource ID and field name */
833
+ id: components["schemas"]["FieldRef"];
834
+ /** Format: enum */
805
835
  type: number;
806
836
  features: components["schemas"]["Resource_Features"];
807
837
  /**
@@ -822,7 +852,8 @@ interface components {
822
852
  * Format: enum
823
853
  * @description Whether the value is empty, assigned, or finally resolved.
824
854
  */
825
- valueStatus: number; /** @description If the value is in its final state (ready, duplicate or error) */
855
+ valueStatus: number;
856
+ /** @description If the value is in its final state (ready, duplicate or error) */
826
857
  valueIsFinal: boolean;
827
858
  /**
828
859
  * @description Error resource ID, if any.
@@ -836,37 +867,47 @@ interface components {
836
867
  errorSignature: string;
837
868
  };
838
869
  FieldRef: {
839
- resourceId: string; /** Format: bytes */
870
+ resourceId: string;
871
+ /** Format: bytes */
840
872
  resourceSignature: string;
841
873
  fieldName: string;
842
874
  };
843
875
  FieldSchema: {
844
- /** Format: enum */type: number;
876
+ /** Format: enum */
877
+ type: number;
845
878
  name: string;
846
- }; /** @description Contains an arbitrary serialized message along with a @type that describes the type of the serialized message. */
879
+ };
880
+ /** @description Contains an arbitrary serialized message along with a @type that describes the type of the serialized message. */
847
881
  GoogleProtobufAny: {
848
- /** @description The type of the serialized message. */"@type": string;
882
+ /** @description The type of the serialized message. */
883
+ "@type": string;
849
884
  } & {
850
885
  [key: string]: unknown;
851
886
  };
852
887
  LocksAPI_Lease_Create_Request: {
853
- resourceId: string; /** Format: bytes */
888
+ resourceId: string;
889
+ /** Format: bytes */
854
890
  resourceSignature: string;
855
891
  timeout: string;
856
892
  name: string;
857
893
  };
858
894
  LocksAPI_Lease_Create_Response: {
859
- /** Format: bytes */leaseId: string;
895
+ /** Format: bytes */
896
+ leaseId: string;
860
897
  };
861
898
  LocksAPI_Lease_Release_Request: {
862
- resourceId: string; /** Format: bytes */
863
- resourceSignature: string; /** Format: bytes */
899
+ resourceId: string;
900
+ /** Format: bytes */
901
+ resourceSignature: string;
902
+ /** Format: bytes */
864
903
  leaseId: string;
865
904
  };
866
905
  LocksAPI_Lease_Release_Response: Record<string, never>;
867
906
  LocksAPI_Lease_Update_Request: {
868
- resourceId: string; /** Format: bytes */
869
- resourceSignature: string; /** Format: bytes */
907
+ resourceId: string;
908
+ /** Format: bytes */
909
+ resourceSignature: string;
910
+ /** Format: bytes */
870
911
  leaseId: string;
871
912
  timeout: string;
872
913
  name: string;
@@ -894,12 +935,14 @@ interface components {
894
935
  LocksAPI_LockFieldValues_Create_Response_LockInfo: {
895
936
  targetId: string;
896
937
  fieldName: string;
897
- lockedBy: string; /** Format: date-time */
938
+ lockedBy: string;
939
+ /** Format: date-time */
898
940
  lockedAt: string;
899
941
  comment: string;
900
942
  };
901
943
  MaintenanceAPI_License_Response: {
902
- /** Format: int32 */status: number;
944
+ /** Format: int32 */
945
+ status: number;
903
946
  isOk: boolean;
904
947
  /**
905
948
  * Format: bytes
@@ -909,7 +952,8 @@ interface components {
909
952
  };
910
953
  MaintenanceAPI_Ping_Response: {
911
954
  coreVersion: string;
912
- coreFullVersion: string; /** Format: enum */
955
+ coreFullVersion: string;
956
+ /** Format: enum */
913
957
  compression: number;
914
958
  /**
915
959
  * @description instanceID is a unique ID that changes when we reset DB state.
@@ -958,7 +1002,8 @@ interface components {
958
1002
  txSpan: components["schemas"]["SpanInfo"];
959
1003
  };
960
1004
  NotificationAPI_Get_Request: {
961
- subscription: string; /** Format: uint32 */
1005
+ subscription: string;
1006
+ /** Format: uint32 */
962
1007
  maxNotifications: number;
963
1008
  };
964
1009
  NotificationAPI_Get_Response: {
@@ -977,7 +1022,8 @@ interface components {
977
1022
  resourceReady: boolean;
978
1023
  resourceRecovered: boolean;
979
1024
  resourceDuplicate: boolean;
980
- resourceError: boolean; /** @description Field events */
1025
+ resourceError: boolean;
1026
+ /** @description Field events */
981
1027
  inputsLocked: boolean;
982
1028
  outputsLocked: boolean;
983
1029
  fieldCreated: boolean;
@@ -1024,7 +1070,8 @@ interface components {
1024
1070
  };
1025
1071
  ResourceSchema: {
1026
1072
  type: components["schemas"]["ResourceType"];
1027
- fields: components["schemas"]["FieldSchema"][]; /** @description Access restriction flags for non-controller roles */
1073
+ fields: components["schemas"]["FieldSchema"][];
1074
+ /** @description Access restriction flags for non-controller roles */
1028
1075
  accessFlags: components["schemas"]["ResourceSchema_AccessFlags"];
1029
1076
  freeInputs: boolean;
1030
1077
  freeOutputs: boolean;
@@ -1034,9 +1081,11 @@ interface components {
1034
1081
  * @description Allow-list approach: default = forbidden (false)
1035
1082
  * Controllers set this to true allow non-controller roles (role='u', role='w')
1036
1083
  */
1037
- createResource: boolean; /** @description IMPORTANT: read_fields=false with write_fields=true is a forbidden combination */
1084
+ createResource: boolean;
1085
+ /** @description IMPORTANT: read_fields=false with write_fields=true is a forbidden combination */
1038
1086
  readFields: boolean;
1039
- writeFields: boolean; /** @description IMPORTANT: read_kv=false with write_kv=true is a forbidden combination */
1087
+ writeFields: boolean;
1088
+ /** @description IMPORTANT: read_kv=false with write_kv=true is a forbidden combination */
1040
1089
  readKv: boolean;
1041
1090
  writeKv: boolean;
1042
1091
  /**
@@ -1067,14 +1116,17 @@ interface components {
1067
1116
  carrier: {
1068
1117
  [key: string]: string;
1069
1118
  };
1070
- }; /** @description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */
1119
+ };
1120
+ /** @description The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). */
1071
1121
  Status: {
1072
1122
  /**
1073
1123
  * Format: int32
1074
1124
  * @description The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
1075
1125
  */
1076
- code: number; /** @description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. */
1077
- message: string; /** @description A list of messages that carry the error details. There is a common set of message types for APIs to use. */
1126
+ code: number;
1127
+ /** @description A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. */
1128
+ message: string;
1129
+ /** @description A list of messages that carry the error details. There is a common set of message types for APIs to use. */
1078
1130
  details: components["schemas"]["GoogleProtobufAny"][];
1079
1131
  };
1080
1132
  SubscriptionAPI_AttachFilter_Request: {
@@ -1099,7 +1151,7 @@ interface components {
1099
1151
  headers: never;
1100
1152
  pathItems: never;
1101
1153
  }
1102
- interface operations {
1154
+ export interface operations {
1103
1155
  Platform_GrantAccess: {
1104
1156
  parameters: {
1105
1157
  query?: never;
@@ -1113,14 +1165,16 @@ interface operations {
1113
1165
  };
1114
1166
  };
1115
1167
  responses: {
1116
- /** @description OK */200: {
1168
+ /** @description OK */
1169
+ 200: {
1117
1170
  headers: {
1118
1171
  [name: string]: unknown;
1119
1172
  };
1120
1173
  content: {
1121
1174
  "application/json": components["schemas"]["AuthAPI_GrantAccess_Response"];
1122
1175
  };
1123
- }; /** @description Default error response */
1176
+ };
1177
+ /** @description Default error response */
1124
1178
  default: {
1125
1179
  headers: {
1126
1180
  [name: string]: unknown;
@@ -1144,14 +1198,16 @@ interface operations {
1144
1198
  };
1145
1199
  };
1146
1200
  responses: {
1147
- /** @description OK */200: {
1201
+ /** @description OK */
1202
+ 200: {
1148
1203
  headers: {
1149
1204
  [name: string]: unknown;
1150
1205
  };
1151
1206
  content: {
1152
1207
  "application/json": components["schemas"]["AuthAPI_GetJWTToken_Response"];
1153
1208
  };
1154
- }; /** @description Default error response */
1209
+ };
1210
+ /** @description Default error response */
1155
1211
  default: {
1156
1212
  headers: {
1157
1213
  [name: string]: unknown;
@@ -1175,14 +1231,16 @@ interface operations {
1175
1231
  };
1176
1232
  };
1177
1233
  responses: {
1178
- /** @description OK */200: {
1234
+ /** @description OK */
1235
+ 200: {
1179
1236
  headers: {
1180
1237
  [name: string]: unknown;
1181
1238
  };
1182
1239
  content: {
1183
1240
  "application/json": components["schemas"]["AuthAPI_Login_Response"];
1184
1241
  };
1185
- }; /** @description Default error response */
1242
+ };
1243
+ /** @description Default error response */
1186
1244
  default: {
1187
1245
  headers: {
1188
1246
  [name: string]: unknown;
@@ -1202,14 +1260,16 @@ interface operations {
1202
1260
  };
1203
1261
  requestBody?: never;
1204
1262
  responses: {
1205
- /** @description OK */200: {
1263
+ /** @description OK */
1264
+ 200: {
1206
1265
  headers: {
1207
1266
  [name: string]: unknown;
1208
1267
  };
1209
1268
  content: {
1210
1269
  "application/json": components["schemas"]["AuthAPI_ListMethods_Response"];
1211
1270
  };
1212
- }; /** @description Default error response */
1271
+ };
1272
+ /** @description Default error response */
1213
1273
  default: {
1214
1274
  headers: {
1215
1275
  [name: string]: unknown;
@@ -1233,14 +1293,16 @@ interface operations {
1233
1293
  };
1234
1294
  };
1235
1295
  responses: {
1236
- /** @description OK */200: {
1296
+ /** @description OK */
1297
+ 200: {
1237
1298
  headers: {
1238
1299
  [name: string]: unknown;
1239
1300
  };
1240
1301
  content: {
1241
1302
  "application/json": components["schemas"]["AuthAPI_MintSignature_Response"];
1242
1303
  };
1243
- }; /** @description Default error response */
1304
+ };
1305
+ /** @description Default error response */
1244
1306
  default: {
1245
1307
  headers: {
1246
1308
  [name: string]: unknown;
@@ -1264,14 +1326,16 @@ interface operations {
1264
1326
  };
1265
1327
  };
1266
1328
  responses: {
1267
- /** @description OK */200: {
1329
+ /** @description OK */
1330
+ 200: {
1268
1331
  headers: {
1269
1332
  [name: string]: unknown;
1270
1333
  };
1271
1334
  content: {
1272
1335
  "application/json": components["schemas"]["AuthAPI_RefreshToken_Response"];
1273
1336
  };
1274
- }; /** @description Default error response */
1337
+ };
1338
+ /** @description Default error response */
1275
1339
  default: {
1276
1340
  headers: {
1277
1341
  [name: string]: unknown;
@@ -1295,14 +1359,16 @@ interface operations {
1295
1359
  };
1296
1360
  };
1297
1361
  responses: {
1298
- /** @description OK */200: {
1362
+ /** @description OK */
1363
+ 200: {
1299
1364
  headers: {
1300
1365
  [name: string]: unknown;
1301
1366
  };
1302
1367
  content: {
1303
1368
  "application/json": components["schemas"]["AuthAPI_RevokeAccess_Response"];
1304
1369
  };
1305
- }; /** @description Default error response */
1370
+ };
1371
+ /** @description Default error response */
1306
1372
  default: {
1307
1373
  headers: {
1308
1374
  [name: string]: unknown;
@@ -1326,14 +1392,16 @@ interface operations {
1326
1392
  };
1327
1393
  };
1328
1394
  responses: {
1329
- /** @description OK */200: {
1395
+ /** @description OK */
1396
+ 200: {
1330
1397
  headers: {
1331
1398
  [name: string]: unknown;
1332
1399
  };
1333
1400
  content: {
1334
1401
  "application/json": components["schemas"]["AuthAPI_GetSessionInfo_Response"];
1335
1402
  };
1336
- }; /** @description Default error response */
1403
+ };
1404
+ /** @description Default error response */
1337
1405
  default: {
1338
1406
  headers: {
1339
1407
  [name: string]: unknown;
@@ -1357,14 +1425,16 @@ interface operations {
1357
1425
  };
1358
1426
  };
1359
1427
  responses: {
1360
- /** @description OK */200: {
1428
+ /** @description OK */
1429
+ 200: {
1361
1430
  headers: {
1362
1431
  [name: string]: unknown;
1363
1432
  };
1364
1433
  content: {
1365
1434
  "application/json": components["schemas"]["AuthAPI_BeginSSOLogin_Response"];
1366
1435
  };
1367
- }; /** @description Default error response */
1436
+ };
1437
+ /** @description Default error response */
1368
1438
  default: {
1369
1439
  headers: {
1370
1440
  [name: string]: unknown;
@@ -1388,14 +1458,16 @@ interface operations {
1388
1458
  };
1389
1459
  };
1390
1460
  responses: {
1391
- /** @description OK */200: {
1461
+ /** @description OK */
1462
+ 200: {
1392
1463
  headers: {
1393
1464
  [name: string]: unknown;
1394
1465
  };
1395
1466
  content: {
1396
1467
  "application/json": components["schemas"]["AuthAPI_GetUserRoot_Response"];
1397
1468
  };
1398
- }; /** @description Default error response */
1469
+ };
1470
+ /** @description Default error response */
1399
1471
  default: {
1400
1472
  headers: {
1401
1473
  [name: string]: unknown;
@@ -1419,14 +1491,16 @@ interface operations {
1419
1491
  };
1420
1492
  };
1421
1493
  responses: {
1422
- /** @description OK */200: {
1494
+ /** @description OK */
1495
+ 200: {
1423
1496
  headers: {
1424
1497
  [name: string]: unknown;
1425
1498
  };
1426
1499
  content: {
1427
1500
  "application/json": components["schemas"]["ControllerAPI_WriteAliasesAndUrls_Response"];
1428
1501
  };
1429
- }; /** @description Default error response */
1502
+ };
1503
+ /** @description Default error response */
1430
1504
  default: {
1431
1505
  headers: {
1432
1506
  [name: string]: unknown;
@@ -1450,14 +1524,16 @@ interface operations {
1450
1524
  };
1451
1525
  };
1452
1526
  responses: {
1453
- /** @description OK */200: {
1527
+ /** @description OK */
1528
+ 200: {
1454
1529
  headers: {
1455
1530
  [name: string]: unknown;
1456
1531
  };
1457
1532
  content: {
1458
1533
  "application/json": components["schemas"]["ControllerAPI_RemoveAliasesAndUrls_Response"];
1459
1534
  };
1460
- }; /** @description Default error response */
1535
+ };
1536
+ /** @description Default error response */
1461
1537
  default: {
1462
1538
  headers: {
1463
1539
  [name: string]: unknown;
@@ -1481,14 +1557,16 @@ interface operations {
1481
1557
  };
1482
1558
  };
1483
1559
  responses: {
1484
- /** @description OK */200: {
1560
+ /** @description OK */
1561
+ 200: {
1485
1562
  headers: {
1486
1563
  [name: string]: unknown;
1487
1564
  };
1488
1565
  content: {
1489
1566
  "application/json": components["schemas"]["ControllerAPI_AttachSubscription_Response"];
1490
1567
  };
1491
- }; /** @description Default error response */
1568
+ };
1569
+ /** @description Default error response */
1492
1570
  default: {
1493
1571
  headers: {
1494
1572
  [name: string]: unknown;
@@ -1512,14 +1590,16 @@ interface operations {
1512
1590
  };
1513
1591
  };
1514
1592
  responses: {
1515
- /** @description OK */200: {
1593
+ /** @description OK */
1594
+ 200: {
1516
1595
  headers: {
1517
1596
  [name: string]: unknown;
1518
1597
  };
1519
1598
  content: {
1520
1599
  "application/json": components["schemas"]["ControllerAPI_Create_Response"];
1521
1600
  };
1522
- }; /** @description Default error response */
1601
+ };
1602
+ /** @description Default error response */
1523
1603
  default: {
1524
1604
  headers: {
1525
1605
  [name: string]: unknown;
@@ -1543,14 +1623,16 @@ interface operations {
1543
1623
  };
1544
1624
  };
1545
1625
  responses: {
1546
- /** @description OK */200: {
1626
+ /** @description OK */
1627
+ 200: {
1547
1628
  headers: {
1548
1629
  [name: string]: unknown;
1549
1630
  };
1550
1631
  content: {
1551
1632
  "application/json": components["schemas"]["ControllerAPI_Deregister_Response"];
1552
1633
  };
1553
- }; /** @description Default error response */
1634
+ };
1635
+ /** @description Default error response */
1554
1636
  default: {
1555
1637
  headers: {
1556
1638
  [name: string]: unknown;
@@ -1574,14 +1656,16 @@ interface operations {
1574
1656
  };
1575
1657
  };
1576
1658
  responses: {
1577
- /** @description OK */200: {
1659
+ /** @description OK */
1660
+ 200: {
1578
1661
  headers: {
1579
1662
  [name: string]: unknown;
1580
1663
  };
1581
1664
  content: {
1582
1665
  "application/json": components["schemas"]["ControllerAPI_Exists_Response"];
1583
1666
  };
1584
- }; /** @description Default error response */
1667
+ };
1668
+ /** @description Default error response */
1585
1669
  default: {
1586
1670
  headers: {
1587
1671
  [name: string]: unknown;
@@ -1605,14 +1689,16 @@ interface operations {
1605
1689
  };
1606
1690
  };
1607
1691
  responses: {
1608
- /** @description OK */200: {
1692
+ /** @description OK */
1693
+ 200: {
1609
1694
  headers: {
1610
1695
  [name: string]: unknown;
1611
1696
  };
1612
1697
  content: {
1613
1698
  "application/json": components["schemas"]["ControllerAPI_SetFeatures_Response"];
1614
1699
  };
1615
- }; /** @description Default error response */
1700
+ };
1701
+ /** @description Default error response */
1616
1702
  default: {
1617
1703
  headers: {
1618
1704
  [name: string]: unknown;
@@ -1636,14 +1722,16 @@ interface operations {
1636
1722
  };
1637
1723
  };
1638
1724
  responses: {
1639
- /** @description OK */200: {
1725
+ /** @description OK */
1726
+ 200: {
1640
1727
  headers: {
1641
1728
  [name: string]: unknown;
1642
1729
  };
1643
1730
  content: {
1644
1731
  "application/json": components["schemas"]["ControllerAPI_ClearFeatures_Response"];
1645
1732
  };
1646
- }; /** @description Default error response */
1733
+ };
1734
+ /** @description Default error response */
1647
1735
  default: {
1648
1736
  headers: {
1649
1737
  [name: string]: unknown;
@@ -1667,14 +1755,16 @@ interface operations {
1667
1755
  };
1668
1756
  };
1669
1757
  responses: {
1670
- /** @description OK */200: {
1758
+ /** @description OK */
1759
+ 200: {
1671
1760
  headers: {
1672
1761
  [name: string]: unknown;
1673
1762
  };
1674
1763
  content: {
1675
1764
  "application/json": components["schemas"]["ControllerAPI_Get_Response"];
1676
1765
  };
1677
- }; /** @description Default error response */
1766
+ };
1767
+ /** @description Default error response */
1678
1768
  default: {
1679
1769
  headers: {
1680
1770
  [name: string]: unknown;
@@ -1698,14 +1788,16 @@ interface operations {
1698
1788
  };
1699
1789
  };
1700
1790
  responses: {
1701
- /** @description OK */200: {
1791
+ /** @description OK */
1792
+ 200: {
1702
1793
  headers: {
1703
1794
  [name: string]: unknown;
1704
1795
  };
1705
1796
  content: {
1706
1797
  "application/json": components["schemas"]["ControllerAPI_GetNotifications_Response"];
1707
1798
  };
1708
- }; /** @description Default error response */
1799
+ };
1800
+ /** @description Default error response */
1709
1801
  default: {
1710
1802
  headers: {
1711
1803
  [name: string]: unknown;
@@ -1729,14 +1821,16 @@ interface operations {
1729
1821
  };
1730
1822
  };
1731
1823
  responses: {
1732
- /** @description OK */200: {
1824
+ /** @description OK */
1825
+ 200: {
1733
1826
  headers: {
1734
1827
  [name: string]: unknown;
1735
1828
  };
1736
1829
  content: {
1737
1830
  "application/json": components["schemas"]["ControllerAPI_Register_Response"];
1738
1831
  };
1739
- }; /** @description Default error response */
1832
+ };
1833
+ /** @description Default error response */
1740
1834
  default: {
1741
1835
  headers: {
1742
1836
  [name: string]: unknown;
@@ -1760,14 +1854,16 @@ interface operations {
1760
1854
  };
1761
1855
  };
1762
1856
  responses: {
1763
- /** @description OK */200: {
1857
+ /** @description OK */
1858
+ 200: {
1764
1859
  headers: {
1765
1860
  [name: string]: unknown;
1766
1861
  };
1767
1862
  content: {
1768
1863
  "application/json": components["schemas"]["ControllerAPI_Update_Response"];
1769
1864
  };
1770
- }; /** @description Default error response */
1865
+ };
1866
+ /** @description Default error response */
1771
1867
  default: {
1772
1868
  headers: {
1773
1869
  [name: string]: unknown;
@@ -1791,14 +1887,16 @@ interface operations {
1791
1887
  };
1792
1888
  };
1793
1889
  responses: {
1794
- /** @description OK */200: {
1890
+ /** @description OK */
1891
+ 200: {
1795
1892
  headers: {
1796
1893
  [name: string]: unknown;
1797
1894
  };
1798
1895
  content: {
1799
1896
  "application/json": components["schemas"]["ControllerAPI_GetUrl_Response"];
1800
1897
  };
1801
- }; /** @description Default error response */
1898
+ };
1899
+ /** @description Default error response */
1802
1900
  default: {
1803
1901
  headers: {
1804
1902
  [name: string]: unknown;
@@ -1818,14 +1916,16 @@ interface operations {
1818
1916
  };
1819
1917
  requestBody?: never;
1820
1918
  responses: {
1821
- /** @description OK */200: {
1919
+ /** @description OK */
1920
+ 200: {
1822
1921
  headers: {
1823
1922
  [name: string]: unknown;
1824
1923
  };
1825
1924
  content: {
1826
1925
  "application/json": components["schemas"]["MaintenanceAPI_License_Response"];
1827
1926
  };
1828
- }; /** @description Default error response */
1927
+ };
1928
+ /** @description Default error response */
1829
1929
  default: {
1830
1930
  headers: {
1831
1931
  [name: string]: unknown;
@@ -1849,14 +1949,16 @@ interface operations {
1849
1949
  };
1850
1950
  };
1851
1951
  responses: {
1852
- /** @description OK */200: {
1952
+ /** @description OK */
1953
+ 200: {
1853
1954
  headers: {
1854
1955
  [name: string]: unknown;
1855
1956
  };
1856
1957
  content: {
1857
1958
  "application/json": components["schemas"]["LocksAPI_Lease_Create_Response"];
1858
1959
  };
1859
- }; /** @description Default error response */
1960
+ };
1961
+ /** @description Default error response */
1860
1962
  default: {
1861
1963
  headers: {
1862
1964
  [name: string]: unknown;
@@ -1880,14 +1982,16 @@ interface operations {
1880
1982
  };
1881
1983
  };
1882
1984
  responses: {
1883
- /** @description OK */200: {
1985
+ /** @description OK */
1986
+ 200: {
1884
1987
  headers: {
1885
1988
  [name: string]: unknown;
1886
1989
  };
1887
1990
  content: {
1888
1991
  "application/json": components["schemas"]["LocksAPI_Lease_Release_Response"];
1889
1992
  };
1890
- }; /** @description Default error response */
1993
+ };
1994
+ /** @description Default error response */
1891
1995
  default: {
1892
1996
  headers: {
1893
1997
  [name: string]: unknown;
@@ -1911,14 +2015,16 @@ interface operations {
1911
2015
  };
1912
2016
  };
1913
2017
  responses: {
1914
- /** @description OK */200: {
2018
+ /** @description OK */
2019
+ 200: {
1915
2020
  headers: {
1916
2021
  [name: string]: unknown;
1917
2022
  };
1918
2023
  content: {
1919
2024
  "application/json": components["schemas"]["LocksAPI_Lease_Update_Response"];
1920
2025
  };
1921
- }; /** @description Default error response */
2026
+ };
2027
+ /** @description Default error response */
1922
2028
  default: {
1923
2029
  headers: {
1924
2030
  [name: string]: unknown;
@@ -1942,14 +2048,16 @@ interface operations {
1942
2048
  };
1943
2049
  };
1944
2050
  responses: {
1945
- /** @description OK */200: {
2051
+ /** @description OK */
2052
+ 200: {
1946
2053
  headers: {
1947
2054
  [name: string]: unknown;
1948
2055
  };
1949
2056
  content: {
1950
2057
  "application/json": components["schemas"]["LocksAPI_LockFieldValues_Create_Response"];
1951
2058
  };
1952
- }; /** @description Default error response */
2059
+ };
2060
+ /** @description Default error response */
1953
2061
  default: {
1954
2062
  headers: {
1955
2063
  [name: string]: unknown;
@@ -1973,14 +2081,16 @@ interface operations {
1973
2081
  };
1974
2082
  };
1975
2083
  responses: {
1976
- /** @description OK */200: {
2084
+ /** @description OK */
2085
+ 200: {
1977
2086
  headers: {
1978
2087
  [name: string]: unknown;
1979
2088
  };
1980
2089
  content: {
1981
2090
  "application/json": components["schemas"]["NotificationAPI_Get_Response"];
1982
2091
  };
1983
- }; /** @description Default error response */
2092
+ };
2093
+ /** @description Default error response */
1984
2094
  default: {
1985
2095
  headers: {
1986
2096
  [name: string]: unknown;
@@ -2000,14 +2110,16 @@ interface operations {
2000
2110
  };
2001
2111
  requestBody?: never;
2002
2112
  responses: {
2003
- /** @description OK */200: {
2113
+ /** @description OK */
2114
+ 200: {
2004
2115
  headers: {
2005
2116
  [name: string]: unknown;
2006
2117
  };
2007
2118
  content: {
2008
2119
  "application/json": components["schemas"]["MaintenanceAPI_Ping_Response"];
2009
2120
  };
2010
- }; /** @description Default error response */
2121
+ };
2122
+ /** @description Default error response */
2011
2123
  default: {
2012
2124
  headers: {
2013
2125
  [name: string]: unknown;
@@ -2027,14 +2139,16 @@ interface operations {
2027
2139
  };
2028
2140
  requestBody?: never;
2029
2141
  responses: {
2030
- /** @description OK */200: {
2142
+ /** @description OK */
2143
+ 200: {
2031
2144
  headers: {
2032
2145
  [name: string]: unknown;
2033
2146
  };
2034
2147
  content: {
2035
2148
  "application/json": components["schemas"]["MiscAPI_ListResourceTypes_Response"];
2036
2149
  };
2037
- }; /** @description Default error response */
2150
+ };
2151
+ /** @description Default error response */
2038
2152
  default: {
2039
2153
  headers: {
2040
2154
  [name: string]: unknown;
@@ -2058,14 +2172,16 @@ interface operations {
2058
2172
  };
2059
2173
  };
2060
2174
  responses: {
2061
- /** @description OK */200: {
2175
+ /** @description OK */
2176
+ 200: {
2062
2177
  headers: {
2063
2178
  [name: string]: unknown;
2064
2179
  };
2065
2180
  content: {
2066
2181
  "application/json": components["schemas"]["SubscriptionAPI_AttachFilter_Response"];
2067
2182
  };
2068
- }; /** @description Default error response */
2183
+ };
2184
+ /** @description Default error response */
2069
2185
  default: {
2070
2186
  headers: {
2071
2187
  [name: string]: unknown;
@@ -2089,14 +2205,16 @@ interface operations {
2089
2205
  };
2090
2206
  };
2091
2207
  responses: {
2092
- /** @description OK */200: {
2208
+ /** @description OK */
2209
+ 200: {
2093
2210
  headers: {
2094
2211
  [name: string]: unknown;
2095
2212
  };
2096
2213
  content: {
2097
2214
  "application/json": components["schemas"]["SubscriptionAPI_DetachFilter_Response"];
2098
2215
  };
2099
- }; /** @description Default error response */
2216
+ };
2217
+ /** @description Default error response */
2100
2218
  default: {
2101
2219
  headers: {
2102
2220
  [name: string]: unknown;
@@ -2120,14 +2238,16 @@ interface operations {
2120
2238
  };
2121
2239
  };
2122
2240
  responses: {
2123
- /** @description OK */200: {
2241
+ /** @description OK */
2242
+ 200: {
2124
2243
  headers: {
2125
2244
  [name: string]: unknown;
2126
2245
  };
2127
2246
  content: {
2128
2247
  "application/json": components["schemas"]["TxAPI_Sync_Response"];
2129
2248
  };
2130
- }; /** @description Default error response */
2249
+ };
2250
+ /** @description Default error response */
2131
2251
  default: {
2132
2252
  headers: {
2133
2253
  [name: string]: unknown;
@@ -2140,5 +2260,4 @@ interface operations {
2140
2260
  };
2141
2261
  }
2142
2262
  //#endregion
2143
- export { components, operations, paths };
2144
2263
  //# sourceMappingURL=plapi.d.ts.map