yousign_client 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/README.md +230 -0
- data/Rakefile +8 -0
- data/config.json +11 -0
- data/docs/AuthenticationEmailOutput.md +10 -0
- data/docs/AuthenticationInweboOutput.md +10 -0
- data/docs/AuthenticationSmsOutput.md +10 -0
- data/docs/AuthenticationsApi.md +320 -0
- data/docs/Body.md +8 -0
- data/docs/Body1.md +9 -0
- data/docs/Body2.md +9 -0
- data/docs/CheckDocumentBankAccountsInput.md +13 -0
- data/docs/CheckDocumentBankAccountsOutput.md +24 -0
- data/docs/CheckDocumentIdentitiesInput.md +11 -0
- data/docs/CheckDocumentIdentitiesOutput.md +28 -0
- data/docs/CheckDocumentsApi.md +210 -0
- data/docs/ConfigEmailTemplate.md +11 -0
- data/docs/ConfigWebhookTemplate.md +10 -0
- data/docs/ConsentProcessInput.md +14 -0
- data/docs/ConsentProcessOutput.md +15 -0
- data/docs/ConsentProcessValueInput.md +10 -0
- data/docs/ConsentProcessValueOutput.md +12 -0
- data/docs/ConsentProcessesApi.md +422 -0
- data/docs/FileInput.md +15 -0
- data/docs/FileInputMetadata.md +9 -0
- data/docs/FileObjectInput.md +21 -0
- data/docs/FileObjectInputWithoutFileReference.md +13 -0
- data/docs/FileObjectOutput.md +24 -0
- data/docs/FileObjectOutputWithoutFileReference.md +17 -0
- data/docs/FileObjectsApi.md +220 -0
- data/docs/FileOutput.md +19 -0
- data/docs/FilesApi.md +218 -0
- data/docs/InlineResponse400.md +8 -0
- data/docs/InweboUserRequest.md +8 -0
- data/docs/MemberInput.md +19 -0
- data/docs/MemberOutput.md +24 -0
- data/docs/MembersApi.md +272 -0
- data/docs/ModeSmsConfiguration.md +8 -0
- data/docs/OperationInput.md +14 -0
- data/docs/OperationOutput.md +15 -0
- data/docs/OperationOutputMetadata.md +9 -0
- data/docs/OperationsApi.md +109 -0
- data/docs/OrganizationBillingAddress.md +16 -0
- data/docs/OrganizationOutput.md +41 -0
- data/docs/OrganizationsApi.md +54 -0
- data/docs/ProcedureConfig.md +10 -0
- data/docs/ProcedureConfigEmail.md +15 -0
- data/docs/ProcedureConfigReminder.md +10 -0
- data/docs/ProcedureConfigReminderConfig.md +8 -0
- data/docs/ProcedureConfigReminderConfigEmail.md +8 -0
- data/docs/ProcedureConfigWebhook.md +15 -0
- data/docs/ProcedureDuplicateInput.md +9 -0
- data/docs/ProcedureInput.md +18 -0
- data/docs/ProcedureInputMetadata.md +9 -0
- data/docs/ProcedureOutput.md +27 -0
- data/docs/ProcedureOutputMetadata.md +9 -0
- data/docs/ProcedureRemindConfig.md +8 -0
- data/docs/ProcedureRemindConfigEmail.md +8 -0
- data/docs/ProcedureRemindInput.md +8 -0
- data/docs/ProceduresApi.md +527 -0
- data/docs/ServerStampConfig.md +8 -0
- data/docs/ServerStampConfigWebhook.md +8 -0
- data/docs/ServerStampInput.md +12 -0
- data/docs/ServerStampOutput.md +17 -0
- data/docs/ServerStampsApi.md +109 -0
- data/docs/SignatureUIsApi.md +545 -0
- data/docs/SignatureUiInput.md +28 -0
- data/docs/SignatureUiInputRedirectCancel.md +10 -0
- data/docs/SignatureUiInputRedirectError.md +10 -0
- data/docs/SignatureUiInputRedirectSuccess.md +10 -0
- data/docs/SignatureUiInputUpdate.md +27 -0
- data/docs/SignatureUiLabelInput.md +10 -0
- data/docs/SignatureUiLabelInputIncluded.md +9 -0
- data/docs/SignatureUiLabelOutput.md +14 -0
- data/docs/SignatureUiOutput.md +33 -0
- data/docs/SignatureUiOutputRedirectCancel.md +10 -0
- data/docs/SignatureUiOutputRedirectError.md +10 -0
- data/docs/SignatureUiOutputRedirectSuccess.md +10 -0
- data/docs/UserGroup.md +10 -0
- data/docs/UserGroupsApi.md +103 -0
- data/docs/UserInput.md +17 -0
- data/docs/UserInputNotifications.md +8 -0
- data/docs/UserOutput.md +29 -0
- data/docs/UserOutputNotifications.md +8 -0
- data/docs/UserWorkspaceOutput.md +9 -0
- data/docs/UsersApi.md +258 -0
- data/docs/WorkspaceConfig.md +10 -0
- data/docs/WorkspaceConfigEmail.md +15 -0
- data/docs/WorkspaceConfigProcedure.md +8 -0
- data/docs/WorkspaceOutput.md +16 -0
- data/docs/WorkspacesApi.md +54 -0
- data/git_push.sh +55 -0
- data/lib/yousign_client.rb +126 -0
- data/lib/yousign_client/api/authentications_api.rb +410 -0
- data/lib/yousign_client/api/check_documents_api.rb +269 -0
- data/lib/yousign_client/api/consent_processes_api.rb +528 -0
- data/lib/yousign_client/api/file_objects_api.rb +282 -0
- data/lib/yousign_client/api/files_api.rb +279 -0
- data/lib/yousign_client/api/members_api.rb +340 -0
- data/lib/yousign_client/api/operations_api.rb +148 -0
- data/lib/yousign_client/api/organizations_api.rb +76 -0
- data/lib/yousign_client/api/procedures_api.rb +680 -0
- data/lib/yousign_client/api/server_stamps_api.rb +146 -0
- data/lib/yousign_client/api/signature_u_is_api.rb +669 -0
- data/lib/yousign_client/api/user_groups_api.rb +135 -0
- data/lib/yousign_client/api/users_api.rb +327 -0
- data/lib/yousign_client/api/workspaces_api.rb +76 -0
- data/lib/yousign_client/api_client.rb +391 -0
- data/lib/yousign_client/api_error.rb +38 -0
- data/lib/yousign_client/configuration.rb +209 -0
- data/lib/yousign_client/models/authentication_email_output.rb +239 -0
- data/lib/yousign_client/models/authentication_inwebo_output.rb +239 -0
- data/lib/yousign_client/models/authentication_sms_output.rb +239 -0
- data/lib/yousign_client/models/body.rb +185 -0
- data/lib/yousign_client/models/body_1.rb +200 -0
- data/lib/yousign_client/models/body_2.rb +200 -0
- data/lib/yousign_client/models/check_document_bank_accounts_input.rb +240 -0
- data/lib/yousign_client/models/check_document_bank_accounts_output.rb +394 -0
- data/lib/yousign_client/models/check_document_identities_input.rb +222 -0
- data/lib/yousign_client/models/check_document_identities_output.rb +440 -0
- data/lib/yousign_client/models/config_email_template.rb +256 -0
- data/lib/yousign_client/models/config_webhook_template.rb +246 -0
- data/lib/yousign_client/models/consent_process_input.rb +293 -0
- data/lib/yousign_client/models/consent_process_output.rb +298 -0
- data/lib/yousign_client/models/consent_process_value_input.rb +215 -0
- data/lib/yousign_client/models/consent_process_value_output.rb +235 -0
- data/lib/yousign_client/models/file_input.rb +304 -0
- data/lib/yousign_client/models/file_input_metadata.rb +194 -0
- data/lib/yousign_client/models/file_object_input.rb +445 -0
- data/lib/yousign_client/models/file_object_input_without_file_reference.rb +252 -0
- data/lib/yousign_client/models/file_object_output.rb +489 -0
- data/lib/yousign_client/models/file_object_output_without_file_reference.rb +307 -0
- data/lib/yousign_client/models/file_output.rb +374 -0
- data/lib/yousign_client/models/inline_response_400.rb +185 -0
- data/lib/yousign_client/models/inwebo_user_request.rb +200 -0
- data/lib/yousign_client/models/member_input.rb +343 -0
- data/lib/yousign_client/models/member_output.rb +432 -0
- data/lib/yousign_client/models/mode_sms_configuration.rb +190 -0
- data/lib/yousign_client/models/operation_input.rb +313 -0
- data/lib/yousign_client/models/operation_output.rb +311 -0
- data/lib/yousign_client/models/operation_output_metadata.rb +194 -0
- data/lib/yousign_client/models/organization_billing_address.rb +256 -0
- data/lib/yousign_client/models/organization_output.rb +530 -0
- data/lib/yousign_client/models/procedure_config.rb +204 -0
- data/lib/yousign_client/models/procedure_config_email.rb +263 -0
- data/lib/yousign_client/models/procedure_config_reminder.rb +256 -0
- data/lib/yousign_client/models/procedure_config_reminder_config.rb +184 -0
- data/lib/yousign_client/models/procedure_config_reminder_config_email.rb +186 -0
- data/lib/yousign_client/models/procedure_config_webhook.rb +263 -0
- data/lib/yousign_client/models/procedure_duplicate_input.rb +197 -0
- data/lib/yousign_client/models/procedure_input.rb +289 -0
- data/lib/yousign_client/models/procedure_input_metadata.rb +194 -0
- data/lib/yousign_client/models/procedure_output.rb +457 -0
- data/lib/yousign_client/models/procedure_output_metadata.rb +194 -0
- data/lib/yousign_client/models/procedure_remind_config.rb +184 -0
- data/lib/yousign_client/models/procedure_remind_config_email.rb +186 -0
- data/lib/yousign_client/models/procedure_remind_input.rb +184 -0
- data/lib/yousign_client/models/server_stamp_config.rb +184 -0
- data/lib/yousign_client/models/server_stamp_config_webhook.rb +186 -0
- data/lib/yousign_client/models/server_stamp_input.rb +242 -0
- data/lib/yousign_client/models/server_stamp_output.rb +352 -0
- data/lib/yousign_client/models/signature_ui_input.rb +456 -0
- data/lib/yousign_client/models/signature_ui_input_redirect_cancel.rb +244 -0
- data/lib/yousign_client/models/signature_ui_input_redirect_error.rb +247 -0
- data/lib/yousign_client/models/signature_ui_input_redirect_success.rb +242 -0
- data/lib/yousign_client/models/signature_ui_input_update.rb +421 -0
- data/lib/yousign_client/models/signature_ui_label_input.rb +210 -0
- data/lib/yousign_client/models/signature_ui_label_input_included.rb +200 -0
- data/lib/yousign_client/models/signature_ui_label_output.rb +245 -0
- data/lib/yousign_client/models/signature_ui_output.rb +481 -0
- data/lib/yousign_client/models/signature_ui_output_redirect_cancel.rb +242 -0
- data/lib/yousign_client/models/signature_ui_output_redirect_error.rb +247 -0
- data/lib/yousign_client/models/signature_ui_output_redirect_success.rb +242 -0
- data/lib/yousign_client/models/user_group.rb +249 -0
- data/lib/yousign_client/models/user_input.rb +341 -0
- data/lib/yousign_client/models/user_input_notifications.rb +185 -0
- data/lib/yousign_client/models/user_output.rb +457 -0
- data/lib/yousign_client/models/user_output_notifications.rb +185 -0
- data/lib/yousign_client/models/user_workspace_output.rb +210 -0
- data/lib/yousign_client/models/workspace_config.rb +226 -0
- data/lib/yousign_client/models/workspace_config_email.rb +263 -0
- data/lib/yousign_client/models/workspace_config_procedure.rb +208 -0
- data/lib/yousign_client/models/workspace_output.rb +275 -0
- data/lib/yousign_client/version.rb +15 -0
- data/spec/api/authentications_api_spec.rb +113 -0
- data/spec/api/check_documents_api_spec.rb +85 -0
- data/spec/api/consent_processes_api_spec.rb +138 -0
- data/spec/api/file_objects_api_spec.rb +90 -0
- data/spec/api/files_api_spec.rb +89 -0
- data/spec/api/members_api_spec.rb +103 -0
- data/spec/api/operations_api_spec.rb +60 -0
- data/spec/api/organizations_api_spec.rb +46 -0
- data/spec/api/procedures_api_spec.rb +178 -0
- data/spec/api/server_stamps_api_spec.rb +60 -0
- data/spec/api/signature_u_is_api_spec.rb +170 -0
- data/spec/api/user_groups_api_spec.rb +58 -0
- data/spec/api/users_api_spec.rb +97 -0
- data/spec/api/workspaces_api_spec.rb +46 -0
- data/spec/api_client_spec.rb +243 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/authentication_email_output_spec.rb +57 -0
- data/spec/models/authentication_inwebo_output_spec.rb +57 -0
- data/spec/models/authentication_sms_output_spec.rb +57 -0
- data/spec/models/body_1_spec.rb +47 -0
- data/spec/models/body_2_spec.rb +47 -0
- data/spec/models/body_spec.rb +41 -0
- data/spec/models/check_document_bank_accounts_input_spec.rb +71 -0
- data/spec/models/check_document_bank_accounts_output_spec.rb +141 -0
- data/spec/models/check_document_identities_input_spec.rb +59 -0
- data/spec/models/check_document_identities_output_spec.rb +165 -0
- data/spec/models/config_email_template_spec.rb +63 -0
- data/spec/models/config_webhook_template_spec.rb +57 -0
- data/spec/models/consent_process_input_spec.rb +81 -0
- data/spec/models/consent_process_output_spec.rb +87 -0
- data/spec/models/consent_process_value_input_spec.rb +53 -0
- data/spec/models/consent_process_value_output_spec.rb +65 -0
- data/spec/models/file_input_metadata_spec.rb +47 -0
- data/spec/models/file_input_spec.rb +87 -0
- data/spec/models/file_object_input_spec.rb +127 -0
- data/spec/models/file_object_input_without_file_reference_spec.rb +71 -0
- data/spec/models/file_object_output_spec.rb +145 -0
- data/spec/models/file_object_output_without_file_reference_spec.rb +95 -0
- data/spec/models/file_output_spec.rb +111 -0
- data/spec/models/inline_response_400_spec.rb +41 -0
- data/spec/models/inwebo_user_request_spec.rb +41 -0
- data/spec/models/member_input_spec.rb +119 -0
- data/spec/models/member_output_spec.rb +153 -0
- data/spec/models/mode_sms_configuration_spec.rb +41 -0
- data/spec/models/operation_input_spec.rb +89 -0
- data/spec/models/operation_output_metadata_spec.rb +47 -0
- data/spec/models/operation_output_spec.rb +95 -0
- data/spec/models/organization_billing_address_spec.rb +89 -0
- data/spec/models/organization_output_spec.rb +239 -0
- data/spec/models/procedure_config_email_spec.rb +83 -0
- data/spec/models/procedure_config_reminder_config_email_spec.rb +41 -0
- data/spec/models/procedure_config_reminder_config_spec.rb +41 -0
- data/spec/models/procedure_config_reminder_spec.rb +53 -0
- data/spec/models/procedure_config_spec.rb +53 -0
- data/spec/models/procedure_config_webhook_spec.rb +83 -0
- data/spec/models/procedure_duplicate_input_spec.rb +47 -0
- data/spec/models/procedure_input_metadata_spec.rb +47 -0
- data/spec/models/procedure_input_spec.rb +101 -0
- data/spec/models/procedure_output_metadata_spec.rb +47 -0
- data/spec/models/procedure_output_spec.rb +159 -0
- data/spec/models/procedure_remind_config_email_spec.rb +41 -0
- data/spec/models/procedure_remind_config_spec.rb +41 -0
- data/spec/models/procedure_remind_input_spec.rb +41 -0
- data/spec/models/server_stamp_config_spec.rb +41 -0
- data/spec/models/server_stamp_config_webhook_spec.rb +41 -0
- data/spec/models/server_stamp_input_spec.rb +65 -0
- data/spec/models/server_stamp_output_spec.rb +99 -0
- data/spec/models/signature_ui_input_redirect_cancel_spec.rb +57 -0
- data/spec/models/signature_ui_input_redirect_error_spec.rb +57 -0
- data/spec/models/signature_ui_input_redirect_success_spec.rb +57 -0
- data/spec/models/signature_ui_input_spec.rb +165 -0
- data/spec/models/signature_ui_input_update_spec.rb +159 -0
- data/spec/models/signature_ui_label_input_included_spec.rb +47 -0
- data/spec/models/signature_ui_label_input_spec.rb +53 -0
- data/spec/models/signature_ui_label_output_spec.rb +77 -0
- data/spec/models/signature_ui_output_redirect_cancel_spec.rb +57 -0
- data/spec/models/signature_ui_output_redirect_error_spec.rb +57 -0
- data/spec/models/signature_ui_output_redirect_success_spec.rb +57 -0
- data/spec/models/signature_ui_output_spec.rb +195 -0
- data/spec/models/user_group_spec.rb +57 -0
- data/spec/models/user_input_notifications_spec.rb +41 -0
- data/spec/models/user_input_spec.rb +99 -0
- data/spec/models/user_output_notifications_spec.rb +41 -0
- data/spec/models/user_output_spec.rb +171 -0
- data/spec/models/user_workspace_output_spec.rb +47 -0
- data/spec/models/workspace_config_email_spec.rb +83 -0
- data/spec/models/workspace_config_procedure_spec.rb +45 -0
- data/spec/models/workspace_config_spec.rb +57 -0
- data/spec/models/workspace_output_spec.rb +89 -0
- data/spec/spec_helper.rb +111 -0
- data/update_client.sh +11 -0
- data/yousign_client.gemspec +45 -0
- data/yousign_openapi.json +5417 -0
- metadata +590 -0
@@ -0,0 +1,282 @@
|
|
1
|
+
=begin
|
2
|
+
#Yousign API Swagger
|
3
|
+
|
4
|
+
#For your information, the Yousign API documentation is available at https://dev.yousign.com/
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.1
|
7
|
+
Contact: support@yousign.fr
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.14
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'uri'
|
14
|
+
|
15
|
+
module YousignClient
|
16
|
+
class FileObjectsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Delete a File Object
|
23
|
+
# Delete a File Object
|
24
|
+
# @param id
|
25
|
+
# @param authorization Authentication credentials for HTTP authentication
|
26
|
+
# @param [Hash] opts the optional parameters
|
27
|
+
# @return [nil]
|
28
|
+
def file_objects_id_delete(id, authorization, opts = {})
|
29
|
+
file_objects_id_delete_with_http_info(id, authorization, opts)
|
30
|
+
nil
|
31
|
+
end
|
32
|
+
|
33
|
+
# Delete a File Object
|
34
|
+
# Delete a File Object
|
35
|
+
# @param id
|
36
|
+
# @param authorization Authentication credentials for HTTP authentication
|
37
|
+
# @param [Hash] opts the optional parameters
|
38
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
39
|
+
def file_objects_id_delete_with_http_info(id, authorization, opts = {})
|
40
|
+
if @api_client.config.debugging
|
41
|
+
@api_client.config.logger.debug 'Calling API: FileObjectsApi.file_objects_id_delete ...'
|
42
|
+
end
|
43
|
+
# verify the required parameter 'id' is set
|
44
|
+
if @api_client.config.client_side_validation && id.nil?
|
45
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FileObjectsApi.file_objects_id_delete"
|
46
|
+
end
|
47
|
+
# verify the required parameter 'authorization' is set
|
48
|
+
if @api_client.config.client_side_validation && authorization.nil?
|
49
|
+
fail ArgumentError, "Missing the required parameter 'authorization' when calling FileObjectsApi.file_objects_id_delete"
|
50
|
+
end
|
51
|
+
# resource path
|
52
|
+
local_var_path = '/file_objects/{id}'.sub('{' + 'id' + '}', id.to_s)
|
53
|
+
|
54
|
+
# query parameters
|
55
|
+
query_params = {}
|
56
|
+
|
57
|
+
# header parameters
|
58
|
+
header_params = {}
|
59
|
+
# HTTP header 'Accept' (if needed)
|
60
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
61
|
+
# HTTP header 'Content-Type'
|
62
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
63
|
+
header_params[:'Authorization'] = authorization
|
64
|
+
|
65
|
+
# form parameters
|
66
|
+
form_params = {}
|
67
|
+
|
68
|
+
# http body (model)
|
69
|
+
post_body = nil
|
70
|
+
auth_names = []
|
71
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
72
|
+
:header_params => header_params,
|
73
|
+
:query_params => query_params,
|
74
|
+
:form_params => form_params,
|
75
|
+
:body => post_body,
|
76
|
+
:auth_names => auth_names)
|
77
|
+
if @api_client.config.debugging
|
78
|
+
@api_client.config.logger.debug "API called: FileObjectsApi#file_objects_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
79
|
+
end
|
80
|
+
return data, status_code, headers
|
81
|
+
end
|
82
|
+
# Find a File Object by ID
|
83
|
+
# Get a File Object
|
84
|
+
# @param id
|
85
|
+
# @param authorization Authentication credentials for HTTP authentication
|
86
|
+
# @param [Hash] opts the optional parameters
|
87
|
+
# @return [FileObjectOutput]
|
88
|
+
def file_objects_id_get(id, authorization, opts = {})
|
89
|
+
data, _status_code, _headers = file_objects_id_get_with_http_info(id, authorization, opts)
|
90
|
+
data
|
91
|
+
end
|
92
|
+
|
93
|
+
# Find a File Object by ID
|
94
|
+
# Get a File Object
|
95
|
+
# @param id
|
96
|
+
# @param authorization Authentication credentials for HTTP authentication
|
97
|
+
# @param [Hash] opts the optional parameters
|
98
|
+
# @return [Array<(FileObjectOutput, Fixnum, Hash)>] FileObjectOutput data, response status code and response headers
|
99
|
+
def file_objects_id_get_with_http_info(id, authorization, opts = {})
|
100
|
+
if @api_client.config.debugging
|
101
|
+
@api_client.config.logger.debug 'Calling API: FileObjectsApi.file_objects_id_get ...'
|
102
|
+
end
|
103
|
+
# verify the required parameter 'id' is set
|
104
|
+
if @api_client.config.client_side_validation && id.nil?
|
105
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FileObjectsApi.file_objects_id_get"
|
106
|
+
end
|
107
|
+
# verify the required parameter 'authorization' is set
|
108
|
+
if @api_client.config.client_side_validation && authorization.nil?
|
109
|
+
fail ArgumentError, "Missing the required parameter 'authorization' when calling FileObjectsApi.file_objects_id_get"
|
110
|
+
end
|
111
|
+
# resource path
|
112
|
+
local_var_path = '/file_objects/{id}'.sub('{' + 'id' + '}', id.to_s)
|
113
|
+
|
114
|
+
# query parameters
|
115
|
+
query_params = {}
|
116
|
+
|
117
|
+
# header parameters
|
118
|
+
header_params = {}
|
119
|
+
# HTTP header 'Accept' (if needed)
|
120
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
121
|
+
# HTTP header 'Content-Type'
|
122
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
123
|
+
header_params[:'Authorization'] = authorization
|
124
|
+
|
125
|
+
# form parameters
|
126
|
+
form_params = {}
|
127
|
+
|
128
|
+
# http body (model)
|
129
|
+
post_body = nil
|
130
|
+
auth_names = []
|
131
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
132
|
+
:header_params => header_params,
|
133
|
+
:query_params => query_params,
|
134
|
+
:form_params => form_params,
|
135
|
+
:body => post_body,
|
136
|
+
:auth_names => auth_names,
|
137
|
+
:return_type => 'FileObjectOutput')
|
138
|
+
if @api_client.config.debugging
|
139
|
+
@api_client.config.logger.debug "API called: FileObjectsApi#file_objects_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
140
|
+
end
|
141
|
+
return data, status_code, headers
|
142
|
+
end
|
143
|
+
# Update a File Object
|
144
|
+
# Update a File Object
|
145
|
+
# @param id
|
146
|
+
# @param authorization Authentication credentials for HTTP authentication
|
147
|
+
# @param content_type The MIME type of the body of the request
|
148
|
+
# @param body
|
149
|
+
# @param [Hash] opts the optional parameters
|
150
|
+
# @return [FileObjectOutput]
|
151
|
+
def file_objects_id_put(id, authorization, content_type, body, opts = {})
|
152
|
+
data, _status_code, _headers = file_objects_id_put_with_http_info(id, authorization, content_type, body, opts)
|
153
|
+
data
|
154
|
+
end
|
155
|
+
|
156
|
+
# Update a File Object
|
157
|
+
# Update a File Object
|
158
|
+
# @param id
|
159
|
+
# @param authorization Authentication credentials for HTTP authentication
|
160
|
+
# @param content_type The MIME type of the body of the request
|
161
|
+
# @param body
|
162
|
+
# @param [Hash] opts the optional parameters
|
163
|
+
# @return [Array<(FileObjectOutput, Fixnum, Hash)>] FileObjectOutput data, response status code and response headers
|
164
|
+
def file_objects_id_put_with_http_info(id, authorization, content_type, body, opts = {})
|
165
|
+
if @api_client.config.debugging
|
166
|
+
@api_client.config.logger.debug 'Calling API: FileObjectsApi.file_objects_id_put ...'
|
167
|
+
end
|
168
|
+
# verify the required parameter 'id' is set
|
169
|
+
if @api_client.config.client_side_validation && id.nil?
|
170
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FileObjectsApi.file_objects_id_put"
|
171
|
+
end
|
172
|
+
# verify the required parameter 'authorization' is set
|
173
|
+
if @api_client.config.client_side_validation && authorization.nil?
|
174
|
+
fail ArgumentError, "Missing the required parameter 'authorization' when calling FileObjectsApi.file_objects_id_put"
|
175
|
+
end
|
176
|
+
# verify the required parameter 'content_type' is set
|
177
|
+
if @api_client.config.client_side_validation && content_type.nil?
|
178
|
+
fail ArgumentError, "Missing the required parameter 'content_type' when calling FileObjectsApi.file_objects_id_put"
|
179
|
+
end
|
180
|
+
# verify the required parameter 'body' is set
|
181
|
+
if @api_client.config.client_side_validation && body.nil?
|
182
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling FileObjectsApi.file_objects_id_put"
|
183
|
+
end
|
184
|
+
# resource path
|
185
|
+
local_var_path = '/file_objects/{id}'.sub('{' + 'id' + '}', id.to_s)
|
186
|
+
|
187
|
+
# query parameters
|
188
|
+
query_params = {}
|
189
|
+
|
190
|
+
# header parameters
|
191
|
+
header_params = {}
|
192
|
+
# HTTP header 'Accept' (if needed)
|
193
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
194
|
+
header_params[:'Authorization'] = authorization
|
195
|
+
header_params[:'Content-Type'] = content_type
|
196
|
+
|
197
|
+
# form parameters
|
198
|
+
form_params = {}
|
199
|
+
|
200
|
+
# http body (model)
|
201
|
+
post_body = @api_client.object_to_http_body(body)
|
202
|
+
auth_names = []
|
203
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
204
|
+
:header_params => header_params,
|
205
|
+
:query_params => query_params,
|
206
|
+
:form_params => form_params,
|
207
|
+
:body => post_body,
|
208
|
+
:auth_names => auth_names,
|
209
|
+
:return_type => 'FileObjectOutput')
|
210
|
+
if @api_client.config.debugging
|
211
|
+
@api_client.config.logger.debug "API called: FileObjectsApi#file_objects_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
212
|
+
end
|
213
|
+
return data, status_code, headers
|
214
|
+
end
|
215
|
+
# Create a new File Object
|
216
|
+
# Create a new fileObject
|
217
|
+
# @param authorization Authentication credentials for HTTP authentication
|
218
|
+
# @param content_type The MIME type of the body of the request
|
219
|
+
# @param body
|
220
|
+
# @param [Hash] opts the optional parameters
|
221
|
+
# @return [FileObjectOutput]
|
222
|
+
def file_objects_post(authorization, content_type, body, opts = {})
|
223
|
+
data, _status_code, _headers = file_objects_post_with_http_info(authorization, content_type, body, opts)
|
224
|
+
data
|
225
|
+
end
|
226
|
+
|
227
|
+
# Create a new File Object
|
228
|
+
# Create a new fileObject
|
229
|
+
# @param authorization Authentication credentials for HTTP authentication
|
230
|
+
# @param content_type The MIME type of the body of the request
|
231
|
+
# @param body
|
232
|
+
# @param [Hash] opts the optional parameters
|
233
|
+
# @return [Array<(FileObjectOutput, Fixnum, Hash)>] FileObjectOutput data, response status code and response headers
|
234
|
+
def file_objects_post_with_http_info(authorization, content_type, body, opts = {})
|
235
|
+
if @api_client.config.debugging
|
236
|
+
@api_client.config.logger.debug 'Calling API: FileObjectsApi.file_objects_post ...'
|
237
|
+
end
|
238
|
+
# verify the required parameter 'authorization' is set
|
239
|
+
if @api_client.config.client_side_validation && authorization.nil?
|
240
|
+
fail ArgumentError, "Missing the required parameter 'authorization' when calling FileObjectsApi.file_objects_post"
|
241
|
+
end
|
242
|
+
# verify the required parameter 'content_type' is set
|
243
|
+
if @api_client.config.client_side_validation && content_type.nil?
|
244
|
+
fail ArgumentError, "Missing the required parameter 'content_type' when calling FileObjectsApi.file_objects_post"
|
245
|
+
end
|
246
|
+
# verify the required parameter 'body' is set
|
247
|
+
if @api_client.config.client_side_validation && body.nil?
|
248
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling FileObjectsApi.file_objects_post"
|
249
|
+
end
|
250
|
+
# resource path
|
251
|
+
local_var_path = '/file_objects'
|
252
|
+
|
253
|
+
# query parameters
|
254
|
+
query_params = {}
|
255
|
+
|
256
|
+
# header parameters
|
257
|
+
header_params = {}
|
258
|
+
# HTTP header 'Accept' (if needed)
|
259
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
260
|
+
header_params[:'Authorization'] = authorization
|
261
|
+
header_params[:'Content-Type'] = content_type
|
262
|
+
|
263
|
+
# form parameters
|
264
|
+
form_params = {}
|
265
|
+
|
266
|
+
# http body (model)
|
267
|
+
post_body = @api_client.object_to_http_body(body)
|
268
|
+
auth_names = []
|
269
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
270
|
+
:header_params => header_params,
|
271
|
+
:query_params => query_params,
|
272
|
+
:form_params => form_params,
|
273
|
+
:body => post_body,
|
274
|
+
:auth_names => auth_names,
|
275
|
+
:return_type => 'FileObjectOutput')
|
276
|
+
if @api_client.config.debugging
|
277
|
+
@api_client.config.logger.debug "API called: FileObjectsApi#file_objects_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
278
|
+
end
|
279
|
+
return data, status_code, headers
|
280
|
+
end
|
281
|
+
end
|
282
|
+
end
|
@@ -0,0 +1,279 @@
|
|
1
|
+
=begin
|
2
|
+
#Yousign API Swagger
|
3
|
+
|
4
|
+
#For your information, the Yousign API documentation is available at https://dev.yousign.com/
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.1
|
7
|
+
Contact: support@yousign.fr
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.14
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'uri'
|
14
|
+
|
15
|
+
module YousignClient
|
16
|
+
class FilesApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Download a File
|
23
|
+
# Used to get the base64 content of a file
|
24
|
+
# @param id
|
25
|
+
# @param authorization Authentication credentials for HTTP authentication
|
26
|
+
# @param [Hash] opts the optional parameters
|
27
|
+
# @return [String]
|
28
|
+
def files_id_download_get(id, authorization, opts = {})
|
29
|
+
data, _status_code, _headers = files_id_download_get_with_http_info(id, authorization, opts)
|
30
|
+
data
|
31
|
+
end
|
32
|
+
|
33
|
+
# Download a File
|
34
|
+
# Used to get the base64 content of a file
|
35
|
+
# @param id
|
36
|
+
# @param authorization Authentication credentials for HTTP authentication
|
37
|
+
# @param [Hash] opts the optional parameters
|
38
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
39
|
+
def files_id_download_get_with_http_info(id, authorization, opts = {})
|
40
|
+
if @api_client.config.debugging
|
41
|
+
@api_client.config.logger.debug 'Calling API: FilesApi.files_id_download_get ...'
|
42
|
+
end
|
43
|
+
# verify the required parameter 'id' is set
|
44
|
+
if @api_client.config.client_side_validation && id.nil?
|
45
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FilesApi.files_id_download_get"
|
46
|
+
end
|
47
|
+
# verify the required parameter 'authorization' is set
|
48
|
+
if @api_client.config.client_side_validation && authorization.nil?
|
49
|
+
fail ArgumentError, "Missing the required parameter 'authorization' when calling FilesApi.files_id_download_get"
|
50
|
+
end
|
51
|
+
# resource path
|
52
|
+
local_var_path = '/files/{id}/download'.sub('{' + 'id' + '}', id.to_s)
|
53
|
+
|
54
|
+
# query parameters
|
55
|
+
query_params = {}
|
56
|
+
|
57
|
+
# header parameters
|
58
|
+
header_params = {}
|
59
|
+
# HTTP header 'Accept' (if needed)
|
60
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
61
|
+
# HTTP header 'Content-Type'
|
62
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
63
|
+
header_params[:'Authorization'] = authorization
|
64
|
+
|
65
|
+
# form parameters
|
66
|
+
form_params = {}
|
67
|
+
|
68
|
+
# http body (model)
|
69
|
+
post_body = nil
|
70
|
+
auth_names = []
|
71
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
72
|
+
:header_params => header_params,
|
73
|
+
:query_params => query_params,
|
74
|
+
:form_params => form_params,
|
75
|
+
:body => post_body,
|
76
|
+
:auth_names => auth_names,
|
77
|
+
:return_type => 'String')
|
78
|
+
if @api_client.config.debugging
|
79
|
+
@api_client.config.logger.debug "API called: FilesApi#files_id_download_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
80
|
+
end
|
81
|
+
return data, status_code, headers
|
82
|
+
end
|
83
|
+
# Duplicate a File
|
84
|
+
# Duplicate a file. It will be create a clone of this file, with a new ID.
|
85
|
+
# @param id
|
86
|
+
# @param authorization Authentication credentials for HTTP authentication
|
87
|
+
# @param content_type The MIME type of the body of the request
|
88
|
+
# @param [Hash] opts the optional parameters
|
89
|
+
# @return [FileOutput]
|
90
|
+
def files_id_duplicate_post(id, authorization, content_type, opts = {})
|
91
|
+
data, _status_code, _headers = files_id_duplicate_post_with_http_info(id, authorization, content_type, opts)
|
92
|
+
data
|
93
|
+
end
|
94
|
+
|
95
|
+
# Duplicate a File
|
96
|
+
# Duplicate a file. It will be create a clone of this file, with a new ID.
|
97
|
+
# @param id
|
98
|
+
# @param authorization Authentication credentials for HTTP authentication
|
99
|
+
# @param content_type The MIME type of the body of the request
|
100
|
+
# @param [Hash] opts the optional parameters
|
101
|
+
# @return [Array<(FileOutput, Fixnum, Hash)>] FileOutput data, response status code and response headers
|
102
|
+
def files_id_duplicate_post_with_http_info(id, authorization, content_type, opts = {})
|
103
|
+
if @api_client.config.debugging
|
104
|
+
@api_client.config.logger.debug 'Calling API: FilesApi.files_id_duplicate_post ...'
|
105
|
+
end
|
106
|
+
# verify the required parameter 'id' is set
|
107
|
+
if @api_client.config.client_side_validation && id.nil?
|
108
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FilesApi.files_id_duplicate_post"
|
109
|
+
end
|
110
|
+
# verify the required parameter 'authorization' is set
|
111
|
+
if @api_client.config.client_side_validation && authorization.nil?
|
112
|
+
fail ArgumentError, "Missing the required parameter 'authorization' when calling FilesApi.files_id_duplicate_post"
|
113
|
+
end
|
114
|
+
# verify the required parameter 'content_type' is set
|
115
|
+
if @api_client.config.client_side_validation && content_type.nil?
|
116
|
+
fail ArgumentError, "Missing the required parameter 'content_type' when calling FilesApi.files_id_duplicate_post"
|
117
|
+
end
|
118
|
+
# resource path
|
119
|
+
local_var_path = '/files/{id}/duplicate'.sub('{' + 'id' + '}', id.to_s)
|
120
|
+
|
121
|
+
# query parameters
|
122
|
+
query_params = {}
|
123
|
+
|
124
|
+
# header parameters
|
125
|
+
header_params = {}
|
126
|
+
# HTTP header 'Accept' (if needed)
|
127
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
128
|
+
# HTTP header 'Content-Type'
|
129
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
130
|
+
header_params[:'Authorization'] = authorization
|
131
|
+
header_params[:'Content-Type'] = content_type
|
132
|
+
|
133
|
+
# form parameters
|
134
|
+
form_params = {}
|
135
|
+
|
136
|
+
# http body (model)
|
137
|
+
post_body = nil
|
138
|
+
auth_names = []
|
139
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
140
|
+
:header_params => header_params,
|
141
|
+
:query_params => query_params,
|
142
|
+
:form_params => form_params,
|
143
|
+
:body => post_body,
|
144
|
+
:auth_names => auth_names,
|
145
|
+
:return_type => 'FileOutput')
|
146
|
+
if @api_client.config.debugging
|
147
|
+
@api_client.config.logger.debug "API called: FilesApi#files_id_duplicate_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
148
|
+
end
|
149
|
+
return data, status_code, headers
|
150
|
+
end
|
151
|
+
# Find a File by ID
|
152
|
+
# Returns all the information regarding the File but without its content (for performance issue).
|
153
|
+
# @param id
|
154
|
+
# @param authorization Authentication credentials for HTTP authentication
|
155
|
+
# @param [Hash] opts the optional parameters
|
156
|
+
# @return [FileOutput]
|
157
|
+
def files_id_get(id, authorization, opts = {})
|
158
|
+
data, _status_code, _headers = files_id_get_with_http_info(id, authorization, opts)
|
159
|
+
data
|
160
|
+
end
|
161
|
+
|
162
|
+
# Find a File by ID
|
163
|
+
# Returns all the information regarding the File but without its content (for performance issue).
|
164
|
+
# @param id
|
165
|
+
# @param authorization Authentication credentials for HTTP authentication
|
166
|
+
# @param [Hash] opts the optional parameters
|
167
|
+
# @return [Array<(FileOutput, Fixnum, Hash)>] FileOutput data, response status code and response headers
|
168
|
+
def files_id_get_with_http_info(id, authorization, opts = {})
|
169
|
+
if @api_client.config.debugging
|
170
|
+
@api_client.config.logger.debug 'Calling API: FilesApi.files_id_get ...'
|
171
|
+
end
|
172
|
+
# verify the required parameter 'id' is set
|
173
|
+
if @api_client.config.client_side_validation && id.nil?
|
174
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling FilesApi.files_id_get"
|
175
|
+
end
|
176
|
+
# verify the required parameter 'authorization' is set
|
177
|
+
if @api_client.config.client_side_validation && authorization.nil?
|
178
|
+
fail ArgumentError, "Missing the required parameter 'authorization' when calling FilesApi.files_id_get"
|
179
|
+
end
|
180
|
+
# resource path
|
181
|
+
local_var_path = '/files/{id}'.sub('{' + 'id' + '}', id.to_s)
|
182
|
+
|
183
|
+
# query parameters
|
184
|
+
query_params = {}
|
185
|
+
|
186
|
+
# header parameters
|
187
|
+
header_params = {}
|
188
|
+
# HTTP header 'Accept' (if needed)
|
189
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
190
|
+
# HTTP header 'Content-Type'
|
191
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
192
|
+
header_params[:'Authorization'] = authorization
|
193
|
+
|
194
|
+
# form parameters
|
195
|
+
form_params = {}
|
196
|
+
|
197
|
+
# http body (model)
|
198
|
+
post_body = nil
|
199
|
+
auth_names = []
|
200
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
201
|
+
:header_params => header_params,
|
202
|
+
:query_params => query_params,
|
203
|
+
:form_params => form_params,
|
204
|
+
:body => post_body,
|
205
|
+
:auth_names => auth_names,
|
206
|
+
:return_type => 'FileOutput')
|
207
|
+
if @api_client.config.debugging
|
208
|
+
@api_client.config.logger.debug "API called: FilesApi#files_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
209
|
+
end
|
210
|
+
return data, status_code, headers
|
211
|
+
end
|
212
|
+
# Create a new File
|
213
|
+
# Used to upload a file in base64 on our platform
|
214
|
+
# @param authorization Authentication credentials for HTTP authentication
|
215
|
+
# @param content_type The MIME type of the body of the request
|
216
|
+
# @param body
|
217
|
+
# @param [Hash] opts the optional parameters
|
218
|
+
# @return [FileOutput]
|
219
|
+
def files_post(authorization, content_type, body, opts = {})
|
220
|
+
data, _status_code, _headers = files_post_with_http_info(authorization, content_type, body, opts)
|
221
|
+
data
|
222
|
+
end
|
223
|
+
|
224
|
+
# Create a new File
|
225
|
+
# Used to upload a file in base64 on our platform
|
226
|
+
# @param authorization Authentication credentials for HTTP authentication
|
227
|
+
# @param content_type The MIME type of the body of the request
|
228
|
+
# @param body
|
229
|
+
# @param [Hash] opts the optional parameters
|
230
|
+
# @return [Array<(FileOutput, Fixnum, Hash)>] FileOutput data, response status code and response headers
|
231
|
+
def files_post_with_http_info(authorization, content_type, body, opts = {})
|
232
|
+
if @api_client.config.debugging
|
233
|
+
@api_client.config.logger.debug 'Calling API: FilesApi.files_post ...'
|
234
|
+
end
|
235
|
+
# verify the required parameter 'authorization' is set
|
236
|
+
if @api_client.config.client_side_validation && authorization.nil?
|
237
|
+
fail ArgumentError, "Missing the required parameter 'authorization' when calling FilesApi.files_post"
|
238
|
+
end
|
239
|
+
# verify the required parameter 'content_type' is set
|
240
|
+
if @api_client.config.client_side_validation && content_type.nil?
|
241
|
+
fail ArgumentError, "Missing the required parameter 'content_type' when calling FilesApi.files_post"
|
242
|
+
end
|
243
|
+
# verify the required parameter 'body' is set
|
244
|
+
if @api_client.config.client_side_validation && body.nil?
|
245
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling FilesApi.files_post"
|
246
|
+
end
|
247
|
+
# resource path
|
248
|
+
local_var_path = '/files'
|
249
|
+
|
250
|
+
# query parameters
|
251
|
+
query_params = {}
|
252
|
+
|
253
|
+
# header parameters
|
254
|
+
header_params = {}
|
255
|
+
# HTTP header 'Accept' (if needed)
|
256
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
257
|
+
header_params[:'Authorization'] = authorization
|
258
|
+
header_params[:'Content-Type'] = content_type
|
259
|
+
|
260
|
+
# form parameters
|
261
|
+
form_params = {}
|
262
|
+
|
263
|
+
# http body (model)
|
264
|
+
post_body = @api_client.object_to_http_body(body)
|
265
|
+
auth_names = []
|
266
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
267
|
+
:header_params => header_params,
|
268
|
+
:query_params => query_params,
|
269
|
+
:form_params => form_params,
|
270
|
+
:body => post_body,
|
271
|
+
:auth_names => auth_names,
|
272
|
+
:return_type => 'FileOutput')
|
273
|
+
if @api_client.config.debugging
|
274
|
+
@api_client.config.logger.debug "API called: FilesApi#files_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
275
|
+
end
|
276
|
+
return data, status_code, headers
|
277
|
+
end
|
278
|
+
end
|
279
|
+
end
|