Class: NotesClient

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

Instance Method Summary collapse

Constructor Details

#initialize(lockstepsdk) ⇒ NotesClient

Initialize the NotesClient class with a lockstepsdk instance.

Parameters:

  • lockstepsdk (LockstepApi) —

    The Lockstep API client object for this connection



24
25
26
 
# File 'lib/lockstep_sdk/clients/notes.rb', line 24

def initialize(lockstepsdk)
    @lockstepsdk = lockstepsdk
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](developer.lockstep.io/docs/extensibility) for more information.

Parameters:

  • id (uuid) —

    Note id to be archived



46
47
48
49
 
# File 'lib/lockstep_sdk/clients/notes.rb', line 46

def archive_note(id:)
    path = "/api/v1/Notes/#{id}"
    @lockstepsdk.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](developer.lockstep.io/docs/extensibility) for more information.

Parameters:

  • body (NoteModel) —

    The array of notes to be created



58
59
60
61
 
# File 'lib/lockstep_sdk/clients/notes.rb', line 58

def create_notes(body:)
    path = "/api/v1/Notes"
    @lockstepsdk.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](developer.lockstep.io/docs/querying-with-searchlight) 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](developer.lockstep.io/docs/extensibility) for more information.

Parameters:

  • filter (string) —

    The filter to use to select from the list of available applications, in the [Searchlight query syntax](github.com/tspence/csharp-searchlight).

  • 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](github.com/tspence/csharp-searchlight).

  • page_size (int32) —

    The page size for results (default 200, maximum of 10,000)

  • page_number (int32) —

    The page number for results (default 0)



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

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}
    @lockstepsdk.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](developer.lockstep.io/docs/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



35
36
37
38
39
 
# File 'lib/lockstep_sdk/clients/notes.rb', line 35

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