Class: DocuSign_Rooms::FormProviderAssociationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_rooms/api/form_provider_associations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = FormProviderAssociationsApi.default) ⇒ FormProviderAssociationsApi

Returns a new instance of FormProviderAssociationsApi.



32
33
34
 
# File 'lib/docusign_rooms/api/form_provider_associations_api.rb', line 32

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



30
31
32
 
# File 'lib/docusign_rooms/api/form_provider_associations_api.rb', line 30

def api_client
  @api_client
end

Instance Method Details

#get_form_provider_associations(provider_id, account_id, options = DocuSign_Rooms::GetFormProviderAssociationsOptions.default) ⇒ FormProviderAssociationsSummaryList

Retrieves all Associations by provider Retrieves all Associations for given provider

Parameters:

  • provider_id —

    provider id like nar, nwmls etc..

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetFormProviderAssociationsOptions —

    Options for modifying the behavior of the function.

Returns:



42
43
44
45
 
# File 'lib/docusign_rooms/api/form_provider_associations_api.rb', line 42

def get_form_provider_associations(provider_id, , options = DocuSign_Rooms::GetFormProviderAssociationsOptions.default)
  data, _status_code, _headers = get_form_provider_associations_with_http_info(provider_id, , options)
  return data
end

#get_form_provider_associations_with_http_info(provider_id, account_id, options = DocuSign_Rooms::GetFormProviderAssociationsOptions.default) ⇒ Array<(FormProviderAssociationsSummaryList, Fixnum, Hash)>

Retrieves all Associations by provider Retrieves all Associations for given provider

Parameters:

  • provider_id —

    provider id like nar, nwmls etc..

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetFormProviderAssociationsOptions —

    Options for modifying the behavior of the function.

Returns:



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/docusign_rooms/api/form_provider_associations_api.rb', line 53

def get_form_provider_associations_with_http_info(provider_id, , options = DocuSign_Rooms::GetFormProviderAssociationsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormProviderAssociationsApi.get_form_provider_associations ..."
  end
  # verify the required parameter 'provider_id' is set
  fail ArgumentError, "Missing the required parameter 'provider_id' when calling FormProviderAssociationsApi.get_form_provider_associations" if provider_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormProviderAssociationsApi.get_form_provider_associations" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_providers/{providerId}/associations".sub('{format}','json').sub('{' + 'providerId' + '}', provider_id.to_s).sub('{' + 'accountId' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'count'] = options.count if !options.count.nil?
  query_params[:'startPosition'] = options.start_position if !options.start_position.nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json', 'application/xml', 'text/xml'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json-patch+json', 'application/json', 'text/json', '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 => 'FormProviderAssociationsSummaryList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormProviderAssociationsApi#get_form_provider_associations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end