Class: DocuSign_Admin::ReservedDomainsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_admin/api/reserved_domains_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ReservedDomainsApi.default) ⇒ ReservedDomainsApi

Returns a new instance of ReservedDomainsApi.



20
21
22
 
# File 'lib/docusign_admin/api/reserved_domains_api.rb', line 20

def initialize(api_client = ReservedDomainsApi.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



18
19
20
 
# File 'lib/docusign_admin/api/reserved_domains_api.rb', line 18

def api_client
  @api_client
end

Instance Method Details

#get_reserved_domains(organization_id) ⇒ DomainsResponse

Returns the list of reserved domains for the organization. Required scopes: domain_read

Parameters:

  • organization_id —

    The organization ID Guid

Returns:



28
29
30
31
 
# File 'lib/docusign_admin/api/reserved_domains_api.rb', line 28

def get_reserved_domains(organization_id)
  data, _status_code, _headers = get_reserved_domains_with_http_info(organization_id)
  return data
end

#get_reserved_domains_with_http_info(organization_id) ⇒ Array<(DomainsResponse, Fixnum, Hash)>

Returns the list of reserved domains for the organization. Required scopes: domain_read

Parameters:

  • organization_id —

    The organization ID Guid

Returns:

  • (Array<(DomainsResponse, Fixnum, Hash)>) —

    DomainsResponse data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/docusign_admin/api/reserved_domains_api.rb', line 37

def get_reserved_domains_with_http_info(organization_id)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ReservedDomainsApi.get_reserved_domains ..."
  end
  # verify the required parameter 'organization_id' is set
  fail ArgumentError, "Missing the required parameter 'organization_id' when calling ReservedDomainsApi.get_reserved_domains" if organization_id.nil?
  # resource path
  local_var_path = "/v2/organizations/{organizationId}/reserved_domains".sub('{format}','json').sub('{' + 'organizationId' + '}', organization_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DomainsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ReservedDomainsApi#get_reserved_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end