MailchimpMarketing 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/MailchimpMarketing.gemspec +45 -0
- data/README.md +369 -0
- data/lib/MailchimpMarketing.rb +163 -0
- data/lib/MailchimpMarketing/api/activity_feed_api.rb +113 -0
- data/lib/MailchimpMarketing/api/authorized_apps_api.rb +171 -0
- data/lib/MailchimpMarketing/api/automations_api.rb +906 -0
- data/lib/MailchimpMarketing/api/batch_webhooks_api.rb +260 -0
- data/lib/MailchimpMarketing/api/batches_api.rb +214 -0
- data/lib/MailchimpMarketing/api/campaign_folders_api.rb +260 -0
- data/lib/MailchimpMarketing/api/campaigns_api.rb +1073 -0
- data/lib/MailchimpMarketing/api/connected_sites_api.rb +257 -0
- data/lib/MailchimpMarketing/api/conversations_api.rb +293 -0
- data/lib/MailchimpMarketing/api/dashboard_api.rb +317 -0
- data/lib/MailchimpMarketing/api/ecommerce_api.rb +3004 -0
- data/lib/MailchimpMarketing/api/external_auths_api.rb +171 -0
- data/lib/MailchimpMarketing/api/facebook_ads_api.rb +133 -0
- data/lib/MailchimpMarketing/api/file_manager_api.rb +566 -0
- data/lib/MailchimpMarketing/api/landing_pages_api.rb +399 -0
- data/lib/MailchimpMarketing/api/lists_api.rb +3457 -0
- data/lib/MailchimpMarketing/api/ping_api.rb +65 -0
- data/lib/MailchimpMarketing/api/postcards_api.rb +77 -0
- data/lib/MailchimpMarketing/api/reporting_api.rb +338 -0
- data/lib/MailchimpMarketing/api/reports_api.rb +1214 -0
- data/lib/MailchimpMarketing/api/root_api.rb +71 -0
- data/lib/MailchimpMarketing/api/search_campaigns_api.rb +74 -0
- data/lib/MailchimpMarketing/api/search_members_api.rb +77 -0
- data/lib/MailchimpMarketing/api/template_folders_api.rb +260 -0
- data/lib/MailchimpMarketing/api/templates_api.rb +331 -0
- data/lib/MailchimpMarketing/api/verified_domains_api.rb +242 -0
- data/lib/MailchimpMarketing/api_client.rb +192 -0
- data/lib/MailchimpMarketing/api_error.rb +38 -0
- data/lib/MailchimpMarketing/configuration.rb +209 -0
- data/lib/MailchimpMarketing/version.rb +15 -0
- metadata +257 -0
@@ -0,0 +1,257 @@
|
|
1
|
+
=begin
|
2
|
+
#Mailchimp Marketing API
|
3
|
+
|
4
|
+
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
5
|
+
|
6
|
+
OpenAPI spec version: 3.0.1
|
7
|
+
Contact: apihelp@mailchimp.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.12
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'uri'
|
14
|
+
|
15
|
+
module MailchimpMarketing
|
16
|
+
class ConnectedSitesApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Delete a connected site
|
23
|
+
# Remove a connected site from your Mailchimp account.
|
24
|
+
# @param connected_site_id The unique identifier for the site.
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [nil]
|
27
|
+
def remove(connected_site_id = {}, opts = {})
|
28
|
+
remove_with_http_info(connected_site_id, opts)
|
29
|
+
nil
|
30
|
+
end
|
31
|
+
|
32
|
+
# Delete a connected site
|
33
|
+
# Remove a connected site from your Mailchimp account.
|
34
|
+
# @param connected_site_id The unique identifier for the site.
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
37
|
+
def remove_with_http_info(connected_site_id, opts = {})
|
38
|
+
# resource path
|
39
|
+
local_var_path = '/connected-sites/{connected_site_id}'.sub('{' + 'connected_site_id' + '}', connected_site_id.to_s)
|
40
|
+
|
41
|
+
# query parameters
|
42
|
+
query_params = {}
|
43
|
+
|
44
|
+
# header parameters
|
45
|
+
header_params = {}
|
46
|
+
# HTTP header 'Accept' (if needed)
|
47
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
48
|
+
# HTTP header 'Content-Type'
|
49
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
50
|
+
|
51
|
+
# form parameters
|
52
|
+
form_params = {}
|
53
|
+
|
54
|
+
# http body (model)
|
55
|
+
post_body = nil
|
56
|
+
auth_names = ['basicAuth']
|
57
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
58
|
+
:header_params => header_params,
|
59
|
+
:query_params => query_params,
|
60
|
+
:form_params => form_params,
|
61
|
+
:body => post_body,
|
62
|
+
:auth_names => auth_names)
|
63
|
+
return data, status_code, headers
|
64
|
+
end
|
65
|
+
# Get all connected sites
|
66
|
+
# Get all connected sites in an account.
|
67
|
+
# @param [Hash] opts the optional parameters
|
68
|
+
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
69
|
+
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
70
|
+
# @option opts [Integer] :count The number of records to return. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **10**. [Maximum value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **1000** (default to 10)
|
71
|
+
# @option opts [Integer] :offset The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **0**. (default to 0)
|
72
|
+
# @return [ConnectedSites]
|
73
|
+
def list(opts = {})
|
74
|
+
data, _status_code, _headers = list_with_http_info(opts)
|
75
|
+
data
|
76
|
+
end
|
77
|
+
|
78
|
+
# Get all connected sites
|
79
|
+
# Get all connected sites in an account.
|
80
|
+
# @param [Hash] opts the optional parameters
|
81
|
+
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
82
|
+
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
83
|
+
# @option opts [Integer] :count The number of records to return. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **10**. [Maximum value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **1000**
|
84
|
+
# @option opts [Integer] :offset The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **0**.
|
85
|
+
# @return [Array<(ConnectedSites, Fixnum, Hash)>] ConnectedSites data, response status code and response headers
|
86
|
+
def list_with_http_info(opts = {})
|
87
|
+
# resource path
|
88
|
+
local_var_path = '/connected-sites'
|
89
|
+
|
90
|
+
# query parameters
|
91
|
+
query_params = {}
|
92
|
+
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
93
|
+
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
94
|
+
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
95
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
96
|
+
|
97
|
+
# header parameters
|
98
|
+
header_params = {}
|
99
|
+
# HTTP header 'Accept' (if needed)
|
100
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
101
|
+
# HTTP header 'Content-Type'
|
102
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
103
|
+
|
104
|
+
# form parameters
|
105
|
+
form_params = {}
|
106
|
+
|
107
|
+
# http body (model)
|
108
|
+
post_body = nil
|
109
|
+
auth_names = ['basicAuth']
|
110
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
111
|
+
:header_params => header_params,
|
112
|
+
:query_params => query_params,
|
113
|
+
:form_params => form_params,
|
114
|
+
:body => post_body,
|
115
|
+
:auth_names => auth_names,
|
116
|
+
:return_type => 'ConnectedSites')
|
117
|
+
return data, status_code, headers
|
118
|
+
end
|
119
|
+
# Get information about a specific connected site
|
120
|
+
# Get information about a specific connected site.
|
121
|
+
# @param connected_site_id The unique identifier for the site.
|
122
|
+
# @param [Hash] opts the optional parameters
|
123
|
+
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
124
|
+
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
125
|
+
# @return [ConnectedSite]
|
126
|
+
def get(connected_site_id = {}, opts = {})
|
127
|
+
data, _status_code, _headers = get_with_http_info(connected_site_id, opts)
|
128
|
+
data
|
129
|
+
end
|
130
|
+
|
131
|
+
# Get information about a specific connected site
|
132
|
+
# Get information about a specific connected site.
|
133
|
+
# @param connected_site_id The unique identifier for the site.
|
134
|
+
# @param [Hash] opts the optional parameters
|
135
|
+
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
136
|
+
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
137
|
+
# @return [Array<(ConnectedSite, Fixnum, Hash)>] ConnectedSite data, response status code and response headers
|
138
|
+
def get_with_http_info(connected_site_id, opts = {})
|
139
|
+
# resource path
|
140
|
+
local_var_path = '/connected-sites/{connected_site_id}'.sub('{' + 'connected_site_id' + '}', connected_site_id.to_s)
|
141
|
+
|
142
|
+
# query parameters
|
143
|
+
query_params = {}
|
144
|
+
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
145
|
+
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
146
|
+
|
147
|
+
# header parameters
|
148
|
+
header_params = {}
|
149
|
+
# HTTP header 'Accept' (if needed)
|
150
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
151
|
+
# HTTP header 'Content-Type'
|
152
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
153
|
+
|
154
|
+
# form parameters
|
155
|
+
form_params = {}
|
156
|
+
|
157
|
+
# http body (model)
|
158
|
+
post_body = nil
|
159
|
+
auth_names = ['basicAuth']
|
160
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
161
|
+
:header_params => header_params,
|
162
|
+
:query_params => query_params,
|
163
|
+
:form_params => form_params,
|
164
|
+
:body => post_body,
|
165
|
+
:auth_names => auth_names,
|
166
|
+
:return_type => 'ConnectedSite')
|
167
|
+
return data, status_code, headers
|
168
|
+
end
|
169
|
+
# Create a new connected site
|
170
|
+
# Create a new Mailchimp connected site.
|
171
|
+
# @param body
|
172
|
+
# @param [Hash] opts the optional parameters
|
173
|
+
# @return [ConnectedSite]
|
174
|
+
def create(body = {}, opts = {})
|
175
|
+
data, _status_code, _headers = create_with_http_info(body, opts)
|
176
|
+
data
|
177
|
+
end
|
178
|
+
|
179
|
+
# Create a new connected site
|
180
|
+
# Create a new Mailchimp connected site.
|
181
|
+
# @param body
|
182
|
+
# @param [Hash] opts the optional parameters
|
183
|
+
# @return [Array<(ConnectedSite, Fixnum, Hash)>] ConnectedSite data, response status code and response headers
|
184
|
+
def create_with_http_info(body, opts = {})
|
185
|
+
# resource path
|
186
|
+
local_var_path = '/connected-sites'
|
187
|
+
|
188
|
+
# query parameters
|
189
|
+
query_params = {}
|
190
|
+
|
191
|
+
# header parameters
|
192
|
+
header_params = {}
|
193
|
+
# HTTP header 'Accept' (if needed)
|
194
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
195
|
+
# HTTP header 'Content-Type'
|
196
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
197
|
+
|
198
|
+
# form parameters
|
199
|
+
form_params = {}
|
200
|
+
|
201
|
+
# http body (model)
|
202
|
+
post_body = @api_client.object_to_http_body(body)
|
203
|
+
auth_names = ['basicAuth']
|
204
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
205
|
+
:header_params => header_params,
|
206
|
+
:query_params => query_params,
|
207
|
+
:form_params => form_params,
|
208
|
+
:body => post_body,
|
209
|
+
:auth_names => auth_names,
|
210
|
+
:return_type => 'ConnectedSite')
|
211
|
+
return data, status_code, headers
|
212
|
+
end
|
213
|
+
# Verify script installation for a connected site
|
214
|
+
# Verify that the connected sites script has been installed, either via the script URL or fragment.
|
215
|
+
# @param connected_site_id The unique identifier for the site.
|
216
|
+
# @param [Hash] opts the optional parameters
|
217
|
+
# @return [nil]
|
218
|
+
def verify_script_installation(connected_site_id = {}, opts = {})
|
219
|
+
verify_script_installation_with_http_info(connected_site_id, opts)
|
220
|
+
nil
|
221
|
+
end
|
222
|
+
|
223
|
+
# Verify script installation for a connected site
|
224
|
+
# Verify that the connected sites script has been installed, either via the script URL or fragment.
|
225
|
+
# @param connected_site_id The unique identifier for the site.
|
226
|
+
# @param [Hash] opts the optional parameters
|
227
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
228
|
+
def verify_script_installation_with_http_info(connected_site_id, opts = {})
|
229
|
+
# resource path
|
230
|
+
local_var_path = '/connected-sites/{connected_site_id}/actions/verify-script-installation'.sub('{' + 'connected_site_id' + '}', connected_site_id.to_s)
|
231
|
+
|
232
|
+
# query parameters
|
233
|
+
query_params = {}
|
234
|
+
|
235
|
+
# header parameters
|
236
|
+
header_params = {}
|
237
|
+
# HTTP header 'Accept' (if needed)
|
238
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
239
|
+
# HTTP header 'Content-Type'
|
240
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
241
|
+
|
242
|
+
# form parameters
|
243
|
+
form_params = {}
|
244
|
+
|
245
|
+
# http body (model)
|
246
|
+
post_body = nil
|
247
|
+
auth_names = ['basicAuth']
|
248
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
249
|
+
:header_params => header_params,
|
250
|
+
:query_params => query_params,
|
251
|
+
:form_params => form_params,
|
252
|
+
:body => post_body,
|
253
|
+
:auth_names => auth_names)
|
254
|
+
return data, status_code, headers
|
255
|
+
end
|
256
|
+
end
|
257
|
+
end
|
@@ -0,0 +1,293 @@
|
|
1
|
+
=begin
|
2
|
+
#Mailchimp Marketing API
|
3
|
+
|
4
|
+
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
5
|
+
|
6
|
+
OpenAPI spec version: 3.0.1
|
7
|
+
Contact: apihelp@mailchimp.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.12
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'uri'
|
14
|
+
|
15
|
+
module MailchimpMarketing
|
16
|
+
class ConversationsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Get a list of conversations
|
23
|
+
# Get a list of conversations for the account.
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
26
|
+
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
27
|
+
# @option opts [Integer] :count The number of records to return. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **10**. [Maximum value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **1000** (default to 10)
|
28
|
+
# @option opts [Integer] :offset The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **0**. (default to 0)
|
29
|
+
# @option opts [String] :has_unread_messages Whether the conversation has any unread messages.
|
30
|
+
# @option opts [String] :list_id The unique id for the list.
|
31
|
+
# @option opts [String] :campaign_id The unique id for the campaign.
|
32
|
+
# @return [TrackedConversations]
|
33
|
+
def list(opts = {})
|
34
|
+
data, _status_code, _headers = list_with_http_info(opts)
|
35
|
+
data
|
36
|
+
end
|
37
|
+
|
38
|
+
# Get a list of conversations
|
39
|
+
# Get a list of conversations for the account.
|
40
|
+
# @param [Hash] opts the optional parameters
|
41
|
+
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
42
|
+
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
43
|
+
# @option opts [Integer] :count The number of records to return. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **10**. [Maximum value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **1000**
|
44
|
+
# @option opts [Integer] :offset The number of records from a collection to skip. Iterating over large collections with this parameter can be slow. [Default value](/developer/guides/get-started-with-mailchimp-api-3/#Parameters) is **0**.
|
45
|
+
# @option opts [String] :has_unread_messages Whether the conversation has any unread messages.
|
46
|
+
# @option opts [String] :list_id The unique id for the list.
|
47
|
+
# @option opts [String] :campaign_id The unique id for the campaign.
|
48
|
+
# @return [Array<(TrackedConversations, Fixnum, Hash)>] TrackedConversations data, response status code and response headers
|
49
|
+
def list_with_http_info(opts = {})
|
50
|
+
# resource path
|
51
|
+
local_var_path = '/conversations'
|
52
|
+
|
53
|
+
# query parameters
|
54
|
+
query_params = {}
|
55
|
+
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
56
|
+
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
57
|
+
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
58
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
59
|
+
query_params[:'has_unread_messages'] = opts[:'has_unread_messages'] if !opts[:'has_unread_messages'].nil?
|
60
|
+
query_params[:'list_id'] = opts[:'list_id'] if !opts[:'list_id'].nil?
|
61
|
+
query_params[:'campaign_id'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
|
62
|
+
|
63
|
+
# header parameters
|
64
|
+
header_params = {}
|
65
|
+
# HTTP header 'Accept' (if needed)
|
66
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
67
|
+
# HTTP header 'Content-Type'
|
68
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
69
|
+
|
70
|
+
# form parameters
|
71
|
+
form_params = {}
|
72
|
+
|
73
|
+
# http body (model)
|
74
|
+
post_body = nil
|
75
|
+
auth_names = ['basicAuth']
|
76
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
77
|
+
:header_params => header_params,
|
78
|
+
:query_params => query_params,
|
79
|
+
:form_params => form_params,
|
80
|
+
:body => post_body,
|
81
|
+
:auth_names => auth_names,
|
82
|
+
:return_type => 'TrackedConversations')
|
83
|
+
return data, status_code, headers
|
84
|
+
end
|
85
|
+
# Get information about a conversation
|
86
|
+
# Get details about an individual conversation.
|
87
|
+
# @param conversation_id The unique id for the conversation.
|
88
|
+
# @param [Hash] opts the optional parameters
|
89
|
+
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
90
|
+
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
91
|
+
# @return [Conversation]
|
92
|
+
def get(conversation_id = {}, opts = {})
|
93
|
+
data, _status_code, _headers = get_with_http_info(conversation_id, opts)
|
94
|
+
data
|
95
|
+
end
|
96
|
+
|
97
|
+
# Get information about a conversation
|
98
|
+
# Get details about an individual conversation.
|
99
|
+
# @param conversation_id The unique id for the conversation.
|
100
|
+
# @param [Hash] opts the optional parameters
|
101
|
+
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
102
|
+
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
103
|
+
# @return [Array<(Conversation, Fixnum, Hash)>] Conversation data, response status code and response headers
|
104
|
+
def get_with_http_info(conversation_id, opts = {})
|
105
|
+
# resource path
|
106
|
+
local_var_path = '/conversations/{conversation_id}'.sub('{' + 'conversation_id' + '}', conversation_id.to_s)
|
107
|
+
|
108
|
+
# query parameters
|
109
|
+
query_params = {}
|
110
|
+
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
111
|
+
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
112
|
+
|
113
|
+
# header parameters
|
114
|
+
header_params = {}
|
115
|
+
# HTTP header 'Accept' (if needed)
|
116
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
117
|
+
# HTTP header 'Content-Type'
|
118
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
119
|
+
|
120
|
+
# form parameters
|
121
|
+
form_params = {}
|
122
|
+
|
123
|
+
# http body (model)
|
124
|
+
post_body = nil
|
125
|
+
auth_names = ['basicAuth']
|
126
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
127
|
+
:header_params => header_params,
|
128
|
+
:query_params => query_params,
|
129
|
+
:form_params => form_params,
|
130
|
+
:body => post_body,
|
131
|
+
:auth_names => auth_names,
|
132
|
+
:return_type => 'Conversation')
|
133
|
+
return data, status_code, headers
|
134
|
+
end
|
135
|
+
# Get conversation messages
|
136
|
+
# Get messages from a specific conversation.
|
137
|
+
# @param conversation_id The unique id for the conversation.
|
138
|
+
# @param [Hash] opts the optional parameters
|
139
|
+
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
140
|
+
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
141
|
+
# @option opts [String] :is_read Whether a conversation message has been marked as read.
|
142
|
+
# @option opts [DateTime] :before_timestamp Restrict the response to messages created before the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
|
143
|
+
# @option opts [DateTime] :since_timestamp Restrict the response to messages created after the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
|
144
|
+
# @return [CollectionOfConversationMessages]
|
145
|
+
def get_conversation_messages(conversation_id = {}, opts = {})
|
146
|
+
data, _status_code, _headers = get_conversation_messages_with_http_info(conversation_id, opts)
|
147
|
+
data
|
148
|
+
end
|
149
|
+
|
150
|
+
# Get conversation messages
|
151
|
+
# Get messages from a specific conversation.
|
152
|
+
# @param conversation_id The unique id for the conversation.
|
153
|
+
# @param [Hash] opts the optional parameters
|
154
|
+
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
155
|
+
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
156
|
+
# @option opts [String] :is_read Whether a conversation message has been marked as read.
|
157
|
+
# @option opts [DateTime] :before_timestamp Restrict the response to messages created before the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
|
158
|
+
# @option opts [DateTime] :since_timestamp Restrict the response to messages created after the set time. We recommend [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time format: 2015-10-21T15:41:36+00:00.
|
159
|
+
# @return [Array<(CollectionOfConversationMessages, Fixnum, Hash)>] CollectionOfConversationMessages data, response status code and response headers
|
160
|
+
def get_conversation_messages_with_http_info(conversation_id, opts = {})
|
161
|
+
# resource path
|
162
|
+
local_var_path = '/conversations/{conversation_id}/messages'.sub('{' + 'conversation_id' + '}', conversation_id.to_s)
|
163
|
+
|
164
|
+
# query parameters
|
165
|
+
query_params = {}
|
166
|
+
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
167
|
+
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
168
|
+
query_params[:'is_read'] = opts[:'is_read'] if !opts[:'is_read'].nil?
|
169
|
+
query_params[:'before_timestamp'] = opts[:'before_timestamp'] if !opts[:'before_timestamp'].nil?
|
170
|
+
query_params[:'since_timestamp'] = opts[:'since_timestamp'] if !opts[:'since_timestamp'].nil?
|
171
|
+
|
172
|
+
# header parameters
|
173
|
+
header_params = {}
|
174
|
+
# HTTP header 'Accept' (if needed)
|
175
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
176
|
+
# HTTP header 'Content-Type'
|
177
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
178
|
+
|
179
|
+
# form parameters
|
180
|
+
form_params = {}
|
181
|
+
|
182
|
+
# http body (model)
|
183
|
+
post_body = nil
|
184
|
+
auth_names = ['basicAuth']
|
185
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
186
|
+
:header_params => header_params,
|
187
|
+
:query_params => query_params,
|
188
|
+
:form_params => form_params,
|
189
|
+
:body => post_body,
|
190
|
+
:auth_names => auth_names,
|
191
|
+
:return_type => 'CollectionOfConversationMessages')
|
192
|
+
return data, status_code, headers
|
193
|
+
end
|
194
|
+
# Get a specific conversation message
|
195
|
+
# Get an individual message in a conversation.
|
196
|
+
# @param conversation_id The unique id for the conversation.
|
197
|
+
# @param message_id The unique id for the conversation message.
|
198
|
+
# @param [Hash] opts the optional parameters
|
199
|
+
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
200
|
+
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
201
|
+
# @return [ConversationMessage]
|
202
|
+
def get_conversation_message(conversation_id = {}, message_id = {}, opts = {})
|
203
|
+
data, _status_code, _headers = get_conversation_message_with_http_info(conversation_id, message_id, opts)
|
204
|
+
data
|
205
|
+
end
|
206
|
+
|
207
|
+
# Get a specific conversation message
|
208
|
+
# Get an individual message in a conversation.
|
209
|
+
# @param conversation_id The unique id for the conversation.
|
210
|
+
# @param message_id The unique id for the conversation message.
|
211
|
+
# @param [Hash] opts the optional parameters
|
212
|
+
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
213
|
+
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
214
|
+
# @return [Array<(ConversationMessage, Fixnum, Hash)>] ConversationMessage data, response status code and response headers
|
215
|
+
def get_conversation_message_with_http_info(conversation_id, message_id, opts = {})
|
216
|
+
# resource path
|
217
|
+
local_var_path = '/conversations/{conversation_id}/messages/{message_id}'.sub('{' + 'conversation_id' + '}', conversation_id.to_s).sub('{' + 'message_id' + '}', message_id.to_s)
|
218
|
+
|
219
|
+
# query parameters
|
220
|
+
query_params = {}
|
221
|
+
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
222
|
+
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
223
|
+
|
224
|
+
# header parameters
|
225
|
+
header_params = {}
|
226
|
+
# HTTP header 'Accept' (if needed)
|
227
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
228
|
+
# HTTP header 'Content-Type'
|
229
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
230
|
+
|
231
|
+
# form parameters
|
232
|
+
form_params = {}
|
233
|
+
|
234
|
+
# http body (model)
|
235
|
+
post_body = nil
|
236
|
+
auth_names = ['basicAuth']
|
237
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
238
|
+
:header_params => header_params,
|
239
|
+
:query_params => query_params,
|
240
|
+
:form_params => form_params,
|
241
|
+
:body => post_body,
|
242
|
+
:auth_names => auth_names,
|
243
|
+
:return_type => 'ConversationMessage')
|
244
|
+
return data, status_code, headers
|
245
|
+
end
|
246
|
+
# Post a new conversation message
|
247
|
+
# Post a new message to a conversation.
|
248
|
+
# @param conversation_id The unique id for the conversation.
|
249
|
+
# @param body
|
250
|
+
# @param [Hash] opts the optional parameters
|
251
|
+
# @return [ConversationMessage]
|
252
|
+
def create_conversation_message(conversation_id = {}, body = {}, opts = {})
|
253
|
+
data, _status_code, _headers = create_conversation_message_with_http_info(conversation_id, body, opts)
|
254
|
+
data
|
255
|
+
end
|
256
|
+
|
257
|
+
# Post a new conversation message
|
258
|
+
# Post a new message to a conversation.
|
259
|
+
# @param conversation_id The unique id for the conversation.
|
260
|
+
# @param body
|
261
|
+
# @param [Hash] opts the optional parameters
|
262
|
+
# @return [Array<(ConversationMessage, Fixnum, Hash)>] ConversationMessage data, response status code and response headers
|
263
|
+
def create_conversation_message_with_http_info(conversation_id, body, opts = {})
|
264
|
+
# resource path
|
265
|
+
local_var_path = '/conversations/{conversation_id}/messages'.sub('{' + 'conversation_id' + '}', conversation_id.to_s)
|
266
|
+
|
267
|
+
# query parameters
|
268
|
+
query_params = {}
|
269
|
+
|
270
|
+
# header parameters
|
271
|
+
header_params = {}
|
272
|
+
# HTTP header 'Accept' (if needed)
|
273
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
274
|
+
# HTTP header 'Content-Type'
|
275
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
276
|
+
|
277
|
+
# form parameters
|
278
|
+
form_params = {}
|
279
|
+
|
280
|
+
# http body (model)
|
281
|
+
post_body = @api_client.object_to_http_body(body)
|
282
|
+
auth_names = ['basicAuth']
|
283
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
284
|
+
:header_params => header_params,
|
285
|
+
:query_params => query_params,
|
286
|
+
:form_params => form_params,
|
287
|
+
:body => post_body,
|
288
|
+
:auth_names => auth_names,
|
289
|
+
:return_type => 'ConversationMessage')
|
290
|
+
return data, status_code, headers
|
291
|
+
end
|
292
|
+
end
|
293
|
+
end
|