Skip to content

Commit 06bdf2d

Browse files
Aakanksha SharmaAakanksha Sharma
Aakanksha Sharma
authored and
Aakanksha Sharma
committed
Initial release of SendinBlue API V3 Ruby Package
1 parent 10067d2 commit 06bdf2d

File tree

489 files changed

+60174
-1
lines changed

Some content is hidden

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

489 files changed

+60174
-1
lines changed

‎.gitignore

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Generated by: https://github.com/swagger-api/swagger-codegen.git
2+
#
3+
4+
*.gem
5+
*.rbc
6+
/.config
7+
/coverage/
8+
/InstalledFiles
9+
/pkg/
10+
/spec/reports/
11+
/spec/examples.txt
12+
/test/tmp/
13+
/test/version_tmp/
14+
/tmp/
15+
16+
## Specific to RubyMotion:
17+
.dat*
18+
.repl_history
19+
build/
20+
21+
## Documentation cache and generated files:
22+
/.yardoc/
23+
/_yardoc/
24+
/doc/
25+
/rdoc/
26+
27+
## Environment normalization:
28+
/.bundle/
29+
/vendor/bundle
30+
/lib/bundler/man/
31+
32+
# for a library or gem, you might want to ignore these files since the code is
33+
# intended to run in multiple environments; otherwise, check them in:
34+
# Gemfile.lock
35+
# .ruby-version
36+
# .ruby-gemset
37+
38+
# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
39+
.rvmrc

‎.rspec

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
--color
2+
--require spec_helper

‎.swagger-codegen-ignore

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Swagger Codegen Ignore
2+
# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
3+
4+
# Use this file to prevent files from being overwritten by the generator.
5+
# The patterns follow closely to .gitignore or .dockerignore.
6+
7+
# As an example, the C# client generator defines ApiClient.cs.
8+
# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
9+
#ApiClient.cs
10+
11+
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
12+
#foo/*/qux
13+
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14+
15+
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16+
#foo/**/qux
17+
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18+
19+
# You can also negate patterns with an exclamation (!).
20+
# For example, you can ignore all files in a docs folder with the file extension .md:
21+
#docs/*.md
22+
# Then explicitly reverse the ignore rule for a single file:
23+
#!docs/README.md

‎.swagger-codegen/VERSION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2.2.3

‎Gemfile

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
source 'https://rubygems.org'
2+
3+
gemspec
4+
5+
group :development, :test do
6+
gem 'rake', '~> 12.0.0'
7+
end

‎LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2017 SendinBlue
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

‎README.md

Lines changed: 352 additions & 1 deletion
Large diffs are not rendered by default.

‎Rakefile

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
begin
2+
require 'rspec/core/rake_task'
3+
4+
RSpec::Core::RakeTask.new(:spec)
5+
task default: :spec
6+
rescue LoadError
7+
# no rspec available
8+
end

‎docs/AccountApi.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# SendinblueApiv3::AccountApi
2+
3+
All URIs are relative to *https://api.sendinblue.com/v3*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**get_account**](AccountApi.md#get_account) | **GET** /account | Get your account informations, plans and credits details
8+
9+
10+
# **get_account**
11+
> GetAccount get_account
12+
13+
Get your account informations, plans and credits details
14+
15+
### Example
16+
```ruby
17+
# load the gem
18+
require 'sendinblue-apiv3'
19+
# setup authorization
20+
SendinblueApiv3.configure do |config|
21+
# Configure API key authorization: api-key
22+
config.api_key['api-key'] = 'YOUR API KEY'
23+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
24+
#config.api_key_prefix['api-key'] = 'Bearer'
25+
end
26+
27+
api_instance = SendinblueApiv3::AccountApi.new
28+
29+
begin
30+
#Get your account informations, plans and credits details
31+
result = api_instance.get_account
32+
p result
33+
rescue SendinblueApiv3::ApiError => e
34+
puts "Exception when calling AccountApi->get_account: #{e}"
35+
end
36+
```
37+
38+
### Parameters
39+
This endpoint does not need any parameter.
40+
41+
### Return type
42+
43+
[**GetAccount**](GetAccount.md)
44+
45+
### Authorization
46+
47+
[api-key](../README.md#api-key)
48+
49+
### HTTP request headers
50+
51+
- **Content-Type**: application/json
52+
- **Accept**: application/json
53+
54+
55+

‎docs/AddCredits.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# SendinblueApiv3::AddCredits
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**sms** | **Integer** | SMS credits to be added to the child account | [optional]
7+
**email** | **Integer** | Email credits to be added to the child account | [optional]
8+
9+

‎docs/AddRemoveContactToList.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# SendinblueApiv3::AddRemoveContactToList
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**emails** | **Array&lt;String&gt;** | Emails to add or remove from a list | [optional]
7+
8+

‎docs/AttributesApi.md

Lines changed: 160 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,160 @@
1+
# SendinblueApiv3::AttributesApi
2+
3+
All URIs are relative to *https://api.sendinblue.com/v3*
4+
5+
Method | HTTP request | Description
6+
------------- | ------------- | -------------
7+
[**create_attribute**](AttributesApi.md#create_attribute) | **POST** /contacts/attributes | Creates contact attributes
8+
[**delete_attribute**](AttributesApi.md#delete_attribute) | **DELETE** /contacts/attributes/{attributeId} | Deletes an attribute
9+
[**get_attributes**](AttributesApi.md#get_attributes) | **GET** /contacts/attributes | Lists all attributes
10+
11+
12+
# **create_attribute**
13+
> CreateModel create_attribute(create_attribute)
14+
15+
Creates contact attributes
16+
17+
### Example
18+
```ruby
19+
# load the gem
20+
require 'sendinblue-apiv3'
21+
# setup authorization
22+
SendinblueApiv3.configure do |config|
23+
# Configure API key authorization: api-key
24+
config.api_key['api-key'] = 'YOUR API KEY'
25+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
26+
#config.api_key_prefix['api-key'] = 'Bearer'
27+
end
28+
29+
api_instance = SendinblueApiv3::AttributesApi.new
30+
31+
create_attribute = SendinblueApiv3::CreateAttribute.new # CreateAttribute | Values to create an attribute
32+
33+
34+
begin
35+
#Creates contact attributes
36+
result = api_instance.create_attribute(create_attribute)
37+
p result
38+
rescue SendinblueApiv3::ApiError => e
39+
puts "Exception when calling AttributesApi->create_attribute: #{e}"
40+
end
41+
```
42+
43+
### Parameters
44+
45+
Name | Type | Description | Notes
46+
------------- | ------------- | ------------- | -------------
47+
**create_attribute** | [**CreateAttribute**](CreateAttribute.md)| Values to create an attribute |
48+
49+
### Return type
50+
51+
[**CreateModel**](CreateModel.md)
52+
53+
### Authorization
54+
55+
[api-key](../README.md#api-key)
56+
57+
### HTTP request headers
58+
59+
- **Content-Type**: application/json
60+
- **Accept**: application/json
61+
62+
63+
64+
# **delete_attribute**
65+
> delete_attribute(attribute_id)
66+
67+
Deletes an attribute
68+
69+
### Example
70+
```ruby
71+
# load the gem
72+
require 'sendinblue-apiv3'
73+
# setup authorization
74+
SendinblueApiv3.configure do |config|
75+
# Configure API key authorization: api-key
76+
config.api_key['api-key'] = 'YOUR API KEY'
77+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
78+
#config.api_key_prefix['api-key'] = 'Bearer'
79+
end
80+
81+
api_instance = SendinblueApiv3::AttributesApi.new
82+
83+
attribute_id = "attribute_id_example" # String | id of the attribute
84+
85+
86+
begin
87+
#Deletes an attribute
88+
api_instance.delete_attribute(attribute_id)
89+
rescue SendinblueApiv3::ApiError => e
90+
puts "Exception when calling AttributesApi->delete_attribute: #{e}"
91+
end
92+
```
93+
94+
### Parameters
95+
96+
Name | Type | Description | Notes
97+
------------- | ------------- | ------------- | -------------
98+
**attribute_id** | **String**| id of the attribute |
99+
100+
### Return type
101+
102+
nil (empty response body)
103+
104+
### Authorization
105+
106+
[api-key](../README.md#api-key)
107+
108+
### HTTP request headers
109+
110+
- **Content-Type**: application/json
111+
- **Accept**: application/json
112+
113+
114+
115+
# **get_attributes**
116+
> GetAttributes get_attributes
117+
118+
Lists all attributes
119+
120+
### Example
121+
```ruby
122+
# load the gem
123+
require 'sendinblue-apiv3'
124+
# setup authorization
125+
SendinblueApiv3.configure do |config|
126+
# Configure API key authorization: api-key
127+
config.api_key['api-key'] = 'YOUR API KEY'
128+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
129+
#config.api_key_prefix['api-key'] = 'Bearer'
130+
end
131+
132+
api_instance = SendinblueApiv3::AttributesApi.new
133+
134+
begin
135+
#Lists all attributes
136+
result = api_instance.get_attributes
137+
p result
138+
rescue SendinblueApiv3::ApiError => e
139+
puts "Exception when calling AttributesApi->get_attributes: #{e}"
140+
end
141+
```
142+
143+
### Parameters
144+
This endpoint does not need any parameter.
145+
146+
### Return type
147+
148+
[**GetAttributes**](GetAttributes.md)
149+
150+
### Authorization
151+
152+
[api-key](../README.md#api-key)
153+
154+
### HTTP request headers
155+
156+
- **Content-Type**: application/json
157+
- **Accept**: application/json
158+
159+
160+

0 commit comments

Comments
 (0)