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,16 @@
|
|
1
|
+
# YousignClient::OrganizationBillingAddress
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**first_name** | **String** | | [optional]
|
7
|
+
**last_name** | **String** | | [optional]
|
8
|
+
**email** | **String** | | [optional]
|
9
|
+
**company** | **String** | | [optional]
|
10
|
+
**phone** | **String** | | [optional]
|
11
|
+
**line1** | **String** | | [optional]
|
12
|
+
**city** | **String** | | [optional]
|
13
|
+
**country** | **String** | | [optional]
|
14
|
+
**zip** | **String** | | [optional]
|
15
|
+
|
16
|
+
|
@@ -0,0 +1,41 @@
|
|
1
|
+
# YousignClient::OrganizationOutput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | Organization ID | [optional]
|
7
|
+
**name** | **String** | Organization name | [optional]
|
8
|
+
**url** | **String** | Custom URL for the Organization (internal usage only, should not be used) | [optional]
|
9
|
+
**created_at** | **DateTime** | Created date of the object | [optional]
|
10
|
+
**updated_at** | **DateTime** | Updated date of the object | [optional]
|
11
|
+
**f_sso** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
12
|
+
**max_users** | **Float** | Internal usage, should not be used | [optional]
|
13
|
+
**procedure_related_files_enable** | **BOOLEAN** | Defined if the organization anable the related files | [optional]
|
14
|
+
**subscriptions** | **Array<String>** | | [optional]
|
15
|
+
**auto_collection** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
16
|
+
**vat_number** | **String** | Internal usage, should not be used | [optional]
|
17
|
+
**billing_address** | [**OrganizationBillingAddress**](OrganizationBillingAddress.md) | | [optional]
|
18
|
+
**in_app_support** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
19
|
+
**in_app_updates** | **String** | Internal usage, should not be used | [optional]
|
20
|
+
**file_template** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
21
|
+
**f_archive** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
22
|
+
**f_user_permissions** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
23
|
+
**f_procedure_template** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
24
|
+
**f_procedure_reminder_auto** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
25
|
+
**f_api** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
26
|
+
**f_checkdocument** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
27
|
+
**f_procedure_create** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
28
|
+
**f_signature_ui** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
29
|
+
**f_server_stamp** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
30
|
+
**f_operation_level_none** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
31
|
+
**f_consent_process** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
32
|
+
**f_operation_level_advanced** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
33
|
+
**f_operation_custom_mode_email** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
34
|
+
**f_dynamic_fields** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
35
|
+
**saml_identity_provider** | **String** | Internal usage, should not be used | [optional]
|
36
|
+
**password_policy_pattern** | **String** | Pattern of the password policy for the organization | [optional]
|
37
|
+
**password_policy_description** | **String** | Description for the password policy | [optional]
|
38
|
+
**user_activation** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
39
|
+
**f_procedure_template_permissions** | **BOOLEAN** | Internal usage, should not be used | [optional]
|
40
|
+
|
41
|
+
|
@@ -0,0 +1,54 @@
|
|
1
|
+
# YousignClient::OrganizationsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.yousign.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**organizations_get**](OrganizationsApi.md#organizations_get) | **GET** /organizations | List all Organizations
|
8
|
+
|
9
|
+
|
10
|
+
# **organizations_get**
|
11
|
+
> Array<OrganizationOutput> organizations_get(authorization)
|
12
|
+
|
13
|
+
List all Organizations
|
14
|
+
|
15
|
+
### Example
|
16
|
+
```ruby
|
17
|
+
# load the gem
|
18
|
+
require 'yousign_client'
|
19
|
+
|
20
|
+
api_instance = YousignClient::OrganizationsApi.new
|
21
|
+
|
22
|
+
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
23
|
+
|
24
|
+
|
25
|
+
begin
|
26
|
+
#List all Organizations
|
27
|
+
result = api_instance.organizations_get(authorization)
|
28
|
+
p result
|
29
|
+
rescue YousignClient::ApiError => e
|
30
|
+
puts "Exception when calling OrganizationsApi->organizations_get: #{e}"
|
31
|
+
end
|
32
|
+
```
|
33
|
+
|
34
|
+
### Parameters
|
35
|
+
|
36
|
+
Name | Type | Description | Notes
|
37
|
+
------------- | ------------- | ------------- | -------------
|
38
|
+
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
39
|
+
|
40
|
+
### Return type
|
41
|
+
|
42
|
+
[**Array<OrganizationOutput>**](OrganizationOutput.md)
|
43
|
+
|
44
|
+
### Authorization
|
45
|
+
|
46
|
+
No authorization required
|
47
|
+
|
48
|
+
### HTTP request headers
|
49
|
+
|
50
|
+
- **Content-Type**: application/json
|
51
|
+
- **Accept**: application/json
|
52
|
+
|
53
|
+
|
54
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# YousignClient::ProcedureConfig
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email** | [**ProcedureConfigEmail**](ProcedureConfigEmail.md) | | [optional]
|
7
|
+
**reminders** | [**Array<ProcedureConfigReminder>**](ProcedureConfigReminder.md) | | [optional]
|
8
|
+
**webhook** | [**ProcedureConfigWebhook**](ProcedureConfigWebhook.md) | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# YousignClient::ProcedureConfigEmail
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**procedure_started** | [**Array<ConfigEmailTemplate>**](ConfigEmailTemplate.md) | | [optional]
|
7
|
+
**procedure_finished** | [**Array<ConfigEmailTemplate>**](ConfigEmailTemplate.md) | | [optional]
|
8
|
+
**procedure_refused** | [**Array<ConfigEmailTemplate>**](ConfigEmailTemplate.md) | | [optional]
|
9
|
+
**procedure_expired** | [**Array<ConfigEmailTemplate>**](ConfigEmailTemplate.md) | | [optional]
|
10
|
+
**procedure_deleted** | [**Array<ConfigEmailTemplate>**](ConfigEmailTemplate.md) | | [optional]
|
11
|
+
**member_started** | [**Array<ConfigEmailTemplate>**](ConfigEmailTemplate.md) | | [optional]
|
12
|
+
**member_finished** | [**Array<ConfigEmailTemplate>**](ConfigEmailTemplate.md) | | [optional]
|
13
|
+
**comment_created** | [**Array<ConfigEmailTemplate>**](ConfigEmailTemplate.md) | | [optional]
|
14
|
+
|
15
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# YousignClient::ProcedureConfigReminder
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**interval** | **Integer** | Number of days between each reminder. The date of the creation of the procedure is used to define the date of the reminder. For example, if you set 2 and the procedure is created at 2017-01-01T15:03:01, the first reminder will be sent at 2017-01-03T15:03:01. | [default to 1]
|
7
|
+
**limit** | **Integer** | Limit of reminders sent. | [optional] [default to 5]
|
8
|
+
**config** | [**ProcedureConfigReminderConfig**](ProcedureConfigReminderConfig.md) | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# YousignClient::ProcedureConfigReminderConfig
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email** | [**ProcedureConfigReminderConfigEmail**](ProcedureConfigReminderConfigEmail.md) | | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# YousignClient::ProcedureConfigReminderConfigEmail
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**reminder_executed** | [**Array<ConfigEmailTemplate>**](ConfigEmailTemplate.md) | | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# YousignClient::ProcedureConfigWebhook
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**procedure_started** | [**Array<ConfigWebhookTemplate>**](ConfigWebhookTemplate.md) | | [optional]
|
7
|
+
**procedure_finished** | [**Array<ConfigWebhookTemplate>**](ConfigWebhookTemplate.md) | | [optional]
|
8
|
+
**procedure_refused** | [**Array<ConfigWebhookTemplate>**](ConfigWebhookTemplate.md) | | [optional]
|
9
|
+
**procedure_expired** | [**Array<ConfigWebhookTemplate>**](ConfigWebhookTemplate.md) | | [optional]
|
10
|
+
**procedure_deleted** | [**Array<ConfigWebhookTemplate>**](ConfigWebhookTemplate.md) | | [optional]
|
11
|
+
**member_started** | [**Array<ConfigWebhookTemplate>**](ConfigWebhookTemplate.md) | | [optional]
|
12
|
+
**member_finished** | [**Array<ConfigWebhookTemplate>**](ConfigWebhookTemplate.md) | | [optional]
|
13
|
+
**comment_created** | [**Array<ConfigWebhookTemplate>**](ConfigWebhookTemplate.md) | | [optional]
|
14
|
+
|
15
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# YousignClient::ProcedureDuplicateInput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**start** | **BOOLEAN** | Defines if the new procedure should be started after the duplication | [optional] [default to false]
|
7
|
+
**template** | **BOOLEAN** | Override the parent value for this property and defines if the new procedure should be a template or not | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# YousignClient::ProcedureInput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | Name of procedure | [optional]
|
7
|
+
**description** | **String** | Description of procedure | [optional]
|
8
|
+
**expires_at** | **Date** | Expiration date. The procedure will be out of usage after this date. | [optional]
|
9
|
+
**template** | **BOOLEAN** | Defines if the procedure is a template (if true). A template could be used by a procedure to get all properties of the template. Check parent parameter for more information. | [optional]
|
10
|
+
**ordered** | **BOOLEAN** | Defines an order for the procedure process. If true, position of each member will be used to define the validation workflow. | [optional]
|
11
|
+
**metadata** | [**ProcedureInputMetadata**](ProcedureInputMetadata.md) | | [optional]
|
12
|
+
**config** | [**ProcedureConfig**](ProcedureConfig.md) | | [optional]
|
13
|
+
**members** | [**Array<MemberInput>**](MemberInput.md) | List of members, REQUIRED if start field is true. | [optional]
|
14
|
+
**start** | **BOOLEAN** | Defines if the procedure has been started. If false, the procedure status will be draft. | [optional] [default to true]
|
15
|
+
**related_files_enable** | **BOOLEAN** | Defines if related files are available. Used only for organization that have this option. | [optional]
|
16
|
+
**archive** | **BOOLEAN** | Defines if the files of the procedure must be archived (Organization should be allowed) | [optional] [default to false]
|
17
|
+
|
18
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# YousignClient::ProcedureOutput
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | Id of the object | [optional]
|
7
|
+
**name** | **String** | Name of procedure | [optional]
|
8
|
+
**description** | **String** | Description of procedure | [optional]
|
9
|
+
**created_at** | **DateTime** | Created date of the object | [optional]
|
10
|
+
**updated_at** | **DateTime** | Updated date of the object | [optional]
|
11
|
+
**expires_at** | **DateTime** | Expiration date. The procedure will be out of usage after this date. | [optional]
|
12
|
+
**status** | **String** | Status of the procedure | [optional]
|
13
|
+
**creator** | **String** | Id of creator of the object | [optional]
|
14
|
+
**creator_first_name** | **String** | The creator's first name | [optional]
|
15
|
+
**creator_last_name** | **String** | The creator's last name | [optional]
|
16
|
+
**workspace** | **String** | Id of workspace creator of the object | [optional]
|
17
|
+
**template** | **BOOLEAN** | Defines if the procedure is a template (if true). A template could be used by a procedure to get all properties of the template. Check parent parameter for more information. | [optional]
|
18
|
+
**ordered** | **BOOLEAN** | Defines an order for the procedure process. If true, position of each member will be used to define the validation workflow. | [optional]
|
19
|
+
**parent** | **String** | Id of a procedure template used to get all properties of the template in the new procedure. If you set other properties, they will be replaced. If you don’t set other properties, all properties will be cloned. | [optional]
|
20
|
+
**metadata** | [**ProcedureOutputMetadata**](ProcedureOutputMetadata.md) | | [optional]
|
21
|
+
**config** | [**ProcedureConfig**](ProcedureConfig.md) | | [optional]
|
22
|
+
**members** | [**Array<MemberOutput>**](MemberOutput.md) | | [optional]
|
23
|
+
**files** | [**Array<FileOutput>**](FileOutput.md) | List of files used in the procedure. | [optional]
|
24
|
+
**related_files_enable** | **BOOLEAN** | Defines if related files are available. | [optional]
|
25
|
+
**archive** | **BOOLEAN** | Defines if the files of the procedure must be archived (Workspace should be allowed) | [optional] [default to false]
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# YousignClient::ProcedureRemindConfigEmail
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**reminder_executed** | [**Array<ConfigEmailTemplate>**](ConfigEmailTemplate.md) | | [optional]
|
7
|
+
|
8
|
+
|
@@ -0,0 +1,527 @@
|
|
1
|
+
# YousignClient::ProceduresApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.yousign.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**export_procedures_get**](ProceduresApi.md#export_procedures_get) | **GET** /export/procedures | Export Procedure list
|
8
|
+
[**procedures_get**](ProceduresApi.md#procedures_get) | **GET** /procedures | Get Procedure list
|
9
|
+
[**procedures_id_delete**](ProceduresApi.md#procedures_id_delete) | **DELETE** /procedures/{id} | Delete a Procedure
|
10
|
+
[**procedures_id_duplicate_post**](ProceduresApi.md#procedures_id_duplicate_post) | **POST** /procedures/{id}/duplicate | Duplicate a Procedure
|
11
|
+
[**procedures_id_get**](ProceduresApi.md#procedures_id_get) | **GET** /procedures/{id} | Find a Procedure by ID
|
12
|
+
[**procedures_id_proof_get**](ProceduresApi.md#procedures_id_proof_get) | **GET** /procedures/{id}/proof | Get a Procedure proof file
|
13
|
+
[**procedures_id_put**](ProceduresApi.md#procedures_id_put) | **PUT** /procedures/{id} | Update a Procedure
|
14
|
+
[**procedures_id_remind_post**](ProceduresApi.md#procedures_id_remind_post) | **POST** /procedures/{id}/remind | Remind a Procedure
|
15
|
+
[**procedures_post**](ProceduresApi.md#procedures_post) | **POST** /procedures | Create a new Procedure
|
16
|
+
|
17
|
+
|
18
|
+
# **export_procedures_get**
|
19
|
+
> String export_procedures_get(authorization, opts)
|
20
|
+
|
21
|
+
Export Procedure list
|
22
|
+
|
23
|
+
### Example
|
24
|
+
```ruby
|
25
|
+
# load the gem
|
26
|
+
require 'yousign_client'
|
27
|
+
|
28
|
+
api_instance = YousignClient::ProceduresApi.new
|
29
|
+
|
30
|
+
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
31
|
+
|
32
|
+
opts = {
|
33
|
+
status: 'status_example', # String | Return Procedure list based on the status for each Procedure
|
34
|
+
name: 'test', # String | Filter by name (contains)
|
35
|
+
members_firstname: 'test', # String | Filter by member firstname (contains)
|
36
|
+
members_lastname: 'test', # String | Filter by member lastname (contains)
|
37
|
+
members_phone: '+33102030405', # String | Filter by member phone (contains)
|
38
|
+
members_email: 'test@test.fr', # String | Filter by member email (contains)
|
39
|
+
files_name: 'test', # String | Filter by file name (contains)
|
40
|
+
created_at: [Date.parse('2013-10-20')], # Array<Date> | Filter by creation date createdAt[after]=2017-09-18 createdAt[before]=2017-09-18 createdAt[strictly_after]=2017-09-18 createdAt[strictly_before]=2017-09-18
|
41
|
+
updated_at: [Date.parse('2013-10-20')], # Array<Date> | Filter by update date updatedAt[after]=2017-09-18 updatedAt[before]=2017-09-18 updatedAt[strictly_after]=2017-09-18 updatedAt[strictly_before]=2017-09-18
|
42
|
+
expires_at: [Date.parse('2013-10-20')], # Array<Date> | Filter by expire date expiresAt[after]=2017-09-18 expiresAt[before]=2017-09-18 expiresAt[strictly_after]=2017-09-18 expiresAt[strictly_before]=2017-09-18
|
43
|
+
deleted_at: [Date.parse('2013-10-20')], # Array<Date> | Filter by delete date deletedAt[after]=2017-09-18 deletedAt[before]=2017-09-18 deletedAt[strictly_after]=2017-09-18 deletedAt[strictly_before]=2017-09-18
|
44
|
+
order_created_at: 'order_created_at_example' # String | Order by attribut
|
45
|
+
}
|
46
|
+
|
47
|
+
begin
|
48
|
+
#Export Procedure list
|
49
|
+
result = api_instance.export_procedures_get(authorization, opts)
|
50
|
+
p result
|
51
|
+
rescue YousignClient::ApiError => e
|
52
|
+
puts "Exception when calling ProceduresApi->export_procedures_get: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
### Parameters
|
57
|
+
|
58
|
+
Name | Type | Description | Notes
|
59
|
+
------------- | ------------- | ------------- | -------------
|
60
|
+
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
61
|
+
**status** | **String**| Return Procedure list based on the status for each Procedure | [optional]
|
62
|
+
**name** | **String**| Filter by name (contains) | [optional]
|
63
|
+
**members_firstname** | **String**| Filter by member firstname (contains) | [optional]
|
64
|
+
**members_lastname** | **String**| Filter by member lastname (contains) | [optional]
|
65
|
+
**members_phone** | **String**| Filter by member phone (contains) | [optional]
|
66
|
+
**members_email** | **String**| Filter by member email (contains) | [optional]
|
67
|
+
**files_name** | **String**| Filter by file name (contains) | [optional]
|
68
|
+
**created_at** | [**Array<Date>**](Date.md)| Filter by creation date createdAt[after]=2017-09-18 createdAt[before]=2017-09-18 createdAt[strictly_after]=2017-09-18 createdAt[strictly_before]=2017-09-18 | [optional]
|
69
|
+
**updated_at** | [**Array<Date>**](Date.md)| Filter by update date updatedAt[after]=2017-09-18 updatedAt[before]=2017-09-18 updatedAt[strictly_after]=2017-09-18 updatedAt[strictly_before]=2017-09-18 | [optional]
|
70
|
+
**expires_at** | [**Array<Date>**](Date.md)| Filter by expire date expiresAt[after]=2017-09-18 expiresAt[before]=2017-09-18 expiresAt[strictly_after]=2017-09-18 expiresAt[strictly_before]=2017-09-18 | [optional]
|
71
|
+
**deleted_at** | [**Array<Date>**](Date.md)| Filter by delete date deletedAt[after]=2017-09-18 deletedAt[before]=2017-09-18 deletedAt[strictly_after]=2017-09-18 deletedAt[strictly_before]=2017-09-18 | [optional]
|
72
|
+
**order_created_at** | **String**| Order by attribut | [optional]
|
73
|
+
|
74
|
+
### Return type
|
75
|
+
|
76
|
+
**String**
|
77
|
+
|
78
|
+
### Authorization
|
79
|
+
|
80
|
+
No authorization required
|
81
|
+
|
82
|
+
### HTTP request headers
|
83
|
+
|
84
|
+
- **Content-Type**: application/json
|
85
|
+
- **Accept**: text/csv
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
# **procedures_get**
|
90
|
+
> Array<ProcedureOutput> procedures_get(authorization, opts)
|
91
|
+
|
92
|
+
Get Procedure list
|
93
|
+
|
94
|
+
### Example
|
95
|
+
```ruby
|
96
|
+
# load the gem
|
97
|
+
require 'yousign_client'
|
98
|
+
|
99
|
+
api_instance = YousignClient::ProceduresApi.new
|
100
|
+
|
101
|
+
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
102
|
+
|
103
|
+
opts = {
|
104
|
+
status: 'status_example', # String | Return Procedure list based on the status for each Procedure
|
105
|
+
template: false, # BOOLEAN | Used to get Procedure template list
|
106
|
+
members: ['/members/f8311c9b-7b37-46d4-b28e-0c40d44b2f95'], # Array<String> | Get Procedure list for given members (paraph mode)
|
107
|
+
items_per_page: '20', # String | Number of items per page for the pagination
|
108
|
+
pagination: true, # BOOLEAN | Enable the pagination
|
109
|
+
page: 2, # Integer | Page of the pagination
|
110
|
+
name: 'test', # String | Filter by name (contains)
|
111
|
+
members_firstname: 'test', # String | Filter by member firstname (contains)
|
112
|
+
members_lastname: 'test', # String | Filter by member lastname (contains)
|
113
|
+
members_phone: '+33102030405', # String | Filter by member phone (contains)
|
114
|
+
members_email: 'test@test.fr', # String | Filter by member email (contains)
|
115
|
+
files_name: 'test', # String | Filter by file name (contains)
|
116
|
+
created_at: [Date.parse('2013-10-20')], # Array<Date> | Filter by creation date createdAt[after]=2017-09-18 createdAt[before]=2017-09-18 createdAt[strictly_after]=2017-09-18 createdAt[strictly_before]=2017-09-18
|
117
|
+
updated_at: [Date.parse('2013-10-20')], # Array<Date> | Filter by update date updatedAt[after]=2017-09-18 updatedAt[before]=2017-09-18 updatedAt[strictly_after]=2017-09-18 updatedAt[strictly_before]=2017-09-18
|
118
|
+
expires_at: [Date.parse('2013-10-20')], # Array<Date> | Filter by expire date expiresAt[after]=2017-09-18 expiresAt[before]=2017-09-18 expiresAt[strictly_after]=2017-09-18 expiresAt[strictly_before]=2017-09-18
|
119
|
+
deleted_at: [Date.parse('2013-10-20')], # Array<Date> | Filter by delete date deletedAt[after]=2017-09-18 deletedAt[before]=2017-09-18 deletedAt[strictly_after]=2017-09-18 deletedAt[strictly_before]=2017-09-18
|
120
|
+
order_created_at: 'order_created_at_example' # String | Order by createdAt order[createdAt]=asc order[createdAt]=desc
|
121
|
+
}
|
122
|
+
|
123
|
+
begin
|
124
|
+
#Get Procedure list
|
125
|
+
result = api_instance.procedures_get(authorization, opts)
|
126
|
+
p result
|
127
|
+
rescue YousignClient::ApiError => e
|
128
|
+
puts "Exception when calling ProceduresApi->procedures_get: #{e}"
|
129
|
+
end
|
130
|
+
```
|
131
|
+
|
132
|
+
### Parameters
|
133
|
+
|
134
|
+
Name | Type | Description | Notes
|
135
|
+
------------- | ------------- | ------------- | -------------
|
136
|
+
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
137
|
+
**status** | **String**| Return Procedure list based on the status for each Procedure | [optional]
|
138
|
+
**template** | **BOOLEAN**| Used to get Procedure template list | [optional] [default to false]
|
139
|
+
**members** | [**Array<String>**](String.md)| Get Procedure list for given members (paraph mode) | [optional]
|
140
|
+
**items_per_page** | **String**| Number of items per page for the pagination | [optional]
|
141
|
+
**pagination** | **BOOLEAN**| Enable the pagination | [optional]
|
142
|
+
**page** | **Integer**| Page of the pagination | [optional]
|
143
|
+
**name** | **String**| Filter by name (contains) | [optional]
|
144
|
+
**members_firstname** | **String**| Filter by member firstname (contains) | [optional]
|
145
|
+
**members_lastname** | **String**| Filter by member lastname (contains) | [optional]
|
146
|
+
**members_phone** | **String**| Filter by member phone (contains) | [optional]
|
147
|
+
**members_email** | **String**| Filter by member email (contains) | [optional]
|
148
|
+
**files_name** | **String**| Filter by file name (contains) | [optional]
|
149
|
+
**created_at** | [**Array<Date>**](Date.md)| Filter by creation date createdAt[after]=2017-09-18 createdAt[before]=2017-09-18 createdAt[strictly_after]=2017-09-18 createdAt[strictly_before]=2017-09-18 | [optional]
|
150
|
+
**updated_at** | [**Array<Date>**](Date.md)| Filter by update date updatedAt[after]=2017-09-18 updatedAt[before]=2017-09-18 updatedAt[strictly_after]=2017-09-18 updatedAt[strictly_before]=2017-09-18 | [optional]
|
151
|
+
**expires_at** | [**Array<Date>**](Date.md)| Filter by expire date expiresAt[after]=2017-09-18 expiresAt[before]=2017-09-18 expiresAt[strictly_after]=2017-09-18 expiresAt[strictly_before]=2017-09-18 | [optional]
|
152
|
+
**deleted_at** | [**Array<Date>**](Date.md)| Filter by delete date deletedAt[after]=2017-09-18 deletedAt[before]=2017-09-18 deletedAt[strictly_after]=2017-09-18 deletedAt[strictly_before]=2017-09-18 | [optional]
|
153
|
+
**order_created_at** | **String**| Order by createdAt order[createdAt]=asc order[createdAt]=desc | [optional]
|
154
|
+
|
155
|
+
### Return type
|
156
|
+
|
157
|
+
[**Array<ProcedureOutput>**](ProcedureOutput.md)
|
158
|
+
|
159
|
+
### Authorization
|
160
|
+
|
161
|
+
No authorization required
|
162
|
+
|
163
|
+
### HTTP request headers
|
164
|
+
|
165
|
+
- **Content-Type**: application/json
|
166
|
+
- **Accept**: application/json
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
# **procedures_id_delete**
|
171
|
+
> procedures_id_delete(id, authorization)
|
172
|
+
|
173
|
+
Delete a Procedure
|
174
|
+
|
175
|
+
### Example
|
176
|
+
```ruby
|
177
|
+
# load the gem
|
178
|
+
require 'yousign_client'
|
179
|
+
|
180
|
+
api_instance = YousignClient::ProceduresApi.new
|
181
|
+
|
182
|
+
id = 'id_example' # String |
|
183
|
+
|
184
|
+
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
185
|
+
|
186
|
+
|
187
|
+
begin
|
188
|
+
#Delete a Procedure
|
189
|
+
api_instance.procedures_id_delete(id, authorization)
|
190
|
+
rescue YousignClient::ApiError => e
|
191
|
+
puts "Exception when calling ProceduresApi->procedures_id_delete: #{e}"
|
192
|
+
end
|
193
|
+
```
|
194
|
+
|
195
|
+
### Parameters
|
196
|
+
|
197
|
+
Name | Type | Description | Notes
|
198
|
+
------------- | ------------- | ------------- | -------------
|
199
|
+
**id** | **String**| |
|
200
|
+
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
201
|
+
|
202
|
+
### Return type
|
203
|
+
|
204
|
+
nil (empty response body)
|
205
|
+
|
206
|
+
### Authorization
|
207
|
+
|
208
|
+
No authorization required
|
209
|
+
|
210
|
+
### HTTP request headers
|
211
|
+
|
212
|
+
- **Content-Type**: application/json
|
213
|
+
- **Accept**: application/json
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
# **procedures_id_duplicate_post**
|
218
|
+
> ProcedureOutput procedures_id_duplicate_post(id, authorization, content_type, body)
|
219
|
+
|
220
|
+
Duplicate a Procedure
|
221
|
+
|
222
|
+
### Example
|
223
|
+
```ruby
|
224
|
+
# load the gem
|
225
|
+
require 'yousign_client'
|
226
|
+
|
227
|
+
api_instance = YousignClient::ProceduresApi.new
|
228
|
+
|
229
|
+
id = 'id_example' # String |
|
230
|
+
|
231
|
+
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
232
|
+
|
233
|
+
content_type = 'application/json' # String | The MIME type of the body of the request
|
234
|
+
|
235
|
+
body = YousignClient::ProcedureDuplicateInput.new # ProcedureDuplicateInput |
|
236
|
+
|
237
|
+
|
238
|
+
begin
|
239
|
+
#Duplicate a Procedure
|
240
|
+
result = api_instance.procedures_id_duplicate_post(id, authorization, content_type, body)
|
241
|
+
p result
|
242
|
+
rescue YousignClient::ApiError => e
|
243
|
+
puts "Exception when calling ProceduresApi->procedures_id_duplicate_post: #{e}"
|
244
|
+
end
|
245
|
+
```
|
246
|
+
|
247
|
+
### Parameters
|
248
|
+
|
249
|
+
Name | Type | Description | Notes
|
250
|
+
------------- | ------------- | ------------- | -------------
|
251
|
+
**id** | **String**| |
|
252
|
+
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
253
|
+
**content_type** | **String**| The MIME type of the body of the request |
|
254
|
+
**body** | [**ProcedureDuplicateInput**](ProcedureDuplicateInput.md)| |
|
255
|
+
|
256
|
+
### Return type
|
257
|
+
|
258
|
+
[**ProcedureOutput**](ProcedureOutput.md)
|
259
|
+
|
260
|
+
### Authorization
|
261
|
+
|
262
|
+
No authorization required
|
263
|
+
|
264
|
+
### HTTP request headers
|
265
|
+
|
266
|
+
- **Content-Type**: Not defined
|
267
|
+
- **Accept**: application/json
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
# **procedures_id_get**
|
272
|
+
> ProcedureOutput procedures_id_get(id, authorization)
|
273
|
+
|
274
|
+
Find a Procedure by ID
|
275
|
+
|
276
|
+
### Example
|
277
|
+
```ruby
|
278
|
+
# load the gem
|
279
|
+
require 'yousign_client'
|
280
|
+
|
281
|
+
api_instance = YousignClient::ProceduresApi.new
|
282
|
+
|
283
|
+
id = 'id_example' # String |
|
284
|
+
|
285
|
+
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
286
|
+
|
287
|
+
|
288
|
+
begin
|
289
|
+
#Find a Procedure by ID
|
290
|
+
result = api_instance.procedures_id_get(id, authorization)
|
291
|
+
p result
|
292
|
+
rescue YousignClient::ApiError => e
|
293
|
+
puts "Exception when calling ProceduresApi->procedures_id_get: #{e}"
|
294
|
+
end
|
295
|
+
```
|
296
|
+
|
297
|
+
### Parameters
|
298
|
+
|
299
|
+
Name | Type | Description | Notes
|
300
|
+
------------- | ------------- | ------------- | -------------
|
301
|
+
**id** | **String**| |
|
302
|
+
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
303
|
+
|
304
|
+
### Return type
|
305
|
+
|
306
|
+
[**ProcedureOutput**](ProcedureOutput.md)
|
307
|
+
|
308
|
+
### Authorization
|
309
|
+
|
310
|
+
No authorization required
|
311
|
+
|
312
|
+
### HTTP request headers
|
313
|
+
|
314
|
+
- **Content-Type**: application/json
|
315
|
+
- **Accept**: application/json
|
316
|
+
|
317
|
+
|
318
|
+
|
319
|
+
# **procedures_id_proof_get**
|
320
|
+
> String procedures_id_proof_get(id, authorization)
|
321
|
+
|
322
|
+
Get a Procedure proof file
|
323
|
+
|
324
|
+
Get a Procedure proof file
|
325
|
+
|
326
|
+
### Example
|
327
|
+
```ruby
|
328
|
+
# load the gem
|
329
|
+
require 'yousign_client'
|
330
|
+
|
331
|
+
api_instance = YousignClient::ProceduresApi.new
|
332
|
+
|
333
|
+
id = 'id_example' # String |
|
334
|
+
|
335
|
+
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
336
|
+
|
337
|
+
|
338
|
+
begin
|
339
|
+
#Get a Procedure proof file
|
340
|
+
result = api_instance.procedures_id_proof_get(id, authorization)
|
341
|
+
p result
|
342
|
+
rescue YousignClient::ApiError => e
|
343
|
+
puts "Exception when calling ProceduresApi->procedures_id_proof_get: #{e}"
|
344
|
+
end
|
345
|
+
```
|
346
|
+
|
347
|
+
### Parameters
|
348
|
+
|
349
|
+
Name | Type | Description | Notes
|
350
|
+
------------- | ------------- | ------------- | -------------
|
351
|
+
**id** | **String**| |
|
352
|
+
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
353
|
+
|
354
|
+
### Return type
|
355
|
+
|
356
|
+
**String**
|
357
|
+
|
358
|
+
### Authorization
|
359
|
+
|
360
|
+
No authorization required
|
361
|
+
|
362
|
+
### HTTP request headers
|
363
|
+
|
364
|
+
- **Content-Type**: application/json
|
365
|
+
- **Accept**: application/json
|
366
|
+
|
367
|
+
|
368
|
+
|
369
|
+
# **procedures_id_put**
|
370
|
+
> ProcedureOutput procedures_id_put(id, authorization, content_type, body)
|
371
|
+
|
372
|
+
Update a Procedure
|
373
|
+
|
374
|
+
### Example
|
375
|
+
```ruby
|
376
|
+
# load the gem
|
377
|
+
require 'yousign_client'
|
378
|
+
|
379
|
+
api_instance = YousignClient::ProceduresApi.new
|
380
|
+
|
381
|
+
id = 'id_example' # String |
|
382
|
+
|
383
|
+
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
384
|
+
|
385
|
+
content_type = 'application/json' # String | The MIME type of the body of the request
|
386
|
+
|
387
|
+
body = YousignClient::ProcedureInput.new # ProcedureInput |
|
388
|
+
|
389
|
+
|
390
|
+
begin
|
391
|
+
#Update a Procedure
|
392
|
+
result = api_instance.procedures_id_put(id, authorization, content_type, body)
|
393
|
+
p result
|
394
|
+
rescue YousignClient::ApiError => e
|
395
|
+
puts "Exception when calling ProceduresApi->procedures_id_put: #{e}"
|
396
|
+
end
|
397
|
+
```
|
398
|
+
|
399
|
+
### Parameters
|
400
|
+
|
401
|
+
Name | Type | Description | Notes
|
402
|
+
------------- | ------------- | ------------- | -------------
|
403
|
+
**id** | **String**| |
|
404
|
+
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
405
|
+
**content_type** | **String**| The MIME type of the body of the request |
|
406
|
+
**body** | [**ProcedureInput**](ProcedureInput.md)| |
|
407
|
+
|
408
|
+
### Return type
|
409
|
+
|
410
|
+
[**ProcedureOutput**](ProcedureOutput.md)
|
411
|
+
|
412
|
+
### Authorization
|
413
|
+
|
414
|
+
No authorization required
|
415
|
+
|
416
|
+
### HTTP request headers
|
417
|
+
|
418
|
+
- **Content-Type**: Not defined
|
419
|
+
- **Accept**: application/json
|
420
|
+
|
421
|
+
|
422
|
+
|
423
|
+
# **procedures_id_remind_post**
|
424
|
+
> ProcedureOutput procedures_id_remind_post(id, authorization, content_type, body)
|
425
|
+
|
426
|
+
Remind a Procedure
|
427
|
+
|
428
|
+
### Example
|
429
|
+
```ruby
|
430
|
+
# load the gem
|
431
|
+
require 'yousign_client'
|
432
|
+
|
433
|
+
api_instance = YousignClient::ProceduresApi.new
|
434
|
+
|
435
|
+
id = 'id_example' # String |
|
436
|
+
|
437
|
+
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
438
|
+
|
439
|
+
content_type = 'application/json' # String | The MIME type of the body of the request
|
440
|
+
|
441
|
+
body = YousignClient::ProcedureRemindInput.new # ProcedureRemindInput |
|
442
|
+
|
443
|
+
|
444
|
+
begin
|
445
|
+
#Remind a Procedure
|
446
|
+
result = api_instance.procedures_id_remind_post(id, authorization, content_type, body)
|
447
|
+
p result
|
448
|
+
rescue YousignClient::ApiError => e
|
449
|
+
puts "Exception when calling ProceduresApi->procedures_id_remind_post: #{e}"
|
450
|
+
end
|
451
|
+
```
|
452
|
+
|
453
|
+
### Parameters
|
454
|
+
|
455
|
+
Name | Type | Description | Notes
|
456
|
+
------------- | ------------- | ------------- | -------------
|
457
|
+
**id** | **String**| |
|
458
|
+
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
459
|
+
**content_type** | **String**| The MIME type of the body of the request |
|
460
|
+
**body** | [**ProcedureRemindInput**](ProcedureRemindInput.md)| |
|
461
|
+
|
462
|
+
### Return type
|
463
|
+
|
464
|
+
[**ProcedureOutput**](ProcedureOutput.md)
|
465
|
+
|
466
|
+
### Authorization
|
467
|
+
|
468
|
+
No authorization required
|
469
|
+
|
470
|
+
### HTTP request headers
|
471
|
+
|
472
|
+
- **Content-Type**: Not defined
|
473
|
+
- **Accept**: application/json
|
474
|
+
|
475
|
+
|
476
|
+
|
477
|
+
# **procedures_post**
|
478
|
+
> ProcedureOutput procedures_post(authorization, content_type, body)
|
479
|
+
|
480
|
+
Create a new Procedure
|
481
|
+
|
482
|
+
### Example
|
483
|
+
```ruby
|
484
|
+
# load the gem
|
485
|
+
require 'yousign_client'
|
486
|
+
|
487
|
+
api_instance = YousignClient::ProceduresApi.new
|
488
|
+
|
489
|
+
authorization = 'Bearer {{access_token}}' # String | Authentication credentials for HTTP authentication
|
490
|
+
|
491
|
+
content_type = 'application/json' # String | The MIME type of the body of the request
|
492
|
+
|
493
|
+
body = YousignClient::ProcedureInput.new # ProcedureInput |
|
494
|
+
|
495
|
+
|
496
|
+
begin
|
497
|
+
#Create a new Procedure
|
498
|
+
result = api_instance.procedures_post(authorization, content_type, body)
|
499
|
+
p result
|
500
|
+
rescue YousignClient::ApiError => e
|
501
|
+
puts "Exception when calling ProceduresApi->procedures_post: #{e}"
|
502
|
+
end
|
503
|
+
```
|
504
|
+
|
505
|
+
### Parameters
|
506
|
+
|
507
|
+
Name | Type | Description | Notes
|
508
|
+
------------- | ------------- | ------------- | -------------
|
509
|
+
**authorization** | **String**| Authentication credentials for HTTP authentication |
|
510
|
+
**content_type** | **String**| The MIME type of the body of the request |
|
511
|
+
**body** | [**ProcedureInput**](ProcedureInput.md)| |
|
512
|
+
|
513
|
+
### Return type
|
514
|
+
|
515
|
+
[**ProcedureOutput**](ProcedureOutput.md)
|
516
|
+
|
517
|
+
### Authorization
|
518
|
+
|
519
|
+
No authorization required
|
520
|
+
|
521
|
+
### HTTP request headers
|
522
|
+
|
523
|
+
- **Content-Type**: Not defined
|
524
|
+
- **Accept**: application/json
|
525
|
+
|
526
|
+
|
527
|
+
|