Class: CustomFieldDefinitionsClient

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

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ CustomFieldDefinitionsClient

Initialize the CustomFieldDefinitionsClient class with an API client instance.

Parameters:

  • connection (LockstepApi) —

    The API client object for this connection



22
23
24
 
# File 'lib/lockstep_sdk/clients/custom_field_definitions_client.rb', line 22

def initialize(connection)
    @connection = connection
end

Instance Method Details

#create_field_definitions(body:) ⇒ Object

Creates one or more Custom Field Definitions 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 (CustomFieldDefinitionModel) —

    The Custom Field Definitions to create



79
80
81
82
 
# File 'lib/lockstep_sdk/clients/custom_field_definitions_client.rb', line 79

def create_field_definitions(body:)
    path = "/api/v1/CustomFieldDefinitions"
    @connection.request(:post, path, body, nil)
end

#delete_field_definition(id:) ⇒ Object

Deletes the Custom Field Definition 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:

  • id (uuid) —

    The unique Lockstep Platform ID number of the Custom Field Definition to delete



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

def delete_field_definition(id:)
    path = "/api/v1/CustomFieldDefinitions/#{id}"
    @connection.request(:delete, path, nil, nil)
end

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

Queries Custom Field Definitions 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:



98
99
100
101
102
 
# File 'lib/lockstep_sdk/clients/custom_field_definitions_client.rb', line 98

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

#retrieve_field_definition(id:, include_param:) ⇒ Object

Retrieves the Custom Field Definition specified 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:

  • id (uuid) —

    The unique Lockstep Platform ID number of this Custom Field Definition

  • include_param (string) —

    To fetch additional data on this object, specify the list of elements to retrieve. No additional data collections are currently defined on this object, but may be supported in the future.



36
37
38
39
40
 
# File 'lib/lockstep_sdk/clients/custom_field_definitions_client.rb', line 36

def retrieve_field_definition(id:, include_param:)
    path = "/api/v1/CustomFieldDefinitions/#{id}"
    params = {:include => include_param}
    @connection.request(:get, path, nil, params)
end

#update_field_definition(id:, body:) ⇒ Object

Updates an existing Custom Field Definition 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:

  • id (uuid) —

    The unique Lockstep Platform ID number of the Custom Field Definition to update

  • body (object) —

    A list of changes to apply to this Custom Field Definition



53
54
55
56
 
# File 'lib/lockstep_sdk/clients/custom_field_definitions_client.rb', line 53

def update_field_definition(id:, body:)
    path = "/api/v1/CustomFieldDefinitions/#{id}"
    @connection.request(:patch, path, body.to_camelback_keys.to_json, nil)
end