sync 2024-02-08

Author: Fast Reports

README.md

@@ -1,31 +1,36 @@
 # fastreport-cloud-sdk
 
 FastReport Cloud
-
 - API version: v1
 
 No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 
 *Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
 
+
 ## Requirements
 
 Building the API client library requires:
-
 1. Java 1.8+
-2. Maven/Gradle
+2. Maven (3.8.3+)/Gradle (7.2+)
 
 ## Installation
 
 To install the API client library to your local Maven repository, simply execute:
 
 ```shell
-git clone https://github.com/FastReports/FastReport-Cloud-Java.git
-cd FastReport-Cloud-Java
 mvn clean install
 ```
 
+To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
+
+```shell
+mvn clean deploy
+```
+
+Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
+
 ### Maven users
 
 Add this dependency to your project's POM:
@@ -34,7 +39,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>cloud.fastreport.sdk</groupId>
   <artifactId>fastreport-cloud-sdk</artifactId>
-  <version>2024.1.21</version>
+  <version>2024.1.22</version>
   <scope>compile</scope>
 </dependency>
 ```
@@ -44,7 +49,14 @@ Add this dependency to your project's POM:
 Add this dependency to your project's build file:
 
 ```groovy
-compile "cloud.fastreport.sdk:fastreport-cloud-sdk:2024.1.21"
+  repositories {
+    mavenCentral()     // Needed if the 'fastreport-cloud-sdk' jar has been published to maven central.
+    mavenLocal()       // Needed if the 'fastreport-cloud-sdk' jar has been published to the local maven repo.
+  }
+
+  dependencies {
+     implementation "cloud.fastreport.sdk:fastreport-cloud-sdk:2024.1.22"
+  }
 ```
 
 ### Others
@@ -57,43 +69,52 @@ mvn clean package
 
 Then manually install the following JARs:
 
-- `target/fastreport-cloud-sdk-2024.1.21.jar`
-- `target/lib/*.jar`
+* `target/fastreport-cloud-sdk-2024.1.22.jar`
+* `target/lib/*.jar`
 
 ## Getting Started
 
 Please follow the [installation](#installation) instruction and execute the following Java code:
 
 ```java
-import cloud.fastreport.*;
+
+// Import classes:
+import cloud.fastreport.ApiClient;
+import cloud.fastreport.ApiException;
+import cloud.fastreport.Configuration;
 import cloud.fastreport.auth.*;
-import cloud.fastreport.model.*;
-import cloud.fastreport.client.UserProfileApi;
-
-public class AppExample {
-
-    public static void main(String[] args) {
-
-        ApiClient defaultClient = new ApiClient(
-                "https://fastreport.cloud",
-                null,
-                new BasicAuthentication("apikey", "***PUT YOUR API KEY HERE***"),
-                null
-        );
-
-        UserProfileApi apiInstance = new UserProfileApi(defaultClient);
-        try {
-            UserProfileVM result = apiInstance.userProfileGetMyProfile();
-            System.out.println(result);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling UserProfileApi#userProfileGetMyProfile");
-            System.err.println("Status code: " + e.getCode());
-            System.err.println("Reason: " + e.getResponseBody());
-            System.err.println("Response headers: " + e.getResponseHeaders());
-            e.printStackTrace();
-        }
+import cloud.fastreport.models.*;
+import cloud.fastreport.client.ApiKeysApi;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = Configuration.getDefaultApiClient();
+    defaultClient.setBasePath("http://localhost");
+    
+    // Configure HTTP basic authorization: ApiKey
+    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
+    ApiKey.setUsername("YOUR USERNAME");
+    ApiKey.setPassword("YOUR PASSWORD");
+
+    // Configure HTTP bearer authorization: JWT
+    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
+    JWT.setBearerToken("BEARER TOKEN");
+
+    ApiKeysApi apiInstance = new ApiKeysApi(defaultClient);
+    CreateApiKeyVM createApiKeyVM = new CreateApiKeyVM(); // CreateApiKeyVM | 
+    try {
+      ApiKeyVM result = apiInstance.apiKeysCreateApiKey(createApiKeyVM);
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling ApiKeysApi#apiKeysCreateApiKey");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
     }
+  }
 }
+
 ```
 
 ## Documentation for API Endpoints
@@ -569,17 +590,19 @@ Class | Method | HTTP request | Description
  - [WebhookTaskVM](docs/WebhookTaskVM.md)
 
 
+<a id="documentation-for-authorization"></a>
 ## Documentation for Authorization
 
+
 Authentication schemes defined for the API:
+<a id="JWT"></a>
 ### JWT
 
+- **Type**: HTTP Bearer Token authentication (JWT)
 
-- **Type**: HTTP basic authentication
-
+<a id="ApiKey"></a>
 ### ApiKey
 
-
 - **Type**: HTTP basic authentication
 
 
@@ -589,4 +612,5 @@ It's recommended to create an instance of `ApiClient` per thread in a multithrea
 
 ## Author
 
-https://www.fast-report.com/en/
+
+

VERSION

@@ -1 +1 @@
-2024.1.21
+2024.1.22

build.gradle

@@ -4,7 +4,7 @@ apply plugin: 'java'
 apply plugin: 'com.diffplug.spotless'
 
 group = 'cloud.fastreport.sdk'
-version = '2024.1.21'
+version = '2024.1.22'
 
 buildscript {
     repositories {

build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "cloud.fastreport.sdk",
     name := "fastreport-cloud-sdk",
-    version := "2024.1.21",
+    version := "2024.1.22",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

pom.xml

@@ -5,7 +5,7 @@
     <artifactId>fastreport-cloud-sdk</artifactId>
     <packaging>jar</packaging>
     <name>fastreport-cloud-sdk</name>
-    <version>2024.1.21</version>
+    <version>2024.1.22</version>
     <url>https://github.com/FastReports/FastReport-Cloud-Java</url>
     <description>FastReport Cloud SDK</description>
     <scm>

src/main/java/cloud/fastreport/ApiClient.java

@@ -143,7 +143,7 @@ private void init() {
         json = new JSON();
 
         // Set default User-Agent.
-        setUserAgent("OpenAPI-Generator/2024.1.21/java");
+        setUserAgent("OpenAPI-Generator/2024.1.22/java");
 
         authentications = new HashMap<String, Authentication>();
     }

src/main/java/cloud/fastreport/Configuration.java

@@ -15,7 +15,7 @@
 
 @javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
 public class Configuration {
-    public static final String VERSION = "2024.1.21";
+    public static final String VERSION = "2024.1.22";
 
     private static ApiClient defaultApiClient = new ApiClient();
 

src/main/java/cloud/fastreport/model/AcceptAgreementsVM.java

@@ -172,7 +172,8 @@ public void write(JsonWriter out, AcceptAgreementsVM value) throws IOException {
            @Override
            public AcceptAgreementsVM read(JsonReader in) throws IOException {
              JsonElement jsonElement = elementAdapter.read(in);
-             validateJsonElement(jsonElement);
+             // comment by Detrav, do not need to validate JSON while parse
+             //validateJsonElement(jsonElement);
              return thisAdapter.fromJsonTree(jsonElement);
            }
 

src/main/java/cloud/fastreport/model/AdminExportFolderCreateVM.java

@@ -179,7 +179,8 @@ public void write(JsonWriter out, AdminExportFolderCreateVM value) throws IOExce
            @Override
            public AdminExportFolderCreateVM read(JsonReader in) throws IOException {
              JsonElement jsonElement = elementAdapter.read(in);
-             validateJsonElement(jsonElement);
+             // comment by Detrav, do not need to validate JSON while parse
+             //validateJsonElement(jsonElement);
              return thisAdapter.fromJsonTree(jsonElement);
            }
 

src/main/java/cloud/fastreport/model/AdminReportFolderCreateVM.java

@@ -179,7 +179,8 @@ public void write(JsonWriter out, AdminReportFolderCreateVM value) throws IOExce
            @Override
            public AdminReportFolderCreateVM read(JsonReader in) throws IOException {
              JsonElement jsonElement = elementAdapter.read(in);
-             validateJsonElement(jsonElement);
+             // comment by Detrav, do not need to validate JSON while parse
+             //validateJsonElement(jsonElement);
              return thisAdapter.fromJsonTree(jsonElement);
            }