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
data/docs/FileInput.md
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
# YousignClient::FileInput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | Name of the file | [optional]
|
7
|
+
**type** | **String** | Type of the file | [optional]
|
8
|
+
**password** | **String** | Password for protected PDF file | [optional]
|
9
|
+
**description** | **String** | Description of the file | [optional]
|
10
|
+
**metadata** | [**FileInputMetadata**](FileInputMetadata.md) | | [optional]
|
11
|
+
**content** | **String** | Content in base 64 of the file | [optional]
|
12
|
+
**procedure** | **String** | Id of the procedure | [optional]
|
13
|
+
**position** | **Integer** | | [optional] [default to 0]
|
14
|
+
|
15
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# YousignClient::FileObjectInput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**file** | **String** | File id reference |
|
7
|
+
**page** | **Integer** | Page of the visible signature. This property is ignored if fieldName is set. If you want a visible signature, you must set page, position and fieldName. | [optional]
|
8
|
+
**position** | **String** | Coordinates of the signature image to set. Format is : \"llx,lly,urx,ury\". llx=left lower x coordinate, lly=left lower y coordinate, urx=upper right x coordinate, ury = upper right y coordinate. To get easily coordinates, you could use this tool : http://placeit.yousign.fr | [optional]
|
9
|
+
**field_name** | **String** | [type=signature] Name of the signature field existing in the document, it will be not used on the signature image. | [optional]
|
10
|
+
**mention** | **String** | [type=signature] Text associated above the signature image. You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature. | [optional]
|
11
|
+
**mention2** | **String** | [type=signature] Text associated below the signature image. (internal usage only, should not be used). You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature. | [optional]
|
12
|
+
**member** | **String** | Member id reference | [optional]
|
13
|
+
**reason** | **String** | [type=signature] The reason they are signing the agreement | [optional] [default to 'Signed by Yousign']
|
14
|
+
**type** | **String** | The type of the file object | [optional] [default to 'signature']
|
15
|
+
**content_required** | **BOOLEAN** | [type=text] Indicate if the member must fill or not the field | [optional] [default to false]
|
16
|
+
**content** | **String** | [type=text] The content of the field. Could be used for placeholder | [optional]
|
17
|
+
**font_family** | **String** | [type=text] The font familly used to render the TextField. Currently only the default value will be used. | [optional] [default to 'raleway']
|
18
|
+
**font_size** | **Integer** | [type=text] The font size used to render the field. Currently only the default value will be used. | [optional] [default to 12]
|
19
|
+
**font_color** | **String** | [type=text] The font color used to render the field. | [optional]
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# YousignClient::FileObjectInputWithoutFileReference
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**page** | **Integer** | Page of the visible signature. This property is ignored if fieldName is set. If you want a visible signature, you must set page, position and fieldName. | [optional]
|
7
|
+
**position** | **String** | Coordinates of the signature image to set. Format is : \"llx,lly,urx,ury\". llx=left lower x coordinate, lly=left lower y coordinate, urx=upper right x coordinate, ury = upper right y coordinate. To get easily coordinates, you could use this tool : http://placeit.yousign.fr | [optional]
|
8
|
+
**field_name** | **String** | Name of the signature field existing in the document, it will be not used on the signature image. | [optional]
|
9
|
+
**mention** | **String** | Text associated above the signature image. You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature. | [optional]
|
10
|
+
**mention2** | **String** | Text associated below the signature image. You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature. | [optional]
|
11
|
+
**reason** | **String** | The reason they are signing the agreement | [optional] [default to 'Signed by Yousign']
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# YousignClient::FileObjectOutput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | Id of the object | [optional]
|
7
|
+
**file** | [**FileOutput**](FileOutput.md) | |
|
8
|
+
**page** | **Integer** | Page of the visible signature. This property is ignored if fieldName is set. If you want a visible signature, you must set page, position and fieldName. | [optional]
|
9
|
+
**position** | **String** | Coordinates of the signature image to set. Format is : “llx,lly,urx,ury”. llx=left lower x coordinate, lly=left lower y coordinate, urx=upper right x coordinate, ury = upper right y coordinate. To get easily coordinates, you could use this tool : http://placeit.yousign.fr | [optional]
|
10
|
+
**field_name** | **String** | [type=signature] Name of the signature field existing in the document | [optional]
|
11
|
+
**mention** | **String** | [type=signature] Text associated above the signature image. You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature. | [optional]
|
12
|
+
**mention2__internal** | **String** | [type=signature] Text associated below the signature image. (internal usage only, should not be used). You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature. | [optional]
|
13
|
+
**created_at** | **DateTime** | Created date of the object | [optional]
|
14
|
+
**updated_at** | **DateTime** | Updated date of the object | [optional]
|
15
|
+
**executed_at** | **DateTime** | Date of signature or validation | [optional]
|
16
|
+
**reason** | **String** | [type=signature] The reason they are signing the agreement | [optional] [default to 'Signed by Firstname Lastname']
|
17
|
+
**type** | **String** | The type of the file object | [optional] [default to 'signature']
|
18
|
+
**content_required** | **BOOLEAN** | [type=text] Indicate if the member must fill or not the field | [optional] [default to false]
|
19
|
+
**content** | **String** | [type=text] The content of the field. Could be used for placeholder | [optional]
|
20
|
+
**font_family** | **String** | [type=text] The font familly used to render the TextField. Currently only the default value will be used. | [optional] [default to 'raleway']
|
21
|
+
**font_size** | **Integer** | [type=text] The font size used to render the field. Currently only the default value will be used. | [optional] [default to 12]
|
22
|
+
**font_color** | **String** | [type=text] The font color used to render the field. | [optional]
|
23
|
+
|
24
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# YousignClient::FileObjectOutputWithoutFileReference
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | Id of the object | [optional]
|
7
|
+
**page** | **Integer** | Page of the visible signature. This property is ignored if fieldName is set. If you want a visible signature, you must set page, position and fieldName. | [optional]
|
8
|
+
**position** | **String** | Coordinates of the signature image to set. Format is : “llx,lly,urx,ury”. llx=left lower x coordinate, lly=left lower y coordinate, urx=upper right x coordinate, ury = upper right y coordinate. To get easily coordinates, you could use this tool : http://placeit.yousign.fr | [optional]
|
9
|
+
**field_name** | **String** | Name of the signature field existing in the document | [optional]
|
10
|
+
**mention** | **String** | Text associated above the signature image. You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature. | [optional]
|
11
|
+
**mention2__internal** | **String** | Text associated below the signature image. You can use some variable inside : {{date.en}} {{date.fr}} {{time.en}} {{time.fr}} that it will be parsed to show the date of the signature. | [optional]
|
12
|
+
**created_at** | **DateTime** | Created date of the object | [optional]
|
13
|
+
**updated_at** | **DateTime** | Updated date of the object | [optional]
|
14
|
+
**executed_at** | **DateTime** | Date of signature or validation | [optional]
|
15
|
+
**reason** | **String** | The reason they are signing the agreement | [optional] [default to 'Signed by Yousign']
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,220 @@
|
|
1
|
+
# YousignClient::FileObjectsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.yousign.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**file_objects_id_delete**](FileObjectsApi.md#file_objects_id_delete) | **DELETE** /file_objects/{id} | Delete a File Object
|
8
|
+
[**file_objects_id_get**](FileObjectsApi.md#file_objects_id_get) | **GET** /file_objects/{id} | Find a File Object by ID
|
9
|
+
[**file_objects_id_put**](FileObjectsApi.md#file_objects_id_put) | **PUT** /file_objects/{id} | Update a File Object
|
10
|
+
[**file_objects_post**](FileObjectsApi.md#file_objects_post) | **POST** /file_objects | Create a new File Object
|
11
|
+
|
12
|
+
|
13
|
+
# **file_objects_id_delete**
|
14
|
+
> file_objects_id_delete(id, authorization)
|
15
|
+
|
16
|
+
Delete a File Object
|
17
|
+
|
18
|
+
Delete a File Object
|
19
|
+
|
20
|
+
### Example
|
21
|
+
```ruby
|
22
|
+
# load the gem
|
23
|
+
require 'yousign_client'
|
24
|
+
|
25
|
+
api_instance = YousignClient::FileObjectsApi.new
|
26
|
+
|
27
|
+
id = 'id_example' # String |
|
28
|
+
|
29
|
+
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
30
|
+
|
31
|
+
|
32
|
+
begin
|
33
|
+
#Delete a File Object
|
34
|
+
api_instance.file_objects_id_delete(id, authorization)
|
35
|
+
rescue YousignClient::ApiError => e
|
36
|
+
puts "Exception when calling FileObjectsApi->file_objects_id_delete: #{e}"
|
37
|
+
end
|
38
|
+
```
|
39
|
+
|
40
|
+
### Parameters
|
41
|
+
|
42
|
+
Name | Type | Description | Notes
|
43
|
+
------------- | ------------- | ------------- | -------------
|
44
|
+
**id** | **String**| |
|
45
|
+
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
46
|
+
|
47
|
+
### Return type
|
48
|
+
|
49
|
+
nil (empty response body)
|
50
|
+
|
51
|
+
### Authorization
|
52
|
+
|
53
|
+
No authorization required
|
54
|
+
|
55
|
+
### HTTP request headers
|
56
|
+
|
57
|
+
- **Content-Type**: application/json
|
58
|
+
- **Accept**: application/json
|
59
|
+
|
60
|
+
|
61
|
+
|
62
|
+
# **file_objects_id_get**
|
63
|
+
> FileObjectOutput file_objects_id_get(id, authorization)
|
64
|
+
|
65
|
+
Find a File Object by ID
|
66
|
+
|
67
|
+
Get a File Object
|
68
|
+
|
69
|
+
### Example
|
70
|
+
```ruby
|
71
|
+
# load the gem
|
72
|
+
require 'yousign_client'
|
73
|
+
|
74
|
+
api_instance = YousignClient::FileObjectsApi.new
|
75
|
+
|
76
|
+
id = 'id_example' # String |
|
77
|
+
|
78
|
+
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
79
|
+
|
80
|
+
|
81
|
+
begin
|
82
|
+
#Find a File Object by ID
|
83
|
+
result = api_instance.file_objects_id_get(id, authorization)
|
84
|
+
p result
|
85
|
+
rescue YousignClient::ApiError => e
|
86
|
+
puts "Exception when calling FileObjectsApi->file_objects_id_get: #{e}"
|
87
|
+
end
|
88
|
+
```
|
89
|
+
|
90
|
+
### Parameters
|
91
|
+
|
92
|
+
Name | Type | Description | Notes
|
93
|
+
------------- | ------------- | ------------- | -------------
|
94
|
+
**id** | **String**| |
|
95
|
+
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
96
|
+
|
97
|
+
### Return type
|
98
|
+
|
99
|
+
[**FileObjectOutput**](FileObjectOutput.md)
|
100
|
+
|
101
|
+
### Authorization
|
102
|
+
|
103
|
+
No authorization required
|
104
|
+
|
105
|
+
### HTTP request headers
|
106
|
+
|
107
|
+
- **Content-Type**: application/json
|
108
|
+
- **Accept**: application/json
|
109
|
+
|
110
|
+
|
111
|
+
|
112
|
+
# **file_objects_id_put**
|
113
|
+
> FileObjectOutput file_objects_id_put(id, authorization, content_type, body)
|
114
|
+
|
115
|
+
Update a File Object
|
116
|
+
|
117
|
+
Update a File Object
|
118
|
+
|
119
|
+
### Example
|
120
|
+
```ruby
|
121
|
+
# load the gem
|
122
|
+
require 'yousign_client'
|
123
|
+
|
124
|
+
api_instance = YousignClient::FileObjectsApi.new
|
125
|
+
|
126
|
+
id = 'id_example' # String |
|
127
|
+
|
128
|
+
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
129
|
+
|
130
|
+
content_type = 'application/json' # String | The MIME type of the body of the request
|
131
|
+
|
132
|
+
body = YousignClient::FileObjectInput.new # FileObjectInput |
|
133
|
+
|
134
|
+
|
135
|
+
begin
|
136
|
+
#Update a File Object
|
137
|
+
result = api_instance.file_objects_id_put(id, authorization, content_type, body)
|
138
|
+
p result
|
139
|
+
rescue YousignClient::ApiError => e
|
140
|
+
puts "Exception when calling FileObjectsApi->file_objects_id_put: #{e}"
|
141
|
+
end
|
142
|
+
```
|
143
|
+
|
144
|
+
### Parameters
|
145
|
+
|
146
|
+
Name | Type | Description | Notes
|
147
|
+
------------- | ------------- | ------------- | -------------
|
148
|
+
**id** | **String**| |
|
149
|
+
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
150
|
+
**content_type** | **String**| The MIME type of the body of the request |
|
151
|
+
**body** | [**FileObjectInput**](FileObjectInput.md)| |
|
152
|
+
|
153
|
+
### Return type
|
154
|
+
|
155
|
+
[**FileObjectOutput**](FileObjectOutput.md)
|
156
|
+
|
157
|
+
### Authorization
|
158
|
+
|
159
|
+
No authorization required
|
160
|
+
|
161
|
+
### HTTP request headers
|
162
|
+
|
163
|
+
- **Content-Type**: Not defined
|
164
|
+
- **Accept**: application/json
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
# **file_objects_post**
|
169
|
+
> FileObjectOutput file_objects_post(authorization, content_type, body)
|
170
|
+
|
171
|
+
Create a new File Object
|
172
|
+
|
173
|
+
Create a new fileObject
|
174
|
+
|
175
|
+
### Example
|
176
|
+
```ruby
|
177
|
+
# load the gem
|
178
|
+
require 'yousign_client'
|
179
|
+
|
180
|
+
api_instance = YousignClient::FileObjectsApi.new
|
181
|
+
|
182
|
+
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
183
|
+
|
184
|
+
content_type = 'application/json' # String | The MIME type of the body of the request
|
185
|
+
|
186
|
+
body = YousignClient::FileObjectInput.new # FileObjectInput |
|
187
|
+
|
188
|
+
|
189
|
+
begin
|
190
|
+
#Create a new File Object
|
191
|
+
result = api_instance.file_objects_post(authorization, content_type, body)
|
192
|
+
p result
|
193
|
+
rescue YousignClient::ApiError => e
|
194
|
+
puts "Exception when calling FileObjectsApi->file_objects_post: #{e}"
|
195
|
+
end
|
196
|
+
```
|
197
|
+
|
198
|
+
### Parameters
|
199
|
+
|
200
|
+
Name | Type | Description | Notes
|
201
|
+
------------- | ------------- | ------------- | -------------
|
202
|
+
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
203
|
+
**content_type** | **String**| The MIME type of the body of the request |
|
204
|
+
**body** | [**FileObjectInput**](FileObjectInput.md)| |
|
205
|
+
|
206
|
+
### Return type
|
207
|
+
|
208
|
+
[**FileObjectOutput**](FileObjectOutput.md)
|
209
|
+
|
210
|
+
### Authorization
|
211
|
+
|
212
|
+
No authorization required
|
213
|
+
|
214
|
+
### HTTP request headers
|
215
|
+
|
216
|
+
- **Content-Type**: Not defined
|
217
|
+
- **Accept**: application/json
|
218
|
+
|
219
|
+
|
220
|
+
|
data/docs/FileOutput.md
ADDED
@@ -0,0 +1,19 @@
|
|
1
|
+
# YousignClient::FileOutput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | Id of the object | [optional]
|
7
|
+
**name** | **String** | Name of the file | [optional]
|
8
|
+
**type** | **String** | Type of file | [optional]
|
9
|
+
**content_type** | **String** | Type of content | [optional]
|
10
|
+
**description** | **String** | Description of the file | [optional]
|
11
|
+
**created_at** | **String** | Created date of the object | [optional]
|
12
|
+
**updated_at** | **String** | Updated date of the object | [optional]
|
13
|
+
**metadata** | [**FileInputMetadata**](FileInputMetadata.md) | | [optional]
|
14
|
+
**workspace** | **String** | Id of workspace | [optional]
|
15
|
+
**creator** | **String** | Id of creator | [optional]
|
16
|
+
**sha256** | **String** | File hash | [optional]
|
17
|
+
**position** | **Integer** | | [optional] [default to 0]
|
18
|
+
|
19
|
+
|
data/docs/FilesApi.md
ADDED
@@ -0,0 +1,218 @@
|
|
1
|
+
# YousignClient::FilesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.yousign.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**files_id_download_get**](FilesApi.md#files_id_download_get) | **GET** /files/{id}/download | Download a File
|
8
|
+
[**files_id_duplicate_post**](FilesApi.md#files_id_duplicate_post) | **POST** /files/{id}/duplicate | Duplicate a File
|
9
|
+
[**files_id_get**](FilesApi.md#files_id_get) | **GET** /files/{id} | Find a File by ID
|
10
|
+
[**files_post**](FilesApi.md#files_post) | **POST** /files | Create a new File
|
11
|
+
|
12
|
+
|
13
|
+
# **files_id_download_get**
|
14
|
+
> String files_id_download_get(id, authorization)
|
15
|
+
|
16
|
+
Download a File
|
17
|
+
|
18
|
+
Used to get the base64 content of a file
|
19
|
+
|
20
|
+
### Example
|
21
|
+
```ruby
|
22
|
+
# load the gem
|
23
|
+
require 'yousign_client'
|
24
|
+
|
25
|
+
api_instance = YousignClient::FilesApi.new
|
26
|
+
|
27
|
+
id = 'id_example' # String |
|
28
|
+
|
29
|
+
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
30
|
+
|
31
|
+
|
32
|
+
begin
|
33
|
+
#Download a File
|
34
|
+
result = api_instance.files_id_download_get(id, authorization)
|
35
|
+
p result
|
36
|
+
rescue YousignClient::ApiError => e
|
37
|
+
puts "Exception when calling FilesApi->files_id_download_get: #{e}"
|
38
|
+
end
|
39
|
+
```
|
40
|
+
|
41
|
+
### Parameters
|
42
|
+
|
43
|
+
Name | Type | Description | Notes
|
44
|
+
------------- | ------------- | ------------- | -------------
|
45
|
+
**id** | **String**| |
|
46
|
+
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
47
|
+
|
48
|
+
### Return type
|
49
|
+
|
50
|
+
**String**
|
51
|
+
|
52
|
+
### Authorization
|
53
|
+
|
54
|
+
No authorization required
|
55
|
+
|
56
|
+
### HTTP request headers
|
57
|
+
|
58
|
+
- **Content-Type**: application/json
|
59
|
+
- **Accept**: application/json
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
# **files_id_duplicate_post**
|
64
|
+
> FileOutput files_id_duplicate_post(id, authorization, content_type)
|
65
|
+
|
66
|
+
Duplicate a File
|
67
|
+
|
68
|
+
Duplicate a file. It will be create a clone of this file, with a new ID.
|
69
|
+
|
70
|
+
### Example
|
71
|
+
```ruby
|
72
|
+
# load the gem
|
73
|
+
require 'yousign_client'
|
74
|
+
|
75
|
+
api_instance = YousignClient::FilesApi.new
|
76
|
+
|
77
|
+
id = 'id_example' # String |
|
78
|
+
|
79
|
+
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
80
|
+
|
81
|
+
content_type = 'application/json' # String | The MIME type of the body of the request
|
82
|
+
|
83
|
+
|
84
|
+
begin
|
85
|
+
#Duplicate a File
|
86
|
+
result = api_instance.files_id_duplicate_post(id, authorization, content_type)
|
87
|
+
p result
|
88
|
+
rescue YousignClient::ApiError => e
|
89
|
+
puts "Exception when calling FilesApi->files_id_duplicate_post: #{e}"
|
90
|
+
end
|
91
|
+
```
|
92
|
+
|
93
|
+
### Parameters
|
94
|
+
|
95
|
+
Name | Type | Description | Notes
|
96
|
+
------------- | ------------- | ------------- | -------------
|
97
|
+
**id** | **String**| |
|
98
|
+
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
99
|
+
**content_type** | **String**| The MIME type of the body of the request |
|
100
|
+
|
101
|
+
### Return type
|
102
|
+
|
103
|
+
[**FileOutput**](FileOutput.md)
|
104
|
+
|
105
|
+
### Authorization
|
106
|
+
|
107
|
+
No authorization required
|
108
|
+
|
109
|
+
### HTTP request headers
|
110
|
+
|
111
|
+
- **Content-Type**: application/json
|
112
|
+
- **Accept**: application/json
|
113
|
+
|
114
|
+
|
115
|
+
|
116
|
+
# **files_id_get**
|
117
|
+
> FileOutput files_id_get(id, authorization)
|
118
|
+
|
119
|
+
Find a File by ID
|
120
|
+
|
121
|
+
Returns all the information regarding the File but without its content (for performance issue).
|
122
|
+
|
123
|
+
### Example
|
124
|
+
```ruby
|
125
|
+
# load the gem
|
126
|
+
require 'yousign_client'
|
127
|
+
|
128
|
+
api_instance = YousignClient::FilesApi.new
|
129
|
+
|
130
|
+
id = 'id_example' # String |
|
131
|
+
|
132
|
+
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
133
|
+
|
134
|
+
|
135
|
+
begin
|
136
|
+
#Find a File by ID
|
137
|
+
result = api_instance.files_id_get(id, authorization)
|
138
|
+
p result
|
139
|
+
rescue YousignClient::ApiError => e
|
140
|
+
puts "Exception when calling FilesApi->files_id_get: #{e}"
|
141
|
+
end
|
142
|
+
```
|
143
|
+
|
144
|
+
### Parameters
|
145
|
+
|
146
|
+
Name | Type | Description | Notes
|
147
|
+
------------- | ------------- | ------------- | -------------
|
148
|
+
**id** | **String**| |
|
149
|
+
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
150
|
+
|
151
|
+
### Return type
|
152
|
+
|
153
|
+
[**FileOutput**](FileOutput.md)
|
154
|
+
|
155
|
+
### Authorization
|
156
|
+
|
157
|
+
No authorization required
|
158
|
+
|
159
|
+
### HTTP request headers
|
160
|
+
|
161
|
+
- **Content-Type**: application/json
|
162
|
+
- **Accept**: application/json
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
# **files_post**
|
167
|
+
> FileOutput files_post(authorization, content_type, body)
|
168
|
+
|
169
|
+
Create a new File
|
170
|
+
|
171
|
+
Used to upload a file in base64 on our platform
|
172
|
+
|
173
|
+
### Example
|
174
|
+
```ruby
|
175
|
+
# load the gem
|
176
|
+
require 'yousign_client'
|
177
|
+
|
178
|
+
api_instance = YousignClient::FilesApi.new
|
179
|
+
|
180
|
+
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
181
|
+
|
182
|
+
content_type = 'application/json' # String | The MIME type of the body of the request
|
183
|
+
|
184
|
+
body = YousignClient::FileInput.new # FileInput |
|
185
|
+
|
186
|
+
|
187
|
+
begin
|
188
|
+
#Create a new File
|
189
|
+
result = api_instance.files_post(authorization, content_type, body)
|
190
|
+
p result
|
191
|
+
rescue YousignClient::ApiError => e
|
192
|
+
puts "Exception when calling FilesApi->files_post: #{e}"
|
193
|
+
end
|
194
|
+
```
|
195
|
+
|
196
|
+
### Parameters
|
197
|
+
|
198
|
+
Name | Type | Description | Notes
|
199
|
+
------------- | ------------- | ------------- | -------------
|
200
|
+
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
201
|
+
**content_type** | **String**| The MIME type of the body of the request |
|
202
|
+
**body** | [**FileInput**](FileInput.md)| |
|
203
|
+
|
204
|
+
### Return type
|
205
|
+
|
206
|
+
[**FileOutput**](FileOutput.md)
|
207
|
+
|
208
|
+
### Authorization
|
209
|
+
|
210
|
+
No authorization required
|
211
|
+
|
212
|
+
### HTTP request headers
|
213
|
+
|
214
|
+
- **Content-Type**: Not defined
|
215
|
+
- **Accept**: application/json
|
216
|
+
|
217
|
+
|
218
|
+
|