mimepost 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/README.md +144 -0
- data/Rakefile +8 -0
- data/docs/AccountProfile.md +23 -0
- data/docs/AccountProfileResponse.md +10 -0
- data/docs/AccountSettings.md +9 -0
- data/docs/AccountsApi.md +216 -0
- data/docs/ApiResponse.md +10 -0
- data/docs/ApiResponseAllWebhooks.md +10 -0
- data/docs/ApiResponseAllWebhooksData.md +13 -0
- data/docs/ApiResponseDomainsList.md +10 -0
- data/docs/ApiResponseDomainsListData.md +20 -0
- data/docs/ApiResponseEmaillogs.md +10 -0
- data/docs/ApiResponseEmaillogsData.md +12 -0
- data/docs/ApiResponseSingleWebhooks.md +10 -0
- data/docs/ApiResponseStats.md +10 -0
- data/docs/ApiResponseStatsData.md +10 -0
- data/docs/ApiResponseStatsDataDatewiseSummary.md +8 -0
- data/docs/ApiResponseStatsDataGraphSummary.md +9 -0
- data/docs/ApiResponseStatsDataTotalSummary.md +8 -0
- data/docs/ApiResponseStatsDataTotalSummaryStatus.md +9 -0
- data/docs/ApiResponseWebhooks.md +10 -0
- data/docs/ApiResponseWebhooksData.md +8 -0
- data/docs/Domain.md +8 -0
- data/docs/DomainsApi.md +427 -0
- data/docs/Email.md +17 -0
- data/docs/EmailAttachments.md +10 -0
- data/docs/EmailGlobalMergeVars.md +9 -0
- data/docs/EmailMergeVars.md +9 -0
- data/docs/EmailTo.md +9 -0
- data/docs/EmailsApi.md +63 -0
- data/docs/StatsApi.md +130 -0
- data/docs/Webhook.md +11 -0
- data/docs/Webhook1.md +11 -0
- data/docs/WebhooksApi.md +272 -0
- data/example.accounts.rb +22 -0
- data/git_push.sh +55 -0
- data/lib/mimepost.rb +71 -0
- data/lib/mimepost/api/accounts_api.rb +227 -0
- data/lib/mimepost/api/domains_api.rb +429 -0
- data/lib/mimepost/api/emails_api.rb +77 -0
- data/lib/mimepost/api/stats_api.rb +158 -0
- data/lib/mimepost/api/webhooks_api.rb +275 -0
- data/lib/mimepost/api_client.rb +391 -0
- data/lib/mimepost/api_error.rb +38 -0
- data/lib/mimepost/configuration.rb +209 -0
- data/lib/mimepost/models/account_profile.rb +325 -0
- data/lib/mimepost/models/account_profile_response.rb +203 -0
- data/lib/mimepost/models/account_settings.rb +194 -0
- data/lib/mimepost/models/api_response.rb +203 -0
- data/lib/mimepost/models/api_response_all_webhooks.rb +205 -0
- data/lib/mimepost/models/api_response_all_webhooks_data.rb +231 -0
- data/lib/mimepost/models/api_response_domains_list.rb +205 -0
- data/lib/mimepost/models/api_response_domains_list_data.rb +326 -0
- data/lib/mimepost/models/api_response_emaillogs.rb +205 -0
- data/lib/mimepost/models/api_response_emaillogs_data.rb +220 -0
- data/lib/mimepost/models/api_response_single_webhooks.rb +203 -0
- data/lib/mimepost/models/api_response_stats.rb +203 -0
- data/lib/mimepost/models/api_response_stats_data.rb +202 -0
- data/lib/mimepost/models/api_response_stats_data_datewise_summary.rb +184 -0
- data/lib/mimepost/models/api_response_stats_data_graph_summary.rb +197 -0
- data/lib/mimepost/models/api_response_stats_data_total_summary.rb +184 -0
- data/lib/mimepost/models/api_response_stats_data_total_summary_status.rb +193 -0
- data/lib/mimepost/models/api_response_webhooks.rb +203 -0
- data/lib/mimepost/models/api_response_webhooks_data.rb +184 -0
- data/lib/mimepost/models/domain.rb +189 -0
- data/lib/mimepost/models/email.rb +297 -0
- data/lib/mimepost/models/email_attachments.rb +202 -0
- data/lib/mimepost/models/email_global_merge_vars.rb +193 -0
- data/lib/mimepost/models/email_merge_vars.rb +193 -0
- data/lib/mimepost/models/email_to.rb +195 -0
- data/lib/mimepost/models/webhook.rb +223 -0
- data/lib/mimepost/models/webhook_1.rb +223 -0
- data/lib/mimepost/version.rb +15 -0
- data/mimepost.gemspec +46 -0
- data/spec/api/accounts_api_spec.rb +81 -0
- data/spec/api/domains_api_spec.rb +122 -0
- data/spec/api/emails_api_spec.rb +47 -0
- data/spec/api/stats_api_spec.rb +63 -0
- data/spec/api/webhooks_api_spec.rb +90 -0
- data/spec/api_client_spec.rb +243 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/account_profile_response_spec.rb +53 -0
- data/spec/models/account_profile_spec.rb +131 -0
- data/spec/models/account_settings_spec.rb +47 -0
- data/spec/models/api_response_all_webhooks_data_spec.rb +71 -0
- data/spec/models/api_response_all_webhooks_spec.rb +53 -0
- data/spec/models/api_response_domains_list_data_spec.rb +117 -0
- data/spec/models/api_response_domains_list_spec.rb +53 -0
- data/spec/models/api_response_emaillogs_data_spec.rb +65 -0
- data/spec/models/api_response_emaillogs_spec.rb +53 -0
- data/spec/models/api_response_single_webhooks_spec.rb +53 -0
- data/spec/models/api_response_spec.rb +53 -0
- data/spec/models/api_response_stats_data_datewise_summary_spec.rb +41 -0
- data/spec/models/api_response_stats_data_graph_summary_spec.rb +47 -0
- data/spec/models/api_response_stats_data_spec.rb +53 -0
- data/spec/models/api_response_stats_data_total_summary_spec.rb +41 -0
- data/spec/models/api_response_stats_data_total_summary_status_spec.rb +47 -0
- data/spec/models/api_response_stats_spec.rb +53 -0
- data/spec/models/api_response_webhooks_data_spec.rb +41 -0
- data/spec/models/api_response_webhooks_spec.rb +53 -0
- data/spec/models/domain_spec.rb +41 -0
- data/spec/models/email_attachments_spec.rb +53 -0
- data/spec/models/email_global_merge_vars_spec.rb +47 -0
- data/spec/models/email_merge_vars_spec.rb +47 -0
- data/spec/models/email_spec.rb +95 -0
- data/spec/models/email_to_spec.rb +47 -0
- data/spec/models/webhook_1_spec.rb +59 -0
- data/spec/models/webhook_spec.rb +59 -0
- data/spec/spec_helper.rb +111 -0
- metadata +390 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: ae7c7768fe4f047976ae66bc461dcbca625c0635d8bbdb961a0ed48d527c2497
|
4
|
+
data.tar.gz: 0f8ab68549a1ec0481519d58cc918532ea16e797649e005f7d308be15c363c84
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 85652a2e71019b6e9dab06c987a11cf296a53e2974b65338d10382ffe0ad69d69b57a82529695e8e23aec7fddd5d1716ca449162493125d0b6ea89b64ca8ac37
|
7
|
+
data.tar.gz: b649df676db60f23ff551df93d398364bff06d9eb7ddcc1e97e6ea10601599437d73924f3bf6a2af0b6b6dc81f6c94f4d4b1a2d236baddbc2119c21c4c145959
|
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,144 @@
|
|
1
|
+
# mimepost
|
2
|
+
|
3
|
+
Mimepost - the Ruby gem for the mimepost
|
4
|
+
|
5
|
+
MimePost API for sending email. You can find out more about MimePost at [https://mimepost.com](http://mimepost.com). For this sample, you can use the api key `special-key` to test the authorization filters.
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
|
+
|
9
|
+
- API version: 0.1.0
|
10
|
+
- Package version: 1.0.0
|
11
|
+
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
|
+
|
13
|
+
## Installation
|
14
|
+
|
15
|
+
### Build a gem
|
16
|
+
|
17
|
+
To build the Ruby code into a gem:
|
18
|
+
|
19
|
+
```shell
|
20
|
+
gem build mimepost.gemspec
|
21
|
+
```
|
22
|
+
|
23
|
+
Then either install the gem locally:
|
24
|
+
|
25
|
+
```shell
|
26
|
+
gem install ./mimepost-1.0.0.gem
|
27
|
+
```
|
28
|
+
(for development, run `gem install --dev ./mimepost-1.0.0.gem` to install the development dependencies)
|
29
|
+
|
30
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
|
+
|
32
|
+
Finally add this to the Gemfile:
|
33
|
+
|
34
|
+
gem 'mimepost', '~> 1.0.0'
|
35
|
+
|
36
|
+
### Install from Git
|
37
|
+
|
38
|
+
If the Ruby gem is hosted at a git repository: https://github.com/mimepost/mimepost-ruby, then add the following in the Gemfile:
|
39
|
+
|
40
|
+
gem 'mimepost', :git => 'https://github.com/mimepost/mimepost-ruby.git'
|
41
|
+
|
42
|
+
### Include the Ruby code directly
|
43
|
+
|
44
|
+
Include the Ruby code directly using `-I` as follows:
|
45
|
+
|
46
|
+
```shell
|
47
|
+
ruby -Ilib script.rb
|
48
|
+
```
|
49
|
+
|
50
|
+
## Getting Started
|
51
|
+
|
52
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
53
|
+
```ruby
|
54
|
+
# Load the gem
|
55
|
+
require 'mimepost'
|
56
|
+
|
57
|
+
# Setup authorization
|
58
|
+
Mimepost.configure do |config|
|
59
|
+
# Configure API key authorization: api_key
|
60
|
+
config.api_key['X-Auth-Token'] = 'YOUR API KEY'
|
61
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
62
|
+
#config.api_key_prefix['X-Auth-Token'] = 'Bearer'
|
63
|
+
end
|
64
|
+
|
65
|
+
api_instance = Mimepost::AccountsApi.new
|
66
|
+
|
67
|
+
begin
|
68
|
+
#Get account profile details
|
69
|
+
result = api_instance.account_profile_get
|
70
|
+
p result
|
71
|
+
rescue Mimepost::ApiError => e
|
72
|
+
puts "Exception when calling AccountsApi->account_profile_get: #{e}"
|
73
|
+
end
|
74
|
+
|
75
|
+
```
|
76
|
+
|
77
|
+
## Documentation for API Endpoints
|
78
|
+
|
79
|
+
All URIs are relative to *https://api.mimepost.com/v1/*
|
80
|
+
|
81
|
+
Class | Method | HTTP request | Description
|
82
|
+
------------ | ------------- | ------------- | -------------
|
83
|
+
*Mimepost::AccountsApi* | [**account_profile_get**](docs/AccountsApi.md#account_profile_get) | **GET** /account/profile/ | Get account profile details
|
84
|
+
*Mimepost::AccountsApi* | [**account_profile_post**](docs/AccountsApi.md#account_profile_post) | **POST** /account/profile/ | Update account profile details
|
85
|
+
*Mimepost::AccountsApi* | [**settings_get**](docs/AccountsApi.md#settings_get) | **GET** /settings/ | Get all the settings
|
86
|
+
*Mimepost::AccountsApi* | [**settings_post**](docs/AccountsApi.md#settings_post) | **POST** /settings/ | Set a setting
|
87
|
+
*Mimepost::DomainsApi* | [**domains_get**](docs/DomainsApi.md#domains_get) | **GET** /domains/ | Get a list of all the domains
|
88
|
+
*Mimepost::DomainsApi* | [**domains_id_approve_post**](docs/DomainsApi.md#domains_id_approve_post) | **POST** /domains/{id}/approve/ | Submit request for the approval of a verified domain
|
89
|
+
*Mimepost::DomainsApi* | [**domains_id_delete**](docs/DomainsApi.md#domains_id_delete) | **DELETE** /domains/{id} | Remove a single domain
|
90
|
+
*Mimepost::DomainsApi* | [**domains_id_get**](docs/DomainsApi.md#domains_id_get) | **GET** /domains/{id} | Get the details of a single domain
|
91
|
+
*Mimepost::DomainsApi* | [**domains_id_verify_dkim_post**](docs/DomainsApi.md#domains_id_verify_dkim_post) | **POST** /domains/{id}/verify_dkim/ | Request for the verification of DKIM record for a single domain
|
92
|
+
*Mimepost::DomainsApi* | [**domains_id_verify_spf_post**](docs/DomainsApi.md#domains_id_verify_spf_post) | **POST** /domains/{id}/verify_spf/ | Request for the verification of SPF record for a single domain
|
93
|
+
*Mimepost::DomainsApi* | [**domains_id_verify_tracking_post**](docs/DomainsApi.md#domains_id_verify_tracking_post) | **POST** /domains/{id}/verify_tracking/ | Request for the verification of tracking record for a single domain
|
94
|
+
*Mimepost::DomainsApi* | [**domains_post**](docs/DomainsApi.md#domains_post) | **POST** /domains/ | Add single domain
|
95
|
+
*Mimepost::EmailsApi* | [**send_email**](docs/EmailsApi.md#send_email) | **POST** /emails/ | Send email
|
96
|
+
*Mimepost::StatsApi* | [**emaillogs_get**](docs/StatsApi.md#emaillogs_get) | **GET** /emaillogs/ | Get the logs of a particular date
|
97
|
+
*Mimepost::StatsApi* | [**stats_get**](docs/StatsApi.md#stats_get) | **GET** /stats/ | Get the summary of stats for a range of dates
|
98
|
+
*Mimepost::WebhooksApi* | [**webhooks_get**](docs/WebhooksApi.md#webhooks_get) | **GET** /webhooks/ | Get the list of all the webhooks
|
99
|
+
*Mimepost::WebhooksApi* | [**webhooks_id_delete**](docs/WebhooksApi.md#webhooks_id_delete) | **DELETE** /webhooks/{id} | Remove a single webhook
|
100
|
+
*Mimepost::WebhooksApi* | [**webhooks_id_get**](docs/WebhooksApi.md#webhooks_id_get) | **GET** /webhooks/{id} | Get the details of a single webhook
|
101
|
+
*Mimepost::WebhooksApi* | [**webhooks_id_put**](docs/WebhooksApi.md#webhooks_id_put) | **PUT** /webhooks/{id} | Update the details of a single webhook
|
102
|
+
*Mimepost::WebhooksApi* | [**webhooks_post**](docs/WebhooksApi.md#webhooks_post) | **POST** /webhooks/ | Add single webhook
|
103
|
+
|
104
|
+
|
105
|
+
## Documentation for Models
|
106
|
+
|
107
|
+
- [Mimepost::AccountProfile](docs/AccountProfile.md)
|
108
|
+
- [Mimepost::AccountProfileResponse](docs/AccountProfileResponse.md)
|
109
|
+
- [Mimepost::AccountSettings](docs/AccountSettings.md)
|
110
|
+
- [Mimepost::ApiResponse](docs/ApiResponse.md)
|
111
|
+
- [Mimepost::ApiResponseAllWebhooks](docs/ApiResponseAllWebhooks.md)
|
112
|
+
- [Mimepost::ApiResponseAllWebhooksData](docs/ApiResponseAllWebhooksData.md)
|
113
|
+
- [Mimepost::ApiResponseDomainsList](docs/ApiResponseDomainsList.md)
|
114
|
+
- [Mimepost::ApiResponseDomainsListData](docs/ApiResponseDomainsListData.md)
|
115
|
+
- [Mimepost::ApiResponseEmaillogs](docs/ApiResponseEmaillogs.md)
|
116
|
+
- [Mimepost::ApiResponseEmaillogsData](docs/ApiResponseEmaillogsData.md)
|
117
|
+
- [Mimepost::ApiResponseSingleWebhooks](docs/ApiResponseSingleWebhooks.md)
|
118
|
+
- [Mimepost::ApiResponseStats](docs/ApiResponseStats.md)
|
119
|
+
- [Mimepost::ApiResponseStatsData](docs/ApiResponseStatsData.md)
|
120
|
+
- [Mimepost::ApiResponseStatsDataDatewiseSummary](docs/ApiResponseStatsDataDatewiseSummary.md)
|
121
|
+
- [Mimepost::ApiResponseStatsDataGraphSummary](docs/ApiResponseStatsDataGraphSummary.md)
|
122
|
+
- [Mimepost::ApiResponseStatsDataTotalSummary](docs/ApiResponseStatsDataTotalSummary.md)
|
123
|
+
- [Mimepost::ApiResponseStatsDataTotalSummaryStatus](docs/ApiResponseStatsDataTotalSummaryStatus.md)
|
124
|
+
- [Mimepost::ApiResponseWebhooks](docs/ApiResponseWebhooks.md)
|
125
|
+
- [Mimepost::ApiResponseWebhooksData](docs/ApiResponseWebhooksData.md)
|
126
|
+
- [Mimepost::Domain](docs/Domain.md)
|
127
|
+
- [Mimepost::Email](docs/Email.md)
|
128
|
+
- [Mimepost::EmailAttachments](docs/EmailAttachments.md)
|
129
|
+
- [Mimepost::EmailGlobalMergeVars](docs/EmailGlobalMergeVars.md)
|
130
|
+
- [Mimepost::EmailMergeVars](docs/EmailMergeVars.md)
|
131
|
+
- [Mimepost::EmailTo](docs/EmailTo.md)
|
132
|
+
- [Mimepost::Webhook](docs/Webhook.md)
|
133
|
+
- [Mimepost::Webhook1](docs/Webhook1.md)
|
134
|
+
|
135
|
+
|
136
|
+
## Documentation for Authorization
|
137
|
+
|
138
|
+
|
139
|
+
### api_key
|
140
|
+
|
141
|
+
- **Type**: API key
|
142
|
+
- **API key parameter name**: X-Auth-Token
|
143
|
+
- **Location**: HTTP header
|
144
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
# Mimepost::AccountProfile
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**first_name** | **String** | First name of the user | [optional]
|
7
|
+
**last_name** | **String** | Last name of the user | [optional]
|
8
|
+
**address** | **String** | | [optional]
|
9
|
+
**city** | **String** | | [optional]
|
10
|
+
**country** | **String** | | [optional]
|
11
|
+
**phone_number** | **String** | | [optional]
|
12
|
+
**skype_id** | **String** | | [optional]
|
13
|
+
**company_name** | **String** | | [optional]
|
14
|
+
**website** | **String** | | [optional]
|
15
|
+
**twitter_handle** | **String** | | [optional] [default to '']
|
16
|
+
**linkedin** | **String** | | [optional]
|
17
|
+
**billing_name** | **String** | | [optional]
|
18
|
+
**billing_company_name** | **String** | | [optional]
|
19
|
+
**billing_address** | **String** | | [optional]
|
20
|
+
**username** | **String** | username | [optional]
|
21
|
+
**email** | **String** | Account email address | [optional]
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Mimepost::AccountProfileResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**success** | **Integer** | Success status, 0 for failed 1 for success | [optional]
|
7
|
+
**message** | **String** | | [optional]
|
8
|
+
**data** | [**AccountProfile**](AccountProfile.md) | | [optional]
|
9
|
+
|
10
|
+
|
data/docs/AccountsApi.md
ADDED
@@ -0,0 +1,216 @@
|
|
1
|
+
# Mimepost::AccountsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.mimepost.com/v1/*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**account_profile_get**](AccountsApi.md#account_profile_get) | **GET** /account/profile/ | Get account profile details
|
8
|
+
[**account_profile_post**](AccountsApi.md#account_profile_post) | **POST** /account/profile/ | Update account profile details
|
9
|
+
[**settings_get**](AccountsApi.md#settings_get) | **GET** /settings/ | Get all the settings
|
10
|
+
[**settings_post**](AccountsApi.md#settings_post) | **POST** /settings/ | Set a setting
|
11
|
+
|
12
|
+
|
13
|
+
# **account_profile_get**
|
14
|
+
> AccountProfileResponse account_profile_get
|
15
|
+
|
16
|
+
Get account profile details
|
17
|
+
|
18
|
+
|
19
|
+
|
20
|
+
### Example
|
21
|
+
```ruby
|
22
|
+
# load the gem
|
23
|
+
require 'mimepost'
|
24
|
+
# setup authorization
|
25
|
+
Mimepost.configure do |config|
|
26
|
+
# Configure API key authorization: api_key
|
27
|
+
config.api_key['X-Auth-Token'] = 'YOUR API KEY'
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
29
|
+
#config.api_key_prefix['X-Auth-Token'] = 'Bearer'
|
30
|
+
end
|
31
|
+
|
32
|
+
api_instance = Mimepost::AccountsApi.new
|
33
|
+
|
34
|
+
begin
|
35
|
+
#Get account profile details
|
36
|
+
result = api_instance.account_profile_get
|
37
|
+
p result
|
38
|
+
rescue Mimepost::ApiError => e
|
39
|
+
puts "Exception when calling AccountsApi->account_profile_get: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Parameters
|
44
|
+
This endpoint does not need any parameter.
|
45
|
+
|
46
|
+
### Return type
|
47
|
+
|
48
|
+
[**AccountProfileResponse**](AccountProfileResponse.md)
|
49
|
+
|
50
|
+
### Authorization
|
51
|
+
|
52
|
+
[api_key](../README.md#api_key)
|
53
|
+
|
54
|
+
### HTTP request headers
|
55
|
+
|
56
|
+
- **Content-Type**: application/json
|
57
|
+
- **Accept**: application/json
|
58
|
+
|
59
|
+
|
60
|
+
|
61
|
+
# **account_profile_post**
|
62
|
+
> ApiResponse account_profile_post(body)
|
63
|
+
|
64
|
+
Update account profile details
|
65
|
+
|
66
|
+
|
67
|
+
|
68
|
+
### Example
|
69
|
+
```ruby
|
70
|
+
# load the gem
|
71
|
+
require 'mimepost'
|
72
|
+
# setup authorization
|
73
|
+
Mimepost.configure do |config|
|
74
|
+
# Configure API key authorization: api_key
|
75
|
+
config.api_key['X-Auth-Token'] = 'YOUR API KEY'
|
76
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
77
|
+
#config.api_key_prefix['X-Auth-Token'] = 'Bearer'
|
78
|
+
end
|
79
|
+
|
80
|
+
api_instance = Mimepost::AccountsApi.new
|
81
|
+
|
82
|
+
body = Mimepost::AccountProfile.new # AccountProfile |
|
83
|
+
|
84
|
+
|
85
|
+
begin
|
86
|
+
#Update account profile details
|
87
|
+
result = api_instance.account_profile_post(body)
|
88
|
+
p result
|
89
|
+
rescue Mimepost::ApiError => e
|
90
|
+
puts "Exception when calling AccountsApi->account_profile_post: #{e}"
|
91
|
+
end
|
92
|
+
```
|
93
|
+
|
94
|
+
### Parameters
|
95
|
+
|
96
|
+
Name | Type | Description | Notes
|
97
|
+
------------- | ------------- | ------------- | -------------
|
98
|
+
**body** | [**AccountProfile**](AccountProfile.md)| |
|
99
|
+
|
100
|
+
### Return type
|
101
|
+
|
102
|
+
[**ApiResponse**](ApiResponse.md)
|
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
|
+
# **settings_get**
|
116
|
+
> AccountSettings settings_get
|
117
|
+
|
118
|
+
Get all the settings
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
### Example
|
123
|
+
```ruby
|
124
|
+
# load the gem
|
125
|
+
require 'mimepost'
|
126
|
+
# setup authorization
|
127
|
+
Mimepost.configure do |config|
|
128
|
+
# Configure API key authorization: api_key
|
129
|
+
config.api_key['X-Auth-Token'] = 'YOUR API KEY'
|
130
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
131
|
+
#config.api_key_prefix['X-Auth-Token'] = 'Bearer'
|
132
|
+
end
|
133
|
+
|
134
|
+
api_instance = Mimepost::AccountsApi.new
|
135
|
+
|
136
|
+
begin
|
137
|
+
#Get all the settings
|
138
|
+
result = api_instance.settings_get
|
139
|
+
p result
|
140
|
+
rescue Mimepost::ApiError => e
|
141
|
+
puts "Exception when calling AccountsApi->settings_get: #{e}"
|
142
|
+
end
|
143
|
+
```
|
144
|
+
|
145
|
+
### Parameters
|
146
|
+
This endpoint does not need any parameter.
|
147
|
+
|
148
|
+
### Return type
|
149
|
+
|
150
|
+
[**AccountSettings**](AccountSettings.md)
|
151
|
+
|
152
|
+
### Authorization
|
153
|
+
|
154
|
+
[api_key](../README.md#api_key)
|
155
|
+
|
156
|
+
### HTTP request headers
|
157
|
+
|
158
|
+
- **Content-Type**: application/json
|
159
|
+
- **Accept**: application/json
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
# **settings_post**
|
164
|
+
> ApiResponse settings_post(body)
|
165
|
+
|
166
|
+
Set a setting
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
### Example
|
171
|
+
```ruby
|
172
|
+
# load the gem
|
173
|
+
require 'mimepost'
|
174
|
+
# setup authorization
|
175
|
+
Mimepost.configure do |config|
|
176
|
+
# Configure API key authorization: api_key
|
177
|
+
config.api_key['X-Auth-Token'] = 'YOUR API KEY'
|
178
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
179
|
+
#config.api_key_prefix['X-Auth-Token'] = 'Bearer'
|
180
|
+
end
|
181
|
+
|
182
|
+
api_instance = Mimepost::AccountsApi.new
|
183
|
+
|
184
|
+
body = Mimepost::AccountSettings.new # AccountSettings |
|
185
|
+
|
186
|
+
|
187
|
+
begin
|
188
|
+
#Set a setting
|
189
|
+
result = api_instance.settings_post(body)
|
190
|
+
p result
|
191
|
+
rescue Mimepost::ApiError => e
|
192
|
+
puts "Exception when calling AccountsApi->settings_post: #{e}"
|
193
|
+
end
|
194
|
+
```
|
195
|
+
|
196
|
+
### Parameters
|
197
|
+
|
198
|
+
Name | Type | Description | Notes
|
199
|
+
------------- | ------------- | ------------- | -------------
|
200
|
+
**body** | [**AccountSettings**](AccountSettings.md)| |
|
201
|
+
|
202
|
+
### Return type
|
203
|
+
|
204
|
+
[**ApiResponse**](ApiResponse.md)
|
205
|
+
|
206
|
+
### Authorization
|
207
|
+
|
208
|
+
[api_key](../README.md#api_key)
|
209
|
+
|
210
|
+
### HTTP request headers
|
211
|
+
|
212
|
+
- **Content-Type**: application/json
|
213
|
+
- **Accept**: application/json
|
214
|
+
|
215
|
+
|
216
|
+
|
data/docs/ApiResponse.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# Mimepost::ApiResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**success** | **Integer** | Success status, 0 for failed 1 for success | [optional]
|
7
|
+
**message** | **String** | | [optional]
|
8
|
+
**error_code** | **Integer** | | [optional]
|
9
|
+
|
10
|
+
|