sib-api-v3-sdk 9.0.0 → 9.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (49) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +0 -19
  3. data/docs/Body.md +1 -0
  4. data/docs/Body1.md +1 -0
  5. data/docs/Body10.md +2 -2
  6. data/docs/Body12.md +1 -1
  7. data/docs/Body8.md +2 -2
  8. data/docs/CreateEmailCampaign.md +2 -0
  9. data/docs/CreateEmailCampaignRecipients.md +1 -0
  10. data/docs/NoteData.md +1 -0
  11. data/docs/TransactionalEmailsApi.md +2 -2
  12. data/docs/UpdateEmailCampaign.md +2 -0
  13. data/docs/UpdateEmailCampaignRecipients.md +2 -1
  14. data/lib/sib-api-v3-sdk/api/contacts_api.rb +20 -0
  15. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +4 -0
  16. data/lib/sib-api-v3-sdk/api/inbound_parsing_api.rb +4 -0
  17. data/lib/sib-api-v3-sdk/api/process_api.rb +4 -0
  18. data/lib/sib-api-v3-sdk/api/reseller_api.rb +4 -0
  19. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +4 -0
  20. data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +27 -3
  21. data/lib/sib-api-v3-sdk/models/body.rb +14 -4
  22. data/lib/sib-api-v3-sdk/models/body_1.rb +14 -4
  23. data/lib/sib-api-v3-sdk/models/body_10.rb +2 -2
  24. data/lib/sib-api-v3-sdk/models/body_12.rb +1 -1
  25. data/lib/sib-api-v3-sdk/models/body_8.rb +2 -2
  26. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +24 -4
  27. data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +17 -5
  28. data/lib/sib-api-v3-sdk/models/note_data.rb +16 -4
  29. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +24 -4
  30. data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +18 -6
  31. data/lib/sib-api-v3-sdk/version.rb +1 -1
  32. data/lib/sib-api-v3-sdk.rb +0 -3
  33. data/spec/models/body_1_spec.rb +6 -0
  34. data/spec/models/body_spec.rb +6 -0
  35. data/spec/models/create_email_campaign_recipients_spec.rb +6 -0
  36. data/spec/models/create_email_campaign_spec.rb +12 -0
  37. data/spec/models/note_data_spec.rb +6 -0
  38. data/spec/models/update_email_campaign_recipients_spec.rb +6 -0
  39. data/spec/models/update_email_campaign_spec.rb +12 -0
  40. metadata +2 -14
  41. data/docs/AttributesApi.md +0 -246
  42. data/docs/FoldersApi.md +0 -372
  43. data/docs/ListsApi.md +0 -560
  44. data/lib/sib-api-v3-sdk/api/attributes_api.rb +0 -274
  45. data/lib/sib-api-v3-sdk/api/folders_api.rb +0 -383
  46. data/lib/sib-api-v3-sdk/api/lists_api.rb +0 -562
  47. data/spec/api/attributes_api_spec.rb +0 -83
  48. data/spec/api/folders_api_spec.rb +0 -107
  49. data/spec/api/lists_api_spec.rb +0 -146
@@ -13,7 +13,7 @@ Swagger Codegen version: 2.4.19
13
13
  require 'date'
14
14
 
15
15
  module SibApiV3Sdk
16
- # List ids to include/exclude from campaign
16
+ # Segment ids and List ids to include/exclude from campaign
17
17
  class CreateEmailCampaignRecipients
18
18
  # List ids to exclude from the campaign
19
19
  attr_accessor :exclusion_list_ids
@@ -21,11 +21,15 @@ module SibApiV3Sdk
21
21
  # Mandatory if scheduledAt is not empty. List Ids to send the campaign to
22
22
  attr_accessor :list_ids
23
23
 
24
+ # Mandatory if listIds are not used. Segment ids to send the campaign to.
25
+ attr_accessor :segment_ids
26
+
24
27
  # Attribute mapping from ruby-style variable name to JSON key.
25
28
  def self.attribute_map
26
29
  {
27
30
  :'exclusion_list_ids' => :'exclusionListIds',
28
- :'list_ids' => :'listIds'
31
+ :'list_ids' => :'listIds',
32
+ :'segment_ids' => :'segmentIds'
29
33
  }
30
34
  end
31
35
 
@@ -33,7 +37,8 @@ module SibApiV3Sdk
33
37
  def self.swagger_types
34
38
  {
35
39
  :'exclusion_list_ids' => :'Array<Integer>',
36
- :'list_ids' => :'Array<Integer>'
40
+ :'list_ids' => :'Array<Integer>',
41
+ :'segment_ids' => :'Array<Integer>'
37
42
  }
38
43
  end
39
44
 
@@ -56,6 +61,12 @@ module SibApiV3Sdk
56
61
  self.list_ids = value
57
62
  end
58
63
  end
64
+
65
+ if attributes.has_key?(:'segmentIds')
66
+ if (value = attributes[:'segmentIds']).is_a?(Array)
67
+ self.segment_ids = value
68
+ end
69
+ end
59
70
  end
60
71
 
61
72
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -77,7 +88,8 @@ module SibApiV3Sdk
77
88
  return true if self.equal?(o)
78
89
  self.class == o.class &&
79
90
  exclusion_list_ids == o.exclusion_list_ids &&
80
- list_ids == o.list_ids
91
+ list_ids == o.list_ids &&
92
+ segment_ids == o.segment_ids
81
93
  end
82
94
 
83
95
  # @see the `==` method
@@ -89,7 +101,7 @@ module SibApiV3Sdk
89
101
  # Calculates hash code according to all attributes.
90
102
  # @return [Fixnum] Hash code
91
103
  def hash
92
- [exclusion_list_ids, list_ids].hash
104
+ [exclusion_list_ids, list_ids, segment_ids].hash
93
105
  end
94
106
 
95
107
  # Builds the object from hash
@@ -24,12 +24,16 @@ module SibApiV3Sdk
24
24
  # Deal Ids linked to a note
25
25
  attr_accessor :deal_ids
26
26
 
27
+ # Company Ids linked to a note
28
+ attr_accessor :company_ids
29
+
27
30
  # Attribute mapping from ruby-style variable name to JSON key.
28
31
  def self.attribute_map
29
32
  {
30
33
  :'text' => :'text',
31
34
  :'contact_ids' => :'contactIds',
32
- :'deal_ids' => :'dealIds'
35
+ :'deal_ids' => :'dealIds',
36
+ :'company_ids' => :'companyIds'
33
37
  }
34
38
  end
35
39
 
@@ -38,7 +42,8 @@ module SibApiV3Sdk
38
42
  {
39
43
  :'text' => :'String',
40
44
  :'contact_ids' => :'Array<Integer>',
41
- :'deal_ids' => :'Array<String>'
45
+ :'deal_ids' => :'Array<String>',
46
+ :'company_ids' => :'Array<String>'
42
47
  }
43
48
  end
44
49
 
@@ -65,6 +70,12 @@ module SibApiV3Sdk
65
70
  self.deal_ids = value
66
71
  end
67
72
  end
73
+
74
+ if attributes.has_key?(:'companyIds')
75
+ if (value = attributes[:'companyIds']).is_a?(Array)
76
+ self.company_ids = value
77
+ end
78
+ end
68
79
  end
69
80
 
70
81
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -120,7 +131,8 @@ module SibApiV3Sdk
120
131
  self.class == o.class &&
121
132
  text == o.text &&
122
133
  contact_ids == o.contact_ids &&
123
- deal_ids == o.deal_ids
134
+ deal_ids == o.deal_ids &&
135
+ company_ids == o.company_ids
124
136
  end
125
137
 
126
138
  # @see the `==` method
@@ -132,7 +144,7 @@ module SibApiV3Sdk
132
144
  # Calculates hash code according to all attributes.
133
145
  # @return [Fixnum] Hash code
134
146
  def hash
135
- [text, contact_ids, deal_ids].hash
147
+ [text, contact_ids, deal_ids, company_ids].hash
136
148
  end
137
149
 
138
150
  # Builds the object from hash
@@ -96,6 +96,12 @@ module SibApiV3Sdk
96
96
  # Set a percentage increase rate for warming up your ip. We recommend you set the increase rate to 30% per day. If you want to send the same number of emails every day, set the daily increase value to 0%.
97
97
  attr_accessor :increase_rate
98
98
 
99
+ # Enter an unsubscription page id. The page id is a 24 digit alphanumeric id that can be found in the URL when editing the page.
100
+ attr_accessor :unsubscription_page_id
101
+
102
+ # Mandatory if templateId is used containing the {{ update_profile }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric id that can be found in the URL when editing the form.
103
+ attr_accessor :update_form_id
104
+
99
105
  class EnumAttributeValidator
100
106
  attr_reader :datatype
101
107
  attr_reader :allowable_values
@@ -148,7 +154,9 @@ module SibApiV3Sdk
148
154
  :'winner_delay' => :'winnerDelay',
149
155
  :'ip_warmup_enable' => :'ipWarmupEnable',
150
156
  :'initial_quota' => :'initialQuota',
151
- :'increase_rate' => :'increaseRate'
157
+ :'increase_rate' => :'increaseRate',
158
+ :'unsubscription_page_id' => :'unsubscriptionPageId',
159
+ :'update_form_id' => :'updateFormId'
152
160
  }
153
161
  end
154
162
 
@@ -182,7 +190,9 @@ module SibApiV3Sdk
182
190
  :'winner_delay' => :'Integer',
183
191
  :'ip_warmup_enable' => :'BOOLEAN',
184
192
  :'initial_quota' => :'Integer',
185
- :'increase_rate' => :'Integer'
193
+ :'increase_rate' => :'Integer',
194
+ :'unsubscription_page_id' => :'String',
195
+ :'update_form_id' => :'String'
186
196
  }
187
197
  end
188
198
 
@@ -313,6 +323,14 @@ module SibApiV3Sdk
313
323
  if attributes.has_key?(:'increaseRate')
314
324
  self.increase_rate = attributes[:'increaseRate']
315
325
  end
326
+
327
+ if attributes.has_key?(:'unsubscriptionPageId')
328
+ self.unsubscription_page_id = attributes[:'unsubscriptionPageId']
329
+ end
330
+
331
+ if attributes.has_key?(:'updateFormId')
332
+ self.update_form_id = attributes[:'updateFormId']
333
+ end
316
334
  end
317
335
 
318
336
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -444,7 +462,9 @@ module SibApiV3Sdk
444
462
  winner_delay == o.winner_delay &&
445
463
  ip_warmup_enable == o.ip_warmup_enable &&
446
464
  initial_quota == o.initial_quota &&
447
- increase_rate == o.increase_rate
465
+ increase_rate == o.increase_rate &&
466
+ unsubscription_page_id == o.unsubscription_page_id &&
467
+ update_form_id == o.update_form_id
448
468
  end
449
469
 
450
470
  # @see the `==` method
@@ -456,7 +476,7 @@ module SibApiV3Sdk
456
476
  # Calculates hash code according to all attributes.
457
477
  # @return [Fixnum] Hash code
458
478
  def hash
459
- [tag, sender, name, html_content, html_url, scheduled_at, subject, reply_to, to_field, recipients, attachment_url, inline_image_activation, mirror_active, recurring, footer, header, utm_campaign, params, send_at_best_time, ab_testing, subject_a, subject_b, split_rule, winner_criteria, winner_delay, ip_warmup_enable, initial_quota, increase_rate].hash
479
+ [tag, sender, name, html_content, html_url, scheduled_at, subject, reply_to, to_field, recipients, attachment_url, inline_image_activation, mirror_active, recurring, footer, header, utm_campaign, params, send_at_best_time, ab_testing, subject_a, subject_b, split_rule, winner_criteria, winner_delay, ip_warmup_enable, initial_quota, increase_rate, unsubscription_page_id, update_form_id].hash
460
480
  end
461
481
 
462
482
  # Builds the object from hash
@@ -13,19 +13,23 @@ Swagger Codegen version: 2.4.19
13
13
  require 'date'
14
14
 
15
15
  module SibApiV3Sdk
16
- # List ids to include/exclude from campaign
16
+ # Segment ids and List ids to include/exclude from campaign
17
17
  class UpdateEmailCampaignRecipients
18
18
  # List ids which have to be excluded from a campaign
19
19
  attr_accessor :exclusion_list_ids
20
20
 
21
- # Lists Ids to send the campaign to. REQUIRED if already not present in campaign and scheduledAt is not empty
21
+ # Lists Ids to send the campaign to. Campaign should only be updated with listIds if listIds were used to create it. REQUIRED if already not present in campaign and scheduledAt is not empty
22
22
  attr_accessor :list_ids
23
23
 
24
+ # Mandatory if listIds are not used. Campaign should only be updated with segmentIds if segmentIds were used to create it. Segment ids to send the campaign to.
25
+ attr_accessor :segment_ids
26
+
24
27
  # Attribute mapping from ruby-style variable name to JSON key.
25
28
  def self.attribute_map
26
29
  {
27
30
  :'exclusion_list_ids' => :'exclusionListIds',
28
- :'list_ids' => :'listIds'
31
+ :'list_ids' => :'listIds',
32
+ :'segment_ids' => :'segmentIds'
29
33
  }
30
34
  end
31
35
 
@@ -33,7 +37,8 @@ module SibApiV3Sdk
33
37
  def self.swagger_types
34
38
  {
35
39
  :'exclusion_list_ids' => :'Array<Integer>',
36
- :'list_ids' => :'Array<Integer>'
40
+ :'list_ids' => :'Array<Integer>',
41
+ :'segment_ids' => :'Array<Integer>'
37
42
  }
38
43
  end
39
44
 
@@ -56,6 +61,12 @@ module SibApiV3Sdk
56
61
  self.list_ids = value
57
62
  end
58
63
  end
64
+
65
+ if attributes.has_key?(:'segmentIds')
66
+ if (value = attributes[:'segmentIds']).is_a?(Array)
67
+ self.segment_ids = value
68
+ end
69
+ end
59
70
  end
60
71
 
61
72
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -77,7 +88,8 @@ module SibApiV3Sdk
77
88
  return true if self.equal?(o)
78
89
  self.class == o.class &&
79
90
  exclusion_list_ids == o.exclusion_list_ids &&
80
- list_ids == o.list_ids
91
+ list_ids == o.list_ids &&
92
+ segment_ids == o.segment_ids
81
93
  end
82
94
 
83
95
  # @see the `==` method
@@ -89,7 +101,7 @@ module SibApiV3Sdk
89
101
  # Calculates hash code according to all attributes.
90
102
  # @return [Fixnum] Hash code
91
103
  def hash
92
- [exclusion_list_ids, list_ids].hash
104
+ [exclusion_list_ids, list_ids, segment_ids].hash
93
105
  end
94
106
 
95
107
  # Builds the object from hash
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.19
11
11
  =end
12
12
 
13
13
  module SibApiV3Sdk
14
- VERSION = "9.0.0"
14
+ VERSION = "9.1.0"
15
15
  end
@@ -276,16 +276,13 @@ require 'sib-api-v3-sdk/models/upload_image_to_gallery'
276
276
 
277
277
  # APIs
278
278
  require 'sib-api-v3-sdk/api/account_api'
279
- require 'sib-api-v3-sdk/api/attributes_api'
280
279
  require 'sib-api-v3-sdk/api/companies_api'
281
280
  require 'sib-api-v3-sdk/api/contacts_api'
282
281
  require 'sib-api-v3-sdk/api/conversations_api'
283
282
  require 'sib-api-v3-sdk/api/deals_api'
284
283
  require 'sib-api-v3-sdk/api/email_campaigns_api'
285
284
  require 'sib-api-v3-sdk/api/files_api'
286
- require 'sib-api-v3-sdk/api/folders_api'
287
285
  require 'sib-api-v3-sdk/api/inbound_parsing_api'
288
- require 'sib-api-v3-sdk/api/lists_api'
289
286
  require 'sib-api-v3-sdk/api/master_account_api'
290
287
  require 'sib-api-v3-sdk/api/notes_api'
291
288
  require 'sib-api-v3-sdk/api/process_api'
@@ -44,4 +44,10 @@ describe 'Body1' do
44
44
  end
45
45
  end
46
46
 
47
+ describe 'test attribute "country_code"' do
48
+ it 'should work' do
49
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
+ end
51
+ end
52
+
47
53
  end
@@ -44,4 +44,10 @@ describe 'Body' do
44
44
  end
45
45
  end
46
46
 
47
+ describe 'test attribute "country_code"' do
48
+ it 'should work' do
49
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
+ end
51
+ end
52
+
47
53
  end
@@ -44,4 +44,10 @@ describe 'CreateEmailCampaignRecipients' do
44
44
  end
45
45
  end
46
46
 
47
+ describe 'test attribute "segment_ids"' do
48
+ it 'should work' do
49
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
+ end
51
+ end
52
+
47
53
  end
@@ -204,4 +204,16 @@ describe 'CreateEmailCampaign' do
204
204
  end
205
205
  end
206
206
 
207
+ describe 'test attribute "unsubscription_page_id"' do
208
+ it 'should work' do
209
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
210
+ end
211
+ end
212
+
213
+ describe 'test attribute "update_form_id"' do
214
+ it 'should work' do
215
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
216
+ end
217
+ end
218
+
207
219
  end
@@ -50,4 +50,10 @@ describe 'NoteData' do
50
50
  end
51
51
  end
52
52
 
53
+ describe 'test attribute "company_ids"' do
54
+ it 'should work' do
55
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
+ end
57
+ end
58
+
53
59
  end
@@ -44,4 +44,10 @@ describe 'UpdateEmailCampaignRecipients' do
44
44
  end
45
45
  end
46
46
 
47
+ describe 'test attribute "segment_ids"' do
48
+ it 'should work' do
49
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
+ end
51
+ end
52
+
47
53
  end
@@ -204,4 +204,16 @@ describe 'UpdateEmailCampaign' do
204
204
  end
205
205
  end
206
206
 
207
+ describe 'test attribute "unsubscription_page_id"' do
208
+ it 'should work' do
209
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
210
+ end
211
+ end
212
+
213
+ describe 'test attribute "update_form_id"' do
214
+ it 'should work' do
215
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
216
+ end
217
+ end
218
+
207
219
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: sib-api-v3-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 9.0.0
4
+ version: 9.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - SendinBlue Developers
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-08-18 00:00:00.000000000 Z
11
+ date: 2022-12-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -231,7 +231,6 @@ files:
231
231
  - docs/AddChildDomain.md
232
232
  - docs/AddContactToList.md
233
233
  - docs/AddCredits.md
234
- - docs/AttributesApi.md
235
234
  - docs/BlockDomain.md
236
235
  - docs/Body.md
237
236
  - docs/Body1.md
@@ -294,7 +293,6 @@ files:
294
293
  - docs/FileDownloadableLink.md
295
294
  - docs/FileList.md
296
295
  - docs/FilesApi.md
297
- - docs/FoldersApi.md
298
296
  - docs/GetAccount.md
299
297
  - docs/GetAccountMarketingAutomation.md
300
298
  - docs/GetAccountPlan.md
@@ -404,7 +402,6 @@ files:
404
402
  - docs/InlineResponse200.md
405
403
  - docs/InlineResponse201.md
406
404
  - docs/InlineResponse2011.md
407
- - docs/ListsApi.md
408
405
  - docs/ManageIp.md
409
406
  - docs/MasterAccountApi.md
410
407
  - docs/MasterDetailsResponse.md
@@ -500,16 +497,13 @@ files:
500
497
  - docs/WebhooksApi.md
501
498
  - lib/sib-api-v3-sdk.rb
502
499
  - lib/sib-api-v3-sdk/api/account_api.rb
503
- - lib/sib-api-v3-sdk/api/attributes_api.rb
504
500
  - lib/sib-api-v3-sdk/api/companies_api.rb
505
501
  - lib/sib-api-v3-sdk/api/contacts_api.rb
506
502
  - lib/sib-api-v3-sdk/api/conversations_api.rb
507
503
  - lib/sib-api-v3-sdk/api/deals_api.rb
508
504
  - lib/sib-api-v3-sdk/api/email_campaigns_api.rb
509
505
  - lib/sib-api-v3-sdk/api/files_api.rb
510
- - lib/sib-api-v3-sdk/api/folders_api.rb
511
506
  - lib/sib-api-v3-sdk/api/inbound_parsing_api.rb
512
- - lib/sib-api-v3-sdk/api/lists_api.rb
513
507
  - lib/sib-api-v3-sdk/api/master_account_api.rb
514
508
  - lib/sib-api-v3-sdk/api/notes_api.rb
515
509
  - lib/sib-api-v3-sdk/api/process_api.rb
@@ -782,16 +776,13 @@ files:
782
776
  - lib/sib-api-v3-sdk/version.rb
783
777
  - sib-api-v3-sdk.gemspec
784
778
  - spec/api/account_api_spec.rb
785
- - spec/api/attributes_api_spec.rb
786
779
  - spec/api/companies_api_spec.rb
787
780
  - spec/api/contacts_api_spec.rb
788
781
  - spec/api/conversations_api_spec.rb
789
782
  - spec/api/deals_api_spec.rb
790
783
  - spec/api/email_campaigns_api_spec.rb
791
784
  - spec/api/files_api_spec.rb
792
- - spec/api/folders_api_spec.rb
793
785
  - spec/api/inbound_parsing_api_spec.rb
794
- - spec/api/lists_api_spec.rb
795
786
  - spec/api/master_account_api_spec.rb
796
787
  - spec/api/notes_api_spec.rb
797
788
  - spec/api/process_api_spec.rb
@@ -1097,9 +1088,6 @@ test_files:
1097
1088
  - spec/api/files_api_spec.rb
1098
1089
  - spec/api/senders_api_spec.rb
1099
1090
  - spec/api/account_api_spec.rb
1100
- - spec/api/attributes_api_spec.rb
1101
- - spec/api/lists_api_spec.rb
1102
- - spec/api/folders_api_spec.rb
1103
1091
  - spec/api/conversations_api_spec.rb
1104
1092
  - spec/api/notes_api_spec.rb
1105
1093
  - spec/api/reseller_api_spec.rb