Skip to content

Commit 14bdedb

Browse files
committed
AP-756 swagger updates
1 parent 4a8e21e commit 14bdedb

File tree

84 files changed

+1416
-496
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

84 files changed

+1416
-496
lines changed

README.md

Lines changed: 66 additions & 62 deletions
Large diffs are not rendered by default.

docs/AccountApi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ All URIs are relative to *https://api.sendinblue.com/v3*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**get_account**](AccountApi.md#get_account) | **GET** /account | Get your account informations, plans and credits details
7+
[**get_account**](AccountApi.md#get_account) | **GET** /account | Get your account information, plan and credits details
88

99

1010
# **get_account**
1111
> GetAccount get_account
1212
13-
Get your account informations, plans and credits details
13+
Get your account information, plan and credits details
1414

1515
### Example
1616
```ruby
@@ -32,7 +32,7 @@ end
3232
api_instance = SibApiV3Sdk::AccountApi.new
3333

3434
begin
35-
#Get your account informations, plans and credits details
35+
#Get your account information, plan and credits details
3636
result = api_instance.get_account
3737
p result
3838
rescue SibApiV3Sdk::ApiError => e

docs/AddContactToList.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**emails** | **Array<String>** | Emails to add to a list | [optional]
6+
**emails** | **Array<String>** | Emails to add to a list. You can pass a maximum of 150 emails for addition in one request. If you need to add the emails in bulk, please prefer /contacts/import api. | [optional]
77

88

docs/AttributesApi.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@ All URIs are relative to *https://api.sendinblue.com/v3*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**create_attribute**](AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Creates contact attribute
8-
[**delete_attribute**](AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Deletes an attribute
9-
[**get_attributes**](AttributesApi.md#get_attributes) | **GET** /contacts/attributes | Lists all attributes
10-
[**update_attribute**](AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Updates contact attribute
7+
[**create_attribute**](AttributesApi.md#create_attribute) | **POST** /contacts/attributes/{attributeCategory}/{attributeName} | Create contact attribute
8+
[**delete_attribute**](AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeCategory}/{attributeName} | Delete an attribute
9+
[**get_attributes**](AttributesApi.md#get_attributes) | **GET** /contacts/attributes | List all attributes
10+
[**update_attribute**](AttributesApi.md#update_attribute) | **PUT** /contacts/attributes/{attributeCategory}/{attributeName} | Update contact attribute
1111

1212

1313
# **create_attribute**
1414
> create_attribute(attribute_category, attribute_name, create_attribute)
1515
16-
Creates contact attribute
16+
Create contact attribute
1717

1818
### Example
1919
```ruby
@@ -42,7 +42,7 @@ create_attribute = SibApiV3Sdk::CreateAttribute.new # CreateAttribute | Values t
4242

4343

4444
begin
45-
#Creates contact attribute
45+
#Create contact attribute
4646
api_instance.create_attribute(attribute_category, attribute_name, create_attribute)
4747
rescue SibApiV3Sdk::ApiError => e
4848
puts "Exception when calling AttributesApi->create_attribute: #{e}"
@@ -75,7 +75,7 @@ nil (empty response body)
7575
# **delete_attribute**
7676
> delete_attribute(attribute_category, attribute_name)
7777
78-
Deletes an attribute
78+
Delete an attribute
7979

8080
### Example
8181
```ruby
@@ -102,7 +102,7 @@ attribute_name = 'attribute_name_example' # String | Name of the existing attrib
102102

103103

104104
begin
105-
#Deletes an attribute
105+
#Delete an attribute
106106
api_instance.delete_attribute(attribute_category, attribute_name)
107107
rescue SibApiV3Sdk::ApiError => e
108108
puts "Exception when calling AttributesApi->delete_attribute: #{e}"
@@ -134,7 +134,7 @@ nil (empty response body)
134134
# **get_attributes**
135135
> GetAttributes get_attributes
136136
137-
Lists all attributes
137+
List all attributes
138138

139139
### Example
140140
```ruby
@@ -156,7 +156,7 @@ end
156156
api_instance = SibApiV3Sdk::AttributesApi.new
157157

158158
begin
159-
#Lists all attributes
159+
#List all attributes
160160
result = api_instance.get_attributes
161161
p result
162162
rescue SibApiV3Sdk::ApiError => e
@@ -185,7 +185,7 @@ This endpoint does not need any parameter.
185185
# **update_attribute**
186186
> update_attribute(attribute_category, attribute_name, update_attribute)
187187
188-
Updates contact attribute
188+
Update contact attribute
189189

190190
### Example
191191
```ruby
@@ -214,7 +214,7 @@ update_attribute = SibApiV3Sdk::UpdateAttribute.new # UpdateAttribute | Values t
214214

215215

216216
begin
217-
#Updates contact attribute
217+
#Update contact attribute
218218
api_instance.update_attribute(attribute_category, attribute_name, update_attribute)
219219
rescue SibApiV3Sdk::ApiError => e
220220
puts "Exception when calling AttributesApi->update_attribute: #{e}"

0 commit comments

Comments
 (0)