dropbox-sign 1.14.0 → 1.16.0

data/lib/dropbox-sign/api/embedded_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.12.0
+Generator version: 7.26.0
 
 =end
 
@@ -24,6 +24,7 @@ module Dropbox::Sign
     end
     # Get Embedded Template Edit URL
     # Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/EmbeddedEditUrlExample.rb
     # @param template_id [String] The id of the template to edit.
     # @param embedded_edit_url_request [EmbeddedEditUrlRequest] 
     # @param [Hash] opts the optional parameters
@@ -35,6 +36,7 @@ module Dropbox::Sign
 
     # Get Embedded Template Edit URL
     # Retrieves an embedded object containing a template url that can be opened in an iFrame. Note that only templates created via the embedded template process are available to be edited with this endpoint.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/EmbeddedEditUrlExample.rb
     # @param template_id [String] The id of the template to edit.
     # @param embedded_edit_url_request [EmbeddedEditUrlRequest] 
     # @param [Hash] opts the optional parameters
@@ -52,7 +54,7 @@ module Dropbox::Sign
         fail ArgumentError, "Missing the required parameter 'embedded_edit_url_request' when calling EmbeddedApi.embedded_edit_url"
       end
       # resource path
-      local_var_path = '/embedded/edit_url/{template_id}'.sub('{' + 'template_id' + '}', CGI.escape(template_id.to_s))
+      local_var_path = '/embedded/edit_url/{template_id}'.sub('{template_id}', CGI.escape(template_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -140,6 +142,7 @@ module Dropbox::Sign
 
     # Get Embedded Sign URL
     # Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/EmbeddedSignUrlExample.rb
     # @param signature_id [String] The id of the signature to get a signature url for.
     # @param [Hash] opts the optional parameters
     # @return [EmbeddedSignUrlResponse]
@@ -150,6 +153,7 @@ module Dropbox::Sign
 
     # Get Embedded Sign URL
     # Retrieves an embedded object containing a signature url that can be opened in an iFrame. Note that templates created via the embedded template process will only be accessible through the API.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/EmbeddedSignUrlExample.rb
     # @param signature_id [String] The id of the signature to get a signature url for.
     # @param [Hash] opts the optional parameters
     # @return [Array<(EmbeddedSignUrlResponse, Integer, Hash)>] EmbeddedSignUrlResponse data, response status code and response headers
@@ -162,7 +166,7 @@ module Dropbox::Sign
         fail ArgumentError, "Missing the required parameter 'signature_id' when calling EmbeddedApi.embedded_sign_url"
       end
       # resource path
-      local_var_path = '/embedded/sign_url/{signature_id}'.sub('{' + 'signature_id' + '}', CGI.escape(signature_id.to_s))
+      local_var_path = '/embedded/sign_url/{signature_id}'.sub('{signature_id}', CGI.escape(signature_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}

data/lib/dropbox-sign/api/fax_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.12.0
+Generator version: 7.26.0
 
 =end
 
@@ -24,6 +24,7 @@ module Dropbox::Sign
     end
     # Delete Fax
     # Deletes the specified Fax from the system
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxDeleteExample.rb
     # @param fax_id [String] Fax ID
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -34,6 +35,7 @@ module Dropbox::Sign
 
     # Delete Fax
     # Deletes the specified Fax from the system
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxDeleteExample.rb
     # @param fax_id [String] Fax ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -46,7 +48,7 @@ module Dropbox::Sign
         fail ArgumentError, "Missing the required parameter 'fax_id' when calling FaxApi.fax_delete"
       end
       # resource path
-      local_var_path = '/fax/{fax_id}'.sub('{' + 'fax_id' + '}', CGI.escape(fax_id.to_s))
+      local_var_path = '/fax/{fax_id}'.sub('{fax_id}', CGI.escape(fax_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -92,6 +94,7 @@ module Dropbox::Sign
 
     # Download Fax Files
     # Downloads files associated with a Fax
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxFilesExample.rb
     # @param fax_id [String] Fax ID
     # @param [Hash] opts the optional parameters
     # @return [File]
@@ -102,6 +105,7 @@ module Dropbox::Sign
 
     # Download Fax Files
     # Downloads files associated with a Fax
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxFilesExample.rb
     # @param fax_id [String] Fax ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -114,7 +118,7 @@ module Dropbox::Sign
         fail ArgumentError, "Missing the required parameter 'fax_id' when calling FaxApi.fax_files"
       end
       # resource path
-      local_var_path = '/fax/files/{fax_id}'.sub('{' + 'fax_id' + '}', CGI.escape(fax_id.to_s))
+      local_var_path = '/fax/files/{fax_id}'.sub('{fax_id}', CGI.escape(fax_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -187,6 +191,7 @@ module Dropbox::Sign
 
     # Get Fax
     # Returns information about a Fax
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxGetExample.rb
     # @param fax_id [String] Fax ID
     # @param [Hash] opts the optional parameters
     # @return [FaxGetResponse]
@@ -197,6 +202,7 @@ module Dropbox::Sign
 
     # Get Fax
     # Returns information about a Fax
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxGetExample.rb
     # @param fax_id [String] Fax ID
     # @param [Hash] opts the optional parameters
     # @return [Array<(FaxGetResponse, Integer, Hash)>] FaxGetResponse data, response status code and response headers
@@ -209,7 +215,7 @@ module Dropbox::Sign
         fail ArgumentError, "Missing the required parameter 'fax_id' when calling FaxApi.fax_get"
       end
       # resource path
-      local_var_path = '/fax/{fax_id}'.sub('{' + 'fax_id' + '}', CGI.escape(fax_id.to_s))
+      local_var_path = '/fax/{fax_id}'.sub('{fax_id}', CGI.escape(fax_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -282,6 +288,7 @@ module Dropbox::Sign
 
     # Lists Faxes
     # Returns properties of multiple Faxes
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxListExample.rb
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Which page number of the Fax List to return. Defaults to &#x60;1&#x60;. (default to 1)
     # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is &#x60;20&#x60;. (default to 20)
@@ -293,6 +300,7 @@ module Dropbox::Sign
 
     # Lists Faxes
     # Returns properties of multiple Faxes
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxListExample.rb
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Which page number of the Fax List to return. Defaults to &#x60;1&#x60;. (default to 1)
     # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is &#x60;20&#x60;. (default to 20)
@@ -389,6 +397,7 @@ module Dropbox::Sign
 
     # Send Fax
     # Creates and sends a new Fax with the submitted file(s)
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxSendExample.rb
     # @param fax_send_request [FaxSendRequest] 
     # @param [Hash] opts the optional parameters
     # @return [FaxGetResponse]
@@ -399,6 +408,7 @@ module Dropbox::Sign
 
     # Send Fax
     # Creates and sends a new Fax with the submitted file(s)
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxSendExample.rb
     # @param fax_send_request [FaxSendRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(FaxGetResponse, Integer, Hash)>] FaxGetResponse data, response status code and response headers

data/lib/dropbox-sign/api/fax_line_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.12.0
+Generator version: 7.26.0
 
 =end
 
@@ -24,6 +24,7 @@ module Dropbox::Sign
     end
     # Add Fax Line User
     # Grants a user access to the specified Fax Line.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineAddUserExample.rb
     # @param fax_line_add_user_request [FaxLineAddUserRequest] 
     # @param [Hash] opts the optional parameters
     # @return [FaxLineResponse]
@@ -34,6 +35,7 @@ module Dropbox::Sign
 
     # Add Fax Line User
     # Grants a user access to the specified Fax Line.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineAddUserExample.rb
     # @param fax_line_add_user_request [FaxLineAddUserRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers
@@ -134,6 +136,7 @@ module Dropbox::Sign
 
     # Get Available Fax Line Area Codes
     # Returns a list of available area codes for a given state/province and city
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineAreaCodeGetExample.rb
     # @param country [String] Filter area codes by country
     # @param [Hash] opts the optional parameters
     # @option opts [String] :state Filter area codes by state
@@ -147,6 +150,7 @@ module Dropbox::Sign
 
     # Get Available Fax Line Area Codes
     # Returns a list of available area codes for a given state/province and city
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineAreaCodeGetExample.rb
     # @param country [String] Filter area codes by country
     # @param [Hash] opts the optional parameters
     # @option opts [String] :state Filter area codes by state
@@ -252,6 +256,7 @@ module Dropbox::Sign
 
     # Purchase Fax Line
     # Purchases a new Fax Line
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineCreateExample.rb
     # @param fax_line_create_request [FaxLineCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [FaxLineResponse]
@@ -262,6 +267,7 @@ module Dropbox::Sign
 
     # Purchase Fax Line
     # Purchases a new Fax Line
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineCreateExample.rb
     # @param fax_line_create_request [FaxLineCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers
@@ -362,6 +368,7 @@ module Dropbox::Sign
 
     # Delete Fax Line
     # Deletes the specified Fax Line from the subscription.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineDeleteExample.rb
     # @param fax_line_delete_request [FaxLineDeleteRequest] 
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -372,6 +379,7 @@ module Dropbox::Sign
 
     # Delete Fax Line
     # Deletes the specified Fax Line from the subscription.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineDeleteExample.rb
     # @param fax_line_delete_request [FaxLineDeleteRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -445,6 +453,7 @@ module Dropbox::Sign
 
     # Get Fax Line
     # Returns the properties and settings of a Fax Line.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineGetExample.rb
     # @param number [String] The Fax Line number
     # @param [Hash] opts the optional parameters
     # @return [FaxLineResponse]
@@ -455,6 +464,7 @@ module Dropbox::Sign
 
     # Get Fax Line
     # Returns the properties and settings of a Fax Line.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineGetExample.rb
     # @param number [String] The Fax Line number
     # @param [Hash] opts the optional parameters
     # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers
@@ -541,6 +551,7 @@ module Dropbox::Sign
 
     # List Fax Lines
     # Returns the properties and settings of multiple Fax Lines.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineListExample.rb
     # @param [Hash] opts the optional parameters
     # @option opts [String] :account_id Account ID
     # @option opts [Integer] :page Which page number of the Fax Line List to return. Defaults to &#x60;1&#x60;. (default to 1)
@@ -554,6 +565,7 @@ module Dropbox::Sign
 
     # List Fax Lines
     # Returns the properties and settings of multiple Fax Lines.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineListExample.rb
     # @param [Hash] opts the optional parameters
     # @option opts [String] :account_id Account ID
     # @option opts [Integer] :page Which page number of the Fax Line List to return. Defaults to &#x60;1&#x60;. (default to 1)
@@ -642,6 +654,7 @@ module Dropbox::Sign
 
     # Remove Fax Line Access
     # Removes a user's access to the specified Fax Line
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineRemoveUserExample.rb
     # @param fax_line_remove_user_request [FaxLineRemoveUserRequest] 
     # @param [Hash] opts the optional parameters
     # @return [FaxLineResponse]
@@ -652,6 +665,7 @@ module Dropbox::Sign
 
     # Remove Fax Line Access
     # Removes a user&#39;s access to the specified Fax Line
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/FaxLineRemoveUserExample.rb
     # @param fax_line_remove_user_request [FaxLineRemoveUserRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(FaxLineResponse, Integer, Hash)>] FaxLineResponse data, response status code and response headers

data/lib/dropbox-sign/api/o_auth_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.12.0
+Generator version: 7.26.0
 
 =end
 
@@ -24,6 +24,7 @@ module Dropbox::Sign
     end
     # OAuth Token Generate
     # Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/OauthTokenGenerateExample.rb
     # @param o_auth_token_generate_request [OAuthTokenGenerateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [OAuthTokenResponse]
@@ -34,6 +35,7 @@ module Dropbox::Sign
 
     # OAuth Token Generate
     # Once you have retrieved the code from the user callback, you will need to exchange it for an access token via a backend call.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/OauthTokenGenerateExample.rb
     # @param o_auth_token_generate_request [OAuthTokenGenerateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(OAuthTokenResponse, Integer, Hash)>] OAuthTokenResponse data, response status code and response headers
@@ -134,6 +136,7 @@ module Dropbox::Sign
 
     # OAuth Token Refresh
     # Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see `expires_in`), along with a refresh token that can be used to acquire a new access token after the current one has expired.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/OauthTokenRefreshExample.rb
     # @param o_auth_token_refresh_request [OAuthTokenRefreshRequest] 
     # @param [Hash] opts the optional parameters
     # @return [OAuthTokenResponse]
@@ -144,6 +147,7 @@ module Dropbox::Sign
 
     # OAuth Token Refresh
     # Access tokens are only valid for a given period of time (typically one hour) for security reasons. Whenever acquiring an new access token its TTL is also given (see &#x60;expires_in&#x60;), along with a refresh token that can be used to acquire a new access token after the current one has expired.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/OauthTokenRefreshExample.rb
     # @param o_auth_token_refresh_request [OAuthTokenRefreshRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(OAuthTokenResponse, Integer, Hash)>] OAuthTokenResponse data, response status code and response headers

data/lib/dropbox-sign/api/report_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 3.0.0
 Contact: apisupport@hellosign.com
 Generated by: https://openapi-generator.tech
-Generator version: 7.12.0
+Generator version: 7.26.0
 
 =end
 
@@ -24,6 +24,7 @@ module Dropbox::Sign
     end
     # Create Report
     # Request the creation of one or more report(s).  When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ReportCreateExample.rb
     # @param report_create_request [ReportCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [ReportCreateResponse]
@@ -34,6 +35,7 @@ module Dropbox::Sign
 
     # Create Report
     # Request the creation of one or more report(s).  When the report(s) have been generated, you will receive an email (one per requested report type) containing a link to download the report as a CSV file. The requested date range may be up to 12 months in duration, and `start_date` must not be more than 10 years in the past.
+    # Example: https://github.com/hellosign/dropbox-sign-ruby/blob/main/examples/ReportCreateExample.rb
     # @param report_create_request [ReportCreateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ReportCreateResponse, Integer, Hash)>] ReportCreateResponse data, response status code and response headers