API de Dropbox Sign v3
Este SDK se genera a partir de nuestra especificación OpenAPI mantenida oficialmente. Hemos realizado actualizaciones importantes que introducen nuevas funciones y crean paridad de funciones entre la API de Dropbox Sign y el SDK. Sin embargo, algunos de estos cambios se consideran "importantes" en el sentido de que requerirán que actualice su código existente para poder continuar usando el SDK. Consulte esta guía de migración para obtener más información.
Este repositorio ya no acepta nuevos problemas ni solicitudes de extracción. ¡Todos los problemas o solicitudes de extracción deben abrirse en el repositorio hellosign/hellosign-openapi!
Debe realizar cambios en el código SDK en el archivo bigote dentro del directorio templates que corresponde al archivo que desea actualizar.
Este SDK de C# lo genera automáticamente el proyecto OpenAPI Generator:
Debe tener instalado docker (o podman vinculado a docker ). Muy recomendable utilizar Docker sin raíz.
Ejecute lo siguiente y todo estará hecho por usted:
./run-buildAtención : Cualquier cambio que haya realizado en el código SDK que no haya realizado en el archivo OAS y/o en los archivos de plantilla de bigote se perderá cuando ejecute este comando.
El SDK de Dropbox Sign .NET se puede instalar utilizando el administrador de paquetes NuGet, con el nombre del paquete Dropbox.Sign (detalles del paquete).
Puede seguir el inicio rápido de NuGet para crear y publicar el paquete a través de la CLI de dotnet. O puede crear y publicar usando Visual Studio.
Alternativamente, el .nupkg se puede publicar en un feed local u otro host y consumirse a través de NuGet como de costumbre.
Para utilizar el cliente API con un proxy HTTP, configure un System.Net.WebProxy
Configuration c = new Configuration ( ) ;
System . Net . WebProxy webProxy = new System . Net . WebProxy ( " http://myProxyUrl:80/ " ) ;
webProxy . Credentials = System . Net . CredentialCache . DefaultCredentials ;
c . Proxy = webProxy ; using System ;
using Dropbox . Sign . Api ;
using Dropbox . Sign . Client ;
using Dropbox . Sign . Model ;
public class Example
{
public static void Main ( )
{
var config = new Configuration ( ) ;
// Configure HTTP basic authorization: api_key
config . Username = " YOUR_API_KEY " ;
// or, configure Bearer (JWT) authorization: oauth2
// config.AccessToken = "YOUR_BEARER_TOKEN";
var accountApi = new AccountApi ( config ) ;
var data = new AccountCreateRequest (
emailAddress : " [email protected] "
) ;
try
{
var result = accountApi . AccountCreate ( data ) ;
Console . WriteLine ( result ) ;
}
catch ( ApiException e )
{
Console . WriteLine ( " Exception when calling Dropbox Sign API: " + e . Message ) ;
Console . WriteLine ( " Status Code: " + e . ErrorCode ) ;
Console . WriteLine ( e . StackTrace ) ;
}
}
} Todos los URI son relativos a https://api.hellosign.com/v3
| Clase | Método | solicitud HTTP | Descripción |
|---|---|---|---|
| CuentaApi | Crear cuenta | PUBLICAR /cuenta/crear | Crear una cuenta |
| CuentaApi | CuentaObtener | OBTENER /cuenta | Obtener cuenta |
| CuentaApi | Actualización de cuenta | PUT /cuenta | Actualizar cuenta |
| CuentaApi | CuentaVerificar | POST /cuenta/verificar | Verificar cuenta |
| ApiAppApi | ApiAppCrear | ENVIAR /api_app | Crear aplicación API |
| ApiAppApi | ApiAppDelete | ELIMINAR /api_app/{client_id} | Eliminar aplicación API |
| ApiAppApi | ApiAppObtener | OBTENER /api_app/{client_id} | Obtener la aplicación API |
| ApiAppApi | Lista de aplicaciones Api | OBTENER /api_app/list | Listar aplicaciones API |
| ApiAppApi | Actualización de ApiApp | PUT /api_app/{client_id} | Actualizar la aplicación API |
| BulkSendJobApi | Envío masivo de trabajoObtener | OBTENER /bulk_send_job/{bulk_send_job_id} | Obtener trabajo de envío masivo |
| BulkSendJobApi | Lista de trabajos de envío masivo | OBTENER /bulk_send_job/list | Listar trabajos de envío masivo |
| API integrada | URL de edición incrustada | ENVIAR /embedded/edit_url/{template_id} | Obtener plantilla integrada Editar URL |
| API integrada | Url de señal incrustada | OBTENER /embedded/sign_url/{signature_id} | Obtener URL de firma incrustada |
| FaxApi | Eliminar fax | BORRAR /fax/{fax_id} | Eliminar fax |
| FaxApi | Archivos de fax | OBTENER /fax/archivos/{fax_id} | Listar archivos de fax |
| FaxApi | Obtener fax | OBTENER /fax/{fax_id} | Obtener fax |
| FaxApi | Lista de faxes | OBTENER /fax/lista | Listas de faxes |
| FaxApi | Enviar fax | CORREO /fax/enviar | Enviar fax |
| FaxLineApi | Línea de faxAgregar usuario | PUT /línea_fax/añadir_usuario | Agregar usuario de línea de fax |
| FaxLineApi | Código de área de línea de faxObtener | OBTENER /línea_fax/códigos_área | Obtenga códigos de área de línea de fax disponibles |
| FaxLineApi | Crear línea de fax | ENVIAR /fax_line/create | Comprar línea de fax |
| FaxLineApi | Línea de faxEliminar | BORRAR /línea_fax | Eliminar línea de fax |
| FaxLineApi | Línea de faxObtener | OBTENER /fax_line | Obtener línea de fax |
| FaxLineApi | Lista de líneas de fax | OBTENER /línea_fax/lista | Listar líneas de fax |
| FaxLineApi | Línea de faxEliminar usuario | PUT /fax_line/remove_user | Eliminar el acceso a la línea de fax |
| OAuthApi | OauthTokenGenerar | POST /oauth/token | Generación de tokens OAuth |
| OAuthApi | OauthTokenActualizar | POST /oauth/token?refresh | Actualización del token de OAuth |
| InformeApi | InformeCrear | ENVIAR /informe/crear | Crear informe |
| FirmaRequestApi | SignatureRequestBulkCreateEmbeddedWithTemplate | POST /signature_request/bulk_create_embedded_with_template | Envío masivo integrado con plantilla |
| FirmaRequestApi | Solicitud de firmaBulkSendWithTemplate | POST /signature_request/bulk_send_with_template | Envío masivo con plantilla |
| FirmaRequestApi | FirmaSolicitudCancelar | POST /signature_request/cancel/{signature_request_id} | Cancelar solicitud de firma incompleta |
| FirmaRequestApi | Solicitud de firmaCrearIncrustado | POST /signature_request/create_embedded | Crear solicitud de firma integrada |
| FirmaRequestApi | SignatureRequestCreateEmbeddedWithTemplate | POST /signature_request/create_embedded_with_template | Crear solicitud de firma integrada con plantilla |
| FirmaRequestApi | Archivos de solicitud de firma | OBTENER /signature_request/files/{signature_request_id} | Descargar archivos |
| FirmaRequestApi | FirmaRequestFilesAsDataUri | OBTENER /signature_request/files_as_data_uri/{signature_request_id} | Descargar archivos como Uri de datos |
| FirmaRequestApi | FirmaRequestFilesAsFileUrl | OBTENER /signature_request/files_as_file_url/{signature_request_id} | Descargar archivos como URL de archivo |
| FirmaRequestApi | Solicitud de firmaObtener | OBTENER /signature_request/{signature_request_id} | Obtener solicitud de firma |
| FirmaRequestApi | Lista de solicitudes de firma | OBTENER /signature_request/list | Listar solicitudes de firma |
| FirmaRequestApi | FirmaSolicitudLiberaciónRetener | POST /signature_request/release_hold/{signature_request_id} | Liberar solicitud de firma en espera |
| FirmaRequestApi | FirmaSolicitudRecordar | POST /signature_request/remind/{signature_request_id} | Enviar recordatorio de solicitud |
| FirmaRequestApi | Solicitud de firmaEliminar | POST /signature_request/remove/{signature_request_id} | Eliminar acceso a solicitud de firma |
| FirmaRequestApi | FirmaSolicitudEnviar | POST /solicitud_firma/enviar | Enviar solicitud de firma |
| FirmaRequestApi | Solicitud de firmaEnviar con plantilla | POST /solicitud_firma/enviar_con_plantilla | Enviar con plantilla |
| FirmaRequestApi | Actualización de solicitud de firma | POST /signature_request/update/{signature_request_id} | Solicitud de actualización de firma |
| EquipoApi | EquipoAgregarMiembro | PUT /equipo/añadir_miembro | Agregar usuario al equipo |
| EquipoApi | Crear equipo | PUBLICAR /equipo/crear | Crear equipo |
| EquipoApi | EquipoEliminar | BORRAR /equipo/destruir | Eliminar equipo |
| EquipoApi | EquipoObtener | OBTENER /equipo | Obtener equipo |
| EquipoApi | Información del equipo | OBTENER /equipo/información | Obtener información del equipo |
| EquipoApi | Invitaciones al equipo | OBTENER /equipo/invitaciones | Listar invitaciones al equipo |
| EquipoApi | Miembros del equipo | OBTENER /equipo/miembros/{team_id} | Listar miembros del equipo |
| EquipoApi | EquipoEliminar Miembro | POST /equipo/remove_member | Eliminar usuario del equipo |
| EquipoApi | EquipoSubequipos | OBTENER /team/sub_teams/{team_id} | Listar subequipos |
| EquipoApi | Actualización del equipo | PUT /equipo | Equipo de actualización |
| PlantillaApi | PlantillaAgregarUsuario | POST /template/add_user/{template_id} | Agregar usuario a la plantilla |
| PlantillaApi | Crear plantilla | PUBLICAR /plantilla/crear | Crear plantilla |
| PlantillaApi | PlantillaCrearborrador integrado | POST /template/create_embedded_draft | Crear borrador de plantilla incrustado |
| PlantillaApi | PlantillaEliminar | POST /plantilla/eliminar/{template_id} | Eliminar plantilla |
| PlantillaApi | Archivos de plantilla | OBTENER /plantilla/archivos/{template_id} | Obtener archivos de plantilla |
| PlantillaApi | Archivos de plantilla como datos Uri | OBTENER /template/files_as_data_uri/{template_id} | Obtener archivos de plantilla como URI de datos |
| PlantillaApi | Archivos de plantilla como URL de archivo | OBTENER /template/files_as_file_url/{template_id} | Obtener archivos de plantilla como URL de archivo |
| PlantillaApi | PlantillaObtener | OBTENER /plantilla/{template_id} | Obtener plantilla |
| PlantillaApi | Lista de plantillas | OBTENER /plantilla/lista | Plantillas de lista |
| PlantillaApi | PlantillaEliminarUsuario | POST /template/remove_user/{template_id} | Eliminar usuario de la plantilla |
| PlantillaApi | Archivos de actualización de plantilla | POST /template/update_files/{template_id} | Actualizar archivos de plantilla |
| DraftApi no reclamado | Borrador no reclamadoCrear | POST /borrador_unclaimed/create | Crear borrador no reclamado |
| DraftApi no reclamado | No reclamadoBorradorCrearIncrustado | POST /borrador_unclaimed/create_embedded | Crear borrador incrustado no reclamado |
| DraftApi no reclamado | Borrador no reclamadoCreateEmbeddedWithTemplate | POST /borrador_unclaimed/create_embedded_with_template | Crear borrador incrustado no reclamado con plantilla |
| DraftApi no reclamado | Borrador no reclamadoEditAndResend | POST /borrador_unclaimed/edit_and_resend/{signature_request_id} | Editar y reenviar borrador no reclamado |
Esquemas de autenticación definidos para la API:
