Class: AttachmentsClient
- Inherits:
-
Object
- Object
- AttachmentsClient
- Defined in:
- lib/lockstep_sdk/clients/attachments.rb
Instance Method Summary collapse
-
#archive_attachment(id:) ⇒ Object
Flag this attachment as archived, which can distinguish between attachments currently active and attachments not intended for active use.
-
#download_attachment(id:) ⇒ Object
Returns a URI for the Attachment file to be downloaded, based on the ID provided.
-
#initialize(lockstepsdk) ⇒ AttachmentsClient
constructor
Initialize the AttachmentsClient class with a lockstepsdk instance.
-
#query_attachments(filter:, include_param:, order:, pageSize:, pageNumber:) ⇒ Object
Queries Attachments for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
-
#retrieve_attachment(id:, include_param:) ⇒ Object
Retrieves the Attachment with the provided Attachment identifier.
-
#update_attachment(id:) ⇒ Object
Updates an existing Attachment with the information supplied to this PATCH call.
-
#upload_attachment(tableName:, objectId:) ⇒ Object
Uploads and creates one or more Attachments from the provided arguments.
Constructor Details
#initialize(lockstepsdk) ⇒ AttachmentsClient
Initialize the AttachmentsClient class with a lockstepsdk instance.
22 23 24 |
# File 'lib/lockstep_sdk/clients/attachments.rb', line 22 def initialize(lockstepsdk) @lockstepsdk = lockstepsdk end |
Instance Method Details
#archive_attachment(id:) ⇒ Object
Flag this attachment as archived, which can distinguish between attachments currently active and attachments not intended for active use. This is similar to deletion but preserves information about the record's existence.
An Attachment is a file that can be attached to various account attributes within Lockstep. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.
See [Extensibility](developer.lockstep.io/docs/extensibility) for more information.
64 65 66 67 68 |
# File 'lib/lockstep_sdk/clients/attachments.rb', line 64 def (id:) path = "/api/v1/Attachments/#{id}" params = {} @lockstepsdk.request(:delete, path, nil, params) end |
#download_attachment(id:) ⇒ Object
Returns a URI for the Attachment file to be downloaded, based on the ID provided.
An Attachment is a file that can be attached to various account attributes within Lockstep. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.
See [Extensibility](developer.lockstep.io/docs/extensibility) for more information.
77 78 79 80 81 |
# File 'lib/lockstep_sdk/clients/attachments.rb', line 77 def (id:) path = "/api/v1/Attachments/#{id}/download" params = {} @lockstepsdk.request(:get, path, nil, params) end |
#query_attachments(filter:, include_param:, order:, pageSize:, pageNumber:) ⇒ Object
Queries Attachments for this account 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.
An Attachment is a file that can be attached to various account attributes within Lockstep. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.
See [Extensibility](developer.lockstep.io/docs/extensibility) for more information.
110 111 112 113 114 |
# File 'lib/lockstep_sdk/clients/attachments.rb', line 110 def (filter:, include_param:, order:, pageSize:, pageNumber:) path = "/api/v1/Attachments/query" params = {:filter => filter, :include => include_param, :order => order, :pageSize => pageSize, :pageNumber => pageNumber} @lockstepsdk.request(:get, path, nil, params) end |
#retrieve_attachment(id:, include_param:) ⇒ Object
Retrieves the Attachment with the provided Attachment identifier.
An Attachment is a file that can be attached to various account attributes within Lockstep. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.
See [Extensibility](developer.lockstep.io/docs/extensibility) for more information.
35 36 37 38 39 |
# File 'lib/lockstep_sdk/clients/attachments.rb', line 35 def (id:, include_param:) path = "/api/v1/Attachments/#{id}" params = {:include => include_param} @lockstepsdk.request(:get, path, nil, params) end |
#update_attachment(id:) ⇒ Object
Updates an existing Attachment 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.
An Attachment is a file that can be attached to various account attributes within Lockstep. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.
See [Extensibility](developer.lockstep.io/docs/extensibility) for more information.
51 52 53 54 55 |
# File 'lib/lockstep_sdk/clients/attachments.rb', line 51 def (id:) path = "/api/v1/Attachments/#{id}" params = {} @lockstepsdk.request(:patch, path, body, params) end |
#upload_attachment(tableName:, objectId:) ⇒ Object
Uploads and creates one or more Attachments from the provided arguments.
An Attachment is a file that can be attached to various account attributes within Lockstep. Attachments can be used for invoices, bills, or any other external files that you wish to track and have access to. Attachments represents an Attachment and a number of different metadata attributes related to the creation, storage, and ownership of the Attachment.
See [Extensibility](developer.lockstep.io/docs/extensibility) for more information.
91 92 93 94 95 |
# File 'lib/lockstep_sdk/clients/attachments.rb', line 91 def (tableName:, objectId:) path = "/api/v1/Attachments" params = {:tableName => tableName, :objectId => objectId} @lockstepsdk.request(:post, path, nil, params) end |