casdoor-sdk 2.0.4

Casdoor SDK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

# casdoor\ServiceApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**send_email**](ServiceApi.md#send_email) | **POST** /api/send-email | 
[**send_notification**](ServiceApi.md#send_notification) | **POST** /api/send-notification | 
[**send_sms**](ServiceApi.md#send_sms) | **POST** /api/send-sms | 



## send_email

> models::ControllersResponse send_email(client_id, client_secret, from)


This API is not for Casdoor frontend to call, it is for Casdoor SDKs.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**client_id** | **String** | The clientId of the application | [required] |
**client_secret** | **String** | The clientSecret of the application | [required] |
**from** | [**ControllersEmailForm**](ControllersEmailForm.md) | Details of the email request | [required] |

### Return type

[**models::ControllersResponse**](controllers.Response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: */*

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


## send_notification

> models::ControllersResponse send_notification(from)


This API is not for Casdoor frontend to call, it is for Casdoor SDKs.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**from** | [**ControllersNotificationForm**](ControllersNotificationForm.md) | Details of the notification request | [required] |

### Return type

[**models::ControllersResponse**](controllers.Response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: */*

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


## send_sms

> models::ControllersResponse send_sms(client_id, client_secret, from)


This API is not for Casdoor frontend to call, it is for Casdoor SDKs.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**client_id** | **String** | The clientId of the application | [required] |
**client_secret** | **String** | The clientSecret of the application | [required] |
**from** | [**ControllersSmsForm**](ControllersSmsForm.md) | Details of the sms request | [required] |

### Return type

[**models::ControllersResponse**](controllers.Response.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: */*

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