Class: DocuSign_Rooms::FormLibrariesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = FormLibrariesApi.default) ⇒ FormLibrariesApi

Returns a new instance of FormLibrariesApi.



44
45
46
 
# File 'lib/docusign_rooms/api/form_libraries_api.rb', line 44

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#get_form_libraries(account_id, options = DocuSign_Rooms::GetFormLibrariesOptions.default) ⇒ FormLibrarySummaryList

Gets a paged list of forms libraries. Returns a list of form libraries to which the current user has access.

Parameters:

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetFormLibrariesOptions —

    Options for modifying the behavior of the function.

Returns:



53
54
55
56
 
# File 'lib/docusign_rooms/api/form_libraries_api.rb', line 53

def get_form_libraries(, options = DocuSign_Rooms::GetFormLibrariesOptions.default)
  data, _status_code, _headers = get_form_libraries_with_http_info(, options)
  return data
end

#get_form_libraries_with_http_info(account_id, options = DocuSign_Rooms::GetFormLibrariesOptions.default) ⇒ Array<(FormLibrarySummaryList, Fixnum, Hash)>

Gets a paged list of forms libraries. Returns a list of form libraries to which the current user has access.

Parameters:

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetFormLibrariesOptions —

    Options for modifying the behavior of the function.

Returns:

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

    FormLibrarySummaryList data, response status code and response headers



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
94
95
96
97
98
99
100
101
 
# File 'lib/docusign_rooms/api/form_libraries_api.rb', line 63

def get_form_libraries_with_http_info(, options = DocuSign_Rooms::GetFormLibrariesOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormLibrariesApi.get_form_libraries ..."
  end
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormLibrariesApi.get_form_libraries" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_libraries".sub('{format}','json').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 => 'FormLibrarySummaryList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormLibrariesApi#get_form_libraries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_form_library_forms(form_library_id, account_id, options = DocuSign_Rooms::GetFormLibraryFormsOptions.default) ⇒ FormSummaryList

Gets a paged list of forms in a forms library. Returns a list of forms to which the current user has access in the specified form library.

Parameters:

  • form_library_id —

    Library Id

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetFormLibraryFormsOptions —

    Options for modifying the behavior of the function.

Returns:



109
110
111
112
 
# File 'lib/docusign_rooms/api/form_libraries_api.rb', line 109

def get_form_library_forms(form_library_id, , options = DocuSign_Rooms::GetFormLibraryFormsOptions.default)
  data, _status_code, _headers = get_form_library_forms_with_http_info(form_library_id, , options)
  return data
end

#get_form_library_forms_with_http_info(form_library_id, account_id, options = DocuSign_Rooms::GetFormLibraryFormsOptions.default) ⇒ Array<(FormSummaryList, Fixnum, Hash)>

Gets a paged list of forms in a forms library. Returns a list of forms to which the current user has access in the specified form library.

Parameters:

  • form_library_id —

    Library Id

  • account_id (Required) —

    The globally unique identifier (GUID) for the account.

  • DocuSign_Rooms::GetFormLibraryFormsOptions —

    Options for modifying the behavior of the function.

Returns:

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

    FormSummaryList data, response status code and response headers



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/docusign_rooms/api/form_libraries_api.rb', line 120

def get_form_library_forms_with_http_info(form_library_id, , options = DocuSign_Rooms::GetFormLibraryFormsOptions.default)
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: FormLibrariesApi.get_form_library_forms ..."
  end
  # verify the required parameter 'form_library_id' is set
  fail ArgumentError, "Missing the required parameter 'form_library_id' when calling FormLibrariesApi.get_form_library_forms" if form_library_id.nil?
  # verify the required parameter 'account_id' is set
  fail ArgumentError, "Missing the required parameter 'account_id' when calling FormLibrariesApi.get_form_library_forms" if .nil?
  # resource path
  local_var_path = "/v2/accounts/{accountId}/form_libraries/{formLibraryId}/forms".sub('{format}','json').sub('{' + 'formLibraryId' + '}', form_library_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 => 'FormSummaryList')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FormLibrariesApi#get_form_library_forms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end