Skip to content

ApiAppApi.md

Latest commit

 

History

History
402 lines (279 loc) · 10 KB

ApiAppApi.md

File metadata and controls

402 lines (279 loc) · 10 KB

Dropbox::Sign::ApiAppApi

All URIs are relative to https://api.hellosign.com/v3

Method HTTP request Description
api_app_create POST /api_app Create API App
api_app_delete DELETE /api_app/{client_id} Delete API App
api_app_get GET /api_app/{client_id} Get API App
api_app_list GET /api_app/list List API Apps
api_app_update PUT /api_app/{client_id} Update API App

api_app_create

<ApiAppGetResponse> api_app_create(api_app_create_request)

Create API App

Creates a new API App.

Examples

require "json"
require "dropbox-sign"

Dropbox::Sign.configure do |config|
  config.username = "YOUR_API_KEY"
  # config.access_token = "YOUR_ACCESS_TOKEN"
end

oauth = Dropbox::Sign::SubOAuth.new
oauth.callback_url = "https://example.com/oauth"
oauth.scopes = [
    "basic_account_info",
    "request_signature",
]

white_labeling_options = Dropbox::Sign::SubWhiteLabelingOptions.new
white_labeling_options.primary_button_color = "#00b3e6"
white_labeling_options.primary_button_text_color = "#ffffff"

api_app_create_request = Dropbox::Sign::ApiAppCreateRequest.new
api_app_create_request.name = "My Production App"
api_app_create_request.domains = [
    "example.com",
]
api_app_create_request.custom_logo_file = File.new("CustomLogoFile.png", "r")
api_app_create_request.oauth = oauth
api_app_create_request.white_labeling_options = white_labeling_options

begin
  response = Dropbox::Sign::ApiAppApi.new.api_app_create(
    api_app_create_request,
  )

  p response
rescue Dropbox::Sign::ApiError => e
  puts "Exception when calling ApiAppApi#api_app_create: #{e}"
end

Using the api_app_create_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<ApiAppGetResponse>, Integer, Hash)> api_app_create_with_http_info(api_app_create_request)

begin
  # Create API App
  data, status_code, headers = api_instance.api_app_create_with_http_info(api_app_create_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApiAppGetResponse>
rescue Dropbox::Sign::ApiError => e
  puts "Error when calling ApiAppApi->api_app_create_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
api_app_create_request ApiAppCreateRequest

Return type

ApiAppGetResponse

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: application/json, multipart/form-data
  • Accept: application/json

api_app_delete

api_app_delete(client_id)

Delete API App

Deletes an API App. Can only be invoked for apps you own.

Examples

require "json"
require "dropbox-sign"

Dropbox::Sign.configure do |config|
  config.username = "YOUR_API_KEY"
  # config.access_token = "YOUR_ACCESS_TOKEN"
end

begin
  Dropbox::Sign::ApiAppApi.new.api_app_delete(
    "0dd3b823a682527788c4e40cb7b6f7e9", # client_id
  )
rescue Dropbox::Sign::ApiError => e
  puts "Exception when calling ApiAppApi#api_app_delete: #{e}"
end

Using the api_app_delete_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> api_app_delete_with_http_info(client_id)

begin
  # Delete API App
  data, status_code, headers = api_instance.api_app_delete_with_http_info(client_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Dropbox::Sign::ApiError => e
  puts "Error when calling ApiAppApi->api_app_delete_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
client_id String The client id of the API App to delete.

Return type

nil (empty response body)

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

api_app_get

<ApiAppGetResponse> api_app_get(client_id)

Get API App

Returns an object with information about an API App.

Examples

require "json"
require "dropbox-sign"

Dropbox::Sign.configure do |config|
  config.username = "YOUR_API_KEY"
  # config.access_token = "YOUR_ACCESS_TOKEN"
end

begin
  response = Dropbox::Sign::ApiAppApi.new.api_app_get(
    "0dd3b823a682527788c4e40cb7b6f7e9", # client_id
  )

  p response
rescue Dropbox::Sign::ApiError => e
  puts "Exception when calling ApiAppApi#api_app_get: #{e}"
end

Using the api_app_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<ApiAppGetResponse>, Integer, Hash)> api_app_get_with_http_info(client_id)

begin
  # Get API App
  data, status_code, headers = api_instance.api_app_get_with_http_info(client_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApiAppGetResponse>
rescue Dropbox::Sign::ApiError => e
  puts "Error when calling ApiAppApi->api_app_get_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
client_id String The client id of the API App to retrieve.

Return type

ApiAppGetResponse

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

api_app_list

<ApiAppListResponse> api_app_list(opts)

List API Apps

Returns a list of API Apps that are accessible by you. If you are on a team with an Admin or Developer role, this list will include apps owned by teammates.

Examples

require "json"
require "dropbox-sign"

Dropbox::Sign.configure do |config|
  config.username = "YOUR_API_KEY"
  # config.access_token = "YOUR_ACCESS_TOKEN"
end

begin
  response = Dropbox::Sign::ApiAppApi.new.api_app_list(
    {
          page: 1,
          page_size: 20,
      },
  )

  p response
rescue Dropbox::Sign::ApiError => e
  puts "Exception when calling ApiAppApi#api_app_list: #{e}"
end

Using the api_app_list_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<ApiAppListResponse>, Integer, Hash)> api_app_list_with_http_info(opts)

begin
  # List API Apps
  data, status_code, headers = api_instance.api_app_list_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApiAppListResponse>
rescue Dropbox::Sign::ApiError => e
  puts "Error when calling ApiAppApi->api_app_list_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
page Integer Which page number of the API App List to return. Defaults to 1. [optional][default to 1]
page_size Integer Number of objects to be returned per page. Must be between 1 and 100. Default is 20. [optional][default to 20]

Return type

ApiAppListResponse

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

api_app_update

<ApiAppGetResponse> api_app_update(client_id, api_app_update_request)

Update API App

Updates an existing API App. Can only be invoked for apps you own. Only the fields you provide will be updated. If you wish to clear an existing optional field, provide an empty string.

Examples

require "json"
require "dropbox-sign"

Dropbox::Sign.configure do |config|
  config.username = "YOUR_API_KEY"
  # config.access_token = "YOUR_ACCESS_TOKEN"
end

oauth = Dropbox::Sign::SubOAuth.new
oauth.callback_url = "https://example.com/oauth"
oauth.scopes = [
    "basic_account_info",
    "request_signature",
]

white_labeling_options = Dropbox::Sign::SubWhiteLabelingOptions.new
white_labeling_options.primary_button_color = "#00b3e6"
white_labeling_options.primary_button_text_color = "#ffffff"

api_app_update_request = Dropbox::Sign::ApiAppUpdateRequest.new
api_app_update_request.callback_url = "https://example.com/dropboxsign"
api_app_update_request.name = "New Name"
api_app_update_request.domains = [
    "example.com",
]
api_app_update_request.custom_logo_file = File.new("CustomLogoFile.png", "r")
api_app_update_request.oauth = oauth
api_app_update_request.white_labeling_options = white_labeling_options

begin
  response = Dropbox::Sign::ApiAppApi.new.api_app_update(
    "0dd3b823a682527788c4e40cb7b6f7e9", # client_id
      api_app_update_request,
  )

  p response
rescue Dropbox::Sign::ApiError => e
  puts "Exception when calling ApiAppApi#api_app_update: #{e}"
end

Using the api_app_update_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<ApiAppGetResponse>, Integer, Hash)> api_app_update_with_http_info(client_id, api_app_update_request)

begin
  # Update API App
  data, status_code, headers = api_instance.api_app_update_with_http_info(client_id, api_app_update_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ApiAppGetResponse>
rescue Dropbox::Sign::ApiError => e
  puts "Error when calling ApiAppApi->api_app_update_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
client_id String The client id of the API App to update.
api_app_update_request ApiAppUpdateRequest

Return type

ApiAppGetResponse

Authorization

api_key, oauth2

HTTP request headers

  • Content-Type: application/json, multipart/form-data
  • Accept: application/json