Class: DocuSign_eSign::CustomTabsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = CustomTabsApi.default) ⇒ CustomTabsApi

Returns a new instance of CustomTabsApi.


30
31
32
# File 'lib/docusign_esign/api/custom_tabs_api.rb', line 30

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client


28
29
30
# File 'lib/docusign_esign/api/custom_tabs_api.rb', line 28

def api_client
  @api_client
end

Instance Method Details

#create(account_id, tab_metadata) ⇒ TabMetadata

Creates a custom tab. Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application. Custom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs.

Parameters:

  • account_id

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

  • tab_metadata (optional parameter)

Returns:


39
40
41
42
# File 'lib/docusign_esign/api/custom_tabs_api.rb', line 39

def create(, )
  data, _status_code, _headers = create_with_http_info(,  )
  return data
end

#create_with_http_info(account_id, tab_metadata) ⇒ Array<(TabMetadata, Fixnum, Hash)>

Creates a custom tab. Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application. Custom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs.

Parameters:

  • account_id

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

  • tab_metadata (optional parameter)

Returns:

  • (Array<(TabMetadata, Fixnum, Hash)>)

    TabMetadata data, 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
# File 'lib/docusign_esign/api/custom_tabs_api.rb', line 49

def create_with_http_info(, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CustomTabsApi.create ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling CustomTabsApi.create" if .nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/tab_definitions".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()
  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 => 'TabMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomTabsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete(account_id, custom_tab_id) ⇒ nil

Deletes custom tab information. Deletes the custom from the specified account.

Parameters:

  • account_id

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

  • custom_tab_id

Returns:

  • (nil)

90
91
92
93
# File 'lib/docusign_esign/api/custom_tabs_api.rb', line 90

def delete(, custom_tab_id)
  delete_with_http_info(, custom_tab_id)
  return nil
end

#delete_with_http_info(account_id, custom_tab_id) ⇒ Array<(nil, Fixnum, Hash)>

Deletes custom tab information. Deletes the custom from the specified account.

Parameters:

  • account_id

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

  • custom_tab_id

Returns:

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

    nil, response status code and response headers


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

def delete_with_http_info(, custom_tab_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CustomTabsApi.delete ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling CustomTabsApi.delete" if .nil?
  # verify the required parameter 'custom_tab_id' is set
  fail ArgumentError, "Missing the required parameter 'custom_tab_id' when calling CustomTabsApi.delete" if custom_tab_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/tab_definitions/{customTabId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'customTabId' + '}', custom_tab_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: CustomTabsApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(account_id, custom_tab_id) ⇒ TabMetadata

Gets custom tab information. Retrieves information about the requested custom tab on the specified account.

Parameters:

  • account_id

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

  • custom_tab_id

Returns:


142
143
144
145
# File 'lib/docusign_esign/api/custom_tabs_api.rb', line 142

def get(, custom_tab_id)
  data, _status_code, _headers = get_with_http_info(, custom_tab_id)
  return data
end

#get_with_http_info(account_id, custom_tab_id) ⇒ Array<(TabMetadata, Fixnum, Hash)>

Gets custom tab information. Retrieves information about the requested custom tab on the specified account.

Parameters:

  • account_id

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

  • custom_tab_id

Returns:

  • (Array<(TabMetadata, Fixnum, Hash)>)

    TabMetadata data, response status code and response headers


152
153
154
155
156
157
158
159
160
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
# File 'lib/docusign_esign/api/custom_tabs_api.rb', line 152

def get_with_http_info(, custom_tab_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CustomTabsApi.get ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling CustomTabsApi.get" if .nil?
  # verify the required parameter 'custom_tab_id' is set
  fail ArgumentError, "Missing the required parameter 'custom_tab_id' when calling CustomTabsApi.get" if custom_tab_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/tab_definitions/{customTabId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'customTabId' + '}', custom_tab_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(: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 => 'TabMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomTabsApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(account_id, options = DocuSign_eSign::ListOptions.default) ⇒ TabMetadataList

Gets a list of all account tabs. Retrieves a list of all tabs associated with the account.

Parameters:

  • account_id

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

  • DocuSign_eSign::ListOptions

    Options for modifying the behavior of the function.

Returns:


195
196
197
198
# File 'lib/docusign_esign/api/custom_tabs_api.rb', line 195

def list(, options = DocuSign_eSign::ListOptions.default)
  data, _status_code, _headers = list_with_http_info(, options)
  return data
end

#list_with_http_info(account_id, options = DocuSign_eSign::ListOptions.default) ⇒ Array<(TabMetadataList, Fixnum, Hash)>

Gets a list of all account tabs. Retrieves a list of all tabs associated with the account.

Parameters:

  • account_id

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

  • DocuSign_eSign::ListOptions

    Options for modifying the behavior of the function.

Returns:

  • (Array<(TabMetadataList, Fixnum, Hash)>)

    TabMetadataList data, response status code and response headers


205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'lib/docusign_esign/api/custom_tabs_api.rb', line 205

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

  # query parameters
  query_params = {}
  query_params[:'custom_tab_only'] = options.custom_tab_only if !options.custom_tab_only.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 => 'TabMetadataList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomTabsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(account_id, custom_tab_id, tab_metadata) ⇒ TabMetadata

Updates custom tab information.

Updates the information in a custom tab for the specified account.

Parameters:

  • account_id

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

  • custom_tab_id
  • tab_metadata (optional parameter)

Returns:


248
249
250
251
# File 'lib/docusign_esign/api/custom_tabs_api.rb', line 248

def update(, custom_tab_id, )
  data, _status_code, _headers = update_with_http_info(, custom_tab_id,  )
  return data
end

#update_with_http_info(account_id, custom_tab_id, tab_metadata) ⇒ Array<(TabMetadata, Fixnum, Hash)>

Updates custom tab information.

Updates the information in a custom tab for the specified account.

Parameters:

  • account_id

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

  • custom_tab_id
  • tab_metadata (optional parameter)

Returns:

  • (Array<(TabMetadata, Fixnum, Hash)>)

    TabMetadata data, response status code and response headers


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
287
288
289
290
291
292
293
294
295
# File 'lib/docusign_esign/api/custom_tabs_api.rb', line 259

def update_with_http_info(, custom_tab_id, )
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: CustomTabsApi.update ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling CustomTabsApi.update" if .nil?
  # verify the required parameter 'custom_tab_id' is set
  fail ArgumentError, "Missing the required parameter 'custom_tab_id' when calling CustomTabsApi.update" if custom_tab_id.nil?
  # resource path
  local_var_path = "/v2.1/accounts/{accountId}/tab_definitions/{customTabId}".sub('{format}','json').sub('{' + 'accountId' + '}', .to_s).sub('{' + 'customTabId' + '}', custom_tab_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 = @api_client.object_to_http_body()
  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 => 'TabMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomTabsApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end