Skip to content

Commit

Permalink
Merge pull request #65 from sendinblue/feature_AP-2022
Browse files Browse the repository at this point in the history
AP-2022: latest update
  • Loading branch information
NagendraSIB authored Mar 2, 2022
2 parents 99de524 + c7cb2c2 commit 365dde2
Show file tree
Hide file tree
Showing 24 changed files with 637 additions and 96 deletions.
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ source 'https://rubygems.org'
gemspec

group :development, :test do
gem 'rake', '>= 12.3.3'
gem 'rake', '~> 12.3.3'
end
25 changes: 14 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,18 +89,19 @@ Class | Method | HTTP request | Description
*SibApiV3Sdk::AttributesApi* | [**delete_attribute**](docs/AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
*SibApiV3Sdk::AttributesApi* | [**get_attributes**](docs/AttributesApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
*SibApiV3Sdk::AttributesApi* | [**update_attribute**](docs/AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
*SibApiV3Sdk::CRMApi* | [**crm_files_id_data_get**](docs/CRMApi.md#crm_files_id_data_get) | **GET** /crm/files/{id}/data | Get file data by id.
*SibApiV3Sdk::CRMApi* | [**crm_files_id_delete**](docs/CRMApi.md#crm_files_id_delete) | **DELETE** /crm/files/{id} | Delete file.
*SibApiV3Sdk::CRMApi* | [**crm_files_id_get**](docs/CRMApi.md#crm_files_id_get) | **GET** /crm/files/{id} | Download file by id.
*SibApiV3Sdk::CRMApi* | [**crm_files_post**](docs/CRMApi.md#crm_files_post) | **POST** /crm/files | Upload and create file.
*SibApiV3Sdk::CRMApi* | [**crm_notes_id_delete**](docs/CRMApi.md#crm_notes_id_delete) | **DELETE** /crm/notes/{id} | Delete Note by ID
*SibApiV3Sdk::CRMApi* | [**crm_notes_id_get**](docs/CRMApi.md#crm_notes_id_get) | **GET** /crm/notes/{id} | Get one Note by ID
*SibApiV3Sdk::CRMApi* | [**crm_files_id_data_get**](docs/CRMApi.md#crm_files_id_data_get) | **GET** /crm/files/{id}/data | Get file details
*SibApiV3Sdk::CRMApi* | [**crm_files_id_delete**](docs/CRMApi.md#crm_files_id_delete) | **DELETE** /crm/files/{id} | Delete a file
*SibApiV3Sdk::CRMApi* | [**crm_files_id_get**](docs/CRMApi.md#crm_files_id_get) | **GET** /crm/files/{id} | Download a file
*SibApiV3Sdk::CRMApi* | [**crm_files_post**](docs/CRMApi.md#crm_files_post) | **POST** /crm/files | Upload a file
*SibApiV3Sdk::CRMApi* | [**crm_notes_id_delete**](docs/CRMApi.md#crm_notes_id_delete) | **DELETE** /crm/notes/{id} | Delete a note
*SibApiV3Sdk::CRMApi* | [**crm_notes_id_get**](docs/CRMApi.md#crm_notes_id_get) | **GET** /crm/notes/{id} | Get a note
*SibApiV3Sdk::CRMApi* | [**crm_notes_id_patch**](docs/CRMApi.md#crm_notes_id_patch) | **PATCH** /crm/notes/{id} | Update a note
*SibApiV3Sdk::CRMApi* | [**crm_notes_post**](docs/CRMApi.md#crm_notes_post) | **POST** /crm/notes | Create a new Note
*SibApiV3Sdk::CRMApi* | [**crm_tasks_id_delete**](docs/CRMApi.md#crm_tasks_id_delete) | **DELETE** /crm/tasks/{id} | Delete Task by id
*SibApiV3Sdk::CRMApi* | [**crm_tasks_id_get**](docs/CRMApi.md#crm_tasks_id_get) | **GET** /crm/tasks/{id} | Get one Task by ID
*SibApiV3Sdk::CRMApi* | [**crm_tasks_id_patch**](docs/CRMApi.md#crm_tasks_id_patch) | **PATCH** /crm/tasks/{id} | Update partial existing task
*SibApiV3Sdk::CRMApi* | [**crm_tasks_post**](docs/CRMApi.md#crm_tasks_post) | **POST** /crm/tasks | Create a new Task
*SibApiV3Sdk::CRMApi* | [**crm_notes_post**](docs/CRMApi.md#crm_notes_post) | **POST** /crm/notes | Create a note
*SibApiV3Sdk::CRMApi* | [**crm_tasks_id_delete**](docs/CRMApi.md#crm_tasks_id_delete) | **DELETE** /crm/tasks/{id} | Delete a task
*SibApiV3Sdk::CRMApi* | [**crm_tasks_id_get**](docs/CRMApi.md#crm_tasks_id_get) | **GET** /crm/tasks/{id} | Get a task
*SibApiV3Sdk::CRMApi* | [**crm_tasks_id_patch**](docs/CRMApi.md#crm_tasks_id_patch) | **PATCH** /crm/tasks/{id} | Update a task
*SibApiV3Sdk::CRMApi* | [**crm_tasks_post**](docs/CRMApi.md#crm_tasks_post) | **POST** /crm/tasks | Create a task
*SibApiV3Sdk::CRMApi* | [**crm_tasktypes_get**](docs/CRMApi.md#crm_tasktypes_get) | **GET** /crm/tasktypes | Get all task types
*SibApiV3Sdk::ContactsApi* | [**add_contact_to_list**](docs/ContactsApi.md#add_contact_to_list) | **POST** /contacts/lists/{listId}/contacts/add | Add existing contacts to a list
*SibApiV3Sdk::ContactsApi* | [**create_attribute**](docs/ContactsApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
*SibApiV3Sdk::ContactsApi* | [**create_contact**](docs/ContactsApi.md#create_contact) | **POST** /contacts | Create a contact
Expand Down Expand Up @@ -161,6 +162,7 @@ Class | Method | HTTP request | Description
*SibApiV3Sdk::ListsApi* | [**update_list**](docs/ListsApi.md#update_list) | **PUT** /contacts/lists/{listId} | Update a list
*SibApiV3Sdk::MasterAccountApi* | [**corporate_master_account_get**](docs/MasterAccountApi.md#corporate_master_account_get) | **GET** /corporate/masterAccount | Get the details of requested master account
*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.
*SibApiV3Sdk::MasterAccountApi* | [**corporate_sub_account_id_delete**](docs/MasterAccountApi.md#corporate_sub_account_id_delete) | **DELETE** /corporate/subAccount/{id} | Delete a sub-account
*SibApiV3Sdk::MasterAccountApi* | [**corporate_sub_account_id_get**](docs/MasterAccountApi.md#corporate_sub_account_id_get) | **GET** /corporate/subAccount/{id} | Get sub-account details
*SibApiV3Sdk::MasterAccountApi* | [**corporate_sub_account_id_plan_put**](docs/MasterAccountApi.md#corporate_sub_account_id_plan_put) | **PUT** /corporate/subAccount/{id}/plan | Update sub-account plan
*SibApiV3Sdk::MasterAccountApi* | [**corporate_sub_account_post**](docs/MasterAccountApi.md#corporate_sub_account_post) | **POST** /corporate/subAccount | Create a new sub-account under a master account.
Expand Down Expand Up @@ -429,6 +431,7 @@ Class | Method | HTTP request | Description
- [SibApiV3Sdk::SubAccountsResponseSubAccounts](docs/SubAccountsResponseSubAccounts.md)
- [SibApiV3Sdk::Task](docs/Task.md)
- [SibApiV3Sdk::TaskReminder](docs/TaskReminder.md)
- [SibApiV3Sdk::TaskTypes](docs/TaskTypes.md)
- [SibApiV3Sdk::UpdateAttribute](docs/UpdateAttribute.md)
- [SibApiV3Sdk::UpdateAttributeEnumeration](docs/UpdateAttributeEnumeration.md)
- [SibApiV3Sdk::UpdateBatchContacts](docs/UpdateBatchContacts.md)
Expand Down
118 changes: 85 additions & 33 deletions docs/CRMApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,25 @@ All URIs are relative to *https://api.sendinblue.com/v3*

Method | HTTP request | Description
------------- | ------------- | -------------
[**crm_files_id_data_get**](CRMApi.md#crm_files_id_data_get) | **GET** /crm/files/{id}/data | Get file data by id.
[**crm_files_id_delete**](CRMApi.md#crm_files_id_delete) | **DELETE** /crm/files/{id} | Delete file.
[**crm_files_id_get**](CRMApi.md#crm_files_id_get) | **GET** /crm/files/{id} | Download file by id.
[**crm_files_post**](CRMApi.md#crm_files_post) | **POST** /crm/files | Upload and create file.
[**crm_notes_id_delete**](CRMApi.md#crm_notes_id_delete) | **DELETE** /crm/notes/{id} | Delete Note by ID
[**crm_notes_id_get**](CRMApi.md#crm_notes_id_get) | **GET** /crm/notes/{id} | Get one Note by ID
[**crm_files_id_data_get**](CRMApi.md#crm_files_id_data_get) | **GET** /crm/files/{id}/data | Get file details
[**crm_files_id_delete**](CRMApi.md#crm_files_id_delete) | **DELETE** /crm/files/{id} | Delete a file
[**crm_files_id_get**](CRMApi.md#crm_files_id_get) | **GET** /crm/files/{id} | Download a file
[**crm_files_post**](CRMApi.md#crm_files_post) | **POST** /crm/files | Upload a file
[**crm_notes_id_delete**](CRMApi.md#crm_notes_id_delete) | **DELETE** /crm/notes/{id} | Delete a note
[**crm_notes_id_get**](CRMApi.md#crm_notes_id_get) | **GET** /crm/notes/{id} | Get a note
[**crm_notes_id_patch**](CRMApi.md#crm_notes_id_patch) | **PATCH** /crm/notes/{id} | Update a note
[**crm_notes_post**](CRMApi.md#crm_notes_post) | **POST** /crm/notes | Create a new Note
[**crm_tasks_id_delete**](CRMApi.md#crm_tasks_id_delete) | **DELETE** /crm/tasks/{id} | Delete Task by id
[**crm_tasks_id_get**](CRMApi.md#crm_tasks_id_get) | **GET** /crm/tasks/{id} | Get one Task by ID
[**crm_tasks_id_patch**](CRMApi.md#crm_tasks_id_patch) | **PATCH** /crm/tasks/{id} | Update partial existing task
[**crm_tasks_post**](CRMApi.md#crm_tasks_post) | **POST** /crm/tasks | Create a new Task
[**crm_notes_post**](CRMApi.md#crm_notes_post) | **POST** /crm/notes | Create a note
[**crm_tasks_id_delete**](CRMApi.md#crm_tasks_id_delete) | **DELETE** /crm/tasks/{id} | Delete a task
[**crm_tasks_id_get**](CRMApi.md#crm_tasks_id_get) | **GET** /crm/tasks/{id} | Get a task
[**crm_tasks_id_patch**](CRMApi.md#crm_tasks_id_patch) | **PATCH** /crm/tasks/{id} | Update a task
[**crm_tasks_post**](CRMApi.md#crm_tasks_post) | **POST** /crm/tasks | Create a task
[**crm_tasktypes_get**](CRMApi.md#crm_tasktypes_get) | **GET** /crm/tasktypes | Get all task types


# **crm_files_id_data_get**
> FileData crm_files_id_data_get(id)
Get file data by id.
Get file details

### Example
```ruby
Expand All @@ -46,7 +47,7 @@ id = 'id_example' # String | File id to get file data.


begin
#Get file data by id.
#Get file details
result = api_instance.crm_files_id_data_get(id)
p result
rescue SibApiV3Sdk::ApiError => e
Expand Down Expand Up @@ -78,7 +79,7 @@ Name | Type | Description | Notes
# **crm_files_id_delete**
> crm_files_id_delete(id)
Delete file.
Delete a file

### Example
```ruby
Expand All @@ -103,7 +104,7 @@ id = 'id_example' # String | File id to delete.


begin
#Delete file.
#Delete a file
api_instance.crm_files_id_delete(id)
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling CRMApi->crm_files_id_delete: #{e}"
Expand Down Expand Up @@ -134,7 +135,7 @@ nil (empty response body)
# **crm_files_id_get**
> crm_files_id_get(id)
Download file by id.
Download a file

### Example
```ruby
Expand All @@ -159,7 +160,7 @@ id = 'id_example' # String | File id to download.


begin
#Download file by id.
#Download a file
api_instance.crm_files_id_get(id)
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling CRMApi->crm_files_id_get: #{e}"
Expand Down Expand Up @@ -190,7 +191,7 @@ nil (empty response body)
# **crm_files_post**
> FileData crm_files_post(file, opts)
Upload and create file.
Upload a file

### Example
```ruby
Expand Down Expand Up @@ -218,7 +219,7 @@ opts = {
}

begin
#Upload and create file.
#Upload a file
result = api_instance.crm_files_post(file, opts)
p result
rescue SibApiV3Sdk::ApiError => e
Expand Down Expand Up @@ -251,7 +252,7 @@ Name | Type | Description | Notes
# **crm_notes_id_delete**
> crm_notes_id_delete(id)
Delete Note by ID
Delete a note

### Example
```ruby
Expand All @@ -276,7 +277,7 @@ id = 'id_example' # String | Note ID to delete


begin
#Delete Note by ID
#Delete a note
api_instance.crm_notes_id_delete(id)
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling CRMApi->crm_notes_id_delete: #{e}"
Expand Down Expand Up @@ -307,7 +308,7 @@ nil (empty response body)
# **crm_notes_id_get**
> Note crm_notes_id_get(id)
Get one Note by ID
Get a note

### Example
```ruby
Expand All @@ -332,7 +333,7 @@ id = 'id_example' # String | Note ID to get


begin
#Get one Note by ID
#Get a note
result = api_instance.crm_notes_id_get(id)
p result
rescue SibApiV3Sdk::ApiError => e
Expand Down Expand Up @@ -424,7 +425,7 @@ Name | Type | Description | Notes
# **crm_notes_post**
> Note crm_notes_post(body)
Create a new Note
Create a note

### Example
```ruby
Expand All @@ -449,7 +450,7 @@ body = SibApiV3Sdk::NoteData.new # NoteData | Note data to create a note.


begin
#Create a new Note
#Create a note
result = api_instance.crm_notes_post(body)
p result
rescue SibApiV3Sdk::ApiError => e
Expand Down Expand Up @@ -481,7 +482,7 @@ Name | Type | Description | Notes
# **crm_tasks_id_delete**
> crm_tasks_id_delete(id)
Delete Task by id
Delete a task

### Example
```ruby
Expand All @@ -506,7 +507,7 @@ id = 'id_example' # String |


begin
#Delete Task by id
#Delete a task
api_instance.crm_tasks_id_delete(id)
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling CRMApi->crm_tasks_id_delete: #{e}"
Expand Down Expand Up @@ -537,7 +538,7 @@ nil (empty response body)
# **crm_tasks_id_get**
> Task crm_tasks_id_get(id)
Get one Task by ID
Get a task

### Example
```ruby
Expand All @@ -562,7 +563,7 @@ id = 'id_example' # String |


begin
#Get one Task by ID
#Get a task
result = api_instance.crm_tasks_id_get(id)
p result
rescue SibApiV3Sdk::ApiError => e
Expand Down Expand Up @@ -594,7 +595,7 @@ Name | Type | Description | Notes
# **crm_tasks_id_patch**
> Task crm_tasks_id_patch(id, body)
Update partial existing task
Update a task

### Example
```ruby
Expand All @@ -621,7 +622,7 @@ body = SibApiV3Sdk::Body1.new # Body1 | Updated task details.


begin
#Update partial existing task
#Update a task
result = api_instance.crm_tasks_id_patch(id, body)
p result
rescue SibApiV3Sdk::ApiError => e
Expand Down Expand Up @@ -654,7 +655,7 @@ Name | Type | Description | Notes
# **crm_tasks_post**
> Task crm_tasks_post(body)
Create a new Task
Create a task

### Example
```ruby
Expand All @@ -679,7 +680,7 @@ body = SibApiV3Sdk::Body.new # Body | Task name.


begin
#Create a new Task
#Create a task
result = api_instance.crm_tasks_post(body)
p result
rescue SibApiV3Sdk::ApiError => e
Expand Down Expand Up @@ -708,3 +709,54 @@ Name | Type | Description | Notes



# **crm_tasktypes_get**
> TaskTypes crm_tasktypes_get
Get all task types

### Example
```ruby
# load the gem
require 'sib-api-v3-sdk'
# setup authorization
SibApiV3Sdk.configure do |config|
# Configure API key authorization: api-key
config.api_key['api-key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['api-key'] = 'Bearer'

# Configure API key authorization: partner-key
config.api_key['partner-key'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
#config.api_key_prefix['partner-key'] = 'Bearer'
end

api_instance = SibApiV3Sdk::CRMApi.new

begin
#Get all task types
result = api_instance.crm_tasktypes_get
p result
rescue SibApiV3Sdk::ApiError => e
puts "Exception when calling CRMApi->crm_tasktypes_get: #{e}"
end
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**TaskTypes**](TaskTypes.md)

### Authorization

[api-key](../README.md#api-key), [partner-key](../README.md#partner-key)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json



1 change: 1 addition & 0 deletions docs/CreateSubAccount.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**company_name** | **String** | Name of the organization |
**email** | **String** | Email address for the organization |
**language** | **String** | Language for identifying localization information | [optional]
**timezone** | **String** | Request timezone of the client | [optional]

Expand Down
Loading

0 comments on commit 365dde2

Please sign in to comment.