Class: DocuSign_eSign::EmailArchiveApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/api/email_archive_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = EmailArchiveApi.default) ⇒ EmailArchiveApi

Returns a new instance of EmailArchiveApi.



44
45
46
 
# File 'lib/docusign_esign/api/email_archive_api.rb', line 44

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



42
43
44
 
# File 'lib/docusign_esign/api/email_archive_api.rb', line 42

def api_client
  @api_client
end

Instance Method Details

#create_bcc_email_archive(account_id, bcc_email_archive) ⇒ BccEmailArchive

Creates a blind carbon copy email archive entry This method creates a BCC email archive configuration for an account (adds a BCC email address to the account for archiving the emails that DocuSign generates). The only property that you must set in the request body is the BCC email address that you want to use. Note: An account can have up to five active and pending email archive addresses combined, but you must use this method to add them to the account one at a time. Each email address is considered a separate BCC email archive configuration.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • bcc_email_archive (optional parameter)

Returns:



53
54
55
56
 
# File 'lib/docusign_esign/api/email_archive_api.rb', line 53

def create_bcc_email_archive(, bcc_email_archive)
  data, _status_code, _headers = create_bcc_email_archive_with_http_info(,  bcc_email_archive)
  return data
end

#create_bcc_email_archive_with_http_info(account_id, bcc_email_archive) ⇒ Array<(BccEmailArchive, Fixnum, Hash)>

Creates a blind carbon copy email archive entry This method creates a BCC email archive configuration for an account (adds a BCC email address to the account for archiving the emails that DocuSign generates). The only property that you must set in the request body is the BCC email address that you want to use. Note: An account can have up to five active and pending email archive addresses combined, but you must use this method to add them to the account one at a time. Each email address is considered a separate BCC email archive configuration.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • bcc_email_archive (optional parameter)

Returns:

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

    BccEmailArchive data, response status code and response headers



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
89
90
91
92
93
94
95
96
97
 
# File 'lib/docusign_esign/api/email_archive_api.rb', line 63

def create_bcc_email_archive_with_http_info(, bcc_email_archive)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmailArchiveApi.create_bcc_email_archive ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EmailArchiveApi.create_bcc_email_archive" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/settings/bcc_email_archives".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(bcc_email_archive)
  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 => 'BccEmailArchive')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: EmailArchiveApi#create_bcc_email_archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_bcc_email_archive(account_id, bcc_email_archive_id) ⇒ nil

Delete a blind carbon copy email archive for an account. This method deletes a BCC email archive configuration from an account. When you use this method, the status of the BCC email archive configuration switches to ‘closed` and the BCC email address is no longer used to archive DocuSign-generated email messages.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • bcc_email_archive_id

Returns:

  • (nil) 


104
105
106
107
 
# File 'lib/docusign_esign/api/email_archive_api.rb', line 104

def delete_bcc_email_archive(, bcc_email_archive_id)
  delete_bcc_email_archive_with_http_info(, bcc_email_archive_id)
  return nil
end

#delete_bcc_email_archive_with_http_info(account_id, bcc_email_archive_id) ⇒ Array<(nil, Fixnum, Hash)>

Delete a blind carbon copy email archive for an account. This method deletes a BCC email archive configuration from an account. When you use this method, the status of the BCC email archive configuration switches to &#x60;closed&#x60; and the BCC email address is no longer used to archive DocuSign-generated email messages.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • bcc_email_archive_id

Returns:

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

    nil, response status code and response headers



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/docusign_esign/api/email_archive_api.rb', line 114

def delete_bcc_email_archive_with_http_info(, bcc_email_archive_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmailArchiveApi.delete_bcc_email_archive ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EmailArchiveApi.delete_bcc_email_archive" if .nil?
  # verify the required parameter 'bcc_email_archive_id' is set
  fail ArgumentError, "Missing the required parameter 'bcc_email_archive_id' when calling EmailArchiveApi.delete_bcc_email_archive" if bcc_email_archive_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'bccEmailArchiveId' + '}', bcc_email_archive_id.to_s)

  # query parameters
  query_params = {}

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

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

#get_bcc_email_archive_history_list(account_id, bcc_email_archive_id, options = DocuSign_eSign::GetBCCEmailArchiveHistoryListOptions.default) ⇒ BccEmailArchiveHistoryList

Get the blind carbon copy email archive history entries for the specified archive This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • bcc_email_archive_id
  • DocuSign_eSign::GetBCCEmailArchiveHistoryListOptions —

    Options for modifying the behavior of the function.

Returns:



157
158
159
160
 
# File 'lib/docusign_esign/api/email_archive_api.rb', line 157

def get_bcc_email_archive_history_list(, bcc_email_archive_id, options = DocuSign_eSign::GetBCCEmailArchiveHistoryListOptions.default)
  data, _status_code, _headers = get_bcc_email_archive_history_list_with_http_info(, bcc_email_archive_id, options)
  return data
end

#get_bcc_email_archive_history_list_with_http_info(account_id, bcc_email_archive_id, options = DocuSign_eSign::GetBCCEmailArchiveHistoryListOptions.default) ⇒ Array<(BccEmailArchiveHistoryList, Fixnum, Hash)>

Get the blind carbon copy email archive history entries for the specified archive This method returns a specific BCC email archive configuration for an account, as well as the history of changes to the email address.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • bcc_email_archive_id
  • DocuSign_eSign::GetBCCEmailArchiveHistoryListOptions —

    Options for modifying the behavior of the function.

Returns:

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

    BccEmailArchiveHistoryList data, response status code and response headers



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
 
# File 'lib/docusign_esign/api/email_archive_api.rb', line 168

def get_bcc_email_archive_history_list_with_http_info(, bcc_email_archive_id, options = DocuSign_eSign::GetBCCEmailArchiveHistoryListOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmailArchiveApi.get_bcc_email_archive_history_list ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EmailArchiveApi.get_bcc_email_archive_history_list" if .nil?
  # verify the required parameter 'bcc_email_archive_id' is set
  fail ArgumentError, "Missing the required parameter 'bcc_email_archive_id' when calling EmailArchiveApi.get_bcc_email_archive_history_list" if bcc_email_archive_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/settings/bcc_email_archives/{bccEmailArchiveId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'bccEmailArchiveId' + '}', bcc_email_archive_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?

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

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

#get_bcc_email_archive_list(account_id, options = DocuSign_eSign::GetBCCEmailArchiveListOptions.default) ⇒ BccEmailArchiveList

Get the blind carbon copy email archive entries owned by the specified account This method retrieves all of the BCC email archive configurations associated with an account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • DocuSign_eSign::GetBCCEmailArchiveListOptions —

    Options for modifying the behavior of the function.

Returns:



213
214
215
216
 
# File 'lib/docusign_esign/api/email_archive_api.rb', line 213

def get_bcc_email_archive_list(, options = DocuSign_eSign::GetBCCEmailArchiveListOptions.default)
  data, _status_code, _headers = get_bcc_email_archive_list_with_http_info(, options)
  return data
end

#get_bcc_email_archive_list_with_http_info(account_id, options = DocuSign_eSign::GetBCCEmailArchiveListOptions.default) ⇒ Array<(BccEmailArchiveList, Fixnum, Hash)>

Get the blind carbon copy email archive entries owned by the specified account This method retrieves all of the BCC email archive configurations associated with an account.

Parameters:

  • account_id —

    The external account number (int) or account ID Guid.

  • DocuSign_eSign::GetBCCEmailArchiveListOptions —

    Options for modifying the behavior of the function.

Returns:

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

    BccEmailArchiveList 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
 
# File 'lib/docusign_esign/api/email_archive_api.rb', line 223

def get_bcc_email_archive_list_with_http_info(, options = DocuSign_eSign::GetBCCEmailArchiveListOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: EmailArchiveApi.get_bcc_email_archive_list ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling EmailArchiveApi.get_bcc_email_archive_list" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/settings/bcc_email_archives".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'start_position'] = options.start_position if !options.start_position.nil?

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

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