Skip to content

Commit 1f52b96

Browse files
Mayank SharmaMayank Sharma
Mayank Sharma
authored and
Mayank Sharma
committed
docs
1 parent d0a3d44 commit 1f52b96

Some content is hidden

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

60 files changed

+321
-376
lines changed

‎.vscode/settings.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"python.testing.unittestArgs": ["-v", "-s", "./test", "-p", "test*.py"],
3+
"python.testing.pytestEnabled": false,
4+
"python.testing.unittestEnabled": true
5+
}

‎README.md

Lines changed: 15 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
# Raven
22

3-
This is OpenAPI defintion for the APIs of Raven. You can find out more about Raven at [https://ravenapp.dev/](https://ravenapp.dev/).
4-
5-
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
6-
7-
- API version: 1.0.0
8-
- Package version: 1.0.0
9-
- Build package: io.swagger.codegen.languages.PythonClientCodegen
3+
Raven Client SDK for JAVA
104

115
## Requirements.
126

@@ -19,31 +13,13 @@ Python 2.7 and 3.4+
1913
If the python package is hosted on Github, you can install directly from Github
2014

2115
```sh
22-
pip install git+https://github.com//.git
23-
```
24-
25-
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com//.git`)
26-
27-
Then import the package:
28-
29-
```python
30-
import swagger_client
31-
```
32-
33-
### Setuptools
34-
35-
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
36-
37-
```sh
38-
python setup.py install --user
16+
pip install raven
3917
```
4018

41-
(or `sudo python setup.py install` to install the package for all users)
42-
4319
Then import the package:
4420

4521
```python
46-
import swagger_client
22+
import raven
4723
```
4824

4925
## Getting Started
@@ -53,59 +29,52 @@ Please follow the [installation procedure](#installation--usage) and then run th
5329
```python
5430
from __future__ import print_function
5531
import time
56-
import swagger_client
57-
from swagger_client.rest import RavenException
32+
import raven
33+
from raven import RavenException
5834
from pprint import pprint
5935

60-
# Configure API key authorization: ApiKeyAuth
61-
configuration = swagger_client.Configuration()
62-
configuration.api_key['Authorization'] = 'YOUR_API_KEY'
63-
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
64-
# configuration.api_key_prefix['Authorization'] = 'Bearer'
6536

6637
# create an instance of the API class
67-
api_instance = swagger_client.EventApi(swagger_client.ApiClient(configuration))
38+
api_instance = raven.RavenClient("YOUR API KEY")
6839
app_id = 'app_id_example' # str | app id of raven app
69-
event = swagger_client.SendEventBulk() # SendEventBulk | the body for the event that has to be triggered
40+
event = raven.SendEventBulk() # SendEventBulk | the body for the event that has to be triggered
7041
idempotency_key = 'idempotency_key_example' # str | idempotency key of api (optional)
7142

7243
try:
7344
# sends the event in bulk to all the clients specified
74-
api_response = api_instance.send_bulk_event(app_id, event, idempotency_key=idempotency_key)
45+
api_response = api_instance.send_bulk(app_id, event, idempotency_key=idempotency_key)
7546
pprint(api_response)
7647
except RavenException as e:
77-
print("Exception when calling EventApi->send_bulk_event: %s\n" % e)
48+
print("Exception when calling RavenClient->send_bulk: %s\n" % e)
7849

7950
```
8051

8152
## Documentation for API Endpoints
8253

8354
All URIs are relative to *https://api.ravenapp.dev*
8455

85-
| Class | Method | HTTP request | Description |
86-
| ---------- | ------------------------------------------------------- | ------------------------------------------- | ---------------------------------------------------- |
87-
| _EventApi_ | [**send_bulk_event**](docs/EventApi.md#send_bulk_event) | **POST** /v1/apps/{app_id}/events/bulk_send | sends the event in bulk to all the clients specified |
88-
| _EventApi_ | [**send_event**](docs/EventApi.md#send_event) | **POST** /v1/apps/{app_id}/events/send | sends the event to the client specified |
56+
| Class | Method | HTTP request | Description |
57+
| ------------- | ---------------------------------------------- | ------------------------------------------- | ---------------------------------------------------- |
58+
| _RavenClient_ | [**send_bulk**](docs/RavenClient.md#send_bulk) | **POST** /v1/apps/{app_id}/events/bulk_send | sends the event in bulk to all the clients specified |
59+
| _RavenClient_ | [**send**](docs/RavenClient.md#send) | **POST** /v1/apps/{app_id}/events/send | sends the event to the client specified |
8960

9061
## Documentation For Models
9162

9263
- [Attachments](docs/Attachments.md)
9364
- [Data](docs/Data.md)
9465
- [EmailOverride](docs/EmailOverride.md)
9566
- [EmailRecipient](docs/EmailRecipient.md)
96-
- [ErrorResponse](docs/ErrorResponse.md)
9767
- [EventOverride](docs/EventOverride.md)
9868
- [Param](docs/Param.md)
9969
- [Properties](docs/Properties.md)
10070
- [ProviderOverride](docs/ProviderOverride.md)
10171
- [PushOverride](docs/PushOverride.md)
10272
- [Response](docs/Response.md)
103-
- [SendEvent](docs/SendEvent.md)
104-
- [SendEventBulk](docs/SendEventBulk.md)
73+
- [SendEventRequest](docs/SendEventRequest.md)
74+
- [SendEventBulkRequest](docs/SendEventBulkRequest.md)
10575
- [SlackOverride](docs/SlackOverride.md)
10676
- [SlackProfile](docs/SlackProfile.md)
10777
- [SmsOverride](docs/SmsOverride.md)
108-
- [SuccessResponse](docs/SuccessResponse.md)
10978
- [TelegramProfile](docs/TelegramProfile.md)
11079
- [User](docs/User.md)
11180
- [VoiceOverride](docs/VoiceOverride.md)

‎docs/Attachments.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1+
12
# Attachments
23

34
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**filename** | **str** | | [optional]
7-
**content** | **str** | | [optional]
8-
**url** | **str** | | [optional]
5+
| Name | Type | Description | Notes |
6+
|--------------|------------|-------------|------------|
7+
| **filename** | **String** | | [optional] |
8+
| **content** | **String** | | [optional] |
9+
| **url** | **String** | | [optional] |
910

10-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1111

1212

‎docs/Data.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1+
12
# Data
23

34
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
5+
| Name | Type | Description | Notes |
6+
|------|------|-------------|-------|
7+
68

7-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
89

910

‎docs/EmailOverride.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1+
12
# EmailOverride
23

34
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**_from** | [**EmailRecipient**](EmailRecipient.md) | | [optional]
7-
**cc** | [**list[EmailRecipient]**](EmailRecipient.md) | | [optional]
8-
**bcc** | [**list[EmailRecipient]**](EmailRecipient.md) | | [optional]
9-
**attachments** | [**Attachments**](Attachments.md) | | [optional]
10-
**schedule_at** | **str** | | [optional]
11-
12-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
5+
| Name | Type | Description | Notes |
6+
|-----------------|-----------------------------------------------------|-------------|------------|
7+
| **from** | [**EmailRecipient**](EmailRecipient.md) | | [optional] |
8+
| **cc** | **List<[EmailRecipient](EmailRecipient.md)>** | | [optional] |
9+
| **bcc** | **List<[EmailRecipient](EmailRecipient.md)>** | | [optional] |
10+
| **attachments** | [**Attachments**](Attachments.md) | | [optional] |
11+
| **scheduleAt** | **String** | | [optional] |
12+
1313

1414

‎docs/EmailRecipient.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1+
12
# EmailRecipient
23

34
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**name** | **str** | | [optional]
7-
**address** | **str** | | [optional]
5+
| Name | Type | Description | Notes |
6+
|-------------|------------|-------------|------------|
7+
| **name** | **String** | | [optional] |
8+
| **address** | **String** | | [optional] |
89

9-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1010

1111

‎docs/ErrorResponse.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎docs/EventApi.md

Lines changed: 0 additions & 128 deletions
This file was deleted.

‎docs/EventOverride.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1+
12
# EventOverride
23

34
## Properties
4-
Name | Type | Description | Notes
5-
------------ | ------------- | ------------- | -------------
6-
**email** | [**EmailOverride**](EmailOverride.md) | | [optional]
7-
**sms** | [**SmsOverride**](SmsOverride.md) | | [optional]
8-
**whatsapp** | [**WhatsappOverride**](WhatsappOverride.md) | | [optional]
9-
**push** | [**PushOverride**](PushOverride.md) | | [optional]
10-
**webhook** | [**WebhookOverride**](WebhookOverride.md) | | [optional]
11-
**voice** | [**VoiceOverride**](VoiceOverride.md) | | [optional]
12-
**slack** | [**SlackOverride**](SlackOverride.md) | | [optional]
13-
**telegram** | [**TelegramOverride**](TelegramOverride.md) | | [optional]
14-
**providers** | [**dict(str, ProviderOverride)**](ProviderOverride.md) | | [optional]
5+
| Name | Type | Description | Notes |
6+
|---------------|----------------------------------------------------------------|-------------|------------|
7+
| **email** | [**EmailOverride**](EmailOverride.md) | | [optional] |
8+
| **sms** | [**SmsOverride**](SmsOverride.md) | | [optional] |
9+
| **whatsapp** | [**WhatsappOverride**](WhatsappOverride.md) | | [optional] |
10+
| **push** | [**PushOverride**](PushOverride.md) | | [optional] |
11+
| **webhook** | [**WebhookOverride**](WebhookOverride.md) | | [optional] |
12+
| **voice** | [**VoiceOverride**](VoiceOverride.md) | | [optional] |
13+
| **slack** | [**SlackOverride**](SlackOverride.md) | | [optional] |
14+
| **telegram** | [**TelegramOverride**](TelegramOverride.md) | | [optional] |
15+
| **providers** | **Map<String, [ProviderOverride](ProviderOverride.md)>** | | [optional] |
1516

16-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1717

1818

19+

‎docs/EventPayload.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# EventPayload
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ------------ | ------------------------------------- | ----------- | ----- |
7+
| **user** | **String** | | |
8+
| **data** | [**Data**](Data.md) | | |
9+
| **override** | [**EventOverride**](EventOverride.md) | | |

0 commit comments

Comments
 (0)