docs info description

Author: ishaileshmishra

src/main/java/com/contentstack/cms/core/CMSRuntimeException.java

@@ -7,8 +7,6 @@
  * @version 1.0.0
  * @since 2022-05-19
  */
-public class CMSRuntimeException extends Exception {
-    public CMSRuntimeException(String message) {
+public class CMSRuntimeException extends Exception { public CMSRuntimeException(String message) {
         super(message);
-    }
-}
+    }}

src/main/java/com/contentstack/cms/core/ContentstackResponse.java

@@ -19,7 +19,6 @@ public class ContentstackResponse<T> {
 
     Call<ResponseBody> response;
 
-
     public Response<ResponseBody> fetch(Call<ResponseBody> response) {
         try {
             return response.execute();

src/main/java/com/contentstack/cms/core/ObjectModel.java

@@ -8,7 +8,7 @@
 
 
 /**
- * The Utility class that contains utility common functions
+ * The utility class that contains utility common functions
  *
  * @author ***REMOVED***
  * @version 1.0.0
@@ -80,8 +80,7 @@ public static void assertionError() {
     }
 
     public static RequestBody toRequestBody(String bodyString) {
-        return RequestBody.create(MediaType.parse("application/json; charset=UTF-8"),
-                bodyString);
+        return RequestBody.create(MediaType.parse("application/json; charset=UTF-8"), bodyString);
     }
 
 }

src/main/java/com/contentstack/cms/core/Util.java

@@ -1,5 +1,6 @@
 package com.contentstack.cms.stack;
 
+import com.contentstack.cms.core.Util;
 import okhttp3.ResponseBody;
 import org.jetbrains.annotations.NotNull;
 import org.json.simple.JSONObject;
@@ -26,7 +27,7 @@ public class Environment {
     protected Environment(Retrofit instance, @NotNull Map<String, Object> stackHeaders) {
         this.headers = new HashMap<>();
         this.params = new HashMap<>();
-        this.headers.put("Content-Type", "application/json");
+        this.headers.put(Util.CONTENT_TYPE, Util.CONTENT_TYPE_VALUE);
         this.headers.putAll(stackHeaders);
         this.service = instance.create(EnvironmentService.class);
     }
@@ -90,6 +91,13 @@ protected void clearParams() {
      * </pre>
      *
      * @return Call
+     * @see <a
+     * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#environment-collection">Get all
+     * environments
+     * </a>
+     * @see #addHeader(String, Object) to add headers
+     * @see #addParam(String, Object) to add query parameters
+     * @since 1.0.0
      */
     public Call<ResponseBody> fetch() {
         return this.service.fetch(this.headers, this.params);
@@ -103,10 +111,17 @@ public Call<ResponseBody> fetch() {
      * logging into your account.
      *
      * @param environment
-     *         name of the environment
+     *         The name of the environment
      * @return Call
+     * @see <a
+     * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#get-a-single-environment">Get a
+     * single environments
+     * </a>
+     * @see #addHeader(String, Object) to add headers
+     * @see #addParam(String, Object) to add query parameters
+     * @since 1.0.0
      */
-    public Call<ResponseBody> get(@NotNull String environment) {
+    public Call<ResponseBody> single(@NotNull String environment) {
         return this.service.getEnv(this.headers, environment);
     }
 
@@ -120,12 +135,24 @@ public Call<ResponseBody> get(@NotNull String environment) {
      * In the 'Body' section, mention the environment name, server names that are part of the environment, the urls
      * (which include the language code and the URL of the server), and the option to deploy content to a server.
      *
-     * @param requestBody
-     *         request body of type @{@link JSONObject}
+     * @param body
+     *         The {@link JSONObject} request body<br>
+     *         <b>Example:</b>
+     *         <pre
      * @return Call
+     * @code{ { "environment": { "name": "development", "servers": [ { "name": "default" } ], "urls": [ { "locale":
+     * "en-us", "url": "http://example.com/" } ], "deploy_content": true } }}
+     * </pre>
+     * @see <a
+     * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#environment-collection">Get all
+     * environments
+     * </a>
+     * @see #addHeader(String, Object) to add headers
+     * @see #addParam(String, Object) to add query parameters
+     * @since 1.0.0
      */
-    public Call<ResponseBody> add(@NotNull JSONObject requestBody) {
-        return this.service.add(this.headers, requestBody);
+    public Call<ResponseBody> create(@NotNull JSONObject body) {
+        return this.service.add(this.headers, body);
     }
 
 
@@ -140,10 +167,15 @@ public Call<ResponseBody> add(@NotNull JSONObject requestBody) {
      * the option to deploy content to a server.
      *
      * @param environmentName
-     *         name of the environment
+     *         The name of the environment
      * @param requestBody
      *         request body of type @{@link JSONObject}
      * @return Call
+     * @see <a
+     * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#update-environment">Update
+     * Environment
+     * @see #addHeader(String, Object) to add headers to the request
+     * @since 1.0.0
      */
     public Call<ResponseBody> update(@NotNull String environmentName, @NotNull JSONObject requestBody) {
         return this.service.update(this.headers, environmentName, requestBody);
@@ -157,8 +189,13 @@ public Call<ResponseBody> update(@NotNull String environmentName, @NotNull JSONO
      * authtoken that you receive after logging into your account.
      *
      * @param environmentName
-     *         name of the environment
+     *         The name of the environment
      * @return Call
+     * @see <a
+     * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#delete-environment">Delete
+     * Environment
+     * @see #addHeader(String, Object) to add headers to the request
+     * @since 1.0.0
      */
     public Call<ResponseBody> delete(@NotNull String environmentName) {
         return this.service.delete(this.headers, environmentName);

src/main/java/com/contentstack/cms/stack/Environment.java

@@ -38,11 +38,6 @@ protected Extensions(Retrofit retrofit, HashMap<String, Object> stackHeaders) {
         this.service = retrofit.create(ExtensionsService.class);
     }
 
-    public Extensions addHeader(@NotNull String key, @NotNull String value) {
-        this.headers.put(key, value);
-        return this;
-    }
-
     /**
      * Sets header for the request
      *
@@ -59,58 +54,75 @@ public void addHeader(@NotNull String key, @NotNull Object value) {
      * Sets header for the request
      *
      * @param key
-     *         header key for the request
+     *         query param key for the request
      * @param value
-     *         header value for the request
+     *         query param value for the request
      */
     public void addParam(@NotNull String key, @NotNull Object value) {
         this.params.put(key, value);
     }
 
 
     /**
-     * Sets header for the request
+     * Set header for the request
      *
      * @param key
-     *         header key for the request
+     *         Removes query param using key of request
      */
     public void removeParam(@NotNull String key) {
         this.params.remove(key);
     }
 
 
     /**
-     * To clear all the params
+     * To clear all the query params
      */
     protected void clearParams() {
         this.params.clear();
     }
 
+
     /**
      * The Get all custom fields request is used to get the information of all custom fields created in a stack.
      *
-     * @param query
-     *         For custom fields  <b>Example:"type":"field"</b>
-     * @param isIncludeBranch
-     *         Set this to 'true' to include the '_branch' top-level key in the response. This key states the unique ID
-     *         of the branch where the concerned Contentstack module resides.
-     *         <b>Example:false</b>
+     * <dl>
+     *   <dt>query</dt>
+     *   <dd>For custom fields  <b>Example:"type":"field"</b></dd>
+     *   <dt>include_branch</dt>
+     *   <dd>Set this to 'true' to include the '_branch' top-level key in the response. This key states the unique ID
+     *      of the branch where the concerned Contentstack module resides</dd>
+     * </dl>
+     *
      * @return Call
+     * @see <a
+     * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#get-all-custom-fields">Get all
+     * Custom Field
+     * </a>
+     * @see #addHeader(String, Object) to add headers
+     * @see #addParam(String, Object) to add query parameters
+     * @since 1.0.0
      */
-    public Call<ResponseBody> fetch(@NotNull String query, boolean isIncludeBranch) {
-        return this.service.getAll(this.headers, query, isIncludeBranch);
+    public Call<ResponseBody> fetch() {
+        return this.service.getAll(this.headers, this.params);
     }
 
 
     /**
      * @param customFieldUid
-     *         Enter the UID of the custom field of which you want to retrieve the details.
-     *         <br><br>
-     *         {@link #addParam(String, Object)} Set this to 'true' to include the '_branch' top-level key in the
-     *         response. This key states the unique ID of the branch where the concerned Contentstack module resides.
-     *         <p>
-     *         <b>Example:false</b>
+     *         Enter the UID of the custom field of which you want to retrieve the details.<br>
+     *          <dl>
+     *            <dt>include_branch</dt>
+     *            <dd>Set this to 'true' to include the '_branch' top-level key in the response.
+     *            This key states the unique ID of the branch where the concerned Contentstack module resides.</dd>
+     *         </dl>
      * @return Call
+     * @see <a
+     * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#get-a-single-custom-field">Get a
+     * Single Custom Field
+     * </a>
+     * @see #addHeader(String, Object) to add headers
+     * @see #addParam(String, Object) to add query parameters
+     * @since 1.0.0
      */
     public Call<ResponseBody> single(@NotNull String customFieldUid) {
         this.headers.put(Util.CONTENT_TYPE, "multipart/form-data");
@@ -135,6 +147,13 @@ public Call<ResponseBody> single(@NotNull String customFieldUid) {
      * @param body
      *         the request body
      * @return Call
+     * @see <a
+     * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#upload-a-custom-field">Upload a
+     * custom field
+     * </a>
+     * @see #addHeader(String, Object) to add headers
+     * @see #addParam(String, Object) to add query parameters
+     * @since 1.0.0
      */
     public Call<ResponseBody> uploadCustomField(Map<String, RequestBody> body) {
         this.headers.put(Util.CONTENT_TYPE, "multipart/form-data");
@@ -158,6 +177,13 @@ public Call<ResponseBody> uploadCustomField(Map<String, RequestBody> body) {
      * @param body
      *         the request body
      * @return Call
+     * @see <a
+     * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#upload-a-custom-field">Upload a
+     * custom field
+     * </a>
+     * @see #addHeader(String, Object) to add headers
+     * @see #addParam(String, Object) to add query parameters
+     * @since 1.0.0
      */
     public Call<ResponseBody> uploadCustomField(JSONObject body) {
         this.headers.put(Util.CONTENT_TYPE, "application/json");
@@ -175,6 +201,12 @@ public Call<ResponseBody> uploadCustomField(JSONObject body) {
      * @param body
      *         JSON requestBody
      * @return Call
+     * @see <a
+     * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#update-a-custom-field">Update a
+     * custom field
+     * </a>
+     * @see #addHeader(String, Object) to add headers
+     * @since 1.0.0
      */
     public Call<ResponseBody> update(@NotNull String customFieldUid, JSONObject body) {
         if (body == null) {
@@ -194,6 +226,12 @@ public Call<ResponseBody> update(@NotNull String customFieldUid, JSONObject body
      * @param customFieldUid
      *         UID of the custom field that you want to update
      * @return Call
+     * @see <a
+     * href="https://www.contentstack.com/docs/developers/apis/content-management-api/#delete-custom-field">Delete a
+     * custom field
+     * </a>
+     * @see #addHeader(String, Object) to add headers
+     * @since 1.0.0
      */
     public Call<ResponseBody> delete(@NotNull String customFieldUid) {
         return this.service.delete(this.headers, customFieldUid);

src/main/java/com/contentstack/cms/stack/Extensions.java

@@ -14,8 +14,7 @@ public interface ExtensionsService {
     @GET("extensions")
     Call<ResponseBody> getAll(
             @HeaderMap Map<String, Object> headers,
-            @Query("query") String query,
-            @Query("include_branch") Boolean isIncludeBranch);
+            @QueryMap(encoded = true) Map<String, Object> query);
 
     @GET("extensions/{custom_field_uid}")
     Call<ResponseBody> getSingle(