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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8c8451f2fbb21e58e803db4b6f8e84f132ea735ac9b0122dd75b6376f7ac86d8
4
- data.tar.gz: e4dc35b3fe6547f8f13a8653bd224d9d261036c7422645a71a8dfd7505ac6ddc
3
+ metadata.gz: 73c8c76720a18ba860802bbc63ca87aeb66c2ab0ff1ef0fefaf77c6f30f096f7
4
+ data.tar.gz: 0c05a66b14790f711bdfa510217f3cdd49154b8247b6331d104189610e291b22
5
5
  SHA512:
6
- metadata.gz: f11ffb30b16cf90bed1dedb5aaafb360755b832ac4635946a7e55804b82e1023dd7fdbd08f52022c97be9580dd9473ae50edbfb0359bd87f8deb3de75bff83c9
7
- data.tar.gz: f831e0c1e5fe048775b1f7d2913fc6270e600d76bc34e10ad6a255009638bb327b8d5368afbef325ec7751d58c2b13801eaf7cdc155d01f6017daf57a911b972
6
+ metadata.gz: de9397df99f6f9ea814a173c327996c212796144dc7ccad476e367c83b45d553a836df5c11ddd85927152817b25e65c59250e5a425b8641839ca593f8a94b5e9
7
+ data.tar.gz: 600b7e277b6e2a74a89f780f3299614cd5c6a3a406a8dd36149a2eb2377a8319591905636c82a208fc1e7148260fbd96a19fbcf37697902090260091145aa9b4
data/README.md CHANGED
@@ -85,10 +85,6 @@ All URIs are relative to *https://api.sendinblue.com/v3*
85
85
  Class | Method | HTTP request | Description
86
86
  ------------ | ------------- | ------------- | -------------
87
87
  *SibApiV3Sdk::AccountApi* | [**get_account**](docs/AccountApi.md#get_account) | **GET** /account | Get your account information, plan and credits details
88
- *SibApiV3Sdk::AttributesApi* | [**create_attribute**](docs/AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
89
- *SibApiV3Sdk::AttributesApi* | [**delete_attribute**](docs/AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
90
- *SibApiV3Sdk::AttributesApi* | [**get_attributes**](docs/AttributesApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
91
- *SibApiV3Sdk::AttributesApi* | [**update_attribute**](docs/AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
92
88
  *SibApiV3Sdk::CompaniesApi* | [**companies_attributes_get**](docs/CompaniesApi.md#companies_attributes_get) | **GET** /companies/attributes | Get company attributes
93
89
  *SibApiV3Sdk::CompaniesApi* | [**companies_get**](docs/CompaniesApi.md#companies_get) | **GET** /companies | Get all companies
94
90
  *SibApiV3Sdk::CompaniesApi* | [**companies_id_delete**](docs/CompaniesApi.md#companies_id_delete) | **DELETE** /companies/{id} | Delete a company
@@ -159,24 +155,9 @@ Class | Method | HTTP request | Description
159
155
  *SibApiV3Sdk::FilesApi* | [**crm_files_id_delete**](docs/FilesApi.md#crm_files_id_delete) | **DELETE** /crm/files/{id} | Delete a file
160
156
  *SibApiV3Sdk::FilesApi* | [**crm_files_id_get**](docs/FilesApi.md#crm_files_id_get) | **GET** /crm/files/{id} | Download a file
161
157
  *SibApiV3Sdk::FilesApi* | [**crm_files_post**](docs/FilesApi.md#crm_files_post) | **POST** /crm/files | Upload a file
162
- *SibApiV3Sdk::FoldersApi* | [**create_folder**](docs/FoldersApi.md#create_folder) | **POST** /contacts/folders | Create a folder
163
- *SibApiV3Sdk::FoldersApi* | [**delete_folder**](docs/FoldersApi.md#delete_folder) | **DELETE** /contacts/folders/{folderId} | Delete a folder (and all its lists)
164
- *SibApiV3Sdk::FoldersApi* | [**get_folder**](docs/FoldersApi.md#get_folder) | **GET** /contacts/folders/{folderId} | Returns a folder's details
165
- *SibApiV3Sdk::FoldersApi* | [**get_folder_lists**](docs/FoldersApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
166
- *SibApiV3Sdk::FoldersApi* | [**get_folders**](docs/FoldersApi.md#get_folders) | **GET** /contacts/folders | Get all folders
167
- *SibApiV3Sdk::FoldersApi* | [**update_folder**](docs/FoldersApi.md#update_folder) | **PUT** /contacts/folders/{folderId} | Update a folder
168
158
  *SibApiV3Sdk::InboundParsingApi* | [**get_inbound_email_attachment**](docs/InboundParsingApi.md#get_inbound_email_attachment) | **GET** /inbound/attachments/{downloadToken} | Retrieve inbound attachment with download token.
169
159
  *SibApiV3Sdk::InboundParsingApi* | [**get_inbound_email_events**](docs/InboundParsingApi.md#get_inbound_email_events) | **GET** /inbound/events | Get the list of all the events for the received emails.
170
160
  *SibApiV3Sdk::InboundParsingApi* | [**get_inbound_email_events_by_uuid**](docs/InboundParsingApi.md#get_inbound_email_events_by_uuid) | **GET** /inbound/events/{uuid} | Fetch all events history for one particular received email.
171
- *SibApiV3Sdk::ListsApi* | [**add_contact_to_list**](docs/ListsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
172
- *SibApiV3Sdk::ListsApi* | [**create_list**](docs/ListsApi.md#create_list) | **POST** /contacts/lists | Create a list
173
- *SibApiV3Sdk::ListsApi* | [**delete_list**](docs/ListsApi.md#delete_list) | **DELETE** /contacts/lists/{listId} | Delete a list
174
- *SibApiV3Sdk::ListsApi* | [**get_contacts_from_list**](docs/ListsApi.md#get_contacts_from_list) | **GET** /contacts/lists/{listId}/contacts | Get contacts in a list
175
- *SibApiV3Sdk::ListsApi* | [**get_folder_lists**](docs/ListsApi.md#get_folder_lists) | **GET** /contacts/folders/{folderId}/lists | Get lists in a folder
176
- *SibApiV3Sdk::ListsApi* | [**get_list**](docs/ListsApi.md#get_list) | **GET** /contacts/lists/{listId} | Get a list's details
177
- *SibApiV3Sdk::ListsApi* | [**get_lists**](docs/ListsApi.md#get_lists) | **GET** /contacts/lists | Get all the lists
178
- *SibApiV3Sdk::ListsApi* | [**remove_contact_from_list**](docs/ListsApi.md#remove_contact_from_list) | **POST** /contacts/lists/{listId}/contacts/remove | Delete a contact from a list
179
- *SibApiV3Sdk::ListsApi* | [**update_list**](docs/ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
180
161
  *SibApiV3Sdk::MasterAccountApi* | [**corporate_master_account_get**](docs/MasterAccountApi.md#corporate_master_account_get) | **GET** /corporate/masterAccount | Get the details of requested master account
181
162
  *SibApiV3Sdk::MasterAccountApi* | [**corporate_sub_account_get**](docs/MasterAccountApi.md#corporate_sub_account_get) | **GET** /corporate/subAccount | Get the list of all the sub-accounts of the master account.
182
163
  *SibApiV3Sdk::MasterAccountApi* | [**corporate_sub_account_id_delete**](docs/MasterAccountApi.md#corporate_sub_account_id_delete) | **DELETE** /corporate/subAccount/{id} | Delete a sub-account
data/docs/Body.md CHANGED
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **name** | **String** | Name of company |
7
7
  **attributes** | **Object** | Attributes for company creation | [optional]
8
+ **country_code** | **Integer** | Country code if phone_number is passed in attributes. | [optional]
8
9
 
9
10
 
data/docs/Body1.md CHANGED
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **name** | **String** | Name of company | [optional]
7
7
  **attributes** | **Object** | Attributes for company update | [optional]
8
+ **country_code** | **Integer** | Country code if phone_number is passed in attributes. | [optional]
8
9
 
9
10
 
data/docs/Body10.md CHANGED
@@ -3,9 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **visitor_id** | **String** | visitor’s ID received from a webhook or generated by you to <a href=\"https://developers.sendinblue.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> |
6
+ **visitor_id** | **String** | visitor’s ID received <a href=\"https://developers.sendinblue.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.sendinblue.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> |
7
7
  **text** | **String** | message text |
8
- **agent_id** | **String** | agent ID. It can be found on agent’s page or received from a webhook. Optional if `groupId` is set. | [optional]
8
+ **agent_id** | **String** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.sendinblue.com/docs/conversations-webhooks\">from a webhook</a>. Optional if `groupId` is set. | [optional]
9
9
  **group_id** | **String** | group ID. It can be found on group’s page. Optional if `agentId` is set. | [optional]
10
10
 
11
11
 
data/docs/Body12.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **agent_id** | **String** | agent ID. It can be found on agent’s page or received from a webhook. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional]
6
+ **agent_id** | **String** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.sendinblue.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional]
7
7
  **received_from** | **String** | mark your messages to distinguish messages created by you from the others. | [optional]
8
8
  **agent_email** | **String** | agent email. When sending online pings from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. If there’s no agent with the specified email address in your Sendinblue organization, a dummy agent will be created automatically. | [optional]
9
9
  **agent_name** | **String** | agent name. | [optional]
data/docs/Body8.md CHANGED
@@ -3,9 +3,9 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **visitor_id** | **String** | visitor’s ID received from a webhook or generated by you to <a href=\"https://developers.sendinblue.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> |
6
+ **visitor_id** | **String** | visitor’s ID received <a href=\"https://developers.sendinblue.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.sendinblue.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> |
7
7
  **text** | **String** | message text |
8
- **agent_id** | **String** | agent ID. It can be found on agent’s page or received from a webhook. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional]
8
+ **agent_id** | **String** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.sendinblue.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional]
9
9
  **received_from** | **String** | mark your messages to distinguish messages created by you from the others. | [optional]
10
10
  **agent_email** | **String** | agent email. When sending messages from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address. | [optional]
11
11
  **agent_name** | **String** | agent name | [optional]
@@ -31,5 +31,7 @@ Name | Type | Description | Notes
31
31
  **ip_warmup_enable** | **BOOLEAN** | Available for dedicated ip clients. Set this to true if you wish to warm up your ip. | [optional] [default to false]
32
32
  **initial_quota** | **Integer** | Mandatory if ipWarmupEnable is set to true. Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. | [optional]
33
33
  **increase_rate** | **Integer** | Mandatory if ipWarmupEnable is set to true. 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%. | [optional]
34
+ **unsubscription_page_id** | **String** | 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. If not entered, then the default unsubscription page will be used. | [optional]
35
+ **update_form_id** | **String** | 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. If not entered, then the default update profile form will be used. | [optional]
34
36
 
35
37
 
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **exclusion_list_ids** | **Array<Integer>** | List ids to exclude from the campaign | [optional]
7
7
  **list_ids** | **Array<Integer>** | Mandatory if scheduledAt is not empty. List Ids to send the campaign to | [optional]
8
+ **segment_ids** | **Array<Integer>** | Mandatory if listIds are not used. Segment ids to send the campaign to. | [optional]
8
9
 
9
10
 
data/docs/NoteData.md CHANGED
@@ -6,5 +6,6 @@ Name | Type | Description | Notes
6
6
  **text** | **String** | Text content of a note |
7
7
  **contact_ids** | **Array<Integer>** | Contact Ids linked to a note | [optional]
8
8
  **deal_ids** | **Array<String>** | Deal Ids linked to a note | [optional]
9
+ **company_ids** | **Array<String>** | Company Ids linked to a note | [optional]
9
10
 
10
11
 
@@ -520,7 +520,7 @@ end
520
520
  api_instance = SibApiV3Sdk::TransactionalEmailsApi.new
521
521
 
522
522
  opts = {
523
- limit: 50, # Integer | Number limitation for the result returned
523
+ limit: 2500, # Integer | Number limitation for the result returned
524
524
  offset: 0, # Integer | Beginning point in the list to retrieve from.
525
525
  start_date: 'start_date_example', # String | Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
526
526
  end_date: 'end_date_example', # String | Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
@@ -546,7 +546,7 @@ end
546
546
 
547
547
  Name | Type | Description | Notes
548
548
  ------------- | ------------- | ------------- | -------------
549
- **limit** | **Integer**| Number limitation for the result returned | [optional] [default to 50]
549
+ **limit** | **Integer**| Number limitation for the result returned | [optional] [default to 2500]
550
550
  **offset** | **Integer**| Beginning point in the list to retrieve from. | [optional] [default to 0]
551
551
  **start_date** | **String**| Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate | [optional]
552
552
  **end_date** | **String**| Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate | [optional]
@@ -31,5 +31,7 @@ Name | Type | Description | Notes
31
31
  **ip_warmup_enable** | **BOOLEAN** | Available for dedicated ip clients. Set this to true if you wish to warm up your ip. | [optional] [default to false]
32
32
  **initial_quota** | **Integer** | Set an initial quota greater than 1 for warming up your ip. We recommend you set a value of 3000. | [optional]
33
33
  **increase_rate** | **Integer** | 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%. | [optional]
34
+ **unsubscription_page_id** | **String** | 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. | [optional]
35
+ **update_form_id** | **String** | 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. | [optional]
34
36
 
35
37
 
@@ -4,6 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **exclusion_list_ids** | **Array<Integer>** | List ids which have to be excluded from a campaign | [optional]
7
- **list_ids** | **Array<Integer>** | Lists Ids to send the campaign to. REQUIRED if already not present in campaign and scheduledAt is not empty | [optional]
7
+ **list_ids** | **Array<Integer>** | 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 | [optional]
8
+ **segment_ids** | **Array<Integer>** | 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. | [optional]
8
9
 
9
10
 
@@ -766,6 +766,10 @@ module SibApiV3Sdk
766
766
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_contacts, must be smaller than or equal to 1000.'
767
767
  end
768
768
 
769
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
770
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_contacts, must be greater than or equal to 0.'
771
+ end
772
+
769
773
  if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
770
774
  fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
771
775
  end
@@ -837,6 +841,10 @@ module SibApiV3Sdk
837
841
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_contacts_from_list, must be smaller than or equal to 500.'
838
842
  end
839
843
 
844
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
845
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_contacts_from_list, must be greater than or equal to 0.'
846
+ end
847
+
840
848
  if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
841
849
  fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
842
850
  end
@@ -958,6 +966,10 @@ module SibApiV3Sdk
958
966
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_folder_lists, must be smaller than or equal to 50.'
959
967
  end
960
968
 
969
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
970
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_folder_lists, must be greater than or equal to 0.'
971
+ end
972
+
961
973
  if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
962
974
  fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
963
975
  end
@@ -1024,6 +1036,10 @@ module SibApiV3Sdk
1024
1036
  fail ArgumentError, 'invalid value for "limit" when calling ContactsApi.get_folders, must be smaller than or equal to 50.'
1025
1037
  end
1026
1038
 
1039
+ if @api_client.config.client_side_validation && limit < 0
1040
+ fail ArgumentError, 'invalid value for "limit" when calling ContactsApi.get_folders, must be greater than or equal to 0.'
1041
+ end
1042
+
1027
1043
  # verify the required parameter 'offset' is set
1028
1044
  if @api_client.config.client_side_validation && offset.nil?
1029
1045
  fail ArgumentError, "Missing the required parameter 'offset' when calling ContactsApi.get_folders"
@@ -1142,6 +1158,10 @@ module SibApiV3Sdk
1142
1158
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_lists, must be smaller than or equal to 50.'
1143
1159
  end
1144
1160
 
1161
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
1162
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ContactsApi.get_lists, must be greater than or equal to 0.'
1163
+ end
1164
+
1145
1165
  if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
1146
1166
  fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
1147
1167
  end
@@ -331,6 +331,10 @@ module SibApiV3Sdk
331
331
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EmailCampaignsApi.get_email_campaigns, must be smaller than or equal to 100.'
332
332
  end
333
333
 
334
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
335
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EmailCampaignsApi.get_email_campaigns, must be greater than or equal to 0.'
336
+ end
337
+
334
338
  if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
335
339
  fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
336
340
  end
@@ -115,6 +115,10 @@ module SibApiV3Sdk
115
115
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InboundParsingApi.get_inbound_email_events, must be smaller than or equal to 500.'
116
116
  end
117
117
 
118
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
119
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InboundParsingApi.get_inbound_email_events, must be greater than or equal to 0.'
120
+ end
121
+
118
122
  if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
119
123
  fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
120
124
  end
@@ -106,6 +106,10 @@ module SibApiV3Sdk
106
106
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ProcessApi.get_processes, must be smaller than or equal to 50.'
107
107
  end
108
108
 
109
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
110
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ProcessApi.get_processes, must be greater than or equal to 0.'
111
+ end
112
+
109
113
  if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
110
114
  fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
111
115
  end
@@ -593,6 +593,10 @@ module SibApiV3Sdk
593
593
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ResellerApi.get_reseller_childs, must be smaller than or equal to 20.'
594
594
  end
595
595
 
596
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
597
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ResellerApi.get_reseller_childs, must be greater than or equal to 0.'
598
+ end
599
+
596
600
  # resource path
597
601
  local_var_path = '/reseller/children'
598
602
 
@@ -218,6 +218,10 @@ module SibApiV3Sdk
218
218
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SMSCampaignsApi.get_sms_campaigns, must be smaller than or equal to 1000.'
219
219
  end
220
220
 
221
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
222
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SMSCampaignsApi.get_sms_campaigns, must be greater than or equal to 0.'
223
+ end
224
+
221
225
  if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
222
226
  fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
223
227
  end
@@ -451,7 +451,7 @@ module SibApiV3Sdk
451
451
  # Get all your transactional email activity (unaggregated events)
452
452
  # This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days
453
453
  # @param [Hash] opts the optional parameters
454
- # @option opts [Integer] :limit Number limitation for the result returned (default to 50)
454
+ # @option opts [Integer] :limit Number limitation for the result returned (default to 2500)
455
455
  # @option opts [Integer] :offset Beginning point in the list to retrieve from. (default to 0)
456
456
  # @option opts [String] :start_date Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate
457
457
  # @option opts [String] :end_date Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate
@@ -487,8 +487,12 @@ module SibApiV3Sdk
487
487
  if @api_client.config.debugging
488
488
  @api_client.config.logger.debug 'Calling API: TransactionalEmailsApi.get_email_event_report ...'
489
489
  end
490
- if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
491
- fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_email_event_report, must be smaller than or equal to 100.'
490
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 5000
491
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_email_event_report, must be smaller than or equal to 5000.'
492
+ end
493
+
494
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
495
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_email_event_report, must be greater than or equal to 0.'
492
496
  end
493
497
 
494
498
  if @api_client.config.client_side_validation && opts[:'event'] && !['bounces', 'hardBounces', 'softBounces', 'delivered', 'spam', 'requests', 'opened', 'clicks', 'invalid', 'deferred', 'blocked', 'unsubscribed', 'error', 'loadedByProxy'].include?(opts[:'event'])
@@ -584,6 +588,10 @@ module SibApiV3Sdk
584
588
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_scheduled_email_by_batch_id, must be smaller than or equal to 500.'
585
589
  end
586
590
 
591
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
592
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_scheduled_email_by_batch_id, must be greater than or equal to 0.'
593
+ end
594
+
587
595
  # resource path
588
596
  local_var_path = '/smtp/emailStatus/{batchId}'.sub('{' + 'batchId' + '}', batch_id.to_s)
589
597
 
@@ -714,6 +722,10 @@ module SibApiV3Sdk
714
722
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_smtp_report, must be smaller than or equal to 30.'
715
723
  end
716
724
 
725
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
726
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_smtp_report, must be greater than or equal to 0.'
727
+ end
728
+
717
729
  if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
718
730
  fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
719
731
  end
@@ -834,6 +846,10 @@ module SibApiV3Sdk
834
846
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_smtp_templates, must be smaller than or equal to 1000.'
835
847
  end
836
848
 
849
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
850
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_smtp_templates, must be greater than or equal to 0.'
851
+ end
852
+
837
853
  if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
838
854
  fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
839
855
  end
@@ -903,6 +919,10 @@ module SibApiV3Sdk
903
919
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_transac_blocked_contacts, must be smaller than or equal to 100.'
904
920
  end
905
921
 
922
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
923
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_transac_blocked_contacts, must be greater than or equal to 0.'
924
+ end
925
+
906
926
  if @api_client.config.client_side_validation && opts[:'sort'] && !['asc', 'desc'].include?(opts[:'sort'])
907
927
  fail ArgumentError, 'invalid value for "sort", must be one of asc, desc'
908
928
  end
@@ -1035,6 +1055,10 @@ module SibApiV3Sdk
1035
1055
  fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_transac_emails_list, must be smaller than or equal to 1000.'
1036
1056
  end
1037
1057
 
1058
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 0
1059
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TransactionalEmailsApi.get_transac_emails_list, must be greater than or equal to 0.'
1060
+ end
1061
+
1038
1062
  # resource path
1039
1063
  local_var_path = '/smtp/emails'
1040
1064
 
@@ -20,11 +20,15 @@ module SibApiV3Sdk
20
20
  # Attributes for company creation
21
21
  attr_accessor :attributes
22
22
 
23
+ # Country code if phone_number is passed in attributes.
24
+ attr_accessor :country_code
25
+
23
26
  # Attribute mapping from ruby-style variable name to JSON key.
24
27
  def self.attribute_map
25
28
  {
26
29
  :'name' => :'name',
27
- :'attributes' => :'attributes'
30
+ :'attributes' => :'attributes',
31
+ :'country_code' => :'countryCode'
28
32
  }
29
33
  end
30
34
 
@@ -32,7 +36,8 @@ module SibApiV3Sdk
32
36
  def self.swagger_types
33
37
  {
34
38
  :'name' => :'String',
35
- :'attributes' => :'Object'
39
+ :'attributes' => :'Object',
40
+ :'country_code' => :'Integer'
36
41
  }
37
42
  end
38
43
 
@@ -51,6 +56,10 @@ module SibApiV3Sdk
51
56
  if attributes.has_key?(:'attributes')
52
57
  self.attributes = attributes[:'attributes']
53
58
  end
59
+
60
+ if attributes.has_key?(:'countryCode')
61
+ self.country_code = attributes[:'countryCode']
62
+ end
54
63
  end
55
64
 
56
65
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -77,7 +86,8 @@ module SibApiV3Sdk
77
86
  return true if self.equal?(o)
78
87
  self.class == o.class &&
79
88
  name == o.name &&
80
- attributes == o.attributes
89
+ attributes == o.attributes &&
90
+ country_code == o.country_code
81
91
  end
82
92
 
83
93
  # @see the `==` method
@@ -89,7 +99,7 @@ module SibApiV3Sdk
89
99
  # Calculates hash code according to all attributes.
90
100
  # @return [Fixnum] Hash code
91
101
  def hash
92
- [name, attributes].hash
102
+ [name, attributes, country_code].hash
93
103
  end
94
104
 
95
105
  # Builds the object from hash
@@ -20,11 +20,15 @@ module SibApiV3Sdk
20
20
  # Attributes for company update
21
21
  attr_accessor :attributes
22
22
 
23
+ # Country code if phone_number is passed in attributes.
24
+ attr_accessor :country_code
25
+
23
26
  # Attribute mapping from ruby-style variable name to JSON key.
24
27
  def self.attribute_map
25
28
  {
26
29
  :'name' => :'name',
27
- :'attributes' => :'attributes'
30
+ :'attributes' => :'attributes',
31
+ :'country_code' => :'countryCode'
28
32
  }
29
33
  end
30
34
 
@@ -32,7 +36,8 @@ module SibApiV3Sdk
32
36
  def self.swagger_types
33
37
  {
34
38
  :'name' => :'String',
35
- :'attributes' => :'Object'
39
+ :'attributes' => :'Object',
40
+ :'country_code' => :'Integer'
36
41
  }
37
42
  end
38
43
 
@@ -51,6 +56,10 @@ module SibApiV3Sdk
51
56
  if attributes.has_key?(:'attributes')
52
57
  self.attributes = attributes[:'attributes']
53
58
  end
59
+
60
+ if attributes.has_key?(:'countryCode')
61
+ self.country_code = attributes[:'countryCode']
62
+ end
54
63
  end
55
64
 
56
65
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -72,7 +81,8 @@ module SibApiV3Sdk
72
81
  return true if self.equal?(o)
73
82
  self.class == o.class &&
74
83
  name == o.name &&
75
- attributes == o.attributes
84
+ attributes == o.attributes &&
85
+ country_code == o.country_code
76
86
  end
77
87
 
78
88
  # @see the `==` method
@@ -84,7 +94,7 @@ module SibApiV3Sdk
84
94
  # Calculates hash code according to all attributes.
85
95
  # @return [Fixnum] Hash code
86
96
  def hash
87
- [name, attributes].hash
97
+ [name, attributes, country_code].hash
88
98
  end
89
99
 
90
100
  # Builds the object from hash
@@ -14,13 +14,13 @@ require 'date'
14
14
 
15
15
  module SibApiV3Sdk
16
16
  class Body10
17
- # visitor’s ID received from a webhook or generated by you to <a href=\"https://developers.sendinblue.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a>
17
+ # visitor’s ID received <a href=\"https://developers.sendinblue.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.sendinblue.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a>
18
18
  attr_accessor :visitor_id
19
19
 
20
20
  # message text
21
21
  attr_accessor :text
22
22
 
23
- # agent ID. It can be found on agent’s page or received from a webhook. Optional if `groupId` is set.
23
+ # agent ID. It can be found on agent’s page or received <a href=\"https://developers.sendinblue.com/docs/conversations-webhooks\">from a webhook</a>. Optional if `groupId` is set.
24
24
  attr_accessor :agent_id
25
25
 
26
26
  # group ID. It can be found on group’s page. Optional if `agentId` is set.
@@ -14,7 +14,7 @@ require 'date'
14
14
 
15
15
  module SibApiV3Sdk
16
16
  class Body12
17
- # agent ID. It can be found on agent’s page or received from a webhook. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required).
17
+ # agent ID. It can be found on agent’s page or received <a href=\"https://developers.sendinblue.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required).
18
18
  attr_accessor :agent_id
19
19
 
20
20
  # mark your messages to distinguish messages created by you from the others.
@@ -14,13 +14,13 @@ require 'date'
14
14
 
15
15
  module SibApiV3Sdk
16
16
  class Body8
17
- # visitor’s ID received from a webhook or generated by you to <a href=\"https://developers.sendinblue.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a>
17
+ # visitor’s ID received <a href=\"https://developers.sendinblue.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.sendinblue.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a>
18
18
  attr_accessor :visitor_id
19
19
 
20
20
  # message text
21
21
  attr_accessor :text
22
22
 
23
- # agent ID. It can be found on agent’s page or received from a webhook. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required).
23
+ # agent ID. It can be found on agent’s page or received <a href=\"https://developers.sendinblue.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required).
24
24
  attr_accessor :agent_id
25
25
 
26
26
  # mark your messages to distinguish messages created by you from the others.
@@ -96,6 +96,12 @@ module SibApiV3Sdk
96
96
  # Mandatory if ipWarmupEnable is set to true. 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. If not entered, then the default unsubscription page will be used.
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. If not entered, then the default update profile form will be used.
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?
@@ -454,7 +472,9 @@ module SibApiV3Sdk
454
472
  winner_delay == o.winner_delay &&
455
473
  ip_warmup_enable == o.ip_warmup_enable &&
456
474
  initial_quota == o.initial_quota &&
457
- increase_rate == o.increase_rate
475
+ increase_rate == o.increase_rate &&
476
+ unsubscription_page_id == o.unsubscription_page_id &&
477
+ update_form_id == o.update_form_id
458
478
  end
459
479
 
460
480
  # @see the `==` method
@@ -466,7 +486,7 @@ module SibApiV3Sdk
466
486
  # Calculates hash code according to all attributes.
467
487
  # @return [Fixnum] Hash code
468
488
  def hash
469
- [tag, sender, name, html_content, html_url, template_id, scheduled_at, subject, reply_to, to_field, recipients, attachment_url, inline_image_activation, mirror_active, 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
489
+ [tag, sender, name, html_content, html_url, template_id, scheduled_at, subject, reply_to, to_field, recipients, attachment_url, inline_image_activation, mirror_active, 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
470
490
  end
471
491
 
472
492
  # Builds the object from hash