docs: Improve code samples in docs (box/box-codegen#661) (#475)

Author: box-sdk-build

.codegen.json

@@ -1 +1 @@
-{ "engineHash": "cb61d82", "specHash": "59747aa", "version": "1.11.0" }
+{ "engineHash": "2c730de", "specHash": "59747aa", "version": "1.11.0" }

docs/ai.md

@@ -19,20 +19,16 @@ See the endpoint docs at
 
 ```python
 client.ai.create_ai_ask(
-    CreateAiAskMode.MULTIPLE_ITEM_QA,
-    "Which direction sun rises?",
+    CreateAiAskMode.SINGLE_ITEM_QA,
+    "which direction sun rises",
     [
         AiItemAsk(
-            id=file_to_ask_1.id,
-            type=AiItemAskTypeField.FILE,
-            content="Earth goes around the sun",
-        ),
-        AiItemAsk(
-            id=file_to_ask_2.id,
+            id=file_to_ask.id,
             type=AiItemAskTypeField.FILE,
-            content="Sun rises in the East in the morning",
-        ),
+            content="Sun rises in the East",
+        )
     ],
+    ai_agent=ai_ask_agent_config,
 )
 ```
 
@@ -127,9 +123,7 @@ See the endpoint docs at
 <!-- sample get_ai_agent_default -->
 
 ```python
-client.ai.get_ai_agent_default_config(
-    GetAiAgentDefaultConfigMode.EXTRACT_STRUCTURED, language="en-US"
-)
+client.ai.get_ai_agent_default_config(GetAiAgentDefaultConfigMode.ASK, language="en-US")
 ```
 
 ### Arguments
@@ -212,9 +206,48 @@ See the endpoint docs at
 ```python
 client.ai.create_ai_extract_structured(
     [AiItemBase(id=file.id)],
-    metadata_template=CreateAiExtractStructuredMetadataTemplate(
-        template_key=template_key, scope="enterprise"
-    ),
+    fields=[
+        CreateAiExtractStructuredFields(
+            key="firstName",
+            display_name="First name",
+            description="Person first name",
+            prompt="What is the your first name?",
+            type="string",
+        ),
+        CreateAiExtractStructuredFields(
+            key="lastName",
+            display_name="Last name",
+            description="Person last name",
+            prompt="What is the your last name?",
+            type="string",
+        ),
+        CreateAiExtractStructuredFields(
+            key="dateOfBirth",
+            display_name="Birth date",
+            description="Person date of birth",
+            prompt="What is the date of your birth?",
+            type="date",
+        ),
+        CreateAiExtractStructuredFields(
+            key="age",
+            display_name="Age",
+            description="Person age",
+            prompt="How old are you?",
+            type="float",
+        ),
+        CreateAiExtractStructuredFields(
+            key="hobby",
+            display_name="Hobby",
+            description="Person hobby",
+            prompt="What is your hobby?",
+            type="multiSelect",
+            options=[
+                CreateAiExtractStructuredFieldsOptionsField(key="guitar"),
+                CreateAiExtractStructuredFieldsOptionsField(key="books"),
+            ],
+        ),
+    ],
+    ai_agent=agent_ignoring_overriding_embeddings_model,
 )
 ```
 

docs/collaboration_allowlist_entries.md

@@ -82,7 +82,9 @@ See the endpoint docs at
 <!-- sample get_collaboration_whitelist_entries_id -->
 
 ```python
-client.collaboration_allowlist_entries.get_collaboration_whitelist_entry_by_id(entry.id)
+client.collaboration_allowlist_entries.get_collaboration_whitelist_entry_by_id(
+    new_entry.id
+)
 ```
 
 ### Arguments

docs/collaboration_allowlist_exempt_targets.md

@@ -81,7 +81,7 @@ See the endpoint docs at
 
 ```python
 client.collaboration_allowlist_exempt_targets.get_collaboration_whitelist_exempt_target_by_id(
-    exempt_target.id
+    new_exempt_target.id
 )
 ```
 

docs/comments.md

@@ -146,8 +146,7 @@ See the endpoint docs at
 
 ```python
 client.comments.create_comment(
-    message,
-    CreateCommentItem(id=new_comment.id, type=CreateCommentItemTypeField.COMMENT),
+    message, CreateCommentItem(id=file_id, type=CreateCommentItemTypeField.FILE)
 )
 ```
 

docs/device_pinners.md

@@ -75,9 +75,7 @@ See the endpoint docs at
 <!-- sample get_enterprises_id_device_pinners -->
 
 ```python
-client.device_pinners.get_enterprise_device_pinners(
-    enterprise_id, direction=GetEnterpriseDevicePinnersDirection.DESC
-)
+client.device_pinners.get_enterprise_device_pinners(enterprise_id)
 ```
 
 ### Arguments

docs/docgen_template.md

@@ -19,9 +19,7 @@ See the endpoint docs at
 <!-- sample post_docgen_templates_v2025.0 -->
 
 ```python
-client.docgen_template.create_docgen_template_v2025_r0(
-    FileReferenceV2025R0(id=uploaded_file.id)
-)
+client.docgen_template.create_docgen_template_v2025_r0(FileReferenceV2025R0(id=file.id))
 ```
 
 ### Arguments

docs/events.md

@@ -82,12 +82,7 @@ See the endpoint docs at
 <!-- sample get_events -->
 
 ```python
-client.events.get_events(
-    stream_type=GetEventsStreamType.ADMIN_LOGS,
-    limit=1,
-    created_after=created_after_date,
-    created_before=created_before_date,
-)
+client.events.get_events()
 ```
 
 ### Arguments

docs/file_metadata.md

@@ -91,16 +91,7 @@ See the endpoint docs at
 
 ```python
 client.file_metadata.create_file_metadata_by_id(
-    file.id,
-    CreateFileMetadataByIdScope.ENTERPRISE,
-    template_key,
-    {
-        "name": "John",
-        "age": 23,
-        "birthDate": "2001-01-03T02:20:50.520Z",
-        "countryCode": "US",
-        "sports": ["basketball", "tennis"],
-    },
+    file.id, CreateFileMetadataByIdScope.GLOBAL, "properties", {"abc": "xyz"}
 )
 ```
 
@@ -190,7 +181,7 @@ See the endpoint docs at
 
 ```python
 client.file_metadata.delete_file_metadata_by_id(
-    file.id, DeleteFileMetadataByIdScope.ENTERPRISE, template_key
+    file.id, DeleteFileMetadataByIdScope.GLOBAL, "properties"
 )
 ```
 

docs/file_requests.md

@@ -17,7 +17,7 @@ See the endpoint docs at
 <!-- sample get_file_requests_id -->
 
 ```python
-client.file_requests.get_file_request_by_id(updated_file_request.id)
+client.file_requests.get_file_request_by_id(file_request_id)
 ```
 
 ### Arguments