Class: DocuSign_eSign::PowerFormsApi
- Inherits:
-
Object
- Object
- DocuSign_eSign::PowerFormsApi
- Defined in:
- lib/docusign_esign/api/power_forms_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_power_form(account_id, power_form) ⇒ PowerForm
Creates a new PowerForm.
-
#create_power_form_with_http_info(account_id, power_form) ⇒ Array<(PowerForm, Fixnum, Hash)>
Creates a new PowerForm.
-
#delete_power_form(account_id, power_form_id) ⇒ nil
Delete a PowerForm.
-
#delete_power_form_with_http_info(account_id, power_form_id) ⇒ Array<(nil, Fixnum, Hash)>
Delete a PowerForm.
-
#delete_power_forms(account_id, power_forms_request) ⇒ PowerFormsResponse
Deletes one or more PowerForms This method deletes one or more PowerForms.
-
#delete_power_forms_with_http_info(account_id, power_forms_request) ⇒ Array<(PowerFormsResponse, Fixnum, Hash)>
Deletes one or more PowerForms This method deletes one or more PowerForms.
-
#get_power_form(account_id, power_form_id) ⇒ PowerForm
Returns a single PowerForm.
-
#get_power_form_data(account_id, power_form_id, options = DocuSign_eSign::GetPowerFormDataOptions.default) ⇒ PowerFormsFormDataResponse
Returns the form data associated with the usage of a PowerForm.
-
#get_power_form_data_with_http_info(account_id, power_form_id, options = DocuSign_eSign::GetPowerFormDataOptions.default) ⇒ Array<(PowerFormsFormDataResponse, Fixnum, Hash)>
Returns the form data associated with the usage of a PowerForm.
-
#get_power_form_with_http_info(account_id, power_form_id) ⇒ Array<(PowerForm, Fixnum, Hash)>
Returns a single PowerForm.
-
#initialize(api_client = PowerFormsApi.default) ⇒ PowerFormsApi
constructor
A new instance of PowerFormsApi.
-
#list_power_form_senders(account_id, options = DocuSign_eSign::ListPowerFormSendersOptions.default) ⇒ PowerFormSendersResponse
Returns the list of PowerForms available to the user.
-
#list_power_form_senders_with_http_info(account_id, options = DocuSign_eSign::ListPowerFormSendersOptions.default) ⇒ Array<(PowerFormSendersResponse, Fixnum, Hash)>
Returns the list of PowerForms available to the user.
-
#list_power_forms(account_id, options = DocuSign_eSign::ListPowerFormsOptions.default) ⇒ PowerFormsResponse
Returns the list of PowerForms available to the user.
-
#list_power_forms_with_http_info(account_id, options = DocuSign_eSign::ListPowerFormsOptions.default) ⇒ Array<(PowerFormsResponse, Fixnum, Hash)>
Returns the list of PowerForms available to the user.
-
#update_power_form(account_id, power_form_id, power_form) ⇒ PowerForm
Creates a new PowerForm.
-
#update_power_form_with_http_info(account_id, power_form_id, power_form) ⇒ Array<(PowerForm, Fixnum, Hash)>
Creates a new PowerForm.
Constructor Details
#initialize(api_client = PowerFormsApi.default) ⇒ PowerFormsApi
Returns a new instance of PowerFormsApi.
68 69 70 |
# File 'lib/docusign_esign/api/power_forms_api.rb', line 68 def initialize(api_client = PowerFormsApi.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
66 67 68 |
# File 'lib/docusign_esign/api/power_forms_api.rb', line 66 def api_client @api_client end |
Instance Method Details
#create_power_form(account_id, power_form) ⇒ PowerForm
Creates a new PowerForm. This method creates a new PowerForm. You create a PowerForm from an existing DocuSign [template](/docs/esign-rest-api/reference/templates/templates/create/), based on the ‘templateId` in the request body. PowerForms that you create from a template are referred to as *web PowerForms*. Note: The DocuSign Admin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a *PDF PowerForm*). However, PDF PowerForms are deprecated and are not supported in the API. Note: A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm initiator.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm. ### Signing modes You can use one of the following signing modes for a PowerForm: **`email`** This mode verifies the recipient’s identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document. Alternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the ‘activateonly` flag to the PowerForm URL and set it to true by passing in the value `1`. When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code. Example: `activateonly=1` **`direct`** This mode does not require any verification. After a recipient enters their email address on the landing page and clicks **Begin Signing,** a new browser tab opens and the recipient can immediately begin the signing process. Because the `direct` signing mode does not verify the recipient’s identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient’s identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check). Note: In the account settings, ‘enablePowerFormDirect` must be true to use `direct` as the `signingMode`. ### Redirect URLs You can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see [How do I specify a URL to redirect to when a PowerForm is completed?](support.docusign.com/en/articles/How-do-I-specify-a-URL-to-redirect-to-when-a-Powerform-is-completed). ### More information For more information about creating PowerForms, see [Create a PowerForm](support.docusign.com/en/guides/ndse-user-guide-create-a-powerform).
77 78 79 80 |
# File 'lib/docusign_esign/api/power_forms_api.rb', line 77 def create_power_form(account_id, power_form) data, _status_code, _headers = create_power_form_with_http_info(account_id, power_form) return data end |
#create_power_form_with_http_info(account_id, power_form) ⇒ Array<(PowerForm, Fixnum, Hash)>
Creates a new PowerForm. This method creates a new PowerForm. You create a PowerForm from an existing DocuSign [template](/docs/esign-rest-api/reference/templates/templates/create/), based on the `templateId` in the request body. PowerForms that you create from a template are referred to as *web PowerForms*. Note: The DocuSign Admin console also supports creating a PowerForm by uploading a PDF file that has active form fields (referred to as a *PDF PowerForm*). However, PDF PowerForms are deprecated and are not supported in the API. Note: A PowerForm can have only one sender. (Because PowerForms are not necessarily sent by email, this user is also referred to as the PowerForm initiator.) If you need to associate multiple senders with a PowerForm, create multiple copies of the PowerForm by using the same template (one copy for each sender). By default, the sender is the PowerForm Administrator who creates the PowerForm. ### Signing modes You can use one of the following signing modes for a PowerForm: **`email`** This mode verifies the recipient's identity by using email authentication before the recipient can sign a document. The recipient enters their email address on the landing page and then clicks **Begin Signing** to begin the signing process. The system then sends an email message with a validation code to the recipient. If the recipient does not provide a valid email address, they do not receive the email message containing the access code and are not able to open and sign the document. Alternatively, you can make the process easier for signers by using email authentication only and omitting the access code. To do this, you append the `activateonly` flag to the PowerForm URL and set it to true by passing in the value `1`. When the flag is active, the first recipient receives an email with a link that initiates the signing session without having to enter access code. Example: `activateonly=1` **`direct`** This mode does not require any verification. After a recipient enters their email address on the landing page and clicks **Begin Signing,** a new browser tab opens and the recipient can immediately begin the signing process. Because the `direct` signing mode does not verify the recipient's identity by using email authentication, we strongly recommend that you use this mode only when the PowerForm is accessible behind a secure portal where the recipient's identity is already authenticated, or where another form of authentication is specified for the recipient in the DocuSign template (for example, an access code, phone authentication, or ID check). Note: In the account settings, `enablePowerFormDirect` must be true to use `direct` as the `signingMode`. ### Redirect URLs You can control the URL to which signers are redirected after signing your PowerForm. However, the URL is specified elsewhere, outside of the PowerForm creation process. For details, see [How do I specify a URL to redirect to when a PowerForm is completed?](support.docusign.com/en/articles/How-do-I-specify-a-URL-to-redirect-to-when-a-Powerform-is-completed). ### More information For more information about creating PowerForms, see [Create a PowerForm](support.docusign.com/en/guides/ndse-user-guide-create-a-powerform).
87 88 89 90 91 92 93 94 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 |
# File 'lib/docusign_esign/api/power_forms_api.rb', line 87 def create_power_form_with_http_info(account_id, power_form) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PowerFormsApi.create_power_form ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling PowerFormsApi.create_power_form" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/powerforms".sub('{format}','json').sub('{' + 'accountId' + '}', account_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(power_form) 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 => 'PowerForm') if @api_client.config.debugging @api_client.config.logger.debug "API called: PowerFormsApi#create_power_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_power_form(account_id, power_form_id) ⇒ nil
Delete a PowerForm. This method deletes a PowerForm.
128 129 130 131 |
# File 'lib/docusign_esign/api/power_forms_api.rb', line 128 def delete_power_form(account_id, power_form_id) delete_power_form_with_http_info(account_id, power_form_id) return nil end |
#delete_power_form_with_http_info(account_id, power_form_id) ⇒ Array<(nil, Fixnum, Hash)>
Delete a PowerForm. This method deletes a PowerForm.
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 |
# File 'lib/docusign_esign/api/power_forms_api.rb', line 138 def delete_power_form_with_http_info(account_id, power_form_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PowerFormsApi.delete_power_form ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling PowerFormsApi.delete_power_form" if account_id.nil? # verify the required parameter 'power_form_id' is set fail ArgumentError, "Missing the required parameter 'power_form_id' when calling PowerFormsApi.delete_power_form" if power_form_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/powerforms/{powerFormId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'powerFormId' + '}', power_form_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: PowerFormsApi#delete_power_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#delete_power_forms(account_id, power_forms_request) ⇒ PowerFormsResponse
Deletes one or more PowerForms This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the ‘powerFormId`.
180 181 182 183 |
# File 'lib/docusign_esign/api/power_forms_api.rb', line 180 def delete_power_forms(account_id, power_forms_request) data, _status_code, _headers = delete_power_forms_with_http_info(account_id, power_forms_request) return data end |
#delete_power_forms_with_http_info(account_id, power_forms_request) ⇒ Array<(PowerFormsResponse, Fixnum, Hash)>
Deletes one or more PowerForms This method deletes one or more PowerForms. The request body takes an array of PowerForm objects that are deleted based on the `powerFormId`.
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 |
# File 'lib/docusign_esign/api/power_forms_api.rb', line 190 def delete_power_forms_with_http_info(account_id, power_forms_request) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PowerFormsApi.delete_power_forms ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling PowerFormsApi.delete_power_forms" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/powerforms".sub('{format}','json').sub('{' + 'accountId' + '}', account_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(power_forms_request) 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 => 'PowerFormsResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: PowerFormsApi#delete_power_forms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_power_form(account_id, power_form_id) ⇒ PowerForm
Returns a single PowerForm. This method returns detailed information about a specific PowerForm.
231 232 233 234 |
# File 'lib/docusign_esign/api/power_forms_api.rb', line 231 def get_power_form(account_id, power_form_id) data, _status_code, _headers = get_power_form_with_http_info(account_id, power_form_id) return data end |
#get_power_form_data(account_id, power_form_id, options = DocuSign_eSign::GetPowerFormDataOptions.default) ⇒ PowerFormsFormDataResponse
Returns the form data associated with the usage of a PowerForm. This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm. You specify the format in which you want to retrieve the data in the ‘Accept` header. This header accepts the following values: - `application/json`: JSON format - `application/xml`: XML format - `text/csv`: Comma-separated value (CSV) format Note: Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.
285 286 287 288 |
# File 'lib/docusign_esign/api/power_forms_api.rb', line 285 def get_power_form_data(account_id, power_form_id, = DocuSign_eSign::GetPowerFormDataOptions.default) data, _status_code, _headers = get_power_form_data_with_http_info(account_id, power_form_id, ) return data end |
#get_power_form_data_with_http_info(account_id, power_form_id, options = DocuSign_eSign::GetPowerFormDataOptions.default) ⇒ Array<(PowerFormsFormDataResponse, Fixnum, Hash)>
Returns the form data associated with the usage of a PowerForm. This method enables Powerform Administrators or the sender of a PowerForm to download the data that recipients have entered into a PowerForm. You specify the format in which you want to retrieve the data in the `Accept` header. This header accepts the following values: - `application/json`: JSON format - `application/xml`: XML format - `text/csv`: Comma-separated value (CSV) format Note: Only PowerForm Administrators or the PowerForm Sender can download the data associated with a PowerForm.
296 297 298 299 300 301 302 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 |
# File 'lib/docusign_esign/api/power_forms_api.rb', line 296 def get_power_form_data_with_http_info(account_id, power_form_id, = DocuSign_eSign::GetPowerFormDataOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PowerFormsApi.get_power_form_data ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling PowerFormsApi.get_power_form_data" if account_id.nil? # verify the required parameter 'power_form_id' is set fail ArgumentError, "Missing the required parameter 'power_form_id' when calling PowerFormsApi.get_power_form_data" if power_form_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/powerforms/{powerFormId}/form_data".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'powerFormId' + '}', power_form_id.to_s) # query parameters query_params = {} query_params[:'data_layout'] = .data_layout if !.data_layout.nil? query_params[:'from_date'] = .from_date if !.from_date.nil? query_params[:'to_date'] = .to_date if !.to_date.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 => 'PowerFormsFormDataResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: PowerFormsApi#get_power_form_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_power_form_with_http_info(account_id, power_form_id) ⇒ Array<(PowerForm, Fixnum, Hash)>
Returns a single PowerForm. This method returns detailed information about a specific PowerForm.
241 242 243 244 245 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 |
# File 'lib/docusign_esign/api/power_forms_api.rb', line 241 def get_power_form_with_http_info(account_id, power_form_id) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PowerFormsApi.get_power_form ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling PowerFormsApi.get_power_form" if account_id.nil? # verify the required parameter 'power_form_id' is set fail ArgumentError, "Missing the required parameter 'power_form_id' when calling PowerFormsApi.get_power_form" if power_form_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/powerforms/{powerFormId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'powerFormId' + '}', power_form_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 => 'PowerForm') if @api_client.config.debugging @api_client.config.logger.debug "API called: PowerFormsApi#get_power_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_power_form_senders(account_id, options = DocuSign_eSign::ListPowerFormSendersOptions.default) ⇒ PowerFormSendersResponse
Returns the list of PowerForms available to the user. This method returns a list of users who have sent PowerForms.
342 343 344 345 |
# File 'lib/docusign_esign/api/power_forms_api.rb', line 342 def list_power_form_senders(account_id, = DocuSign_eSign::ListPowerFormSendersOptions.default) data, _status_code, _headers = list_power_form_senders_with_http_info(account_id, ) return data end |
#list_power_form_senders_with_http_info(account_id, options = DocuSign_eSign::ListPowerFormSendersOptions.default) ⇒ Array<(PowerFormSendersResponse, Fixnum, Hash)>
Returns the list of PowerForms available to the user. This method returns a list of users who have sent PowerForms.
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 |
# File 'lib/docusign_esign/api/power_forms_api.rb', line 352 def list_power_form_senders_with_http_info(account_id, = DocuSign_eSign::ListPowerFormSendersOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PowerFormsApi.list_power_form_senders ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling PowerFormsApi.list_power_form_senders" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/powerforms/senders".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'start_position'] = .start_position if !.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 => 'PowerFormSendersResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: PowerFormsApi#list_power_form_senders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_power_forms(account_id, options = DocuSign_eSign::ListPowerFormsOptions.default) ⇒ PowerFormsResponse
Returns the list of PowerForms available to the user. This method returns a list of PowerForms that are available to the user.
394 395 396 397 |
# File 'lib/docusign_esign/api/power_forms_api.rb', line 394 def list_power_forms(account_id, = DocuSign_eSign::ListPowerFormsOptions.default) data, _status_code, _headers = list_power_forms_with_http_info(account_id, ) return data end |
#list_power_forms_with_http_info(account_id, options = DocuSign_eSign::ListPowerFormsOptions.default) ⇒ Array<(PowerFormsResponse, Fixnum, Hash)>
Returns the list of PowerForms available to the user. This method returns a list of PowerForms that are available to the user.
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 |
# File 'lib/docusign_esign/api/power_forms_api.rb', line 404 def list_power_forms_with_http_info(account_id, = DocuSign_eSign::ListPowerFormsOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PowerFormsApi.list_power_forms ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling PowerFormsApi.list_power_forms" if account_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/powerforms".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'from_date'] = .from_date if !.from_date.nil? query_params[:'order'] = .order if !.order.nil? query_params[:'order_by'] = .order_by if !.order_by.nil? query_params[:'search_fields'] = .search_fields if !.search_fields.nil? query_params[:'search_text'] = .search_text if !.search_text.nil? query_params[:'to_date'] = .to_date if !.to_date.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 => 'PowerFormsResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: PowerFormsApi#list_power_forms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_power_form(account_id, power_form_id, power_form) ⇒ PowerForm
Creates a new PowerForm. This method updates an existing PowerForm.
452 453 454 455 |
# File 'lib/docusign_esign/api/power_forms_api.rb', line 452 def update_power_form(account_id, power_form_id, power_form) data, _status_code, _headers = update_power_form_with_http_info(account_id, power_form_id, power_form) return data end |
#update_power_form_with_http_info(account_id, power_form_id, power_form) ⇒ Array<(PowerForm, Fixnum, Hash)>
Creates a new PowerForm. This method updates an existing PowerForm.
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 |
# File 'lib/docusign_esign/api/power_forms_api.rb', line 463 def update_power_form_with_http_info(account_id, power_form_id, power_form) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: PowerFormsApi.update_power_form ..." end # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling PowerFormsApi.update_power_form" if account_id.nil? # verify the required parameter 'power_form_id' is set fail ArgumentError, "Missing the required parameter 'power_form_id' when calling PowerFormsApi.update_power_form" if power_form_id.nil? # resource path local_var_path = "/v2.1/accounts/{accountId}/powerforms/{powerFormId}".sub('{format}','json').sub('{' + 'accountId' + '}', account_id.to_s).sub('{' + 'powerFormId' + '}', power_form_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(power_form) 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 => 'PowerForm') if @api_client.config.debugging @api_client.config.logger.debug "API called: PowerFormsApi#update_power_form\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |