[Auto Generated] v1.0

settle-club · Aug 8, 2024 · 2f0d7c2 · 2f0d7c2
1 parent 9ae7f02
commit 2f0d7c2
Show file tree

Hide file tree

Showing 37 changed files with 62,732 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,85 @@
+# Settle Java
+
+
+Settle client for Java language
+[![](https://jitpack.io/v/settle-finance/java-integration-sdk.svg)](https://jitpack.io/#settle-finance/java-integration-sdk)
+
+
+
+## Getting Started
+Get started with the Java Development SDK for Potlee, Compatible with Java 21
+
+
+# Usage
+
+1. Create Maven project and add the dependency in the pom.xml 
+```xml
+    <dependency>
+        <groupId>com.github.settle-finance</groupId>
+        <artifactId>java-integration-sdk</artifactId>
+        <version>1.0.0</version>
+    </dependency>
+```
+
+2. Add it in your root pom.xml at the end of repositories:
+```xml
+<repositories>
+    <repository>
+        <id>jitpack.io</id>
+        <url>https://jitpack.io</url>
+    </repository>
+</repositories>
+```
+
+3. Start integrating
+
+### Exampe Usage 
+```java
+public class Example {
+    static PlatformConfig platformConfig;
+    static PlatformClient platformClient;
+
+    public static void main(String[] args) {
+        try {
+            platformConfig = new PlatformConfig(
+                    "COMPANY_ID",
+                    "API_KEY",
+                    "API_SECRET",
+                    "API_TOKEN",
+                    "https://api.potleez5.de",
+                    false
+            );
+
+            platformClient = new PlatformClient(platformConfig);
+
+            PlatformModels.CustomerObject customer = PlatformModels.CustomerObject.builder().countryCode("91").mobile("8898518242").uid("1").build();
+
+            PlatformModels.Device device = PlatformModels.Device.builder().ipAddress("127.0.0.1").userAgent("moz").build();
+
+            PlatformModels.Order order =  PlatformModels.Order.builder().valueInPaise(100000).uid("123").build();
+
+            PlatformModels.VerifyCustomer verifyCustomer = PlatformModels.VerifyCustomer.builder().customer(customer).order(order).device(device).build();
+
+            // Use this API to verify the customer.
+            PlatformModels.VerifyCustomerSuccess verifyCustomerSuccess = platformClient.customer.verify(
+                    platformConfig.getOrganizationId(),
+                    verifyCustomer
+            );
+
+            PlatformModels.CreateTransaction createTransaction = PlatformModels.CreateTransaction.builder().customer(customer).order(order).redirectUrl("https://www.google.com").build();
+
+            // Use this API to create transaction for user.
+            PlatformModels.CreateTransactionSuccess createTransactionSuccess = platformClient.customer.createOrder(
+                    platformConfig.getOrganizationId(),
+                    createTransaction
+            );
+
+        } catch (Exception e) {
+            System.out.println(e);
+        }
+    }
+}
+```
+
+### Documentation
+* [Platform](documentation/platform/README.md)
diff --git a/documentation/application/CONTENT.md b/documentation/application/CONTENT.md
@@ -0,0 +1,226 @@
+
+
+
+
+##### [Back to Application docs](./README.md)
+
+## Content Methods
+Content Service
+* [checkForUpdates](#checkforupdates)
+
+
+
+## Methods with example and description
+
+
+### checkForUpdates
+Check for app updates
+
+
+
+
+```java
+content.checkForUpdates() {
+  //use response
+}
+```
+
+
+
+
+
+
+*Returned Response:*
+
+
+
+
+[AppUpdateResponse](#AppUpdateResponse)
+
+Successful operation
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "available": true,
+  "type": "HARD",
+  "version": "1.0.3",
+  "title": "A new update is available",
+  "description": "Please update your app",
+  "releasedOn": "2022-11-14",
+  "appLink": "https://apps.apple.com/us/app/potlee/id6444611798"
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+
+### Schemas
+
+
+
+ #### [AppUpdateResponse](#AppUpdateResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | available | Boolean |  no  |  |
+ | type | String? |  yes  |  |
+ | version | String? |  yes  |  |
+ | title | String |  no  |  |
+ | description | String |  no  |  |
+ | releasedOn | String? |  yes  |  |
+ | appLink | String? |  yes  |  |
+
+---
+
+
+
+
+ #### [CreateVersionRequest](#CreateVersionRequest)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | status | String |  no  |  |
+ | version | String |  no  |  |
+ | additionalNotes | String? |  yes  |  |
+ | title | String? |  yes  |  |
+ | description | String? |  yes  |  |
+ | releasedOn | String? |  yes  |  |
+
+---
+
+
+
+
+ #### [UpdateVersionRequest](#UpdateVersionRequest)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | additionalNotes | String? |  yes  |  |
+ | status | String |  no  |  |
+ | title | String? |  yes  |  |
+ | description | String? |  yes  |  |
+ | releasedOn | String? |  yes  |  |
+
+---
+
+
+
+
+ #### [CreateVersionResponse](#CreateVersionResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | additionalNotes | String? |  yes  |  |
+ | status | String |  no  |  |
+ | version | String |  no  |  |
+ | title | String? |  yes  |  |
+ | description | String? |  yes  |  |
+ | releasedOn | String |  no  |  |
+ | updatedAt | String |  no  |  |
+ | createdAt | String |  no  |  |
+
+---
+
+
+
+
+ #### [VersionResponse](#VersionResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | additionalNotes | String? |  yes  |  |
+ | status | String |  no  |  |
+ | version | String |  no  |  |
+ | title | String? |  yes  |  |
+ | description | String? |  yes  |  |
+ | releasedOn | String |  no  |  |
+ | updatedAt | String |  no  |  |
+ | createdAt | String |  no  |  |
+
+---
+
+
+
+
+ #### [GetVersionsResponseExample](#GetVersionsResponseExample)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | versions | ArrayList<[VersionResponse](#VersionResponse)>? |  yes  |  |
+
+---
+
+
+
+
+ #### [GenerateSignedUrlRequest](#GenerateSignedUrlRequest)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | provider | String? |  yes  | The name of the storage provider (e.g., 'gcp') to be used. |
+ | fileName | String? |  yes  | The name of the file for which the signed URL is generated. File name will be auto generated if not provided. |
+ | filePath | String? |  yes  | The path within the storage where the file is located or will be stored. File will be uploaded in root of bucket if path is not provided. |
+ | fileUrl | String? |  yes  | The URL of the file to be downloaded. This is only allowed if the action is 'download'. |
+ | action | String |  no  | The action that the signed URL will allow, such as 'upload' or 'download'. |
+ | access | String? |  yes  | The access level for the file (e.g., 'publicRead', 'private'). |
+ | expires | Double? |  yes  | The expiration time for the signed URL in milliseconds. If not provided, a default value is used. |
+
+---
+
+
+
+
+ #### [SignedDetails](#SignedDetails)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | provider | String |  no  | The cloud provider where the file is stored. |
+ | signedUrl | String |  no  | The signed URL that allows access or actions on the specified file. |
+
+---
+
+
+
+
+ #### [GenerateSignedUrlResponse](#GenerateSignedUrlResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | fileUrl | String? |  yes  | The URL of the uploaded file. |
+ | signedDetails | [SignedDetails](#SignedDetails) |  no  |  |
+
+---
+
+
+
+
+ #### [ErrorResponse](#ErrorResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | message | String? |  yes  |  |
+ | info | String? |  yes  |  |
+ | code | String? |  yes  |  |
+ | requestId | String? |  yes  |  |
+ | meta | HashMap<String,Object>? |  yes  |  |
+
+---
+
+
+