From bf48ea7e0077fcfad2da5dba3103fee9b97c27c7 Mon Sep 17 00:00:00 2001 From: akimrx Date: Sun, 24 Mar 2024 13:43:19 +0300 Subject: [PATCH] docs: updated sphinx docs --- docs/_modules/yc_lockbox/_models.html | 25 ++- docs/_sources/pages/models.rst.txt | 23 +++ docs/genindex.html | 68 ++++++-- docs/index.html | 7 + docs/objects.inv | Bin 960 -> 1115 bytes docs/pages/clients.html | 24 +-- docs/pages/models.html | 228 ++++++++++++++++++++++++-- docs/searchindex.js | 2 +- docs_src/source/pages/models.rst | 23 +++ 9 files changed, 360 insertions(+), 40 deletions(-) diff --git a/docs/_modules/yc_lockbox/_models.html b/docs/_modules/yc_lockbox/_models.html index 19f2dcd..1c1b895 100644 --- a/docs/_modules/yc_lockbox/_models.html +++ b/docs/_modules/yc_lockbox/_models.html @@ -227,9 +227,12 @@

Source code for yc_lockbox._models

     model_config: ConfigDict = ConfigDict(extra="forbid", populate_by_name=True)
 
 
+

+[docs]
 class IamTokenResponse(BaseDomainModel):
     token: str = Field(..., alias="iamToken")
-    expires_at: datetime = Field(..., alias="expiresAt")
+    expires_at: datetime = Field(..., alias="expiresAt")

+
 
 
 

@@ -535,20 +538,31 @@ 
Source code for yc_lockbox._models
     next_page_token: str | None = Field(None, alias="nextPageToken")
 
 
+

+[docs]
 class SecretsList(BasePaginatedResponse):
-    secrets: list[Secret] = []
+    secrets: list[Secret] = []

+
 
 
+

+[docs]
 class SecretVersionsList(BasePaginatedResponse):
-    versions: list[SecretVersion] = []
+    versions: list[SecretVersion] = []

+
 
 
+

+[docs]
 class YandexCloudError(BaseDomainModel):
     code: int
     message: str | None = None
-    details: Any = None
+    details: Any = None

 
 
+
+

+[docs]
 class Operation(BaseDomainModel):
     id: str
     done: bool = False
@@ -587,7 +601,8 @@ 
Source code for yc_lockbox._models
 
         if self.client is not None:
             resource.inject_client(self.client)
-        return resource
+        return resource

+
 

         
       

diff --git a/docs/_sources/pages/models.rst.txt b/docs/_sources/pages/models.rst.txt
index 2ce7d97..8fd1d43 100644
--- a/docs/_sources/pages/models.rst.txt
+++ b/docs/_sources/pages/models.rst.txt
@@ -16,6 +16,17 @@ Domain models provide complete information about the resource, similar to aggreg
 .. autopydantic_model:: yc_lockbox._models.SecretPayloadEntry
 
 
+Paginated models
+^^^^^^^^^^^^^^^^
+
+Used when ``iterator=False``.
+
+.. autopydantic_model:: yc_lockbox._models.SecretsList
+
+.. autopydantic_model:: yc_lockbox._models.SecretVersionsList
+
+
+
 Upsert models
 -------------
 
@@ -28,3 +39,15 @@ Upsert models (interfaces) are designed for operations of creating new resources
 .. autopydantic_model:: yc_lockbox._models.INewSecretPayloadEntry
 
 .. autopydantic_model:: yc_lockbox._models.IUpdateSecret
+
+
+Common models
+-------------
+
+Other Yandex Cloud models related to Lockbox.
+
+.. autopydantic_model:: yc_lockbox._models.Operation
+
+.. autopydantic_model:: yc_lockbox._models.YandexCloudError
+
+.. autopydantic_model:: yc_lockbox._models.IamTokenResponse
\ No newline at end of file
diff --git a/docs/genindex.html b/docs/genindex.html
index dfc95fb..1e6fd2c 100644
--- a/docs/genindex.html
+++ b/docs/genindex.html
@@ -197,7 +197,7 @@
           
 

   
Index

-  
A | B | C | D | E | F | G | I | K | L | N | P | R | S | T | U | V | Y

+  
A | B | C | D | E | F | G | I | K | L | M | N | P | R | S | T | U | V | Y

 

 

   
A

@@ -251,16 +251,22 @@ 
C

           
  • (yc_lockbox._models.SecretVersion method)
 
    • 
         
-    
-    
+    
@@ -287,21 +293,27 @@ 
    D
    
           
  • (yc_lockbox._models.Secret attribute)
 
    • 
         
-    
-    
+    
   
@@ -312,6 +324,12 @@ 
    E
    
   
+    
    
     
   
    
@@ -353,9 +371,11 @@ 
    G
    
   
    I
    
   
    
     
    
 
    
 
+
    
+  
    M
    
+  
+    
+    
+  
    
+
    
+
 
    
   
    N
    
   
@@ -454,9 +490,13 @@ 
    R
    
   
    
+    
    
     
     
+        
  • secret_id (yc_lockbox._models.SecretVersion attribute)
+
    • 
         		
     
     
   
    
 
    
 
@@ -531,11 +577,13 @@ 
    V
    
     
-    
+    
   
diff --git a/docs/index.html b/docs/index.html
index c2d2943..a8f4d6d 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -405,6 +405,7 @@ 
    Modules#<
 
  • SecretVersion
    • 
 
  • SecretPayload
    • 
 
  • SecretPayloadEntry
    • 
+
  • Paginated models
    • 
 
 
 
  • Upsert models
 
    • 
+
  • Common models
+
    • 
 
 
 
  • Exceptions
    • 
diff --git a/docs/objects.inv b/docs/objects.inv
index 92a8804cd9185b338ed55008cb89adbbe6110ebc..fb52c6211f97baabfcc53d87bcd1c32bec68ba0e 100644
GIT binary patch
delta 1008
zcmVPr-Eo5eToXQ2mO)O
z?{%D-OuTy^-EFFifS6FjkHkQtfhwqh8JJYE+lh~BH8R~zQR3zjHaJXIWGn_w(-c@KVBLkKVMPy?1w&n7J>Ein6Bh@=S03!oTXunI
zh7H@KFra1!*MB!~Zs~H8B}N`#uFJ36@$M#3mz^>AP9|;m)A93H`1{hjyQmn+4X3`f
zRXFsW)OW=3Vbx81YfA&|yl>gB90a?Wt*PP#D)UteyR{~qp%D+6P7Y9EA_dvmH)yz=
zWPk?i1Uhu*H0-bkCUzn#4rqqhdhC;>R#*$5%ZzQXBY&z&jzpBOhSIT}XRB}xoD8no
zzs?ykhM5B{-VqJ$UW>Ql8vF{Ax7VspixSJbs1?Hb0FPzg9u_5D_J{}}v&Rd$
zQAYG(A(mu6T&D3IbYT-?Sm^u#ErwIU73hQ*Ts7l1J-VIwtvO{Z8*_^Z$5ys@uw&w`
z!Xl!rn12pZ=77ZlrKG}wEsf`AlFh+wnr{diPcm-BF{g@MWwKNhCeI;rN#js3TQiKk
zBm}#rcr$StngL<#LRsy4PN;ufcRrtiMT#8_u2jlq2Hg=aW}d5Pi$>}TXUh?oSp{}F
zfqOU%G$ahx`4TZ#YEZ7EcA-RfJ!yHm6+mxSPk*mxD0sCYHC@DL%Y)c)M;l^F9QXO0
zbcr_Gv$dCQ8UYof9FO|Q{bY4>HU{g|iCv3WwGOdH4Pt_+;0Qz{L%kQetjF$`I8ew~
zRTIRDNx$Z>PVUpvQBxrF63hr|l&p}I#fb%j5)p=Py49x2r4JfY(Y1EBmhZ2SaIK5C
zbAJY+{%rFf#N}G^;%+{*R8ceyy=tA?)7v%kmsO8Kmh5R%JeaNCkQP(>9#=sdIt<|g
zdDw9VT3g{6)IH?fK_YF~eVxX;tHI`N-7k7}KR4%YOj6gW)59wgh1fV_~{%$mgz==ZP|FkfYI=6Yjr}lZ%_03qY<1=R$*XKhdcYmNB;n{Nk
eF=_Bh&$1ebqG?~yzw~I2^ylyRT9}WwY8nFiDNczGOAsf%(kZ
z=O!;~DL;J7)+_feAg9cV1GPX5FbyrR1Y0P6KaukUBL~n%sDBCr+Sq~=K)ELdT&-0N
z+Pb@ej8+WfnWBV)vAXdlK~dVHQ7y{>-&-6cVDfg}nhU^4O`TMfBS57vJ(V&B#*nS3
zxTtmpnI4uX4QmM-oR%vx76WHk0lbm0?8Y*%pa+|pqwcT~Z>GK^#KH8IM}K+GDKO3O
zVVl+#^v%Kb4S!tNx`LL(sy*E5^6O5#^(5+jXPmvKR6hKf{P_p`ed*m@J5DPrSRCyY
zPID*qz2L;K8Wz5{rGVV9vmi8(yf1jhO1}^
zXs|(`Lw8QcPG=zT3t0<5GsGrhpFGuJZGa&&_rZ>8M}H1fHn4=!xnF0Ca4j4yuG+s&
z88L>L6E5FU1N~Wxx8pke0*kssh#1m3RH%I4sidzb&5w!+^mdcudWMEq4W^jI=&N|_
zxMM7}4UYTb(J@Dx&B@wx4~>M%QL>mZayQw8xEX_$9AcLYi-n+Mi)-DRPtF}wBJ@8qWBEgyHieF9_q3gtJ%`KHX&P57Od8CHJ=82UQL~Nnrm3>n
zan1bnrt}x>KaQ1GVB&?fTXzGI_+16tr&mYS>DJrdXZvQT#Mw|3e(Y{L$=I}>5=Client#
 
 
    Return type:
    
-
    Operation | YandexCloudError
    
+
    Operation | YandexCloudError
    
 
    
 
 
@@ -288,7 +288,7 @@ 
    Client#
 
 
    Return type:
    
-
    Operation | YandexCloudError
    
+
    Operation | YandexCloudError
    
 
    
 
 
@@ -313,7 +313,7 @@ 
    Client#
 
 
    Return type:
    
-
    Operation | YandexCloudError
    
+
    Operation | YandexCloudError
    
 
    
 
 
@@ -331,7 +331,7 @@ 
    Client#
 
 
    Return type:
    
-
    Operation | YandexCloudError
    
+
    Operation | YandexCloudError
    
 
    
 
 
@@ -349,7 +349,7 @@ 
    Client#
 
 
    Return type:
    
-
    Operation | YandexCloudError
    
+
    Operation | YandexCloudError
    
 
    
 
 
@@ -367,7 +367,7 @@ 
    Client#
 
 
    Return type:
    
-
    Operation | YandexCloudError
    
+
    Operation | YandexCloudError
    
 
    
 
 
@@ -385,7 +385,7 @@ 
    Client#
 
 
    Return type:
    
-
    Secret | YandexCloudError
    
+
    Secret | YandexCloudError
    
 
    
 
 
@@ -404,7 +404,7 @@ 
    Client#
 
 
    Return type:
    
-
    SecretPayload | YandexCloudError
    
+
    SecretPayload | YandexCloudError
    
 
    
 
 
@@ -441,7 +441,7 @@ 
    Client#
 
 
    Return type:
    
-
    Union[SecretVersionsList, Iterator[SecretVersion], YandexCloudError]
    
+
    Union[SecretVersionsList, Iterator[SecretVersion], YandexCloudError]
    
 
    
 
 
@@ -466,7 +466,7 @@ 
    Client#
 
 
    Return type:
    
-
    Union[SecretsList, Iterator[Secret], YandexCloudError]
    
+
    Union[SecretsList, Iterator[Secret], YandexCloudError]
    
 
    
 
 
@@ -488,7 +488,7 @@ 
    Client#
 
 
    Return type:
    
-
    Operation | YandexCloudError
    
+
    Operation | YandexCloudError
    
 
    
 
 
@@ -520,7 +520,7 @@ 
    Client#
 
 
    Return type:
    
-
    Operation | YandexCloudError
    
+
    Operation | YandexCloudError
    
 
    
 
 
diff --git a/docs/pages/models.html b/docs/pages/models.html
index 857d8a6..1a91bb3 100644
--- a/docs/pages/models.html
+++ b/docs/pages/models.html
@@ -308,7 +308,7 @@ 
    Domain models
 
    Return type:
    
-
    Union[Operation, YandexCloudError]
    
+
    Union[Operation, YandexCloudError]
    
 
    
 
 
@@ -319,7 +319,7 @@ 
    Domain models
 
    Return type:
    
-
    Union[Operation, YandexCloudError]
    
+
    Union[Operation, YandexCloudError]
    
 
    
 
 
@@ -330,7 +330,7 @@ 
    Domain models
 
    Return type:
    
-
    Union[Operation, YandexCloudError]
    
+
    Union[Operation, YandexCloudError]
    
 
    
 
 
@@ -341,7 +341,7 @@ 
    Domain models
 
    Return type:
    
-
    Union[Operation, YandexCloudError]
    
+
    Union[Operation, YandexCloudError]
    
 
    
 
 
@@ -352,7 +352,7 @@ 
    Domain models
 
    Return type:
    
-
    Union[Operation, YandexCloudError]
    
+
    Union[Operation, YandexCloudError]
    
 
    
 
 
@@ -363,7 +363,7 @@ 
    Domain models
 
    Return type:
    
-
    Union[SecretVersionsList, Iterator[SecretVersion], YandexCloudError]
    
+
    Union[SecretVersionsList, Iterator[SecretVersion], YandexCloudError]
    
 
    
 
 
@@ -373,7 +373,7 @@ 
    Domain modelspayload(version_id=None, **kwargs)[source]#
 
    
 
    Return type:
    
-
    Union[Operation, YandexCloudError]
    
+
    Union[Operation, YandexCloudError]
    
 
    
 
    
 
    
@@ -395,7 +395,7 @@ 
    Domain models
 
    Return type:
    
-
    Union[Operation, YandexCloudError]
    
+
    Union[Operation, YandexCloudError]
    
 
    
 
 
@@ -406,7 +406,7 @@ 
    Domain models
 
    Return type:
    
-
    Union[Operation, YandexCloudError]
    
+
    Union[Operation, YandexCloudError]
    
 
    
 
 
@@ -472,7 +472,7 @@ 
    Domain models
 
    Return type:
    
-
    Union[Operation, YandexCloudError]
    
+
    Union[Operation, YandexCloudError]
    
 
    
 
 
@@ -483,7 +483,7 @@ 
    Domain models
 
    Return type:
    
-
    Union[SecretPayload, YandexCloudError]
    
+
    Union[SecretPayload, YandexCloudError]
    
 
    
 
 
@@ -494,7 +494,7 @@ 
    Domain models
 
    Return type:
    
-
    Union[Operation, YandexCloudError]
    
+
    Union[Operation, YandexCloudError]
    
 
    
 
 
@@ -594,6 +594,44 @@ 
    Domain models
+
    Paginated models#
    
+
    Used when iterator=False.
    
+
    
+
    
+pydantic model yc_lockbox._models.SecretsList[source]#
    
+
    
+
    Fields:
    
+
    
+
    
+
    
+
    
+
    
+field secrets: list[Secret] = []#
    
+
    
+
+
    
+
+
    
+
    
+pydantic model yc_lockbox._models.SecretVersionsList[source]#
    
+
    
+
    Fields:
    
+
    
+
    
+
    
+
    
+
    
+field versions: list[SecretVersion] = []#
    
+
    
+
+
    
+
+
 
 
    
 
    Upsert models#
    
@@ -757,6 +795,134 @@ 
    Upsert models
+
    Common models#
    
+
    Other Yandex Cloud models related to Lockbox.
    
+
    
+
    
+pydantic model yc_lockbox._models.Operation[source]#
    
+
    
+
    Fields:
    
+
    
+
    
+
    
+
    
+
    
+field created_at: datetime | None = None (alias 'createdAt')#
    
+
    
+
+
    
+
    
+field created_by: str | None = None (alias 'createdBy')#
    
+
    
+
+
    
+
    
+field description: str | None = None#
    
+
    
+
+
    
+
    
+field done: bool = False#
    
+
    
+
+
    
+
    
+field error: Any = None#
    
+
    
+
+
    
+
    
+field id: str [Required]#
    
+
    
+
+
    
+
    
+field metadata: Union[dict[str, str], Any] = None#
    
+
    
+
+
    
+
    
+field modified_at: datetime | None = None (alias 'modifiedAt')#
    
+
    
+
+
    
+
    
+field response: Any = None#
    
+
    
+
+
    
+
    
+property resource: T | None#
    
+
    Returns response from operation if possible.
+Otherwise returns None.
    
+
    
+
+
    
+
+
    
+
    
+pydantic model yc_lockbox._models.YandexCloudError[source]#
    
+
    
+
    Fields:
    
+
    
+
    
+
    
+
    
+
    
+field code: int [Required]#
    
+
    
+
+
    
+
    
+field details: Any = None#
    
+
    
+
+
    
+
    
+field message: str | None = None#
    
+
    
+
+
    
+
+
    
+
    
+pydantic model yc_lockbox._models.IamTokenResponse[source]#
    
+
    
+
    Fields:
    
+
    
+
    
+
    
+
    
+
    
+field expires_at: datetime [Required] (alias 'expiresAt')#
    
+
    
+
+
    
+
    
+field token: str [Required] (alias 'iamToken')#
    
+
    
+
+
    
+
 
    
 
 
@@ -867,6 +1033,17 @@ 
    Upsert modelsSecretPayloadEntry.reveal_text_value()
 
 
+
  • Paginated models
+
    • 
 
 
 
  • Upsert models
 
    • 
 
diff --git a/docs/searchindex.js b/docs/searchindex.js
index 90188a0..90aabf6 100644
--- a/docs/searchindex.js
+++ b/docs/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["index", "pages/abstracts", "pages/adapters", "pages/clients", "pages/exceptions", "pages/models"], "filenames": ["index.rst", "pages/abstracts.rst", "pages/adapters.rst", "pages/clients.rst", "pages/exceptions.rst", "pages/models.rst"], "titles": ["Yandex Lockbox Python client documentation", "Abstracts", "Adapters", "Client", "Exceptions", "Models & objects"], "terms": {"releas": 0, "v": 0, "0": [0, 3], "1": 0, "thi": [0, 3, 5], "librari": 0, "i": [0, 3, 5], "simpl": [0, 3], "work": [0, 3], "over": 0, "rest": [0, 3], "api": [0, 3], "simplifi": 0, "allow": [0, 3], "you": [0, 3], "them": 0, "oop": 0, "paradigm": 0, "support": 0, "3": 0, "10": 0, "11": 0, "12": 0, "depend": 0, "pydanticv2": 0, "crypthographi": 0, "pyjwt": 0, "request": [0, 3], "current": [0, 5], "follow": 0, "ar": [0, 3, 5], "list": [0, 3, 5], "access": 0, "bind": 0, "set": [0, 3], "updat": [0, 3, 5], "pip": 0, "yc": [0, 3], "also": [0, 5], "can": [0, 3], "sourc": [0, 3, 5], "git": 0, "clone": 0, "http": [0, 3], "github": 0, "com": 0, "akimrx": 0, "cd": 0, "make": [0, 3], "authent": [0, 3], "via": [0, 3], "your": [0, 3], "oauth": [0, 3], "token": [0, 3], "yc_lockbox": [0, 3, 5], "import": [0, 3], "yandexlockboxcli": [0, 3], "y0_xxxxxxxxxxxx": 0, "iam": [0, 3], "If": [0, 3], "pass": [0, 3], "credenti": [0, 3], "need": [0, 3], "take": [0, 3], "care": [0, 3], "fresh": [0, 3], "yourself": [0, 3], "t1": 0, "xxxxxx": 0, "xxxxxxx": 0, "us": [0, 3, 5], "servic": [0, 3], "account": [0, 3], "kei": [0, 3, 5], "json": [0, 3], "open": [0, 3], "path": [0, 3], "r": [0, 3], "keyfil": 0, "read": 0, "inewsecret": [0, 3, 5], "inewsecretpayloadentri": [0, 5], "oauth_or_iam_token": 0, "create_secret_oper": 0, "create_secret": [0, 3], "folder_id": [0, 3, 5], "b1xxxxxxxxxxxxxx": 0, "name": [0, 3, 5], "my": [0, 3, 5], "version_payload_entri": [0, 5], "secret_entry_1": 0, "text_valu": [0, 5], "secret_entry_text_valu": 0, "secret_entry_2": 0, "binary_valu": [0, 5], "secret_entry_binary_valu": 0, "encod": 0, "done": [0, 5], "new_secret": 0, "resourc": [0, 3, 5], "print": [0, 3, 5], "id": [0, 3, 5], "deactiv": [0, 3, 5], "get_secret": [0, 3], "e6qxxxxxxxxxx": 0, "statu": [0, 3, 5], "payload": [0, 3, 5], "version_id": [0, 3, 5], "current_vers": [0, 5], "option": [0, 3, 5], "default": [0, 3, 5], "entri": [0, 3, 5], "secretpayloadentri": [0, 5], "object": [0, 3], "direct": 0, "return": [0, 3, 5], "mask": [0, 3, 5], "valu": [0, 3, 5], "like": [0, 3, 5], "reveal_text_valu": [0, 3, 5], "similar": [0, 3, 5], "get_secret_valu": 0, "inewsecretvers": [0, 3, 5], "e6qxxxxxxxxxxxx": 0, "add_vers": [0, 5], "descript": [0, 3, 5], "base_version_id": [0, 5], "payload_entri": [0, 5], "altern": 0, "add_secret_vers": [0, 3], "secret_id": [0, 3, 5], "list_secret": [0, 3], "b1xxxxxxxxxx": 0, "iter": [0, 3, 5], "true": [0, 3, 5], "activ": [0, 3, 5], "list_vers": [0, 5], "schedule_version_destruct": [0, 5], "cancel_version_destruct": [0, 5], "activate_secret": [0, 3], "auth_head": [0, 3], "cancel_secret_version_destruct": [0, 3], "deactivate_secret": [0, 3], "delete_secret": [0, 3], "get_secret_payload": [0, 3], "list_secret_access_bind": [0, 3], "list_secret_oper": [0, 3], "list_secret_vers": [0, 3], "schedule_secret_version_destruct": [0, 3], "set_secret_access_bind": [0, 3], "update_secret": [0, 3], "update_secret_access_bind": [0, 3], "yandexauthcli": [0, 3], "adapt": [0, 3], "get_iam_token": [0, 3], "model": 0, "domain": 0, "secretvers": [0, 3, 5], "secretpayload": [0, 3, 5], "upsert": 0, "iupdatesecret": [0, 3, 5], "except": [0, 3], "abstract": 0, "index": 0, "come": [1, 2, 4], "soon": [1, 2, 4], "class": 3, "auth_client": 3, "_auth": 3, "_adapt": 3, "httpadapt": 3, "lockbox_base_url": 3, "none": [3, 5], "payload_lockbox_base_url": 3, "base": 3, "abstractyandexlockboxcli": 3, "yandex": 3, "lockbox": [3, 5], "secret": [3, 5], "vault": 3, "paramet": [3, 5], "type": [3, 5], "abstractyandexauthcli": 3, "implement": 3, "abstracthttpadapt": 3, "commun": 3, "cloud": 3, "str": [3, 5], "url": 3, "without": 3, "auth_base_url": 3, "all": [3, 5], "e": 3, "look": 3, "To": 3, "get": [3, 5], "real": [3, 5], "call": [3, 5], "inject": 3, "method": [3, 5], "reveal_binary_valu": [3, 5], "usag": [3, 5], "from": [3, 5], "y0_agaexxxxxxxxxxxxxxxxxxxxxxxxx": 3, "e6xxxxxxxxxxxxxxxx": 3, "try": 3, "mykei": 3, "keyerror": 3, "invalid": 3, "foo": 3, "exist": [3, 5], "rais": 3, "gener": 3, "sa": 3, "creat": [3, 5], "output": 3, "infil": 3, "load": 3, "raise_for_statu": 3, "specifi": [3, 5], "indentifi": 3, "bool": [3, 5], "fals": [3, 5], "yandexclouderror": [3, 5], "instead": 3, "throw": 3, "oper": [3, 5], "version": [3, 5], "add": [3, 5], "new": [3, 5], "previou": 3, "one": 3, "A": [3, 5], "properti": 3, "dict": [3, 5], "header": 3, "cancel": [3, 5], "previous": 3, "schedul": [3, 5], "destruct": [3, 5], "hasn": 3, "t": 3, "been": 3, "destroi": 3, "yet": 3, "folder": 3, "delet": [3, 5], "identifi": 3, "arg": 3, "kwarg": [3, 5], "Not": 3, "readi": 3, "page_s": [3, 5], "100": [3, 5], "page_token": [3, 5], "retriev": 3, "int": 3, "The": 3, "maximum": 3, "number": 3, "result": 3, "per": 3, "page": 3, "avail": [3, 5], "larger": 3, "than": 3, "next_page_token": 3, "next": 3, "subsequ": 3, "1000": 3, "data": [3, 5], "pagin": 3, "union": [3, 5], "secretversionslist": [3, 5], "secretslist": 3, "pending_period": [3, 5], "604800": [3, 5], "time": 3, "interv": 3, "second": 3, "between": 3, "actual": 3, "7": 3, "dai": 3, "field": [3, 5], "which": 3, "attribut": [3, 5], "go": 3, "comma": [3, 5], "separ": [3, 5], "off": 3, "onli": 3, "chang": 3, "other": 3, "left": 3, "untouch": 3, "updatemask": [3, 5], "wa": 3, "sent": 3, "": 3, "reset": 3, "most": 3, "null": 3, "provid": [3, 5], "an": [3, 5], "up": 3, "date": 3, "synchron": 3, "mode": 3, "backward": 3, "compat": 3, "cacheabl": 3, "process": 3, "session": 3, "complet": 5, "inform": 5, "about": 5, "aggreg": 5, "have": 5, "command": 5, "manag": 5, "pydant": 5, "_model": 5, "root": 5, "repres": 5, "contain": 5, "manipul": 5, "basic": 5, "secret_payload": 5, "my_entri": 5, "show": 5, "old": 5, "new_data": 5, "update_mask": 5, "update_oper": 5, "refresh": 5, "created_at": 5, "datetim": 5, "deletion_protect": 5, "kms_key_id": 5, "label": 5, "requir": 5, "alia": 5, "createdat": 5, "currentvers": 5, "deletionprotect": 5, "folderid": 5, "kmskeyid": 5, "unknown": 5, "shortcut": 5, "destroy_at": 5, "payload_entry_kei": 5, "destroyat": 5, "payloadentrykei": 5, "secretid": 5, "descruct": 5, "versionid": 5, "ani": 5, "secretbyt": 5, "secretstr": 5, "binaryvalu": 5, "textvalu": 5, "reveal": 5, "binari": 5, "byte": 5, "text": 5, "interfac": 5, "design": 5, "insid": 5, "version_descript": 5, "versiondescript": 5, "versionpayloadentri": 5, "baseversionid": 5, "payloadentri": 5}, "objects": {"yc_lockbox": [[3, 0, 1, "", "YandexLockboxClient"]], "yc_lockbox.YandexLockboxClient": [[3, 1, 1, "", "activate_secret"], [3, 1, 1, "", "add_secret_version"], [3, 2, 1, "", "auth_headers"], [3, 1, 1, "", "cancel_secret_version_destruction"], [3, 1, 1, "", "create_secret"], [3, 1, 1, "", "deactivate_secret"], [3, 1, 1, "", "delete_secret"], [3, 1, 1, "", "get_secret"], [3, 1, 1, "", "get_secret_payload"], [3, 1, 1, "", "list_secret_access_bindings"], [3, 1, 1, "", "list_secret_operations"], [3, 1, 1, "", "list_secret_versions"], [3, 1, 1, "", "list_secrets"], [3, 1, 1, "", "schedule_secret_version_destruction"], [3, 1, 1, "", "set_secret_access_bindings"], [3, 1, 1, "", "update_secret"], [3, 1, 1, "", "update_secret_access_bindings"]], "yc_lockbox._auth": [[3, 0, 1, "", "YandexAuthClient"]], "yc_lockbox._auth.YandexAuthClient": [[3, 2, 1, "", "adapter"], [3, 1, 1, "", "get_iam_token"]], "yc_lockbox._models": [[5, 3, 1, "", "INewSecret"], [5, 3, 1, "", "INewSecretPayloadEntry"], [5, 3, 1, "", "INewSecretVersion"], [5, 3, 1, "", "IUpdateSecret"], [5, 3, 1, "", "Secret"], [5, 3, 1, "", "SecretPayload"], [5, 3, 1, "", "SecretPayloadEntry"], [5, 3, 1, "", "SecretVersion"]], "yc_lockbox._models.INewSecret": [[5, 4, 1, "", "deletion_protection"], [5, 4, 1, "", "description"], [5, 4, 1, "", "folder_id"], [5, 4, 1, "", "kms_key_id"], [5, 4, 1, "", "labels"], [5, 4, 1, "", "name"], [5, 4, 1, "", "version_description"], [5, 4, 1, "", "version_payload_entries"]], "yc_lockbox._models.INewSecretPayloadEntry": [[5, 4, 1, "", "binary_value"], [5, 4, 1, "", "key"], [5, 4, 1, "", "text_value"]], "yc_lockbox._models.INewSecretVersion": [[5, 4, 1, "", "base_version_id"], [5, 4, 1, "", "description"], [5, 4, 1, "", "payload_entries"]], "yc_lockbox._models.IUpdateSecret": [[5, 4, 1, "", "deletion_protection"], [5, 4, 1, "", "description"], [5, 4, 1, "", "labels"], [5, 4, 1, "", "name"], [5, 4, 1, "", "update_mask"]], "yc_lockbox._models.Secret": [[5, 1, 1, "", "activate"], [5, 1, 1, "", "add_version"], [5, 1, 1, "", "cancel_version_destruction"], [5, 4, 1, "", "created_at"], [5, 4, 1, "", "current_version"], [5, 1, 1, "", "deactivate"], [5, 1, 1, "", "delete"], [5, 4, 1, "", "deletion_protection"], [5, 4, 1, "", "description"], [5, 4, 1, "", "folder_id"], [5, 4, 1, "", "id"], [5, 4, 1, "", "kms_key_id"], [5, 4, 1, "", "labels"], [5, 1, 1, "", "list_versions"], [5, 4, 1, "", "name"], [5, 1, 1, "", "payload"], [5, 1, 1, "", "refresh"], [5, 1, 1, "", "schedule_version_destruction"], [5, 4, 1, "", "status"], [5, 1, 1, "", "update"]], "yc_lockbox._models.SecretPayload": [[5, 4, 1, "", "entries"], [5, 1, 1, "", "get"], [5, 4, 1, "", "version_id"]], "yc_lockbox._models.SecretPayloadEntry": [[5, 4, 1, "", "binary_value"], [5, 4, 1, "", "key"], [5, 1, 1, "", "reveal_binary_value"], [5, 1, 1, "", "reveal_text_value"], [5, 4, 1, "", "text_value"]], "yc_lockbox._models.SecretVersion": [[5, 1, 1, "", "cancel_version_destruction"], [5, 4, 1, "", "created_at"], [5, 4, 1, "", "description"], [5, 4, 1, "", "destroy_at"], [5, 4, 1, "", "id"], [5, 1, 1, "", "payload"], [5, 4, 1, "", "payload_entry_keys"], [5, 1, 1, "", "schedule_version_destruction"], [5, 4, 1, "", "secret_id"], [5, 4, 1, "", "status"]]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:property", "3": "py:pydantic_model", "4": "py:pydantic_field"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "property", "Python property"], "3": ["py", "pydantic_model", "Python model"], "4": ["py", "pydantic_field", "Python field"]}, "titleterms": {"yandex": 0, "lockbox": 0, "python": 0, "client": [0, 3], "document": 0, "instal": 0, "quick": 0, "start": 0, "creat": 0, "new": 0, "secret": 0, "get": 0, "from": 0, "add": 0, "version": 0, "other": 0, "oper": 0, "modul": 0, "content": 0, "indic": 0, "tabl": 0, "abstract": 1, "adapt": 2, "except": 4, "model": 5, "object": 5, "domain": 5, "upsert": 5}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"Yandex Lockbox Python client documentation": [[0, "yandex-lockbox-python-client-documentation"]], "Installation": [[0, "installation"]], "Quick start": [[0, "quick-start"]], "Create a new secret": [[0, "create-a-new-secret"]], "Get secret from Lockbox": [[0, "get-secret-from-lockbox"]], "Add new version of secret": [[0, "add-new-version-of-secret"]], "Other operations with secret": [[0, "other-operations-with-secret"]], "Modules": [[0, "modules"]], "Content:": [[0, null]], "Indices and tables": [[0, "indices-and-tables"]], "Abstracts": [[1, "abstracts"]], "Adapters": [[2, "adapters"]], "Client": [[3, "client"]], "Exceptions": [[4, "exceptions"]], "Models & objects": [[5, "models-objects"]], "Domain models": [[5, "domain-models"]], "Upsert models": [[5, "upsert-models"]]}, "indexentries": {"yandexauthclient (class in yc_lockbox._auth)": [[3, "yc_lockbox._auth.YandexAuthClient"]], "yandexlockboxclient (class in yc_lockbox)": [[3, "yc_lockbox.YandexLockboxClient"]], "activate_secret() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.activate_secret"]], "adapter (yc_lockbox._auth.yandexauthclient property)": [[3, "yc_lockbox._auth.YandexAuthClient.adapter"]], "add_secret_version() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.add_secret_version"]], "auth_headers (yc_lockbox.yandexlockboxclient property)": [[3, "yc_lockbox.YandexLockboxClient.auth_headers"]], "cancel_secret_version_destruction() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.cancel_secret_version_destruction"]], "create_secret() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.create_secret"]], "deactivate_secret() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.deactivate_secret"]], "delete_secret() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.delete_secret"]], "get_iam_token() (yc_lockbox._auth.yandexauthclient method)": [[3, "yc_lockbox._auth.YandexAuthClient.get_iam_token"]], "get_secret() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.get_secret"]], "get_secret_payload() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.get_secret_payload"]], "list_secret_access_bindings() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.list_secret_access_bindings"]], "list_secret_operations() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.list_secret_operations"]], "list_secret_versions() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.list_secret_versions"]], "list_secrets() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.list_secrets"]], "schedule_secret_version_destruction() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.schedule_secret_version_destruction"]], "set_secret_access_bindings() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.set_secret_access_bindings"]], "update_secret() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.update_secret"]], "update_secret_access_bindings() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.update_secret_access_bindings"]], "activate() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.activate"]], "add_version() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.add_version"]], "base_version_id (yc_lockbox._models.inewsecretversion attribute)": [[5, "yc_lockbox._models.INewSecretVersion.base_version_id"]], "binary_value (yc_lockbox._models.inewsecretpayloadentry attribute)": [[5, "yc_lockbox._models.INewSecretPayloadEntry.binary_value"]], "binary_value (yc_lockbox._models.secretpayloadentry attribute)": [[5, "yc_lockbox._models.SecretPayloadEntry.binary_value"]], "cancel_version_destruction() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.cancel_version_destruction"]], "cancel_version_destruction() (yc_lockbox._models.secretversion method)": [[5, "yc_lockbox._models.SecretVersion.cancel_version_destruction"]], "created_at (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.created_at"]], "created_at (yc_lockbox._models.secretversion attribute)": [[5, "yc_lockbox._models.SecretVersion.created_at"]], "current_version (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.current_version"]], "deactivate() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.deactivate"]], "delete() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.delete"]], "deletion_protection (yc_lockbox._models.inewsecret attribute)": [[5, "yc_lockbox._models.INewSecret.deletion_protection"]], "deletion_protection (yc_lockbox._models.iupdatesecret attribute)": [[5, "yc_lockbox._models.IUpdateSecret.deletion_protection"]], "deletion_protection (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.deletion_protection"]], "description (yc_lockbox._models.inewsecret attribute)": [[5, "yc_lockbox._models.INewSecret.description"]], "description (yc_lockbox._models.inewsecretversion attribute)": [[5, "yc_lockbox._models.INewSecretVersion.description"]], "description (yc_lockbox._models.iupdatesecret attribute)": [[5, "yc_lockbox._models.IUpdateSecret.description"]], "description (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.description"]], "description (yc_lockbox._models.secretversion attribute)": [[5, "yc_lockbox._models.SecretVersion.description"]], "destroy_at (yc_lockbox._models.secretversion attribute)": [[5, "yc_lockbox._models.SecretVersion.destroy_at"]], "entries (yc_lockbox._models.secretpayload attribute)": [[5, "yc_lockbox._models.SecretPayload.entries"]], "folder_id (yc_lockbox._models.inewsecret attribute)": [[5, "yc_lockbox._models.INewSecret.folder_id"]], "folder_id (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.folder_id"]], "get() (yc_lockbox._models.secretpayload method)": [[5, "yc_lockbox._models.SecretPayload.get"]], "id (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.id"]], "id (yc_lockbox._models.secretversion attribute)": [[5, "yc_lockbox._models.SecretVersion.id"]], "key (yc_lockbox._models.inewsecretpayloadentry attribute)": [[5, "yc_lockbox._models.INewSecretPayloadEntry.key"]], "key (yc_lockbox._models.secretpayloadentry attribute)": [[5, "yc_lockbox._models.SecretPayloadEntry.key"]], "kms_key_id (yc_lockbox._models.inewsecret attribute)": [[5, "yc_lockbox._models.INewSecret.kms_key_id"]], "kms_key_id (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.kms_key_id"]], "labels (yc_lockbox._models.inewsecret attribute)": [[5, "yc_lockbox._models.INewSecret.labels"]], "labels (yc_lockbox._models.iupdatesecret attribute)": [[5, "yc_lockbox._models.IUpdateSecret.labels"]], "labels (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.labels"]], "list_versions() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.list_versions"]], "name (yc_lockbox._models.inewsecret attribute)": [[5, "yc_lockbox._models.INewSecret.name"]], "name (yc_lockbox._models.iupdatesecret attribute)": [[5, "yc_lockbox._models.IUpdateSecret.name"]], "name (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.name"]], "payload() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.payload"]], "payload() (yc_lockbox._models.secretversion method)": [[5, "yc_lockbox._models.SecretVersion.payload"]], "payload_entries (yc_lockbox._models.inewsecretversion attribute)": [[5, "yc_lockbox._models.INewSecretVersion.payload_entries"]], "payload_entry_keys (yc_lockbox._models.secretversion attribute)": [[5, "yc_lockbox._models.SecretVersion.payload_entry_keys"]], "refresh() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.refresh"]], "reveal_binary_value() (yc_lockbox._models.secretpayloadentry method)": [[5, "yc_lockbox._models.SecretPayloadEntry.reveal_binary_value"]], "reveal_text_value() (yc_lockbox._models.secretpayloadentry method)": [[5, "yc_lockbox._models.SecretPayloadEntry.reveal_text_value"]], "schedule_version_destruction() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.schedule_version_destruction"]], "schedule_version_destruction() (yc_lockbox._models.secretversion method)": [[5, "yc_lockbox._models.SecretVersion.schedule_version_destruction"]], "secret_id (yc_lockbox._models.secretversion attribute)": [[5, "yc_lockbox._models.SecretVersion.secret_id"]], "status (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.status"]], "status (yc_lockbox._models.secretversion attribute)": [[5, "yc_lockbox._models.SecretVersion.status"]], "text_value (yc_lockbox._models.inewsecretpayloadentry attribute)": [[5, "yc_lockbox._models.INewSecretPayloadEntry.text_value"]], "text_value (yc_lockbox._models.secretpayloadentry attribute)": [[5, "yc_lockbox._models.SecretPayloadEntry.text_value"]], "update() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.update"]], "update_mask (yc_lockbox._models.iupdatesecret attribute)": [[5, "yc_lockbox._models.IUpdateSecret.update_mask"]], "version_description (yc_lockbox._models.inewsecret attribute)": [[5, "yc_lockbox._models.INewSecret.version_description"]], "version_id (yc_lockbox._models.secretpayload attribute)": [[5, "yc_lockbox._models.SecretPayload.version_id"]], "version_payload_entries (yc_lockbox._models.inewsecret attribute)": [[5, "yc_lockbox._models.INewSecret.version_payload_entries"]]}})
\ No newline at end of file
+Search.setIndex({"docnames": ["index", "pages/abstracts", "pages/adapters", "pages/clients", "pages/exceptions", "pages/models"], "filenames": ["index.rst", "pages/abstracts.rst", "pages/adapters.rst", "pages/clients.rst", "pages/exceptions.rst", "pages/models.rst"], "titles": ["Yandex Lockbox Python client documentation", "Abstracts", "Adapters", "Client", "Exceptions", "Models & objects"], "terms": {"releas": 0, "v": 0, "0": [0, 3], "1": 0, "thi": [0, 3, 5], "librari": 0, "i": [0, 3, 5], "simpl": [0, 3], "work": [0, 3], "over": 0, "rest": [0, 3], "api": [0, 3], "simplifi": 0, "allow": [0, 3], "you": [0, 3], "them": 0, "oop": 0, "paradigm": 0, "support": 0, "3": 0, "10": 0, "11": 0, "12": 0, "depend": 0, "pydanticv2": 0, "crypthographi": 0, "pyjwt": 0, "request": [0, 3], "current": [0, 5], "follow": 0, "ar": [0, 3, 5], "list": [0, 3, 5], "access": 0, "bind": 0, "set": [0, 3], "updat": [0, 3, 5], "pip": 0, "yc": [0, 3], "also": [0, 5], "can": [0, 3], "sourc": [0, 3, 5], "git": 0, "clone": 0, "http": [0, 3], "github": 0, "com": 0, "akimrx": 0, "cd": 0, "make": [0, 3], "authent": [0, 3], "via": [0, 3], "your": [0, 3], "oauth": [0, 3], "token": [0, 3, 5], "yc_lockbox": [0, 3, 5], "import": [0, 3], "yandexlockboxcli": [0, 3], "y0_xxxxxxxxxxxx": 0, "iam": [0, 3], "If": [0, 3], "pass": [0, 3], "credenti": [0, 3], "need": [0, 3], "take": [0, 3], "care": [0, 3], "fresh": [0, 3], "yourself": [0, 3], "t1": 0, "xxxxxx": 0, "xxxxxxx": 0, "us": [0, 3, 5], "servic": [0, 3], "account": [0, 3], "kei": [0, 3, 5], "json": [0, 3], "open": [0, 3], "path": [0, 3], "r": [0, 3], "keyfil": 0, "read": 0, "inewsecret": [0, 3, 5], "inewsecretpayloadentri": [0, 5], "oauth_or_iam_token": 0, "create_secret_oper": 0, "create_secret": [0, 3], "folder_id": [0, 3, 5], "b1xxxxxxxxxxxxxx": 0, "name": [0, 3, 5], "my": [0, 3, 5], "version_payload_entri": [0, 5], "secret_entry_1": 0, "text_valu": [0, 5], "secret_entry_text_valu": 0, "secret_entry_2": 0, "binary_valu": [0, 5], "secret_entry_binary_valu": 0, "encod": 0, "done": [0, 5], "new_secret": 0, "resourc": [0, 3, 5], "print": [0, 3, 5], "id": [0, 3, 5], "deactiv": [0, 3, 5], "get_secret": [0, 3], "e6qxxxxxxxxxx": 0, "statu": [0, 3, 5], "payload": [0, 3, 5], "version_id": [0, 3, 5], "current_vers": [0, 5], "option": [0, 3, 5], "default": [0, 3, 5], "entri": [0, 3, 5], "secretpayloadentri": [0, 5], "object": [0, 3], "direct": 0, "return": [0, 3, 5], "mask": [0, 3, 5], "valu": [0, 3, 5], "like": [0, 3, 5], "reveal_text_valu": [0, 3, 5], "similar": [0, 3, 5], "get_secret_valu": 0, "inewsecretvers": [0, 3, 5], "e6qxxxxxxxxxxxx": 0, "add_vers": [0, 5], "descript": [0, 3, 5], "base_version_id": [0, 5], "payload_entri": [0, 5], "altern": 0, "add_secret_vers": [0, 3], "secret_id": [0, 3, 5], "list_secret": [0, 3], "b1xxxxxxxxxx": 0, "iter": [0, 3, 5], "true": [0, 3, 5], "activ": [0, 3, 5], "list_vers": [0, 5], "schedule_version_destruct": [0, 5], "cancel_version_destruct": [0, 5], "activate_secret": [0, 3], "auth_head": [0, 3], "cancel_secret_version_destruct": [0, 3], "deactivate_secret": [0, 3], "delete_secret": [0, 3], "get_secret_payload": [0, 3], "list_secret_access_bind": [0, 3], "list_secret_oper": [0, 3], "list_secret_vers": [0, 3], "schedule_secret_version_destruct": [0, 3], "set_secret_access_bind": [0, 3], "update_secret": [0, 3], "update_secret_access_bind": [0, 3], "yandexauthcli": [0, 3], "adapt": [0, 3], "get_iam_token": [0, 3], "model": 0, "domain": 0, "secretvers": [0, 3, 5], "secretpayload": [0, 3, 5], "pagin": [0, 3], "upsert": 0, "iupdatesecret": [0, 3, 5], "common": 0, "yandexclouderror": [0, 3, 5], "iamtokenrespons": [0, 5], "except": [0, 3], "abstract": 0, "index": 0, "come": [1, 2, 4], "soon": [1, 2, 4], "class": 3, "auth_client": 3, "_auth": 3, "_adapt": 3, "httpadapt": 3, "lockbox_base_url": 3, "none": [3, 5], "payload_lockbox_base_url": 3, "base": 3, "abstractyandexlockboxcli": 3, "yandex": [3, 5], "lockbox": [3, 5], "secret": [3, 5], "vault": 3, "paramet": [3, 5], "type": [3, 5], "abstractyandexauthcli": 3, "implement": 3, "abstracthttpadapt": 3, "commun": 3, "cloud": [3, 5], "str": [3, 5], "url": 3, "without": 3, "auth_base_url": 3, "all": [3, 5], "e": 3, "look": 3, "To": 3, "get": [3, 5], "real": [3, 5], "call": [3, 5], "inject": 3, "method": [3, 5], "reveal_binary_valu": [3, 5], "usag": [3, 5], "from": [3, 5], "y0_agaexxxxxxxxxxxxxxxxxxxxxxxxx": 3, "e6xxxxxxxxxxxxxxxx": 3, "try": 3, "mykei": 3, "keyerror": 3, "invalid": 3, "foo": 3, "exist": [3, 5], "rais": 3, "gener": 3, "sa": 3, "creat": [3, 5], "output": 3, "infil": 3, "load": 3, "raise_for_statu": 3, "specifi": [3, 5], "indentifi": 3, "bool": [3, 5], "fals": [3, 5], "instead": 3, "throw": 3, "oper": [3, 5], "version": [3, 5], "add": [3, 5], "new": [3, 5], "previou": 3, "one": 3, "A": [3, 5], "properti": [3, 5], "dict": [3, 5], "header": 3, "cancel": [3, 5], "previous": 3, "schedul": [3, 5], "destruct": [3, 5], "hasn": 3, "t": [3, 5], "been": 3, "destroi": 3, "yet": 3, "folder": 3, "delet": [3, 5], "identifi": 3, "arg": 3, "kwarg": [3, 5], "Not": 3, "readi": 3, "page_s": [3, 5], "100": [3, 5], "page_token": [3, 5], "retriev": 3, "int": [3, 5], "The": 3, "maximum": 3, "number": 3, "result": 3, "per": 3, "page": 3, "avail": [3, 5], "larger": 3, "than": 3, "next_page_token": 3, "next": 3, "subsequ": 3, "1000": 3, "data": [3, 5], "union": [3, 5], "secretversionslist": [3, 5], "secretslist": [3, 5], "pending_period": [3, 5], "604800": [3, 5], "time": 3, "interv": 3, "second": 3, "between": 3, "actual": 3, "7": 3, "dai": 3, "field": [3, 5], "which": 3, "attribut": [3, 5], "go": 3, "comma": [3, 5], "separ": [3, 5], "off": 3, "onli": 3, "chang": 3, "other": [3, 5], "left": 3, "untouch": 3, "updatemask": [3, 5], "wa": 3, "sent": 3, "": 3, "reset": 3, "most": 3, "null": 3, "provid": [3, 5], "an": [3, 5], "up": 3, "date": 3, "synchron": 3, "mode": 3, "backward": 3, "compat": 3, "cacheabl": 3, "process": 3, "session": 3, "complet": 5, "inform": 5, "about": 5, "aggreg": 5, "have": 5, "command": 5, "manag": 5, "pydant": 5, "_model": 5, "root": 5, "repres": 5, "contain": 5, "manipul": 5, "basic": 5, "secret_payload": 5, "my_entri": 5, "show": 5, "old": 5, "new_data": 5, "update_mask": 5, "update_oper": 5, "refresh": 5, "created_at": 5, "datetim": 5, "deletion_protect": 5, "kms_key_id": 5, "label": 5, "requir": 5, "alia": 5, "createdat": 5, "currentvers": 5, "deletionprotect": 5, "folderid": 5, "kmskeyid": 5, "unknown": 5, "shortcut": 5, "destroy_at": 5, "payload_entry_kei": 5, "destroyat": 5, "payloadentrykei": 5, "secretid": 5, "descruct": 5, "versionid": 5, "ani": 5, "secretbyt": 5, "secretstr": 5, "binaryvalu": 5, "textvalu": 5, "reveal": 5, "binari": 5, "byte": 5, "text": 5, "when": 5, "interfac": 5, "design": 5, "insid": 5, "version_descript": 5, "versiondescript": 5, "versionpayloadentri": 5, "baseversionid": 5, "payloadentri": 5, "relat": 5, "created_bi": 5, "error": 5, "metadata": 5, "modified_at": 5, "respons": 5, "createdbi": 5, "modifiedat": 5, "possibl": 5, "otherwis": 5, "code": 5, "detail": 5, "messag": 5, "expires_at": 5, "expiresat": 5, "iamtoken": 5}, "objects": {"yc_lockbox": [[3, 0, 1, "", "YandexLockboxClient"]], "yc_lockbox.YandexLockboxClient": [[3, 1, 1, "", "activate_secret"], [3, 1, 1, "", "add_secret_version"], [3, 2, 1, "", "auth_headers"], [3, 1, 1, "", "cancel_secret_version_destruction"], [3, 1, 1, "", "create_secret"], [3, 1, 1, "", "deactivate_secret"], [3, 1, 1, "", "delete_secret"], [3, 1, 1, "", "get_secret"], [3, 1, 1, "", "get_secret_payload"], [3, 1, 1, "", "list_secret_access_bindings"], [3, 1, 1, "", "list_secret_operations"], [3, 1, 1, "", "list_secret_versions"], [3, 1, 1, "", "list_secrets"], [3, 1, 1, "", "schedule_secret_version_destruction"], [3, 1, 1, "", "set_secret_access_bindings"], [3, 1, 1, "", "update_secret"], [3, 1, 1, "", "update_secret_access_bindings"]], "yc_lockbox._auth": [[3, 0, 1, "", "YandexAuthClient"]], "yc_lockbox._auth.YandexAuthClient": [[3, 2, 1, "", "adapter"], [3, 1, 1, "", "get_iam_token"]], "yc_lockbox._models": [[5, 3, 1, "", "INewSecret"], [5, 3, 1, "", "INewSecretPayloadEntry"], [5, 3, 1, "", "INewSecretVersion"], [5, 3, 1, "", "IUpdateSecret"], [5, 3, 1, "", "IamTokenResponse"], [5, 3, 1, "", "Operation"], [5, 3, 1, "", "Secret"], [5, 3, 1, "", "SecretPayload"], [5, 3, 1, "", "SecretPayloadEntry"], [5, 3, 1, "", "SecretVersion"], [5, 3, 1, "", "SecretVersionsList"], [5, 3, 1, "", "SecretsList"], [5, 3, 1, "", "YandexCloudError"]], "yc_lockbox._models.INewSecret": [[5, 4, 1, "", "deletion_protection"], [5, 4, 1, "", "description"], [5, 4, 1, "", "folder_id"], [5, 4, 1, "", "kms_key_id"], [5, 4, 1, "", "labels"], [5, 4, 1, "", "name"], [5, 4, 1, "", "version_description"], [5, 4, 1, "", "version_payload_entries"]], "yc_lockbox._models.INewSecretPayloadEntry": [[5, 4, 1, "", "binary_value"], [5, 4, 1, "", "key"], [5, 4, 1, "", "text_value"]], "yc_lockbox._models.INewSecretVersion": [[5, 4, 1, "", "base_version_id"], [5, 4, 1, "", "description"], [5, 4, 1, "", "payload_entries"]], "yc_lockbox._models.IUpdateSecret": [[5, 4, 1, "", "deletion_protection"], [5, 4, 1, "", "description"], [5, 4, 1, "", "labels"], [5, 4, 1, "", "name"], [5, 4, 1, "", "update_mask"]], "yc_lockbox._models.IamTokenResponse": [[5, 4, 1, "", "expires_at"], [5, 4, 1, "", "token"]], "yc_lockbox._models.Operation": [[5, 4, 1, "", "created_at"], [5, 4, 1, "", "created_by"], [5, 4, 1, "", "description"], [5, 4, 1, "", "done"], [5, 4, 1, "", "error"], [5, 4, 1, "", "id"], [5, 4, 1, "", "metadata"], [5, 4, 1, "", "modified_at"], [5, 2, 1, "", "resource"], [5, 4, 1, "", "response"]], "yc_lockbox._models.Secret": [[5, 1, 1, "", "activate"], [5, 1, 1, "", "add_version"], [5, 1, 1, "", "cancel_version_destruction"], [5, 4, 1, "", "created_at"], [5, 4, 1, "", "current_version"], [5, 1, 1, "", "deactivate"], [5, 1, 1, "", "delete"], [5, 4, 1, "", "deletion_protection"], [5, 4, 1, "", "description"], [5, 4, 1, "", "folder_id"], [5, 4, 1, "", "id"], [5, 4, 1, "", "kms_key_id"], [5, 4, 1, "", "labels"], [5, 1, 1, "", "list_versions"], [5, 4, 1, "", "name"], [5, 1, 1, "", "payload"], [5, 1, 1, "", "refresh"], [5, 1, 1, "", "schedule_version_destruction"], [5, 4, 1, "", "status"], [5, 1, 1, "", "update"]], "yc_lockbox._models.SecretPayload": [[5, 4, 1, "", "entries"], [5, 1, 1, "", "get"], [5, 4, 1, "", "version_id"]], "yc_lockbox._models.SecretPayloadEntry": [[5, 4, 1, "", "binary_value"], [5, 4, 1, "", "key"], [5, 1, 1, "", "reveal_binary_value"], [5, 1, 1, "", "reveal_text_value"], [5, 4, 1, "", "text_value"]], "yc_lockbox._models.SecretVersion": [[5, 1, 1, "", "cancel_version_destruction"], [5, 4, 1, "", "created_at"], [5, 4, 1, "", "description"], [5, 4, 1, "", "destroy_at"], [5, 4, 1, "", "id"], [5, 1, 1, "", "payload"], [5, 4, 1, "", "payload_entry_keys"], [5, 1, 1, "", "schedule_version_destruction"], [5, 4, 1, "", "secret_id"], [5, 4, 1, "", "status"]], "yc_lockbox._models.SecretVersionsList": [[5, 4, 1, "", "versions"]], "yc_lockbox._models.SecretsList": [[5, 4, 1, "", "secrets"]], "yc_lockbox._models.YandexCloudError": [[5, 4, 1, "", "code"], [5, 4, 1, "", "details"], [5, 4, 1, "", "message"]]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:property", "3": "py:pydantic_model", "4": "py:pydantic_field"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "property", "Python property"], "3": ["py", "pydantic_model", "Python model"], "4": ["py", "pydantic_field", "Python field"]}, "titleterms": {"yandex": 0, "lockbox": 0, "python": 0, "client": [0, 3], "document": 0, "instal": 0, "quick": 0, "start": 0, "creat": 0, "new": 0, "secret": 0, "get": 0, "from": 0, "add": 0, "version": 0, "other": 0, "oper": 0, "modul": 0, "content": 0, "indic": 0, "tabl": 0, "abstract": 1, "adapt": 2, "except": 4, "model": 5, "object": 5, "domain": 5, "pagin": 5, "upsert": 5, "common": 5}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx": 60}, "alltitles": {"Yandex Lockbox Python client documentation": [[0, "yandex-lockbox-python-client-documentation"]], "Installation": [[0, "installation"]], "Quick start": [[0, "quick-start"]], "Create a new secret": [[0, "create-a-new-secret"]], "Get secret from Lockbox": [[0, "get-secret-from-lockbox"]], "Add new version of secret": [[0, "add-new-version-of-secret"]], "Other operations with secret": [[0, "other-operations-with-secret"]], "Modules": [[0, "modules"]], "Content:": [[0, null]], "Indices and tables": [[0, "indices-and-tables"]], "Abstracts": [[1, "abstracts"]], "Adapters": [[2, "adapters"]], "Client": [[3, "client"]], "Exceptions": [[4, "exceptions"]], "Models & objects": [[5, "models-objects"]], "Domain models": [[5, "domain-models"]], "Paginated models": [[5, "paginated-models"]], "Upsert models": [[5, "upsert-models"]], "Common models": [[5, "common-models"]]}, "indexentries": {"yandexauthclient (class in yc_lockbox._auth)": [[3, "yc_lockbox._auth.YandexAuthClient"]], "yandexlockboxclient (class in yc_lockbox)": [[3, "yc_lockbox.YandexLockboxClient"]], "activate_secret() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.activate_secret"]], "adapter (yc_lockbox._auth.yandexauthclient property)": [[3, "yc_lockbox._auth.YandexAuthClient.adapter"]], "add_secret_version() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.add_secret_version"]], "auth_headers (yc_lockbox.yandexlockboxclient property)": [[3, "yc_lockbox.YandexLockboxClient.auth_headers"]], "cancel_secret_version_destruction() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.cancel_secret_version_destruction"]], "create_secret() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.create_secret"]], "deactivate_secret() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.deactivate_secret"]], "delete_secret() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.delete_secret"]], "get_iam_token() (yc_lockbox._auth.yandexauthclient method)": [[3, "yc_lockbox._auth.YandexAuthClient.get_iam_token"]], "get_secret() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.get_secret"]], "get_secret_payload() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.get_secret_payload"]], "list_secret_access_bindings() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.list_secret_access_bindings"]], "list_secret_operations() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.list_secret_operations"]], "list_secret_versions() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.list_secret_versions"]], "list_secrets() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.list_secrets"]], "schedule_secret_version_destruction() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.schedule_secret_version_destruction"]], "set_secret_access_bindings() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.set_secret_access_bindings"]], "update_secret() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.update_secret"]], "update_secret_access_bindings() (yc_lockbox.yandexlockboxclient method)": [[3, "yc_lockbox.YandexLockboxClient.update_secret_access_bindings"]], "activate() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.activate"]], "add_version() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.add_version"]], "base_version_id (yc_lockbox._models.inewsecretversion attribute)": [[5, "yc_lockbox._models.INewSecretVersion.base_version_id"]], "binary_value (yc_lockbox._models.inewsecretpayloadentry attribute)": [[5, "yc_lockbox._models.INewSecretPayloadEntry.binary_value"]], "binary_value (yc_lockbox._models.secretpayloadentry attribute)": [[5, "yc_lockbox._models.SecretPayloadEntry.binary_value"]], "cancel_version_destruction() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.cancel_version_destruction"]], "cancel_version_destruction() (yc_lockbox._models.secretversion method)": [[5, "yc_lockbox._models.SecretVersion.cancel_version_destruction"]], "code (yc_lockbox._models.yandexclouderror attribute)": [[5, "yc_lockbox._models.YandexCloudError.code"]], "created_at (yc_lockbox._models.operation attribute)": [[5, "yc_lockbox._models.Operation.created_at"]], "created_at (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.created_at"]], "created_at (yc_lockbox._models.secretversion attribute)": [[5, "yc_lockbox._models.SecretVersion.created_at"]], "created_by (yc_lockbox._models.operation attribute)": [[5, "yc_lockbox._models.Operation.created_by"]], "current_version (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.current_version"]], "deactivate() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.deactivate"]], "delete() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.delete"]], "deletion_protection (yc_lockbox._models.inewsecret attribute)": [[5, "yc_lockbox._models.INewSecret.deletion_protection"]], "deletion_protection (yc_lockbox._models.iupdatesecret attribute)": [[5, "yc_lockbox._models.IUpdateSecret.deletion_protection"]], "deletion_protection (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.deletion_protection"]], "description (yc_lockbox._models.inewsecret attribute)": [[5, "yc_lockbox._models.INewSecret.description"]], "description (yc_lockbox._models.inewsecretversion attribute)": [[5, "yc_lockbox._models.INewSecretVersion.description"]], "description (yc_lockbox._models.iupdatesecret attribute)": [[5, "yc_lockbox._models.IUpdateSecret.description"]], "description (yc_lockbox._models.operation attribute)": [[5, "yc_lockbox._models.Operation.description"]], "description (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.description"]], "description (yc_lockbox._models.secretversion attribute)": [[5, "yc_lockbox._models.SecretVersion.description"]], "destroy_at (yc_lockbox._models.secretversion attribute)": [[5, "yc_lockbox._models.SecretVersion.destroy_at"]], "details (yc_lockbox._models.yandexclouderror attribute)": [[5, "yc_lockbox._models.YandexCloudError.details"]], "done (yc_lockbox._models.operation attribute)": [[5, "yc_lockbox._models.Operation.done"]], "entries (yc_lockbox._models.secretpayload attribute)": [[5, "yc_lockbox._models.SecretPayload.entries"]], "error (yc_lockbox._models.operation attribute)": [[5, "yc_lockbox._models.Operation.error"]], "expires_at (yc_lockbox._models.iamtokenresponse attribute)": [[5, "yc_lockbox._models.IamTokenResponse.expires_at"]], "folder_id (yc_lockbox._models.inewsecret attribute)": [[5, "yc_lockbox._models.INewSecret.folder_id"]], "folder_id (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.folder_id"]], "get() (yc_lockbox._models.secretpayload method)": [[5, "yc_lockbox._models.SecretPayload.get"]], "id (yc_lockbox._models.operation attribute)": [[5, "yc_lockbox._models.Operation.id"]], "id (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.id"]], "id (yc_lockbox._models.secretversion attribute)": [[5, "yc_lockbox._models.SecretVersion.id"]], "key (yc_lockbox._models.inewsecretpayloadentry attribute)": [[5, "yc_lockbox._models.INewSecretPayloadEntry.key"]], "key (yc_lockbox._models.secretpayloadentry attribute)": [[5, "yc_lockbox._models.SecretPayloadEntry.key"]], "kms_key_id (yc_lockbox._models.inewsecret attribute)": [[5, "yc_lockbox._models.INewSecret.kms_key_id"]], "kms_key_id (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.kms_key_id"]], "labels (yc_lockbox._models.inewsecret attribute)": [[5, "yc_lockbox._models.INewSecret.labels"]], "labels (yc_lockbox._models.iupdatesecret attribute)": [[5, "yc_lockbox._models.IUpdateSecret.labels"]], "labels (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.labels"]], "list_versions() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.list_versions"]], "message (yc_lockbox._models.yandexclouderror attribute)": [[5, "yc_lockbox._models.YandexCloudError.message"]], "metadata (yc_lockbox._models.operation attribute)": [[5, "yc_lockbox._models.Operation.metadata"]], "modified_at (yc_lockbox._models.operation attribute)": [[5, "yc_lockbox._models.Operation.modified_at"]], "name (yc_lockbox._models.inewsecret attribute)": [[5, "yc_lockbox._models.INewSecret.name"]], "name (yc_lockbox._models.iupdatesecret attribute)": [[5, "yc_lockbox._models.IUpdateSecret.name"]], "name (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.name"]], "payload() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.payload"]], "payload() (yc_lockbox._models.secretversion method)": [[5, "yc_lockbox._models.SecretVersion.payload"]], "payload_entries (yc_lockbox._models.inewsecretversion attribute)": [[5, "yc_lockbox._models.INewSecretVersion.payload_entries"]], "payload_entry_keys (yc_lockbox._models.secretversion attribute)": [[5, "yc_lockbox._models.SecretVersion.payload_entry_keys"]], "refresh() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.refresh"]], "resource (yc_lockbox._models.operation property)": [[5, "yc_lockbox._models.Operation.resource"]], "response (yc_lockbox._models.operation attribute)": [[5, "yc_lockbox._models.Operation.response"]], "reveal_binary_value() (yc_lockbox._models.secretpayloadentry method)": [[5, "yc_lockbox._models.SecretPayloadEntry.reveal_binary_value"]], "reveal_text_value() (yc_lockbox._models.secretpayloadentry method)": [[5, "yc_lockbox._models.SecretPayloadEntry.reveal_text_value"]], "schedule_version_destruction() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.schedule_version_destruction"]], "schedule_version_destruction() (yc_lockbox._models.secretversion method)": [[5, "yc_lockbox._models.SecretVersion.schedule_version_destruction"]], "secret_id (yc_lockbox._models.secretversion attribute)": [[5, "yc_lockbox._models.SecretVersion.secret_id"]], "secrets (yc_lockbox._models.secretslist attribute)": [[5, "yc_lockbox._models.SecretsList.secrets"]], "status (yc_lockbox._models.secret attribute)": [[5, "yc_lockbox._models.Secret.status"]], "status (yc_lockbox._models.secretversion attribute)": [[5, "yc_lockbox._models.SecretVersion.status"]], "text_value (yc_lockbox._models.inewsecretpayloadentry attribute)": [[5, "yc_lockbox._models.INewSecretPayloadEntry.text_value"]], "text_value (yc_lockbox._models.secretpayloadentry attribute)": [[5, "yc_lockbox._models.SecretPayloadEntry.text_value"]], "token (yc_lockbox._models.iamtokenresponse attribute)": [[5, "yc_lockbox._models.IamTokenResponse.token"]], "update() (yc_lockbox._models.secret method)": [[5, "yc_lockbox._models.Secret.update"]], "update_mask (yc_lockbox._models.iupdatesecret attribute)": [[5, "yc_lockbox._models.IUpdateSecret.update_mask"]], "version_description (yc_lockbox._models.inewsecret attribute)": [[5, "yc_lockbox._models.INewSecret.version_description"]], "version_id (yc_lockbox._models.secretpayload attribute)": [[5, "yc_lockbox._models.SecretPayload.version_id"]], "version_payload_entries (yc_lockbox._models.inewsecret attribute)": [[5, "yc_lockbox._models.INewSecret.version_payload_entries"]], "versions (yc_lockbox._models.secretversionslist attribute)": [[5, "yc_lockbox._models.SecretVersionsList.versions"]]}})
\ No newline at end of file
diff --git a/docs_src/source/pages/models.rst b/docs_src/source/pages/models.rst
index 2ce7d97..8fd1d43 100644
--- a/docs_src/source/pages/models.rst
+++ b/docs_src/source/pages/models.rst
@@ -16,6 +16,17 @@ Domain models provide complete information about the resource, similar to aggreg
 .. autopydantic_model:: yc_lockbox._models.SecretPayloadEntry
 
 
+Paginated models
+^^^^^^^^^^^^^^^^
+
+Used when ``iterator=False``.
+
+.. autopydantic_model:: yc_lockbox._models.SecretsList
+
+.. autopydantic_model:: yc_lockbox._models.SecretVersionsList
+
+
+
 Upsert models
 -------------
 
@@ -28,3 +39,15 @@ Upsert models (interfaces) are designed for operations of creating new resources
 .. autopydantic_model:: yc_lockbox._models.INewSecretPayloadEntry
 
 .. autopydantic_model:: yc_lockbox._models.IUpdateSecret
+
+
+Common models
+-------------
+
+Other Yandex Cloud models related to Lockbox.
+
+.. autopydantic_model:: yc_lockbox._models.Operation
+
+.. autopydantic_model:: yc_lockbox._models.YandexCloudError
+
+.. autopydantic_model:: yc_lockbox._models.IamTokenResponse
\ No newline at end of file