chore: updated docs

Author: lempira

docs/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 1ff0f7f1ed8bde3d86963992a23e5922
+config: dde11509b3a7c658194a785d86df1e0e
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/html/_sources/autoapi/algokit_utils/applications/abi/index.rst.txt

@@ -41,29 +41,24 @@ Functions
 Module Contents
 ---------------
 
-.. py:data:: ABIValue
-   :type:  TypeAlias
-   :value: bool | int | str | bytes | bytearray | list['ABIValue'] | tuple['ABIValue'] | dict[str, 'ABIValue']
+.. py:type:: ABIValue
+   :canonical: bool | int | str | bytes | bytearray | list['ABIValue'] | tuple['ABIValue'] | dict[str, 'ABIValue']
 
 
-.. py:data:: ABIStruct
-   :type:  TypeAlias
-   :value: dict[str, list[dict[str, 'ABIValue']]]
+.. py:type:: ABIStruct
+   :canonical: dict[str, list[dict[str, 'ABIValue']]]
 
 
-.. py:data:: Arc56ReturnValueType
-   :type:  TypeAlias
-   :value: ABIValue | ABIStruct | None
+.. py:type:: Arc56ReturnValueType
+   :canonical: ABIValue | ABIStruct | None
 
 
-.. py:data:: ABIType
-   :type:  TypeAlias
-   :value: algosdk.abi.ABIType
+.. py:type:: ABIType
+   :canonical: algosdk.abi.ABIType
 
 
-.. py:data:: ABIArgumentType
-   :type:  TypeAlias
-   :value: algosdk.abi.ABIType | algosdk.abi.ABITransactionType | algosdk.abi.ABIReferenceType
+.. py:type:: ABIArgumentType
+   :canonical: algosdk.abi.ABIType | algosdk.abi.ABITransactionType | algosdk.abi.ABIReferenceType
 
 
 .. py:class:: ABIReturn(result: algosdk.atomic_transaction_composer.ABIResult)

docs/html/_sources/autoapi/algokit_utils/applications/app_manager/index.rst.txt

@@ -143,6 +143,8 @@ Module Contents
 
       Get names of all boxes for an application.
 
+      If the box name can't be decoded from UTF-8, the string representation of the bytes is returned.
+
       :param app_id: The application ID
       :return: List of box names
 

docs/html/_sources/autoapi/algokit_utils/applications/app_spec/arc32/index.rst.txt

@@ -31,9 +31,8 @@ Classes
 Module Contents
 ---------------
 
-.. py:data:: AppSpecStateDict
-   :type:  TypeAlias
-   :value: dict[str, dict[str, dict]]
+.. py:type:: AppSpecStateDict
+   :canonical: dict[str, dict[str, dict]]
 
 
    Type defining Application Specification state entries
@@ -103,25 +102,22 @@ Module Contents
       :type:  list[list[str]]
 
 
-.. py:data:: OnCompleteActionName
-   :type:  TypeAlias
-   :value: Literal['no_op', 'opt_in', 'close_out', 'clear_state', 'update_application', 'delete_application']
+.. py:type:: OnCompleteActionName
+   :canonical: Literal['no_op', 'opt_in', 'close_out', 'clear_state', 'update_application', 'delete_application']
 
 
    String literals representing on completion transaction types
 
 
-.. py:data:: MethodConfigDict
-   :type:  TypeAlias
-   :value: dict[OnCompleteActionName, CallConfig]
+.. py:type:: MethodConfigDict
+   :canonical: dict[OnCompleteActionName, CallConfig]
 
 
    Dictionary of `dict[OnCompletionActionName, CallConfig]` representing allowed actions for each on completion type
 
 
-.. py:data:: DefaultArgumentType
-   :type:  TypeAlias
-   :value: Literal['abi-method', 'local-state', 'global-state', 'constant']
+.. py:type:: DefaultArgumentType
+   :canonical: Literal['abi-method', 'local-state', 'global-state', 'constant']
 
 
    Literal values describing the types of default argument sources

docs/html/_sources/autoapi/algokit_utils/models/state/index.rst.txt

@@ -35,7 +35,8 @@ Module Contents
    .. py:attribute:: name
       :type:  str
 
-      The name of the box as a string
+      The name of the box as a string.
+      If the name can't be decoded from UTF-8, the string representation of the bytes is returned instead.
 
 
 
@@ -90,14 +91,12 @@ Module Contents
 
 
 
-.. py:data:: TealTemplateParams
-   :type:  TypeAlias
-   :value: Mapping[str, str | int | bytes] | dict[str, str | int | bytes]
+.. py:type:: TealTemplateParams
+   :canonical: Mapping[str, str | int | bytes] | dict[str, str | int | bytes]
 
 
-.. py:data:: BoxIdentifier
-   :type:  TypeAlias
-   :value: str | bytes | AccountTransactionSigner
+.. py:type:: BoxIdentifier
+   :canonical: str | bytes | AccountTransactionSigner
 
 
 .. py:class:: BoxReference(app_id: int, name: bytes | str)

docs/html/autoapi/algokit_utils/applications/abi/index.html

@@ -388,29 +388,29 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
 </section>
 <section id="module-contents">
 <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to this heading">¶</a></h2>
-<dl class="py data">
+<dl class="py type">
 <dt class="sig sig-object py" id="algokit_utils.applications.abi.ABIValue">
-<span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.abi.</span></span><span class="sig-name descname"><span class="pre">ABIValue</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">TypeAlias</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">bool</span> <span class="pre">|</span> <span class="pre">int</span> <span class="pre">|</span> <span class="pre">str</span> <span class="pre">|</span> <span class="pre">bytes</span> <span class="pre">|</span> <span class="pre">bytearray</span> <span class="pre">|</span> <span class="pre">list['ABIValue']</span> <span class="pre">|</span> <span class="pre">tuple['ABIValue']</span> <span class="pre">|</span> <span class="pre">dict[str,</span> <span class="pre">'ABIValue']</span></em><a class="headerlink" href="#algokit_utils.applications.abi.ABIValue" title="Link to this definition">¶</a></dt>
+<em class="property"><span class="pre">type</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.abi.</span></span><span class="sig-name descname"><span class="pre">ABIValue</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bytes</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">bytearray</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ABIValue'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">tuple</span><span class="p"><span class="pre">[</span></span><span class="s"><span class="pre">'ABIValue'</span></span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'ABIValue'</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#algokit_utils.applications.abi.ABIValue" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
-<dl class="py data">
+<dl class="py type">
 <dt class="sig sig-object py" id="algokit_utils.applications.abi.ABIStruct">
-<span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.abi.</span></span><span class="sig-name descname"><span class="pre">ABIStruct</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">TypeAlias</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">dict[str,</span> <span class="pre">list[dict[str,</span> <span class="pre">'ABIValue']]]</span></em><a class="headerlink" href="#algokit_utils.applications.abi.ABIStruct" title="Link to this definition">¶</a></dt>
+<em class="property"><span class="pre">type</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.abi.</span></span><span class="sig-name descname"><span class="pre">ABIStruct</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">list</span><span class="p"><span class="pre">[</span></span><span class="pre">dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="s"><span class="pre">'ABIValue'</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#algokit_utils.applications.abi.ABIStruct" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
-<dl class="py data">
+<dl class="py type">
 <dt class="sig sig-object py" id="algokit_utils.applications.abi.Arc56ReturnValueType">
-<span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.abi.</span></span><span class="sig-name descname"><span class="pre">Arc56ReturnValueType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">TypeAlias</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ABIValue</span> <span class="pre">|</span> <span class="pre">ABIStruct</span> <span class="pre">|</span> <span class="pre">None</span></em><a class="headerlink" href="#algokit_utils.applications.abi.Arc56ReturnValueType" title="Link to this definition">¶</a></dt>
+<em class="property"><span class="pre">type</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.abi.</span></span><span class="sig-name descname"><span class="pre">Arc56ReturnValueType</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">ABIValue</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">ABIStruct</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#algokit_utils.applications.abi.Arc56ReturnValueType" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
-<dl class="py data">
+<dl class="py type">
 <dt class="sig sig-object py" id="algokit_utils.applications.abi.ABIType">
-<span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.abi.</span></span><span class="sig-name descname"><span class="pre">ABIType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">TypeAlias</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">algosdk.abi.ABIType</span></em><a class="headerlink" href="#algokit_utils.applications.abi.ABIType" title="Link to this definition">¶</a></dt>
+<em class="property"><span class="pre">type</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.abi.</span></span><span class="sig-name descname"><span class="pre">ABIType</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">algosdk.abi.ABIType</span></em><a class="headerlink" href="#algokit_utils.applications.abi.ABIType" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
-<dl class="py data">
+<dl class="py type">
 <dt class="sig sig-object py" id="algokit_utils.applications.abi.ABIArgumentType">
-<span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.abi.</span></span><span class="sig-name descname"><span class="pre">ABIArgumentType</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">TypeAlias</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">algosdk.abi.ABIType</span> <span class="pre">|</span> <span class="pre">algosdk.abi.ABITransactionType</span> <span class="pre">|</span> <span class="pre">algosdk.abi.ABIReferenceType</span></em><a class="headerlink" href="#algokit_utils.applications.abi.ABIArgumentType" title="Link to this definition">¶</a></dt>
+<em class="property"><span class="pre">type</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">algokit_utils.applications.abi.</span></span><span class="sig-name descname"><span class="pre">ABIArgumentType</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">algosdk.abi.ABIType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">algosdk.abi.ABITransactionType</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">algosdk.abi.ABIReferenceType</span></em><a class="headerlink" href="#algokit_utils.applications.abi.ABIArgumentType" title="Link to this definition">¶</a></dt>
 <dd></dd></dl>
 
 <dl class="py class">

docs/html/autoapi/algokit_utils/applications/app_manager/index.html

@@ -515,6 +515,7 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Link to
 <dt class="sig sig-object py" id="algokit_utils.applications.app_manager.AppManager.get_box_names">
 <span class="sig-name descname"><span class="pre">get_box_names</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">list</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="../../models/state/index.html#algokit_utils.models.state.BoxName" title="algokit_utils.models.state.BoxName"><span class="pre">algokit_utils.models.state.BoxName</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#algokit_utils.applications.app_manager.AppManager.get_box_names" title="Link to this definition">¶</a></dt>
 <dd><p>Get names of all boxes for an application.</p>
+<p>If the box name can’t be decoded from UTF-8, the string representation of the bytes is returned.</p>
 <dl class="field-list">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><p><strong>app_id</strong> – The application ID</p>