Class: CustomFieldValuesClient

Inherits:
Object
  • Object
show all
Defined in:
lib/lockstep_sdk/clients/custom_field_values_client.rb

Instance Method Summary collapse

Constructor Details

#initialize(lockstepsdk) ⇒ CustomFieldValuesClient

Initialize the CustomFieldValuesClient class with a lockstepsdk instance.

Parameters:

  • lockstepsdk (LockstepApi) —

    The Lockstep API client object for this connection



25
26
27
 
# File 'lib/lockstep_sdk/clients/custom_field_values_client.rb', line 25

def initialize(lockstepsdk)
    @lockstepsdk = lockstepsdk
end

Instance Method Details

#create_fields(body:) ⇒ Object

Creates one or more Custom Fields and returns the records as created. A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information. See [Extensibility](developer.lockstep.io/docs/extensibility) for more information.

Parameters:

  • body (CustomFieldValueModel) —

    The Custom Fields to create



75
76
77
78
 
# File 'lib/lockstep_sdk/clients/custom_field_values_client.rb', line 75

def create_fields(body:)
    path = "/api/v1/CustomFieldValues"
    @lockstepsdk.request(:post, path, body, nil)
end

#delete_field(definition_id:, record_key:) ⇒ Object

Deletes the Custom Field referred to by this unique identifier.

A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information. See [Extensibility](developer.lockstep.io/docs/extensibility) for more information.

Parameters:

  • definition_id (uuid) —

    The unique Lockstep Platform ID number of the Custom Field Definition for the Custom Field Value to retrieve.

  • record_key (uuid) —

    The unique Lockstep Platform ID number of the Lockstep Platform object the Custom Field Value is attached to.



66
67
68
69
 
# File 'lib/lockstep_sdk/clients/custom_field_values_client.rb', line 66

def delete_field(definition_id:, record_key:)
    path = "/api/v1/CustomFieldValues/#{definitionId}/#{recordKey}"
    @lockstepsdk.request(:delete, path, nil, nil)
end

#query_fields(filter:, include_param:, order:, page_size:, page_number:) ⇒ Object

Queries Custom Fields within the Lockstep platform using the specified filtering, sorting, nested fetch, and pagination rules requested.

More information on querying can be found on the [Searchlight Query Language](developer.lockstep.io/docs/querying-with-searchlight) page on the Lockstep Developer website.

A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information. See [Extensibility](developer.lockstep.io/docs/extensibility) for more information.

Parameters:



92
93
94
95
96
 
# File 'lib/lockstep_sdk/clients/custom_field_values_client.rb', line 92

def query_fields(filter:, include_param:, order:, page_size:, page_number:)
    path = "/api/v1/CustomFieldValues/query"
    params = {:filter => filter, :include => include_param, :order => order, :pageSize => page_size, :pageNumber => page_number}
    @lockstepsdk.request(:get, path, nil, params)
end

#retrieve_field(definition_id:, record_key:, include_param:) ⇒ Object

Retrieves all Custom Field Definitions.

A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information. See [Extensibility](developer.lockstep.io/docs/extensibility) for more information.

Parameters:

  • definition_id (uuid) —

    The unique Lockstep Platform ID number of the Custom Field Definition for the Custom Field Value to retrieve.

  • record_key (uuid) —

    The unique Lockstep Platform ID number of the Lockstep Platform object the Custom Field Value is attached to.

  • include_param (string) —

    To fetch additional data on this object, specify the list of elements to retrieve. Available collections: CustomFieldDefinition



38
39
40
41
42
 
# File 'lib/lockstep_sdk/clients/custom_field_values_client.rb', line 38

def retrieve_field(definition_id:, record_key:, include_param:)
    path = "/api/v1/CustomFieldValues/#{definitionId}/#{recordKey}"
    params = {:include => include_param}
    @lockstepsdk.request(:get, path, nil, params)
end

#update_field(definition_id:, record_key:, body:) ⇒ Object

Updates an existing Custom Field with the information supplied to this PATCH call.

The PATCH method allows you to change specific values on the object while leaving other values alone. As input you should supply a list of field names and new values. If you do not provide the name of a field, that field will remain unchanged. This allows you to ensure that you are only updating the specific fields desired.

A Custom Field represents metadata added to an object within the Lockstep Platform. Lockstep provides a core definition for each object. The core definition is intended to represent a level of compatibility that provides support across most accounting systems and products. When a user or developer requires information beyond this core definition, you can use Custom Fields to represent this information. See [Extensibility](developer.lockstep.io/docs/extensibility) for more information.

Parameters:

  • definition_id (uuid) —

    The unique Lockstep Platform ID number of the Custom Field Definition for the Custom Field Value to retrieve.

  • record_key (uuid) —

    The unique Lockstep Platform ID number of the Lockstep Platform object the Custom Field Value is attached to.

  • body (object) —

    A list of changes to apply to this Custom Field



54
55
56
57
 
# File 'lib/lockstep_sdk/clients/custom_field_values_client.rb', line 54

def update_field(definition_id:, record_key:, body:)
    path = "/api/v1/CustomFieldValues/#{definitionId}/#{recordKey}"
    @lockstepsdk.request(:patch, path, body.to_camelback_keys.to_json, nil)
end