Class: PaymentApplicationsClient
- Inherits:
-
Object
- Object
- PaymentApplicationsClient
- Defined in:
- lib/lockstep_sdk/clients/payment_applications.rb
Instance Method Summary collapse
-
#create_payment_applications ⇒ Object
Creates one or more Payment Applications within this account and returns the records as created.
-
#delete_payment_application(id:) ⇒ Object
Deletes the Payment Application referred to by this unique identifier.
-
#initialize(lockstepsdk) ⇒ PaymentApplicationsClient
constructor
Initialize the PaymentApplicationsClient class with a lockstepsdk instance.
-
#query_payment_applications(filter:, include_param:, order:, pageSize:, pageNumber:) ⇒ Object
Queries Payment Applications for this account using the specified filtering, sorting, nested fetch, and pagination rules requested.
-
#retrieve_payment_application(id:, include_param:) ⇒ Object
Retrieves the Payment Application specified by this unique identifier, optionally including nested data sets.
-
#update_payment_application(id:) ⇒ Object
Updates an existing Payment Application with the information supplied to this PATCH call.
Constructor Details
#initialize(lockstepsdk) ⇒ PaymentApplicationsClient
Initialize the PaymentApplicationsClient class with a lockstepsdk instance.
22 23 24 |
# File 'lib/lockstep_sdk/clients/payment_applications.rb', line 22 def initialize(lockstepsdk) @lockstepsdk = lockstepsdk end |
Instance Method Details
#create_payment_applications ⇒ Object
Creates one or more Payment Applications within this account and returns the records as created.
A Payment Application is created by a business who receives a Payment from a customer. A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices. The Payment Application contains information about which Invoices are connected to which Payments and for which amounts.
67 68 69 70 |
# File 'lib/lockstep_sdk/clients/payment_applications.rb', line 67 def create_payment_applications() path = "/api/v1/PaymentApplications" @lockstepsdk.request(:post, path, body, nil) end |
#delete_payment_application(id:) ⇒ Object
Deletes the Payment Application referred to by this unique identifier.
A Payment Application is created by a business who receives a Payment from a customer. A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices. The Payment Application contains information about which Invoices are connected to which Payments and for which amounts.
56 57 58 59 60 |
# File 'lib/lockstep_sdk/clients/payment_applications.rb', line 56 def delete_payment_application(id:) path = "/api/v1/PaymentApplications/#{id}" params = {} @lockstepsdk.request(:delete, path, nil, params) end |
#query_payment_applications(filter:, include_param:, order:, pageSize:, pageNumber:) ⇒ Object
Queries Payment Applications 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. A Payment Application is created by a business who receives a Payment from a customer. A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices. The Payment Application contains information about which Invoices are connected to which Payments and for which amounts.
81 82 83 84 85 |
# File 'lib/lockstep_sdk/clients/payment_applications.rb', line 81 def query_payment_applications(filter:, include_param:, order:, pageSize:, pageNumber:) path = "/api/v1/PaymentApplications/query" params = {:filter => filter, :include => include_param, :order => order, :pageSize => pageSize, :pageNumber => pageNumber} @lockstepsdk.request(:get, path, nil, params) end |
#retrieve_payment_application(id:, include_param:) ⇒ Object
Retrieves the Payment Application specified by this unique identifier, optionally including nested data sets.
A Payment Application is created by a business who receives a Payment from a customer. A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices. The Payment Application contains information about which Invoices are connected to which Payments and for which amounts.
33 34 35 36 37 |
# File 'lib/lockstep_sdk/clients/payment_applications.rb', line 33 def retrieve_payment_application(id:, include_param:) path = "/api/v1/PaymentApplications/#{id}" params = {:include => include_param} @lockstepsdk.request(:get, path, nil, params) end |
#update_payment_application(id:) ⇒ Object
Updates an existing Payment Application 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 Payment Application is created by a business who receives a Payment from a customer. A customer may make a single Payment to match an Invoice exactly, a partial Payment for an Invoice, or a single Payment may be made for multiple smaller Invoices. The Payment Application contains information about which Invoices are connected to which Payments and for which amounts.
45 46 47 48 49 |
# File 'lib/lockstep_sdk/clients/payment_applications.rb', line 45 def update_payment_application(id:) path = "/api/v1/PaymentApplications/#{id}" params = {} @lockstepsdk.request(:patch, path, body, params) end |