Class: Hubspot::Crm::Tickets::AssociationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/tickets/api/associations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AssociationsApi

Returns a new instance of AssociationsApi.



21
22
23
 
# File 'lib/hubspot/codegen/crm/tickets/api/associations_api.rb', line 21

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



19
20
21
 
# File 'lib/hubspot/codegen/crm/tickets/api/associations_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#archive(ticket_id, to_object_type, to_object_id, association_type, opts = {}) ⇒ nil

Remove an association between two tickets

Parameters:

  • ticket_id (String)
  • to_object_type (String)
  • to_object_id (String)
  • association_type (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


31
32
33
34
 
# File 'lib/hubspot/codegen/crm/tickets/api/associations_api.rb', line 31

def archive(ticket_id, to_object_type, to_object_id, association_type, opts = {})
  archive_with_http_info(ticket_id, to_object_type, to_object_id, association_type, opts)
  nil
end

#archive_with_http_info(ticket_id, to_object_type, to_object_id, association_type, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove an association between two tickets

Parameters:

  • ticket_id (String)
  • to_object_type (String)
  • to_object_id (String)
  • association_type (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    nil, response status code and response headers



43
44
45
46
47
48
49
50
51
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
 
# File 'lib/hubspot/codegen/crm/tickets/api/associations_api.rb', line 43

def archive_with_http_info(ticket_id, to_object_type, to_object_id, association_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationsApi.archive ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling AssociationsApi.archive"
  end
  # verify the required parameter 'to_object_type' is set
  if @api_client.config.client_side_validation && to_object_type.nil?
    fail ArgumentError, "Missing the required parameter 'to_object_type' when calling AssociationsApi.archive"
  end
  # verify the required parameter 'to_object_id' is set
  if @api_client.config.client_side_validation && to_object_id.nil?
    fail ArgumentError, "Missing the required parameter 'to_object_id' when calling AssociationsApi.archive"
  end
  # verify the required parameter 'association_type' is set
  if @api_client.config.client_side_validation && association_type.nil?
    fail ArgumentError, "Missing the required parameter 'association_type' when calling AssociationsApi.archive"
  end
  # resource path
  local_var_path = '/crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}/{toObjectId}/{associationType}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s)).sub('{' + 'associationType' + '}', CGI.escape(association_type.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])

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

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

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  new_options = opts.merge(
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AssociationsApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create(ticket_id, to_object_type, to_object_id, association_type, opts = {}) ⇒ SimplePublicObject

Associate a ticket with another object

Parameters:

  • ticket_id (String)
  • to_object_type (String)
  • to_object_id (String)
  • association_type (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :paginate_associations (Boolean) — default: default to false

Returns:



110
111
112
113
 
# File 'lib/hubspot/codegen/crm/tickets/api/associations_api.rb', line 110

def create(ticket_id, to_object_type, to_object_id, association_type, opts = {})
  data, _status_code, _headers = create_with_http_info(ticket_id, to_object_type, to_object_id, association_type, opts)
  data
end

#create_with_http_info(ticket_id, to_object_type, to_object_id, association_type, opts = {}) ⇒ Array<(SimplePublicObject, Integer, Hash)>

Associate a ticket with another object

Parameters:

  • ticket_id (String)
  • to_object_type (String)
  • to_object_id (String)
  • association_type (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :paginate_associations (Boolean)

Returns:

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

    SimplePublicObject data, response status code and response headers



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
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/hubspot/codegen/crm/tickets/api/associations_api.rb', line 123

def create_with_http_info(ticket_id, to_object_type, to_object_id, association_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationsApi.create ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling AssociationsApi.create"
  end
  # verify the required parameter 'to_object_type' is set
  if @api_client.config.client_side_validation && to_object_type.nil?
    fail ArgumentError, "Missing the required parameter 'to_object_type' when calling AssociationsApi.create"
  end
  # verify the required parameter 'to_object_id' is set
  if @api_client.config.client_side_validation && to_object_id.nil?
    fail ArgumentError, "Missing the required parameter 'to_object_id' when calling AssociationsApi.create"
  end
  # verify the required parameter 'association_type' is set
  if @api_client.config.client_side_validation && association_type.nil?
    fail ArgumentError, "Missing the required parameter 'association_type' when calling AssociationsApi.create"
  end
  # resource path
  local_var_path = '/crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}/{toObjectId}/{associationType}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s)).sub('{' + 'associationType' + '}', CGI.escape(association_type.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'paginateAssociations'] = opts[:'paginate_associations'] if !opts[:'paginate_associations'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])

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

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

  # return_type
  return_type = opts[:return_type] || 'SimplePublicObject' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  new_options = opts.merge(
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AssociationsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all(ticket_id, to_object_type, opts = {}) ⇒ CollectionResponseAssociatedId

List associations of a ticket by type

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :paginate_associations (Boolean) — default: default to false
  • :after (String) —

    The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.

  • :limit (Integer) —

    The maximum number of results to display per page. (default to 500)

Returns:



191
192
193
194
 
# File 'lib/hubspot/codegen/crm/tickets/api/associations_api.rb', line 191

def get_all(ticket_id, to_object_type, opts = {})
  data, _status_code, _headers = get_all_with_http_info(ticket_id, to_object_type, opts)
  data
end

#get_all_with_http_info(ticket_id, to_object_type, opts = {}) ⇒ Array<(CollectionResponseAssociatedId, Integer, Hash)>

List associations of a ticket by type

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :paginate_associations (Boolean)
  • :after (String) —

    The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.

  • :limit (Integer) —

    The maximum number of results to display per page.

Returns:



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/hubspot/codegen/crm/tickets/api/associations_api.rb', line 204

def get_all_with_http_info(ticket_id, to_object_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AssociationsApi.get_all ...'
  end
  # verify the required parameter 'ticket_id' is set
  if @api_client.config.client_side_validation && ticket_id.nil?
    fail ArgumentError, "Missing the required parameter 'ticket_id' when calling AssociationsApi.get_all"
  end
  # verify the required parameter 'to_object_type' is set
  if @api_client.config.client_side_validation && to_object_type.nil?
    fail ArgumentError, "Missing the required parameter 'to_object_type' when calling AssociationsApi.get_all"
  end
  # resource path
  local_var_path = '/crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}'.sub('{' + 'ticketId' + '}', CGI.escape(ticket_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'paginateAssociations'] = opts[:'paginate_associations'] if !opts[:'paginate_associations'].nil?
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*'])

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

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

  # return_type
  return_type = opts[:return_type] || 'CollectionResponseAssociatedId' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  new_options = opts.merge(
    :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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AssociationsApi#get_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end