API documentation

API documentation

Author: ishaileshmishra

README.md

@@ -42,7 +42,7 @@ To use Contentstack management sdk in our Maven project, we'll need to add the f
 
 ```java
 <dependency>
- <groupId>com.contentstack</groupId>
+ <groupId>com.contentstack.sdk</groupId>
  <artifactId>cms</artifactId>
  <version>{version}</version>
 </dependency>

cms.iml

@@ -12,15 +12,15 @@
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
     <orderEntry type="library" name="Maven: com.google.code.gson:gson:2.9.0" level="project" />
-    <orderEntry type="library" name="Maven: io.reactivex.rxjava3:rxjava:3.1.4" level="project" />
-    <orderEntry type="library" name="Maven: org.reactivestreams:reactive-streams:1.0.3" level="project" />
+    <orderEntry type="library" name="Maven: io.reactivex.rxjava3:rxjava:3.1.5" level="project" />
+    <orderEntry type="library" name="Maven: org.reactivestreams:reactive-streams:1.0.4" level="project" />
     <orderEntry type="library" name="Maven: com.squareup.retrofit2:retrofit:2.9.0" level="project" />
     <orderEntry type="library" name="Maven: com.squareup.okhttp3:okhttp:3.14.9" level="project" />
     <orderEntry type="library" name="Maven: com.squareup.okio:okio:1.17.2" level="project" />
     <orderEntry type="library" name="Maven: com.squareup.retrofit2:converter-gson:2.9.0" level="project" />
-    <orderEntry type="library" name="Maven: com.squareup.okhttp3:logging-interceptor:4.9.3" level="project" />
-    <orderEntry type="library" name="Maven: org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.4.10" level="project" />
-    <orderEntry type="library" name="Maven: org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.4.10" level="project" />
+    <orderEntry type="library" name="Maven: com.squareup.okhttp3:logging-interceptor:4.10.0" level="project" />
+    <orderEntry type="library" name="Maven: org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.10" level="project" />
+    <orderEntry type="library" name="Maven: org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.6.10" level="project" />
     <orderEntry type="library" scope="PROVIDED" name="Maven: org.jetbrains:annotations:23.0.0" level="project" />
     <orderEntry type="library" name="Maven: org.projectlombok:lombok:1.18.24" level="project" />
     <orderEntry type="library" scope="TEST" name="Maven: io.github.cdimascio:java-dotenv:5.2.2" level="project" />

pom.xml

@@ -5,9 +5,9 @@
     <groupId>com.contentstack.sdk</groupId>
     <artifactId>cms</artifactId>
     <name>contentstack-management-java</name>
-    <version>${sdk.version}</version>
-    <description>Contentstack Java Management SDK for Content Management API,
-        Contentstack is a headless CMS with an API-first approach
+    <version>1.0.0-SNAPSHOT</version>
+    <description>Contentstack Java Management SDK for Content Management API, Contentstack is a headless CMS with an
+        API-first approach
     </description>
     <url>https://github.com/contentstack/contentstack-management-java/</url>
 
@@ -79,10 +79,10 @@
         <maven-source-plugin.version>2.2.1</maven-source-plugin.version>
         <maven-javadoc-plugin.version>3.0.0</maven-javadoc-plugin.version>
         <dotenv-source.version>5.2.2</dotenv-source.version>
-        <rxjava-source.version>3.1.4</rxjava-source.version>
+        <rxjava-source.version>3.1.5</rxjava-source.version>
         <retrofit-source.version>2.9.0</retrofit-source.version>
         <converter-gson-version>2.9.0</converter-gson-version>
-        <logging.version>4.9.3</logging.version>
+        <logging.version>4.10.0</logging.version>
         <jococo-plugin.version>0.8.5</jococo-plugin.version>
         <lombok-source.version>1.18.24</lombok-source.version>
         <junit-jupiter.version>5.8.2</junit-jupiter.version>
@@ -215,6 +215,8 @@
                     </execution>
                 </executions>
             </plugin>
+
+
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-site-plugin</artifactId>

src/main/java/com/contentstack/cms/Contentstack.java

@@ -61,7 +61,7 @@ public class Contentstack {
      * Client client = new Client.Builder().build();
      * User userInstance = client.user();
      * </pre>
-     * <p>
+     * <br>
      *
      * @return User user
      */
@@ -100,7 +100,7 @@ public User user() {
      * Contentstack client = new Contentstack.Builder().build();
      * Response login = client.login("emailId", "password");
      * </pre>
-     * <p>
+     * <br>
      *
      * @param emailId
      *         the email id
@@ -147,7 +147,7 @@ public Response<LoginDetails> login(String emailId, String password) throws IOEx
      * Contentstack client = new Contentstack.Builder().build();
      * Response login = client.login("emailId", "password");
      * </pre>
-     * <p>
+     * <br>
      *
      * @param emailId
      *         the email id
@@ -244,7 +244,7 @@ Response<ResponseBody> logoutWithAuthtoken(String authtoken) throws IOException
     public Organization organization() {
         if (this.authtoken == null)
             throw new IllegalStateException("Please Login to access user instance");
-        return new Organization(this.instance);
+        return new Organization(this.instance, this.authtoken);
     }
 
     /**
@@ -396,9 +396,11 @@ public Builder() {
         /**
          * Sets proxy. (Setting proxy to the OkHttpClient) Proxy proxy = new Proxy(Proxy.Type.HTTP, new
          * InetSocketAddress(proxyHost, proxyPort));
-         * <p>
-         * Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("hostname", 433)); Contentstack contentstack =
-         * new Contentstack.Builder().setProxy(proxy).build();
+         * <br>
+         * <pre>
+         *         Proxy proxy = new Proxy(Proxy.Type.HTTP, new InetSocketAddress("hostname", 433));
+         *         Contentstack contentstack = new Contentstack.Builder().setProxy(proxy).build();
+         *     </pre>
          *
          * @param proxy
          *         the proxy

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

@@ -15,10 +15,6 @@ public class CSResponse {
     private static final String RESPONSE_NULL = "response == null";
     private final Response<ResponseBody> response;
 
-    //Request request;
-    //ResponseBody response; // JSONResponse/ JSON/ String / model
-
-
     public CSResponse(Response<ResponseBody> response) {
         this.response = response;
     }

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

@@ -40,6 +40,7 @@ public class Util {
     public static final String X_USER_AGENT = "X-User-Agent";
     public static final String USER_AGENT = "User-Agent";
     public static final String CONTENT_TYPE = "Content-Type";
+    public static final String MULTIPART = "multipart/form-data";
     public static final String CONTENT_TYPE_VALUE = "application/json";