Class: ConnectWise::ProjectTicketNotesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/api/project_ticket_notes_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProjectTicketNotesApi

Returns a new instance of ProjectTicketNotesApi.



17
18
19
 
# File 'lib/connect_wise/api/project_ticket_notes_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/connect_wise/api/project_ticket_notes_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#get_project_tickets_by_parent_id_all_notes(parent_id, client_id, opts = {}) ⇒ Array<ProjectTicketNote>

Get List of ProjectTicketNote

Parameters:

  • parent_id (Integer) —

    ticketId

  • client_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:



34
35
36
37
 
# File 'lib/connect_wise/api/project_ticket_notes_api.rb', line 34

def get_project_tickets_by_parent_id_all_notes(parent_id, client_id, opts = {})
  data, _status_code, _headers = get_project_tickets_by_parent_id_all_notes_with_http_info(parent_id, client_id, opts)
  data
end

#get_project_tickets_by_parent_id_all_notes_with_http_info(parent_id, client_id, opts = {}) ⇒ Array<(Array<ProjectTicketNote>, Integer, Hash)>

Get List of ProjectTicketNote

Parameters:

  • parent_id (Integer) —

    ticketId

  • client_id (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :child_conditions (String)
  • :custom_field_conditions (String)
  • :order_by (String)
  • :fields (String)
  • :page (Integer)
  • :page_size (Integer)
  • :page_id (Integer)

Returns:

  • (Array<(Array<ProjectTicketNote>, Integer, Hash)>) —

    Array<ProjectTicketNote> data, response status code and response headers

Raises:

  • (ArgumentError) 


52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/connect_wise/api/project_ticket_notes_api.rb', line 52

def get_project_tickets_by_parent_id_all_notes_with_http_info(parent_id, client_id, opts = {})
  @api_client.config.logger.debug 'Calling API: ProjectTicketNotesApi.get_project_tickets_by_parent_id_all_notes ...' if @api_client.config.debugging
  # verify the required parameter 'parent_id' is set
  raise ArgumentError, "Missing the required parameter 'parent_id' when calling ProjectTicketNotesApi.get_project_tickets_by_parent_id_all_notes" if @api_client.config.client_side_validation && parent_id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling ProjectTicketNotesApi.get_project_tickets_by_parent_id_all_notes" if @api_client.config.client_side_validation && client_id.nil?

  # resource path
  local_var_path = '/project/tickets/{parentId}/allNotes'.sub('{' + 'parentId' + '}', CGI.escape(parent_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:conditions] = opts[:conditions] unless opts[:conditions].nil?
  query_params[:childConditions] = opts[:child_conditions] unless opts[:child_conditions].nil?
  query_params[:customFieldConditions] = opts[:custom_field_conditions] unless opts[:custom_field_conditions].nil?
  query_params[:orderBy] = opts[:order_by] unless opts[:order_by].nil?
  query_params[:fields] = opts[:fields] unless opts[:fields].nil?
  query_params[:page] = opts[:page] unless opts[:page].nil?
  query_params[:pageSize] = opts[:page_size] unless opts[:page_size].nil?
  query_params[:pageId] = opts[:page_id] unless opts[:page_id].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.connectwise.com+json; version=2022.1'])
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<ProjectTicketNote>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'ProjectTicketNotesApi.get_project_tickets_by_parent_id_all_notes',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  @api_client.config.logger.debug "API called: ProjectTicketNotesApi#get_project_tickets_by_parent_id_all_notes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end

#post_project_ticket_note_by_id_mark_as(id, client_id, project_ticket_note, opts = {}) ⇒ nil

Post ProjectTicketNote

Parameters:

  • id (Integer) —

    ticketNoteId

  • client_id (String)
  • project_ticket_note (ProjectTicketNote) —

    item

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


112
113
114
115
 
# File 'lib/connect_wise/api/project_ticket_notes_api.rb', line 112

def post_project_ticket_note_by_id_mark_as(id, client_id, project_ticket_note, opts = {})
  post_project_ticket_note_by_id_mark_as_with_http_info(id, client_id, project_ticket_note, opts)
  nil
end

#post_project_ticket_note_by_id_mark_as_with_http_info(id, client_id, project_ticket_note, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Post ProjectTicketNote

Parameters:

  • id (Integer) —

    ticketNoteId

  • client_id (String)
  • project_ticket_note (ProjectTicketNote) —

    item

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers

Raises:

  • (ArgumentError) 


123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/connect_wise/api/project_ticket_notes_api.rb', line 123

def post_project_ticket_note_by_id_mark_as_with_http_info(id, client_id, project_ticket_note, opts = {})
  @api_client.config.logger.debug 'Calling API: ProjectTicketNotesApi.post_project_ticket_note_by_id_mark_as ...' if @api_client.config.debugging
  # verify the required parameter 'id' is set
  raise ArgumentError, "Missing the required parameter 'id' when calling ProjectTicketNotesApi.post_project_ticket_note_by_id_mark_as" if @api_client.config.client_side_validation && id.nil?
  # verify the required parameter 'client_id' is set
  raise ArgumentError, "Missing the required parameter 'client_id' when calling ProjectTicketNotesApi.post_project_ticket_note_by_id_mark_as" if @api_client.config.client_side_validation && client_id.nil?
  # verify the required parameter 'project_ticket_note' is set
  raise ArgumentError, "Missing the required parameter 'project_ticket_note' when calling ProjectTicketNotesApi.post_project_ticket_note_by_id_mark_as" if @api_client.config.client_side_validation && project_ticket_note.nil?

  # resource path
  local_var_path = '/project/ticketNote/{id}/markAs/'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  header_params['Content-Type'] = content_type unless content_type.nil?
  header_params[:clientId] = client_id

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(project_ticket_note)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    operation: :'ProjectTicketNotesApi.post_project_ticket_note_by_id_mark_as',
    header_params: header_params,
    query_params: query_params,
    form_params: form_params,
    body: post_body,
    auth_names: auth_names,
    return_type: return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  @api_client.config.logger.debug "API called: ProjectTicketNotesApi#post_project_ticket_note_by_id_mark_as\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" if @api_client.config.debugging
  [data, status_code, headers]
end