API Dropbox Sign v3
Este SDK é gerado a partir de nossa especificação OpenAPI mantida oficialmente. Fizemos atualizações importantes que introduzem novas funcionalidades e criam paridade de recursos entre a API do Dropbox Sign e o SDK. No entanto, algumas dessas alterações são consideradas "rupturas", no sentido de que exigirão que você atualize seu código existente para continuar usando o SDK. Consulte este guia de migração para obter mais informações.
Este repositório não aceita mais novos problemas ou solicitações pull. Todos os problemas ou solicitações pull devem ser abertos no repositório hellosign/hellosign-openapi!
Você deve fazer alterações no código SDK no arquivo bigode no diretório templates que corresponde ao arquivo que deseja atualizar.
Este SDK C# é gerado automaticamente pelo projeto OpenAPI Generator:
Você deve ter docker (ou podman vinculado ao docker ) instalado. Altamente recomendado usar o docker sem root.
Execute o seguinte e tudo será feito para você:
./run-buildAtenção : Quaisquer alterações feitas no código SDK que não foram feitas no arquivo OAS e/ou nos arquivos de modelo bigode serão perdidas quando você executar este comando.
O Dropbox Sign .NET SDK pode ser instalado usando o gerenciador de pacotes NuGet, sob o nome de pacote Dropbox.Sign (detalhes do pacote).
Você pode seguir o início rápido do NuGet para criar e publicar o pacote por meio da CLI dotnet. Ou você pode criar e publicar usando o Visual Studio.
Alternativamente, o .nupkg pode ser publicado em um feed local ou outro host e consumido via NuGet normalmente.
Para usar o cliente API com um proxy HTTP, configure um 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 os URIs são relativos a https://api.hellosign.com/v3
| Aula | Método | Solicitação HTTP | Descrição |
|---|---|---|---|
| API de conta | Criar conta | POST /conta/criar | Criar uma conta |
| API de conta | ContaObter | OBTER / conta | Obter conta |
| API de conta | Atualização de conta | PUT / conta | Atualizar conta |
| API de conta | Verificação de conta | POST /conta/verificar | Verifique a conta |
| ApiAppApi | ApiAppCreate | POST /api_app | Criar aplicativo API |
| ApiAppApi | ApiAppDelete | EXCLUIR /api_app/{client_id} | Excluir aplicativo API |
| ApiAppApi | ApiAppGet | OBTER /api_app/{client_id} | Obtenha o aplicativo API |
| ApiAppApi | APIAppList | GET /api_app/list | Listar aplicativos de API |
| ApiAppApi | ApiAppUpdate | PUT /api_app/{client_id} | Atualizar aplicativo API |
| BulkSendJobAPI | BulkSendJobGet | OBTER /bulk_send_job/{bulk_send_job_id} | Obter trabalho de envio em massa |
| BulkSendJobAPI | BulkSendJobList | GET /bulk_send_job/lista | Listar trabalhos de envio em massa |
| API incorporada | EmbeddedEditUrl | POST /embedded/edit_url/{template_id} | Obtenha o URL de edição do modelo incorporado |
| API incorporada | EmbeddedSignUrl | OBTER /embedded/sign_url/{signature_id} | Obtenha URL de sinal incorporado |
| FaxAPI | FaxExcluir | EXCLUIR /fax/{fax_id} | Excluir fax |
| FaxAPI | Arquivos de fax | OBTER /fax/arquivos/{fax_id} | Listar arquivos de fax |
| FaxAPI | Obter fax | OBTER /fax/{fax_id} | Obter fax |
| FaxAPI | Lista de fax | OBTER /fax/lista | Lista faxes |
| FaxAPI | FaxEnviar | POSTAR /fax/enviar | Enviar fax |
| FaxLineApi | FaxLineAddUser | COLOQUE /fax_line/add_user | Adicionar usuário de linha de fax |
| FaxLineApi | FaxLineAreaCodeGet | OBTER /fax_line/area_codes | Obtenha códigos de área de linha de fax disponíveis |
| FaxLineApi | FaxLineCreate | POST /fax_line/criar | Comprar linha de fax |
| FaxLineApi | FaxLineExcluir | EXCLUIR /fax_line | Excluir linha de fax |
| FaxLineApi | FaxLineObter | GET /fax_line | Obter linha de fax |
| FaxLineApi | Lista de linhas de fax | GET /fax_line/lista | Listar linhas de fax |
| FaxLineApi | FaxLineRemoveUser | PUT /fax_line/remove_user | Remover acesso à linha de fax |
| OAuthApi | OauthTokenGenerate | POST /oauth/token | Geração de token OAuth |
| OAuthApi | OauthTokenRefresh | POST /oauth/token?refresh | Atualização do token OAuth |
| API de relatório | Criar relatório | POST /relatório/criar | Criar relatório |
| SignatureRequestAPI | SignatureRequestBulkCreateEmbeddedWithTemplate | POST /signature_request/bulk_create_embedded_with_template | Envio em massa incorporado com modelo |
| SignatureRequestAPI | SignatureRequestBulkSendWithTemplate | POST /signature_request/bulk_send_with_template | Envio em massa com modelo |
| SignatureRequestAPI | AssinaturaRequestCancel | POST /signature_request/cancel/{signature_request_id} | Cancelar solicitação de assinatura incompleta |
| SignatureRequestAPI | SignatureRequestCreateEmbedded | POST /signature_request/create_embedded | Criar solicitação de assinatura incorporada |
| SignatureRequestAPI | SignatureRequestCreateEmbeddedWithTemplate | POST /signature_request/create_embedded_with_template | Criar solicitação de assinatura incorporada com modelo |
| SignatureRequestAPI | Arquivos de solicitação de assinatura | OBTER /signature_request/files/{signature_request_id} | Baixar arquivos |
| SignatureRequestAPI | SignatureRequestFilesAsDataUri | OBTER /signature_request/files_as_data_uri/{signature_request_id} | Baixar arquivos como Uri de dados |
| SignatureRequestAPI | SignatureRequestFilesAsFileUrl | OBTER /signature_request/files_as_file_url/{signature_request_id} | Baixar arquivos como URL do arquivo |
| SignatureRequestAPI | Solicitação de assinaturaGet | OBTER /signature_request/{signature_request_id} | Obter solicitação de assinatura |
| SignatureRequestAPI | Lista de Solicitações de Assinatura | GET /signature_request/lista | Listar solicitações de assinatura |
| SignatureRequestAPI | SignatureRequestReleaseHold | POST /signature_request/release_hold/{signature_request_id} | Liberar solicitação de assinatura em espera |
| SignatureRequestAPI | AssinaturaRequestRemind | POST /signature_request/remind/{signature_request_id} | Enviar lembrete de solicitação |
| SignatureRequestAPI | SignatureRequestRemover | POST /signature_request/remove/{signature_request_id} | Remover acesso à solicitação de assinatura |
| SignatureRequestAPI | Solicitação de assinaturaEnviar | POST /signature_request/enviar | Enviar solicitação de assinatura |
| SignatureRequestAPI | SignatureRequestSendWithTemplate | POST /signature_request/send_with_template | Enviar com modelo |
| SignatureRequestAPI | AssinaturaRequestUpdate | POST /signature_request/update/{signature_request_id} | Atualizar solicitação de assinatura |
| Equipe API | Membro da EquipeAdd | PUT /equipe/add_member | Adicionar usuário à equipe |
| Equipe API | EquipeCriar | POST /equipe/criar | Criar equipe |
| Equipe API | EquipeExcluir | DELETE /equipe/destruir | Excluir equipe |
| Equipe API | EquipeGet | OBTER /equipe | Obter equipe |
| Equipe API | Informações da equipe | OBTER /equipe/informações | Obtenha informações da equipe |
| Equipe API | Convites de equipe | OBTER /equipe/convites | Listar convites da equipe |
| Equipe API | Membros da equipe | OBTER /equipe/membros/{team_id} | Listar membros da equipe |
| Equipe API | EquipeRemoverMembro | POST /team/remove_member | Remover usuário da equipe |
| Equipe API | EquipeSubEquipes | OBTER /team/sub_teams/{team_id} | Listar subequipes |
| Equipe API | Atualização da equipe | PUT /equipe | Equipe de atualização |
| API de modelo | ModeloAddUser | POST /template/add_user/{template_id} | Adicionar usuário ao modelo |
| API de modelo | Criar modelo | POST /modelo/criar | Criar modelo |
| API de modelo | TemplateCreateEmbeddedDraft | POST /template/create_embedded_draft | Criar rascunho de modelo incorporado |
| API de modelo | Excluir modelo | POST /template/delete/{template_id} | Excluir modelo |
| API de modelo | Arquivos de modelo | OBTER /template/files/{template_id} | Obtenha arquivos de modelo |
| API de modelo | TemplateFilesAsDataUri | OBTER /template/files_as_data_uri/{template_id} | Obtenha arquivos de modelo como Data Uri |
| API de modelo | TemplateFilesAsFileUrl | OBTER /template/files_as_file_url/{template_id} | Obtenha arquivos de modelo como URL de arquivo |
| API de modelo | ModeloObter | OBTER /template/{template_id} | Obter modelo |
| API de modelo | Lista de modelos | GET /modelo/lista | Modelos de lista |
| API de modelo | ModeloRemoverUsuário | POST /template/remove_user/{template_id} | Remover usuário do modelo |
| API de modelo | Arquivos de atualização de modelo | POST /template/update_files/{template_id} | Atualizar arquivos de modelo |
| API de rascunho não reclamada | Não reivindicado RascunhoCriar | POST /unclaimed_draft/criar | Criar rascunho não reclamado |
| API de rascunho não reclamada | Não reclamadoDraftCreateEmbedded | POST /unclaimed_draft/create_embedded | Criar rascunho incorporado não reivindicado |
| API de rascunho não reclamada | Não reivindicadoDraftCreateEmbeddedWithTemplate | POST /unclaimed_draft/create_embedded_with_template | Criar rascunho não reivindicado incorporado com modelo |
| API de rascunho não reclamada | Rascunho não reclamadoEditar e reenviar | POST /unclaimed_draft/edit_and_resend/{signature_request_id} | Editar e reenviar rascunho não reclamado |
Esquemas de autenticação definidos para a API:
