sib-api-v3-sdk 9.0.0 → 9.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.
- checksums.yaml +4 -4
- data/README.md +0 -19
- data/docs/Body.md +1 -0
- data/docs/Body1.md +1 -0
- data/docs/Body10.md +2 -2
- data/docs/Body12.md +1 -1
- data/docs/Body8.md +2 -2
- data/docs/CreateEmailCampaign.md +2 -0
- data/docs/CreateEmailCampaignRecipients.md +1 -0
- data/docs/NoteData.md +1 -0
- data/docs/TransactionalEmailsApi.md +2 -2
- data/docs/UpdateEmailCampaign.md +2 -0
- data/docs/UpdateEmailCampaignRecipients.md +2 -1
- data/lib/sib-api-v3-sdk/api/contacts_api.rb +20 -0
- data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +4 -0
- data/lib/sib-api-v3-sdk/api/inbound_parsing_api.rb +4 -0
- data/lib/sib-api-v3-sdk/api/process_api.rb +4 -0
- data/lib/sib-api-v3-sdk/api/reseller_api.rb +4 -0
- data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +4 -0
- data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +27 -3
- data/lib/sib-api-v3-sdk/models/body.rb +14 -4
- data/lib/sib-api-v3-sdk/models/body_1.rb +14 -4
- data/lib/sib-api-v3-sdk/models/body_10.rb +2 -2
- data/lib/sib-api-v3-sdk/models/body_12.rb +1 -1
- data/lib/sib-api-v3-sdk/models/body_8.rb +2 -2
- data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +24 -4
- data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +17 -5
- data/lib/sib-api-v3-sdk/models/note_data.rb +16 -4
- data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +24 -4
- data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +18 -6
- data/lib/sib-api-v3-sdk/version.rb +1 -1
- data/lib/sib-api-v3-sdk.rb +0 -3
- data/spec/models/body_1_spec.rb +6 -0
- data/spec/models/body_spec.rb +6 -0
- data/spec/models/create_email_campaign_recipients_spec.rb +6 -0
- data/spec/models/create_email_campaign_spec.rb +12 -0
- data/spec/models/note_data_spec.rb +6 -0
- data/spec/models/update_email_campaign_recipients_spec.rb +6 -0
- data/spec/models/update_email_campaign_spec.rb +12 -0
- metadata +2 -14
- data/docs/AttributesApi.md +0 -246
- data/docs/FoldersApi.md +0 -372
- data/docs/ListsApi.md +0 -560
- data/lib/sib-api-v3-sdk/api/attributes_api.rb +0 -274
- data/lib/sib-api-v3-sdk/api/folders_api.rb +0 -383
- data/lib/sib-api-v3-sdk/api/lists_api.rb +0 -562
- data/spec/api/attributes_api_spec.rb +0 -83
- data/spec/api/folders_api_spec.rb +0 -107
- data/spec/api/lists_api_spec.rb +0 -146
@@ -1,107 +0,0 @@
|
|
1
|
-
=begin
|
2
|
-
#SendinBlue API
|
3
|
-
|
4
|
-
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
5
|
-
|
6
|
-
OpenAPI spec version: 3.0.0
|
7
|
-
Contact: contact@sendinblue.com
|
8
|
-
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.4.19
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require 'spec_helper'
|
14
|
-
require 'json'
|
15
|
-
|
16
|
-
# Unit tests for SibApiV3Sdk::FoldersApi
|
17
|
-
# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
|
18
|
-
# Please update as you see appropriate
|
19
|
-
describe 'FoldersApi' do
|
20
|
-
before do
|
21
|
-
# run before each test
|
22
|
-
@instance = SibApiV3Sdk::FoldersApi.new
|
23
|
-
end
|
24
|
-
|
25
|
-
after do
|
26
|
-
# run after each test
|
27
|
-
end
|
28
|
-
|
29
|
-
describe 'test an instance of FoldersApi' do
|
30
|
-
it 'should create an instance of FoldersApi' do
|
31
|
-
expect(@instance).to be_instance_of(SibApiV3Sdk::FoldersApi)
|
32
|
-
end
|
33
|
-
end
|
34
|
-
|
35
|
-
# unit tests for create_folder
|
36
|
-
# Create a folder
|
37
|
-
# @param create_folder Name of the folder
|
38
|
-
# @param [Hash] opts the optional parameters
|
39
|
-
# @return [CreateModel]
|
40
|
-
describe 'create_folder test' do
|
41
|
-
it 'should work' do
|
42
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
43
|
-
end
|
44
|
-
end
|
45
|
-
|
46
|
-
# unit tests for delete_folder
|
47
|
-
# Delete a folder (and all its lists)
|
48
|
-
# @param folder_id Id of the folder
|
49
|
-
# @param [Hash] opts the optional parameters
|
50
|
-
# @return [nil]
|
51
|
-
describe 'delete_folder test' do
|
52
|
-
it 'should work' do
|
53
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
54
|
-
end
|
55
|
-
end
|
56
|
-
|
57
|
-
# unit tests for get_folder
|
58
|
-
# Returns a folder's details
|
59
|
-
# @param folder_id id of the folder
|
60
|
-
# @param [Hash] opts the optional parameters
|
61
|
-
# @return [GetFolder]
|
62
|
-
describe 'get_folder test' do
|
63
|
-
it 'should work' do
|
64
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
65
|
-
end
|
66
|
-
end
|
67
|
-
|
68
|
-
# unit tests for get_folder_lists
|
69
|
-
# Get lists in a folder
|
70
|
-
# @param folder_id Id of the folder
|
71
|
-
# @param [Hash] opts the optional parameters
|
72
|
-
# @option opts [Integer] :limit Number of documents per page
|
73
|
-
# @option opts [Integer] :offset Index of the first document of the page
|
74
|
-
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
75
|
-
# @return [GetFolderLists]
|
76
|
-
describe 'get_folder_lists test' do
|
77
|
-
it 'should work' do
|
78
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
79
|
-
end
|
80
|
-
end
|
81
|
-
|
82
|
-
# unit tests for get_folders
|
83
|
-
# Get all folders
|
84
|
-
# @param limit Number of documents per page
|
85
|
-
# @param offset Index of the first document of the page
|
86
|
-
# @param [Hash] opts the optional parameters
|
87
|
-
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
88
|
-
# @return [GetFolders]
|
89
|
-
describe 'get_folders test' do
|
90
|
-
it 'should work' do
|
91
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
92
|
-
end
|
93
|
-
end
|
94
|
-
|
95
|
-
# unit tests for update_folder
|
96
|
-
# Update a folder
|
97
|
-
# @param folder_id Id of the folder
|
98
|
-
# @param update_folder Name of the folder
|
99
|
-
# @param [Hash] opts the optional parameters
|
100
|
-
# @return [nil]
|
101
|
-
describe 'update_folder test' do
|
102
|
-
it 'should work' do
|
103
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
104
|
-
end
|
105
|
-
end
|
106
|
-
|
107
|
-
end
|
data/spec/api/lists_api_spec.rb
DELETED
@@ -1,146 +0,0 @@
|
|
1
|
-
=begin
|
2
|
-
#SendinBlue API
|
3
|
-
|
4
|
-
#SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
5
|
-
|
6
|
-
OpenAPI spec version: 3.0.0
|
7
|
-
Contact: contact@sendinblue.com
|
8
|
-
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
-
Swagger Codegen version: 2.4.19
|
10
|
-
|
11
|
-
=end
|
12
|
-
|
13
|
-
require 'spec_helper'
|
14
|
-
require 'json'
|
15
|
-
|
16
|
-
# Unit tests for SibApiV3Sdk::ListsApi
|
17
|
-
# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
|
18
|
-
# Please update as you see appropriate
|
19
|
-
describe 'ListsApi' do
|
20
|
-
before do
|
21
|
-
# run before each test
|
22
|
-
@instance = SibApiV3Sdk::ListsApi.new
|
23
|
-
end
|
24
|
-
|
25
|
-
after do
|
26
|
-
# run after each test
|
27
|
-
end
|
28
|
-
|
29
|
-
describe 'test an instance of ListsApi' do
|
30
|
-
it 'should create an instance of ListsApi' do
|
31
|
-
expect(@instance).to be_instance_of(SibApiV3Sdk::ListsApi)
|
32
|
-
end
|
33
|
-
end
|
34
|
-
|
35
|
-
# unit tests for add_contact_to_list
|
36
|
-
# Add existing contacts to a list
|
37
|
-
# @param list_id Id of the list
|
38
|
-
# @param contact_emails Emails addresses OR IDs of the contacts
|
39
|
-
# @param [Hash] opts the optional parameters
|
40
|
-
# @return [PostContactInfo]
|
41
|
-
describe 'add_contact_to_list test' do
|
42
|
-
it 'should work' do
|
43
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
44
|
-
end
|
45
|
-
end
|
46
|
-
|
47
|
-
# unit tests for create_list
|
48
|
-
# Create a list
|
49
|
-
# @param create_list Values to create a list
|
50
|
-
# @param [Hash] opts the optional parameters
|
51
|
-
# @return [CreateModel]
|
52
|
-
describe 'create_list test' do
|
53
|
-
it 'should work' do
|
54
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
55
|
-
end
|
56
|
-
end
|
57
|
-
|
58
|
-
# unit tests for delete_list
|
59
|
-
# Delete a list
|
60
|
-
# @param list_id Id of the list
|
61
|
-
# @param [Hash] opts the optional parameters
|
62
|
-
# @return [nil]
|
63
|
-
describe 'delete_list test' do
|
64
|
-
it 'should work' do
|
65
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
66
|
-
end
|
67
|
-
end
|
68
|
-
|
69
|
-
# unit tests for get_contacts_from_list
|
70
|
-
# Get contacts in a list
|
71
|
-
# @param list_id Id of the list
|
72
|
-
# @param [Hash] opts the optional parameters
|
73
|
-
# @option opts [String] :modified_since Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time format for accurate result.
|
74
|
-
# @option opts [Integer] :limit Number of documents per page
|
75
|
-
# @option opts [Integer] :offset Index of the first document of the page
|
76
|
-
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
77
|
-
# @return [GetContacts]
|
78
|
-
describe 'get_contacts_from_list test' do
|
79
|
-
it 'should work' do
|
80
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
81
|
-
end
|
82
|
-
end
|
83
|
-
|
84
|
-
# unit tests for get_folder_lists
|
85
|
-
# Get lists in a folder
|
86
|
-
# @param folder_id Id of the folder
|
87
|
-
# @param [Hash] opts the optional parameters
|
88
|
-
# @option opts [Integer] :limit Number of documents per page
|
89
|
-
# @option opts [Integer] :offset Index of the first document of the page
|
90
|
-
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
91
|
-
# @return [GetFolderLists]
|
92
|
-
describe 'get_folder_lists test' do
|
93
|
-
it 'should work' do
|
94
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
95
|
-
end
|
96
|
-
end
|
97
|
-
|
98
|
-
# unit tests for get_list
|
99
|
-
# Get a list's details
|
100
|
-
# @param list_id Id of the list
|
101
|
-
# @param [Hash] opts the optional parameters
|
102
|
-
# @return [GetExtendedList]
|
103
|
-
describe 'get_list test' do
|
104
|
-
it 'should work' do
|
105
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
106
|
-
end
|
107
|
-
end
|
108
|
-
|
109
|
-
# unit tests for get_lists
|
110
|
-
# Get all the lists
|
111
|
-
# @param [Hash] opts the optional parameters
|
112
|
-
# @option opts [Integer] :limit Number of documents per page
|
113
|
-
# @option opts [Integer] :offset Index of the first document of the page
|
114
|
-
# @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
|
115
|
-
# @return [GetLists]
|
116
|
-
describe 'get_lists test' do
|
117
|
-
it 'should work' do
|
118
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
119
|
-
end
|
120
|
-
end
|
121
|
-
|
122
|
-
# unit tests for remove_contact_from_list
|
123
|
-
# Delete a contact from a list
|
124
|
-
# @param list_id Id of the list
|
125
|
-
# @param contact_emails Emails addresses OR IDs of the contacts
|
126
|
-
# @param [Hash] opts the optional parameters
|
127
|
-
# @return [PostContactInfo]
|
128
|
-
describe 'remove_contact_from_list test' do
|
129
|
-
it 'should work' do
|
130
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
131
|
-
end
|
132
|
-
end
|
133
|
-
|
134
|
-
# unit tests for update_list
|
135
|
-
# Update a list
|
136
|
-
# @param list_id Id of the list
|
137
|
-
# @param update_list Values to update a list
|
138
|
-
# @param [Hash] opts the optional parameters
|
139
|
-
# @return [nil]
|
140
|
-
describe 'update_list test' do
|
141
|
-
it 'should work' do
|
142
|
-
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
143
|
-
end
|
144
|
-
end
|
145
|
-
|
146
|
-
end
|