parlo-sdk 1.0.0 → 1.1.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 (36) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +6 -1
  3. data/lib/parlo-sdk/api/domains_api.rb +1 -1
  4. data/lib/parlo-sdk/api/emails_api.rb +94 -1
  5. data/lib/parlo-sdk/api_client.rb +1 -1
  6. data/lib/parlo-sdk/api_error.rb +1 -1
  7. data/lib/parlo-sdk/api_model_base.rb +1 -1
  8. data/lib/parlo-sdk/configuration.rb +1 -1
  9. data/lib/parlo-sdk/models/auth_health.rb +1 -1
  10. data/lib/parlo-sdk/models/auth_health_dkim.rb +1 -1
  11. data/lib/parlo-sdk/models/auth_health_dmarc.rb +1 -1
  12. data/lib/parlo-sdk/models/auth_health_spf.rb +1 -1
  13. data/lib/parlo-sdk/models/create_domain_request.rb +1 -1
  14. data/lib/parlo-sdk/models/delete_domain200_response.rb +1 -1
  15. data/lib/parlo-sdk/models/dns_record.rb +1 -1
  16. data/lib/parlo-sdk/models/domain.rb +1 -1
  17. data/lib/parlo-sdk/models/domain_summary.rb +1 -1
  18. data/lib/parlo-sdk/models/email.rb +106 -7
  19. data/lib/parlo-sdk/models/email_created.rb +1 -1
  20. data/lib/parlo-sdk/models/email_list.rb +192 -0
  21. data/lib/parlo-sdk/models/email_summary.rb +367 -0
  22. data/lib/parlo-sdk/models/error.rb +1 -1
  23. data/lib/parlo-sdk/models/list_domains200_response.rb +1 -1
  24. data/lib/parlo-sdk/models/list_meta.rb +240 -0
  25. data/lib/parlo-sdk/models/send_email_request.rb +2 -2
  26. data/lib/parlo-sdk/models/send_email_request_cc.rb +1 -1
  27. data/lib/parlo-sdk/models/send_email_request_to.rb +1 -1
  28. data/lib/parlo-sdk/models/webhook_event.rb +268 -0
  29. data/lib/parlo-sdk/version.rb +2 -2
  30. data/lib/parlo-sdk.rb +5 -1
  31. data/spec/models/email_list_spec.rb +42 -0
  32. data/spec/models/email_summary_spec.rb +88 -0
  33. data/spec/models/list_meta_spec.rb +60 -0
  34. data/spec/models/webhook_event_spec.rb +58 -0
  35. data/spec/spec_helper.rb +1 -1
  36. metadata +14 -2
@@ -0,0 +1,88 @@
1
+ =begin
2
+ #Parlo API
3
+
4
+ #The Parlo API sends transactional email and manages the sending domains it authenticates from. Marketing campaigns (audiences, templates, broadcasts) are designed and sent from the Parlo dashboard, not this API — the API is transactional-only at launch. All requests authenticate with a company API key as an HTTP bearer token: `Authorization: Bearer parlo_live_xxx`. Errors return a JSON body of the shape `{ \"message\": string, \"code\": string }`.
5
+
6
+ The version of the OpenAPI document: 1.1.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.24.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for Parlo::EmailSummary
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe Parlo::EmailSummary do
21
+ #let(:instance) { Parlo::EmailSummary.new }
22
+
23
+ describe 'test an instance of EmailSummary' do
24
+ it 'should create an instance of EmailSummary' do
25
+ # uncomment below to test the instance creation
26
+ #expect(instance).to be_instance_of(Parlo::EmailSummary)
27
+ end
28
+ end
29
+
30
+ describe 'test attribute "id"' do
31
+ it 'should work' do
32
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
33
+ end
34
+ end
35
+
36
+ describe 'test attribute "to"' do
37
+ it 'should work' do
38
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
39
+ end
40
+ end
41
+
42
+ describe 'test attribute "from"' do
43
+ it 'should work' do
44
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
45
+ end
46
+ end
47
+
48
+ describe 'test attribute "subject"' do
49
+ it 'should work' do
50
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
51
+ end
52
+ end
53
+
54
+ describe 'test attribute "status"' do
55
+ it 'should work' do
56
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
57
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["queued", "sent", "delivered", "bounced", "complained", "failed"])
58
+ # validator.allowable_values.each do |value|
59
+ # expect { instance.status = value }.not_to raise_error
60
+ # end
61
+ end
62
+ end
63
+
64
+ describe 'test attribute "opened"' do
65
+ it 'should work' do
66
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
67
+ end
68
+ end
69
+
70
+ describe 'test attribute "clicked"' do
71
+ it 'should work' do
72
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
73
+ end
74
+ end
75
+
76
+ describe 'test attribute "last_event_at"' do
77
+ it 'should work' do
78
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
79
+ end
80
+ end
81
+
82
+ describe 'test attribute "created_at"' do
83
+ it 'should work' do
84
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
85
+ end
86
+ end
87
+
88
+ end
@@ -0,0 +1,60 @@
1
+ =begin
2
+ #Parlo API
3
+
4
+ #The Parlo API sends transactional email and manages the sending domains it authenticates from. Marketing campaigns (audiences, templates, broadcasts) are designed and sent from the Parlo dashboard, not this API — the API is transactional-only at launch. All requests authenticate with a company API key as an HTTP bearer token: `Authorization: Bearer parlo_live_xxx`. Errors return a JSON body of the shape `{ \"message\": string, \"code\": string }`.
5
+
6
+ The version of the OpenAPI document: 1.1.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.24.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for Parlo::ListMeta
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe Parlo::ListMeta do
21
+ #let(:instance) { Parlo::ListMeta.new }
22
+
23
+ describe 'test an instance of ListMeta' do
24
+ it 'should create an instance of ListMeta' do
25
+ # uncomment below to test the instance creation
26
+ #expect(instance).to be_instance_of(Parlo::ListMeta)
27
+ end
28
+ end
29
+
30
+ describe 'test attribute "current_page"' do
31
+ it 'should work' do
32
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
33
+ end
34
+ end
35
+
36
+ describe 'test attribute "next_page"' do
37
+ it 'should work' do
38
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
39
+ end
40
+ end
41
+
42
+ describe 'test attribute "prev_page"' do
43
+ it 'should work' do
44
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
45
+ end
46
+ end
47
+
48
+ describe 'test attribute "total_pages"' do
49
+ it 'should work' do
50
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
51
+ end
52
+ end
53
+
54
+ describe 'test attribute "total_count"' do
55
+ it 'should work' do
56
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
57
+ end
58
+ end
59
+
60
+ end
@@ -0,0 +1,58 @@
1
+ =begin
2
+ #Parlo API
3
+
4
+ #The Parlo API sends transactional email and manages the sending domains it authenticates from. Marketing campaigns (audiences, templates, broadcasts) are designed and sent from the Parlo dashboard, not this API — the API is transactional-only at launch. All requests authenticate with a company API key as an HTTP bearer token: `Authorization: Bearer parlo_live_xxx`. Errors return a JSON body of the shape `{ \"message\": string, \"code\": string }`.
5
+
6
+ The version of the OpenAPI document: 1.1.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.24.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for Parlo::WebhookEvent
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe Parlo::WebhookEvent do
21
+ #let(:instance) { Parlo::WebhookEvent.new }
22
+
23
+ describe 'test an instance of WebhookEvent' do
24
+ it 'should create an instance of WebhookEvent' do
25
+ # uncomment below to test the instance creation
26
+ #expect(instance).to be_instance_of(Parlo::WebhookEvent)
27
+ end
28
+ end
29
+
30
+ describe 'test attribute "id"' do
31
+ it 'should work' do
32
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
33
+ end
34
+ end
35
+
36
+ describe 'test attribute "type"' do
37
+ it 'should work' do
38
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
39
+ # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["email.delivered", "email.bounced", "email.complained", "email.opened", "email.clicked", "email.failed"])
40
+ # validator.allowable_values.each do |value|
41
+ # expect { instance.type = value }.not_to raise_error
42
+ # end
43
+ end
44
+ end
45
+
46
+ describe 'test attribute "created_at"' do
47
+ it 'should work' do
48
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
49
+ end
50
+ end
51
+
52
+ describe 'test attribute "data"' do
53
+ it 'should work' do
54
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
55
+ end
56
+ end
57
+
58
+ end
data/spec/spec_helper.rb CHANGED
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Parlo API sends transactional email and manages the sending domains it authenticates from. Marketing campaigns (audiences, templates, broadcasts) are designed and sent from the Parlo dashboard, not this API — the API is transactional-only at launch. All requests authenticate with a company API key as an HTTP bearer token: `Authorization: Bearer parlo_live_xxx`. Errors return a JSON body of the shape `{ \"message\": string, \"code\": string }`.
5
5
 
6
- The version of the OpenAPI document: 1.0.0
6
+ The version of the OpenAPI document: 1.1.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.24.0-SNAPSHOT
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: parlo-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Claris
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-07-25 00:00:00.000000000 Z
11
+ date: 2026-08-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -81,11 +81,15 @@ files:
81
81
  - lib/parlo-sdk/models/domain_summary.rb
82
82
  - lib/parlo-sdk/models/email.rb
83
83
  - lib/parlo-sdk/models/email_created.rb
84
+ - lib/parlo-sdk/models/email_list.rb
85
+ - lib/parlo-sdk/models/email_summary.rb
84
86
  - lib/parlo-sdk/models/error.rb
85
87
  - lib/parlo-sdk/models/list_domains200_response.rb
88
+ - lib/parlo-sdk/models/list_meta.rb
86
89
  - lib/parlo-sdk/models/send_email_request.rb
87
90
  - lib/parlo-sdk/models/send_email_request_cc.rb
88
91
  - lib/parlo-sdk/models/send_email_request_to.rb
92
+ - lib/parlo-sdk/models/webhook_event.rb
89
93
  - lib/parlo-sdk/version.rb
90
94
  - spec/api/domains_api_spec.rb
91
95
  - spec/api/emails_api_spec.rb
@@ -99,12 +103,16 @@ files:
99
103
  - spec/models/domain_spec.rb
100
104
  - spec/models/domain_summary_spec.rb
101
105
  - spec/models/email_created_spec.rb
106
+ - spec/models/email_list_spec.rb
102
107
  - spec/models/email_spec.rb
108
+ - spec/models/email_summary_spec.rb
103
109
  - spec/models/error_spec.rb
104
110
  - spec/models/list_domains200_response_spec.rb
111
+ - spec/models/list_meta_spec.rb
105
112
  - spec/models/send_email_request_cc_spec.rb
106
113
  - spec/models/send_email_request_spec.rb
107
114
  - spec/models/send_email_request_to_spec.rb
115
+ - spec/models/webhook_event_spec.rb
108
116
  - spec/spec_helper.rb
109
117
  homepage: https://getparlo.io
110
118
  licenses:
@@ -142,10 +150,14 @@ test_files:
142
150
  - spec/models/auth_health_spf_spec.rb
143
151
  - spec/models/send_email_request_to_spec.rb
144
152
  - spec/models/send_email_request_spec.rb
153
+ - spec/models/webhook_event_spec.rb
145
154
  - spec/models/create_domain_request_spec.rb
155
+ - spec/models/email_list_spec.rb
146
156
  - spec/models/domain_spec.rb
157
+ - spec/models/email_summary_spec.rb
147
158
  - spec/models/list_domains200_response_spec.rb
148
159
  - spec/models/email_spec.rb
160
+ - spec/models/list_meta_spec.rb
149
161
  - spec/models/auth_health_dmarc_spec.rb
150
162
  - spec/models/dns_record_spec.rb
151
163
  - spec/models/delete_domain200_response_spec.rb