Sync open source content 🐝 (from 7dc36ffbb1f4910128197ad168e8bdff812720e8)

Author: beezythebot

docs/customize/code/code-regions/java.mdx

@@ -33,10 +33,21 @@ Java SDK classes can have two code regions:
 - `// #region imports` - allows the addition of imports to an SDK file needed for
   custom methods and properties. This region must be located at the top of the
   file alongside generated imports.
-- `// #region sdk-class-body` - allows the addition of custom methods and
+- `// #region class-body` - allows the addition of custom methods and
   properties to an SDK class. This region must be located in the body of a Java
   SDK class alongside generated methods and properties.
 
+### Model classes
+
+Java model classes can also have custom code regions:
+
+- `// #region imports` - allows the addition of imports to a model file needed for
+  custom methods and properties. This region must be located at the top of the
+  file alongside generated imports.
+- `// #region class-body` - allows the addition of custom methods and
+  properties to a model class. This region must be located in the body of a Java
+  model class alongside generated methods and properties.
+
 ## Managing dependencies
 
 When adding custom code that requires external packages, configure these dependencies in the `.speakeasy/gen.yaml` file to prevent them from being removed during SDK regeneration. Use the `additionalDependencies` configuration to specify package dependencies:
@@ -82,7 +93,7 @@ public class Todos implements
     }
 
     // !focus(1:11)
-    // #region sdk-class-body
+    // #region class-body
     public String renderTodo(String id) throws Exception {
         Todo todo = getOne(id).todo()
             .orElseThrow(() -> new Exception("Todo not found"));
@@ -94,11 +105,107 @@ public class Todos implements
 
         return renderer.render(parser.parse(markdown));
     }
-    // #endregion sdk-class-body
+    // #endregion class-body
 
     public Todo getOne(String id) throws Exception {
         // Generated method implementation
         ...
     }
 }
 ```
+
+## Model class example
+
+You can also add custom methods to model classes. Here's an example of adding a `render()` method to a `Todo` model class:
+
+```java src/main/java/com/example/sdk/models/components/Todo.java
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+package com.example.sdk.models.components;
+
+import java.util.Objects;
+
+// !focus(1:3)
+// #region imports
+import org.commonmark.parser.Parser;
+import org.commonmark.renderer.html.HtmlRenderer;
+// #endregion imports
+
+import com.example.sdk.utils.Utils;
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+public class Todo {
+
+    @JsonProperty("id")
+    private String id;
+
+    @JsonProperty("title")
+    private String title;
+
+    @JsonProperty("description")
+    private String description;
+
+    @JsonProperty("completed")
+    private boolean completed;
+
+    @JsonCreator
+    public Todo(
+            @JsonProperty("id") String id,
+            @JsonProperty("title") String title,
+            @JsonProperty("description") String description,
+            @JsonProperty("completed") boolean completed) {
+        Utils.checkNotNull(id, "id");
+        Utils.checkNotNull(title, "title");
+        Utils.checkNotNull(description, "description");
+        Utils.checkNotNull(completed, "completed");
+        this.id = id;
+        this.title = title;
+        this.description = description;
+        this.completed = completed;
+    }
+
+    @JsonIgnore
+    public String id() {
+        return id;
+    }
+
+    @JsonIgnore
+    public String title() {
+        return title;
+    }
+
+    @JsonIgnore
+    public String description() {
+        return description;
+    }
+
+    @JsonIgnore
+    public boolean completed() {
+        return completed;
+    }
+
+    // !focus(1:8)
+    // #region class-body
+    public String render() throws Exception {
+        Parser parser = Parser.builder().build();
+        HtmlRenderer renderer = HtmlRenderer.builder().build();
+        String markdown = String.format("# %s\n\n%s", title(), description());
+
+        return renderer.render(parser.parse(markdown));
+    }
+    // #endregion class-body
+
+    // Generated methods continue...
+}
+```
+
+This allows you to use the custom method like so:
+
+```java
+Todo todo = ...;
+String rendered = todo.render();
+```