Class: Propertyware::CustomFieldFieldsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/propertyware/api/custom_field_fields_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CustomFieldFieldsApi

Returns a new instance of CustomFieldFieldsApi.



19
20
21
 
# File 'lib/propertyware/api/custom_field_fields_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/propertyware/api/custom_field_fields_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#retrieve_custom_field_definitions(entity_type, opts = {}) ⇒ Array<CustomFieldDefinition>

Retrieve list of custom field definitions. Retrieve list of custom field definitions.<br/><br/>Required permission:<br/><span class="permissionBlock">CUSTOM FIELD</span> - Read

Parameters:

  • entity_type (String) —

    Entity type, allowed entity types (Asset, Building, Contact, Lease, Portfolio, Prospect, Unit, Vendor, WorkOrder, ServiceAgreement)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/propertyware/api/custom_field_fields_api.rb', line 27

def retrieve_custom_field_definitions(entity_type, opts = {})
  data, _status_code, _headers = retrieve_custom_field_definitions_with_http_info(entity_type, opts)
  data
end

#retrieve_custom_field_definitions_with_http_info(entity_type, opts = {}) ⇒ Array<(Array<CustomFieldDefinition>, Integer, Hash)>

Retrieve list of custom field definitions. Retrieve list of custom field definitions.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;&quot;permissionBlock&quot;&gt;CUSTOM FIELD&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;

Parameters:

  • entity_type (String) —

    Entity type, allowed entity types (Asset, Building, Contact, Lease, Portfolio, Prospect, Unit, Vendor, WorkOrder, ServiceAgreement)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Array<CustomFieldDefinition>, Integer, Hash)>) —

    Array<CustomFieldDefinition> 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
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/propertyware/api/custom_field_fields_api.rb', line 37

def retrieve_custom_field_definitions_with_http_info(entity_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomFieldFieldsApi.retrieve_custom_field_definitions ...'
  end
  # verify the required parameter 'entity_type' is set
  if @api_client.config.client_side_validation && entity_type.nil?
    fail ArgumentError, "Missing the required parameter 'entity_type' when calling CustomFieldFieldsApi.retrieve_custom_field_definitions"
  end
  # resource path
  local_var_path = '/customfields/{entityType}/definitions'.sub('{' + 'entityType' + '}', CGI.escape(entity_type.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<CustomFieldDefinition>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']

  new_options = opts.merge(
    :operation => :"CustomFieldFieldsApi.retrieve_custom_field_definitions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomFieldFieldsApi#retrieve_custom_field_definitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end