sib-api-v3-sdk 8.1.0 → 9.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (216) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +82 -33
  3. data/docs/Body.md +3 -11
  4. data/docs/Body1.md +3 -11
  5. data/docs/Body10.md +11 -0
  6. data/docs/Body11.md +8 -0
  7. data/docs/Body12.md +11 -0
  8. data/docs/Body2.md +11 -0
  9. data/docs/Body3.md +9 -0
  10. data/docs/Body4.md +9 -0
  11. data/docs/Body5.md +11 -0
  12. data/docs/Body6.md +18 -0
  13. data/docs/Body7.md +17 -0
  14. data/docs/Body8.md +13 -0
  15. data/docs/Body9.md +8 -0
  16. data/docs/CompaniesApi.md +425 -0
  17. data/docs/CompaniesList.md +8 -0
  18. data/docs/Company.md +11 -0
  19. data/docs/CompanyAttributes.md +7 -0
  20. data/docs/CompanyAttributesInner.md +12 -0
  21. data/docs/ContactsApi.md +8 -2
  22. data/docs/{ListsApi.md → ConversationsApi.md} +115 -133
  23. data/docs/ConversationsMessage.md +17 -0
  24. data/docs/ConversationsMessageFile.md +12 -0
  25. data/docs/ConversationsMessageFileImageInfo.md +10 -0
  26. data/docs/CreateContact.md +1 -1
  27. data/docs/CreateEmailCampaign.md +2 -0
  28. data/docs/CreateEmailCampaignRecipients.md +1 -0
  29. data/docs/CreateSubAccount.md +3 -3
  30. data/docs/CreateSubAccountResponse.md +8 -0
  31. data/docs/Deal.md +11 -0
  32. data/docs/DealAttributes.md +7 -0
  33. data/docs/DealAttributesInner.md +12 -0
  34. data/docs/DealsApi.md +476 -0
  35. data/docs/DealsList.md +8 -0
  36. data/docs/EmailCampaignsApi.md +6 -5
  37. data/docs/FileData.md +3 -6
  38. data/docs/FileDownloadableLink.md +8 -0
  39. data/docs/FileList.md +7 -0
  40. data/docs/FilesApi.md +318 -0
  41. data/docs/GetCampaignStats.md +2 -0
  42. data/docs/GetScheduledEmailByBatchId.md +9 -0
  43. data/docs/GetScheduledEmailByBatchIdBatches.md +10 -0
  44. data/docs/GetScheduledEmailByMessageId.md +10 -0
  45. data/docs/GetSsoToken.md +1 -1
  46. data/docs/InboundParsingApi.md +60 -0
  47. data/docs/InlineResponse200.md +8 -0
  48. data/docs/InlineResponse201.md +8 -0
  49. data/docs/InlineResponse2011.md +8 -0
  50. data/docs/MasterAccountApi.md +6 -6
  51. data/docs/NoteData.md +1 -0
  52. data/docs/NoteId.md +8 -0
  53. data/docs/NoteList.md +7 -0
  54. data/docs/NotesApi.md +312 -0
  55. data/docs/Pipeline.md +8 -0
  56. data/docs/PipelineStage.md +9 -0
  57. data/docs/ScheduleSmtpEmail.md +10 -0
  58. data/docs/SendSmtpEmail.md +3 -1
  59. data/docs/SubAccountDetailsResponsePlanInfoCredits.md +1 -1
  60. data/docs/SubAccountsResponseSubAccounts.md +4 -4
  61. data/docs/Task.md +0 -11
  62. data/docs/TaskList.md +8 -0
  63. data/docs/TaskReminder.md +1 -1
  64. data/docs/TaskTypes.md +0 -1
  65. data/docs/{FoldersApi.md → TasksApi.md} +95 -91
  66. data/docs/TransactionalEmailsApi.md +201 -2
  67. data/docs/UpdateContact.md +1 -1
  68. data/docs/UpdateEmailCampaign.md +3 -1
  69. data/docs/UpdateEmailCampaignRecipients.md +2 -1
  70. data/docs/UpdateSmtpTemplate.md +1 -1
  71. data/docs/UploadImageModel.md +8 -0
  72. data/lib/sib-api-v3-sdk/api/companies_api.rb +409 -0
  73. data/lib/sib-api-v3-sdk/api/contacts_api.rb +26 -0
  74. data/lib/sib-api-v3-sdk/api/conversations_api.rb +504 -0
  75. data/lib/sib-api-v3-sdk/api/deals_api.rb +454 -0
  76. data/lib/sib-api-v3-sdk/api/email_campaigns_api.rb +13 -8
  77. data/lib/sib-api-v3-sdk/api/files_api.rb +313 -0
  78. data/lib/sib-api-v3-sdk/api/inbound_parsing_api.rb +57 -1
  79. data/lib/sib-api-v3-sdk/api/master_account_api.rb +9 -9
  80. data/lib/sib-api-v3-sdk/api/notes_api.rb +308 -0
  81. data/lib/sib-api-v3-sdk/api/process_api.rb +4 -0
  82. data/lib/sib-api-v3-sdk/api/reseller_api.rb +4 -0
  83. data/lib/sib-api-v3-sdk/api/sms_campaigns_api.rb +4 -0
  84. data/lib/sib-api-v3-sdk/api/tasks_api.rb +375 -0
  85. data/lib/sib-api-v3-sdk/api/transactional_emails_api.rb +222 -3
  86. data/lib/sib-api-v3-sdk/models/body.rb +16 -111
  87. data/lib/sib-api-v3-sdk/models/body_1.rb +16 -116
  88. data/lib/sib-api-v3-sdk/models/body_10.rb +225 -0
  89. data/lib/sib-api-v3-sdk/models/body_11.rb +190 -0
  90. data/lib/sib-api-v3-sdk/models/body_12.rb +215 -0
  91. data/lib/sib-api-v3-sdk/models/body_2.rb +223 -0
  92. data/lib/sib-api-v3-sdk/models/body_3.rb +200 -0
  93. data/lib/sib-api-v3-sdk/models/body_4.rb +195 -0
  94. data/lib/sib-api-v3-sdk/models/body_5.rb +223 -0
  95. data/lib/sib-api-v3-sdk/models/body_6.rb +320 -0
  96. data/lib/sib-api-v3-sdk/models/body_7.rb +281 -0
  97. data/lib/sib-api-v3-sdk/models/body_8.rb +245 -0
  98. data/lib/sib-api-v3-sdk/models/body_9.rb +190 -0
  99. data/lib/sib-api-v3-sdk/models/companies_list.rb +188 -0
  100. data/lib/sib-api-v3-sdk/models/company.rb +220 -0
  101. data/lib/sib-api-v3-sdk/models/company_attributes.rb +176 -0
  102. data/lib/sib-api-v3-sdk/models/company_attributes_inner.rb +223 -0
  103. data/lib/sib-api-v3-sdk/models/conversations_message.rb +324 -0
  104. data/lib/sib-api-v3-sdk/models/conversations_message_file.rb +239 -0
  105. data/lib/sib-api-v3-sdk/models/conversations_message_file_image_info.rb +236 -0
  106. data/lib/sib-api-v3-sdk/models/create_contact.rb +1 -1
  107. data/lib/sib-api-v3-sdk/models/create_email_campaign.rb +24 -4
  108. data/lib/sib-api-v3-sdk/models/create_email_campaign_recipients.rb +17 -5
  109. data/lib/sib-api-v3-sdk/models/create_sub_account.rb +3 -3
  110. data/lib/sib-api-v3-sdk/models/create_sub_account_response.rb +190 -0
  111. data/lib/sib-api-v3-sdk/models/deal.rb +220 -0
  112. data/lib/sib-api-v3-sdk/models/deal_attributes.rb +176 -0
  113. data/lib/sib-api-v3-sdk/models/deal_attributes_inner.rb +223 -0
  114. data/lib/sib-api-v3-sdk/models/deals_list.rb +188 -0
  115. data/lib/sib-api-v3-sdk/models/file_data.rb +22 -54
  116. data/lib/sib-api-v3-sdk/models/file_downloadable_link.rb +190 -0
  117. data/lib/sib-api-v3-sdk/models/file_list.rb +176 -0
  118. data/lib/sib-api-v3-sdk/models/get_campaign_stats.rb +21 -1
  119. data/lib/sib-api-v3-sdk/models/get_scheduled_email_by_batch_id.rb +196 -0
  120. data/lib/sib-api-v3-sdk/models/{contact.rb → get_scheduled_email_by_batch_id_batches.rb} +62 -74
  121. data/lib/sib-api-v3-sdk/models/get_scheduled_email_by_message_id.rb +254 -0
  122. data/lib/sib-api-v3-sdk/models/get_sso_token.rb +1 -1
  123. data/lib/sib-api-v3-sdk/models/inline_response_200.rb +191 -0
  124. data/lib/sib-api-v3-sdk/models/inline_response_201.rb +191 -0
  125. data/lib/sib-api-v3-sdk/models/inline_response_201_1.rb +191 -0
  126. data/lib/sib-api-v3-sdk/models/note_data.rb +16 -4
  127. data/lib/sib-api-v3-sdk/models/note_id.rb +186 -0
  128. data/lib/sib-api-v3-sdk/models/note_list.rb +176 -0
  129. data/lib/sib-api-v3-sdk/models/pipeline.rb +188 -0
  130. data/lib/sib-api-v3-sdk/models/pipeline_stage.rb +196 -0
  131. data/lib/sib-api-v3-sdk/models/schedule_smtp_email.rb +206 -0
  132. data/lib/sib-api-v3-sdk/models/send_smtp_email.rb +24 -4
  133. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_credits.rb +2 -2
  134. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_credits_emails.rb +1 -1
  135. data/lib/sib-api-v3-sdk/models/sub_account_details_response_plan_info_features.rb +1 -1
  136. data/lib/sib-api-v3-sdk/models/sub_accounts_response_sub_accounts.rb +4 -4
  137. data/lib/sib-api-v3-sdk/models/task.rb +4 -119
  138. data/lib/sib-api-v3-sdk/models/task_list.rb +188 -0
  139. data/lib/sib-api-v3-sdk/models/task_reminder.rb +1 -1
  140. data/lib/sib-api-v3-sdk/models/task_types.rb +1 -11
  141. data/lib/sib-api-v3-sdk/models/update_contact.rb +1 -1
  142. data/lib/sib-api-v3-sdk/models/update_email_campaign.rb +25 -5
  143. data/lib/sib-api-v3-sdk/models/update_email_campaign_recipients.rb +18 -6
  144. data/lib/sib-api-v3-sdk/models/update_smtp_template.rb +1 -1
  145. data/lib/sib-api-v3-sdk/models/upload_image_model.rb +190 -0
  146. data/lib/sib-api-v3-sdk/version.rb +1 -1
  147. data/lib/sib-api-v3-sdk.rb +44 -5
  148. data/spec/api/companies_api_spec.rb +119 -0
  149. data/spec/api/contacts_api_spec.rb +2 -0
  150. data/spec/api/{crm_api_spec.rb → conversations_api_spec.rb} +54 -94
  151. data/spec/api/{lists_api_spec.rb → deals_api_spec.rb} +51 -68
  152. data/spec/api/email_campaigns_api_spec.rb +1 -1
  153. data/spec/api/files_api_spec.rb +99 -0
  154. data/spec/api/inbound_parsing_api_spec.rb +12 -0
  155. data/spec/api/master_account_api_spec.rb +4 -4
  156. data/spec/api/notes_api_spec.rb +97 -0
  157. data/spec/api/{folders_api_spec.rb → tasks_api_spec.rb} +47 -41
  158. data/spec/api/transactional_emails_api_spec.rb +44 -0
  159. data/spec/models/body_10_spec.rb +59 -0
  160. data/spec/models/body_11_spec.rb +41 -0
  161. data/spec/models/body_12_spec.rb +59 -0
  162. data/spec/models/body_1_spec.rb +2 -50
  163. data/spec/models/body_2_spec.rb +59 -0
  164. data/spec/models/body_3_spec.rb +47 -0
  165. data/spec/models/body_4_spec.rb +47 -0
  166. data/spec/models/body_5_spec.rb +59 -0
  167. data/spec/models/body_6_spec.rb +101 -0
  168. data/spec/models/{contact_spec.rb → body_7_spec.rb} +26 -14
  169. data/spec/{api/attributes_api_spec.rb → models/body_8_spec.rb} +22 -34
  170. data/spec/models/body_9_spec.rb +41 -0
  171. data/spec/models/body_spec.rb +2 -50
  172. data/spec/models/companies_list_spec.rb +41 -0
  173. data/spec/models/company_attributes_inner_spec.rb +65 -0
  174. data/spec/models/company_attributes_spec.rb +35 -0
  175. data/spec/models/company_spec.rb +59 -0
  176. data/spec/models/conversations_message_file_image_info_spec.rb +53 -0
  177. data/spec/models/conversations_message_file_spec.rb +65 -0
  178. data/spec/models/conversations_message_spec.rb +99 -0
  179. data/spec/models/create_email_campaign_recipients_spec.rb +6 -0
  180. data/spec/models/create_email_campaign_spec.rb +12 -0
  181. data/spec/models/create_sub_account_response_spec.rb +41 -0
  182. data/spec/models/deal_attributes_inner_spec.rb +65 -0
  183. data/spec/models/deal_attributes_spec.rb +35 -0
  184. data/spec/models/deal_spec.rb +59 -0
  185. data/spec/models/deals_list_spec.rb +41 -0
  186. data/spec/models/file_data_spec.rb +3 -21
  187. data/spec/models/file_downloadable_link_spec.rb +41 -0
  188. data/spec/models/file_list_spec.rb +35 -0
  189. data/spec/models/get_campaign_stats_spec.rb +12 -0
  190. data/spec/models/get_scheduled_email_by_batch_id_batches_spec.rb +57 -0
  191. data/spec/models/get_scheduled_email_by_batch_id_spec.rb +47 -0
  192. data/spec/models/get_scheduled_email_by_message_id_spec.rb +57 -0
  193. data/spec/models/inline_response_200_spec.rb +41 -0
  194. data/spec/models/inline_response_201_1_spec.rb +41 -0
  195. data/spec/models/inline_response_201_spec.rb +41 -0
  196. data/spec/models/note_data_spec.rb +6 -0
  197. data/spec/models/note_id_spec.rb +41 -0
  198. data/spec/models/note_list_spec.rb +35 -0
  199. data/spec/models/pipeline_spec.rb +41 -0
  200. data/spec/models/pipeline_stage_spec.rb +47 -0
  201. data/spec/models/schedule_smtp_email_spec.rb +53 -0
  202. data/spec/models/send_smtp_email_spec.rb +12 -0
  203. data/spec/models/task_list_spec.rb +41 -0
  204. data/spec/models/task_spec.rb +0 -66
  205. data/spec/models/task_types_spec.rb +0 -6
  206. data/spec/models/update_email_campaign_recipients_spec.rb +6 -0
  207. data/spec/models/update_email_campaign_spec.rb +12 -0
  208. data/spec/models/upload_image_model_spec.rb +41 -0
  209. metadata +179 -23
  210. data/docs/AttributesApi.md +0 -246
  211. data/docs/CRMApi.md +0 -762
  212. data/docs/Contact.md +0 -15
  213. data/lib/sib-api-v3-sdk/api/attributes_api.rb +0 -274
  214. data/lib/sib-api-v3-sdk/api/crm_api.rb +0 -716
  215. data/lib/sib-api-v3-sdk/api/folders_api.rb +0 -383
  216. data/lib/sib-api-v3-sdk/api/lists_api.rb +0 -562
@@ -13,131 +13,114 @@ Swagger Codegen version: 2.4.19
13
13
  require 'spec_helper'
14
14
  require 'json'
15
15
 
16
- # Unit tests for SibApiV3Sdk::ListsApi
16
+ # Unit tests for SibApiV3Sdk::DealsApi
17
17
  # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
18
18
  # Please update as you see appropriate
19
- describe 'ListsApi' do
19
+ describe 'DealsApi' do
20
20
  before do
21
21
  # run before each test
22
- @instance = SibApiV3Sdk::ListsApi.new
22
+ @instance = SibApiV3Sdk::DealsApi.new
23
23
  end
24
24
 
25
25
  after do
26
26
  # run after each test
27
27
  end
28
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)
29
+ describe 'test an instance of DealsApi' do
30
+ it 'should create an instance of DealsApi' do
31
+ expect(@instance).to be_instance_of(SibApiV3Sdk::DealsApi)
32
32
  end
33
33
  end
34
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
35
+ # unit tests for crm_attributes_deals_get
36
+ # Get deal attributes
39
37
  # @param [Hash] opts the optional parameters
40
- # @return [PostContactInfo]
41
- describe 'add_contact_to_list test' do
38
+ # @return [DealAttributes]
39
+ describe 'crm_attributes_deals_get test' do
42
40
  it 'should work' do
43
41
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
42
  end
45
43
  end
46
44
 
47
- # unit tests for create_list
48
- # Create a list
49
- # @param create_list Values to create a list
45
+ # unit tests for crm_deals_get
46
+ # Get all deals
50
47
  # @param [Hash] opts the optional parameters
51
- # @return [CreateModel]
52
- describe 'create_list test' do
48
+ # @option opts [String] :filter_attributes Filter by attrbutes. If you have filter for owner on your side please send it as `attributes.owner`.\"
49
+ # @option opts [String] :filter_linked_companies_ids Filter by linked companies ids
50
+ # @option opts [String] :filter_linked_contacts_ids Filter by linked companies ids
51
+ # @option opts [Integer] :offset Index of the first document of the page
52
+ # @option opts [Integer] :limit Number of documents per page
53
+ # @option opts [String] :sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
54
+ # @option opts [String] :sort_by The field used to sort field names.
55
+ # @return [DealsList]
56
+ describe 'crm_deals_get test' do
53
57
  it 'should work' do
54
58
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
55
59
  end
56
60
  end
57
61
 
58
- # unit tests for delete_list
59
- # Delete a list
60
- # @param list_id Id of the list
62
+ # unit tests for crm_deals_id_delete
63
+ # Delete a deal
64
+ # @param id
61
65
  # @param [Hash] opts the optional parameters
62
66
  # @return [nil]
63
- describe 'delete_list test' do
67
+ describe 'crm_deals_id_delete test' do
64
68
  it 'should work' do
65
69
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
66
70
  end
67
71
  end
68
72
 
69
- # unit tests for get_contacts_from_list
70
- # Get contacts in a list
71
- # @param list_id Id of the list
73
+ # unit tests for crm_deals_id_get
74
+ # Get a deal
75
+ # @param id
72
76
  # @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
77
+ # @return [Deal]
78
+ describe 'crm_deals_id_get test' do
79
79
  it 'should work' do
80
80
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
81
81
  end
82
82
  end
83
83
 
84
- # unit tests for get_folder_lists
85
- # Get lists in a folder
86
- # @param folder_id Id of the folder
84
+ # unit tests for crm_deals_id_patch
85
+ # Update a deal
86
+ # @param id
87
+ # @param body Updated deal details.
87
88
  # @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
89
+ # @return [nil]
90
+ describe 'crm_deals_id_patch test' do
104
91
  it 'should work' do
105
92
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
106
93
  end
107
94
  end
108
95
 
109
- # unit tests for get_lists
110
- # Get all the lists
96
+ # unit tests for crm_deals_link_unlink_id_patch
97
+ # Link and Unlink a deal with contacts and companies
98
+ # @param id
99
+ # @param body Linked / Unlinked contacts and companies ids.
111
100
  # @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
101
+ # @return [nil]
102
+ describe 'crm_deals_link_unlink_id_patch test' do
117
103
  it 'should work' do
118
104
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
119
105
  end
120
106
  end
121
107
 
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
108
+ # unit tests for crm_deals_post
109
+ # Create a deal
110
+ # @param body Deal create data.
126
111
  # @param [Hash] opts the optional parameters
127
- # @return [PostContactInfo]
128
- describe 'remove_contact_from_list test' do
112
+ # @return [InlineResponse201]
113
+ describe 'crm_deals_post test' do
129
114
  it 'should work' do
130
115
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
131
116
  end
132
117
  end
133
118
 
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
119
+ # unit tests for crm_pipeline_details_get
120
+ # Get pipeline stages
138
121
  # @param [Hash] opts the optional parameters
139
- # @return [nil]
140
- describe 'update_list test' do
122
+ # @return [Pipeline]
123
+ describe 'crm_pipeline_details_get test' do
141
124
  it 'should work' do
142
125
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
143
126
  end
@@ -182,7 +182,7 @@ describe 'EmailCampaignsApi' do
182
182
  # Upload an image to your account's image gallery
183
183
  # @param upload_image Parameters to upload an image
184
184
  # @param [Hash] opts the optional parameters
185
- # @return [nil]
185
+ # @return [UploadImageModel]
186
186
  describe 'upload_image_to_gallery test' do
187
187
  it 'should work' do
188
188
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -0,0 +1,99 @@
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::FilesApi
17
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
18
+ # Please update as you see appropriate
19
+ describe 'FilesApi' do
20
+ before do
21
+ # run before each test
22
+ @instance = SibApiV3Sdk::FilesApi.new
23
+ end
24
+
25
+ after do
26
+ # run after each test
27
+ end
28
+
29
+ describe 'test an instance of FilesApi' do
30
+ it 'should create an instance of FilesApi' do
31
+ expect(@instance).to be_instance_of(SibApiV3Sdk::FilesApi)
32
+ end
33
+ end
34
+
35
+ # unit tests for crm_files_get
36
+ # Get all files
37
+ # @param [Hash] opts the optional parameters
38
+ # @option opts [String] :entity Filter by file entity type
39
+ # @option opts [String] :entity_ids Filter by file entity IDs
40
+ # @option opts [Integer] :date_from dateFrom to date range filter type (timestamp in milliseconds)
41
+ # @option opts [Integer] :date_to dateTo to date range filter type (timestamp in milliseconds)
42
+ # @option opts [Integer] :offset Index of the first document of the page
43
+ # @option opts [Integer] :limit Number of documents per page
44
+ # @option opts [String] :sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
45
+ # @return [FileList]
46
+ describe 'crm_files_get test' do
47
+ it 'should work' do
48
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
49
+ end
50
+ end
51
+
52
+ # unit tests for crm_files_id_data_get
53
+ # Get file details
54
+ # @param id File id to get file data.
55
+ # @param [Hash] opts the optional parameters
56
+ # @return [FileData]
57
+ describe 'crm_files_id_data_get test' do
58
+ it 'should work' do
59
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
60
+ end
61
+ end
62
+
63
+ # unit tests for crm_files_id_delete
64
+ # Delete a file
65
+ # @param id File id to delete.
66
+ # @param [Hash] opts the optional parameters
67
+ # @return [nil]
68
+ describe 'crm_files_id_delete test' do
69
+ it 'should work' do
70
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
71
+ end
72
+ end
73
+
74
+ # unit tests for crm_files_id_get
75
+ # Download a file
76
+ # @param id File id to download.
77
+ # @param [Hash] opts the optional parameters
78
+ # @return [FileDownloadableLink]
79
+ describe 'crm_files_id_get test' do
80
+ it 'should work' do
81
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
82
+ end
83
+ end
84
+
85
+ # unit tests for crm_files_post
86
+ # Upload a file
87
+ # @param file File data to create a file.
88
+ # @param [Hash] opts the optional parameters
89
+ # @option opts [String] :deal_id Deal id linked to a file
90
+ # @option opts [Integer] :contact_id Contact id linked to a file
91
+ # @option opts [String] :company_id Company id linked to a file
92
+ # @return [FileData]
93
+ describe 'crm_files_post test' do
94
+ it 'should work' do
95
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
96
+ end
97
+ end
98
+
99
+ end
@@ -32,6 +32,18 @@ describe 'InboundParsingApi' do
32
32
  end
33
33
  end
34
34
 
35
+ # unit tests for get_inbound_email_attachment
36
+ # Retrieve inbound attachment with download token.
37
+ # This endpoint will retrieve inbound attachment with download token.
38
+ # @param download_token Token to fetch a particular attachment
39
+ # @param [Hash] opts the optional parameters
40
+ # @return [File]
41
+ describe 'get_inbound_email_attachment 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
+
35
47
  # unit tests for get_inbound_email_events
36
48
  # Get the list of all the events for the received emails.
37
49
  # This endpoint will show the list of all the events for the received emails.
@@ -46,7 +46,7 @@ describe 'MasterAccountApi' do
46
46
  # unit tests for corporate_sub_account_get
47
47
  # Get the list of all the sub-accounts of the master account.
48
48
  # This endpoint will provide the list all the sub-accounts of the master account.
49
- # @param offset Page number of sub-accounts listing
49
+ # @param offset Index of the first sub-account in the page
50
50
  # @param limit Number of sub-accounts to be displayed on each page
51
51
  # @param [Hash] opts the optional parameters
52
52
  # @return [SubAccountsResponse]
@@ -69,7 +69,7 @@ describe 'MasterAccountApi' do
69
69
 
70
70
  # unit tests for corporate_sub_account_id_get
71
71
  # Get sub-account details
72
- # This endpoint will provide the details of specified sub-account organization
72
+ # This endpoint will provide the details for the specified sub-account company
73
73
  # @param id Id of the sub-account organization
74
74
  # @param [Hash] opts the optional parameters
75
75
  # @return [SubAccountDetailsResponse]
@@ -97,7 +97,7 @@ describe 'MasterAccountApi' do
97
97
  # This endpoint will create a new sub-account under a master account
98
98
  # @param sub_account_create values to create new sub-account
99
99
  # @param [Hash] opts the optional parameters
100
- # @return [CreateModel]
100
+ # @return [CreateSubAccountResponse]
101
101
  describe 'corporate_sub_account_post test' do
102
102
  it 'should work' do
103
103
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -106,7 +106,7 @@ describe 'MasterAccountApi' do
106
106
 
107
107
  # unit tests for corporate_sub_account_sso_token_post
108
108
  # Generate SSO token to access Sendinblue
109
- # This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced with actual token.
109
+ # This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token.
110
110
  # @param sso_token_request Values to generate SSO token for sub-account
111
111
  # @param [Hash] opts the optional parameters
112
112
  # @return [GetSsoToken]
@@ -0,0 +1,97 @@
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::NotesApi
17
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
18
+ # Please update as you see appropriate
19
+ describe 'NotesApi' do
20
+ before do
21
+ # run before each test
22
+ @instance = SibApiV3Sdk::NotesApi.new
23
+ end
24
+
25
+ after do
26
+ # run after each test
27
+ end
28
+
29
+ describe 'test an instance of NotesApi' do
30
+ it 'should create an instance of NotesApi' do
31
+ expect(@instance).to be_instance_of(SibApiV3Sdk::NotesApi)
32
+ end
33
+ end
34
+
35
+ # unit tests for crm_notes_get
36
+ # Get all notes
37
+ # @param [Hash] opts the optional parameters
38
+ # @option opts [String] :entity Filter by note entity type
39
+ # @option opts [String] :entity_ids Filter by note entity IDs
40
+ # @option opts [Integer] :date_from dateFrom to date range filter type (timestamp in milliseconds)
41
+ # @option opts [Integer] :date_to dateTo to date range filter type (timestamp in milliseconds)
42
+ # @option opts [Integer] :offset Index of the first document of the page
43
+ # @option opts [Integer] :limit Number of documents per page
44
+ # @option opts [String] :sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
45
+ # @return [NoteList]
46
+ describe 'crm_notes_get test' do
47
+ it 'should work' do
48
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
49
+ end
50
+ end
51
+
52
+ # unit tests for crm_notes_id_delete
53
+ # Delete a note
54
+ # @param id Note ID to delete
55
+ # @param [Hash] opts the optional parameters
56
+ # @return [nil]
57
+ describe 'crm_notes_id_delete test' do
58
+ it 'should work' do
59
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
60
+ end
61
+ end
62
+
63
+ # unit tests for crm_notes_id_get
64
+ # Get a note
65
+ # @param id Note ID to get
66
+ # @param [Hash] opts the optional parameters
67
+ # @return [Note]
68
+ describe 'crm_notes_id_get test' do
69
+ it 'should work' do
70
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
71
+ end
72
+ end
73
+
74
+ # unit tests for crm_notes_id_patch
75
+ # Update a note
76
+ # @param id Note ID to update
77
+ # @param body Note data to update a note
78
+ # @param [Hash] opts the optional parameters
79
+ # @return [nil]
80
+ describe 'crm_notes_id_patch test' do
81
+ it 'should work' do
82
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
83
+ end
84
+ end
85
+
86
+ # unit tests for crm_notes_post
87
+ # Create a note
88
+ # @param body Note data to create a note.
89
+ # @param [Hash] opts the optional parameters
90
+ # @return [NoteId]
91
+ describe 'crm_notes_post test' do
92
+ it 'should work' do
93
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
94
+ end
95
+ end
96
+
97
+ end
@@ -13,92 +13,98 @@ Swagger Codegen version: 2.4.19
13
13
  require 'spec_helper'
14
14
  require 'json'
15
15
 
16
- # Unit tests for SibApiV3Sdk::FoldersApi
16
+ # Unit tests for SibApiV3Sdk::TasksApi
17
17
  # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
18
18
  # Please update as you see appropriate
19
- describe 'FoldersApi' do
19
+ describe 'TasksApi' do
20
20
  before do
21
21
  # run before each test
22
- @instance = SibApiV3Sdk::FoldersApi.new
22
+ @instance = SibApiV3Sdk::TasksApi.new
23
23
  end
24
24
 
25
25
  after do
26
26
  # run after each test
27
27
  end
28
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)
29
+ describe 'test an instance of TasksApi' do
30
+ it 'should create an instance of TasksApi' do
31
+ expect(@instance).to be_instance_of(SibApiV3Sdk::TasksApi)
32
32
  end
33
33
  end
34
34
 
35
- # unit tests for create_folder
36
- # Create a folder
37
- # @param create_folder Name of the folder
35
+ # unit tests for crm_tasks_get
36
+ # Get all tasks
38
37
  # @param [Hash] opts the optional parameters
39
- # @return [CreateModel]
40
- describe 'create_folder test' do
38
+ # @option opts [String] :filter_type Filter by task type (ID)
39
+ # @option opts [String] :filter_status Filter by task status
40
+ # @option opts [String] :filter_date Filter by date
41
+ # @option opts [String] :filter_assign_to Filter by assignTo id
42
+ # @option opts [String] :filter_contacts Filter by contact ids
43
+ # @option opts [String] :filter_deals Filter by deals ids
44
+ # @option opts [String] :filter_companies Filter by companies ids
45
+ # @option opts [Integer] :date_from dateFrom to date range filter type (timestamp in milliseconds)
46
+ # @option opts [Integer] :date_to dateTo to date range filter type (timestamp in milliseconds)
47
+ # @option opts [Integer] :offset Index of the first document of the page
48
+ # @option opts [Integer] :limit Number of documents per page
49
+ # @option opts [String] :sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed
50
+ # @option opts [String] :sort_by The field used to sort field names.
51
+ # @return [TaskList]
52
+ describe 'crm_tasks_get test' do
41
53
  it 'should work' do
42
54
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
43
55
  end
44
56
  end
45
57
 
46
- # unit tests for delete_folder
47
- # Delete a folder (and all its lists)
48
- # @param folder_id Id of the folder
58
+ # unit tests for crm_tasks_id_delete
59
+ # Delete a task
60
+ # @param id
49
61
  # @param [Hash] opts the optional parameters
50
62
  # @return [nil]
51
- describe 'delete_folder test' do
63
+ describe 'crm_tasks_id_delete test' do
52
64
  it 'should work' do
53
65
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
54
66
  end
55
67
  end
56
68
 
57
- # unit tests for get_folder
58
- # Returns a folder's details
59
- # @param folder_id id of the folder
69
+ # unit tests for crm_tasks_id_get
70
+ # Get a task
71
+ # @param id
60
72
  # @param [Hash] opts the optional parameters
61
- # @return [GetFolder]
62
- describe 'get_folder test' do
73
+ # @return [Task]
74
+ describe 'crm_tasks_id_get test' do
63
75
  it 'should work' do
64
76
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
65
77
  end
66
78
  end
67
79
 
68
- # unit tests for get_folder_lists
69
- # Get lists in a folder
70
- # @param folder_id Id of the folder
80
+ # unit tests for crm_tasks_id_patch
81
+ # Update a task
82
+ # @param id
83
+ # @param body Updated task details.
71
84
  # @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
85
+ # @return [nil]
86
+ describe 'crm_tasks_id_patch test' do
77
87
  it 'should work' do
78
88
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
79
89
  end
80
90
  end
81
91
 
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
92
+ # unit tests for crm_tasks_post
93
+ # Create a task
94
+ # @param body Task name.
86
95
  # @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
96
+ # @return [InlineResponse2011]
97
+ describe 'crm_tasks_post test' do
90
98
  it 'should work' do
91
99
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
92
100
  end
93
101
  end
94
102
 
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
103
+ # unit tests for crm_tasktypes_get
104
+ # Get all task types
99
105
  # @param [Hash] opts the optional parameters
100
- # @return [nil]
101
- describe 'update_folder test' do
106
+ # @return [TaskTypes]
107
+ describe 'crm_tasktypes_get test' do
102
108
  it 'should work' do
103
109
  # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
104
110
  end
@@ -79,6 +79,18 @@ describe 'TransactionalEmailsApi' do
79
79
  end
80
80
  end
81
81
 
82
+ # unit tests for delete_scheduled_email_by_id
83
+ # Delete scheduled emails by batchId or messageId
84
+ # Delete scheduled batch of emails by batchId or single scheduled email by messageId
85
+ # @param identifier The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email.
86
+ # @param [Hash] opts the optional parameters
87
+ # @return [nil]
88
+ describe 'delete_scheduled_email_by_id test' do
89
+ it 'should work' do
90
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
91
+ end
92
+ end
93
+
82
94
  # unit tests for delete_smtp_template
83
95
  # Delete an inactive email template
84
96
  # @param template_id id of the template
@@ -138,6 +150,38 @@ describe 'TransactionalEmailsApi' do
138
150
  end
139
151
  end
140
152
 
153
+ # unit tests for get_scheduled_email_by_batch_id
154
+ # Fetch scheduled emails by batchId
155
+ # Fetch scheduled batch of emails by batchId (Can retrieve data upto 30 days old)
156
+ # @param batch_id The batchId of scheduled emails batch (Should be a valid UUIDv4)
157
+ # @param [Hash] opts the optional parameters
158
+ # @option opts [Date] :start_date Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
159
+ # @option opts [Date] :end_date Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
160
+ # @option opts [String] :sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed
161
+ # @option opts [String] :status Filter the records by `status` of the scheduled email batch or message.
162
+ # @option opts [Integer] :limit Number of documents returned per page
163
+ # @option opts [Integer] :offset Index of the first document on the page
164
+ # @return [GetScheduledEmailByBatchId]
165
+ describe 'get_scheduled_email_by_batch_id test' do
166
+ it 'should work' do
167
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
168
+ end
169
+ end
170
+
171
+ # unit tests for get_scheduled_email_by_message_id
172
+ # Fetch scheduled email by messageId
173
+ # Fetch scheduled email by messageId (Can retrieve data upto 30 days old)
174
+ # @param message_id The messageId of scheduled email
175
+ # @param [Hash] opts the optional parameters
176
+ # @option opts [Date] :start_date Mandatory if endDate is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current date.
177
+ # @option opts [Date] :end_date Mandatory if startDate is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.
178
+ # @return [GetScheduledEmailByMessageId]
179
+ describe 'get_scheduled_email_by_message_id test' do
180
+ it 'should work' do
181
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
182
+ end
183
+ end
184
+
141
185
  # unit tests for get_smtp_report
142
186
  # Get your transactional email activity aggregated per day
143
187
  # @param [Hash] opts the optional parameters