Class: PinterestSdkClient::BusinessAccessInviteApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BusinessAccessInviteApi

Returns a new instance of BusinessAccessInviteApi.



19
20
21
 
# File 'lib/pinterest_sdk/api/business_access_invite_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/business_access_invite_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#asset_access_requests_create(business_id, create_asset_access_request_body, opts = {}) ⇒ CreateAssetAccessRequestResponse

Create a request to access an existing partner's assets. Create a request to access an existing partner's assets with the specified permissions. The request will be sent to the partner for approval. The assets that can be requested are ad accounts and profiles.

Parameters:

  • business_id (String) —

    Unique identifier of the requesting business.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/pinterest_sdk/api/business_access_invite_api.rb', line 28

def asset_access_requests_create(business_id, create_asset_access_request_body, opts = {})
  data, _status_code, _headers = asset_access_requests_create_with_http_info(business_id, create_asset_access_request_body, opts)
  data
end

#asset_access_requests_create_with_http_info(business_id, create_asset_access_request_body, opts = {}) ⇒ Array<(CreateAssetAccessRequestResponse, Integer, Hash)>

Create a request to access an existing partner's assets. Create a request to access an existing partner's assets with the specified permissions. The request will be sent to the partner for approval. The assets that can be requested are ad accounts and profiles.

Parameters:

  • business_id (String) —

    Unique identifier of the requesting business.

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

    the optional parameters

Returns:



39
40
41
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/pinterest_sdk/api/business_access_invite_api.rb', line 39

def asset_access_requests_create_with_http_info(business_id, create_asset_access_request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAccessInviteApi.asset_access_requests_create ...'
  end
  # verify the required parameter 'business_id' is set
  if @api_client.config.client_side_validation && business_id.nil?
    fail ArgumentError, "Missing the required parameter 'business_id' when calling BusinessAccessInviteApi.asset_access_requests_create"
  end
  if @api_client.config.client_side_validation && business_id.to_s.length > 20
    fail ArgumentError, 'invalid value for "business_id" when calling BusinessAccessInviteApi.asset_access_requests_create, the character length must be smaller than or equal to 20.'
  end

  if @api_client.config.client_side_validation && business_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "business_id" when calling BusinessAccessInviteApi.asset_access_requests_create, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && business_id !~ pattern
    fail ArgumentError, "invalid value for 'business_id' when calling BusinessAccessInviteApi.asset_access_requests_create, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'create_asset_access_request_body' is set
  if @api_client.config.client_side_validation && create_asset_access_request_body.nil?
    fail ArgumentError, "Missing the required parameter 'create_asset_access_request_body' when calling BusinessAccessInviteApi.asset_access_requests_create"
  end
  # resource path
  local_var_path = '/businesses/{business_id}/requests/assets/access'.sub('{business_id}', CGI.escape(business_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']) 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(create_asset_access_request_body)

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

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

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

#cancel_invites_or_requests(business_id, cancel_invites_request, opts = {}) ⇒ CancelInvitesResponse

Cancel invites/requests Cancel membership/partnership invites and/or requests.

Parameters:

  • business_id (String) —

    Unique identifier of the requesting business.

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

    the optional parameters

Returns:



115
116
117
118
 
# File 'lib/pinterest_sdk/api/business_access_invite_api.rb', line 115

def cancel_invites_or_requests(business_id, cancel_invites_request, opts = {})
  data, _status_code, _headers = cancel_invites_or_requests_with_http_info(business_id, cancel_invites_request, opts)
  data
end

#cancel_invites_or_requests_with_http_info(business_id, cancel_invites_request, opts = {}) ⇒ Array<(CancelInvitesResponse, Integer, Hash)>

Cancel invites/requests Cancel membership/partnership invites and/or requests.

Parameters:

  • business_id (String) —

    Unique identifier of the requesting business.

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

    the optional parameters

Returns:

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

    CancelInvitesResponse data, response status code and response headers



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
186
187
188
189
190
 
# File 'lib/pinterest_sdk/api/business_access_invite_api.rb', line 126

def cancel_invites_or_requests_with_http_info(business_id, cancel_invites_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAccessInviteApi.cancel_invites_or_requests ...'
  end
  # verify the required parameter 'business_id' is set
  if @api_client.config.client_side_validation && business_id.nil?
    fail ArgumentError, "Missing the required parameter 'business_id' when calling BusinessAccessInviteApi.cancel_invites_or_requests"
  end
  if @api_client.config.client_side_validation && business_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "business_id" when calling BusinessAccessInviteApi.cancel_invites_or_requests, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && business_id !~ pattern
    fail ArgumentError, "invalid value for 'business_id' when calling BusinessAccessInviteApi.cancel_invites_or_requests, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'cancel_invites_request' is set
  if @api_client.config.client_side_validation && cancel_invites_request.nil?
    fail ArgumentError, "Missing the required parameter 'cancel_invites_request' when calling BusinessAccessInviteApi.cancel_invites_or_requests"
  end
  # resource path
  local_var_path = '/businesses/{business_id}/invites'.sub('{business_id}', CGI.escape(business_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']) 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(cancel_invites_request)

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

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

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

#create_asset_invites(business_id, create_asset_invites_request, opts = {}) ⇒ UpdateInvitesResultsResponseArray

Update invite/request with an asset permission Assign asset permissions information to an existing invite/request. Can be used to: - Request access to a partner's asset. Note: This is only for when no existing partnership exists. If an existing partnership exists, use "Create a request to access an existing partner's assets" to request access to your partner's assets. - invite_type="PARTNER_REQUEST" - Invite a partner to access your business assets. Note: This is only for when there is no existing partnership. If there is an existing partnership, use "Assign/Update partner asset permissions" to assign a partner access to new assets. - invite_type="PARTNER_INVITE" - Invite a member to access your business assets. Note: This is only for when there is no existing membership. If there is an existing membership, use "Assign/Update member asset permissions" to assign a member access to new assets. - invite_type="MEMBER_INVITE" To learn more about permission levels, visit https://help.pinterest.com/en/business/article/business-manager-overview.

Parameters:

  • business_id (String) —

    Unique identifier of the requesting business.

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

    the optional parameters

Returns:



198
199
200
201
 
# File 'lib/pinterest_sdk/api/business_access_invite_api.rb', line 198

def create_asset_invites(business_id, create_asset_invites_request, opts = {})
  data, _status_code, _headers = create_asset_invites_with_http_info(business_id, create_asset_invites_request, opts)
  data
end

#create_asset_invites_with_http_info(business_id, create_asset_invites_request, opts = {}) ⇒ Array<(UpdateInvitesResultsResponseArray, Integer, Hash)>

Update invite/request with an asset permission Assign asset permissions information to an existing invite/request. Can be used to: - Request access to a partner's asset. Note: This is only for when no existing partnership exists. If an existing partnership exists, use &quot;Create a request to access an existing partner's assets&quot; to request access to your partner's assets. - invite_type=&quot;PARTNER_REQUEST&quot; - Invite a partner to access your business assets. Note: This is only for when there is no existing partnership. If there is an existing partnership, use &quot;Assign/Update partner asset permissions&quot; to assign a partner access to new assets. - invite_type=&quot;PARTNER_INVITE&quot; - Invite a member to access your business assets. Note: This is only for when there is no existing membership. If there is an existing membership, use &quot;Assign/Update member asset permissions&quot; to assign a member access to new assets. - invite_type=&quot;MEMBER_INVITE&quot; To learn more about permission levels, visit https://help.pinterest.com/en/business/article/business-manager-overview.

Parameters:

  • business_id (String) —

    Unique identifier of the requesting business.

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

    the optional parameters

Returns:



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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/pinterest_sdk/api/business_access_invite_api.rb', line 209

def create_asset_invites_with_http_info(business_id, create_asset_invites_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAccessInviteApi.create_asset_invites ...'
  end
  # verify the required parameter 'business_id' is set
  if @api_client.config.client_side_validation && business_id.nil?
    fail ArgumentError, "Missing the required parameter 'business_id' when calling BusinessAccessInviteApi.create_asset_invites"
  end
  if @api_client.config.client_side_validation && business_id.to_s.length > 20
    fail ArgumentError, 'invalid value for "business_id" when calling BusinessAccessInviteApi.create_asset_invites, the character length must be smaller than or equal to 20.'
  end

  if @api_client.config.client_side_validation && business_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "business_id" when calling BusinessAccessInviteApi.create_asset_invites, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && business_id !~ pattern
    fail ArgumentError, "invalid value for 'business_id' when calling BusinessAccessInviteApi.create_asset_invites, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'create_asset_invites_request' is set
  if @api_client.config.client_side_validation && create_asset_invites_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_asset_invites_request' when calling BusinessAccessInviteApi.create_asset_invites"
  end
  # resource path
  local_var_path = '/businesses/{business_id}/invites/assets/access'.sub('{business_id}', CGI.escape(business_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']) 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(create_asset_invites_request)

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

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

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

#create_membership_or_partnership_invites(business_id, create_membership_or_partnership_invites_body, opts = {}) ⇒ CreateInvitesResultsResponseArray

Create invites or requests Create batch invites or requests. Can create batch invites or requests as described below. - Invite members to join the business. This would required specifying the following: - invite_type="MEMBER_INVITE" - business_role="EMPLOYEE" OR business_role="BIZ_ADMIN" (To learn more about business roles, visit https://help.pinterest.com/en/business/article/profile-permissions-in-business-access.) - members - Invite partners to access your business assets. This would require specifying the following: - invite_type="PARTNER_INVITE" - business_role="PARTNER" - partners - Request to be a partner so you can access their assets. This would require specifying the following: - invite_type="PARTNER_REQUEST" - business_role="PARTNER" - partners

Parameters:

  • business_id (String) —

    Unique identifier of the requesting business.

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

    the optional parameters

Returns:



285
286
287
288
 
# File 'lib/pinterest_sdk/api/business_access_invite_api.rb', line 285

def create_membership_or_partnership_invites(business_id, create_membership_or_partnership_invites_body, opts = {})
  data, _status_code, _headers = create_membership_or_partnership_invites_with_http_info(business_id, create_membership_or_partnership_invites_body, opts)
  data
end

#create_membership_or_partnership_invites_with_http_info(business_id, create_membership_or_partnership_invites_body, opts = {}) ⇒ Array<(CreateInvitesResultsResponseArray, Integer, Hash)>

Create invites or requests Create batch invites or requests. Can create batch invites or requests as described below. - Invite members to join the business. This would required specifying the following: - invite_type=&quot;MEMBER_INVITE&quot; - business_role=&quot;EMPLOYEE&quot; OR business_role=&quot;BIZ_ADMIN&quot; (To learn more about business roles, visit https://help.pinterest.com/en/business/article/profile-permissions-in-business-access.) - members - Invite partners to access your business assets. This would require specifying the following: - invite_type=&quot;PARTNER_INVITE&quot; - business_role=&quot;PARTNER&quot; - partners - Request to be a partner so you can access their assets. This would require specifying the following: - invite_type=&quot;PARTNER_REQUEST&quot; - business_role=&quot;PARTNER&quot; - partners

Parameters:

  • business_id (String) —

    Unique identifier of the requesting business.

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

    the optional parameters

Returns:



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
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
 
# File 'lib/pinterest_sdk/api/business_access_invite_api.rb', line 296

def create_membership_or_partnership_invites_with_http_info(business_id, create_membership_or_partnership_invites_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAccessInviteApi.create_membership_or_partnership_invites ...'
  end
  # verify the required parameter 'business_id' is set
  if @api_client.config.client_side_validation && business_id.nil?
    fail ArgumentError, "Missing the required parameter 'business_id' when calling BusinessAccessInviteApi.create_membership_or_partnership_invites"
  end
  if @api_client.config.client_side_validation && business_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "business_id" when calling BusinessAccessInviteApi.create_membership_or_partnership_invites, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && business_id !~ pattern
    fail ArgumentError, "invalid value for 'business_id' when calling BusinessAccessInviteApi.create_membership_or_partnership_invites, must conform to the pattern #{pattern}."
  end

  # verify the required parameter 'create_membership_or_partnership_invites_body' is set
  if @api_client.config.client_side_validation && create_membership_or_partnership_invites_body.nil?
    fail ArgumentError, "Missing the required parameter 'create_membership_or_partnership_invites_body' when calling BusinessAccessInviteApi.create_membership_or_partnership_invites"
  end
  # resource path
  local_var_path = '/businesses/{business_id}/invites'.sub('{business_id}', CGI.escape(business_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']) 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(create_membership_or_partnership_invites_body)

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

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

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

#get_invites(business_id, opts = {}) ⇒ GetInvites200Response

Get invites/requests Get the membership/partnership invites and/or requests for the authorized user.

Parameters:

  • business_id (String) —

    Unique identifier of the requesting business.

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

    the optional parameters

Options Hash (opts):

  • :is_member (Boolean) —

    A boolean field to indicate whether the invite is to create a partnership or a membership. (default to true)

  • :invite_status (Array<InviteFilterStatus>) —

    A list of invite statuses to filter invites by. Only invites whose status is in the provided statuses will be returned.

  • :invite_type (InviteType) —

    Invite type to filter invites by. Only invites of the specified type will be returned.

  • :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:



372
373
374
375
 
# File 'lib/pinterest_sdk/api/business_access_invite_api.rb', line 372

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

#get_invites_with_http_info(business_id, opts = {}) ⇒ Array<(GetInvites200Response, Integer, Hash)>

Get invites/requests Get the membership/partnership invites and/or requests for the authorized user.

Parameters:

  • business_id (String) —

    Unique identifier of the requesting business.

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

    the optional parameters

Options Hash (opts):

  • :is_member (Boolean) —

    A boolean field to indicate whether the invite is to create a partnership or a membership. (default to true)

  • :invite_status (Array<InviteFilterStatus>) —

    A list of invite statuses to filter invites by. Only invites whose status is in the provided statuses will be returned.

  • :invite_type (InviteType) —

    Invite type to filter invites by. Only invites of the specified type will be returned.

  • :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<(GetInvites200Response, Integer, Hash)>) —

    GetInvites200Response data, response status code and response headers



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
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
 
# File 'lib/pinterest_sdk/api/business_access_invite_api.rb', line 387

def get_invites_with_http_info(business_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAccessInviteApi.get_invites ...'
  end
  # verify the required parameter 'business_id' is set
  if @api_client.config.client_side_validation && business_id.nil?
    fail ArgumentError, "Missing the required parameter 'business_id' when calling BusinessAccessInviteApi.get_invites"
  end
  if @api_client.config.client_side_validation && business_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "business_id" when calling BusinessAccessInviteApi.get_invites, the character length must be greater than or equal to 1.'
  end

  pattern = Regexp.new(/^\d+$/)
  if @api_client.config.client_side_validation && business_id !~ pattern
    fail ArgumentError, "invalid value for 'business_id' when calling BusinessAccessInviteApi.get_invites, must conform to the pattern #{pattern}."
  end

  if @api_client.config.client_side_validation && !opts[:'invite_status'].nil? && opts[:'invite_status'].length < 1
    fail ArgumentError, 'invalid value for "opts[:"invite_status"]" when calling BusinessAccessInviteApi.get_invites, number of items must be greater than or equal to 1.'
  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 BusinessAccessInviteApi.get_invites, 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 BusinessAccessInviteApi.get_invites, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/businesses/{business_id}/invites'.sub('{business_id}', CGI.escape(business_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'is_member'] = opts[:'is_member'] if !opts[:'is_member'].nil?
  query_params[:'invite_status'] = @api_client.build_collection_param(opts[:'invite_status'], :multi) if !opts[:'invite_status'].nil?
  query_params[:'invite_type'] = opts[:'invite_type'] if !opts[:'invite_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] || 'GetInvites200Response'

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

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

#respond_business_access_invites(auth_respond_invites_body, opts = {}) ⇒ RespondToInvitesResponseArray

Accept or decline an invite/request Accept or decline invites or requests.

Parameters:

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

    the optional parameters

Returns:



466
467
468
469
 
# File 'lib/pinterest_sdk/api/business_access_invite_api.rb', line 466

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

#respond_business_access_invites_with_http_info(auth_respond_invites_body, opts = {}) ⇒ Array<(RespondToInvitesResponseArray, Integer, Hash)>

Accept or decline an invite/request Accept or decline invites or requests.

Parameters:

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

    the optional parameters

Returns:



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
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/pinterest_sdk/api/business_access_invite_api.rb', line 476

def respond_business_access_invites_with_http_info(auth_respond_invites_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BusinessAccessInviteApi.respond_business_access_invites ...'
  end
  # verify the required parameter 'auth_respond_invites_body' is set
  if @api_client.config.client_side_validation && auth_respond_invites_body.nil?
    fail ArgumentError, "Missing the required parameter 'auth_respond_invites_body' when calling BusinessAccessInviteApi.respond_business_access_invites"
  end
  # resource path
  local_var_path = '/businesses/invites'

  # 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(auth_respond_invites_body)

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

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

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