Class: Bfwd::EmailsubscriptionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/api/emailsubscriptions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EmailsubscriptionsApi

Returns a new instance of EmailsubscriptionsApi.



19
20
21
 
# File 'lib/bf_ruby2/api/emailsubscriptions_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/bf_ruby2/api/emailsubscriptions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_email_subscription(request, opts = {}) ⇒ EmailSubscriptionPagedMetadata

Create an email subscription. an email subscription","request":"createEmailSubscriptionRequest.html","response":"creatEmailSubscriptionResponse.html"

Parameters:

  • request —

    .

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/bf_ruby2/api/emailsubscriptions_api.rb', line 28

def create_email_subscription(request, opts = {})
  data, _status_code, _headers = create_email_subscription_with_http_info(request, opts)
  return data
end

#create_email_subscription_with_http_info(request, opts = {}) ⇒ Array<(EmailSubscriptionPagedMetadata, Fixnum, Hash)>

Create an email subscription. an email subscription&quot;,&quot;request&quot;:&quot;createEmailSubscriptionRequest.html&quot;,&quot;response&quot;:&quot;creatEmailSubscriptionResponse.html&quot;

Parameters:

  • request —

    .

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

    the optional parameters

Returns:



38
39
40
41
42
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
76
 
# File 'lib/bf_ruby2/api/emailsubscriptions_api.rb', line 38

def create_email_subscription_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmailsubscriptionsApi.create_email_subscription ..."
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling EmailsubscriptionsApi.create_email_subscription"
  end
  # resource path
  local_var_path = "/email-subscriptions"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = []
  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,
    :return_type => 'EmailSubscriptionPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailsubscriptionsApi#create_email_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_email_subscription_by_type(type, opts = {}) ⇒ EmailSubscriptionPagedMetadata

Unsubscribe from the email specified by the type parameter. { "nickname" : "Unsubscribe","response" : "unsubscribeEmail.html"}

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



84
85
86
87
 
# File 'lib/bf_ruby2/api/emailsubscriptions_api.rb', line 84

def delete_email_subscription_by_type(type, opts = {})
  data, _status_code, _headers = delete_email_subscription_by_type_with_http_info(type, opts)
  return data
end

#delete_email_subscription_by_type_with_http_info(type, opts = {}) ⇒ Array<(EmailSubscriptionPagedMetadata, Fixnum, Hash)>

Unsubscribe from the email specified by the type parameter. { &quot;nickname&quot; : &quot;Unsubscribe&quot;,&quot;response&quot; : &quot;unsubscribeEmail.html&quot;}

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/bf_ruby2/api/emailsubscriptions_api.rb', line 95

def delete_email_subscription_by_type_with_http_info(type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmailsubscriptionsApi.delete_email_subscription_by_type ..."
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling EmailsubscriptionsApi.delete_email_subscription_by_type"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['FailedPayment', 'InvoicePaid', 'SubscriptionCancellation', 'SubscriptionCancelled', 'SubscriptionPlanMigrated', 'SubscriptionPlanMigrating', 'CardExpired', 'CardExpiring'].include?(type)
    fail ArgumentError, "invalid value for 'type', must be one of FailedPayment, InvoicePaid, SubscriptionCancellation, SubscriptionCancelled, SubscriptionPlanMigrated, SubscriptionPlanMigrating, CardExpired, CardExpiring"
  end
  # resource path
  local_var_path = "/email-subscriptions/type={type}".sub('{' + 'type' + '}', type.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

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

#get_all_email_subscriptions(state, type, opts = {}) ⇒ EmailSubscriptionPagedMetadata

Returns a collection of all email-subscriptions. By default 10 values are returned. Records are returned in natural order. all email subscriptions","response":"getEmailSubscriptionsAll.html"

Parameters:

  • state —

    Constrains search to Email Subscriptions of a specific state.

  • type —

    Constrains search to Email Subscriptions of a specific type

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first email-subscription to return. (default to 0)

  • :records (Integer) —

    The maximum number of email-subscription to return. (default to 10)

  • :order_by (String) —

    Specify a field used to order the result set. (default to created)

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC. (default to DESC)

Returns:



151
152
153
154
 
# File 'lib/bf_ruby2/api/emailsubscriptions_api.rb', line 151

def get_all_email_subscriptions(state, type, opts = {})
  data, _status_code, _headers = get_all_email_subscriptions_with_http_info(state, type, opts)
  return data
end

#get_all_email_subscriptions_with_http_info(state, type, opts = {}) ⇒ Array<(EmailSubscriptionPagedMetadata, Fixnum, Hash)>

Returns a collection of all email-subscriptions. By default 10 values are returned. Records are returned in natural order. all email subscriptions&quot;,&quot;response&quot;:&quot;getEmailSubscriptionsAll.html&quot;

Parameters:

  • state —

    Constrains search to Email Subscriptions of a specific state.

  • type —

    Constrains search to Email Subscriptions of a specific type

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :offset (Integer) —

    The offset from the first email-subscription to return.

  • :records (Integer) —

    The maximum number of email-subscription to return.

  • :order_by (String) —

    Specify a field used to order the result set.

  • :order (String) —

    Ihe direction of any ordering, either ASC or DESC.

Returns:



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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/bf_ruby2/api/emailsubscriptions_api.rb', line 167

def get_all_email_subscriptions_with_http_info(state, type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmailsubscriptionsApi.get_all_email_subscriptions ..."
  end
  # verify the required parameter 'state' is set
  if @api_client.config.client_side_validation && state.nil?
    fail ArgumentError, "Missing the required parameter 'state' when calling EmailsubscriptionsApi.get_all_email_subscriptions"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Active', 'Disabled'].include?(state)
    fail ArgumentError, "invalid value for 'state', must be one of Active, Disabled"
  end
  # verify the required parameter 'type' is set
  if @api_client.config.client_side_validation && type.nil?
    fail ArgumentError, "Missing the required parameter 'type' when calling EmailsubscriptionsApi.get_all_email_subscriptions"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['FailedPayment', 'InvoicePaid', 'SubscriptionCancellation', 'SubscriptionCancelled', 'SubscriptionPlanMigrated', 'SubscriptionPlanMigrating', 'CardExpired', 'CardExpiring'].include?(type)
    fail ArgumentError, "invalid value for 'type', must be one of FailedPayment, InvoicePaid, SubscriptionCancellation, SubscriptionCancelled, SubscriptionPlanMigrated, SubscriptionPlanMigrating, CardExpired, CardExpiring"
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC'
  end
  # resource path
  local_var_path = "/email-subscriptions"

  # query parameters
  query_params = {}
  query_params[:'state'] = state
  query_params[:'type'] = type
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil?
  query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'EmailSubscriptionPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailsubscriptionsApi#get_all_email_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_subscription_by_id(email_subscription_id, opts = {}) ⇒ EmailSubscriptionPagedMetadata

Retrieves a single email subscription, specified by ID. { "nickname" : "Retrieve by ID","response" : "getEmailSubscriptionByID.html"}

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :include_retired (BOOLEAN) —

    Include deleted email-subscriptions (default to false)

Returns:



234
235
236
237
 
# File 'lib/bf_ruby2/api/emailsubscriptions_api.rb', line 234

def get_email_subscription_by_id(email_subscription_id, opts = {})
  data, _status_code, _headers = get_email_subscription_by_id_with_http_info(email_subscription_id, opts)
  return data
end

#get_email_subscription_by_id_with_http_info(email_subscription_id, opts = {}) ⇒ Array<(EmailSubscriptionPagedMetadata, Fixnum, Hash)>

Retrieves a single email subscription, specified by ID. { &quot;nickname&quot; : &quot;Retrieve by ID&quot;,&quot;response&quot; : &quot;getEmailSubscriptionByID.html&quot;}

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

  • :include_retired (BOOLEAN) —

    Include deleted email-subscriptions

Returns:



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/bf_ruby2/api/emailsubscriptions_api.rb', line 246

def get_email_subscription_by_id_with_http_info(email_subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmailsubscriptionsApi.get_email_subscription_by_id ..."
  end
  # verify the required parameter 'email_subscription_id' is set
  if @api_client.config.client_side_validation && email_subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_subscription_id' when calling EmailsubscriptionsApi.get_email_subscription_by_id"
  end
  # resource path
  local_var_path = "/email-subscriptions/{email-subscription-id}".sub('{' + 'email-subscription-id' + '}', email_subscription_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?
  query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'EmailSubscriptionPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailsubscriptionsApi#get_email_subscription_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_email_subscription(request, opts = {}) ⇒ EmailSubscriptionPagedMetadata

Update an email subscription. EmailSubscription","request":"updateEmailSubscriptionRequest.html","response":"updateEmailSubscriptionResponse.html"

Parameters:

  • request —

    .

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

    the optional parameters

Returns:



293
294
295
296
 
# File 'lib/bf_ruby2/api/emailsubscriptions_api.rb', line 293

def update_email_subscription(request, opts = {})
  data, _status_code, _headers = update_email_subscription_with_http_info(request, opts)
  return data
end

#update_email_subscription_with_http_info(request, opts = {}) ⇒ Array<(EmailSubscriptionPagedMetadata, Fixnum, Hash)>

Update an email subscription. EmailSubscription&quot;,&quot;request&quot;:&quot;updateEmailSubscriptionRequest.html&quot;,&quot;response&quot;:&quot;updateEmailSubscriptionResponse.html&quot;

Parameters:

  • request —

    .

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

    the optional parameters

Returns:



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/bf_ruby2/api/emailsubscriptions_api.rb', line 303

def update_email_subscription_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmailsubscriptionsApi.update_email_subscription ..."
  end
  # verify the required parameter 'request' is set
  if @api_client.config.client_side_validation && request.nil?
    fail ArgumentError, "Missing the required parameter 'request' when calling EmailsubscriptionsApi.update_email_subscription"
  end
  # resource path
  local_var_path = "/email-subscriptions"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request)
  auth_names = []
  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,
    :return_type => 'EmailSubscriptionPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailsubscriptionsApi#update_email_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end