Class: Bfwd::EmailprovidersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EmailprovidersApi

Returns a new instance of EmailprovidersApi.



19
20
21
 
# File 'lib/bf_ruby2/api/emailproviders_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/emailproviders_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_email_provider(request, opts = {}) ⇒ EmailProviderPagedMetadata

Create an email provider. an email provider","request":"createEmailProviderRequest.html","response":"creatEmailProviderResponse.html"

Parameters:

  • .

  • (defaults to: {})

    the optional parameters

Returns:



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

def create_email_provider(request, opts = {})
  data, _status_code, _headers = create_email_provider_with_http_info(request, opts)
  return data
end

#create_email_provider_with_http_info(request, opts = {}) ⇒ Array<(EmailProviderPagedMetadata, Fixnum, Hash)>

Create an email provider. an email provider&quot;,&quot;request&quot;:&quot;createEmailProviderRequest.html&quot;,&quot;response&quot;:&quot;creatEmailProviderResponse.html&quot;

Parameters:

  • .

  • (defaults to: {})

    the optional parameters

Returns:

  • EmailProviderPagedMetadata data, response status code and response headers



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/emailproviders_api.rb', line 38

def create_email_provider_with_http_info(request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmailprovidersApi.create_email_provider ..."
  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 EmailprovidersApi.create_email_provider"
  end
  # resource path
  local_var_path = "/email-providers"

  # 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 => 'EmailProviderPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailprovidersApi#create_email_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete(email_provider_id, opts = {}) ⇒ EmailProviderPagedMetadata

Deletes a single email provider, specified by id or name parameter. { "nickname" : "delete","response" : "deleteEmailProvider.html"}

Parameters:

  • (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/emailproviders_api.rb', line 84

def delete(email_provider_id, opts = {})
  data, _status_code, _headers = delete_with_http_info(email_provider_id, opts)
  return data
end

#delete_with_http_info(email_provider_id, opts = {}) ⇒ Array<(EmailProviderPagedMetadata, Fixnum, Hash)>

Deletes a single email provider, specified by id or name parameter. { &quot;nickname&quot; : &quot;delete&quot;,&quot;response&quot; : &quot;deleteEmailProvider.html&quot;}

Parameters:

  • (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:

  • EmailProviderPagedMetadata data, response status code and response headers



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
 
# File 'lib/bf_ruby2/api/emailproviders_api.rb', line 95

def delete_with_http_info(email_provider_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmailprovidersApi.delete ..."
  end
  # verify the required parameter 'email_provider_id' is set
  if @api_client.config.client_side_validation && email_provider_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_provider_id' when calling EmailprovidersApi.delete"
  end
  # resource path
  local_var_path = "/email-providers/{email-provider-ID}".sub('{' + 'email-provider-ID' + '}', email_provider_id.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'])
  # 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 => 'EmailProviderPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailprovidersApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_email_providers(opts = {}) ⇒ EmailProviderPagedMetadata

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

Parameters:

  • (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-provider to return. (default to 0)

  • :records (Integer) —

    The maximum number of email-provider 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)

  • :include_retired (BOOLEAN) —

    Include deleted email-providers (default to false)

Returns:



146
147
148
149
 
# File 'lib/bf_ruby2/api/emailproviders_api.rb', line 146

def get_all_email_providers(opts = {})
  data, _status_code, _headers = get_all_email_providers_with_http_info(opts)
  return data
end

#get_all_email_providers_with_http_info(opts = {}) ⇒ Array<(EmailProviderPagedMetadata, Fixnum, Hash)>

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

Parameters:

  • (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-provider to return.

  • :records (Integer) —

    The maximum number of email-provider 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.

  • :include_retired (BOOLEAN) —

    Include deleted email-providers

Returns:

  • EmailProviderPagedMetadata data, response status code and response headers



161
162
163
164
165
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
 
# File 'lib/bf_ruby2/api/emailproviders_api.rb', line 161

def get_all_email_providers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmailprovidersApi.get_all_email_providers ..."
  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-providers"

  # query parameters
  query_params = {}
  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?
  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'])

  # 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 => 'EmailProviderPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailprovidersApi#get_all_email_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_email_by_provider_id(email_provider_id, opts = {}) ⇒ EmailProviderPagedMetadata

Retrieves a single email provider, specified by the version-ID parameter. { "nickname" : "Retrieve by version","response" : "getEmailProviderByID.html"}

Parameters:

  • (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-providers (default to false)

Returns:



211
212
213
214
 
# File 'lib/bf_ruby2/api/emailproviders_api.rb', line 211

def get_email_by_provider_id(email_provider_id, opts = {})
  data, _status_code, _headers = get_email_by_provider_id_with_http_info(email_provider_id, opts)
  return data
end

#get_email_by_provider_id_with_http_info(email_provider_id, opts = {}) ⇒ Array<(EmailProviderPagedMetadata, Fixnum, Hash)>

Retrieves a single email provider, specified by the version-ID parameter. { &quot;nickname&quot; : &quot;Retrieve by version&quot;,&quot;response&quot; : &quot;getEmailProviderByID.html&quot;}

Parameters:

  • (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-providers

Returns:

  • EmailProviderPagedMetadata data, response status code and response headers



223
224
225
226
227
228
229
230
231
232
233
234
235
236
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
 
# File 'lib/bf_ruby2/api/emailproviders_api.rb', line 223

def get_email_by_provider_id_with_http_info(email_provider_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmailprovidersApi.get_email_by_provider_id ..."
  end
  # verify the required parameter 'email_provider_id' is set
  if @api_client.config.client_side_validation && email_provider_id.nil?
    fail ArgumentError, "Missing the required parameter 'email_provider_id' when calling EmailprovidersApi.get_email_by_provider_id"
  end
  # resource path
  local_var_path = "/email-providers/{email-provider-ID}".sub('{' + 'email-provider-ID' + '}', email_provider_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 => 'EmailProviderPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailprovidersApi#get_email_by_provider_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end