Skip to content

Commit 360c1c3

Browse files
stigistigi
committed
chore: generate documentation with sourcedocs
1 parent 1ee4632 commit 360c1c3

File tree

18 files changed

+629
-0
lines changed

18 files changed

+629
-0
lines changed

‎.github/workflows/regen.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,18 @@ jobs:
2323
node-version: 20
2424
- uses: bahmutov/npm-install@v1
2525

26+
- name: Install Swift
27+
uses: sersoft-gmbh/swifty-linux-action
28+
with:
29+
release-version: 5.5
30+
31+
- name: Build SourceDocs
32+
run: |
33+
git clone [email protected]:stigi/SourceDocs.git --branch xcode16 /tmp/sourcedocs
34+
pushd /tmp/sourcedocs
35+
make
36+
popd
37+
2638
- name: Regen `magicbell-java-client`
2739
run: yarn codegen
2840
env:

‎documentation/Reference/Channels/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Reference Documentation
2+
3+
## Classes
4+
5+
- [ChannelsService](classes/ChannelsService.md)
6+
7+
This file was generated by [SourceDocs](https://github.com/eneko/SourceDocs) on 2024-12-17 00:14:55 +0000

‎documentation/Reference/Channels/classes/ChannelsService.md

Lines changed: 195 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,195 @@
1+
**CLASS**
2+
3+
# `ChannelsService`
4+
5+
```swift
6+
public class ChannelsService
7+
```
8+
9+
## Properties
10+
### `baseUrl`
11+
12+
```swift
13+
public var baseUrl: String
14+
```
15+
16+
## Methods
17+
### `init(baseUrl:)`
18+
19+
```swift
20+
public init(baseUrl: String)
21+
```
22+
23+
### `get_mobile_push_apns_tokens(params:)`
24+
25+
```swift
26+
public func get_mobile_push_apns_tokens(params: MagicbellSwiftClientRequestParams) async throws
27+
-> MagicbellSwiftClientResponse
28+
```
29+
30+
### `save_mobile_push_apns_token(data:params:)`
31+
32+
```swift
33+
public func save_mobile_push_apns_token(
34+
data: [String: Any?], params: MagicbellSwiftClientRequestParams
35+
) async throws -> MagicbellSwiftClientResponse
36+
```
37+
38+
### `get_mobile_push_apns_token(tokenId:params:)`
39+
40+
```swift
41+
public func get_mobile_push_apns_token(tokenId: String, params: MagicbellSwiftClientRequestParams)
42+
async throws -> MagicbellSwiftClientResponse
43+
```
44+
45+
### `discard_mobile_push_apns_token(tokenId:params:)`
46+
47+
```swift
48+
public func discard_mobile_push_apns_token(
49+
tokenId: String, params: MagicbellSwiftClientRequestParams
50+
) async throws -> MagicbellSwiftClientResponse
51+
```
52+
53+
### `get_mobile_push_expo_tokens(params:)`
54+
55+
```swift
56+
public func get_mobile_push_expo_tokens(params: MagicbellSwiftClientRequestParams) async throws
57+
-> MagicbellSwiftClientResponse
58+
```
59+
60+
### `save_mobile_push_expo_token(data:params:)`
61+
62+
```swift
63+
public func save_mobile_push_expo_token(
64+
data: [String: Any?], params: MagicbellSwiftClientRequestParams
65+
) async throws -> MagicbellSwiftClientResponse
66+
```
67+
68+
### `get_mobile_push_expo_token(tokenId:params:)`
69+
70+
```swift
71+
public func get_mobile_push_expo_token(tokenId: String, params: MagicbellSwiftClientRequestParams)
72+
async throws -> MagicbellSwiftClientResponse
73+
```
74+
75+
### `discard_mobile_push_expo_token(tokenId:params:)`
76+
77+
```swift
78+
public func discard_mobile_push_expo_token(
79+
tokenId: String, params: MagicbellSwiftClientRequestParams
80+
) async throws -> MagicbellSwiftClientResponse
81+
```
82+
83+
### `get_mobile_push_fcm_tokens(params:)`
84+
85+
```swift
86+
public func get_mobile_push_fcm_tokens(params: MagicbellSwiftClientRequestParams) async throws
87+
-> MagicbellSwiftClientResponse
88+
```
89+
90+
### `save_mobile_push_fcm_token(data:params:)`
91+
92+
```swift
93+
public func save_mobile_push_fcm_token(
94+
data: [String: Any?], params: MagicbellSwiftClientRequestParams
95+
) async throws -> MagicbellSwiftClientResponse
96+
```
97+
98+
### `get_mobile_push_fcm_token(tokenId:params:)`
99+
100+
```swift
101+
public func get_mobile_push_fcm_token(tokenId: String, params: MagicbellSwiftClientRequestParams)
102+
async throws -> MagicbellSwiftClientResponse
103+
```
104+
105+
### `discard_mobile_push_fcm_token(tokenId:params:)`
106+
107+
```swift
108+
public func discard_mobile_push_fcm_token(
109+
tokenId: String, params: MagicbellSwiftClientRequestParams
110+
) async throws -> MagicbellSwiftClientResponse
111+
```
112+
113+
### `get_slack_tokens(params:)`
114+
115+
```swift
116+
public func get_slack_tokens(params: MagicbellSwiftClientRequestParams) async throws
117+
-> MagicbellSwiftClientResponse
118+
```
119+
120+
### `save_slack_token(data:params:)`
121+
122+
```swift
123+
public func save_slack_token(data: [String: Any?], params: MagicbellSwiftClientRequestParams)
124+
async throws -> MagicbellSwiftClientResponse
125+
```
126+
127+
### `get_slack_token(tokenId:params:)`
128+
129+
```swift
130+
public func get_slack_token(tokenId: String, params: MagicbellSwiftClientRequestParams)
131+
async throws -> MagicbellSwiftClientResponse
132+
```
133+
134+
### `discard_slack_token(tokenId:params:)`
135+
136+
```swift
137+
public func discard_slack_token(tokenId: String, params: MagicbellSwiftClientRequestParams)
138+
async throws -> MagicbellSwiftClientResponse
139+
```
140+
141+
### `get_teams_tokens(params:)`
142+
143+
```swift
144+
public func get_teams_tokens(params: MagicbellSwiftClientRequestParams) async throws
145+
-> MagicbellSwiftClientResponse
146+
```
147+
148+
### `save_teams_token(data:params:)`
149+
150+
```swift
151+
public func save_teams_token(data: [String: Any?], params: MagicbellSwiftClientRequestParams)
152+
async throws -> MagicbellSwiftClientResponse
153+
```
154+
155+
### `get_teams_token(tokenId:params:)`
156+
157+
```swift
158+
public func get_teams_token(tokenId: String, params: MagicbellSwiftClientRequestParams)
159+
async throws -> MagicbellSwiftClientResponse
160+
```
161+
162+
### `discard_teams_token(tokenId:params:)`
163+
164+
```swift
165+
public func discard_teams_token(tokenId: String, params: MagicbellSwiftClientRequestParams)
166+
async throws -> MagicbellSwiftClientResponse
167+
```
168+
169+
### `get_web_push_tokens(params:)`
170+
171+
```swift
172+
public func get_web_push_tokens(params: MagicbellSwiftClientRequestParams) async throws
173+
-> MagicbellSwiftClientResponse
174+
```
175+
176+
### `save_web_push_token(data:params:)`
177+
178+
```swift
179+
public func save_web_push_token(data: [String: Any?], params: MagicbellSwiftClientRequestParams)
180+
async throws -> MagicbellSwiftClientResponse
181+
```
182+
183+
### `get_web_push_token(tokenId:params:)`
184+
185+
```swift
186+
public func get_web_push_token(tokenId: String, params: MagicbellSwiftClientRequestParams)
187+
async throws -> MagicbellSwiftClientResponse
188+
```
189+
190+
### `discard_web_push_token(tokenId:params:)`
191+
192+
```swift
193+
public func discard_web_push_token(tokenId: String, params: MagicbellSwiftClientRequestParams)
194+
async throws -> MagicbellSwiftClientResponse
195+
```

‎documentation/Reference/Integrations/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Reference Documentation
2+
3+
## Classes
4+
5+
- [IntegrationsService](classes/IntegrationsService.md)
6+
7+
This file was generated by [SourceDocs](https://github.com/eneko/SourceDocs) on 2024-12-17 00:14:55 +0000

‎documentation/Reference/Integrations/classes/IntegrationsService.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
**CLASS**
2+
3+
# `IntegrationsService`
4+
5+
```swift
6+
public class IntegrationsService
7+
```
8+
9+
## Properties
10+
### `baseUrl`
11+
12+
```swift
13+
public var baseUrl: String
14+
```
15+
16+
## Methods
17+
### `init(baseUrl:)`
18+
19+
```swift
20+
public init(baseUrl: String)
21+
```
22+
23+
### `save_inbox_installation(data:params:)`
24+
25+
```swift
26+
public func save_inbox_installation(
27+
data: [String: Any?], params: MagicbellSwiftClientRequestParams
28+
) async throws -> MagicbellSwiftClientResponse
29+
```
30+
31+
### `start_inbox_installation(params:)`
32+
33+
```swift
34+
public func start_inbox_installation(params: MagicbellSwiftClientRequestParams) async throws
35+
-> MagicbellSwiftClientResponse
36+
```
37+
38+
### `save_slack_installation(data:params:)`
39+
40+
```swift
41+
public func save_slack_installation(
42+
data: [String: Any?], params: MagicbellSwiftClientRequestParams
43+
) async throws -> MagicbellSwiftClientResponse
44+
```
45+
46+
### `finish_slack_installation(data:params:)`
47+
48+
```swift
49+
public func finish_slack_installation(
50+
data: [String: Any?], params: MagicbellSwiftClientRequestParams
51+
) async throws -> MagicbellSwiftClientResponse
52+
```
53+
54+
### `start_slack_installation(data:params:)`
55+
56+
```swift
57+
public func start_slack_installation(
58+
data: [String: Any?], params: MagicbellSwiftClientRequestParams
59+
) async throws -> MagicbellSwiftClientResponse
60+
```
61+
62+
### `save_templates_installation(data:params:)`
63+
64+
```swift
65+
public func save_templates_installation(
66+
data: [String: Any?], params: MagicbellSwiftClientRequestParams
67+
) async throws -> MagicbellSwiftClientResponse
68+
```
69+
70+
### `save_web_push_installation(data:params:)`
71+
72+
```swift
73+
public func save_web_push_installation(
74+
data: [String: Any?], params: MagicbellSwiftClientRequestParams
75+
) async throws -> MagicbellSwiftClientResponse
76+
```
77+
78+
### `start_web_push_installation(params:)`
79+
80+
```swift
81+
public func start_web_push_installation(params: MagicbellSwiftClientRequestParams) async throws
82+
-> MagicbellSwiftClientResponse
83+
```

‎documentation/Reference/MagicbellSwiftClient/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Reference Documentation
2+
3+
## Classes
4+
5+
- [MagicbellSwiftClient](classes/MagicbellSwiftClient.md)
6+
7+
This file was generated by [SourceDocs](https://github.com/eneko/SourceDocs) on 2024-12-17 00:14:55 +0000

‎documentation/Reference/MagicbellSwiftClient/classes/MagicbellSwiftClient.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
**CLASS**
2+
3+
# `MagicbellSwiftClient`
4+
5+
```swift
6+
public class MagicbellSwiftClient
7+
```
8+
9+
## Properties
10+
### `channels`
11+
12+
```swift
13+
public let channels: ChannelsService
14+
```
15+
16+
### `integrations`
17+
18+
```swift
19+
public let integrations: IntegrationsService
20+
```
21+
22+
### `baseUrl`
23+
24+
```swift
25+
public var baseUrl: String
26+
```
27+
28+
## Methods
29+
### `init(baseUrl:)`
30+
31+
```swift
32+
public init(baseUrl: String)
33+
```

‎documentation/Reference/MagicbellSwiftClientInternal/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Reference Documentation
2+
3+
## Structs
4+
5+
- [Request](structs/Request.md)
6+
- [Response](structs/Response.md)
7+
8+
## Classes
9+
10+
- [RestClient](classes/RestClient.md)
11+
12+
## Enums
13+
14+
- [HTTPMethod](enums/HTTPMethod.md)
15+
- [SdkErrors](enums/SdkErrors.md)
16+
17+
This file was generated by [SourceDocs](https://github.com/eneko/SourceDocs) on 2024-12-17 00:14:56 +0000

‎documentation/Reference/MagicbellSwiftClientInternal/classes/RestClient.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
**CLASS**
2+
3+
# `RestClient`
4+
5+
```swift
6+
public class RestClient
7+
```
8+
9+
## Methods
10+
### `init(session:)`
11+
12+
```swift
13+
public init(session: URLSession? = nil)
14+
```
15+
16+
### `makeRequest(request:)`
17+
18+
```swift
19+
public func makeRequest(request: Request) async throws -> Response
20+
```

0 commit comments

Comments
 (0)