Class: NotesClient

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

Instance Method Summary collapse

Constructor Details

#initialize(connection) ⇒ NotesClient

Initialize the NotesClient class with an API client instance.

Parameters:

  • connection (LockstepApi) —

    The API client object for this connection



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

def initialize(connection)
    @connection = connection
end

Instance Method Details

#archive_note(id:) ⇒ Object

Archives the Note with the unique ID specified.

A note is a customizable text string that can be attached to various account attributes within Lockstep. You can use notes for internal communication, correspondence with clients, or personal reminders. The Note Model represents a note and a number of different metadata attributes related to the creation, storage, and ownership of the note.

See Extensibility for more information.

Parameters:

  • id (uuid) —

    Note id to be archived



50
51
52
53
 
# File 'lib/lockstep_sdk/clients/notes_client.rb', line 50

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

#create_notes(body:) ⇒ Object

Creates one or more notes from the specified array of Note Models

A note is a customizable text string that can be attached to various account attributes within Lockstep. You can use notes for internal communication, correspondence with clients, or personal reminders. The Note Model represents a note and a number of different metadata attributes related to the creation, storage, and ownership of the note.

See Extensibility for more information.

Parameters:

  • body (NoteModel) —

    The array of notes to be created



63
64
65
66
 
# File 'lib/lockstep_sdk/clients/notes_client.rb', line 63

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

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

Queries Notes on 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 page on the Lockstep Developer website.

A note is a customizable text string that can be attached to various account attributes within Lockstep. You can use notes for internal communication, correspondence with clients, or personal reminders. The Note Model represents a note and a number of different metadata attributes related to the creation, storage, and ownership of the note.

See Extensibility for more information.

Parameters:

  • filter (string) —

    The filter to use to select from the list of available applications, in the Searchlight query syntax.

  • include_param (string) —

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

  • order (string) —

    The sort order for the results, in the Searchlight order syntax.

  • page_size (int32) —

    The page size for results (default 250, maximum of 500)

  • page_number (int32) —

    The page number for results (default 0)



82
83
84
85
86
 
# File 'lib/lockstep_sdk/clients/notes_client.rb', line 82

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

#retrieve_note(id:, include_param:) ⇒ Object

Retrieves the note with the specified note identifier.

A note is a customizable text string that can be attached to various account attributes within Lockstep. You can use notes for internal communication, correspondence with clients, or personal reminders. The Note Model represents a note and a number of different metadata attributes related to the creation, storage, and ownership of the note.

See Extensibility for more information.

Parameters:

  • id (uuid) —

    The unique ID number of the Note to retrieve

  • include_param (string) —

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



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

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