emailguard_sdk 1.0.5 → 1.2.0

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.
Files changed (140) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +21 -0
  3. data/README.md +16 -2
  4. data/examples/detect-email.rb +5 -0
  5. data/examples/get-billing-usage.rb +5 -0
  6. data/examples/get-team.rb +5 -0
  7. data/examples/list-notification-channels.rb +5 -0
  8. data/examples/list-pending-team-invites.rb +5 -0
  9. data/lib/emailguard_sdk/api/billing_api.rb +7 -7
  10. data/lib/emailguard_sdk/api/channels_api.rb +105 -105
  11. data/lib/emailguard_sdk/api/email_api.rb +11 -11
  12. data/lib/emailguard_sdk/api/events_api.rb +7 -7
  13. data/lib/emailguard_sdk/api/invites_api.rb +60 -60
  14. data/lib/emailguard_sdk/api/members_api.rb +27 -27
  15. data/lib/emailguard_sdk/api/rules_api.rb +71 -71
  16. data/lib/emailguard_sdk/api/teams_api.rb +14 -14
  17. data/lib/emailguard_sdk/api_client.rb +1 -1
  18. data/lib/emailguard_sdk/api_error.rb +1 -1
  19. data/lib/emailguard_sdk/api_model_base.rb +1 -1
  20. data/lib/emailguard_sdk/configuration.rb +3 -3
  21. data/lib/emailguard_sdk/facade.rb +191 -0
  22. data/lib/emailguard_sdk/models/base_response.rb +3 -3
  23. data/lib/emailguard_sdk/models/billing_usage_event.rb +1 -1
  24. data/lib/emailguard_sdk/models/billing_usage_item.rb +1 -1
  25. data/lib/emailguard_sdk/models/billing_usage_response.rb +3 -3
  26. data/lib/emailguard_sdk/models/create_notification_channel_input.rb +1 -1
  27. data/lib/emailguard_sdk/models/create_notification_rule_input.rb +1 -1
  28. data/lib/emailguard_sdk/models/email_detect_data.rb +68 -6
  29. data/lib/emailguard_sdk/models/email_detect_evidence.rb +1 -1
  30. data/lib/emailguard_sdk/models/email_detect_matched_rule.rb +165 -0
  31. data/lib/emailguard_sdk/models/email_detect_response.rb +3 -3
  32. data/lib/emailguard_sdk/models/get_notification_channel_response.rb +3 -3
  33. data/lib/emailguard_sdk/models/get_notification_channels_response.rb +3 -3
  34. data/lib/emailguard_sdk/models/get_notification_events_response.rb +3 -3
  35. data/lib/emailguard_sdk/models/get_notification_rules_response.rb +3 -3
  36. data/lib/emailguard_sdk/models/get_public_team_response.rb +3 -3
  37. data/lib/emailguard_sdk/models/id_data_response.rb +3 -3
  38. data/lib/emailguard_sdk/models/id_data_struct.rb +1 -1
  39. data/lib/emailguard_sdk/models/invite_team_member_input.rb +1 -1
  40. data/lib/emailguard_sdk/models/list_public_team_invites_response.rb +3 -3
  41. data/lib/emailguard_sdk/models/list_public_team_members_response.rb +3 -3
  42. data/lib/emailguard_sdk/models/message_response.rb +3 -3
  43. data/lib/emailguard_sdk/models/notification_channel_response.rb +1 -1
  44. data/lib/emailguard_sdk/models/notification_rule_channel_input.rb +1 -1
  45. data/lib/emailguard_sdk/models/notification_rule_channel_response.rb +1 -1
  46. data/lib/emailguard_sdk/models/notification_rule_response.rb +1 -1
  47. data/lib/emailguard_sdk/models/public_team_invite_response.rb +1 -1
  48. data/lib/emailguard_sdk/models/public_team_member_response.rb +1 -1
  49. data/lib/emailguard_sdk/models/public_team_response.rb +1 -1
  50. data/lib/emailguard_sdk/models/{update_team_member_input.rb → public_update_team_member_input.rb} +5 -32
  51. data/lib/emailguard_sdk/models/update_notification_channel_input.rb +1 -1
  52. data/lib/emailguard_sdk/models/update_notification_rule_input.rb +1 -1
  53. data/lib/emailguard_sdk/models/update_team_input.rb +1 -1
  54. data/lib/emailguard_sdk/version.rb +2 -2
  55. data/lib/emailguard_sdk.rb +4 -2
  56. data/spec/facade_contract_spec.rb +340 -0
  57. data/spec/spec_helper.rb +1 -111
  58. metadata +15 -126
  59. data/Gemfile +0 -9
  60. data/Rakefile +0 -10
  61. data/docs/BaseResponse.md +0 -20
  62. data/docs/BillingApi.md +0 -85
  63. data/docs/BillingUsageEvent.md +0 -26
  64. data/docs/BillingUsageItem.md +0 -28
  65. data/docs/BillingUsageResponse.md +0 -22
  66. data/docs/ChannelsApi.md +0 -366
  67. data/docs/CreateNotificationChannelInput.md +0 -22
  68. data/docs/CreateNotificationRuleInput.md +0 -28
  69. data/docs/EmailApi.md +0 -72
  70. data/docs/EmailDetectData.md +0 -48
  71. data/docs/EmailDetectEvidence.md +0 -22
  72. data/docs/EmailDetectResponse.md +0 -22
  73. data/docs/EventsApi.md +0 -76
  74. data/docs/GetNotificationChannelResponse.md +0 -22
  75. data/docs/GetNotificationChannelsResponse.md +0 -22
  76. data/docs/GetNotificationEventsResponse.md +0 -22
  77. data/docs/GetNotificationRulesResponse.md +0 -22
  78. data/docs/GetPublicTeamResponse.md +0 -22
  79. data/docs/IdDataResponse.md +0 -22
  80. data/docs/IdDataStruct.md +0 -18
  81. data/docs/InviteTeamMemberInput.md +0 -20
  82. data/docs/InvitesApi.md +0 -220
  83. data/docs/ListPublicTeamInvitesResponse.md +0 -22
  84. data/docs/ListPublicTeamMembersResponse.md +0 -22
  85. data/docs/MembersApi.md +0 -222
  86. data/docs/MessageResponse.md +0 -20
  87. data/docs/NotificationChannelResponse.md +0 -28
  88. data/docs/NotificationRuleChannelInput.md +0 -22
  89. data/docs/NotificationRuleChannelResponse.md +0 -28
  90. data/docs/NotificationRuleResponse.md +0 -32
  91. data/docs/PublicTeamInviteResponse.md +0 -24
  92. data/docs/PublicTeamMemberResponse.md +0 -34
  93. data/docs/PublicTeamResponse.md +0 -28
  94. data/docs/RulesApi.md +0 -294
  95. data/docs/TeamsApi.md +0 -148
  96. data/docs/UpdateNotificationChannelInput.md +0 -20
  97. data/docs/UpdateNotificationRuleInput.md +0 -28
  98. data/docs/UpdateTeamInput.md +0 -24
  99. data/docs/UpdateTeamMemberInput.md +0 -22
  100. data/emailguard_sdk.gemspec +0 -44
  101. data/git_push.sh +0 -57
  102. data/spec/api/billing_api_spec.rb +0 -49
  103. data/spec/api/channels_api_spec.rb +0 -95
  104. data/spec/api/email_api_spec.rb +0 -47
  105. data/spec/api/events_api_spec.rb +0 -46
  106. data/spec/api/invites_api_spec.rb +0 -70
  107. data/spec/api/members_api_spec.rb +0 -71
  108. data/spec/api/rules_api_spec.rb +0 -83
  109. data/spec/api/teams_api_spec.rb +0 -58
  110. data/spec/models/base_response_spec.rb +0 -42
  111. data/spec/models/billing_usage_event_spec.rb +0 -60
  112. data/spec/models/billing_usage_item_spec.rb +0 -66
  113. data/spec/models/billing_usage_response_spec.rb +0 -48
  114. data/spec/models/create_notification_channel_input_spec.rb +0 -48
  115. data/spec/models/create_notification_rule_input_spec.rb +0 -66
  116. data/spec/models/email_detect_data_spec.rb +0 -126
  117. data/spec/models/email_detect_evidence_spec.rb +0 -48
  118. data/spec/models/email_detect_response_spec.rb +0 -48
  119. data/spec/models/get_notification_channel_response_spec.rb +0 -48
  120. data/spec/models/get_notification_channels_response_spec.rb +0 -48
  121. data/spec/models/get_notification_events_response_spec.rb +0 -48
  122. data/spec/models/get_notification_rules_response_spec.rb +0 -48
  123. data/spec/models/get_public_team_response_spec.rb +0 -48
  124. data/spec/models/id_data_response_spec.rb +0 -48
  125. data/spec/models/id_data_struct_spec.rb +0 -36
  126. data/spec/models/invite_team_member_input_spec.rb +0 -42
  127. data/spec/models/list_public_team_invites_response_spec.rb +0 -48
  128. data/spec/models/list_public_team_members_response_spec.rb +0 -48
  129. data/spec/models/message_response_spec.rb +0 -42
  130. data/spec/models/notification_channel_response_spec.rb +0 -66
  131. data/spec/models/notification_rule_channel_input_spec.rb +0 -48
  132. data/spec/models/notification_rule_channel_response_spec.rb +0 -66
  133. data/spec/models/notification_rule_response_spec.rb +0 -78
  134. data/spec/models/public_team_invite_response_spec.rb +0 -54
  135. data/spec/models/public_team_member_response_spec.rb +0 -84
  136. data/spec/models/public_team_response_spec.rb +0 -66
  137. data/spec/models/update_notification_channel_input_spec.rb +0 -42
  138. data/spec/models/update_notification_rule_input_spec.rb +0 -66
  139. data/spec/models/update_team_input_spec.rb +0 -54
  140. data/spec/models/update_team_member_input_spec.rb +0 -48
data/spec/spec_helper.rb CHANGED
@@ -1,111 +1 @@
1
- =begin
2
- #EmailGuard Public API
3
-
4
- #Team-scoped REST API at /api/v1. Authenticate with `Authorization: Bearer egsk_live_...` or `X-API-Key`. Forks may register custom routes under /api/v1/tools/* (requires `tools:read` / `tools:write` scopes). Async tool jobs return a `job_id` — poll `GET .../{jobId}/results` until complete. See /docs/api-reference.
5
-
6
- The version of the OpenAPI document: 1.1
7
- Contact: dev@emailguard.co
8
- Generated by: https://openapi-generator.tech
9
- Generator version: 7.23.0
10
-
11
- =end
12
-
13
- # load the gem
14
- require 'emailguard_sdk'
15
-
16
- # The following was generated by the `rspec --init` command. Conventionally, all
17
- # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
18
- # The generated `.rspec` file contains `--require spec_helper` which will cause
19
- # this file to always be loaded, without a need to explicitly require it in any
20
- # files.
21
- #
22
- # Given that it is always loaded, you are encouraged to keep this file as
23
- # light-weight as possible. Requiring heavyweight dependencies from this file
24
- # will add to the boot time of your test suite on EVERY test run, even for an
25
- # individual file that may not need all of that loaded. Instead, consider making
26
- # a separate helper file that requires the additional dependencies and performs
27
- # the additional setup, and require it from the spec files that actually need
28
- # it.
29
- #
30
- # The `.rspec` file also contains a few flags that are not defaults but that
31
- # users commonly want.
32
- #
33
- # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
34
- RSpec.configure do |config|
35
- # rspec-expectations config goes here. You can use an alternate
36
- # assertion/expectation library such as wrong or the stdlib/minitest
37
- # assertions if you prefer.
38
- config.expect_with :rspec do |expectations|
39
- # This option will default to `true` in RSpec 4. It makes the `description`
40
- # and `failure_message` of custom matchers include text for helper methods
41
- # defined using `chain`, e.g.:
42
- # be_bigger_than(2).and_smaller_than(4).description
43
- # # => "be bigger than 2 and smaller than 4"
44
- # ...rather than:
45
- # # => "be bigger than 2"
46
- expectations.include_chain_clauses_in_custom_matcher_descriptions = true
47
- end
48
-
49
- # rspec-mocks config goes here. You can use an alternate test double
50
- # library (such as bogus or mocha) by changing the `mock_with` option here.
51
- config.mock_with :rspec do |mocks|
52
- # Prevents you from mocking or stubbing a method that does not exist on
53
- # a real object. This is generally recommended, and will default to
54
- # `true` in RSpec 4.
55
- mocks.verify_partial_doubles = true
56
- end
57
-
58
- # The settings below are suggested to provide a good initial experience
59
- # with RSpec, but feel free to customize to your heart's content.
60
- =begin
61
- # These two settings work together to allow you to limit a spec run
62
- # to individual examples or groups you care about by tagging them with
63
- # `:focus` metadata. When nothing is tagged with `:focus`, all examples
64
- # get run.
65
- config.filter_run :focus
66
- config.run_all_when_everything_filtered = true
67
-
68
- # Allows RSpec to persist some state between runs in order to support
69
- # the `--only-failures` and `--next-failure` CLI options. We recommend
70
- # you configure your source control system to ignore this file.
71
- config.example_status_persistence_file_path = "spec/examples.txt"
72
-
73
- # Limits the available syntax to the non-monkey patched syntax that is
74
- # recommended. For more details, see:
75
- # - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
76
- # - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
77
- # - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
78
- config.disable_monkey_patching!
79
-
80
- # This setting enables warnings. It's recommended, but in some cases may
81
- # be too noisy due to issues in dependencies.
82
- config.warnings = true
83
-
84
- # Many RSpec users commonly either run the entire suite or an individual
85
- # file, and it's useful to allow more verbose output when running an
86
- # individual spec file.
87
- if config.files_to_run.one?
88
- # Use the documentation formatter for detailed output,
89
- # unless a formatter has already been configured
90
- # (e.g. via a command-line flag).
91
- config.default_formatter = 'doc'
92
- end
93
-
94
- # Print the 10 slowest examples and example groups at the
95
- # end of the spec run, to help surface which specs are running
96
- # particularly slow.
97
- config.profile_examples = 10
98
-
99
- # Run specs in random order to surface order dependencies. If you find an
100
- # order dependency and want to debug it, you can fix the order by providing
101
- # the seed, which is printed after each run.
102
- # --seed 1234
103
- config.order = :random
104
-
105
- # Seed global randomization in this process using the `--seed` CLI option.
106
- # Setting this allows you to use `--seed` to deterministically reproduce
107
- # test failures related to randomization by passing the same `--seed` value
108
- # as the one that triggered the failure.
109
- Kernel.srand config.seed
110
- =end
111
- end
1
+ # Generated test support.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: emailguard_sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.5
4
+ version: 1.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - EmailGuard
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-08-28 00:00:00.000000000 Z
11
+ date: 2026-09-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -58,50 +58,13 @@ executables: []
58
58
  extensions: []
59
59
  extra_rdoc_files: []
60
60
  files:
61
- - Gemfile
61
+ - LICENSE
62
62
  - README.md
63
- - Rakefile
64
- - docs/BaseResponse.md
65
- - docs/BillingApi.md
66
- - docs/BillingUsageEvent.md
67
- - docs/BillingUsageItem.md
68
- - docs/BillingUsageResponse.md
69
- - docs/ChannelsApi.md
70
- - docs/CreateNotificationChannelInput.md
71
- - docs/CreateNotificationRuleInput.md
72
- - docs/EmailApi.md
73
- - docs/EmailDetectData.md
74
- - docs/EmailDetectEvidence.md
75
- - docs/EmailDetectResponse.md
76
- - docs/EventsApi.md
77
- - docs/GetNotificationChannelResponse.md
78
- - docs/GetNotificationChannelsResponse.md
79
- - docs/GetNotificationEventsResponse.md
80
- - docs/GetNotificationRulesResponse.md
81
- - docs/GetPublicTeamResponse.md
82
- - docs/IdDataResponse.md
83
- - docs/IdDataStruct.md
84
- - docs/InviteTeamMemberInput.md
85
- - docs/InvitesApi.md
86
- - docs/ListPublicTeamInvitesResponse.md
87
- - docs/ListPublicTeamMembersResponse.md
88
- - docs/MembersApi.md
89
- - docs/MessageResponse.md
90
- - docs/NotificationChannelResponse.md
91
- - docs/NotificationRuleChannelInput.md
92
- - docs/NotificationRuleChannelResponse.md
93
- - docs/NotificationRuleResponse.md
94
- - docs/PublicTeamInviteResponse.md
95
- - docs/PublicTeamMemberResponse.md
96
- - docs/PublicTeamResponse.md
97
- - docs/RulesApi.md
98
- - docs/TeamsApi.md
99
- - docs/UpdateNotificationChannelInput.md
100
- - docs/UpdateNotificationRuleInput.md
101
- - docs/UpdateTeamInput.md
102
- - docs/UpdateTeamMemberInput.md
103
- - emailguard_sdk.gemspec
104
- - git_push.sh
63
+ - examples/detect-email.rb
64
+ - examples/get-billing-usage.rb
65
+ - examples/get-team.rb
66
+ - examples/list-notification-channels.rb
67
+ - examples/list-pending-team-invites.rb
105
68
  - lib/emailguard_sdk.rb
106
69
  - lib/emailguard_sdk/api/billing_api.rb
107
70
  - lib/emailguard_sdk/api/channels_api.rb
@@ -115,6 +78,7 @@ files:
115
78
  - lib/emailguard_sdk/api_error.rb
116
79
  - lib/emailguard_sdk/api_model_base.rb
117
80
  - lib/emailguard_sdk/configuration.rb
81
+ - lib/emailguard_sdk/facade.rb
118
82
  - lib/emailguard_sdk/models/base_response.rb
119
83
  - lib/emailguard_sdk/models/billing_usage_event.rb
120
84
  - lib/emailguard_sdk/models/billing_usage_item.rb
@@ -123,6 +87,7 @@ files:
123
87
  - lib/emailguard_sdk/models/create_notification_rule_input.rb
124
88
  - lib/emailguard_sdk/models/email_detect_data.rb
125
89
  - lib/emailguard_sdk/models/email_detect_evidence.rb
90
+ - lib/emailguard_sdk/models/email_detect_matched_rule.rb
126
91
  - lib/emailguard_sdk/models/email_detect_response.rb
127
92
  - lib/emailguard_sdk/models/get_notification_channel_response.rb
128
93
  - lib/emailguard_sdk/models/get_notification_channels_response.rb
@@ -142,54 +107,16 @@ files:
142
107
  - lib/emailguard_sdk/models/public_team_invite_response.rb
143
108
  - lib/emailguard_sdk/models/public_team_member_response.rb
144
109
  - lib/emailguard_sdk/models/public_team_response.rb
110
+ - lib/emailguard_sdk/models/public_update_team_member_input.rb
145
111
  - lib/emailguard_sdk/models/update_notification_channel_input.rb
146
112
  - lib/emailguard_sdk/models/update_notification_rule_input.rb
147
113
  - lib/emailguard_sdk/models/update_team_input.rb
148
- - lib/emailguard_sdk/models/update_team_member_input.rb
149
114
  - lib/emailguard_sdk/version.rb
150
- - spec/api/billing_api_spec.rb
151
- - spec/api/channels_api_spec.rb
152
- - spec/api/email_api_spec.rb
153
- - spec/api/events_api_spec.rb
154
- - spec/api/invites_api_spec.rb
155
- - spec/api/members_api_spec.rb
156
- - spec/api/rules_api_spec.rb
157
- - spec/api/teams_api_spec.rb
158
- - spec/models/base_response_spec.rb
159
- - spec/models/billing_usage_event_spec.rb
160
- - spec/models/billing_usage_item_spec.rb
161
- - spec/models/billing_usage_response_spec.rb
162
- - spec/models/create_notification_channel_input_spec.rb
163
- - spec/models/create_notification_rule_input_spec.rb
164
- - spec/models/email_detect_data_spec.rb
165
- - spec/models/email_detect_evidence_spec.rb
166
- - spec/models/email_detect_response_spec.rb
167
- - spec/models/get_notification_channel_response_spec.rb
168
- - spec/models/get_notification_channels_response_spec.rb
169
- - spec/models/get_notification_events_response_spec.rb
170
- - spec/models/get_notification_rules_response_spec.rb
171
- - spec/models/get_public_team_response_spec.rb
172
- - spec/models/id_data_response_spec.rb
173
- - spec/models/id_data_struct_spec.rb
174
- - spec/models/invite_team_member_input_spec.rb
175
- - spec/models/list_public_team_invites_response_spec.rb
176
- - spec/models/list_public_team_members_response_spec.rb
177
- - spec/models/message_response_spec.rb
178
- - spec/models/notification_channel_response_spec.rb
179
- - spec/models/notification_rule_channel_input_spec.rb
180
- - spec/models/notification_rule_channel_response_spec.rb
181
- - spec/models/notification_rule_response_spec.rb
182
- - spec/models/public_team_invite_response_spec.rb
183
- - spec/models/public_team_member_response_spec.rb
184
- - spec/models/public_team_response_spec.rb
185
- - spec/models/update_notification_channel_input_spec.rb
186
- - spec/models/update_notification_rule_input_spec.rb
187
- - spec/models/update_team_input_spec.rb
188
- - spec/models/update_team_member_input_spec.rb
115
+ - spec/facade_contract_spec.rb
189
116
  - spec/spec_helper.rb
190
117
  homepage: https://emailguard.co
191
118
  licenses:
192
- - Unlicense
119
+ - MIT
193
120
  metadata:
194
121
  homepage_uri: https://emailguard.co
195
122
  source_code_uri: https://github.com/EmailGuard/emailguard-ruby
@@ -203,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
203
130
  requirements:
204
131
  - - ">="
205
132
  - !ruby/object:Gem::Version
206
- version: '2.7'
133
+ version: '3.0'
207
134
  required_rubygems_version: !ruby/object:Gem::Requirement
208
135
  requirements:
209
136
  - - ">="
@@ -215,43 +142,5 @@ signing_key:
215
142
  specification_version: 4
216
143
  summary: EmailGuard public API Ruby SDK
217
144
  test_files:
218
- - spec/api/invites_api_spec.rb
219
- - spec/api/rules_api_spec.rb
220
- - spec/api/teams_api_spec.rb
221
- - spec/api/events_api_spec.rb
222
- - spec/api/email_api_spec.rb
223
- - spec/api/channels_api_spec.rb
224
- - spec/api/members_api_spec.rb
225
- - spec/api/billing_api_spec.rb
226
- - spec/models/id_data_struct_spec.rb
227
- - spec/models/email_detect_evidence_spec.rb
228
- - spec/models/update_team_member_input_spec.rb
229
- - spec/models/email_detect_data_spec.rb
230
- - spec/models/billing_usage_item_spec.rb
231
- - spec/models/update_notification_channel_input_spec.rb
232
- - spec/models/billing_usage_event_spec.rb
233
- - spec/models/notification_channel_response_spec.rb
234
- - spec/models/email_detect_response_spec.rb
235
- - spec/models/get_notification_rules_response_spec.rb
236
- - spec/models/list_public_team_members_response_spec.rb
237
- - spec/models/update_team_input_spec.rb
238
- - spec/models/create_notification_rule_input_spec.rb
239
- - spec/models/billing_usage_response_spec.rb
240
- - spec/models/get_public_team_response_spec.rb
241
- - spec/models/message_response_spec.rb
242
- - spec/models/invite_team_member_input_spec.rb
243
- - spec/models/create_notification_channel_input_spec.rb
244
- - spec/models/notification_rule_channel_input_spec.rb
245
- - spec/models/base_response_spec.rb
246
- - spec/models/get_notification_channels_response_spec.rb
247
- - spec/models/notification_rule_channel_response_spec.rb
248
- - spec/models/update_notification_rule_input_spec.rb
249
- - spec/models/notification_rule_response_spec.rb
250
- - spec/models/public_team_invite_response_spec.rb
251
- - spec/models/public_team_response_spec.rb
252
- - spec/models/get_notification_events_response_spec.rb
253
- - spec/models/public_team_member_response_spec.rb
254
- - spec/models/get_notification_channel_response_spec.rb
255
- - spec/models/list_public_team_invites_response_spec.rb
256
- - spec/models/id_data_response_spec.rb
145
+ - spec/facade_contract_spec.rb
257
146
  - spec/spec_helper.rb
data/Gemfile DELETED
@@ -1,9 +0,0 @@
1
- source 'https://rubygems.org'
2
-
3
- gemspec
4
-
5
- group :development, :test do
6
- gem 'rake', '~> 13.0.1'
7
- gem 'pry-byebug'
8
- gem 'rubocop', '~> 0.66.0'
9
- end
data/Rakefile DELETED
@@ -1,10 +0,0 @@
1
- require "bundler/gem_tasks"
2
-
3
- begin
4
- require 'rspec/core/rake_task'
5
-
6
- RSpec::Core::RakeTask.new(:spec)
7
- task default: :spec
8
- rescue LoadError
9
- # no rspec available
10
- end
data/docs/BaseResponse.md DELETED
@@ -1,20 +0,0 @@
1
- # Emailguard::BaseResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **code** | **String** | Machine-readable status code (for example OK or INVALID_BODY). | |
8
- | **message** | **String** | Human-readable detail when the code is not OK. | [optional] |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'emailguard_sdk'
14
-
15
- instance = Emailguard::BaseResponse.new(
16
- code: null,
17
- message: null
18
- )
19
- ```
20
-
data/docs/BillingApi.md DELETED
@@ -1,85 +0,0 @@
1
- # Emailguard::BillingApi
2
-
3
- All URIs are relative to *http://api.emailguard.co*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**api_v1_team_billing_usage_get**](BillingApi.md#api_v1_team_billing_usage_get) | **GET** /api/v1/team/billing/usage | Get billing usage |
8
-
9
-
10
- ## api_v1_team_billing_usage_get
11
-
12
- > <BillingUsageResponse> api_v1_team_billing_usage_get(opts)
13
-
14
- Get billing usage
15
-
16
- Returns metered feature usage for the team's billing period. Defaults to the current period; use `range=previous` or `range=custom` with `start` and `end` to query other windows.
17
-
18
- ### Examples
19
-
20
- ```ruby
21
- require 'time'
22
- require 'emailguard_sdk'
23
- # setup authorization
24
- Emailguard.configure do |config|
25
- # Configure API key authorization: ApiKeyAuth
26
- config.api_key['Authorization'] = 'YOUR API KEY'
27
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
28
- # config.api_key_prefix['Authorization'] = 'Bearer'
29
- end
30
-
31
- api_instance = Emailguard::BillingApi.new
32
- opts = {
33
- range: 'current', # String | Period selector: current, previous, or custom
34
- start: 'start_example', # String | Custom range start (RFC3339 or YYYY-MM-DD); required when range=custom
35
- _end: '_end_example' # String | Custom range end (RFC3339 or YYYY-MM-DD); required when range=custom
36
- }
37
-
38
- begin
39
- # Get billing usage
40
- result = api_instance.api_v1_team_billing_usage_get(opts)
41
- p result
42
- rescue Emailguard::ApiError => e
43
- puts "Error when calling BillingApi->api_v1_team_billing_usage_get: #{e}"
44
- end
45
- ```
46
-
47
- #### Using the api_v1_team_billing_usage_get_with_http_info variant
48
-
49
- This returns an Array which contains the response data, status code and headers.
50
-
51
- > <Array(<BillingUsageResponse>, Integer, Hash)> api_v1_team_billing_usage_get_with_http_info(opts)
52
-
53
- ```ruby
54
- begin
55
- # Get billing usage
56
- data, status_code, headers = api_instance.api_v1_team_billing_usage_get_with_http_info(opts)
57
- p status_code # => 2xx
58
- p headers # => { ... }
59
- p data # => <BillingUsageResponse>
60
- rescue Emailguard::ApiError => e
61
- puts "Error when calling BillingApi->api_v1_team_billing_usage_get_with_http_info: #{e}"
62
- end
63
- ```
64
-
65
- ### Parameters
66
-
67
- | Name | Type | Description | Notes |
68
- | ---- | ---- | ----------- | ----- |
69
- | **range** | **String** | Period selector: current, previous, or custom | [optional] |
70
- | **start** | **String** | Custom range start (RFC3339 or YYYY-MM-DD); required when range&#x3D;custom | [optional] |
71
- | **_end** | **String** | Custom range end (RFC3339 or YYYY-MM-DD); required when range&#x3D;custom | [optional] |
72
-
73
- ### Return type
74
-
75
- [**BillingUsageResponse**](BillingUsageResponse.md)
76
-
77
- ### Authorization
78
-
79
- [ApiKeyAuth](../README.md#ApiKeyAuth)
80
-
81
- ### HTTP request headers
82
-
83
- - **Content-Type**: Not defined
84
- - **Accept**: application/json
85
-
@@ -1,26 +0,0 @@
1
- # Emailguard::BillingUsageEvent
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **delta** | **Integer** | | |
8
- | **event_type** | **String** | | |
9
- | **metadata** | **String** | | |
10
- | **usage_after** | **Integer** | | |
11
- | **usage_before** | **Integer** | | |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'emailguard_sdk'
17
-
18
- instance = Emailguard::BillingUsageEvent.new(
19
- delta: null,
20
- event_type: null,
21
- metadata: null,
22
- usage_after: null,
23
- usage_before: null
24
- )
25
- ```
26
-
@@ -1,28 +0,0 @@
1
- # Emailguard::BillingUsageItem
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **events** | [**Array&lt;BillingUsageEvent&gt;**](BillingUsageEvent.md) | | [optional] |
8
- | **feature_key** | **String** | | |
9
- | **limit** | **Integer** | | [optional] |
10
- | **period_end** | **String** | | |
11
- | **period_start** | **String** | | |
12
- | **usage** | **Integer** | | |
13
-
14
- ## Example
15
-
16
- ```ruby
17
- require 'emailguard_sdk'
18
-
19
- instance = Emailguard::BillingUsageItem.new(
20
- events: null,
21
- feature_key: null,
22
- limit: null,
23
- period_end: null,
24
- period_start: null,
25
- usage: null
26
- )
27
- ```
28
-
@@ -1,22 +0,0 @@
1
- # Emailguard::BillingUsageResponse
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **code** | **String** | Machine-readable status code (for example OK or INVALID_BODY). | |
8
- | **data** | [**Array&lt;BillingUsageItem&gt;**](BillingUsageItem.md) | | [optional] |
9
- | **message** | **String** | Human-readable detail when the code is not OK. | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'emailguard_sdk'
15
-
16
- instance = Emailguard::BillingUsageResponse.new(
17
- code: null,
18
- data: null,
19
- message: null
20
- )
21
- ```
22
-