Skip to content

FaxLineApi.md

Latest commit

 

History

History
514 lines (347 loc) · 12.3 KB

FaxLineApi.md

File metadata and controls

514 lines (347 loc) · 12.3 KB

Dropbox::Sign::FaxLineApi

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

Method HTTP request Description
fax_line_add_user PUT /fax_line/add_user Add Fax Line User
fax_line_area_code_get GET /fax_line/area_codes Get Available Fax Line Area Codes
fax_line_create POST /fax_line/create Purchase Fax Line
fax_line_delete DELETE /fax_line Delete Fax Line
fax_line_get GET /fax_line Get Fax Line
fax_line_list GET /fax_line/list List Fax Lines
fax_line_remove_user PUT /fax_line/remove_user Remove Fax Line Access

fax_line_add_user

<FaxLineResponse> fax_line_add_user(fax_line_add_user_request)

Add Fax Line User

Grants a user access to the specified Fax Line.

Examples

require "json"
require "dropbox-sign"

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

fax_line_add_user_request = Dropbox::Sign::FaxLineAddUserRequest.new
fax_line_add_user_request.number = "[FAX_NUMBER]"
fax_line_add_user_request.email_address = "member@dropboxsign.com"

begin
  response = Dropbox::Sign::FaxLineApi.new.fax_line_add_user(
    fax_line_add_user_request,
  )

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

Using the fax_line_add_user_with_http_info variant

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

<Array(<FaxLineResponse>, Integer, Hash)> fax_line_add_user_with_http_info(fax_line_add_user_request)

begin
  # Add Fax Line User
  data, status_code, headers = api_instance.fax_line_add_user_with_http_info(fax_line_add_user_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FaxLineResponse>
rescue Dropbox::Sign::ApiError => e
  puts "Error when calling FaxLineApi->fax_line_add_user_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
fax_line_add_user_request FaxLineAddUserRequest

Return type

FaxLineResponse

Authorization

api_key

HTTP request headers

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

fax_line_area_code_get

<FaxLineAreaCodeGetResponse> fax_line_area_code_get(country, opts)

Get Available Fax Line Area Codes

Returns a list of available area codes for a given state/province and city

Examples

require "json"
require "dropbox-sign"

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

begin
  response = Dropbox::Sign::FaxLineApi.new.fax_line_area_code_get(
    "US", # country
  )

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

Using the fax_line_area_code_get_with_http_info variant

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

<Array(<FaxLineAreaCodeGetResponse>, Integer, Hash)> fax_line_area_code_get_with_http_info(country, opts)

begin
  # Get Available Fax Line Area Codes
  data, status_code, headers = api_instance.fax_line_area_code_get_with_http_info(country, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FaxLineAreaCodeGetResponse>
rescue Dropbox::Sign::ApiError => e
  puts "Error when calling FaxLineApi->fax_line_area_code_get_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
country String Filter area codes by country
state String Filter area codes by state [optional]
province String Filter area codes by province [optional]
city String Filter area codes by city [optional]

Return type

FaxLineAreaCodeGetResponse

Authorization

api_key

HTTP request headers

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

fax_line_create

<FaxLineResponse> fax_line_create(fax_line_create_request)

Purchase Fax Line

Purchases a new Fax Line

Examples

require "json"
require "dropbox-sign"

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

fax_line_create_request = Dropbox::Sign::FaxLineCreateRequest.new
fax_line_create_request.area_code = 209
fax_line_create_request.country = "US"

begin
  response = Dropbox::Sign::FaxLineApi.new.fax_line_create(
    fax_line_create_request,
  )

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

Using the fax_line_create_with_http_info variant

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

<Array(<FaxLineResponse>, Integer, Hash)> fax_line_create_with_http_info(fax_line_create_request)

begin
  # Purchase Fax Line
  data, status_code, headers = api_instance.fax_line_create_with_http_info(fax_line_create_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FaxLineResponse>
rescue Dropbox::Sign::ApiError => e
  puts "Error when calling FaxLineApi->fax_line_create_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
fax_line_create_request FaxLineCreateRequest

Return type

FaxLineResponse

Authorization

api_key

HTTP request headers

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

fax_line_delete

fax_line_delete(fax_line_delete_request)

Delete Fax Line

Deletes the specified Fax Line from the subscription.

Examples

require "json"
require "dropbox-sign"

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

fax_line_delete_request = Dropbox::Sign::FaxLineDeleteRequest.new
fax_line_delete_request.number = "[FAX_NUMBER]"

begin
  Dropbox::Sign::FaxLineApi.new.fax_line_delete(
    fax_line_delete_request,
  )
rescue Dropbox::Sign::ApiError => e
  puts "Exception when calling FaxLineApi#fax_line_delete: #{e}"
end

Using the fax_line_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)> fax_line_delete_with_http_info(fax_line_delete_request)

begin
  # Delete Fax Line
  data, status_code, headers = api_instance.fax_line_delete_with_http_info(fax_line_delete_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Dropbox::Sign::ApiError => e
  puts "Error when calling FaxLineApi->fax_line_delete_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
fax_line_delete_request FaxLineDeleteRequest

Return type

nil (empty response body)

Authorization

api_key

HTTP request headers

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

fax_line_get

<FaxLineResponse> fax_line_get(number)

Get Fax Line

Returns the properties and settings of a Fax Line.

Examples

require "json"
require "dropbox-sign"

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

begin
  response = Dropbox::Sign::FaxLineApi.new.fax_line_get(
    "123-123-1234", # number
  )

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

Using the fax_line_get_with_http_info variant

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

<Array(<FaxLineResponse>, Integer, Hash)> fax_line_get_with_http_info(number)

begin
  # Get Fax Line
  data, status_code, headers = api_instance.fax_line_get_with_http_info(number)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FaxLineResponse>
rescue Dropbox::Sign::ApiError => e
  puts "Error when calling FaxLineApi->fax_line_get_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
number String The Fax Line number

Return type

FaxLineResponse

Authorization

api_key

HTTP request headers

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

fax_line_list

<FaxLineListResponse> fax_line_list(opts)

List Fax Lines

Returns the properties and settings of multiple Fax Lines.

Examples

require "json"
require "dropbox-sign"

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

begin
  response = Dropbox::Sign::FaxLineApi.new.fax_line_list(
    {
          account_id: "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97",
          page: 1,
          page_size: 20,
          show_team_lines: nil,
      },
  )

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

Using the fax_line_list_with_http_info variant

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

<Array(<FaxLineListResponse>, Integer, Hash)> fax_line_list_with_http_info(opts)

begin
  # List Fax Lines
  data, status_code, headers = api_instance.fax_line_list_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FaxLineListResponse>
rescue Dropbox::Sign::ApiError => e
  puts "Error when calling FaxLineApi->fax_line_list_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
account_id String Account ID [optional]
page Integer Which page number of the Fax Line 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]
show_team_lines Boolean Include Fax Lines belonging to team members in the list [optional]

Return type

FaxLineListResponse

Authorization

api_key

HTTP request headers

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

fax_line_remove_user

<FaxLineResponse> fax_line_remove_user(fax_line_remove_user_request)

Remove Fax Line Access

Removes a user's access to the specified Fax Line

Examples

require "json"
require "dropbox-sign"

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

fax_line_remove_user_request = Dropbox::Sign::FaxLineRemoveUserRequest.new
fax_line_remove_user_request.number = "[FAX_NUMBER]"
fax_line_remove_user_request.email_address = "member@dropboxsign.com"

begin
  response = Dropbox::Sign::FaxLineApi.new.fax_line_remove_user(
    fax_line_remove_user_request,
  )

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

Using the fax_line_remove_user_with_http_info variant

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

<Array(<FaxLineResponse>, Integer, Hash)> fax_line_remove_user_with_http_info(fax_line_remove_user_request)

begin
  # Remove Fax Line Access
  data, status_code, headers = api_instance.fax_line_remove_user_with_http_info(fax_line_remove_user_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <FaxLineResponse>
rescue Dropbox::Sign::ApiError => e
  puts "Error when calling FaxLineApi->fax_line_remove_user_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
fax_line_remove_user_request FaxLineRemoveUserRequest

Return type

FaxLineResponse

Authorization

api_key

HTTP request headers

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