Class: BombBomb::ListsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bombbomb/api/lists_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ListsApi

Returns a new instance of ListsApi.



30
31
32
 
# File 'lib/bombbomb/api/lists_api.rb', line 30

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



28
29
30
 
# File 'lib/bombbomb/api/lists_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#clear_list(list_id, opts = {}) ⇒ nil

Clear Contacts from List Clears all contacts from a list.

Parameters:

  • list_id —

    The list to be cleared.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


39
40
41
42
 
# File 'lib/bombbomb/api/lists_api.rb', line 39

def clear_list(list_id, opts = {})
  clear_list_with_http_info(list_id, opts)
  return nil
end

#clear_list_with_http_info(list_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Clear Contacts from List Clears all contacts from a list.

Parameters:

  • list_id —

    The list to be cleared.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



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
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/bombbomb/api/lists_api.rb', line 49

def clear_list_with_http_info(list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ListsApi.clear_list ..."
  end
  # verify the required parameter 'list_id' is set
  fail ArgumentError, "Missing the required parameter 'list_id' when calling ListsApi.clear_list" if list_id.nil?
  # resource path
  local_var_path = "/lists/{listId}/clear".sub('{format}','json').sub('{' + 'listId' + '}', list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/x-www-form-urlencoded']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ListsApi#clear_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#copy_list_contacts(from_list_id, list_id, opts = {}) ⇒ nil

Copy All Contacts from a List Copy all contacts from a list.

Parameters:

  • from_list_id —

    The list to be cleared.

  • list_id —

    The list to be cleared.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


96
97
98
99
 
# File 'lib/bombbomb/api/lists_api.rb', line 96

def copy_list_contacts(from_list_id, list_id, opts = {})
  copy_list_contacts_with_http_info(from_list_id, list_id, opts)
  return nil
end

#copy_list_contacts_with_http_info(from_list_id, list_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Copy All Contacts from a List Copy all contacts from a list.

Parameters:

  • from_list_id —

    The list to be cleared.

  • list_id —

    The list to be cleared.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/bombbomb/api/lists_api.rb', line 107

def copy_list_contacts_with_http_info(from_list_id, list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ListsApi.copy_list_contacts ..."
  end
  # verify the required parameter 'from_list_id' is set
  fail ArgumentError, "Missing the required parameter 'from_list_id' when calling ListsApi.copy_list_contacts" if from_list_id.nil?
  # verify the required parameter 'list_id' is set
  fail ArgumentError, "Missing the required parameter 'list_id' when calling ListsApi.copy_list_contacts" if list_id.nil?
  # resource path
  local_var_path = "/lists/{listId}/copy".sub('{format}','json').sub('{' + 'listId' + '}', list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/x-www-form-urlencoded']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  form_params["fromListId"] = from_list_id

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ListsApi#copy_list_contacts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#suppress_all_in_list(list_id, opts = {}) ⇒ nil

Suppress All Contacts from List Suppresses all contacts in a list.

Parameters:

  • list_id —

    The list to be cleared.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


156
157
158
159
 
# File 'lib/bombbomb/api/lists_api.rb', line 156

def suppress_all_in_list(list_id, opts = {})
  suppress_all_in_list_with_http_info(list_id, opts)
  return nil
end

#suppress_all_in_list_with_http_info(list_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Suppress All Contacts from List Suppresses all contacts in a list.

Parameters:

  • list_id —

    The list to be cleared.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/bombbomb/api/lists_api.rb', line 166

def suppress_all_in_list_with_http_info(list_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ListsApi.suppress_all_in_list ..."
  end
  # verify the required parameter 'list_id' is set
  fail ArgumentError, "Missing the required parameter 'list_id' when calling ListsApi.suppress_all_in_list" if list_id.nil?
  # resource path
  local_var_path = "/lists/{listId}/suppress".sub('{format}','json').sub('{' + 'listId' + '}', list_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/x-www-form-urlencoded']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BBOAuth2']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ListsApi#suppress_all_in_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end