MailchimpMarketing 3.0.1 → 3.0.8
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 +4 -4
- data/Gemfile +1 -1
- data/MailchimpMarketing.gemspec +1 -1
- data/README.md +55 -46
- data/lib/MailchimpMarketing.rb +5 -6
- data/lib/MailchimpMarketing/api/activity_feed_api.rb +13 -69
- data/lib/MailchimpMarketing/api/authorized_apps_api.rb +20 -113
- data/lib/MailchimpMarketing/api/automations_api.rb +130 -685
- data/lib/MailchimpMarketing/api/batch_webhooks_api.rb +33 -182
- data/lib/MailchimpMarketing/api/batches_api.rb +26 -146
- data/lib/MailchimpMarketing/api/campaign_folders_api.rb +33 -182
- data/lib/MailchimpMarketing/api/campaigns_api.rb +144 -803
- data/lib/MailchimpMarketing/api/connected_sites_api.rb +32 -179
- data/lib/MailchimpMarketing/api/conversations_api.rb +36 -205
- data/lib/MailchimpMarketing/api/dashboard_api.rb +32 -221
- data/lib/MailchimpMarketing/api/ecommerce_api.rb +447 -2312
- data/lib/MailchimpMarketing/api/external_auths_api.rb +20 -113
- data/lib/MailchimpMarketing/api/facebook_ads_api.rb +16 -83
- data/lib/MailchimpMarketing/api/file_manager_api.rb +71 -413
- data/lib/MailchimpMarketing/api/landing_pages_api.rb +51 -286
- data/lib/MailchimpMarketing/api/lists_api.rb +721 -2876
- data/lib/MailchimpMarketing/api/ping_api.rb +7 -33
- data/lib/MailchimpMarketing/api/postcards_api.rb +9 -41
- data/lib/MailchimpMarketing/api/reporting_api.rb +41 -237
- data/lib/MailchimpMarketing/api/reports_api.rb +153 -903
- data/lib/MailchimpMarketing/api/root_api.rb +7 -37
- data/lib/MailchimpMarketing/api/search_campaigns_api.rb +8 -39
- data/lib/MailchimpMarketing/api/search_members_api.rb +8 -41
- data/lib/MailchimpMarketing/api/template_folders_api.rb +33 -182
- data/lib/MailchimpMarketing/api/templates_api.rb +40 -234
- data/lib/MailchimpMarketing/api/verified_domains_api.rb +32 -170
- data/lib/MailchimpMarketing/api_client.rb +94 -64
- data/lib/MailchimpMarketing/api_error.rb +4 -4
- data/lib/MailchimpMarketing/configuration.rb +1 -1
- data/lib/MailchimpMarketing/version.rb +2 -2
- metadata +2 -2
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
5
5
|
|
6
|
-
OpenAPI spec version: 3.0.
|
6
|
+
OpenAPI spec version: 3.0.8
|
7
7
|
Contact: apihelp@mailchimp.com
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
9
|
Swagger Codegen version: 2.4.12
|
@@ -11,6 +11,7 @@ Swagger Codegen version: 2.4.12
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'uri'
|
14
|
+
require 'json'
|
14
15
|
|
15
16
|
module MailchimpMarketing
|
16
17
|
class RootApi
|
@@ -19,52 +20,21 @@ module MailchimpMarketing
|
|
19
20
|
def initialize(api_client)
|
20
21
|
@api_client = api_client
|
21
22
|
end
|
22
|
-
# API Root
|
23
|
-
# Get links to all other resources available in the API.
|
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
|
-
# @return [APIRoot]
|
28
|
-
def get_root(opts = {})
|
29
|
-
data, _status_code, _headers = get_root_with_http_info(opts)
|
30
|
-
data
|
31
|
-
end
|
32
23
|
|
33
|
-
#
|
34
|
-
|
35
|
-
# @param [Hash] opts the optional parameters
|
36
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
37
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
38
|
-
# @return [Array<(APIRoot, Fixnum, Hash)>] APIRoot data, response status code and response headers
|
39
|
-
def get_root_with_http_info(opts = {})
|
40
|
-
# resource path
|
41
|
-
local_var_path = '/'
|
24
|
+
# List api root resources
|
25
|
+
def get_root(opts = {})
|
42
26
|
|
43
|
-
# query parameters
|
44
27
|
query_params = {}
|
45
28
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
46
29
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
47
|
-
|
48
|
-
# header parameters
|
49
|
-
header_params = {}
|
50
|
-
# HTTP header 'Accept' (if needed)
|
51
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
52
|
-
# HTTP header 'Content-Type'
|
53
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
54
|
-
|
55
|
-
# form parameters
|
56
30
|
form_params = {}
|
57
|
-
|
58
|
-
# http body (model)
|
59
31
|
post_body = nil
|
60
|
-
|
32
|
+
|
33
|
+
local_var_path = '/'
|
61
34
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
62
|
-
:header_params => header_params,
|
63
35
|
:query_params => query_params,
|
64
36
|
:form_params => form_params,
|
65
|
-
:body => post_body
|
66
|
-
:auth_names => auth_names,
|
67
|
-
:return_type => 'APIRoot')
|
37
|
+
:body => post_body)
|
68
38
|
return data, status_code, headers
|
69
39
|
end
|
70
40
|
end
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
5
5
|
|
6
|
-
OpenAPI spec version: 3.0.
|
6
|
+
OpenAPI spec version: 3.0.8
|
7
7
|
Contact: apihelp@mailchimp.com
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
9
|
Swagger Codegen version: 2.4.12
|
@@ -11,6 +11,7 @@ Swagger Codegen version: 2.4.12
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'uri'
|
14
|
+
require 'json'
|
14
15
|
|
15
16
|
module MailchimpMarketing
|
16
17
|
class SearchCampaignsApi
|
@@ -19,55 +20,23 @@ module MailchimpMarketing
|
|
19
20
|
def initialize(api_client)
|
20
21
|
@api_client = api_client
|
21
22
|
end
|
22
|
-
# Search Campaigns
|
23
|
-
# Search all campaigns for the specified query terms.
|
24
|
-
# @param query The search query used to filter results.
|
25
|
-
# @param [Hash] opts the optional parameters
|
26
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
27
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
28
|
-
# @return [Campaigns]
|
29
|
-
def search(query = {}, opts = {})
|
30
|
-
data, _status_code, _headers = search_with_http_info(query, opts)
|
31
|
-
data
|
32
|
-
end
|
33
23
|
|
34
|
-
# Search
|
35
|
-
|
36
|
-
|
37
|
-
# @param [Hash] opts the optional parameters
|
38
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
39
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
40
|
-
# @return [Array<(Campaigns, Fixnum, Hash)>] Campaigns data, response status code and response headers
|
41
|
-
def search_with_http_info(query, opts = {})
|
42
|
-
# resource path
|
43
|
-
local_var_path = '/search-campaigns'
|
24
|
+
# Search campaigns
|
25
|
+
def search(query, opts = {})
|
26
|
+
fail ArgumentError, "Missing required param: 'query'" if query.nil?
|
44
27
|
|
45
|
-
# query parameters
|
46
28
|
query_params = {}
|
47
29
|
query_params[:'query'] = query
|
48
30
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
49
31
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
50
|
-
|
51
|
-
# header parameters
|
52
|
-
header_params = {}
|
53
|
-
# HTTP header 'Accept' (if needed)
|
54
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
55
|
-
# HTTP header 'Content-Type'
|
56
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
57
|
-
|
58
|
-
# form parameters
|
59
32
|
form_params = {}
|
60
|
-
|
61
|
-
# http body (model)
|
62
33
|
post_body = nil
|
63
|
-
|
34
|
+
|
35
|
+
local_var_path = '/search-campaigns'
|
64
36
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
65
|
-
:header_params => header_params,
|
66
37
|
:query_params => query_params,
|
67
38
|
:form_params => form_params,
|
68
|
-
:body => post_body
|
69
|
-
:auth_names => auth_names,
|
70
|
-
:return_type => 'Campaigns')
|
39
|
+
:body => post_body)
|
71
40
|
return data, status_code, headers
|
72
41
|
end
|
73
42
|
end
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
5
5
|
|
6
|
-
OpenAPI spec version: 3.0.
|
6
|
+
OpenAPI spec version: 3.0.8
|
7
7
|
Contact: apihelp@mailchimp.com
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
9
|
Swagger Codegen version: 2.4.12
|
@@ -11,6 +11,7 @@ Swagger Codegen version: 2.4.12
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'uri'
|
14
|
+
require 'json'
|
14
15
|
|
15
16
|
module MailchimpMarketing
|
16
17
|
class SearchMembersApi
|
@@ -19,58 +20,24 @@ module MailchimpMarketing
|
|
19
20
|
def initialize(api_client)
|
20
21
|
@api_client = api_client
|
21
22
|
end
|
22
|
-
# Search Members
|
23
|
-
# Search for list members. This search can be restricted to a specific list, or can be used to search across all lists in an account.
|
24
|
-
# @param query The search query used to filter results.
|
25
|
-
# @param [Hash] opts the optional parameters
|
26
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
27
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
28
|
-
# @option opts [String] :list_id The unique id for the list.
|
29
|
-
# @return [Members]
|
30
|
-
def search(query = {}, opts = {})
|
31
|
-
data, _status_code, _headers = search_with_http_info(query, opts)
|
32
|
-
data
|
33
|
-
end
|
34
23
|
|
35
|
-
# Search
|
36
|
-
|
37
|
-
|
38
|
-
# @param [Hash] opts the optional parameters
|
39
|
-
# @option opts [Array<String>] :fields A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
|
40
|
-
# @option opts [Array<String>] :exclude_fields A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.
|
41
|
-
# @option opts [String] :list_id The unique id for the list.
|
42
|
-
# @return [Array<(Members, Fixnum, Hash)>] Members data, response status code and response headers
|
43
|
-
def search_with_http_info(query, opts = {})
|
44
|
-
# resource path
|
45
|
-
local_var_path = '/search-members'
|
24
|
+
# Search members
|
25
|
+
def search(query, opts = {})
|
26
|
+
fail ArgumentError, "Missing required param: 'query'" if query.nil?
|
46
27
|
|
47
|
-
# query parameters
|
48
28
|
query_params = {}
|
49
29
|
query_params[:'query'] = query
|
50
30
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
51
31
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
52
32
|
query_params[:'list_id'] = opts[:'list_id'] if !opts[:'list_id'].nil?
|
53
|
-
|
54
|
-
# header parameters
|
55
|
-
header_params = {}
|
56
|
-
# HTTP header 'Accept' (if needed)
|
57
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
58
|
-
# HTTP header 'Content-Type'
|
59
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
60
|
-
|
61
|
-
# form parameters
|
62
33
|
form_params = {}
|
63
|
-
|
64
|
-
# http body (model)
|
65
34
|
post_body = nil
|
66
|
-
|
35
|
+
|
36
|
+
local_var_path = '/search-members'
|
67
37
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
68
|
-
:header_params => header_params,
|
69
38
|
:query_params => query_params,
|
70
39
|
:form_params => form_params,
|
71
|
-
:body => post_body
|
72
|
-
:auth_names => auth_names,
|
73
|
-
:return_type => 'Members')
|
40
|
+
:body => post_body)
|
74
41
|
return data, status_code, headers
|
75
42
|
end
|
76
43
|
end
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
5
5
|
|
6
|
-
OpenAPI spec version: 3.0.
|
6
|
+
OpenAPI spec version: 3.0.8
|
7
7
|
Contact: apihelp@mailchimp.com
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
9
|
Swagger Codegen version: 2.4.12
|
@@ -11,6 +11,7 @@ Swagger Codegen version: 2.4.12
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
require 'uri'
|
14
|
+
require 'json'
|
14
15
|
|
15
16
|
module MailchimpMarketing
|
16
17
|
class TemplateFoldersApi
|
@@ -19,241 +20,91 @@ module MailchimpMarketing
|
|
19
20
|
def initialize(api_client)
|
20
21
|
@api_client = api_client
|
21
22
|
end
|
22
|
-
# Delete a template folder
|
23
|
-
# Delete a specific template folder, and mark all the templates in the folder as 'unfiled'.
|
24
|
-
# @param folder_id The unique id for the template folder.
|
25
|
-
# @param [Hash] opts the optional parameters
|
26
|
-
# @return [nil]
|
27
|
-
def remove(folder_id = {}, opts = {})
|
28
|
-
remove_with_http_info(folder_id, opts)
|
29
|
-
nil
|
30
|
-
end
|
31
23
|
|
32
|
-
# Delete
|
33
|
-
|
34
|
-
|
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(folder_id, opts = {})
|
38
|
-
# resource path
|
39
|
-
local_var_path = '/template-folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_id.to_s)
|
24
|
+
# Delete template folder
|
25
|
+
def remove(folder_id, opts = {})
|
26
|
+
fail ArgumentError, "Missing required param: 'folder_id'" if folder_id.nil?
|
40
27
|
|
41
|
-
# query parameters
|
42
28
|
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
29
|
form_params = {}
|
53
|
-
|
54
|
-
# http body (model)
|
55
30
|
post_body = nil
|
56
|
-
|
31
|
+
|
32
|
+
local_var_path = '/template-folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_id.to_s)
|
57
33
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
58
|
-
:header_params => header_params,
|
59
34
|
:query_params => query_params,
|
60
35
|
:form_params => form_params,
|
61
|
-
:body => post_body
|
62
|
-
:auth_names => auth_names)
|
36
|
+
:body => post_body)
|
63
37
|
return data, status_code, headers
|
64
38
|
end
|
65
|
-
# Get all template folders
|
66
|
-
# Get all folders used to organize templates.
|
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 [TemplateFolders]
|
73
|
-
def list(opts = {})
|
74
|
-
data, _status_code, _headers = list_with_http_info(opts)
|
75
|
-
data
|
76
|
-
end
|
77
39
|
|
78
|
-
#
|
79
|
-
|
80
|
-
|
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<(TemplateFolders, Fixnum, Hash)>] TemplateFolders data, response status code and response headers
|
86
|
-
def list_with_http_info(opts = {})
|
87
|
-
# resource path
|
88
|
-
local_var_path = '/template-folders'
|
40
|
+
# List template folders
|
41
|
+
def list(opts = {})
|
42
|
+
fail ArgumentError, 'invalid value for "opts[:"count"]", must be smaller than or equal to 1000.' if !opts[:'count'].nil? && opts[:'count'] > 1000
|
89
43
|
|
90
|
-
# query parameters
|
91
44
|
query_params = {}
|
92
45
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
93
46
|
query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :csv) if !opts[:'exclude_fields'].nil?
|
94
47
|
query_params[:'count'] = opts[:'count'] if !opts[:'count'].nil?
|
95
48
|
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
49
|
form_params = {}
|
106
|
-
|
107
|
-
# http body (model)
|
108
50
|
post_body = nil
|
109
|
-
|
51
|
+
|
52
|
+
local_var_path = '/template-folders'
|
110
53
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
111
|
-
:header_params => header_params,
|
112
54
|
:query_params => query_params,
|
113
55
|
:form_params => form_params,
|
114
|
-
:body => post_body
|
115
|
-
:auth_names => auth_names,
|
116
|
-
:return_type => 'TemplateFolders')
|
56
|
+
:body => post_body)
|
117
57
|
return data, status_code, headers
|
118
58
|
end
|
119
|
-
# Get a template folder
|
120
|
-
# Get information about a specific folder used to organize templates.
|
121
|
-
# @param folder_id The unique id for the template folder.
|
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 [TemplateFolder]
|
126
|
-
def get(folder_id = {}, opts = {})
|
127
|
-
data, _status_code, _headers = get_with_http_info(folder_id, opts)
|
128
|
-
data
|
129
|
-
end
|
130
59
|
|
131
|
-
# Get
|
132
|
-
|
133
|
-
|
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<(TemplateFolder, Fixnum, Hash)>] TemplateFolder data, response status code and response headers
|
138
|
-
def get_with_http_info(folder_id, opts = {})
|
139
|
-
# resource path
|
140
|
-
local_var_path = '/template-folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_id.to_s)
|
60
|
+
# Get template folder
|
61
|
+
def get(folder_id, opts = {})
|
62
|
+
fail ArgumentError, "Missing required param: 'folder_id'" if folder_id.nil?
|
141
63
|
|
142
|
-
# query parameters
|
143
64
|
query_params = {}
|
144
65
|
query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
|
145
66
|
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
67
|
form_params = {}
|
156
|
-
|
157
|
-
# http body (model)
|
158
68
|
post_body = nil
|
159
|
-
|
69
|
+
|
70
|
+
local_var_path = '/template-folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_id.to_s)
|
160
71
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
161
|
-
:header_params => header_params,
|
162
72
|
:query_params => query_params,
|
163
73
|
:form_params => form_params,
|
164
|
-
:body => post_body
|
165
|
-
:auth_names => auth_names,
|
166
|
-
:return_type => 'TemplateFolder')
|
74
|
+
:body => post_body)
|
167
75
|
return data, status_code, headers
|
168
76
|
end
|
169
|
-
# Update a template folder
|
170
|
-
# Update a specific folder used to organize templates.
|
171
|
-
# @param folder_id The unique id for the template folder.
|
172
|
-
# @param body
|
173
|
-
# @param [Hash] opts the optional parameters
|
174
|
-
# @return [TemplateFolder]
|
175
|
-
def update(folder_id = {}, body = {}, opts = {})
|
176
|
-
data, _status_code, _headers = update_with_http_info(folder_id, body, opts)
|
177
|
-
data
|
178
|
-
end
|
179
77
|
|
180
|
-
# Update
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
# @param [Hash] opts the optional parameters
|
185
|
-
# @return [Array<(TemplateFolder, Fixnum, Hash)>] TemplateFolder data, response status code and response headers
|
186
|
-
def update_with_http_info(folder_id, body, opts = {})
|
187
|
-
# resource path
|
188
|
-
local_var_path = '/template-folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_id.to_s)
|
78
|
+
# Update template folder
|
79
|
+
def update(folder_id, body, opts = {})
|
80
|
+
fail ArgumentError, "Missing required param: 'folder_id'" if folder_id.nil?
|
81
|
+
fail ArgumentError, "Missing required param: 'body'" if body.nil?
|
189
82
|
|
190
|
-
# query parameters
|
191
83
|
query_params = {}
|
192
|
-
|
193
|
-
# header parameters
|
194
|
-
header_params = {}
|
195
|
-
# HTTP header 'Accept' (if needed)
|
196
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
197
|
-
# HTTP header 'Content-Type'
|
198
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
199
|
-
|
200
|
-
# form parameters
|
201
84
|
form_params = {}
|
202
|
-
|
203
|
-
# http body (model)
|
204
85
|
post_body = @api_client.object_to_http_body(body)
|
205
|
-
|
86
|
+
|
87
|
+
local_var_path = '/template-folders/{folder_id}'.sub('{' + 'folder_id' + '}', folder_id.to_s)
|
206
88
|
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
|
207
|
-
:header_params => header_params,
|
208
89
|
:query_params => query_params,
|
209
90
|
:form_params => form_params,
|
210
|
-
:body => post_body
|
211
|
-
:auth_names => auth_names,
|
212
|
-
:return_type => 'TemplateFolder')
|
91
|
+
:body => post_body)
|
213
92
|
return data, status_code, headers
|
214
93
|
end
|
215
|
-
# Create a template folder
|
216
|
-
# Create a new template folder.
|
217
|
-
# @param body
|
218
|
-
# @param [Hash] opts the optional parameters
|
219
|
-
# @return [TemplateFolder]
|
220
|
-
def create(body = {}, opts = {})
|
221
|
-
data, _status_code, _headers = create_with_http_info(body, opts)
|
222
|
-
data
|
223
|
-
end
|
224
94
|
|
225
|
-
#
|
226
|
-
|
227
|
-
|
228
|
-
# @param [Hash] opts the optional parameters
|
229
|
-
# @return [Array<(TemplateFolder, Fixnum, Hash)>] TemplateFolder data, response status code and response headers
|
230
|
-
def create_with_http_info(body, opts = {})
|
231
|
-
# resource path
|
232
|
-
local_var_path = '/template-folders'
|
95
|
+
# Add template folder
|
96
|
+
def create(body, opts = {})
|
97
|
+
fail ArgumentError, "Missing required param: 'body'" if body.nil?
|
233
98
|
|
234
|
-
# query parameters
|
235
99
|
query_params = {}
|
236
|
-
|
237
|
-
# header parameters
|
238
|
-
header_params = {}
|
239
|
-
# HTTP header 'Accept' (if needed)
|
240
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
|
241
|
-
# HTTP header 'Content-Type'
|
242
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
243
|
-
|
244
|
-
# form parameters
|
245
100
|
form_params = {}
|
246
|
-
|
247
|
-
# http body (model)
|
248
101
|
post_body = @api_client.object_to_http_body(body)
|
249
|
-
|
102
|
+
|
103
|
+
local_var_path = '/template-folders'
|
250
104
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
251
|
-
:header_params => header_params,
|
252
105
|
:query_params => query_params,
|
253
106
|
:form_params => form_params,
|
254
|
-
:body => post_body
|
255
|
-
:auth_names => auth_names,
|
256
|
-
:return_type => 'TemplateFolder')
|
107
|
+
:body => post_body)
|
257
108
|
return data, status_code, headers
|
258
109
|
end
|
259
110
|
end
|