Class: DocuSign_Rooms::FieldsApi
- Inherits:
-
Object
- Object
- DocuSign_Rooms::FieldsApi
- Defined in:
- lib/docusign_rooms/api/fields_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get_field_set(field_set_id, account_id, options = DocuSign_Rooms::GetFieldSetOptions.default) ⇒ FieldSet
Get details of a specific field set.
-
#get_field_set_with_http_info(field_set_id, account_id, options = DocuSign_Rooms::GetFieldSetOptions.default) ⇒ Array<(FieldSet, Fixnum, Hash)>
Get details of a specific field set.
-
#initialize(api_client = FieldsApi.default) ⇒ FieldsApi
constructor
A new instance of FieldsApi.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
27 28 29 |
# File 'lib/docusign_rooms/api/fields_api.rb', line 27 def api_client @api_client end |
Instance Method Details
#get_field_set(field_set_id, account_id, options = DocuSign_Rooms::GetFieldSetOptions.default) ⇒ FieldSet
Get details of a specific field set. Get details of a specific field set.
39 40 41 42 |
# File 'lib/docusign_rooms/api/fields_api.rb', line 39 def get_field_set(field_set_id, account_id, = DocuSign_Rooms::GetFieldSetOptions.default) data, _status_code, _headers = get_field_set_with_http_info(field_set_id, account_id, ) return data end |
#get_field_set_with_http_info(field_set_id, account_id, options = DocuSign_Rooms::GetFieldSetOptions.default) ⇒ Array<(FieldSet, Fixnum, Hash)>
Get details of a specific field set. Get details of a specific field set.
50 51 52 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 |
# File 'lib/docusign_rooms/api/fields_api.rb', line 50 def get_field_set_with_http_info(field_set_id, account_id, = DocuSign_Rooms::GetFieldSetOptions.default) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: FieldsApi.get_field_set ..." end # verify the required parameter 'field_set_id' is set fail ArgumentError, "Missing the required parameter 'field_set_id' when calling FieldsApi.get_field_set" if field_set_id.nil? # verify the required parameter 'account_id' is set fail ArgumentError, "Missing the required parameter 'account_id' when calling FieldsApi.get_field_set" if account_id.nil? if .fields_custom_data_filters && !.fields_custom_data_filters.all?{|item| ['None', 'IsRequiredOnCreate', 'IsRequiredOnSubmit'].include?(item)} fail ArgumentError, 'invalid value for "fields_custom_data_filters", must include one of None, IsRequiredOnCreate, IsRequiredOnSubmit' end # resource path local_var_path = "/v2/accounts/{accountId}/field_sets/{fieldSetId}".sub('{format}','json').sub('{' + 'fieldSetId' + '}', field_set_id.to_s).sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} query_params[:'fieldsCustomDataFilters'] = @api_client.build_collection_param(.fields_custom_data_filters, :csv) if !.fields_custom_data_filters.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 => 'FieldSet') if @api_client.config.debugging @api_client.config.logger.debug "API called: FieldsApi#get_field_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |