Skip to content

Commit

Permalink
CC-2795: update SDK (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
NagendraSIB authored May 29, 2024
1 parent ad2b291 commit 28ced89
Show file tree
Hide file tree
Showing 261 changed files with 13,131 additions and 1,230 deletions.
58 changes: 55 additions & 3 deletions README.md

Large diffs are not rendered by default.

5 changes: 2 additions & 3 deletions docs/Body.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Name of company |
**attributes** | **Object** | Attributes for company creation | [optional]
**country_code** | **Integer** | Country code if phone_number is passed in attributes. | [optional]
**group_name** | **String** | The name of the group of sub-accounts |
**sub_account_ids** | **Array<Integer>** | Pass the list of sub-account Ids to be included in the group | [optional]


5 changes: 2 additions & 3 deletions docs/Body1.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Name of company | [optional]
**attributes** | **Object** | Attributes for company update | [optional]
**country_code** | **Integer** | Country code if phone_number is passed in attributes. | [optional]
**group_name** | **String** | The name of the group of sub-accounts |
**sub_account_ids** | **Array<Integer>** | Pass the list of sub-account Ids to be included in the group | [optional]


14 changes: 10 additions & 4 deletions docs/Body10.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,15 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**visitor_id** | **String** | visitor’s ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> |
**text** | **String** | message text |
**agent_id** | **String** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Optional if `groupId` is set. | [optional]
**group_id** | **String** | group ID. It can be found on group’s page. Optional if `agentId` is set. | [optional]
**name** | **String** | Name of task | [optional]
**duration** | **Integer** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional]
**task_type_id** | **String** | Id for type of task e.g Call / Email / Meeting etc. | [optional]
**date** | **DateTime** | Task date/time | [optional]
**notes** | **String** | Notes added to a task | [optional]
**done** | **BOOLEAN** | Task marked as done | [optional]
**assign_to_id** | **String** | To assign a task to a user you can use either the account email or ID. | [optional]
**contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this task | [optional]
**deals_ids** | **Array<String>** | Deal ids for deals a task is linked to | [optional]
**companies_ids** | **Array<String>** | Companies ids for companies a task is linked to | [optional]


7 changes: 6 additions & 1 deletion docs/Body11.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**text** | **String** | edited message text |
**visitor_id** | **String** | visitor’s ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> |
**text** | **String** | message text |
**agent_id** | **String** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional]
**received_from** | **String** | mark your messages to distinguish messages created by you from the others. | [optional]
**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]
**agent_name** | **String** | agent name | [optional]


5 changes: 1 addition & 4 deletions docs/Body12.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**agent_id** | **String** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional]
**received_from** | **String** | mark your messages to distinguish messages created by you from the others. | [optional]
**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 Brevo organization, a dummy agent will be created automatically. | [optional]
**agent_name** | **String** | agent name. | [optional]
**text** | **String** | edited message text |


11 changes: 11 additions & 0 deletions docs/Body13.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Brevo::Body13

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**visitor_id** | **String** | visitor’s ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> |
**text** | **String** | message text |
**agent_id** | **String** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Optional if `groupId` is set. | [optional]
**group_id** | **String** | group ID. It can be found on group’s page. Optional if `agentId` is set. | [optional]


8 changes: 8 additions & 0 deletions docs/Body14.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Brevo::Body14

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**text** | **String** | edited message text |


11 changes: 11 additions & 0 deletions docs/Body15.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Brevo::Body15

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**agent_id** | **String** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional]
**received_from** | **String** | mark your messages to distinguish messages created by you from the others. | [optional]
**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 Brevo organization, a dummy agent will be created automatically. | [optional]
**agent_name** | **String** | agent name. | [optional]


5 changes: 1 addition & 4 deletions docs/Body2.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**link_contact_ids** | **Array<Integer>** | Contact ids for contacts to be linked with company | [optional]
**unlink_contact_ids** | **Array<Integer>** | Contact ids for contacts to be unlinked from company | [optional]
**link_deals_ids** | **Array<String>** | Deals ids for deals to be linked with company | [optional]
**unlink_deals_ids** | **Array<String>** | Deals ids for deals to be unlinked from company | [optional]
**sub_account_ids** | **Array<Integer>** | List of sub-account ids |


5 changes: 3 additions & 2 deletions docs/Body3.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Name of deal |
**attributes** | **Object** | Attributes for deal creation If you want to create a deal on a specific pipeline and stage you can use the following attributes `pipeline` and `deal_stage`. Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}` | [optional]
**name** | **String** | Name of company |
**attributes** | **Object** | Attributes for company creation | [optional]
**country_code** | **Integer** | Country code if phone_number is passed in attributes. | [optional]


5 changes: 3 additions & 2 deletions docs/Body4.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Name of deal | [optional]
**attributes** | **Object** | Attributes for deal update If you wish to update the pipeline of a deal you need to provide the `pipeline` and the `deal_stage`. Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}` | [optional]
**name** | **String** | Name of company | [optional]
**attributes** | **Object** | Attributes for company update | [optional]
**country_code** | **Integer** | Country code if phone_number is passed in attributes. | [optional]


8 changes: 4 additions & 4 deletions docs/Body5.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**link_contact_ids** | **Array<Integer>** | Contact ids for contacts to be linked with deal | [optional]
**unlink_contact_ids** | **Array<Integer>** | Contact ids for contacts to be unlinked from deal | [optional]
**link_company_ids** | **Array<String>** | Company ids to be linked with deal | [optional]
**unlink_company_ids** | **Array<String>** | Company ids to be unlinked from deal | [optional]
**link_contact_ids** | **Array<Integer>** | Contact ids for contacts to be linked with company | [optional]
**unlink_contact_ids** | **Array<Integer>** | Contact ids for contacts to be unlinked from company | [optional]
**link_deals_ids** | **Array<String>** | Deals ids for deals to be linked with company | [optional]
**unlink_deals_ids** | **Array<String>** | Deals ids for deals to be unlinked from company | [optional]


13 changes: 2 additions & 11 deletions docs/Body6.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Name of task |
**duration** | **Integer** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional]
**task_type_id** | **String** | Id for type of task e.g Call / Email / Meeting etc. |
**date** | **DateTime** | Task due date and time |
**notes** | **String** | Notes added to a task | [optional]
**done** | **BOOLEAN** | Task marked as done | [optional]
**assign_to_id** | **String** | User id to whom task is assigned | [optional]
**contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this task | [optional]
**deals_ids** | **Array<String>** | Deal ids for deals a task is linked to | [optional]
**companies_ids** | **Array<String>** | Companies ids for companies a task is linked to | [optional]
**reminder** | [**TaskReminder**](TaskReminder.md) | | [optional]
**name** | **String** | Name of deal |
**attributes** | **Object** | Attributes for deal creation To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID. If you want to create a deal on a specific pipeline and stage you can use the following attributes `pipeline` and `deal_stage`. Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}` | [optional]


12 changes: 2 additions & 10 deletions docs/Body7.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,7 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Name of task | [optional]
**duration** | **Integer** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional]
**task_type_id** | **String** | Id for type of task e.g Call / Email / Meeting etc. | [optional]
**date** | **DateTime** | Task date/time | [optional]
**notes** | **String** | Notes added to a task | [optional]
**done** | **BOOLEAN** | Task marked as done | [optional]
**assign_to_id** | **String** | User id to whom task is assigned | [optional]
**contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this task | [optional]
**deals_ids** | **Array<String>** | Deal ids for deals a task is linked to | [optional]
**companies_ids** | **Array<String>** | Companies ids for companies a task is linked to | [optional]
**name** | **String** | Name of deal | [optional]
**attributes** | **Object** | Attributes for deal update To assign owner of a Deal you can send attributes.deal_owner and utilize the account email or ID. If you wish to update the pipeline of a deal you need to provide the `pipeline` and the `deal_stage`. Pipeline and deal_stage are ids you can fetch using this endpoint `/crm/pipeline/details/{pipelineID}` | [optional]


10 changes: 4 additions & 6 deletions docs/Body8.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,9 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**visitor_id** | **String** | visitor’s ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a> |
**text** | **String** | message text |
**agent_id** | **String** | agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required). | [optional]
**received_from** | **String** | mark your messages to distinguish messages created by you from the others. | [optional]
**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]
**agent_name** | **String** | agent name | [optional]
**link_contact_ids** | **Array<Integer>** | Contact ids for contacts to be linked with deal | [optional]
**unlink_contact_ids** | **Array<Integer>** | Contact ids for contacts to be unlinked from deal | [optional]
**link_company_ids** | **Array<String>** | Company ids to be linked with deal | [optional]
**unlink_company_ids** | **Array<String>** | Company ids to be unlinked from deal | [optional]


12 changes: 11 additions & 1 deletion docs/Body9.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**text** | **String** | edited message text |
**name** | **String** | Name of task |
**duration** | **Integer** | Duration of task in milliseconds [1 minute = 60000 ms] | [optional]
**task_type_id** | **String** | Id for type of task e.g Call / Email / Meeting etc. |
**date** | **DateTime** | Task due date and time |
**notes** | **String** | Notes added to a task | [optional]
**done** | **BOOLEAN** | Task marked as done | [optional]
**assign_to_id** | **String** | To assign a task to a user you can use either the account email or ID. | [optional]
**contacts_ids** | **Array<Integer>** | Contact ids for contacts linked to this task | [optional]
**deals_ids** | **Array<String>** | Deal ids for deals a task is linked to | [optional]
**companies_ids** | **Array<String>** | Companies ids for companies a task is linked to | [optional]
**reminder** | [**TaskReminder**](TaskReminder.md) | | [optional]


16 changes: 8 additions & 8 deletions docs/CompaniesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ api_instance = Brevo::CompaniesApi.new

id = 'id_example' # String |

body = Brevo::Body1.new # Body1 | Updated company details.
body = Brevo::Body4.new # Body4 | Updated company details.


begin
Expand All @@ -290,7 +290,7 @@ end
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **String**| |
**body** | [**Body1**](Body1.md)| Updated company details. |
**body** | [**Body4**](Body4.md)| Updated company details. |

### Return type

Expand Down Expand Up @@ -333,7 +333,7 @@ api_instance = Brevo::CompaniesApi.new

id = 'id_example' # String |

body = Brevo::Body2.new # Body2 | Linked / Unlinked contacts and deals ids.
body = Brevo::Body5.new # Body5 | Linked / Unlinked contacts and deals ids.


begin
Expand All @@ -349,7 +349,7 @@ end
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**id** | **String**| |
**body** | [**Body2**](Body2.md)| Linked / Unlinked contacts and deals ids. |
**body** | [**Body5**](Body5.md)| Linked / Unlinked contacts and deals ids. |

### Return type

Expand All @@ -367,7 +367,7 @@ nil (empty response body)


# **companies_post**
> InlineResponse200 companies_post(body)
> InlineResponse2002 companies_post(body)
Create a company

Expand All @@ -390,7 +390,7 @@ end

api_instance = Brevo::CompaniesApi.new

body = Brevo::Body.new # Body | Company create data.
body = Brevo::Body3.new # Body3 | Company create data.


begin
Expand All @@ -406,11 +406,11 @@ end

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Body**](Body.md)| Company create data. |
**body** | [**Body3**](Body3.md)| Company create data. |

### Return type

[**InlineResponse200**](InlineResponse200.md)
[**InlineResponse2002**](InlineResponse2002.md)

### Authorization

Expand Down
Loading

0 comments on commit 28ced89

Please sign in to comment.