Class: PinterestSdkClient::UserAccountApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pinterest_sdk/api/user_account_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UserAccountApi

Returns a new instance of UserAccountApi.



19
20
21
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#boards_user_follows_list(opts = {}) ⇒ BoardsList200Response

List following boards Get a list of the boards a user follows. The request returns a board summary object array.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ad_account_id (String) —

    Unique identifier of an ad account.

  • :explicit_following (Boolean) —

    Whether or not to include implicit user follows, which means followees with board follows. When explicit_following is True, it means we only want explicit user follows. (default to false)

  • :bookmark (String) —

    Cursor used to fetch the next page of items

  • :page_size (Integer) —

    Maximum number of items to include in a single page. See documentation on Pagination for more information. (default to 25)

Returns:



30
31
32
33
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 30

def boards_user_follows_list(opts = {})
  data, _status_code, _headers = boards_user_follows_list_with_http_info(opts)
  data
end

#boards_user_follows_list_with_http_info(opts = {}) ⇒ Array<(BoardsList200Response, Integer, Hash)>

List following boards Get a list of the boards a user follows. The request returns a board summary object array.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ad_account_id (String) —

    Unique identifier of an ad account.

  • :explicit_following (Boolean) —

    Whether or not to include implicit user follows, which means followees with board follows. When explicit_following is True, it means we only want explicit user follows. (default to false)

  • :bookmark (String) —

    Cursor used to fetch the next page of items

  • :page_size (Integer) —

    Maximum number of items to include in a single page. See documentation on Pagination for more information. (default to 25)

Returns:

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

    BoardsList200Response data, 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
101
102
103
104
105
106
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 43

def boards_user_follows_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserAccountApi.boards_user_follows_list ...'
  end
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'].to_s.length > 18
    fail ArgumentError, 'invalid value for "opts[:"ad_account_id"]" when calling UserAccountApi.boards_user_follows_list, the character length must be smaller than or equal to 18.'
  end

  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling UserAccountApi.boards_user_follows_list, must conform to the pattern #{pattern}."
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 250
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling UserAccountApi.boards_user_follows_list, must be smaller than or equal to 250.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling UserAccountApi.boards_user_follows_list, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/user_account/following/boards'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ad_account_id'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
  query_params[:'explicit_following'] = opts[:'explicit_following'] if !opts[:'explicit_following'].nil?
  query_params[:'bookmark'] = opts[:'bookmark'] if !opts[:'bookmark'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']

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

#follow_user_update(username, follow_user_create, opts = {}) ⇒ FollowUser

Follow user This endpoint is currently in beta and not available to all apps. Learn more. Use this request, as a signed-in user, to follow another user.

Parameters:

  • username (String) —

    A valid username

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

    the optional parameters

Returns:



114
115
116
117
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 114

def follow_user_update(username, follow_user_create, opts = {})
  data, _status_code, _headers = follow_user_update_with_http_info(username, follow_user_create, opts)
  data
end

#follow_user_update_with_http_info(username, follow_user_create, opts = {}) ⇒ Array<(FollowUser, Integer, Hash)>

Follow user This endpoint is currently in beta and not available to all apps. Learn more. Use this request, as a signed-in user, to follow another user.

Parameters:

  • username (String) —

    A valid username

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

    the optional parameters

Returns:

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

    FollowUser data, response status code and response headers



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
182
183
184
185
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 125

def follow_user_update_with_http_info(username, follow_user_create, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserAccountApi.follow_user_update ...'
  end
  # verify the required parameter 'username' is set
  if @api_client.config.client_side_validation && username.nil?
    fail ArgumentError, "Missing the required parameter 'username' when calling UserAccountApi.follow_user_update"
  end
  pattern = Regexp.new(/(?!^\d+$)^.+$/)
  if @api_client.config.client_side_validation && username !~ pattern
    fail ArgumentError, "invalid value for 'username' when calling UserAccountApi.follow_user_update, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'follow_user_create' is set
  if @api_client.config.client_side_validation && follow_user_create.nil?
    fail ArgumentError, "Missing the required parameter 'follow_user_create' when calling UserAccountApi.follow_user_update"
  end
  # resource path
  local_var_path = '/user_account/following/{username}'.sub('{username}', CGI.escape(username.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']) unless header_params['Accept']
  # 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(follow_user_create)

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

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

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

#followers_list(opts = {}) ⇒ FollowersList200Response

List followers Get a list of your followers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :bookmark (String) —

    Cursor used to fetch the next page of items

  • :page_size (Integer) —

    Maximum number of items to include in a single page. See documentation on Pagination for more information. (default to 25)

Returns:



193
194
195
196
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 193

def followers_list(opts = {})
  data, _status_code, _headers = followers_list_with_http_info(opts)
  data
end

#followers_list_with_http_info(opts = {}) ⇒ Array<(FollowersList200Response, Integer, Hash)>

List followers Get a list of your followers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :bookmark (String) —

    Cursor used to fetch the next page of items

  • :page_size (Integer) —

    Maximum number of items to include in a single page. See documentation on Pagination for more information. (default to 25)

Returns:

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

    FollowersList200Response data, response status code and response headers



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/pinterest_sdk/api/user_account_api.rb', line 204

def followers_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserAccountApi.followers_list ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 250
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling UserAccountApi.followers_list, must be smaller than or equal to 250.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling UserAccountApi.followers_list, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/user_account/followers'

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

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']

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

#linked_business_accounts_get(opts = {}) ⇒ Array<LinkedBusiness>

List linked businesses Get a list of your linked business accounts.

Parameters:

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

    the optional parameters

Returns:



262
263
264
265
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 262

def linked_business_accounts_get(opts = {})
  data, _status_code, _headers = linked_business_accounts_get_with_http_info(opts)
  data
end

#linked_business_accounts_get_with_http_info(opts = {}) ⇒ Array<(Array<LinkedBusiness>, Integer, Hash)>

List linked businesses Get a list of your linked business accounts.

Parameters:

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

    the optional parameters

Returns:

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

    Array data, response status code and response headers



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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 271

def linked_business_accounts_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserAccountApi.linked_business_accounts_get ...'
  end
  # resource path
  local_var_path = '/user_account/businesses'

  # 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']) unless header_params['Accept']

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']

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

#unverify_website_delete(website, opts = {}) ⇒ UserWebsite

Unverify website Unverify a website verified by the signed-in user.

Parameters:

  • website (String) —

    Website with path or domain only

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

    the optional parameters

Returns:



320
321
322
323
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 320

def unverify_website_delete(website, opts = {})
  data, _status_code, _headers = unverify_website_delete_with_http_info(website, opts)
  data
end

#unverify_website_delete_with_http_info(website, opts = {}) ⇒ Array<(UserWebsite, Integer, Hash)>

Unverify website Unverify a website verified by the signed-in user.

Parameters:

  • website (String) —

    Website with path or domain only

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

    the optional parameters

Returns:

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

    UserWebsite data, response status code and response headers



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
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 330

def unverify_website_delete_with_http_info(website, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserAccountApi.unverify_website_delete ...'
  end
  # verify the required parameter 'website' is set
  if @api_client.config.client_side_validation && website.nil?
    fail ArgumentError, "Missing the required parameter 'website' when calling UserAccountApi.unverify_website_delete"
  end
  # resource path
  local_var_path = '/user_account/websites'

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

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

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

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

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

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

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

#user_account_analytics(start_date, end_date, opts = {}) ⇒ Hash<String, AnalyticsMetricsResponse>

Get user account analytics Get analytics for the "operation user_account" - By default, the "operation user_account" is the token user_account. Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account".

Parameters:

  • start_date (Date) —

    Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.

  • end_date (Date) —

    Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.

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

    the optional parameters

Options Hash (opts):

  • :from_claimed_content (String) —

    Filter on Pins that match your claimed domain. (default to 'BOTH')

  • :pin_format (String) —

    Pin formats to get data for, default is all. (default to 'ALL')

  • :app_types (String) —

    Apps or devices to get data for, default is all. (default to 'ALL')

  • :content_type (String) —

    Filter to paid or organic data. Default is all. (default to 'ALL')

  • :source (String) —

    Filter to activity from Pins created and saved by your, or activity created and saved by others from your claimed accounts (default to 'ALL')

  • :metric_types (Array<QuerymetrictypesItems>) —

    Metric types to get data for, default is all.

  • :split_field (String) —

    How to split the data into groups. Not including this param means data won't be split. (default to 'NO_SPLIT')

  • :ad_account_id (String) —

    Unique identifier of an ad account.

Returns:



393
394
395
396
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 393

def (start_date, end_date, opts = {})
  data, _status_code, _headers = (start_date, end_date, opts)
  data
end

#user_account_analytics_top_pins(start_date, end_date, sort_by, opts = {}) ⇒ TopPinsAnalyticsResponse

Get user account top pins analytics Gets analytics data about a user's top pins (limited to the top 50). - By default, the "operation user_account" is the token user_account. Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account".

Parameters:

  • start_date (Date) —

    Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.

  • end_date (Date) —

    Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.

  • sort_by (TopPinsSortBy) —

    Specify sorting order for metrics

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

    the optional parameters

Options Hash (opts):

  • :from_claimed_content (String) —

    Filter on Pins that match your claimed domain. (default to 'BOTH')

  • :pin_format (String) —

    Pin formats to get data for, default is all. (default to 'ALL')

  • :app_types (String) —

    Apps or devices to get data for, default is all. (default to 'ALL')

  • :content_type (String) —

    Filter to paid or organic data. Default is all. (default to 'ALL')

  • :source (String) —

    Filter to activity from Pins created and saved by your, or activity created and saved by others from your claimed accounts (default to 'ALL')

  • :metric_types (Array<QuerymetrictypesItems>) —

    Metric types to get data for, default is all.

  • :num_of_pins (Integer) —

    Number of pins to include, default is 10. Max is 50. (default to 10)

  • :created_in_last_n_days (Float) —

    Get metrics for pins created in the last &quot;n&quot; days.

  • :ad_account_id (String) —

    Unique identifier of an ad account.

Returns:



523
524
525
526
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 523

def (start_date, end_date, sort_by, opts = {})
  data, _status_code, _headers = (start_date, end_date, sort_by, opts)
  data
end

#user_account_analytics_top_pins_with_http_info(start_date, end_date, sort_by, opts = {}) ⇒ Array<(TopPinsAnalyticsResponse, Integer, Hash)>

Get user account top pins analytics Gets analytics data about a user's top pins (limited to the top 50). - By default, the &quot;operation user_account&quot; is the token user_account. Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the &quot;operation user_account&quot;.

Parameters:

  • start_date (Date) —

    Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.

  • end_date (Date) —

    Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.

  • sort_by (TopPinsSortBy) —

    Specify sorting order for metrics

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

    the optional parameters

Options Hash (opts):

  • :from_claimed_content (String) —

    Filter on Pins that match your claimed domain. (default to 'BOTH')

  • :pin_format (String) —

    Pin formats to get data for, default is all. (default to 'ALL')

  • :app_types (String) —

    Apps or devices to get data for, default is all. (default to 'ALL')

  • :content_type (String) —

    Filter to paid or organic data. Default is all. (default to 'ALL')

  • :source (String) —

    Filter to activity from Pins created and saved by your, or activity created and saved by others from your claimed accounts (default to 'ALL')

  • :metric_types (Array<QuerymetrictypesItems>) —

    Metric types to get data for, default is all.

  • :num_of_pins (Integer) —

    Number of pins to include, default is 10. Max is 50. (default to 10)

  • :created_in_last_n_days (Float) —

    Get metrics for pins created in the last &quot;n&quot; days.

  • :ad_account_id (String) —

    Unique identifier of an ad account.

Returns:

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

    TopPinsAnalyticsResponse data, response status code and response headers



544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 544

def (start_date, end_date, sort_by, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserAccountApi.user_account_analytics_top_pins ...'
  end
  # verify the required parameter 'start_date' is set
  if @api_client.config.client_side_validation && start_date.nil?
    fail ArgumentError, "Missing the required parameter 'start_date' when calling UserAccountApi.user_account_analytics_top_pins"
  end
  # verify the required parameter 'end_date' is set
  if @api_client.config.client_side_validation && end_date.nil?
    fail ArgumentError, "Missing the required parameter 'end_date' when calling UserAccountApi.user_account_analytics_top_pins"
  end
  # verify the required parameter 'sort_by' is set
  if @api_client.config.client_side_validation && sort_by.nil?
    fail ArgumentError, "Missing the required parameter 'sort_by' when calling UserAccountApi.user_account_analytics_top_pins"
  end
  allowable_values = ["OTHER", "CLAIMED", "BOTH"]
  if @api_client.config.client_side_validation && opts[:'from_claimed_content'] && !allowable_values.include?(opts[:'from_claimed_content'])
    fail ArgumentError, "invalid value for \"from_claimed_content\", must be one of #{allowable_values}"
  end
  allowable_values = ["ALL", "ORGANIC_IMAGE", "ORGANIC_PRODUCT", "ORGANIC_VIDEO", "ADS_STANDARD", "ADS_PRODUCT", "ADS_VIDEO", "ADS_IDEA"]
  if @api_client.config.client_side_validation && opts[:'pin_format'] && !allowable_values.include?(opts[:'pin_format'])
    fail ArgumentError, "invalid value for \"pin_format\", must be one of #{allowable_values}"
  end
  allowable_values = ["ALL", "MOBILE", "TABLET", "WEB"]
  if @api_client.config.client_side_validation && opts[:'app_types'] && !allowable_values.include?(opts[:'app_types'])
    fail ArgumentError, "invalid value for \"app_types\", must be one of #{allowable_values}"
  end
  allowable_values = ["ALL", "PAID", "ORGANIC"]
  if @api_client.config.client_side_validation && opts[:'content_type'] && !allowable_values.include?(opts[:'content_type'])
    fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}"
  end
  allowable_values = ["ALL", "YOUR_PINS", "OTHER_PINS"]
  if @api_client.config.client_side_validation && opts[:'source'] && !allowable_values.include?(opts[:'source'])
    fail ArgumentError, "invalid value for \"source\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'num_of_pins'].nil? && opts[:'num_of_pins'] > 50
    fail ArgumentError, 'invalid value for "opts[:"num_of_pins"]" when calling UserAccountApi.user_account_analytics_top_pins, must be smaller than or equal to 50.'
  end

  if @api_client.config.client_side_validation && !opts[:'num_of_pins'].nil? && opts[:'num_of_pins'] < 1
    fail ArgumentError, 'invalid value for "opts[:"num_of_pins"]" when calling UserAccountApi.user_account_analytics_top_pins, must be greater than or equal to 1.'
  end

  allowable_values = [30]
  if @api_client.config.client_side_validation && opts[:'created_in_last_n_days'] && !allowable_values.include?(opts[:'created_in_last_n_days'])
    fail ArgumentError, "invalid value for \"created_in_last_n_days\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'].to_s.length > 18
    fail ArgumentError, 'invalid value for "opts[:"ad_account_id"]" when calling UserAccountApi.user_account_analytics_top_pins, the character length must be smaller than or equal to 18.'
  end

  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling UserAccountApi.user_account_analytics_top_pins, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/user_account/analytics/top_pins'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start_date'] = start_date
  query_params[:'end_date'] = end_date
  query_params[:'sort_by'] = sort_by
  query_params[:'from_claimed_content'] = opts[:'from_claimed_content'] if !opts[:'from_claimed_content'].nil?
  query_params[:'pin_format'] = opts[:'pin_format'] if !opts[:'pin_format'].nil?
  query_params[:'app_types'] = opts[:'app_types'] if !opts[:'app_types'].nil?
  query_params[:'content_type'] = opts[:'content_type'] if !opts[:'content_type'].nil?
  query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
  query_params[:'metric_types'] = @api_client.build_collection_param(opts[:'metric_types'], :csv) if !opts[:'metric_types'].nil?
  query_params[:'num_of_pins'] = opts[:'num_of_pins'] if !opts[:'num_of_pins'].nil?
  query_params[:'created_in_last_n_days'] = opts[:'created_in_last_n_days'] if !opts[:'created_in_last_n_days'].nil?
  query_params[:'ad_account_id'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']

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

#user_account_analytics_top_video_pins(start_date, end_date, sort_by, opts = {}) ⇒ TopVideoPinsAnalyticsResponse

Get user account top video pins analytics Gets analytics data about a user's top video pins (limited to the top 50). - By default, the "operation user_account" is the token user_account. Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account".

Parameters:

  • start_date (Date) —

    Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.

  • end_date (Date) —

    Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.

  • sort_by (TopVideoPinsSortBy) —

    Specify sorting order for video metrics

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

    the optional parameters

Options Hash (opts):

  • :from_claimed_content (String) —

    Filter on Pins that match your claimed domain. (default to 'BOTH')

  • :pin_format (String) —

    Pin formats to get data for, default is all. (default to 'ALL')

  • :app_types (String) —

    Apps or devices to get data for, default is all. (default to 'ALL')

  • :content_type (String) —

    Filter to paid or organic data. Default is all. (default to 'ALL')

  • :source (String) —

    Filter to activity from Pins created and saved by your, or activity created and saved by others from your claimed accounts (default to 'ALL')

  • :metric_types (Array<QueryvideopinmetrictypesItems>) —

    Metric types to get video data for, default is all.

  • :num_of_pins (Integer) —

    Number of pins to include, default is 10. Max is 50. (default to 10)

  • :created_in_last_n_days (Float) —

    Get metrics for pins created in the last &quot;n&quot; days.

  • :ad_account_id (String) —

    Unique identifier of an ad account.

Returns:



669
670
671
672
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 669

def (start_date, end_date, sort_by, opts = {})
  data, _status_code, _headers = (start_date, end_date, sort_by, opts)
  data
end

#user_account_analytics_top_video_pins_with_http_info(start_date, end_date, sort_by, opts = {}) ⇒ Array<(TopVideoPinsAnalyticsResponse, Integer, Hash)>

Get user account top video pins analytics Gets analytics data about a user's top video pins (limited to the top 50). - By default, the &quot;operation user_account&quot; is the token user_account. Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the &quot;operation user_account&quot;.

Parameters:

  • start_date (Date) —

    Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.

  • end_date (Date) —

    Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.

  • sort_by (TopVideoPinsSortBy) —

    Specify sorting order for video metrics

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

    the optional parameters

Options Hash (opts):

  • :from_claimed_content (String) —

    Filter on Pins that match your claimed domain. (default to 'BOTH')

  • :pin_format (String) —

    Pin formats to get data for, default is all. (default to 'ALL')

  • :app_types (String) —

    Apps or devices to get data for, default is all. (default to 'ALL')

  • :content_type (String) —

    Filter to paid or organic data. Default is all. (default to 'ALL')

  • :source (String) —

    Filter to activity from Pins created and saved by your, or activity created and saved by others from your claimed accounts (default to 'ALL')

  • :metric_types (Array<QueryvideopinmetrictypesItems>) —

    Metric types to get video data for, default is all.

  • :num_of_pins (Integer) —

    Number of pins to include, default is 10. Max is 50. (default to 10)

  • :created_in_last_n_days (Float) —

    Get metrics for pins created in the last &quot;n&quot; days.

  • :ad_account_id (String) —

    Unique identifier of an ad account.

Returns:



690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 690

def (start_date, end_date, sort_by, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserAccountApi.user_account_analytics_top_video_pins ...'
  end
  # verify the required parameter 'start_date' is set
  if @api_client.config.client_side_validation && start_date.nil?
    fail ArgumentError, "Missing the required parameter 'start_date' when calling UserAccountApi.user_account_analytics_top_video_pins"
  end
  # verify the required parameter 'end_date' is set
  if @api_client.config.client_side_validation && end_date.nil?
    fail ArgumentError, "Missing the required parameter 'end_date' when calling UserAccountApi.user_account_analytics_top_video_pins"
  end
  # verify the required parameter 'sort_by' is set
  if @api_client.config.client_side_validation && sort_by.nil?
    fail ArgumentError, "Missing the required parameter 'sort_by' when calling UserAccountApi.user_account_analytics_top_video_pins"
  end
  allowable_values = ["OTHER", "CLAIMED", "BOTH"]
  if @api_client.config.client_side_validation && opts[:'from_claimed_content'] && !allowable_values.include?(opts[:'from_claimed_content'])
    fail ArgumentError, "invalid value for \"from_claimed_content\", must be one of #{allowable_values}"
  end
  allowable_values = ["ALL", "ORGANIC_IMAGE", "ORGANIC_PRODUCT", "ORGANIC_VIDEO", "ADS_STANDARD", "ADS_PRODUCT", "ADS_VIDEO", "ADS_IDEA"]
  if @api_client.config.client_side_validation && opts[:'pin_format'] && !allowable_values.include?(opts[:'pin_format'])
    fail ArgumentError, "invalid value for \"pin_format\", must be one of #{allowable_values}"
  end
  allowable_values = ["ALL", "MOBILE", "TABLET", "WEB"]
  if @api_client.config.client_side_validation && opts[:'app_types'] && !allowable_values.include?(opts[:'app_types'])
    fail ArgumentError, "invalid value for \"app_types\", must be one of #{allowable_values}"
  end
  allowable_values = ["ALL", "PAID", "ORGANIC"]
  if @api_client.config.client_side_validation && opts[:'content_type'] && !allowable_values.include?(opts[:'content_type'])
    fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}"
  end
  allowable_values = ["ALL", "YOUR_PINS", "OTHER_PINS"]
  if @api_client.config.client_side_validation && opts[:'source'] && !allowable_values.include?(opts[:'source'])
    fail ArgumentError, "invalid value for \"source\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'num_of_pins'].nil? && opts[:'num_of_pins'] > 50
    fail ArgumentError, 'invalid value for "opts[:"num_of_pins"]" when calling UserAccountApi.user_account_analytics_top_video_pins, must be smaller than or equal to 50.'
  end

  if @api_client.config.client_side_validation && !opts[:'num_of_pins'].nil? && opts[:'num_of_pins'] < 1
    fail ArgumentError, 'invalid value for "opts[:"num_of_pins"]" when calling UserAccountApi.user_account_analytics_top_video_pins, must be greater than or equal to 1.'
  end

  allowable_values = [30]
  if @api_client.config.client_side_validation && opts[:'created_in_last_n_days'] && !allowable_values.include?(opts[:'created_in_last_n_days'])
    fail ArgumentError, "invalid value for \"created_in_last_n_days\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'].to_s.length > 18
    fail ArgumentError, 'invalid value for "opts[:"ad_account_id"]" when calling UserAccountApi.user_account_analytics_top_video_pins, the character length must be smaller than or equal to 18.'
  end

  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling UserAccountApi.user_account_analytics_top_video_pins, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/user_account/analytics/top_video_pins'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start_date'] = start_date
  query_params[:'end_date'] = end_date
  query_params[:'sort_by'] = sort_by
  query_params[:'from_claimed_content'] = opts[:'from_claimed_content'] if !opts[:'from_claimed_content'].nil?
  query_params[:'pin_format'] = opts[:'pin_format'] if !opts[:'pin_format'].nil?
  query_params[:'app_types'] = opts[:'app_types'] if !opts[:'app_types'].nil?
  query_params[:'content_type'] = opts[:'content_type'] if !opts[:'content_type'].nil?
  query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
  query_params[:'metric_types'] = @api_client.build_collection_param(opts[:'metric_types'], :csv) if !opts[:'metric_types'].nil?
  query_params[:'num_of_pins'] = opts[:'num_of_pins'] if !opts[:'num_of_pins'].nil?
  query_params[:'created_in_last_n_days'] = opts[:'created_in_last_n_days'] if !opts[:'created_in_last_n_days'].nil?
  query_params[:'ad_account_id'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']

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

#user_account_analytics_with_http_info(start_date, end_date, opts = {}) ⇒ Array<(Hash<String, AnalyticsMetricsResponse>, Integer, Hash)>

Get user account analytics Get analytics for the &quot;operation user_account&quot; - By default, the &quot;operation user_account&quot; is the token user_account. Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the &quot;operation user_account&quot;.

Parameters:

  • start_date (Date) —

    Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.

  • end_date (Date) —

    Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.

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

    the optional parameters

Options Hash (opts):

  • :from_claimed_content (String) —

    Filter on Pins that match your claimed domain. (default to 'BOTH')

  • :pin_format (String) —

    Pin formats to get data for, default is all. (default to 'ALL')

  • :app_types (String) —

    Apps or devices to get data for, default is all. (default to 'ALL')

  • :content_type (String) —

    Filter to paid or organic data. Default is all. (default to 'ALL')

  • :source (String) —

    Filter to activity from Pins created and saved by your, or activity created and saved by others from your claimed accounts (default to 'ALL')

  • :metric_types (Array<QuerymetrictypesItems>) —

    Metric types to get data for, default is all.

  • :split_field (String) —

    How to split the data into groups. Not including this param means data won't be split. (default to 'NO_SPLIT')

  • :ad_account_id (String) —

    Unique identifier of an ad account.

Returns:

  • (Array<(Hash<String, AnalyticsMetricsResponse>, Integer, Hash)>) —

    Hash<String, AnalyticsMetricsResponse> data, response status code and response headers



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 412

def (start_date, end_date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserAccountApi.user_account_analytics ...'
  end
  # verify the required parameter 'start_date' is set
  if @api_client.config.client_side_validation && start_date.nil?
    fail ArgumentError, "Missing the required parameter 'start_date' when calling UserAccountApi.user_account_analytics"
  end
  # verify the required parameter 'end_date' is set
  if @api_client.config.client_side_validation && end_date.nil?
    fail ArgumentError, "Missing the required parameter 'end_date' when calling UserAccountApi.user_account_analytics"
  end
  allowable_values = ["OTHER", "CLAIMED", "BOTH"]
  if @api_client.config.client_side_validation && opts[:'from_claimed_content'] && !allowable_values.include?(opts[:'from_claimed_content'])
    fail ArgumentError, "invalid value for \"from_claimed_content\", must be one of #{allowable_values}"
  end
  allowable_values = ["ALL", "ORGANIC_IMAGE", "ORGANIC_PRODUCT", "ORGANIC_VIDEO", "ADS_STANDARD", "ADS_PRODUCT", "ADS_VIDEO", "ADS_IDEA"]
  if @api_client.config.client_side_validation && opts[:'pin_format'] && !allowable_values.include?(opts[:'pin_format'])
    fail ArgumentError, "invalid value for \"pin_format\", must be one of #{allowable_values}"
  end
  allowable_values = ["ALL", "MOBILE", "TABLET", "WEB"]
  if @api_client.config.client_side_validation && opts[:'app_types'] && !allowable_values.include?(opts[:'app_types'])
    fail ArgumentError, "invalid value for \"app_types\", must be one of #{allowable_values}"
  end
  allowable_values = ["ALL", "PAID", "ORGANIC"]
  if @api_client.config.client_side_validation && opts[:'content_type'] && !allowable_values.include?(opts[:'content_type'])
    fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}"
  end
  allowable_values = ["ALL", "YOUR_PINS", "OTHER_PINS"]
  if @api_client.config.client_side_validation && opts[:'source'] && !allowable_values.include?(opts[:'source'])
    fail ArgumentError, "invalid value for \"source\", must be one of #{allowable_values}"
  end
  allowable_values = ["NO_SPLIT", "APP_TYPE", "OWNED_CONTENT", "SOURCE", "PIN_FORMAT"]
  if @api_client.config.client_side_validation && opts[:'split_field'] && !allowable_values.include?(opts[:'split_field'])
    fail ArgumentError, "invalid value for \"split_field\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'].to_s.length > 18
    fail ArgumentError, 'invalid value for "opts[:"ad_account_id"]" when calling UserAccountApi.user_account_analytics, the character length must be smaller than or equal to 18.'
  end

  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling UserAccountApi.user_account_analytics, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/user_account/analytics'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'start_date'] = start_date
  query_params[:'end_date'] = end_date
  query_params[:'from_claimed_content'] = opts[:'from_claimed_content'] if !opts[:'from_claimed_content'].nil?
  query_params[:'pin_format'] = opts[:'pin_format'] if !opts[:'pin_format'].nil?
  query_params[:'app_types'] = opts[:'app_types'] if !opts[:'app_types'].nil?
  query_params[:'content_type'] = opts[:'content_type'] if !opts[:'content_type'].nil?
  query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
  query_params[:'metric_types'] = @api_client.build_collection_param(opts[:'metric_types'], :csv) if !opts[:'metric_types'].nil?
  query_params[:'split_field'] = opts[:'split_field'] if !opts[:'split_field'].nil?
  query_params[:'ad_account_id'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, AnalyticsMetricsResponse>'

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

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

#user_account_followed_interests(username, opts = {}) ⇒ UserAccountFollowedInterests200Response

List following interests Get a list of a user's following interests in one place.

Parameters:

  • username (String) —

    A valid username

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

    the optional parameters

Options Hash (opts):

  • :bookmark (String) —

    Cursor used to fetch the next page of items

  • :page_size (Integer) —

    Maximum number of items to include in a single page. See documentation on Pagination for more information. (default to 25)

Returns:



806
807
808
809
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 806

def (username, opts = {})
  data, _status_code, _headers = (username, opts)
  data
end

#user_account_followed_interests_with_http_info(username, opts = {}) ⇒ Array<(UserAccountFollowedInterests200Response, Integer, Hash)>

List following interests Get a list of a user's following interests in one place.

Parameters:

  • username (String) —

    A valid username

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

    the optional parameters

Options Hash (opts):

  • :bookmark (String) —

    Cursor used to fetch the next page of items

  • :page_size (Integer) —

    Maximum number of items to include in a single page. See documentation on Pagination for more information. (default to 25)

Returns:



818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 818

def (username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserAccountApi.user_account_followed_interests ...'
  end
  # verify the required parameter 'username' is set
  if @api_client.config.client_side_validation && username.nil?
    fail ArgumentError, "Missing the required parameter 'username' when calling UserAccountApi.user_account_followed_interests"
  end
  pattern = Regexp.new(/(?!^\d+$)^.+$/)
  if @api_client.config.client_side_validation && username !~ pattern
    fail ArgumentError, "invalid value for 'username' when calling UserAccountApi.user_account_followed_interests, must conform to the pattern #{pattern}."
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 250
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling UserAccountApi.user_account_followed_interests, must be smaller than or equal to 250.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling UserAccountApi.user_account_followed_interests, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/users/{username}/interests/follow'.sub('{username}', CGI.escape(username.to_s))

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

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']

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

#user_account_get(opts = {}) ⇒ Account

Get user account Get account information for the "operation user_account" - By default, the "operation user_account" is the token user_account. [Understanding Business Access]: https://developers.pinterest.com/docs/getting-started/using-business-access/ "Understanding Business Access" If using Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account". See [Understanding Business Access] for more information.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ad_account_id (String) —

    Unique identifier of an ad account.

Returns:



886
887
888
889
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 886

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

#user_account_get_with_http_info(opts = {}) ⇒ Array<(Account, Integer, Hash)>

Get user account Get account information for the &quot;operation user_account&quot; - By default, the &quot;operation user_account&quot; is the token user_account. [Understanding Business Access]: https://developers.pinterest.com/docs/getting-started/using-business-access/ &quot;Understanding Business Access&quot; If using Business Access: Specify an ad_account_id to use the owner of that ad_account as the &quot;operation user_account&quot;. See [Understanding Business Access] for more information.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ad_account_id (String) —

    Unique identifier of an ad account.

Returns:

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

    Account data, response status code and response headers



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 896

def (opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserAccountApi.user_account_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'].to_s.length > 18
    fail ArgumentError, 'invalid value for "opts[:"ad_account_id"]" when calling UserAccountApi.user_account_get, the character length must be smaller than or equal to 18.'
  end

  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling UserAccountApi.user_account_get, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/user_account'

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

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']

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

#user_following_get(opts = {}) ⇒ FollowersList200Response

List following Get a list of who a certain user follows.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ad_account_id (String) —

    Unique identifier of an ad account.

  • :explicit_following (Boolean) —

    Whether or not to include implicit user follows, which means followees with board follows. When explicit_following is True, it means we only want explicit user follows. (default to false)

  • :feed_type (UserFollowingFeedType) —

    Thrift param specifying what type of followees will be kept. Default to include all followees. (default to 'ALL')

  • :bookmark (String) —

    Cursor used to fetch the next page of items

  • :page_size (Integer) —

    Maximum number of items to include in a single page. See documentation on Pagination for more information. (default to 25)

Returns:



959
960
961
962
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 959

def user_following_get(opts = {})
  data, _status_code, _headers = user_following_get_with_http_info(opts)
  data
end

#user_following_get_with_http_info(opts = {}) ⇒ Array<(FollowersList200Response, Integer, Hash)>

List following Get a list of who a certain user follows.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ad_account_id (String) —

    Unique identifier of an ad account.

  • :explicit_following (Boolean) —

    Whether or not to include implicit user follows, which means followees with board follows. When explicit_following is True, it means we only want explicit user follows. (default to false)

  • :feed_type (UserFollowingFeedType) —

    Thrift param specifying what type of followees will be kept. Default to include all followees. (default to 'ALL')

  • :bookmark (String) —

    Cursor used to fetch the next page of items

  • :page_size (Integer) —

    Maximum number of items to include in a single page. See documentation on Pagination for more information. (default to 25)

Returns:

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

    FollowersList200Response data, response status code and response headers



973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 973

def user_following_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserAccountApi.user_following_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'].to_s.length > 18
    fail ArgumentError, 'invalid value for "opts[:"ad_account_id"]" when calling UserAccountApi.user_following_get, the character length must be smaller than or equal to 18.'
  end

  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling UserAccountApi.user_following_get, must conform to the pattern #{pattern}."
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 250
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling UserAccountApi.user_following_get, must be smaller than or equal to 250.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling UserAccountApi.user_following_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/user_account/following'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ad_account_id'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
  query_params[:'explicit_following'] = opts[:'explicit_following'] if !opts[:'explicit_following'].nil?
  query_params[:'feed_type'] = opts[:'feed_type'] if !opts[:'feed_type'].nil?
  query_params[:'bookmark'] = opts[:'bookmark'] if !opts[:'bookmark'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']

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

#user_websites_get(opts = {}) ⇒ UserWebsitesGet200Response

Get user websites Get user websites, claimed or not

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :bookmark (String) —

    Cursor used to fetch the next page of items

  • :page_size (Integer) —

    Maximum number of items to include in a single page. See documentation on Pagination for more information. (default to 25)

Returns:



1045
1046
1047
1048
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 1045

def user_websites_get(opts = {})
  data, _status_code, _headers = user_websites_get_with_http_info(opts)
  data
end

#user_websites_get_with_http_info(opts = {}) ⇒ Array<(UserWebsitesGet200Response, Integer, Hash)>

Get user websites Get user websites, claimed or not

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :bookmark (String) —

    Cursor used to fetch the next page of items

  • :page_size (Integer) —

    Maximum number of items to include in a single page. See documentation on Pagination for more information. (default to 25)

Returns:

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

    UserWebsitesGet200Response data, response status code and response headers



1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 1056

def user_websites_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserAccountApi.user_websites_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 250
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling UserAccountApi.user_websites_get, must be smaller than or equal to 250.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling UserAccountApi.user_websites_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/user_account/websites'

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

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

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

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

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

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

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

#verify_website_update(user_website_create, opts = {}) ⇒ UserWebsite

Verify website Verify a website as a signed-in user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ad_account_id (String) —

    Unique identifier of an ad account.

Returns:



1116
1117
1118
1119
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 1116

def verify_website_update(user_website_create, opts = {})
  data, _status_code, _headers = verify_website_update_with_http_info(user_website_create, opts)
  data
end

#verify_website_update_with_http_info(user_website_create, opts = {}) ⇒ Array<(UserWebsite, Integer, Hash)>

Verify website Verify a website as a signed-in user.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ad_account_id (String) —

    Unique identifier of an ad account.

Returns:

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

    UserWebsite data, response status code and response headers



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 1127

def verify_website_update_with_http_info(user_website_create, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserAccountApi.verify_website_update ...'
  end
  # verify the required parameter 'user_website_create' is set
  if @api_client.config.client_side_validation && user_website_create.nil?
    fail ArgumentError, "Missing the required parameter 'user_website_create' when calling UserAccountApi.verify_website_update"
  end
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'].to_s.length > 18
    fail ArgumentError, 'invalid value for "opts[:"ad_account_id"]" when calling UserAccountApi.verify_website_update, the character length must be smaller than or equal to 18.'
  end

  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling UserAccountApi.verify_website_update, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/user_account/websites'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # 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(user_website_create)

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

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

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

#website_verification_get(opts = {}) ⇒ UserWebsiteVerification

Get user verification code for website claiming Get verification code for user to install on the website to claim it.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ad_account_id (String) —

    Unique identifier of an ad account.

Returns:



1195
1196
1197
1198
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 1195

def website_verification_get(opts = {})
  data, _status_code, _headers = website_verification_get_with_http_info(opts)
  data
end

#website_verification_get_with_http_info(opts = {}) ⇒ Array<(UserWebsiteVerification, Integer, Hash)>

Get user verification code for website claiming Get verification code for user to install on the website to claim it.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ad_account_id (String) —

    Unique identifier of an ad account.

Returns:

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

    UserWebsiteVerification data, response status code and response headers



1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
 
# File 'lib/pinterest_sdk/api/user_account_api.rb', line 1205

def website_verification_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserAccountApi.website_verification_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'].to_s.length > 18
    fail ArgumentError, 'invalid value for "opts[:"ad_account_id"]" when calling UserAccountApi.website_verification_get, the character length must be smaller than or equal to 18.'
  end

  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && !opts[:'ad_account_id'].nil? && opts[:'ad_account_id'] !~ pattern
    fail ArgumentError, "invalid value for 'opts[:\"ad_account_id\"]' when calling UserAccountApi.website_verification_get, must conform to the pattern #{pattern}."
  end

  # resource path
  local_var_path = '/user_account/websites/verification'

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

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['pinterest_oauth2', 'client_credentials']

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