fetchActivity() {
*
* @return Call
* @see Cancel
- * scheduled action
+ * "https://www.contentstack.com/docs/developers/apis/content-management-api/#cancel-scheduled-action">Cancel
+ * scheduled action
*
- *
- * @see #addHeader(String, Object) to add headers
+ *
+ * @see #addHeader(String, String) to add headers
* @see #addParam(String, Object) to add query parameters
* @since 0.1.0
*/
diff --git a/src/main/java/com/contentstack/cms/stack/Release.java b/src/main/java/com/contentstack/cms/stack/Release.java
index dd62d0aa..3a137082 100644
--- a/src/main/java/com/contentstack/cms/stack/Release.java
+++ b/src/main/java/com/contentstack/cms/stack/Release.java
@@ -1,5 +1,6 @@
package com.contentstack.cms.stack;
+import com.contentstack.cms.BaseImplementation;
import okhttp3.ResponseBody;
import org.jetbrains.annotations.NotNull;
import org.json.simple.JSONObject;
@@ -12,7 +13,7 @@
* You can pin a set of entries and assets (along with the deploy action, i.e.,
* publish/unpublish) to a ‘release’, and
* then deploy this release to an environment. This will publish/unpublish all
- * the the items of the release to the
+ * the items of the release to the
* specified environment. Read more about Releases.
*
* You can now pass the branch header in the API request to fetch or manage
@@ -29,7 +30,7 @@
* @version v0.1.0
* @since 2022-10-22
*/
-public class Release {
+public class Release implements BaseImplementation {
protected final ReleaseService service;
protected HashMap headers;
@@ -57,24 +58,60 @@ void validate() {
throw new IllegalAccessError("Release Uid Can Not Be Null OR Empty");
}
+
/**
- * Sets header for the request
- *
- * @param key header key for the request
- * @param value header value for the request
+ * @param key A string representing the key of the parameter. It cannot be
+ * null and must be
+ * provided as a non-null value.
+ * @param value The "value" parameter is of type Object, which means it can
+ * accept any type of
+ * object as its value.
+ * @return instance of Release
+ */
+ @Override
+ public Release addParam(@NotNull String key, @NotNull Object value) {
+ this.params.put(key, value);
+ return this;
+ }
+
+ /**
+ * @param key The key parameter is a string that represents the name or
+ * identifier of the header.
+ * It is used to specify the type of information being sent in the
+ * header.
+ * @param value The value parameter is a string that represents the value of the
+ * header.
+ * @return instance of Release
*/
- public void addHeader(@NotNull String key, @NotNull Object value) {
+ @Override
+ public Release addHeader(@NotNull String key, @NotNull String value) {
this.headers.put(key, value);
+ return this;
}
/**
- * Sets header for the request
- *
- * @param key query param key for the request
- * @param value query param value for the request
+ * @param params The "params" parameter is a HashMap that maps String keys to
+ * Object values. It is
+ * annotated with @NotNull, indicating that it cannot be null.
+ * @return instance of Release
*/
- public void addParam(@NotNull String key, @NotNull Object value) {
- this.params.put(key, value);
+ @Override
+ public Release addParams(@NotNull HashMap params) {
+ this.params.putAll(params);
+ return this;
+ }
+
+ /**
+ * @param headers A HashMap containing key-value pairs of headers, where the key
+ * is a String
+ * representing the header name and the value is a String
+ * representing the header value.
+ * @return instance of Release
+ */
+ @Override
+ public Release addHeaders(@NotNull HashMap headers) {
+ this.headers.putAll(headers);
+ return this;
}
/**
@@ -103,7 +140,7 @@ protected void clearParams() {
* "https://www.contentstack.com/docs/developers/apis/content-management-api/#get-all-releases">Get
* all Releases
*
- * @see #addHeader(String, Object) to add headers
+ * @see #addHeader(String, String) to add headers
* @see #addParam(String, Object) to add query parameters
* @since 0.1.0
*/
@@ -123,7 +160,7 @@ public Call find() {
* a singel
* release
*
- * @see #addHeader(String, Object) to add headers
+ * @see #addHeader(String, String) to add headers
* @see #addParam(String, Object) to add query parameters
* @since 0.1.0
*/
@@ -145,7 +182,7 @@ public Call fetch() {
* "https://www.contentstack.com/docs/developers/apis/content-management-api/#create-a-release">Create
* a release
*
- * @see #addHeader(String, Object) to add headers
+ * @see #addHeader(String, String) to add headers
* @see #addParam(String, Object) to add query parameters
* @since 0.1.0
*/
@@ -167,7 +204,7 @@ public Call create(@NotNull JSONObject requestBody) {
* "https://www.contentstack.com/docs/developers/apis/content-management-api/#update-a-release">Update
* a release
*
- * @see #addHeader(String, Object) to add headers
+ * @see #addHeader(String, String) to add headers
* @see #addParam(String, Object) to add query parameters
* @since 0.1.0
*/
@@ -187,7 +224,7 @@ public Call update(@NotNull JSONObject requestBody) {
* "https://www.contentstack.com/docs/developers/apis/content-management-api/#delete-a-release">Delete
* a release
*
- * @see #addHeader(String, Object) to add headers
+ * @see #addHeader(String, String) to add headers
* @see #addParam(String, Object) to add query parameters
* @since 0.1.0
*/
@@ -211,7 +248,7 @@ public Call delete() {
* a
* release item
*
- * @see #addHeader(String, Object) to add headers
+ * @see #addHeader(String, String) to add headers
* @see #addParam(String, Object) to add query parameters
* @since 0.1.0
*/
@@ -237,7 +274,7 @@ public ReleaseItem item() {
* "https://www.contentstack.com/docs/developers/apis/content-management-api/#deploy-a-release">Deploy
* a release
*
- * @see #addHeader(String, Object) to add headers
+ * @see #addHeader(String, String) to add headers
* @see #addParam(String, Object) to add query parameters
* @since 0.1.0
*/
@@ -260,7 +297,7 @@ public Call deploy(@NotNull JSONObject requestBody) {
* "https://www.contentstack.com/docs/developers/apis/content-management-api/#clone-a-release">Clone
* all release
*
- * @see #addHeader(String, Object) to add headers
+ * @see #addHeader(String, String) to add headers
* @since 0.1.0
*/
public Call clone(@NotNull JSONObject requestBody) {
diff --git a/src/main/java/com/contentstack/cms/stack/ReleaseItem.java b/src/main/java/com/contentstack/cms/stack/ReleaseItem.java
index c4cae1cb..c728ac5c 100644
--- a/src/main/java/com/contentstack/cms/stack/ReleaseItem.java
+++ b/src/main/java/com/contentstack/cms/stack/ReleaseItem.java
@@ -1,5 +1,6 @@
package com.contentstack.cms.stack;
+import com.contentstack.cms.BaseImplementation;
import okhttp3.ResponseBody;
import org.jetbrains.annotations.NotNull;
import org.json.simple.JSONObject;
@@ -21,7 +22,7 @@
* @version v0.1.0
* @since 2022-10-22
*/
-public class ReleaseItem {
+public class ReleaseItem implements BaseImplementation {
protected final ReleaseService service;
protected HashMap headers;
@@ -40,24 +41,60 @@ void validate() {
throw new IllegalAccessError("Release Uid can not be null or empty");
}
+
/**
- * Sets header for the request
- *
- * @param key header key for the request
- * @param value header value for the request
+ * @param key A string representing the key of the parameter. It cannot be
+ * null and must be
+ * provided as a non-null value.
+ * @param value The "value" parameter is of type Object, which means it can
+ * accept any type of
+ * object as its value.
+ * @return instance of {@link ReleaseItem}
+ */
+ @Override
+ public ReleaseItem addParam(@NotNull String key, @NotNull Object value) {
+ this.params.put(key, value);
+ return this;
+ }
+
+ /**
+ * @param key The key parameter is a string that represents the name or
+ * identifier of the header.
+ * It is used to specify the type of information being sent in the
+ * header.
+ * @param value The value parameter is a string that represents the value of the
+ * header.
+ * @return instance of {@link ReleaseItem}
*/
- public void addHeader(@NotNull String key, @NotNull Object value) {
+ @Override
+ public ReleaseItem addHeader(@NotNull String key, @NotNull String value) {
this.headers.put(key, value);
+ return this;
}
/**
- * Sets header for the request
- *
- * @param key query param key for the request
- * @param value query param value for the request
+ * @param params The "params" parameter is a HashMap that maps String keys to
+ * Object values. It is
+ * annotated with @NotNull, indicating that it cannot be null.
+ * @return instance of {@link ReleaseItem}
*/
- public void addParam(@NotNull String key, @NotNull Object value) {
- this.params.put(key, value);
+ @Override
+ public ReleaseItem addParams(@NotNull HashMap params) {
+ this.params.putAll(params);
+ return this;
+ }
+
+ /**
+ * @param headers A HashMap containing key-value pairs of headers, where the key
+ * is a String
+ * representing the header name and the value is a String
+ * representing the header value.
+ * @return instance of {@link ReleaseItem}
+ */
+ @Override
+ public ReleaseItem addHeaders(@NotNull HashMap headers) {
+ this.headers.putAll(headers);
+ return this;
}
/**
@@ -98,7 +135,7 @@ public Call find() {
* 'Body' section, you need to provide
* the details of the item such as the UID, version (of the entry), content type
* UID (of an entry), the action to be
- * performed (publish/unpublish), and the locale of the item.
+ * performed (publish/un-publish), and the locale of the item.
*
* @param jsonBody requestBody for create/add single Item
* @return Call
@@ -116,7 +153,7 @@ public Call create(@NotNull JSONObject jsonBody) {
* 'Body' section, you need to provide
* the details of the items such as their UIDs, versions (in case of entries),
* content type UIDs (in case of
- * entries), the action to be performed (publish/unpublish), and the locales of
+ * entries), the action to be performed (publish/un-publish), and the locales of
* the items.
*
* @param jsonBody requestBody for create/add single Item
@@ -184,7 +221,7 @@ public Call update(@NotNull JSONObject jsonBody) {
* section, you need to provide the
* details of the item such as their UIDs, version (of the entry), content type
* UID (of an entry), the action to be
- * performed (publish/unpublish), and the locale of the item.
+ * performed (publish/un-publish), and the locale of the item.
*
* OR
*
@@ -196,7 +233,7 @@ public Call update(@NotNull JSONObject jsonBody) {
* section, you need to provide the UIDs
* of the items along with details such as their locale, versions, the action to
* be performed on the items
- * (publish/unpublish), and content type UID of entries (if any).
+ * (publish/un-publish), and content type UID of entries (if any).
*
* @return Call
*/
diff --git a/src/main/java/com/contentstack/cms/stack/Roles.java b/src/main/java/com/contentstack/cms/stack/Roles.java
index a2848215..2b85a2ee 100644
--- a/src/main/java/com/contentstack/cms/stack/Roles.java
+++ b/src/main/java/com/contentstack/cms/stack/Roles.java
@@ -1,5 +1,6 @@
package com.contentstack.cms.stack;
+import com.contentstack.cms.BaseImplementation;
import okhttp3.ResponseBody;
import org.jetbrains.annotations.NotNull;
import org.json.simple.JSONObject;
@@ -11,17 +12,15 @@
/**
* A role is a collection of permissions that will be applicable to all the
* users who are assigned this role.
- *
*
* @author ishaileshmishra
* @version v0.1.0
* @see Roles
- *
- *
+ * "https://www.contentstack.com/docs/developers/invite-users-and-assign-roles/about-stack-roles">Roles
+ *
* @since 2022-10-22
*/
-public class Roles {
+public class Roles implements BaseImplementation {
protected final RolesService service;
protected HashMap headers;
@@ -46,35 +45,11 @@ void validate() {
throw new IllegalAccessError("Role uid can not be null or empty");
}
- /**
- * Sets header for the request
- *
- * @param key
- * header key for the request
- * @param value
- * header value for the request
- */
- public void addHeader(@NotNull String key, @NotNull Object value) {
- this.headers.put(key, value);
- }
-
- /**
- * Sets header for the request
- *
- * @param key
- * query param key for the request
- * @param value
- * query param value for the request
- */
- public void addParam(@NotNull String key, @NotNull Object value) {
- this.params.put(key, value);
- }
/**
* Set header for the request
*
- * @param key
- * Removes query param using key of request
+ * @param key Removes query param using key of request
*/
public void removeParam(@NotNull String key) {
this.params.remove(key);
@@ -100,11 +75,11 @@ protected void clearParams() {
*
* @return Call
* @see Get
- * all
- * Roles
- *
- * @see #addHeader(String, Object) to add headers
+ * "https://www.contentstack.com/docs/developers/apis/content-management-api/#get-all-roles">Get
+ * all
+ * Roles
+ *
+ * @see #addHeader(String, String) to add headers
* @see #addParam(String, Object) to add query parameters
* @since 0.1.0
*/
@@ -118,11 +93,11 @@ public Call find() {
*
* @return Call
* @see Get
- * a
- * single Roles
- *
- * @see #addHeader(String, Object) to add headers
+ * "https://www.contentstack.com/docs/developers/apis/content-management-api/#get-a-single-role">Get
+ * a
+ * single Roles
+ *
+ * @see #addHeader(String, String) to add headers
* @see #addParam(String, Object) to add query parameters
* @since 0.1.0
*/
@@ -140,15 +115,14 @@ public Call fetch() {
* permissions (which include the details of
* the content types, environments, and languages that are accessible).
*
- * @param requestBody
- * details of the delivery role in @{@link JSONObject} format
+ * @param requestBody details of the delivery role in @{@link JSONObject} format
* @return Call
* @see Create
- * a
- * Roles
- *
- * @see #addHeader(String, Object) to add headers
+ * "https://www.contentstack.com/docs/developers/apis/content-management-api/#create-a-role">Create
+ * a
+ * Roles
+ *
+ * @see #addHeader(String, String) to add headers
* @since 0.1.0
*/
public Call create(@NotNull JSONObject requestBody) {
@@ -167,14 +141,13 @@ public Call create(@NotNull JSONObject requestBody) {
* (which include the details of the content types, environments, and languages
* that are accessible).
*
- * @param requestBody
- * the body should be of @{@link JSONObject} type
+ * @param requestBody the body should be of @{@link JSONObject} type
* @return Call
* @see Update
- * Role
- *
- * @see #addHeader(String, Object) to add headers
+ * "https://www.contentstack.com/docs/developers/apis/content-management-api/#update-role">Update
+ * Role
+ *
+ * @see #addHeader(String, String) to add headers
* @see #addParam(String, Object) to add query parameters
* @since 0.1.0
*/
@@ -188,11 +161,11 @@ public Call update(@NotNull JSONObject requestBody) {
*
* @return Call
* @see Delete
- * a
- * Role
- *
- * @see #addHeader(String, Object) to add headers
+ * "https://www.contentstack.com/docs/developers/apis/content-management-api/#delete-role">Delete
+ * a
+ * Role
+ *
+ * @see #addHeader(String, String) to add headers
* @since 0.1.0
*/
public Call delete() {
@@ -200,4 +173,27 @@ public Call delete() {
return this.service.deleteRole(this.headers, this.roleUid);
}
+ @Override
+ public Roles addParam(@NotNull String key, @NotNull Object value) {
+ this.params.put(key, value);
+ return this;
+ }
+
+ @Override
+ public Roles addHeader(@NotNull String key, @NotNull String value) {
+ this.headers.put(key, value);
+ return this;
+ }
+
+ @Override
+ public Roles addParams(@NotNull HashMap params) {
+ this.params.putAll(params);
+ return this;
+ }
+
+ @Override
+ public Roles addHeaders(@NotNull HashMap headers) {
+ this.headers.putAll(headers);
+ return this;
+ }
}
diff --git a/src/main/java/com/contentstack/cms/stack/Stack.java b/src/main/java/com/contentstack/cms/stack/Stack.java
index 55054c5f..2bd21fd4 100644
--- a/src/main/java/com/contentstack/cms/stack/Stack.java
+++ b/src/main/java/com/contentstack/cms/stack/Stack.java
@@ -1,5 +1,6 @@
package com.contentstack.cms.stack;
+import com.contentstack.cms.BaseImplementation;
import okhttp3.ResponseBody;
import org.jetbrains.annotations.NotNull;
import org.json.simple.JSONObject;
@@ -16,9 +17,9 @@
*
* @author ishaileshmishra
* @version v0.1.0
- * @since 2022-10-22
+ * @since 2022 -10-22
*/
-public class Stack {
+public class Stack implements BaseImplementation {
private final StackService service;
protected Retrofit client;
@@ -37,24 +38,6 @@ public Stack(@NotNull Retrofit client) {
this.service = client.create(StackService.class);
}
- /**
- * The addHeader function adds a key-value pair to the headers map and returns
- * the updated Stack
- * object.
- *
- * @param key A string representing the key of the header. It is marked
- * as @NotNull, which means it
- * cannot be null and must be provided.
- * @param value The value parameter is of type Object, which means it can accept
- * any type of object as
- * its value.
- * @return The method is returning a Stack object.
- */
- public Stack addHeader(@NotNull String key, @NotNull Object value) {
- this.headers.put(key, value);
- return this;
- }
-
/**
* The addParam function adds a key-value pair to a stack and returns the
* updated stack.
@@ -71,6 +54,46 @@ public Stack addParam(@NotNull String key, @NotNull Object value) {
return this;
}
+ /**
+ * @param key The key parameter is a string that represents the name or
+ * identifier of the header.
+ * It is used to specify the type of information being sent in the
+ * header.
+ * @param value The value parameter is a string that represents the value of the
+ * header.
+ * @return instance of the Stack
+ */
+ @Override
+ public Stack addHeader(@NotNull String key, @NotNull String value) {
+ this.headers.put(key, value);
+ return this;
+ }
+
+ /**
+ * @param params The "params" parameter is a HashMap that maps String keys to
+ * Object values. It is
+ * annotated with @NotNull, indicating that it cannot be null.
+ * @return instance of the Stack
+ */
+ @Override
+ public Stack addParams(@NotNull HashMap params) {
+ this.params.putAll(params);
+ return this;
+ }
+
+ /**
+ * @param headers A HashMap containing key-value pairs of headers, where the key
+ * is a String
+ * representing the header name and the value is a String
+ * representing the header value.
+ * @return instance of the Stack
+ */
+ @Override
+ public Stack addHeaders(@NotNull HashMap headers) {
+ this.headers.putAll(headers);
+ return this;
+ }
+
/**
* The function removes a parameter from a stack and returns the modified stack.
*
@@ -546,10 +569,10 @@ public Roles roles(String roleUid) {
}
/**
- * You can pin a set of entries and assets (along with the deploy action, i.e.,
- * publish/unpublish) to a
+ * You can pin a set of entries and assets (along with the deployment action, i.e.,
+ * publish/un-publish) to a
* release, and then deploy this release to an environment. This will
- * publish/unpublish all the items of the release to the specified environment.
+ * publish/un-publish all the items of the release to the specified environment.
* Read more about Releases.
*
* @return Release
@@ -559,10 +582,10 @@ public Release releases() {
}
/**
- * You can pin a set of entries and assets (along with the deploy action, i.e.,
- * publish/unpublish) to a
+ * You can pin a set of entries and assets (along with the deployment action, i.e.,
+ * publish/un-publish) to a
* release, and then deploy this release to an environment. This will
- * publish/unpublish all the items of the release to the specified environment.
+ * publish/un-publish all the items of the release to the specified environment.
* Read more about Releases.
*
* @param releaseUid The unique ID of the release of which you want to retrieve
@@ -631,7 +654,7 @@ public AuditLog auditLog(@NotNull String logItemUid) {
/**
* The Publishing Queue displays the historical and current details of
- * activities such as publish, unpublish, or
+ * activities such as publish, un-publish, or
* delete that can be performed on entries and/or assets. It also shows details
* of Release deployments. These
* details include time, entry, content type, version, language, user,
@@ -649,7 +672,7 @@ public PublishQueue publishQueue() {
}
/**
- * You can perform bulk operations such as Publish, Unpublish, and Delete on
+ * You can perform bulk operations such as Publish, Un-publish, and Delete on
* multiple entries or assets, or Change
* the Workflow Details of multiple entries or assets at the same time.
*
@@ -666,7 +689,7 @@ public BulkOperation bulkOperation() {
/**
* The Publishing Queue displays the historical and current details of
- * activities such as publish, unpublish, or
+ * activities such as publish, un-publish, or
* delete that can be performed on entries and/or assets. It also shows details
* of Release deployments. These
* details include time, entry, content type, version, language, user,
@@ -798,6 +821,45 @@ public Alias alias(String aliasUid) {
return new Alias(this.client, aliasUid);
}
+
+ /**
+ * The taxonomy works on data where hierarchy is configured
+ *
+ *
+ * {@code
+ * Stack stack = new Contentstack.Builder().setAuthtoken("authtoken").build().stack();
+ * Taxonomy taxonomy = stack.taxonomy();
+ * Call response = taxonomy.fetch().execute();
+ * }
+ *
+ *
+ * @return instance of Taxonomy
+ */
+ public Taxonomy taxonomy() {
+ return new Taxonomy(this.client, this.headers);
+ }
+
+
+ /**
+ * The taxonomy works on data where hierarchy is configured
+ *
+ * @param taxonomyUid the taxonomy uid
+ * @return instance of Taxonomy
+ *
+ *
+ * {@code
+ * Stack stack = new Contentstack.Builder().setAuthtoken("authtoken").build().stack();
+ * Taxonomy taxonomy = stack.taxonomy("taxonomyId");
+ * taxonomy.terms();
+ * taxonomy.fetch();
+ * taxonomy.find();
+ * }
+ *
+ */
+ public Taxonomy taxonomy(@NotNull String taxonomyUid) {
+ return new Taxonomy(this.client, this.headers, taxonomyUid);
+ }
+
/**
* Get stacks
*
@@ -826,7 +888,7 @@ public Alias alias(String aliasUid) {
* UID in the header.
*
*
- * - Add headers using {@link #addHeader(String, Object)}
+ * - Add headers using {@link #addHeader(String, String)}
*
* - Add query parameters using {@link #addParam(String, Object)}
*
@@ -945,7 +1007,7 @@ public Call transferOwnership(@NotNull JSONObject body) {
*
* - To Accept stack owned by other user, user
* {@link #addParam(String, Object)} to add query parameters
- * - To Add Header use {@link #addHeader(String, Object)}
+ * - To Add Header use {@link #addHeader(String, String)}
*
*
* @param ownershipToken the ownership token received via email by another user.
@@ -1116,16 +1178,16 @@ public Call share(@NotNull JSONObject requestBody) {
}
/**
- * Unshare a stack
+ * Un-share a stack
*
- * The Unshare a stack removes the user account from the list of collaborators.
+ * The Un-share a stack removes the user account from the list of collaborators.
* Once this call is executed, the user
* will not be able to view the stack in their account.
*
*
*
* In the 'Body' section, you need to provide the email ID of the user from whom
- * you wish to unshare the stack.
+ * you wish to un-share the stack.
*
* Here is a sample of the Request Body:
*
@@ -1190,4 +1252,5 @@ public Call roles(@NotNull JSONObject body) {
return service.updateUserRoles(this.headers, body);
}
+
}
diff --git a/src/main/java/com/contentstack/cms/stack/Taxonomy.java b/src/main/java/com/contentstack/cms/stack/Taxonomy.java
new file mode 100644
index 00000000..65f1fb0c
--- /dev/null
+++ b/src/main/java/com/contentstack/cms/stack/Taxonomy.java
@@ -0,0 +1,251 @@
+package com.contentstack.cms.stack;
+
+import com.contentstack.cms.BaseImplementation;
+import okhttp3.ResponseBody;
+import org.jetbrains.annotations.NotNull;
+import org.json.simple.JSONObject;
+import retrofit2.Call;
+import retrofit2.Retrofit;
+
+import java.util.HashMap;
+
+
+/**
+ * The type Taxonomy.
+ */
+public class Taxonomy implements BaseImplementation {
+
+ private String taxonomyId;
+ /**
+ * The Taxonomy service.
+ */
+ final TaxonomyService taxonomyService;
+ /**
+ * The Headers.
+ */
+ protected HashMap headers;
+ /**
+ * The Params.
+ */
+ protected HashMap params;
+
+
+ /**
+ * Instantiates a new Taxonomy.
+ *
+ * @param client the client
+ * @param headers the headers
+ */
+ protected Taxonomy(Retrofit client, HashMap headers) {
+ this.headers = new HashMap<>();
+ this.params = new HashMap<>();
+ this.headers.putAll(headers);
+ this.taxonomyService = client.create(TaxonomyService.class);
+ }
+
+ /**
+ * Instantiates a new Taxonomy.
+ *
+ * @param client the client
+ * @param headers the headers
+ * @param taxonomyId the taxonomy id
+ */
+ protected Taxonomy(Retrofit client, HashMap headers, @NotNull String taxonomyId) {
+ this.headers = new HashMap<>();
+ this.params = new HashMap<>();
+ this.taxonomyId = taxonomyId;
+ this.headers.putAll(headers);
+ this.taxonomyService = client.create(TaxonomyService.class);
+ }
+
+ /**
+ * @param key A string representing the key of the parameter. It cannot be
+ * null and must be
+ * provided as a non-null value.
+ * @param value The "value" parameter is of type Object, which means it can
+ * accept any type of
+ * object as its value.
+ * @return instance of Taxonomy
+ */
+ @Override
+ public Taxonomy addParam(@NotNull String key, @NotNull Object value) {
+ this.params.put(key, value);
+ return this;
+ }
+
+ /**
+ * @param key The key parameter is a string that represents the name or
+ * identifier of the header.
+ * It is used to specify the type of information being sent in the
+ * header.
+ * @param value The value parameter is a string that represents the value of the
+ * header.
+ * @return instance of Taxonomy
+ */
+ @Override
+ public Taxonomy addHeader(@NotNull String key, @NotNull String value) {
+ this.headers.put(key, value);
+ return this;
+ }
+
+ /**
+ * @param headers A HashMap containing key-value pairs of headers, where the key
+ * is a String
+ * representing the header name and the value is a String
+ * representing the header value.
+ * @return instance of Taxonomy
+ */
+ @Override
+ public Taxonomy addHeaders(@NotNull HashMap headers) {
+ this.headers.putAll(headers);
+ return this;
+ }
+
+ /**
+ * @param params The "params" parameter is a HashMap that maps String keys to
+ * Object values. It is
+ * annotated with @NotNull, indicating that it cannot be null.
+ * @return instance of Taxonomy
+ */
+ @Override
+ public Taxonomy addParams(@NotNull HashMap params) {
+ this.params.putAll(params);
+ return this;
+ }
+
+ /**
+ * Get all taxonomies call.
+ *
+ * Query parameters:
+ *
+ * -
+ * include_terms_count: Whether to include the count of terms in the response. Values: true or false.
+ *
+ * -
+ * include_referenced_terms_count: Whether to include the count of referenced terms in the response. Values: true or false.
+ *
+ * -
+ * include_referenced_entries_count: Whether to include the count of referenced entries in the response. Values: true or false.
+ *
+ * -
+ * include_count: Whether to include the total count of taxonomies in the response. Values: true or false.
+ *
+ * -
+ * asc or desc: Sort order based on the UID field. Values: field_uid (replace with the actual field UID), or omit for no sorting.
+ *
+ * -
+ * typeahead: Search string for typeahead functionality. Values: Any search string.
+ *
+ * -
+ * include_deleted: Whether to include deleted taxonomies in the response. Values: true or false.
+ *
+ * -
+ * skip: Number of records to skip in pagination. Values: Any non-negative integer.
+ *
+ * -
+ * limit: Maximum number of records to return. Values: Any positive integer.
+ *
+ *
+ *
+ * @return the call Example {@code
+ * Response response = taxonomy.find().execute();
+ * }
+ */
+ public Call find() {
+ return this.taxonomyService.find(this.headers, this.params);
+ }
+
+ /**
+ * Fetch Single Taxonomy Call.
+ *
+ * Query Parameters:
+ *
+ * -
+ * include_terms_count: Whether to include the count of terms in the response. Values: true or false.
+ *
+ * -
+ * include_referenced_terms_count: Whether to include the count of terms referred in at least 1 entry. Values: true or false.
+ *
+ * -
+ * include_referenced_entries_count: Whether to include the count of entries where at least 1 term of this taxonomy is referred. Values: true or false
+ *
+ *
+ *
+ * @param taxonomyId the taxonomy id
+ * @return the call Example {@code
+ * Response response = taxonomy.fetch("taxonomyId").execute();
+ * }
+ */
+ public Call fetch(@NotNull String taxonomyId) {
+ return this.taxonomyService.fetch(this.headers, taxonomyId, this.params);
+ }
+
+ /**
+ * Create Taxonomy call.
+ *
+ * @param body the body
+ * @return the call Example {@code
+ * JSONObject body = new JSONObject
+ * Response response = taxonomy.create(body).execute();
+ * }
+ */
+ public Call create(@NotNull JSONObject body) {
+ return this.taxonomyService.create(this.headers, body);
+ }
+
+ /**
+ * Update Taxonomy call.
+ *
+ * @param taxonomyId - The taxonomy for which we need to update the details
+ * @param body the body
+ * @return the call Example {@code
+ * JSONObject body = new JSONObject();
+ * JSONObject bodyContent = new JSONObject();
+ * bodyContent.put("name", "Taxonomy 1");
+ * bodyContent.put("description", "Description updated for Taxonomy 1);
+ * body.put("taxonomy", bodyContent);
+ * Response response = taxonomy.update("taxonomyId", body).execute();
+ * }
+ */
+ public Call update(@NotNull String taxonomyId, @NotNull JSONObject body) {
+ return this.taxonomyService.update(this.headers, taxonomyId, body);
+ }
+
+ /**
+ * Delete Taxonomy call.
+ *
+ * @param taxonomyId - The taxonomy for which we need to update the details
+ * @return the call Example {@code
+ * Response response = taxonomy.delete("taxonomyId").execute();
+ * }
+ */
+ public Call delete(@NotNull String taxonomyId) {
+ return this.taxonomyService.delete(this.headers, taxonomyId);
+ }
+
+ /**
+ * Clear params for internal uses only for testing
+ */
+ protected void clearParams() {
+ this.params.clear();
+ }
+
+
+ /**
+ * Get terms information
+ *
+ *
Examples
+ *
+ * {@code
+ * Term terms = stack("authtoken").taxonomy("taxonomyId").term();
+ * }*
+ *
+ *
+ * @return instance of {@link Terms}
+ */
+ public Terms terms() {
+ return new Terms(this.taxonomyService, this.headers, this.taxonomyId);
+ }
+
+
+}
diff --git a/src/main/java/com/contentstack/cms/stack/TaxonomyService.java b/src/main/java/com/contentstack/cms/stack/TaxonomyService.java
new file mode 100644
index 00000000..aebf2cb7
--- /dev/null
+++ b/src/main/java/com/contentstack/cms/stack/TaxonomyService.java
@@ -0,0 +1,82 @@
+package com.contentstack.cms.stack;
+
+import okhttp3.ResponseBody;
+import org.json.simple.JSONObject;
+import retrofit2.Call;
+import retrofit2.http.*;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public interface TaxonomyService {
+
+ @GET("taxonomies")
+ Call find(@HeaderMap Map headers, @QueryMap Map params);
+
+ @GET("taxonomies/{taxonomy_uid}")
+ Call fetch(@HeaderMap Map headers, @Path("taxonomy_uid") String uid, @QueryMap Map query);
+
+ @POST("taxonomies")
+ Call create(
+ @HeaderMap Map headers,
+ @Body JSONObject body);
+
+ @PUT("taxonomies/{taxonomy_uid}")
+ Call update(
+ @HeaderMap Map headers,
+ @Path("taxonomy_uid") String uid,
+ @Body JSONObject body);
+
+ @DELETE("taxonomies/{taxonomy_uid}")
+ Call delete(
+ @HeaderMap Map headers,
+ @Path("taxonomy_uid") String uid);
+
+ //--Terms--
+ @POST("taxonomies/{taxonomy_uid}/terms")
+ Call createTerm(
+ @HeaderMap HashMap headers,
+ @Path("taxonomy_uid") String taxonomyId,
+ @Body JSONObject body);
+
+ @GET("taxonomies/{taxonomy_uid}/terms")
+ Call findTerm(
+ @HeaderMap HashMap headers,
+ @Path("taxonomy_uid") String taxonomyId,
+ @QueryMap Map queryParams);
+
+ @GET("taxonomies/{taxonomy_uid}/terms/{term_id}")
+ Call fetchTerm(
+ @HeaderMap HashMap headers,
+ @Path("taxonomy_uid") String taxonomyId,
+ @Path("term_id") String termId,
+ @QueryMap Map queryParams);
+
+ @GET("taxonomies/{taxonomy_uid}/terms/{term_id}/descendants")
+ Call descendantsTerm(
+ @HeaderMap HashMap headers,
+ @Path("taxonomy_uid") String taxonomyId,
+ @Path("term_id") String termId,
+ @QueryMap Map queryParams);
+
+ @GET("taxonomies/{taxonomy_uid}/terms/{term_id}/ancestors")
+ Call ancestorsTerm(
+ @HeaderMap HashMap headers,
+ @Path("taxonomy_uid") String taxonomyId,
+ @Path("term_id") String termId,
+ @QueryMap Map queryParams);
+
+ @PUT("taxonomies/{taxonomy_uid}/terms/{term_id}")
+ Call updateTerm(
+ @HeaderMap HashMap headers,
+ @Path("taxonomy_uid") String taxonomyId,
+ @Path("term_id") String termId,
+ @Body JSONObject body);
+
+
+ @GET("taxonomies/all/terms")
+ Call searchTerm(
+ @HeaderMap HashMap headers,
+ @Query("term") String termString
+ );
+}
diff --git a/src/main/java/com/contentstack/cms/stack/Terms.java b/src/main/java/com/contentstack/cms/stack/Terms.java
new file mode 100644
index 00000000..61e09a09
--- /dev/null
+++ b/src/main/java/com/contentstack/cms/stack/Terms.java
@@ -0,0 +1,265 @@
+package com.contentstack.cms.stack;
+
+import com.contentstack.cms.BaseImplementation;
+import okhttp3.ResponseBody;
+import org.jetbrains.annotations.NotNull;
+import org.json.simple.JSONObject;
+import retrofit2.Call;
+
+import java.util.HashMap;
+
+/**
+ * provides an implementation
+ *
+ * - Create a Term
+ * - Get all Terms of a Taxonomy
+ * - Get a single Term
+ * - Get descendants of a single Term
+ * - Get ancestors of a single Term
+ * - Update a Term
+ * - Search for all Terms within all Taxonomies
+ *
+ */
+public class Terms implements BaseImplementation {
+
+ /**
+ * The Taxonomy service.
+ */
+ final TaxonomyService taxonomyService;
+ /**
+ * The Headers.
+ */
+ final HashMap headers;
+ /**
+ * The Taxonomy id.
+ */
+ final String taxonomyId;
+ /**
+ * The Params.
+ */
+ final HashMap params;
+
+
+ /**
+ * Instantiates a new Terms.
+ *
+ * @param service the service
+ * @param headers the headers
+ * @param taxonomyId the taxonomy id
+ */
+ public Terms(@NotNull TaxonomyService service, HashMap headers, String taxonomyId) {
+ this.taxonomyService = service;
+ this.headers = headers;
+ this.taxonomyId = taxonomyId;
+ this.params = new HashMap<>();
+ }
+
+
+ /**
+ * @param key A string representing the key of the parameter. It cannot be
+ * null and must be
+ * provided as a non-null value.
+ * @param value The "value" parameter is of type Object, which means it can
+ * accept any type of
+ * object as its value.
+ * @return instance of Terms
+ */
+ @Override
+ public Terms addParam(@NotNull String key, @NotNull Object value) {
+ this.params.put(key, value);
+ return this;
+ }
+
+ /**
+ * @param key The key parameter is a string that represents the name or
+ * identifier of the header.
+ * It is used to specify the type of information being sent in the
+ * header.
+ * @param value The value parameter is a string that represents the value of the
+ * header.
+ * @return instance of Terms
+ */
+ @Override
+ public Terms addHeader(@NotNull String key, @NotNull String value) {
+ this.headers.put(key, value);
+ return this;
+ }
+
+ /**
+ * @param params The "params" parameter is a HashMap that maps String keys to
+ * Object values. It is
+ * annotated with @NotNull, indicating that it cannot be null.
+ * @return instance of Terms
+ */
+ @Override
+ public Terms addParams(@NotNull HashMap params) {
+ this.params.putAll(params);
+ return this;
+ }
+
+ /**
+ * @param headers A HashMap containing key-value pairs of headers, where the key
+ * is a String
+ * representing the header name and the value is a String
+ * representing the header value.
+ * @return instance of Terms
+ */
+ @Override
+ public Terms addHeaders(@NotNull HashMap headers) {
+ this.headers.putAll(headers);
+ return this;
+ }
+
+
+ /**
+ * Create Terms call.
+ *
+ * @param body The JSONObject request body
+ * @return instance of Call Example {@code
+ * Stack stack = new Contentstack.Builder().build().stack(headers);
+ * JSONObject body = new JSONObject();
+ * Term term = stack.taxonomy("taxonomyId").terms().create(body);
+ * }
+ */
+ public Call create(@NotNull JSONObject body) {
+ return this.taxonomyService.createTerm(this.headers, taxonomyId, body);
+ }
+
+ /**
+ *
+ * Supported Query Parameters: to use query parameters use #addParams("key", "value");
+ *
+ * -
+ * taxonomy_uid - The taxonomy for which we need the terms
+ *
+ * -
+ * depth - Include the terms upto the depth specified if set to a number greater than 0, include all the terms if set to 0, default depth will be set to 1
+ *
+ * -
+ * include_children_count - Include count of number of children under each term if set to true
+ *
+ * -
+ * include_referenced_entries_count - Include count of the entries where this term is referred
+ *
+ * -
+ * include_count - Include count of the documents/nodes that matched the query
+ *
+ * -
+ * asc|desc - Sort the given field in either ascending or descending order
+ *
+ * -
+ * typeahead - Used to match the given string in all terms and return the matched result
+ *
+ * -
+ * deleted - Used to fetch only the deleted terms
+ *
+ * -
+ * skip - Skip the number of documents/nodes
+ *
+ * -
+ * limit - Limit the result to number of documents/nodes
+ *
+ *
+ *
+ * Example
+ *
+ * {@code
+ * Stack stack = new Contentstack.Builder().build().stack(headers);
+ * Term term = stack.taxonomy("taxonomyId").terms().addParam("limit", 2).find();
+ * }*
+ *
+ *
+ * @return the call
+ * @see #addParam(String, Object) #addParam(String, Object)to add query parameters returns instance of Call
+ */
+ public Call find() {
+ return this.taxonomyService.findTerm(this.headers, taxonomyId, this.params);
+ }
+
+ /**
+ * Fetch single term based on term uid.
+ *
+ * @param termUid The term for which we need the details
+ * @return instance of call Supported Query Parameters: to use query parameters use #addParams("key", "value");
- include_children_count - Include count of number of children under each term
- include_referenced_entries_count - Include count of the entries where this term is referred
Example {@code
+ * Stack stack = new Contentstack.Builder().build().stack(headers);
+ * Term term = stack.taxonomy("taxonomyId").terms().find();
+ * }
+ * @see #addParam(String, Object) #addParam(String, Object)#addParam(String, Object)to add query parameters
+ */
+ public Call fetch(@NotNull String termUid) {
+ return this.taxonomyService.fetchTerm(this.headers, taxonomyId, termUid, this.params);
+ }
+
+ /**
+ * Get descendants of a single Term
+ *
+ * @param termUid The term for which we need the details
+ * @return The details of the term descendants URL/Query parameters
- depth - Include the terms upto the depth specified if set to a number greater than 0, include all the terms if set to 0, default depth will be set to 1
- include_children_count - Include count of number of children under each term
- include_referenced_entries_count - Include count of the entries where atleast 1 term of this taxonomy is referred
- include_count - Include count of the documents/nodes that matched the query
- skip - Skip the number of documents/nodes
- limit - Limit the result to number of documents/nodes
Example
{@code
+ * Stack stack = new Contentstack.Builder().build().stack(headers);
+ * Term term = stack.taxonomy("taxonomyId").terms().descendants("termId").;
+ * }
+ */
+ public Call descendants(@NotNull String termUid) {
+ return this.taxonomyService.descendantsTerm(this.headers, this.taxonomyId, termUid, this.params);
+ }
+
+ /**
+ * Get ancestors of a single Term
+ *
+ * @param termUid The term for which we need the details
+ * @return The details of the term ancestors Example
{@code
+ * Stack stack = new Contentstack.Builder().build().stack(headers);
+ * Term term = stack.taxonomy("taxonomyId").terms().ancestors("termId");
+ * }
+ */
+ public Call ancestors(@NotNull String termUid) {
+ return this.taxonomyService.ancestorsTerm(this.headers, this.taxonomyId, termUid, this.params);
+ }
+
+ /**
+ * Update call.
+ *
+ * @param termUid - The term for which we need the details
+ * @param body the JSONObject body for the request
+ * @return instance of Call