signrequest_client 0.1.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +43 -44
  4. data/docs/ApiTokensApi.md +13 -9
  5. data/docs/Document.md +16 -19
  6. data/docs/DocumentAttachment.md +5 -5
  7. data/docs/DocumentAttachmentsApi.md +9 -6
  8. data/docs/DocumentSearch.md +5 -5
  9. data/docs/DocumentsApi.md +12 -65
  10. data/docs/DocumentsSearchApi.md +23 -58
  11. data/docs/Event.md +0 -1
  12. data/docs/EventsApi.md +6 -4
  13. data/docs/InlineResponse201.md +9 -0
  14. data/docs/InlineResponse2011.md +8 -0
  15. data/docs/InlineSignRequest.md +15 -15
  16. data/docs/SignRequest.md +15 -15
  17. data/docs/SignRequestQuickCreate.md +25 -25
  18. data/docs/SignerAttachment.md +1 -1
  19. data/docs/SigningLog.md +2 -2
  20. data/docs/SignrequestQuickCreateApi.md +3 -2
  21. data/docs/SignrequestsApi.md +21 -22
  22. data/docs/TeamMember.md +0 -1
  23. data/docs/TeamMembersApi.md +6 -4
  24. data/docs/TeamsApi.md +20 -72
  25. data/docs/Template.md +2 -3
  26. data/docs/TemplatesApi.md +6 -4
  27. data/docs/WebhookSubscription.md +1 -2
  28. data/docs/WebhooksApi.md +18 -12
  29. data/lib/signrequest_client.rb +2 -0
  30. data/lib/signrequest_client/api/api_tokens_api.rb +10 -10
  31. data/lib/signrequest_client/api/document_attachments_api.rb +6 -6
  32. data/lib/signrequest_client/api/documents_api.rb +8 -69
  33. data/lib/signrequest_client/api/documents_search_api.rb +31 -59
  34. data/lib/signrequest_client/api/events_api.rb +4 -4
  35. data/lib/signrequest_client/api/signrequest_quick_create_api.rb +2 -2
  36. data/lib/signrequest_client/api/signrequests_api.rb +24 -36
  37. data/lib/signrequest_client/api/team_members_api.rb +4 -4
  38. data/lib/signrequest_client/api/teams_api.rb +20 -81
  39. data/lib/signrequest_client/api/templates_api.rb +4 -4
  40. data/lib/signrequest_client/api/webhooks_api.rb +12 -12
  41. data/lib/signrequest_client/models/document.rb +19 -30
  42. data/lib/signrequest_client/models/document_attachment.rb +5 -0
  43. data/lib/signrequest_client/models/document_search.rb +60 -79
  44. data/lib/signrequest_client/models/event.rb +3 -12
  45. data/lib/signrequest_client/models/inline_prefill_tags.rb +1 -1
  46. data/lib/signrequest_client/models/inline_response_201.rb +240 -0
  47. data/lib/signrequest_client/models/inline_response_201_1.rb +226 -0
  48. data/lib/signrequest_client/models/inline_sign_request.rb +46 -38
  49. data/lib/signrequest_client/models/sign_request.rb +15 -0
  50. data/lib/signrequest_client/models/sign_request_quick_create.rb +25 -0
  51. data/lib/signrequest_client/models/signer_attachment.rb +1 -0
  52. data/lib/signrequest_client/models/signing_log.rb +7 -5
  53. data/lib/signrequest_client/models/team_member.rb +1 -10
  54. data/lib/signrequest_client/models/template.rb +3 -10
  55. data/lib/signrequest_client/models/webhook_subscription.rb +4 -12
  56. data/lib/signrequest_client/version.rb +1 -1
  57. data/pkg/signrequest_client-0.1.0.gem +0 -0
  58. data/spec/models/inline_response_201_1_spec.rb +46 -0
  59. data/spec/models/inline_response_201_spec.rb +52 -0
  60. metadata +11 -3
@@ -20,7 +20,7 @@ module SignRequestClient
20
20
  @api_client = api_client
21
21
  end
22
22
 
23
- #
23
+ # Create a Document Attachment
24
24
  #
25
25
  # @param data
26
26
  # @param [Hash] opts the optional parameters
@@ -30,7 +30,7 @@ module SignRequestClient
30
30
  return data
31
31
  end
32
32
 
33
- #
33
+ # Create a Document Attachment
34
34
  #
35
35
  # @param data
36
36
  # @param [Hash] opts the optional parameters
@@ -75,7 +75,7 @@ module SignRequestClient
75
75
  return data, status_code, headers
76
76
  end
77
77
 
78
- #
78
+ # Retrieve a list of Document Attachments
79
79
  #
80
80
  # @param [Hash] opts the optional parameters
81
81
  # @option opts [String] :document__uuid
@@ -89,7 +89,7 @@ module SignRequestClient
89
89
  return data
90
90
  end
91
91
 
92
- #
92
+ # Retrieve a list of Document Attachments
93
93
  #
94
94
  # @param [Hash] opts the optional parameters
95
95
  # @option opts [String] :document__uuid
@@ -139,7 +139,7 @@ module SignRequestClient
139
139
  return data, status_code, headers
140
140
  end
141
141
 
142
- #
142
+ # Retrieve a Document Attachment
143
143
  #
144
144
  # @param uuid
145
145
  # @param [Hash] opts the optional parameters
@@ -149,7 +149,7 @@ module SignRequestClient
149
149
  return data
150
150
  end
151
151
 
152
- #
152
+ # Retrieve a Document Attachment
153
153
  #
154
154
  # @param uuid
155
155
  # @param [Hash] opts the optional parameters
@@ -20,7 +20,7 @@ module SignRequestClient
20
20
  @api_client = api_client
21
21
  end
22
22
 
23
- #
23
+ # Create a Document
24
24
  #
25
25
  # @param data
26
26
  # @param [Hash] opts the optional parameters
@@ -30,7 +30,7 @@ module SignRequestClient
30
30
  return data
31
31
  end
32
32
 
33
- #
33
+ # Create a Document
34
34
  #
35
35
  # @param data
36
36
  # @param [Hash] opts the optional parameters
@@ -75,7 +75,7 @@ module SignRequestClient
75
75
  return data, status_code, headers
76
76
  end
77
77
 
78
- #
78
+ # Delete a Document
79
79
  #
80
80
  # @param uuid
81
81
  # @param [Hash] opts the optional parameters
@@ -85,7 +85,7 @@ module SignRequestClient
85
85
  return nil
86
86
  end
87
87
 
88
- #
88
+ # Delete a Document
89
89
  #
90
90
  # @param uuid
91
91
  # @param [Hash] opts the optional parameters
@@ -129,68 +129,7 @@ module SignRequestClient
129
129
  return data, status_code, headers
130
130
  end
131
131
 
132
- #
133
- # This is only for integration partners
134
- # @param uuid
135
- # @param data
136
- # @param [Hash] opts the optional parameters
137
- # @return [Document]
138
- def documents_delete_files(uuid, data, opts = {})
139
- data, _status_code, _headers = documents_delete_files_with_http_info(uuid, data, opts)
140
- return data
141
- end
142
-
143
- #
144
- # This is only for integration partners
145
- # @param uuid
146
- # @param data
147
- # @param [Hash] opts the optional parameters
148
- # @return [Array<(Document, Fixnum, Hash)>] Document data, response status code and response headers
149
- def documents_delete_files_with_http_info(uuid, data, opts = {})
150
- if @api_client.config.debugging
151
- @api_client.config.logger.debug "Calling API: DocumentsApi.documents_delete_files ..."
152
- end
153
- # verify the required parameter 'uuid' is set
154
- if @api_client.config.client_side_validation && uuid.nil?
155
- fail ArgumentError, "Missing the required parameter 'uuid' when calling DocumentsApi.documents_delete_files"
156
- end
157
- # verify the required parameter 'data' is set
158
- if @api_client.config.client_side_validation && data.nil?
159
- fail ArgumentError, "Missing the required parameter 'data' when calling DocumentsApi.documents_delete_files"
160
- end
161
- # resource path
162
- local_var_path = "/documents/{uuid}/delete_files/".sub('{' + 'uuid' + '}', uuid.to_s)
163
-
164
- # query parameters
165
- query_params = {}
166
-
167
- # header parameters
168
- header_params = {}
169
- # HTTP header 'Accept' (if needed)
170
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
171
- # HTTP header 'Content-Type'
172
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
173
-
174
- # form parameters
175
- form_params = {}
176
-
177
- # http body (model)
178
- post_body = @api_client.object_to_http_body(data)
179
- auth_names = ['Token']
180
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
181
- :header_params => header_params,
182
- :query_params => query_params,
183
- :form_params => form_params,
184
- :body => post_body,
185
- :auth_names => auth_names,
186
- :return_type => 'Document')
187
- if @api_client.config.debugging
188
- @api_client.config.logger.debug "API called: DocumentsApi#documents_delete_files\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
189
- end
190
- return data, status_code, headers
191
- end
192
-
193
- #
132
+ # Retrieve a list of Documents
194
133
  #
195
134
  # @param [Hash] opts the optional parameters
196
135
  # @option opts [String] :external_id
@@ -210,7 +149,7 @@ module SignRequestClient
210
149
  return data
211
150
  end
212
151
 
213
- #
152
+ # Retrieve a list of Documents
214
153
  #
215
154
  # @param [Hash] opts the optional parameters
216
155
  # @option opts [String] :external_id
@@ -272,7 +211,7 @@ module SignRequestClient
272
211
  return data, status_code, headers
273
212
  end
274
213
 
275
- #
214
+ # Retrieve a Document
276
215
  #
277
216
  # @param uuid
278
217
  # @param [Hash] opts the optional parameters
@@ -282,7 +221,7 @@ module SignRequestClient
282
221
  return data
283
222
  end
284
223
 
285
- #
224
+ # Retrieve a Document
286
225
  #
287
226
  # @param uuid
288
227
  # @param [Hash] opts the optional parameters
@@ -20,22 +20,40 @@ module SignRequestClient
20
20
  @api_client = api_client
21
21
  end
22
22
 
23
- #
24
- # ## Search interface for fast (autocomplete) searching of documents. This can be useful to have your users search for a document in your interface. Document names are tokenized on whitespace, hyphens and underscores to also match partial document names. *Normal search:* - ?**q**={{query}} *Autocomplete search:* - ?**autocomplete**={{partial query}} *Search in document name:* - ?**name**={{query}} *Available (extra) filters:* - ?**subdomain**={{ team_subdomain }} or use this endpoint with team_subdomain.signrequest.com (when not provided only personal documents are shown) - ?**signer_emails**={{ signer@email.com }} (will filter documents that an email needed to sign/approve) - ?**status**={{ si }} - ?**who**={{ mo }} To include multiple values for a filter field separate the values with a pipe (|). For example to only search for completed documents use **status=se|vi** (sent and viewed). *Pagination:* - ?**page**={{ page_number: default 1 }} - ?**limit**={{ limit results: default 10, max 100 }} *Format:* By default json is returned, to export data as csv or xls use the format parameter. - ?**format**=csv - ?**format**=xls For csv and xls the data can also be exported with each signer on a separate row. In this mode also the signer inputs that have an *external_id* specified on a tag will be exported. All external_id's found will be exported as columns. To use this mode add the **signer_data** parameter. - ?**format**=csv&**signer_data**=1 - ?**format**=xls&**signer_data**=1 Note that all documents are only ordered by **created** (newest first) when **q**, **autocomplete** or **name** are not used, else they are ordered by the strenght of the match.
23
+ # Search documents
24
+ # Search interface for fast (autocomplete) searching of documents. This can be useful to have your users search for a document in your interface. Document names are tokenized on whitespace, hyphens and underscores to also match partial document names. *Normal search:* - ?**q**={{query}} *Autocomplete search:* - ?**autocomplete**={{partial query}} *Search in document name:* - ?**name**={{query}} *Available (extra) filters:* - ?**subdomain**={{ team_subdomain }} or use this endpoint with team_subdomain.signrequest.com (when not provided only personal documents are shown) - ?**signer_emails**={{ signer@email.com }} (will filter documents that an email needed to sign/approve) - ?**status**={{ si }} - ?**who**={{ mo }} To include multiple values for a filter field separate the values with a pipe (|). For example to only search for completed documents use **status=se|vi** (sent and viewed). *Pagination:* - ?**page**={{ page_number: default 1 }} - ?**limit**={{ limit results: default 10, max 100 }} *Format:* By default json is returned, to export data as csv or xls use the format parameter. - ?**format**=csv - ?**format**=xls For csv and xls the data can also be exported with each signer on a separate row. In this mode also the signer inputs that have an *external_id* specified on a tag will be exported. All external_id's found will be exported as columns. To use this mode add the **signer_data** parameter. - ?**format**=csv&**signer_data**=1 - ?**format**=xls&**signer_data**=1 Note that all documents are only ordered by **created** (newest first) when **q**, **autocomplete** or **name** are not used, else they are ordered by the strenght of the match.
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @option opts [Integer] :page A page number within the paginated result set.
27
27
  # @option opts [Integer] :limit Number of results to return per page.
28
+ # @option opts [String] :q Normal search query
29
+ # @option opts [String] :autocomplete Partial search query
30
+ # @option opts [String] :name Document name
31
+ # @option opts [String] :subdomain
32
+ # @option opts [String] :signer_emails Email needed to sign/approve
33
+ # @option opts [String] :status &#x60;co&#x60;: converting, &#x60;ne&#x60;: new, &#x60;se&#x60;: sent, &#x60;vi&#x60;: viewed, &#x60;si&#x60;: signed, &#x60;do&#x60;: downloaded, &#x60;sd&#x60;: signed and downloaded, &#x60;ca&#x60;: cancelled, &#x60;de&#x60;: declined, &#x60;ec&#x60;: error converting, &#x60;es&#x60;: error sending, &#x60;xp&#x60;: expired
34
+ # @option opts [String] :who &#x60;m&#x60;: only me, &#x60;mo&#x60;: me and others, &#x60;o&#x60;: only others
35
+ # @option opts [String] :format Export format, can be &#x60;json&#x60; (default), &#x60;csv&#x60;, or &#x60;xls&#x60;
36
+ # @option opts [Float] :signer_data Set to &#x60;1&#x60; to export with each signer on a separate row
28
37
  # @return [InlineResponse2002]
29
38
  def documents_search_list(opts = {})
30
39
  data, _status_code, _headers = documents_search_list_with_http_info(opts)
31
40
  return data
32
41
  end
33
42
 
34
- #
35
- # ## Search interface for fast (autocomplete) searching of documents. This can be useful to have your users search for a document in your interface. Document names are tokenized on whitespace, hyphens and underscores to also match partial document names. *Normal search:* - ?**q**&#x3D;{{query}} *Autocomplete search:* - ?**autocomplete**&#x3D;{{partial query}} *Search in document name:* - ?**name**&#x3D;{{query}} *Available (extra) filters:* - ?**subdomain**&#x3D;{{ team_subdomain }} or use this endpoint with team_subdomain.signrequest.com (when not provided only personal documents are shown) - ?**signer_emails**&#x3D;{{ signer@email.com }} (will filter documents that an email needed to sign/approve) - ?**status**&#x3D;{{ si }} - ?**who**&#x3D;{{ mo }} To include multiple values for a filter field separate the values with a pipe (|). For example to only search for completed documents use **status&#x3D;se|vi** (sent and viewed). *Pagination:* - ?**page**&#x3D;{{ page_number: default 1 }} - ?**limit**&#x3D;{{ limit results: default 10, max 100 }} *Format:* By default json is returned, to export data as csv or xls use the format parameter. - ?**format**&#x3D;csv - ?**format**&#x3D;xls For csv and xls the data can also be exported with each signer on a separate row. In this mode also the signer inputs that have an *external_id* specified on a tag will be exported. All external_id&#39;s found will be exported as columns. To use this mode add the **signer_data** parameter. - ?**format**&#x3D;csv&amp;**signer_data**&#x3D;1 - ?**format**&#x3D;xls&amp;**signer_data**&#x3D;1 Note that all documents are only ordered by **created** (newest first) when **q**, **autocomplete** or **name** are not used, else they are ordered by the strenght of the match.
43
+ # Search documents
44
+ # Search interface for fast (autocomplete) searching of documents. This can be useful to have your users search for a document in your interface. Document names are tokenized on whitespace, hyphens and underscores to also match partial document names. *Normal search:* - ?**q**&#x3D;{{query}} *Autocomplete search:* - ?**autocomplete**&#x3D;{{partial query}} *Search in document name:* - ?**name**&#x3D;{{query}} *Available (extra) filters:* - ?**subdomain**&#x3D;{{ team_subdomain }} or use this endpoint with team_subdomain.signrequest.com (when not provided only personal documents are shown) - ?**signer_emails**&#x3D;{{ signer@email.com }} (will filter documents that an email needed to sign/approve) - ?**status**&#x3D;{{ si }} - ?**who**&#x3D;{{ mo }} To include multiple values for a filter field separate the values with a pipe (|). For example to only search for completed documents use **status&#x3D;se|vi** (sent and viewed). *Pagination:* - ?**page**&#x3D;{{ page_number: default 1 }} - ?**limit**&#x3D;{{ limit results: default 10, max 100 }} *Format:* By default json is returned, to export data as csv or xls use the format parameter. - ?**format**&#x3D;csv - ?**format**&#x3D;xls For csv and xls the data can also be exported with each signer on a separate row. In this mode also the signer inputs that have an *external_id* specified on a tag will be exported. All external_id&#39;s found will be exported as columns. To use this mode add the **signer_data** parameter. - ?**format**&#x3D;csv&amp;**signer_data**&#x3D;1 - ?**format**&#x3D;xls&amp;**signer_data**&#x3D;1 Note that all documents are only ordered by **created** (newest first) when **q**, **autocomplete** or **name** are not used, else they are ordered by the strenght of the match.
36
45
  # @param [Hash] opts the optional parameters
37
46
  # @option opts [Integer] :page A page number within the paginated result set.
38
47
  # @option opts [Integer] :limit Number of results to return per page.
48
+ # @option opts [String] :q Normal search query
49
+ # @option opts [String] :autocomplete Partial search query
50
+ # @option opts [String] :name Document name
51
+ # @option opts [String] :subdomain
52
+ # @option opts [String] :signer_emails Email needed to sign/approve
53
+ # @option opts [String] :status &#x60;co&#x60;: converting, &#x60;ne&#x60;: new, &#x60;se&#x60;: sent, &#x60;vi&#x60;: viewed, &#x60;si&#x60;: signed, &#x60;do&#x60;: downloaded, &#x60;sd&#x60;: signed and downloaded, &#x60;ca&#x60;: cancelled, &#x60;de&#x60;: declined, &#x60;ec&#x60;: error converting, &#x60;es&#x60;: error sending, &#x60;xp&#x60;: expired
54
+ # @option opts [String] :who &#x60;m&#x60;: only me, &#x60;mo&#x60;: me and others, &#x60;o&#x60;: only others
55
+ # @option opts [String] :format Export format, can be &#x60;json&#x60; (default), &#x60;csv&#x60;, or &#x60;xls&#x60;
56
+ # @option opts [Float] :signer_data Set to &#x60;1&#x60; to export with each signer on a separate row
39
57
  # @return [Array<(InlineResponse2002, Fixnum, Hash)>] InlineResponse2002 data, response status code and response headers
40
58
  def documents_search_list_with_http_info(opts = {})
41
59
  if @api_client.config.debugging
@@ -48,6 +66,15 @@ module SignRequestClient
48
66
  query_params = {}
49
67
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
50
68
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
69
+ query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
70
+ query_params[:'autocomplete'] = opts[:'autocomplete'] if !opts[:'autocomplete'].nil?
71
+ query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
72
+ query_params[:'subdomain'] = opts[:'subdomain'] if !opts[:'subdomain'].nil?
73
+ query_params[:'signer_emails'] = opts[:'signer_emails'] if !opts[:'signer_emails'].nil?
74
+ query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
75
+ query_params[:'who'] = opts[:'who'] if !opts[:'who'].nil?
76
+ query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
77
+ query_params[:'signer_data'] = opts[:'signer_data'] if !opts[:'signer_data'].nil?
51
78
 
52
79
  # header parameters
53
80
  header_params = {}
@@ -74,60 +101,5 @@ module SignRequestClient
74
101
  end
75
102
  return data, status_code, headers
76
103
  end
77
-
78
- #
79
- # ## Search interface for fast (autocomplete) searching of documents. This can be useful to have your users search for a document in your interface. Document names are tokenized on whitespace, hyphens and underscores to also match partial document names. *Normal search:* - ?**q**={{query}} *Autocomplete search:* - ?**autocomplete**={{partial query}} *Search in document name:* - ?**name**={{query}} *Available (extra) filters:* - ?**subdomain**={{ team_subdomain }} or use this endpoint with team_subdomain.signrequest.com (when not provided only personal documents are shown) - ?**signer_emails**={{ signer@email.com }} (will filter documents that an email needed to sign/approve) - ?**status**={{ si }} - ?**who**={{ mo }} To include multiple values for a filter field separate the values with a pipe (|). For example to only search for completed documents use **status=se|vi** (sent and viewed). *Pagination:* - ?**page**={{ page_number: default 1 }} - ?**limit**={{ limit results: default 10, max 100 }} *Format:* By default json is returned, to export data as csv or xls use the format parameter. - ?**format**=csv - ?**format**=xls For csv and xls the data can also be exported with each signer on a separate row. In this mode also the signer inputs that have an *external_id* specified on a tag will be exported. All external_id's found will be exported as columns. To use this mode add the **signer_data** parameter. - ?**format**=csv&**signer_data**=1 - ?**format**=xls&**signer_data**=1 Note that all documents are only ordered by **created** (newest first) when **q**, **autocomplete** or **name** are not used, else they are ordered by the strenght of the match.
80
- # @param id
81
- # @param [Hash] opts the optional parameters
82
- # @return [DocumentSearch]
83
- def documents_search_read(id, opts = {})
84
- data, _status_code, _headers = documents_search_read_with_http_info(id, opts)
85
- return data
86
- end
87
-
88
- #
89
- # ## Search interface for fast (autocomplete) searching of documents. This can be useful to have your users search for a document in your interface. Document names are tokenized on whitespace, hyphens and underscores to also match partial document names. *Normal search:* - ?**q**&#x3D;{{query}} *Autocomplete search:* - ?**autocomplete**&#x3D;{{partial query}} *Search in document name:* - ?**name**&#x3D;{{query}} *Available (extra) filters:* - ?**subdomain**&#x3D;{{ team_subdomain }} or use this endpoint with team_subdomain.signrequest.com (when not provided only personal documents are shown) - ?**signer_emails**&#x3D;{{ signer@email.com }} (will filter documents that an email needed to sign/approve) - ?**status**&#x3D;{{ si }} - ?**who**&#x3D;{{ mo }} To include multiple values for a filter field separate the values with a pipe (|). For example to only search for completed documents use **status&#x3D;se|vi** (sent and viewed). *Pagination:* - ?**page**&#x3D;{{ page_number: default 1 }} - ?**limit**&#x3D;{{ limit results: default 10, max 100 }} *Format:* By default json is returned, to export data as csv or xls use the format parameter. - ?**format**&#x3D;csv - ?**format**&#x3D;xls For csv and xls the data can also be exported with each signer on a separate row. In this mode also the signer inputs that have an *external_id* specified on a tag will be exported. All external_id&#39;s found will be exported as columns. To use this mode add the **signer_data** parameter. - ?**format**&#x3D;csv&amp;**signer_data**&#x3D;1 - ?**format**&#x3D;xls&amp;**signer_data**&#x3D;1 Note that all documents are only ordered by **created** (newest first) when **q**, **autocomplete** or **name** are not used, else they are ordered by the strenght of the match.
90
- # @param id
91
- # @param [Hash] opts the optional parameters
92
- # @return [Array<(DocumentSearch, Fixnum, Hash)>] DocumentSearch data, response status code and response headers
93
- def documents_search_read_with_http_info(id, opts = {})
94
- if @api_client.config.debugging
95
- @api_client.config.logger.debug "Calling API: DocumentsSearchApi.documents_search_read ..."
96
- end
97
- # verify the required parameter 'id' is set
98
- if @api_client.config.client_side_validation && id.nil?
99
- fail ArgumentError, "Missing the required parameter 'id' when calling DocumentsSearchApi.documents_search_read"
100
- end
101
- # resource path
102
- local_var_path = "/documents-search/{id}/".sub('{' + 'id' + '}', id.to_s)
103
-
104
- # query parameters
105
- query_params = {}
106
-
107
- # header parameters
108
- header_params = {}
109
- # HTTP header 'Accept' (if needed)
110
- header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv', 'application/vnd.ms-excel'])
111
- # HTTP header 'Content-Type'
112
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
113
-
114
- # form parameters
115
- form_params = {}
116
-
117
- # http body (model)
118
- post_body = nil
119
- auth_names = ['Token']
120
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
121
- :header_params => header_params,
122
- :query_params => query_params,
123
- :form_params => form_params,
124
- :body => post_body,
125
- :auth_names => auth_names,
126
- :return_type => 'DocumentSearch')
127
- if @api_client.config.debugging
128
- @api_client.config.logger.debug "API called: DocumentsSearchApi#documents_search_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
129
- end
130
- return data, status_code, headers
131
- end
132
104
  end
133
105
  end
@@ -20,7 +20,7 @@ module SignRequestClient
20
20
  @api_client = api_client
21
21
  end
22
22
 
23
- #
23
+ # Retrieve a list of Events
24
24
  #
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @option opts [String] :document__uuid
@@ -44,7 +44,7 @@ module SignRequestClient
44
44
  return data
45
45
  end
46
46
 
47
- #
47
+ # Retrieve a list of Events
48
48
  #
49
49
  # @param [Hash] opts the optional parameters
50
50
  # @option opts [String] :document__uuid
@@ -114,7 +114,7 @@ module SignRequestClient
114
114
  return data, status_code, headers
115
115
  end
116
116
 
117
- #
117
+ # Retrieve an Event
118
118
  #
119
119
  # @param id A unique integer value identifying this event.
120
120
  # @param [Hash] opts the optional parameters
@@ -124,7 +124,7 @@ module SignRequestClient
124
124
  return data
125
125
  end
126
126
 
127
- #
127
+ # Retrieve an Event
128
128
  #
129
129
  # @param id A unique integer value identifying this event.
130
130
  # @param [Hash] opts the optional parameters
@@ -20,7 +20,7 @@ module SignRequestClient
20
20
  @api_client = api_client
21
21
  end
22
22
 
23
- #
23
+ # Quick create a SignRequest
24
24
  #
25
25
  # @param data
26
26
  # @param [Hash] opts the optional parameters
@@ -30,7 +30,7 @@ module SignRequestClient
30
30
  return data
31
31
  end
32
32
 
33
- #
33
+ # Quick create a SignRequest
34
34
  #
35
35
  # @param data
36
36
  # @param [Hash] opts the optional parameters
@@ -20,24 +20,22 @@ module SignRequestClient
20
20
  @api_client = api_client
21
21
  end
22
22
 
23
- #
23
+ # Cancel a SignRequest
24
24
  #
25
25
  # @param uuid
26
- # @param data
27
26
  # @param [Hash] opts the optional parameters
28
- # @return [SignRequest]
29
- def signrequests_cancel_signrequest(uuid, data, opts = {})
30
- data, _status_code, _headers = signrequests_cancel_signrequest_with_http_info(uuid, data, opts)
27
+ # @return [InlineResponse201]
28
+ def signrequests_cancel_signrequest(uuid, opts = {})
29
+ data, _status_code, _headers = signrequests_cancel_signrequest_with_http_info(uuid, opts)
31
30
  return data
32
31
  end
33
32
 
34
- #
33
+ # Cancel a SignRequest
35
34
  #
36
35
  # @param uuid
37
- # @param data
38
36
  # @param [Hash] opts the optional parameters
39
- # @return [Array<(SignRequest, Fixnum, Hash)>] SignRequest data, response status code and response headers
40
- def signrequests_cancel_signrequest_with_http_info(uuid, data, opts = {})
37
+ # @return [Array<(InlineResponse201, Fixnum, Hash)>] InlineResponse201 data, response status code and response headers
38
+ def signrequests_cancel_signrequest_with_http_info(uuid, opts = {})
41
39
  if @api_client.config.debugging
42
40
  @api_client.config.logger.debug "Calling API: SignrequestsApi.signrequests_cancel_signrequest ..."
43
41
  end
@@ -45,10 +43,6 @@ module SignRequestClient
45
43
  if @api_client.config.client_side_validation && uuid.nil?
46
44
  fail ArgumentError, "Missing the required parameter 'uuid' when calling SignrequestsApi.signrequests_cancel_signrequest"
47
45
  end
48
- # verify the required parameter 'data' is set
49
- if @api_client.config.client_side_validation && data.nil?
50
- fail ArgumentError, "Missing the required parameter 'data' when calling SignrequestsApi.signrequests_cancel_signrequest"
51
- end
52
46
  # resource path
53
47
  local_var_path = "/signrequests/{uuid}/cancel_signrequest/".sub('{' + 'uuid' + '}', uuid.to_s)
54
48
 
@@ -66,7 +60,7 @@ module SignRequestClient
66
60
  form_params = {}
67
61
 
68
62
  # http body (model)
69
- post_body = @api_client.object_to_http_body(data)
63
+ post_body = nil
70
64
  auth_names = ['Token']
71
65
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
72
66
  :header_params => header_params,
@@ -74,14 +68,14 @@ module SignRequestClient
74
68
  :form_params => form_params,
75
69
  :body => post_body,
76
70
  :auth_names => auth_names,
77
- :return_type => 'SignRequest')
71
+ :return_type => 'InlineResponse201')
78
72
  if @api_client.config.debugging
79
73
  @api_client.config.logger.debug "API called: SignrequestsApi#signrequests_cancel_signrequest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
80
74
  end
81
75
  return data, status_code, headers
82
76
  end
83
77
 
84
- #
78
+ # Create a SignRequest
85
79
  #
86
80
  # @param data
87
81
  # @param [Hash] opts the optional parameters
@@ -91,7 +85,7 @@ module SignRequestClient
91
85
  return data
92
86
  end
93
87
 
94
- #
88
+ # Create a SignRequest
95
89
  #
96
90
  # @param data
97
91
  # @param [Hash] opts the optional parameters
@@ -136,7 +130,7 @@ module SignRequestClient
136
130
  return data, status_code, headers
137
131
  end
138
132
 
139
- #
133
+ # Retrieve a list of SignRequests
140
134
  #
141
135
  # @param [Hash] opts the optional parameters
142
136
  # @option opts [String] :who
@@ -149,7 +143,7 @@ module SignRequestClient
149
143
  return data
150
144
  end
151
145
 
152
- #
146
+ # Retrieve a list of SignRequests
153
147
  #
154
148
  # @param [Hash] opts the optional parameters
155
149
  # @option opts [String] :who
@@ -197,7 +191,7 @@ module SignRequestClient
197
191
  return data, status_code, headers
198
192
  end
199
193
 
200
- #
194
+ # Retrieve a SignRequest
201
195
  #
202
196
  # @param uuid
203
197
  # @param [Hash] opts the optional parameters
@@ -207,7 +201,7 @@ module SignRequestClient
207
201
  return data
208
202
  end
209
203
 
210
- #
204
+ # Retrieve a SignRequest
211
205
  #
212
206
  # @param uuid
213
207
  # @param [Hash] opts the optional parameters
@@ -252,24 +246,22 @@ module SignRequestClient
252
246
  return data, status_code, headers
253
247
  end
254
248
 
255
- #
249
+ # Resend a SignRequest
256
250
  #
257
251
  # @param uuid
258
- # @param data
259
252
  # @param [Hash] opts the optional parameters
260
- # @return [SignRequest]
261
- def signrequests_resend_signrequest_email(uuid, data, opts = {})
262
- data, _status_code, _headers = signrequests_resend_signrequest_email_with_http_info(uuid, data, opts)
253
+ # @return [InlineResponse2011]
254
+ def signrequests_resend_signrequest_email(uuid, opts = {})
255
+ data, _status_code, _headers = signrequests_resend_signrequest_email_with_http_info(uuid, opts)
263
256
  return data
264
257
  end
265
258
 
266
- #
259
+ # Resend a SignRequest
267
260
  #
268
261
  # @param uuid
269
- # @param data
270
262
  # @param [Hash] opts the optional parameters
271
- # @return [Array<(SignRequest, Fixnum, Hash)>] SignRequest data, response status code and response headers
272
- def signrequests_resend_signrequest_email_with_http_info(uuid, data, opts = {})
263
+ # @return [Array<(InlineResponse2011, Fixnum, Hash)>] InlineResponse2011 data, response status code and response headers
264
+ def signrequests_resend_signrequest_email_with_http_info(uuid, opts = {})
273
265
  if @api_client.config.debugging
274
266
  @api_client.config.logger.debug "Calling API: SignrequestsApi.signrequests_resend_signrequest_email ..."
275
267
  end
@@ -277,10 +269,6 @@ module SignRequestClient
277
269
  if @api_client.config.client_side_validation && uuid.nil?
278
270
  fail ArgumentError, "Missing the required parameter 'uuid' when calling SignrequestsApi.signrequests_resend_signrequest_email"
279
271
  end
280
- # verify the required parameter 'data' is set
281
- if @api_client.config.client_side_validation && data.nil?
282
- fail ArgumentError, "Missing the required parameter 'data' when calling SignrequestsApi.signrequests_resend_signrequest_email"
283
- end
284
272
  # resource path
285
273
  local_var_path = "/signrequests/{uuid}/resend_signrequest_email/".sub('{' + 'uuid' + '}', uuid.to_s)
286
274
 
@@ -298,7 +286,7 @@ module SignRequestClient
298
286
  form_params = {}
299
287
 
300
288
  # http body (model)
301
- post_body = @api_client.object_to_http_body(data)
289
+ post_body = nil
302
290
  auth_names = ['Token']
303
291
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
304
292
  :header_params => header_params,
@@ -306,7 +294,7 @@ module SignRequestClient
306
294
  :form_params => form_params,
307
295
  :body => post_body,
308
296
  :auth_names => auth_names,
309
- :return_type => 'SignRequest')
297
+ :return_type => 'InlineResponse2011')
310
298
  if @api_client.config.debugging
311
299
  @api_client.config.logger.debug "API called: SignrequestsApi#signrequests_resend_signrequest_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
312
300
  end