Class: Hubspot::Crm::Extensions::Cards::CardsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/extensions/cards/api/cards_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CardsApi

Returns a new instance of CardsApi.



22
23
24
 
# File 'lib/hubspot/codegen/crm/extensions/cards/api/cards_api.rb', line 22

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/hubspot/codegen/crm/extensions/cards/api/cards_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#archive(card_id, app_id, opts = {}) ⇒ nil

Delete a card Permanently deletes a card definition with the given ID. Once deleted, data fetch requests for this card will no longer be sent to your service. This can’t be undone.

Parameters:

  • card_id (String) —

    The ID of the card to delete.

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:

  • (nil) 


31
32
33
34
 
# File 'lib/hubspot/codegen/crm/extensions/cards/api/cards_api.rb', line 31

def archive(card_id, app_id, opts = {})
  archive_with_http_info(card_id, app_id, opts)
  nil
end

#archive_with_http_info(card_id, app_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a card Permanently deletes a card definition with the given ID. Once deleted, data fetch requests for this card will no longer be sent to your service. This can&#39;t be undone.

Parameters:

  • card_id (String) —

    The ID of the card to delete.

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



42
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
 
# File 'lib/hubspot/codegen/crm/extensions/cards/api/cards_api.rb', line 42

def archive_with_http_info(card_id, app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.archive ...'
  end
  # verify the required parameter 'card_id' is set
  if @api_client.config.client_side_validation && card_id.nil?
    fail ArgumentError, "Missing the required parameter 'card_id' when calling CardsApi.archive"
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling CardsApi.archive"
  end
  # resource path
  local_var_path = '/crm/v3/extensions/cards-dev/{appId}/{cardId}'.sub('{' + 'cardId' + '}', CGI.escape(card_id.to_s)).sub('{' + 'appId' + '}', CGI.escape(app_id.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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"CardsApi.archive",
    :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: CardsApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create(app_id, card_create_request, opts = {}) ⇒ PublicCardResponse

Create a new card Defines a new card that will become active on an account when this app is installed.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

  • card_create_request (CardCreateRequest) —

    The new card definition.

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

    the optional parameters

Returns:



100
101
102
103
 
# File 'lib/hubspot/codegen/crm/extensions/cards/api/cards_api.rb', line 100

def create(app_id, card_create_request, opts = {})
  data, _status_code, _headers = create_with_http_info(app_id, card_create_request, opts)
  data
end

#create_with_http_info(app_id, card_create_request, opts = {}) ⇒ Array<(PublicCardResponse, Integer, Hash)>

Create a new card Defines a new card that will become active on an account when this app is installed.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

  • card_create_request (CardCreateRequest) —

    The new card definition.

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

    the optional parameters

Returns:

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

    PublicCardResponse data, response status code and response headers



111
112
113
114
115
116
117
118
119
120
121
122
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
 
# File 'lib/hubspot/codegen/crm/extensions/cards/api/cards_api.rb', line 111

def create_with_http_info(app_id, card_create_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.create ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling CardsApi.create"
  end
  # verify the required parameter 'card_create_request' is set
  if @api_client.config.client_side_validation && card_create_request.nil?
    fail ArgumentError, "Missing the required parameter 'card_create_request' when calling CardsApi.create"
  end
  # resource path
  local_var_path = '/crm/v3/extensions/cards-dev/{appId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.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(['application/json', '*/*'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'PublicCardResponse'

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

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

#get_all(app_id, opts = {}) ⇒ PublicCardListResponse

Get all cards Returns a list of cards for a given app.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:



173
174
175
176
 
# File 'lib/hubspot/codegen/crm/extensions/cards/api/cards_api.rb', line 173

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

#get_all_with_http_info(app_id, opts = {}) ⇒ Array<(PublicCardListResponse, Integer, Hash)>

Get all cards Returns a list of cards for a given app.

Parameters:

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:

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

    PublicCardListResponse data, response status code and response headers



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
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
 
# File 'lib/hubspot/codegen/crm/extensions/cards/api/cards_api.rb', line 183

def get_all_with_http_info(app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.get_all ...'
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling CardsApi.get_all"
  end
  # resource path
  local_var_path = '/crm/v3/extensions/cards-dev/{appId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.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(['application/json', '*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'PublicCardListResponse'

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

  new_options = opts.merge(
    :operation => :"CardsApi.get_all",
    :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: CardsApi#get_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_by_id(card_id, app_id, opts = {}) ⇒ PublicCardResponse

Get a card. Returns the definition for a card with the given ID.

Parameters:

  • card_id (String) —

    The ID of the target card.

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:



237
238
239
240
 
# File 'lib/hubspot/codegen/crm/extensions/cards/api/cards_api.rb', line 237

def get_by_id(card_id, app_id, opts = {})
  data, _status_code, _headers = get_by_id_with_http_info(card_id, app_id, opts)
  data
end

#get_by_id_with_http_info(card_id, app_id, opts = {}) ⇒ Array<(PublicCardResponse, Integer, Hash)>

Get a card. Returns the definition for a card with the given ID.

Parameters:

  • card_id (String) —

    The ID of the target card.

  • app_id (Integer) —

    The ID of the target app.

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

    the optional parameters

Returns:

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

    PublicCardResponse data, response status code and response headers



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/hubspot/codegen/crm/extensions/cards/api/cards_api.rb', line 248

def get_by_id_with_http_info(card_id, app_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.get_by_id ...'
  end
  # verify the required parameter 'card_id' is set
  if @api_client.config.client_side_validation && card_id.nil?
    fail ArgumentError, "Missing the required parameter 'card_id' when calling CardsApi.get_by_id"
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling CardsApi.get_by_id"
  end
  # resource path
  local_var_path = '/crm/v3/extensions/cards-dev/{appId}/{cardId}'.sub('{' + 'cardId' + '}', CGI.escape(card_id.to_s)).sub('{' + 'appId' + '}', CGI.escape(app_id.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(['application/json', '*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'PublicCardResponse'

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

  new_options = opts.merge(
    :operation => :"CardsApi.get_by_id",
    :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: CardsApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(card_id, app_id, card_patch_request, opts = {}) ⇒ PublicCardResponse

Update a card Update a card definition with new details.

Parameters:

  • card_id (String) —

    The ID of the card to update.

  • app_id (Integer) —

    The ID of the target app.

  • card_patch_request (CardPatchRequest) —

    Card definition fields to be updated.

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

    the optional parameters

Returns:



307
308
309
310
 
# File 'lib/hubspot/codegen/crm/extensions/cards/api/cards_api.rb', line 307

def update(card_id, app_id, card_patch_request, opts = {})
  data, _status_code, _headers = update_with_http_info(card_id, app_id, card_patch_request, opts)
  data
end

#update_with_http_info(card_id, app_id, card_patch_request, opts = {}) ⇒ Array<(PublicCardResponse, Integer, Hash)>

Update a card Update a card definition with new details.

Parameters:

  • card_id (String) —

    The ID of the card to update.

  • app_id (Integer) —

    The ID of the target app.

  • card_patch_request (CardPatchRequest) —

    Card definition fields to be updated.

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

    the optional parameters

Returns:

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

    PublicCardResponse data, response status code and response headers



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/hubspot/codegen/crm/extensions/cards/api/cards_api.rb', line 319

def update_with_http_info(card_id, app_id, card_patch_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardsApi.update ...'
  end
  # verify the required parameter 'card_id' is set
  if @api_client.config.client_side_validation && card_id.nil?
    fail ArgumentError, "Missing the required parameter 'card_id' when calling CardsApi.update"
  end
  # verify the required parameter 'app_id' is set
  if @api_client.config.client_side_validation && app_id.nil?
    fail ArgumentError, "Missing the required parameter 'app_id' when calling CardsApi.update"
  end
  # verify the required parameter 'card_patch_request' is set
  if @api_client.config.client_side_validation && card_patch_request.nil?
    fail ArgumentError, "Missing the required parameter 'card_patch_request' when calling CardsApi.update"
  end
  # resource path
  local_var_path = '/crm/v3/extensions/cards-dev/{appId}/{cardId}'.sub('{' + 'cardId' + '}', CGI.escape(card_id.to_s)).sub('{' + 'appId' + '}', CGI.escape(app_id.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(['application/json', '*/*'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'PublicCardResponse'

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

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