emailguard_sdk 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +34 -147
- data/lib/emailguard_sdk/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f70ea213e1e74b6c64d7584b2f113833fd47e1f044e187c04c34c4347f5c5cea
|
|
4
|
+
data.tar.gz: f73d66c7acbfb4459275f3344094c380d57a2031020c4d975f58f264be324dc9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e4e9045a185f7aaba8069b642fc5dbe193d8122259b24b765fd844ec0fb60765dec203ba0cfb36ceec6109dd6146d862424f457d707430b4715ed77ff96d8df7
|
|
7
|
+
data.tar.gz: a97fde42971cf9443873534ca73b93779e606a0d06a77607fa95d8cdfcabb5b3f0d5e5b68dde6966da6e426f61d68d7310734b33476c480a62856d62d2880120
|
data/README.md
CHANGED
|
@@ -1,169 +1,56 @@
|
|
|
1
1
|
# emailguard_sdk
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Ruby SDK for the EmailGuard public API. This package is generated from the public OpenAPI spec.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Links
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
- [EmailGuard website](https://emailguard.co)
|
|
8
|
+
- [API docs](https://emailguard.co/docs/api-reference)
|
|
9
|
+
- [Ruby SDK guide](https://emailguard.co/docs/api-reference/guides/sdk-ruby)
|
|
10
|
+
- [OpenAPI spec](https://api.emailguard.co/api/v1/openapi.json)
|
|
11
|
+
- [Developer support](mailto:dev@emailguard.co)
|
|
8
12
|
|
|
9
|
-
|
|
10
|
-
- Package version: 1.0.0
|
|
11
|
-
- Generator version: 7.23.0
|
|
12
|
-
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
13
|
-
For more information, please visit [https://emailguard.co](https://emailguard.co)
|
|
13
|
+
## Install
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
```bash
|
|
16
|
+
gem install emailguard_sdk
|
|
17
|
+
```
|
|
16
18
|
|
|
17
|
-
|
|
19
|
+
## Authentication
|
|
18
20
|
|
|
19
|
-
|
|
21
|
+
Create a team-scoped API key in EmailGuard, then authenticate requests with:
|
|
20
22
|
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
+
```bash
|
|
24
|
+
Authorization: Bearer egsk_live_...
|
|
23
25
|
```
|
|
24
26
|
|
|
25
|
-
|
|
27
|
+
For local examples, you can also set:
|
|
26
28
|
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
+
```bash
|
|
30
|
+
EMAILGUARD_API_KEY=egsk_live_...
|
|
29
31
|
```
|
|
30
32
|
|
|
31
|
-
(for development, run `gem install --dev ./emailguard_sdk-1.0.0.gem` to install the development dependencies)
|
|
32
|
-
|
|
33
|
-
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
34
|
-
|
|
35
|
-
Finally add this to the Gemfile:
|
|
36
|
-
|
|
37
|
-
gem 'emailguard_sdk', '~> 1.0.0'
|
|
38
|
-
|
|
39
|
-
### Install from Git
|
|
40
33
|
|
|
41
|
-
|
|
34
|
+
## API Responses
|
|
42
35
|
|
|
43
|
-
|
|
36
|
+
REST API responses use a JSON envelope:
|
|
44
37
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
Include the Ruby code directly using `-I` as follows:
|
|
48
|
-
|
|
49
|
-
```shell
|
|
50
|
-
ruby -Ilib script.rb
|
|
38
|
+
```json
|
|
39
|
+
{ "code": "SUCCESS", "data": {}, "message": "" }
|
|
51
40
|
```
|
|
52
41
|
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
Please follow the [installation](#installation) procedure and then run the following code:
|
|
56
|
-
|
|
57
|
-
```ruby
|
|
58
|
-
# Load the gem
|
|
59
|
-
require 'emailguard_sdk'
|
|
60
|
-
|
|
61
|
-
# Setup authorization
|
|
62
|
-
Emailguard.configure do |config|
|
|
63
|
-
# Configure API key authorization: ApiKeyAuth
|
|
64
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
65
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
66
|
-
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
67
|
-
end
|
|
68
|
-
|
|
69
|
-
api_instance = Emailguard::BillingApi.new
|
|
70
|
-
opts = {
|
|
71
|
-
range: 'current', # String | Period selector: current, previous, or custom
|
|
72
|
-
start: 'start_example', # String | Custom range start (RFC3339 or YYYY-MM-DD); required when range=custom
|
|
73
|
-
_end: '_end_example' # String | Custom range end (RFC3339 or YYYY-MM-DD); required when range=custom
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
begin
|
|
77
|
-
#Get billing usage
|
|
78
|
-
result = api_instance.api_v1_team_billing_usage_get(opts)
|
|
79
|
-
p result
|
|
80
|
-
rescue Emailguard::ApiError => e
|
|
81
|
-
puts "Exception when calling BillingApi->api_v1_team_billing_usage_get: #{e}"
|
|
82
|
-
end
|
|
42
|
+
Read `data` on success and use `code` / `message` for error handling.
|
|
83
43
|
|
|
84
|
-
|
|
44
|
+
## Related Packages
|
|
45
|
+
|
|
46
|
+
- [@emailguard/sdk (TypeScript)](https://www.npmjs.com/package/@emailguard/sdk)
|
|
47
|
+
- [@emailguard/mcp (MCP)](https://www.npmjs.com/package/@emailguard/mcp)
|
|
48
|
+
- [github.com/emailguard/emailguard-go/emailguardsdk (Go)](https://pkg.go.dev/github.com/emailguard/emailguard-go/emailguardsdk)
|
|
49
|
+
- [emailguard_sdk (Python)](https://pypi.org/project/emailguard_sdk/)
|
|
50
|
+
- [emailguard/emailguard-sdk (PHP)](https://packagist.org/packages/emailguard/emailguard-sdk)
|
|
51
|
+
- [emailguard_sdk (Ruby)](https://rubygems.org/gems/emailguard_sdk) (this package)
|
|
52
|
+
- [EmailGuard Zapier integration](https://emailguard.co/docs/api-reference/guides/getting-started)
|
|
85
53
|
|
|
86
|
-
##
|
|
87
|
-
|
|
88
|
-
All URIs are relative to *http://api.emailguard.co*
|
|
89
|
-
|
|
90
|
-
Class | Method | HTTP request | Description
|
|
91
|
-
------------ | ------------- | ------------- | -------------
|
|
92
|
-
*Emailguard::BillingApi* | [**api_v1_team_billing_usage_get**](docs/BillingApi.md#api_v1_team_billing_usage_get) | **GET** /api/v1/team/billing/usage | Get billing usage
|
|
93
|
-
*Emailguard::ChannelsApi* | [**api_v1_team_notifications_channels_channel_id_delete**](docs/ChannelsApi.md#api_v1_team_notifications_channels_channel_id_delete) | **DELETE** /api/v1/team/notifications/channels/{channelId} | Delete notification channel
|
|
94
|
-
*Emailguard::ChannelsApi* | [**api_v1_team_notifications_channels_channel_id_put**](docs/ChannelsApi.md#api_v1_team_notifications_channels_channel_id_put) | **PUT** /api/v1/team/notifications/channels/{channelId} | Update notification channel
|
|
95
|
-
*Emailguard::ChannelsApi* | [**api_v1_team_notifications_channels_channel_id_test_post**](docs/ChannelsApi.md#api_v1_team_notifications_channels_channel_id_test_post) | **POST** /api/v1/team/notifications/channels/{channelId}/test | Test notification channel
|
|
96
|
-
*Emailguard::ChannelsApi* | [**api_v1_team_notifications_channels_get**](docs/ChannelsApi.md#api_v1_team_notifications_channels_get) | **GET** /api/v1/team/notifications/channels | List notification channels
|
|
97
|
-
*Emailguard::ChannelsApi* | [**api_v1_team_notifications_channels_post**](docs/ChannelsApi.md#api_v1_team_notifications_channels_post) | **POST** /api/v1/team/notifications/channels | Create notification channel
|
|
98
|
-
*Emailguard::EmailApi* | [**api_v1_emails_detect_get**](docs/EmailApi.md#api_v1_emails_detect_get) | **GET** /api/v1/emails/detect | Detect email characteristics
|
|
99
|
-
*Emailguard::EventsApi* | [**api_v1_team_notifications_events_get**](docs/EventsApi.md#api_v1_team_notifications_events_get) | **GET** /api/v1/team/notifications/events | List notification events
|
|
100
|
-
*Emailguard::InvitesApi* | [**api_v1_team_members_invites_get**](docs/InvitesApi.md#api_v1_team_members_invites_get) | **GET** /api/v1/team/members/invites | List pending team invites
|
|
101
|
-
*Emailguard::InvitesApi* | [**api_v1_team_members_invites_invite_id_delete**](docs/InvitesApi.md#api_v1_team_members_invites_invite_id_delete) | **DELETE** /api/v1/team/members/invites/{inviteId} | Cancel a pending invite
|
|
102
|
-
*Emailguard::InvitesApi* | [**api_v1_team_members_invites_post**](docs/InvitesApi.md#api_v1_team_members_invites_post) | **POST** /api/v1/team/members/invites | Invite a team member
|
|
103
|
-
*Emailguard::MembersApi* | [**api_v1_team_members_get**](docs/MembersApi.md#api_v1_team_members_get) | **GET** /api/v1/team/members | List team members
|
|
104
|
-
*Emailguard::MembersApi* | [**api_v1_team_members_user_id_delete**](docs/MembersApi.md#api_v1_team_members_user_id_delete) | **DELETE** /api/v1/team/members/{userId} | Remove a team member
|
|
105
|
-
*Emailguard::MembersApi* | [**api_v1_team_members_user_id_patch**](docs/MembersApi.md#api_v1_team_members_user_id_patch) | **PATCH** /api/v1/team/members/{userId} | Update a team member role
|
|
106
|
-
*Emailguard::RulesApi* | [**api_v1_team_notifications_rules_get**](docs/RulesApi.md#api_v1_team_notifications_rules_get) | **GET** /api/v1/team/notifications/rules | List notification rules
|
|
107
|
-
*Emailguard::RulesApi* | [**api_v1_team_notifications_rules_post**](docs/RulesApi.md#api_v1_team_notifications_rules_post) | **POST** /api/v1/team/notifications/rules | Create notification rule
|
|
108
|
-
*Emailguard::RulesApi* | [**api_v1_team_notifications_rules_rule_id_delete**](docs/RulesApi.md#api_v1_team_notifications_rules_rule_id_delete) | **DELETE** /api/v1/team/notifications/rules/{ruleId} | Delete notification rule
|
|
109
|
-
*Emailguard::RulesApi* | [**api_v1_team_notifications_rules_rule_id_put**](docs/RulesApi.md#api_v1_team_notifications_rules_rule_id_put) | **PUT** /api/v1/team/notifications/rules/{ruleId} | Update notification rule
|
|
110
|
-
*Emailguard::TeamsApi* | [**api_v1_team_get**](docs/TeamsApi.md#api_v1_team_get) | **GET** /api/v1/team | Get team
|
|
111
|
-
*Emailguard::TeamsApi* | [**api_v1_team_patch**](docs/TeamsApi.md#api_v1_team_patch) | **PATCH** /api/v1/team | Update team
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
## Documentation for Models
|
|
115
|
-
|
|
116
|
-
- [Emailguard::BaseResponse](docs/BaseResponse.md)
|
|
117
|
-
- [Emailguard::BillingUsageEvent](docs/BillingUsageEvent.md)
|
|
118
|
-
- [Emailguard::BillingUsageItem](docs/BillingUsageItem.md)
|
|
119
|
-
- [Emailguard::BillingUsageResponse](docs/BillingUsageResponse.md)
|
|
120
|
-
- [Emailguard::CreateNotificationChannelInput](docs/CreateNotificationChannelInput.md)
|
|
121
|
-
- [Emailguard::CreateNotificationRuleInput](docs/CreateNotificationRuleInput.md)
|
|
122
|
-
- [Emailguard::EmailDetectData](docs/EmailDetectData.md)
|
|
123
|
-
- [Emailguard::EmailDetectResponse](docs/EmailDetectResponse.md)
|
|
124
|
-
- [Emailguard::GetNotificationChannelResponse](docs/GetNotificationChannelResponse.md)
|
|
125
|
-
- [Emailguard::GetNotificationChannelsResponse](docs/GetNotificationChannelsResponse.md)
|
|
126
|
-
- [Emailguard::GetNotificationEventsResponse](docs/GetNotificationEventsResponse.md)
|
|
127
|
-
- [Emailguard::GetNotificationRulesResponse](docs/GetNotificationRulesResponse.md)
|
|
128
|
-
- [Emailguard::GetPublicTeamResponse](docs/GetPublicTeamResponse.md)
|
|
129
|
-
- [Emailguard::IdDataResponse](docs/IdDataResponse.md)
|
|
130
|
-
- [Emailguard::IdDataStruct](docs/IdDataStruct.md)
|
|
131
|
-
- [Emailguard::InviteTeamMemberInput](docs/InviteTeamMemberInput.md)
|
|
132
|
-
- [Emailguard::ListPublicTeamInvitesResponse](docs/ListPublicTeamInvitesResponse.md)
|
|
133
|
-
- [Emailguard::ListPublicTeamMembersResponse](docs/ListPublicTeamMembersResponse.md)
|
|
134
|
-
- [Emailguard::MessageResponse](docs/MessageResponse.md)
|
|
135
|
-
- [Emailguard::NotificationChannelResponse](docs/NotificationChannelResponse.md)
|
|
136
|
-
- [Emailguard::NotificationRuleChannelInput](docs/NotificationRuleChannelInput.md)
|
|
137
|
-
- [Emailguard::NotificationRuleChannelResponse](docs/NotificationRuleChannelResponse.md)
|
|
138
|
-
- [Emailguard::NotificationRuleResponse](docs/NotificationRuleResponse.md)
|
|
139
|
-
- [Emailguard::PublicTeamInviteResponse](docs/PublicTeamInviteResponse.md)
|
|
140
|
-
- [Emailguard::PublicTeamMemberResponse](docs/PublicTeamMemberResponse.md)
|
|
141
|
-
- [Emailguard::PublicTeamResponse](docs/PublicTeamResponse.md)
|
|
142
|
-
- [Emailguard::UpdateNotificationChannelInput](docs/UpdateNotificationChannelInput.md)
|
|
143
|
-
- [Emailguard::UpdateNotificationRuleInput](docs/UpdateNotificationRuleInput.md)
|
|
144
|
-
- [Emailguard::UpdateTeamInput](docs/UpdateTeamInput.md)
|
|
145
|
-
- [Emailguard::UpdateTeamMemberInput](docs/UpdateTeamMemberInput.md)
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
## Documentation for Authorization
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
Authentication schemes defined for the API:
|
|
152
|
-
### ApiKeyAuth
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
- **Type**: API key
|
|
156
|
-
- **API key parameter name**: Authorization
|
|
157
|
-
- **Location**: HTTP header
|
|
158
|
-
|
|
159
|
-
### BasicAuth
|
|
160
|
-
|
|
161
|
-
- **Type**: HTTP basic authentication
|
|
162
|
-
|
|
163
|
-
### BearerAuth
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
- **Type**: API key
|
|
167
|
-
- **API key parameter name**: Authorization
|
|
168
|
-
- **Location**: HTTP header
|
|
54
|
+
## Support
|
|
169
55
|
|
|
56
|
+
Questions, issues, or feedback? Email [dev@emailguard.co](mailto:dev@emailguard.co).
|