Class: HighLevel::Resources::Proposals

Inherits:
Base
  • Object
show all
Defined in:
lib/high_level/resources/proposals.rb

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from HighLevel::Resources::Base

Instance Method Details

#list_documents_contracts(location_id: nil, status: nil, payment_status: nil, limit: nil, skip: nil, query: nil, date_from: nil, date_to: nil, authorization: nil, **_opts) ⇒ Object

List documents

List documents for a location



12
13
14
15
16
17
18
19
20
 
# File 'lib/high_level/resources/proposals.rb', line 12

def list_documents_contracts(location_id: nil, status: nil, payment_status: nil, limit: nil, skip: nil, query: nil, date_from: nil, date_to: nil, authorization: nil, **_opts)
  request(
    method: :get,
    path: "/proposals/document",
    security: %w[Location-Access Agency-Access],
    params: { "locationId" => location_id, "status" => status, "paymentStatus" => payment_status, "limit" => limit, "skip" => skip, "query" => query, "dateFrom" => date_from, "dateTo" => date_to }.compact,
    headers: { "Authorization" => authorization }.compact
  )
end

#list_documents_contracts_templates(location_id: nil, date_from: nil, date_to: nil, type: nil, name: nil, is_public_document: nil, user_id: nil, limit: nil, skip: nil, authorization: nil, **_opts) ⇒ Object

List templates

List document contract templates for a location



38
39
40
41
42
43
44
45
46
 
# File 'lib/high_level/resources/proposals.rb', line 38

def list_documents_contracts_templates(location_id: nil, date_from: nil, date_to: nil, type: nil, name: nil, is_public_document: nil, user_id: nil, limit: nil, skip: nil, authorization: nil, **_opts)
  request(
    method: :get,
    path: "/proposals/templates",
    security: %w[Location-Access Agency-Access],
    params: { "locationId" => location_id, "dateFrom" => date_from, "dateTo" => date_to, "type" => type, "name" => name, "isPublicDocument" => is_public_document, "userId" => user_id, "limit" => limit, "skip" => skip }.compact,
    headers: { "Authorization" => authorization }.compact
  )
end

#send_documents_contracts(body:, authorization: nil, **_opts) ⇒ Object

Send document

Send document to a client



25
26
27
28
29
30
31
32
33
 
# File 'lib/high_level/resources/proposals.rb', line 25

def send_documents_contracts(body:, authorization: nil, **_opts)
  request(
    method: :post,
    path: "/proposals/document/send",
    security: %w[Location-Access Agency-Access],
    headers: { "Authorization" => authorization }.compact,
    body: body
  )
end

#send_documents_contracts_template(body:, authorization: nil, **_opts) ⇒ Object

Send template

Send template to a client



51
52
53
54
55
56
57
58
59
 
# File 'lib/high_level/resources/proposals.rb', line 51

def send_documents_contracts_template(body:, authorization: nil, **_opts)
  request(
    method: :post,
    path: "/proposals/templates/send",
    security: %w[Location-Access Agency-Access],
    headers: { "Authorization" => authorization }.compact,
    body: body
  )
end