Class: MailchimpMarketing::DashboardApi
- Inherits:
-
Object
- Object
- MailchimpMarketing::DashboardApi
- Defined in:
- lib/MailchimpMarketing/api/dashboard_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#ads(opts = {}) ⇒ OnboardingAds
Dashboard Onboarding Ads Get all the onboarding ads info for the mobile dashboard.
-
#ads_with_http_info(opts = {}) ⇒ Array<(OnboardingAds, Fixnum, Hash)>
Dashboard Onboarding Ads Get all the onboarding ads info for the mobile dashboard.
-
#audiences(opts = {}) ⇒ Audiences
Dashboard Audiences Get all the audiences info for the mobile dashboard.
-
#audiences_with_http_info(opts = {}) ⇒ Array<(Audiences, Fixnum, Hash)>
Dashboard Audiences Get all the audiences info for the mobile dashboard.
-
#charts(opts = {}) ⇒ Charts
Dashboard Charts Get info about which dashboard charts to show for this user.
-
#charts_with_http_info(opts = {}) ⇒ Array<(Charts, Fixnum, Hash)>
Dashboard Charts Get info about which dashboard charts to show for this user.
-
#ecommerce(opts = {}) ⇒ Ecommerce
Dashboard Ecommerce Get all the ecommerce info for the mobile dashboard.
-
#ecommerce_with_http_info(opts = {}) ⇒ Array<(Ecommerce, Fixnum, Hash)>
Dashboard Ecommerce Get all the ecommerce info for the mobile dashboard.
-
#engagement(opts = {}) ⇒ DataAboutEngagement
Dashboard Engagement Get all the engagement info for the mobile dashboard.
-
#engagement_with_http_info(opts = {}) ⇒ Array<(DataAboutEngagement, Fixnum, Hash)>
Dashboard Engagement Get all the engagement info for the mobile dashboard.
-
#homepage(opts = {}) ⇒ DataForHomepage
Dashboard Homepage Get all the metrics for the Homepage.
-
#homepage_with_http_info(opts = {}) ⇒ Array<(DataForHomepage, Fixnum, Hash)>
Dashboard Homepage Get all the metrics for the Homepage.
-
#initialize(api_client) ⇒ DashboardApi
constructor
A new instance of DashboardApi.
Constructor Details
#initialize(api_client) ⇒ DashboardApi
Returns a new instance of DashboardApi.
19 20 21 |
# File 'lib/MailchimpMarketing/api/dashboard_api.rb', line 19 def initialize(api_client) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/MailchimpMarketing/api/dashboard_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#ads(opts = {}) ⇒ OnboardingAds
Dashboard Onboarding Ads Get all the onboarding ads info for the mobile dashboard
30 31 32 33 |
# File 'lib/MailchimpMarketing/api/dashboard_api.rb', line 30 def ads(opts = {}) data, _status_code, _headers = ads_with_http_info(opts) data end |
#ads_with_http_info(opts = {}) ⇒ Array<(OnboardingAds, Fixnum, Hash)>
Dashboard Onboarding Ads Get all the onboarding ads info for the mobile dashboard
43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/MailchimpMarketing/api/dashboard_api.rb', line 43 def ads_with_http_info(opts = {}) # resource path local_var_path = '/dashboard/ads' # query parameters query_params = {} query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil? query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil? query_params[:'platform'] = opts[:'platform'] if !opts[:'platform'].nil? query_params[:'num'] = opts[:'num'] if !opts[:'num'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'OnboardingAds') return data, status_code, headers end |
#audiences(opts = {}) ⇒ Audiences
Dashboard Audiences Get all the audiences info for the mobile dashboard
82 83 84 85 |
# File 'lib/MailchimpMarketing/api/dashboard_api.rb', line 82 def audiences(opts = {}) data, _status_code, _headers = audiences_with_http_info(opts) data end |
#audiences_with_http_info(opts = {}) ⇒ Array<(Audiences, Fixnum, Hash)>
Dashboard Audiences Get all the audiences info for the mobile dashboard
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 |
# File 'lib/MailchimpMarketing/api/dashboard_api.rb', line 93 def audiences_with_http_info(opts = {}) # resource path local_var_path = '/dashboard/audiences' # query parameters query_params = {} query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil? query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Audiences') return data, status_code, headers end |
#charts(opts = {}) ⇒ Charts
Dashboard Charts Get info about which dashboard charts to show for this user
130 131 132 133 |
# File 'lib/MailchimpMarketing/api/dashboard_api.rb', line 130 def charts(opts = {}) data, _status_code, _headers = charts_with_http_info(opts) data end |
#charts_with_http_info(opts = {}) ⇒ Array<(Charts, Fixnum, Hash)>
Dashboard Charts Get info about which dashboard charts to show for this user
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 |
# File 'lib/MailchimpMarketing/api/dashboard_api.rb', line 141 def charts_with_http_info(opts = {}) # resource path local_var_path = '/dashboard/charts' # query parameters query_params = {} query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil? query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Charts') return data, status_code, headers end |
#ecommerce(opts = {}) ⇒ Ecommerce
Dashboard Ecommerce Get all the ecommerce info for the mobile dashboard
178 179 180 181 |
# File 'lib/MailchimpMarketing/api/dashboard_api.rb', line 178 def ecommerce(opts = {}) data, _status_code, _headers = ecommerce_with_http_info(opts) data end |
#ecommerce_with_http_info(opts = {}) ⇒ Array<(Ecommerce, Fixnum, Hash)>
Dashboard Ecommerce Get all the ecommerce info for the mobile dashboard
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 |
# File 'lib/MailchimpMarketing/api/dashboard_api.rb', line 189 def ecommerce_with_http_info(opts = {}) # resource path local_var_path = '/dashboard/ecommerce' # query parameters query_params = {} query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil? query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Ecommerce') return data, status_code, headers end |
#engagement(opts = {}) ⇒ DataAboutEngagement
Dashboard Engagement Get all the engagement info for the mobile dashboard
226 227 228 229 |
# File 'lib/MailchimpMarketing/api/dashboard_api.rb', line 226 def engagement(opts = {}) data, _status_code, _headers = engagement_with_http_info(opts) data end |
#engagement_with_http_info(opts = {}) ⇒ Array<(DataAboutEngagement, Fixnum, Hash)>
Dashboard Engagement Get all the engagement info for the mobile dashboard
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 |
# File 'lib/MailchimpMarketing/api/dashboard_api.rb', line 237 def engagement_with_http_info(opts = {}) # resource path local_var_path = '/dashboard/engagement' # query parameters query_params = {} query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil? query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'DataAboutEngagement') return data, status_code, headers end |
#homepage(opts = {}) ⇒ DataForHomepage
Dashboard Homepage Get all the metrics for the Homepage
274 275 276 277 |
# File 'lib/MailchimpMarketing/api/dashboard_api.rb', line 274 def homepage(opts = {}) data, _status_code, _headers = homepage_with_http_info(opts) data end |
#homepage_with_http_info(opts = {}) ⇒ Array<(DataForHomepage, Fixnum, Hash)>
Dashboard Homepage Get all the metrics for the Homepage
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 |
# File 'lib/MailchimpMarketing/api/dashboard_api.rb', line 285 def homepage_with_http_info(opts = {}) # resource path local_var_path = '/dashboard/homepage' # query parameters query_params = {} query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil? query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['basicAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'DataForHomepage') return data, status_code, headers end |