Skip to content

Commit 9e8b896

Browse files
stigistigi
committed
chore: Running first genration
1 parent a51bf05 commit 9e8b896

File tree

182 files changed

+9406
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

182 files changed

+9406
-1
lines changed

‎README.md

Lines changed: 208 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
# MagicbellJavaClient Java SDK 0.0.1
2+
3+
Welcome to the MagicbellJavaClient SDK documentation. This guide will help you get started with integrating and using the MagicbellJavaClient SDK in your project.
4+
5+
[![This SDK was generated by liblab](https://public-liblab-readme-assets.s3.us-east-1.amazonaws.com/built-by-liblab-icon.svg)](https://liblab.com/?utm_source=readme)
6+
7+
## Versions
8+
9+
- API version: `2.0.0`
10+
- SDK version: `0.0.1`
11+
12+
## About the API
13+
14+
OpenAPI 3.1.0 Specification for MagicBell API.
15+
16+
## Table of Contents
17+
18+
- [Setup & Configuration](#setup--configuration)
19+
- [Supported Language Versions](#supported-language-versions)
20+
- [Installation](#installation)
21+
- [Authentication](#authentication)
22+
- [Access Token Authentication](#access-token-authentication)
23+
- [Setting a Custom Timeout](#setting-a-custom-timeout)
24+
- [Sample Usage](#sample-usage)
25+
- [Services](#services)
26+
- [Models](#models)
27+
- [License](#license)
28+
29+
# Setup & Configuration
30+
31+
## Supported Language Versions
32+
33+
This SDK is compatible with the following versions: `Java >= 1.8`
34+
35+
## Installation
36+
37+
If you use Maven, place the following within the _dependency_ tag in your `pom.xml` file:
38+
39+
```XML
40+
<dependency>
41+
<groupId>com.magicbell.client</groupId>
42+
<artifactId>magicbell-java-client</artifactId>
43+
<version>0.0.1</version>
44+
</dependency>
45+
```
46+
47+
If you use Gradle, paste the next line inside the _dependencies_ block of your `build.gradle` file:
48+
49+
```Gradle
50+
implementation group: com.magicbell.client, name: magicbell-java-client, version: 0.0.0
51+
```
52+
53+
If you use JAR files, package the SDK by running the following command:
54+
55+
```shell
56+
mvn compile assembly:single
57+
```
58+
59+
Then, add the JAR file to your project's classpath.
60+
61+
## Authentication
62+
63+
### Access Token Authentication
64+
65+
The MagicbellJavaClient API uses an Access Token for authentication.
66+
67+
This token must be provided to authenticate your requests to the API.
68+
69+
#### Setting the Access Token
70+
71+
When you initialize the SDK, you can set the access token as follows:
72+
73+
```java
74+
import com.magicbell.client.magicbelljavaclient.MagicbellJavaClient;
75+
import com.magicbell.client.magicbelljavaclient.config.MagicbellJavaClientConfig;
76+
77+
public class Main {
78+
79+
public static void main(String[] args) {
80+
MagicbellJavaClientConfig config = MagicbellJavaClientConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
81+
82+
MagicbellJavaClient magicbellJavaClient = new MagicbellJavaClient(config);
83+
}
84+
}
85+
86+
```
87+
88+
If you need to set or update the access token after initializing the SDK, you can use:
89+
90+
```java
91+
magicbellJavaClient.setAccessToken('YOUR_ACCESS_TOKEN');
92+
```
93+
94+
## Setting a Custom Timeout
95+
96+
You can set a custom timeout for the SDK's HTTP requests as follows:
97+
98+
```java
99+
import com.magicbell.client.magicbelljavaclient.MagicbellJavaClient;
100+
import com.magicbell.client.magicbelljavaclient.config.MagicbellJavaClientConfig;
101+
102+
public class Main {
103+
104+
public static void main(String[] args) {
105+
MagicbellJavaClientConfig config = MagicbellJavaClientConfig.builder().timeout(10000).build();
106+
MagicbellJavaClient magicbellJavaClient = new MagicbellJavaClient(config);
107+
}
108+
}
109+
110+
```
111+
112+
# Sample Usage
113+
114+
Below is a comprehensive example demonstrating how to authenticate and call a simple endpoint:
115+
116+
```java
117+
import com.magicbell.client.magicbelljavaclient.MagicbellJavaClient;
118+
import com.magicbell.client.magicbelljavaclient.config.MagicbellJavaClientConfig;
119+
import com.magicbell.client.magicbelljavaclient.models.ArrayOfMetadataApnsTokens;
120+
import com.magicbell.client.magicbelljavaclient.models.GetMobilePushApnsTokensParameters;
121+
122+
public class Main {
123+
124+
public static void main(String[] args) {
125+
MagicbellJavaClientConfig config = MagicbellJavaClientConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
126+
127+
MagicbellJavaClient magicbellJavaClient = new MagicbellJavaClient(config);
128+
129+
GetMobilePushApnsTokensParameters requestParameters = GetMobilePushApnsTokensParameters
130+
.builder()
131+
.pageSize(3L)
132+
.pageAfter("page[after]")
133+
.pageBefore("page[before]")
134+
.build();
135+
136+
ArrayOfMetadataApnsTokens response = magicbellJavaClient.channels.getMobilePushApnsTokens(requestParameters);
137+
138+
System.out.println(response);
139+
}
140+
}
141+
142+
```
143+
144+
## Services
145+
146+
The SDK provides various services to interact with the API.
147+
148+
<details>
149+
<summary>Below is a list of all available services with links to their detailed documentation:</summary>
150+
151+
| Name |
152+
| :---------------------------------------------------------------------------------------------------------------------------------------- |
153+
| ChannelsService: [[Java](documentation/services/ChannelsService.md)] [[Kotlin](documentation/services/ChannelsService.kt.md)] |
154+
| IntegrationsService: [[Java](documentation/services/IntegrationsService.md)] [[Kotlin](documentation/services/IntegrationsService.kt.md)] |
155+
156+
</details>
157+
158+
## Models
159+
160+
The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.
161+
162+
<details>
163+
<summary>Below is a list of all available models with links to their detailed documentation:</summary>
164+
165+
| Name | Description |
166+
| :--------------------------------------------------------------------------------------------- | :---------- |
167+
| [ArrayOfMetadataApnsTokens](documentation/models/ArrayOfMetadataApnsTokens.md) | |
168+
| [ApnsToken](documentation/models/ApnsToken.md) | |
169+
| [MetadataApnsToken](documentation/models/MetadataApnsToken.md) | |
170+
| [DiscardResult](documentation/models/DiscardResult.md) | |
171+
| [ArrayOfMetadataExpoTokens](documentation/models/ArrayOfMetadataExpoTokens.md) | |
172+
| [ExpoToken](documentation/models/ExpoToken.md) | |
173+
| [MetadataExpoToken](documentation/models/MetadataExpoToken.md) | |
174+
| [ArrayOfMetadataFcmTokens](documentation/models/ArrayOfMetadataFcmTokens.md) | |
175+
| [FcmToken](documentation/models/FcmToken.md) | |
176+
| [MetadataFcmToken](documentation/models/MetadataFcmToken.md) | |
177+
| [ArrayOfMetadataSlackTokens](documentation/models/ArrayOfMetadataSlackTokens.md) | |
178+
| [SlackToken](documentation/models/SlackToken.md) | |
179+
| [MetadataSlackToken](documentation/models/MetadataSlackToken.md) | |
180+
| [ArrayOfMetadataTeamsTokens](documentation/models/ArrayOfMetadataTeamsTokens.md) | |
181+
| [TeamsToken](documentation/models/TeamsToken.md) | |
182+
| [MetadataTeamsToken](documentation/models/MetadataTeamsToken.md) | |
183+
| [ArrayOfMetadataWebPushTokens](documentation/models/ArrayOfMetadataWebPushTokens.md) | |
184+
| [WebPushToken](documentation/models/WebPushToken.md) | |
185+
| [MetadataWebPushToken](documentation/models/MetadataWebPushToken.md) | |
186+
| [InboxConfig](documentation/models/InboxConfig.md) | |
187+
| [SlackInstallation](documentation/models/SlackInstallation.md) | |
188+
| [SlackFinishInstallResponse](documentation/models/SlackFinishInstallResponse.md) | |
189+
| [SlackStartInstall](documentation/models/SlackStartInstall.md) | |
190+
| [SlackStartInstallResponseContent](documentation/models/SlackStartInstallResponseContent.md) | |
191+
| [TemplatesInstallation](documentation/models/TemplatesInstallation.md) | |
192+
| [WebPushStartInstallationResponse](documentation/models/WebPushStartInstallationResponse.md) | |
193+
| [Links](documentation/models/Links.md) | |
194+
| [TokenMetadata](documentation/models/TokenMetadata.md) | |
195+
| [GetMobilePushApnsTokensParameters](documentation/models/GetMobilePushApnsTokensParameters.md) | |
196+
| [GetMobilePushExpoTokensParameters](documentation/models/GetMobilePushExpoTokensParameters.md) | |
197+
| [GetMobilePushFcmTokensParameters](documentation/models/GetMobilePushFcmTokensParameters.md) | |
198+
| [GetSlackTokensParameters](documentation/models/GetSlackTokensParameters.md) | |
199+
| [GetTeamsTokensParameters](documentation/models/GetTeamsTokensParameters.md) | |
200+
| [GetWebPushTokensParameters](documentation/models/GetWebPushTokensParameters.md) | |
201+
202+
</details>
203+
204+
## License
205+
206+
This SDK is licensed under the MIT License.
207+
208+
See the [LICENSE](LICENSE) file for more details.

‎documentation/models/ApnsToken.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# ApnsToken
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :------------- | :---------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7+
| deviceToken | String | ✅ | |
8+
| appId | String | ❌ | (Optional) The bundle identifier of the application that is registering this token. Use this field to override the default identifier specified in the projects APNs integration. |
9+
| installationId | ApnsTokenInstallationId | ❌ | (Optional) The APNs environment the token is registered for. If none is provided we assume the token is used in `production`. |

‎documentation/models/ApnsTokenInstallationId.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# ApnsTokenInstallationId
2+
3+
(Optional) The APNs environment the token is registered for. If none is provided we assume the token is used in `production`.
4+
5+
**Properties**
6+
7+
| Name | Type | Required | Description |
8+
| :---------- | :----- | :------- | :------------ |
9+
| DEVELOPMENT | String | ✅ | "development" |
10+
| PRODUCTION | String | ✅ | "production" |

‎documentation/models/ArrayOfMetadataApnsTokens.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# ArrayOfMetadataApnsTokens
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :---- | :------------------------ | :------- | :---------- |
7+
| data | List\<MetadataApnsToken\> | ❌ | |
8+
| links | Links | ❌ | |

‎documentation/models/ArrayOfMetadataExpoTokens.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# ArrayOfMetadataExpoTokens
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :---- | :------------------------ | :------- | :---------- |
7+
| data | List\<MetadataExpoToken\> | ❌ | |
8+
| links | Links | ❌ | |

‎documentation/models/ArrayOfMetadataFcmTokens.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# ArrayOfMetadataFcmTokens
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :---- | :----------------------- | :------- | :---------- |
7+
| data | List\<MetadataFcmToken\> | ❌ | |
8+
| links | Links | ❌ | |

‎documentation/models/ArrayOfMetadataSlackTokens.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# ArrayOfMetadataSlackTokens
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :---- | :------------------------- | :------- | :---------- |
7+
| data | List\<MetadataSlackToken\> | ❌ | |
8+
| links | Links | ❌ | |

‎documentation/models/ArrayOfMetadataTeamsTokens.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# ArrayOfMetadataTeamsTokens
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :---- | :------------------------- | :------- | :---------- |
7+
| data | List\<MetadataTeamsToken\> | ❌ | |
8+
| links | Links | ❌ | |

‎documentation/models/ArrayOfMetadataWebPushTokens.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# ArrayOfMetadataWebPushTokens
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :---- | :--------------------------- | :------- | :---------- |
7+
| data | List\<MetadataWebPushToken\> | ❌ | |
8+
| links | Links | ❌ | |

‎documentation/models/AuthedUser.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# AuthedUser
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :----------- | :----- | :------- | :---------- |
7+
| id | String | ✅ | |
8+
| accessToken | String | ❌ | |
9+
| expiresIn | Long | ❌ | |
10+
| refreshToken | String | ❌ | |
11+
| scope | String | ❌ | |
12+
| tokenType | String | ❌ | |

‎documentation/models/Banner.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Banner
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :---------------- | :----- | :------- | :---------- |
7+
| backgroundColor | String | ✅ | |
8+
| fontSize | String | ✅ | |
9+
| textColor | String | ✅ | |
10+
| backgroundOpacity | Double | ❌ | |

‎documentation/models/DefaultHover.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# DefaultHover
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :-------------- | :----- | :------- | :---------- |
7+
| backgroundColor | String | ✅ | |

‎documentation/models/DefaultState.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# DefaultState
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :---- | :----- | :------- | :---------- |
7+
| color | String | ✅ | |

‎documentation/models/Default_.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Default\_
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :-------------- | :----------- | :------- | :---------- |
7+
| backgroundColor | String | ✅ | |
8+
| borderRadius | String | ✅ | |
9+
| fontFamily | String | ✅ | |
10+
| fontSize | String | ✅ | |
11+
| margin | String | ✅ | |
12+
| textColor | String | ✅ | |
13+
| hover | DefaultHover | ❌ | |
14+
| state | DefaultState | ❌ | |

‎documentation/models/Dialog.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Dialog
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :-------------- | :----- | :------- | :---------- |
7+
| accentColor | String | ✅ | |
8+
| backgroundColor | String | ✅ | |
9+
| textColor | String | ✅ | |

‎documentation/models/DiscardResult.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# DiscardResult
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :---------- | :----- | :------- | :---------- |
7+
| discardedAt | String | ❌ | |
8+
| id | String | ❌ | |

‎documentation/models/Enterprise.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Enterprise
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :--- | :----- | :------- | :---------- |
7+
| id | String | ✅ | |
8+
| name | String | ✅ | |

‎documentation/models/ExpoToken.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# ExpoToken
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :---------- | :----- | :------- | :---------- |
7+
| deviceToken | String | ✅ | |

‎documentation/models/FcmToken.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# FcmToken
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :------------- | :--------------------- | :------- | :---------- |
7+
| deviceToken | String | ✅ | |
8+
| installationId | FcmTokenInstallationId | ❌ | |

‎documentation/models/FcmTokenInstallationId.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# FcmTokenInstallationId
2+
3+
**Properties**
4+
5+
| Name | Type | Required | Description |
6+
| :---------- | :----- | :------- | :------------ |
7+
| DEVELOPMENT | String | ✅ | "development" |
8+
| PRODUCTION | String | ✅ | "production" |

0 commit comments

Comments
 (0)