deploy: 5fc81df

_modules/viam/app/app_client.html

@@ -736,6 +736,7 @@ <h1>Source code for viam.app.app_client</h1><div class="highlight"><pre>
 
 <span class="sd">        Args:</span>
 <span class="sd">            org_id (str): The ID of the organization.</span>
+<span class="sd">                You can obtain your organization ID from the Viam app&#39;s organization settings page.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">request</span> <span class="o">=</span> <span class="n">DeleteOrganizationRequest</span><span class="p">(</span><span class="n">organization_id</span><span class="o">=</span><span class="n">org_id</span><span class="p">)</span>
         <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_app_client</span><span class="o">.</span><span class="n">DeleteOrganization</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_metadata</span><span class="p">)</span></div>
@@ -749,6 +750,7 @@ <h1>Source code for viam.app.app_client</h1><div class="highlight"><pre>
 
 <span class="sd">        Args:</span>
 <span class="sd">            org_id (str): The ID of the organization to list members of.</span>
+<span class="sd">                You can obtain your organization ID from the Viam app&#39;s organization settings page.</span>
 
 <span class="sd">        Returns:</span>
 <span class="sd">            Tuple[List[viam.proto.app.OrganizationMember], List[viam.proto.app.OrganizationInvite]]: A tuple containing two lists; the first</span>
@@ -769,6 +771,7 @@ <h1>Source code for viam.app.app_client</h1><div class="highlight"><pre>
 
 <span class="sd">        Args:</span>
 <span class="sd">            org_id (str): The ID of the organization to create an invite for.</span>
+<span class="sd">                You can obtain your organization ID from the Viam app&#39;s organization settings page.</span>
 <span class="sd">            email (str): The email address to send the invite to.</span>
 <span class="sd">            authorizations (Optional[List[viam.proto.app.Authorization]]): Specifications of the</span>
 <span class="sd">                authorizations to include in the invite. If not provided, full owner permissions will</span>
@@ -820,6 +823,7 @@ <h1>Source code for viam.app.app_client</h1><div class="highlight"><pre>
 
 <span class="sd">        Args:</span>
 <span class="sd">            org_id (str): The ID of the organization that the invite is for.</span>
+<span class="sd">                You can obtain your organization ID from the Viam app&#39;s organization settings page.</span>
 <span class="sd">            email (str): Email of the user the invite was sent to.</span>
 <span class="sd">            add_authorizations (Optional[List[viam.proto.app.Authorization]]): Optional list of authorizations to add to the invite.</span>
 <span class="sd">            remove_authorizations (Optional[List[viam.proto.app.Authorization]]): Optional list of authorizations to remove from the invite.</span>
@@ -851,6 +855,7 @@ <h1>Source code for viam.app.app_client</h1><div class="highlight"><pre>
 
 <span class="sd">        Args:</span>
 <span class="sd">            org_id (str): The ID of the org to remove the user from.</span>
+<span class="sd">                You can obtain your organization ID from the Viam app&#39;s organization settings page.</span>
 <span class="sd">            user_id (str): The ID of the user to remove.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">request</span> <span class="o">=</span> <span class="n">DeleteOrganizationMemberRequest</span><span class="p">(</span><span class="n">organization_id</span><span class="o">=</span><span class="n">org_id</span><span class="p">,</span> <span class="n">user_id</span><span class="o">=</span><span class="n">user_id</span><span class="p">)</span>
@@ -865,6 +870,7 @@ <h1>Source code for viam.app.app_client</h1><div class="highlight"><pre>
 
 <span class="sd">        Args:</span>
 <span class="sd">            org_id (str): The ID of the organization that the invite to delete was for.</span>
+<span class="sd">                You can obtain your organization ID from the Viam app&#39;s organization settings page.</span>
 <span class="sd">            email (str): The email address the pending invite was sent to.</span>
 
 <span class="sd">        Raises:</span>
@@ -878,14 +884,18 @@ <h1>Source code for viam.app.app_client</h1><div class="highlight"><pre>
 
 <span class="sd">        ::</span>
 
-<span class="sd">            await cloud.resend_organization_invite(&quot;org-id&quot;, &quot;[email protected]&quot;)</span>
+<span class="sd">            org_invite = await cloud.resend_organization_invite(&quot;org-id&quot;, &quot;[email protected]&quot;)</span>
 
 <span class="sd">        Args:</span>
 <span class="sd">            org_id (str): The ID of the organization that the invite to resend was for.</span>
+<span class="sd">                You can obtain your organization ID from the Viam app&#39;s organization settings page.</span>
 <span class="sd">            email (str): The email address associated with the invite.</span>
 
 <span class="sd">        Raises:</span>
 <span class="sd">            GRPCError: If no pending invite is associated with the provided email address.</span>
+
+<span class="sd">        Returns:</span>
+<span class="sd">            viam.proto.app.OrganizationInvite: The organization invite sent.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">request</span> <span class="o">=</span> <span class="n">ResendOrganizationInviteRequest</span><span class="p">(</span><span class="n">organization_id</span><span class="o">=</span><span class="n">org_id</span><span class="p">,</span> <span class="n">email</span><span class="o">=</span><span class="n">email</span><span class="p">)</span>
         <span class="n">response</span><span class="p">:</span> <span class="n">ResendOrganizationInviteResponse</span> <span class="o">=</span> <span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">_app_client</span><span class="o">.</span><span class="n">ResendOrganizationInvite</span><span class="p">(</span><span class="n">request</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">_metadata</span><span class="p">)</span>
@@ -900,6 +910,7 @@ <h1>Source code for viam.app.app_client</h1><div class="highlight"><pre>
 
 <span class="sd">        Args:</span>
 <span class="sd">            org_id (str): The ID of the organization to create the location under.</span>
+<span class="sd">                You can obtain your organization ID from the Viam app&#39;s organization settings page.</span>
 <span class="sd">            name (str): Name of the location.</span>
 <span class="sd">            parent_location_id (Optional[str]): Optional parent location to put the location under. Defaults to a root-level location if no</span>
 <span class="sd">                location ID is provided.</span>
@@ -1003,6 +1014,7 @@ <h1>Source code for viam.app.app_client</h1><div class="highlight"><pre>
 
 <span class="sd">        Args:</span>
 <span class="sd">            org_id (str): The ID of the org to list locations for.</span>
+<span class="sd">                You can obtain your organization ID from the Viam app&#39;s organization settings page.</span>
 
 <span class="sd">        Returns:</span>
 <span class="sd">            List[viam.proto.app.Location]: The list of locations.</span>
@@ -1133,6 +1145,7 @@ <h1>Source code for viam.app.app_client</h1><div class="highlight"><pre>
 
 <span class="sd">        Args:</span>
 <span class="sd">            org_id (str): The ID of the organization to list rover rental robots for.</span>
+<span class="sd">                You can obtain your organization ID from the Viam app&#39;s organization settings page.</span>
 
 <span class="sd">        Returns:</span>
 <span class="sd">            List[viam.proto.app.RoverRentalRobot]: The list of rover rental robots.</span>
@@ -1572,6 +1585,7 @@ <h1>Source code for viam.app.app_client</h1><div class="highlight"><pre>
 
 <span class="sd">        Args:</span>
 <span class="sd">            org_id (str): The ID of the organization to list fragments for.</span>
+<span class="sd">                You can obtain your organization ID from the Viam app&#39;s organization settings page.</span>
 <span class="sd">            show_public: Optional boolean specifying whether or not to only show public fragments. If True, only public fragments will</span>
 <span class="sd">                return. If False, only private fragments will return. Defaults to True.</span>
 
@@ -1613,7 +1627,8 @@ <h1>Source code for viam.app.app_client</h1><div class="highlight"><pre>
 <span class="sd">            new_fragment = await cloud.create_fragment(org_id=&quot;org-id&quot;, name=&quot;cool_smart_machine_to_configure_several_of&quot;)</span>
 
 <span class="sd">        Args:</span>
-<span class="sd">            org_id (str): The ID of the organization to create the ragment within.</span>
+<span class="sd">            org_id (str): The ID of the organization to create the fragment within.</span>
+<span class="sd">                You can obtain your organization ID from the Viam app&#39;s organization settings page.</span>
 <span class="sd">            name (str): Name of the fragment.</span>
 <span class="sd">            config (Optional[Mapping[str, Any]]): Optional Dictionary representation of new config to assign to specified fragment. Can be</span>
 <span class="sd">                assigned by updating the fragment.</span>
@@ -1695,6 +1710,7 @@ <h1>Source code for viam.app.app_client</h1><div class="highlight"><pre>
 
 <span class="sd">        Args:</span>
 <span class="sd">            org_id (str): The ID of the organization to create the role in.</span>
+<span class="sd">                You can obtain your organization ID from the Viam app&#39;s organization settings page.</span>
 <span class="sd">            identity_id (str): ID of the entity the role belongs to (e.g., a user ID).</span>
 <span class="sd">            role (Union[Literal[&quot;owner&quot;], Literal[&quot;operator&quot;]]): The role to add.</span>
 <span class="sd">            resource_type (Union[Literal[&quot;organization&quot;], Literal[&quot;location&quot;], Literal[&quot;robot&quot;]]): Type of the resource to add role to.</span>
@@ -1736,6 +1752,7 @@ <h1>Source code for viam.app.app_client</h1><div class="highlight"><pre>
 
 <span class="sd">        Args:</span>
 <span class="sd">            org_id (str): The ID of the organization the role exists in.</span>
+<span class="sd">                You can obtain your organization ID from the Viam app&#39;s organization settings page.</span>
 <span class="sd">            identity_id (str): ID of the entity the role belongs to (e.g., a user ID).</span>
 <span class="sd">            role (Union[Literal[&quot;owner&quot;], Literal[&quot;operator&quot;]]): The role to remove.</span>
 <span class="sd">            resource_type (Union[Literal[&quot;organization&quot;], Literal[&quot;location&quot;], Literal[&quot;robot&quot;]]): Type of the resource the role is being</span>
@@ -1981,6 +1998,7 @@ <h1>Source code for viam.app.app_client</h1><div class="highlight"><pre>
 
 <span class="sd">        Args:</span>
 <span class="sd">            org_id (str): The ID of the organization to create the module under.</span>
+<span class="sd">                You can obtain your organization ID from the Viam app&#39;s organization settings page.</span>
 <span class="sd">            name (str): The name of the module. Must be unique within your organization.</span>
 
 <span class="sd">        Raises:</span>
@@ -2092,6 +2110,7 @@ <h1>Source code for viam.app.app_client</h1><div class="highlight"><pre>
 
 <span class="sd">        Args:</span>
 <span class="sd">            org_id (str): The ID of the organization to list modules for.</span>
+<span class="sd">                You can obtain your organization ID from the Viam app&#39;s organization settings page.</span>
 
 <span class="sd">        Returns:</span>
 <span class="sd">            List[viam.proto.app.Module]: The list of modules.</span>
@@ -2119,6 +2138,7 @@ <h1>Source code for viam.app.app_client</h1><div class="highlight"><pre>
 
 <span class="sd">        Args:</span>
 <span class="sd">            org_id (str): The ID of the organization to create the key for.</span>
+<span class="sd">                You can obtain your organization ID from the Viam app&#39;s organization settings page.</span>
 <span class="sd">            authorizations (List[viam.proto.app.Authorization]): A list of authorizations to associate</span>
 <span class="sd">                with the key.</span>
 <span class="sd">            name (Optional[str]): A name for the key. If None, defaults to the current timestamp.</span>
@@ -2178,6 +2198,7 @@ <h1>Source code for viam.app.app_client</h1><div class="highlight"><pre>
 
 <span class="sd">        Args:</span>
 <span class="sd">            org_id (str): The ID of the organization to list API keys for.</span>
+<span class="sd">                You can obtain your organization ID from the Viam app&#39;s organization settings page.</span>
 
 <span class="sd">        Returns:</span>
 <span class="sd">            List[viam.proto.app.APIKeyWithAuthorizations]: The existing API keys and authorizations.&quot;&quot;&quot;</span>