ultracart_api 4.1.40 → 4.1.42

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -364,6 +364,70 @@ module UltracartClient
364
364
  return data, status_code, headers
365
365
  end
366
366
 
367
+ # Delete pbx address
368
+ # Delete a pbx address
369
+ # @param conversation_pbx_address_uuid [String]
370
+ # @param [Hash] opts the optional parameters
371
+ # @return [ConversationPbxAddressResponse]
372
+ def delete_pbx_address(conversation_pbx_address_uuid, opts = {})
373
+ data, _status_code, _headers = delete_pbx_address_with_http_info(conversation_pbx_address_uuid, opts)
374
+ data
375
+ end
376
+
377
+ # Delete pbx address
378
+ # Delete a pbx address
379
+ # @param conversation_pbx_address_uuid [String]
380
+ # @param [Hash] opts the optional parameters
381
+ # @return [Array<(ConversationPbxAddressResponse, Integer, Hash)>] ConversationPbxAddressResponse data, response status code and response headers
382
+ def delete_pbx_address_with_http_info(conversation_pbx_address_uuid, opts = {})
383
+ if @api_client.config.debugging
384
+ @api_client.config.logger.debug 'Calling API: ConversationApi.delete_pbx_address ...'
385
+ end
386
+ # verify the required parameter 'conversation_pbx_address_uuid' is set
387
+ if @api_client.config.client_side_validation && conversation_pbx_address_uuid.nil?
388
+ fail ArgumentError, "Missing the required parameter 'conversation_pbx_address_uuid' when calling ConversationApi.delete_pbx_address"
389
+ end
390
+ # resource path
391
+ local_var_path = '/conversation/pbx/address/{conversationPbxAddressUuid}'.sub('{' + 'conversationPbxAddressUuid' + '}', CGI.escape(conversation_pbx_address_uuid.to_s))
392
+
393
+ # query parameters
394
+ query_params = opts[:query_params] || {}
395
+
396
+ # header parameters
397
+ header_params = opts[:header_params] || {}
398
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
399
+ # HTTP header 'Accept' (if needed)
400
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
401
+
402
+ # form parameters
403
+ form_params = opts[:form_params] || {}
404
+
405
+ # http body (model)
406
+ post_body = opts[:debug_body]
407
+
408
+ # return_type
409
+ return_type = opts[:debug_return_type] || 'ConversationPbxAddressResponse'
410
+
411
+ # auth_names
412
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
413
+
414
+ new_options = opts.merge(
415
+ :operation => :"ConversationApi.delete_pbx_address",
416
+ :header_params => header_params,
417
+ :query_params => query_params,
418
+ :form_params => form_params,
419
+ :body => post_body,
420
+ :auth_names => auth_names,
421
+ :return_type => return_type
422
+ )
423
+
424
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
425
+ if @api_client.config.debugging
426
+ @api_client.config.logger.debug "API called: ConversationApi#delete_pbx_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
427
+ end
428
+ return data, status_code, headers
429
+ end
430
+
367
431
  # Delete Agent Voicemail
368
432
  # Delete pbx agent Voicemail
369
433
  # @param recording_sid [String]
@@ -556,6 +620,70 @@ module UltracartClient
556
620
  return data, status_code, headers
557
621
  end
558
622
 
623
+ # Delete pbx phoneNumber
624
+ # Delete a pbx phoneNumber. Only works if deletion_protected is false.
625
+ # @param conversation_pbx_phone_number_uuid [String]
626
+ # @param [Hash] opts the optional parameters
627
+ # @return [nil]
628
+ def delete_pbx_phone_number(conversation_pbx_phone_number_uuid, opts = {})
629
+ delete_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid, opts)
630
+ nil
631
+ end
632
+
633
+ # Delete pbx phoneNumber
634
+ # Delete a pbx phoneNumber. Only works if deletion_protected is false.
635
+ # @param conversation_pbx_phone_number_uuid [String]
636
+ # @param [Hash] opts the optional parameters
637
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
638
+ def delete_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid, opts = {})
639
+ if @api_client.config.debugging
640
+ @api_client.config.logger.debug 'Calling API: ConversationApi.delete_pbx_phone_number ...'
641
+ end
642
+ # verify the required parameter 'conversation_pbx_phone_number_uuid' is set
643
+ if @api_client.config.client_side_validation && conversation_pbx_phone_number_uuid.nil?
644
+ fail ArgumentError, "Missing the required parameter 'conversation_pbx_phone_number_uuid' when calling ConversationApi.delete_pbx_phone_number"
645
+ end
646
+ # resource path
647
+ local_var_path = '/conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid}'.sub('{' + 'conversationPbxPhoneNumberUuid' + '}', CGI.escape(conversation_pbx_phone_number_uuid.to_s))
648
+
649
+ # query parameters
650
+ query_params = opts[:query_params] || {}
651
+
652
+ # header parameters
653
+ header_params = opts[:header_params] || {}
654
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
655
+ # HTTP header 'Accept' (if needed)
656
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
657
+
658
+ # form parameters
659
+ form_params = opts[:form_params] || {}
660
+
661
+ # http body (model)
662
+ post_body = opts[:debug_body]
663
+
664
+ # return_type
665
+ return_type = opts[:debug_return_type]
666
+
667
+ # auth_names
668
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
669
+
670
+ new_options = opts.merge(
671
+ :operation => :"ConversationApi.delete_pbx_phone_number",
672
+ :header_params => header_params,
673
+ :query_params => query_params,
674
+ :form_params => form_params,
675
+ :body => post_body,
676
+ :auth_names => auth_names,
677
+ :return_type => return_type
678
+ )
679
+
680
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
681
+ if @api_client.config.debugging
682
+ @api_client.config.logger.debug "API called: ConversationApi#delete_pbx_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
683
+ end
684
+ return data, status_code, headers
685
+ end
686
+
559
687
  # Delete pbx queue
560
688
  # Delete a pbx queue
561
689
  # @param conversation_pbx_queue_uuid [String]
@@ -2531,6 +2659,128 @@ module UltracartClient
2531
2659
  return data, status_code, headers
2532
2660
  end
2533
2661
 
2662
+ # Get pbx address
2663
+ # Retrieve a pbx address
2664
+ # @param conversation_pbx_address_uuid [String]
2665
+ # @param [Hash] opts the optional parameters
2666
+ # @return [ConversationPbxAddressResponse]
2667
+ def get_pbx_address(conversation_pbx_address_uuid, opts = {})
2668
+ data, _status_code, _headers = get_pbx_address_with_http_info(conversation_pbx_address_uuid, opts)
2669
+ data
2670
+ end
2671
+
2672
+ # Get pbx address
2673
+ # Retrieve a pbx address
2674
+ # @param conversation_pbx_address_uuid [String]
2675
+ # @param [Hash] opts the optional parameters
2676
+ # @return [Array<(ConversationPbxAddressResponse, Integer, Hash)>] ConversationPbxAddressResponse data, response status code and response headers
2677
+ def get_pbx_address_with_http_info(conversation_pbx_address_uuid, opts = {})
2678
+ if @api_client.config.debugging
2679
+ @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_address ...'
2680
+ end
2681
+ # verify the required parameter 'conversation_pbx_address_uuid' is set
2682
+ if @api_client.config.client_side_validation && conversation_pbx_address_uuid.nil?
2683
+ fail ArgumentError, "Missing the required parameter 'conversation_pbx_address_uuid' when calling ConversationApi.get_pbx_address"
2684
+ end
2685
+ # resource path
2686
+ local_var_path = '/conversation/pbx/address/{conversationPbxAddressUuid}'.sub('{' + 'conversationPbxAddressUuid' + '}', CGI.escape(conversation_pbx_address_uuid.to_s))
2687
+
2688
+ # query parameters
2689
+ query_params = opts[:query_params] || {}
2690
+
2691
+ # header parameters
2692
+ header_params = opts[:header_params] || {}
2693
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2694
+ # HTTP header 'Accept' (if needed)
2695
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2696
+
2697
+ # form parameters
2698
+ form_params = opts[:form_params] || {}
2699
+
2700
+ # http body (model)
2701
+ post_body = opts[:debug_body]
2702
+
2703
+ # return_type
2704
+ return_type = opts[:debug_return_type] || 'ConversationPbxAddressResponse'
2705
+
2706
+ # auth_names
2707
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
2708
+
2709
+ new_options = opts.merge(
2710
+ :operation => :"ConversationApi.get_pbx_address",
2711
+ :header_params => header_params,
2712
+ :query_params => query_params,
2713
+ :form_params => form_params,
2714
+ :body => post_body,
2715
+ :auth_names => auth_names,
2716
+ :return_type => return_type
2717
+ )
2718
+
2719
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2720
+ if @api_client.config.debugging
2721
+ @api_client.config.logger.debug "API called: ConversationApi#get_pbx_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2722
+ end
2723
+ return data, status_code, headers
2724
+ end
2725
+
2726
+ # Get pbx addresses
2727
+ # Retrieve pbx addresses
2728
+ # @param [Hash] opts the optional parameters
2729
+ # @return [ConversationPbxAddressesResponse]
2730
+ def get_pbx_addresses(opts = {})
2731
+ data, _status_code, _headers = get_pbx_addresses_with_http_info(opts)
2732
+ data
2733
+ end
2734
+
2735
+ # Get pbx addresses
2736
+ # Retrieve pbx addresses
2737
+ # @param [Hash] opts the optional parameters
2738
+ # @return [Array<(ConversationPbxAddressesResponse, Integer, Hash)>] ConversationPbxAddressesResponse data, response status code and response headers
2739
+ def get_pbx_addresses_with_http_info(opts = {})
2740
+ if @api_client.config.debugging
2741
+ @api_client.config.logger.debug 'Calling API: ConversationApi.get_pbx_addresses ...'
2742
+ end
2743
+ # resource path
2744
+ local_var_path = '/conversation/pbx/address'
2745
+
2746
+ # query parameters
2747
+ query_params = opts[:query_params] || {}
2748
+
2749
+ # header parameters
2750
+ header_params = opts[:header_params] || {}
2751
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
2752
+ # HTTP header 'Accept' (if needed)
2753
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2754
+
2755
+ # form parameters
2756
+ form_params = opts[:form_params] || {}
2757
+
2758
+ # http body (model)
2759
+ post_body = opts[:debug_body]
2760
+
2761
+ # return_type
2762
+ return_type = opts[:debug_return_type] || 'ConversationPbxAddressesResponse'
2763
+
2764
+ # auth_names
2765
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
2766
+
2767
+ new_options = opts.merge(
2768
+ :operation => :"ConversationApi.get_pbx_addresses",
2769
+ :header_params => header_params,
2770
+ :query_params => query_params,
2771
+ :form_params => form_params,
2772
+ :body => post_body,
2773
+ :auth_names => auth_names,
2774
+ :return_type => return_type
2775
+ )
2776
+
2777
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
2778
+ if @api_client.config.debugging
2779
+ @api_client.config.logger.debug "API called: ConversationApi#get_pbx_addresses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2780
+ end
2781
+ return data, status_code, headers
2782
+ end
2783
+
2534
2784
  # Get pbx agent
2535
2785
  # Retrieve a pbx agent
2536
2786
  # @param conversation_pbx_agent_uuid [String]
@@ -4300,6 +4550,75 @@ module UltracartClient
4300
4550
  return data, status_code, headers
4301
4551
  end
4302
4552
 
4553
+ # Insert pbx address
4554
+ # Insert a pbx address
4555
+ # @param pbx_address [ConversationPbxAddress] Pbx Address
4556
+ # @param [Hash] opts the optional parameters
4557
+ # @return [ConversationPbxAddressResponse]
4558
+ def insert_pbx_address(pbx_address, opts = {})
4559
+ data, _status_code, _headers = insert_pbx_address_with_http_info(pbx_address, opts)
4560
+ data
4561
+ end
4562
+
4563
+ # Insert pbx address
4564
+ # Insert a pbx address
4565
+ # @param pbx_address [ConversationPbxAddress] Pbx Address
4566
+ # @param [Hash] opts the optional parameters
4567
+ # @return [Array<(ConversationPbxAddressResponse, Integer, Hash)>] ConversationPbxAddressResponse data, response status code and response headers
4568
+ def insert_pbx_address_with_http_info(pbx_address, opts = {})
4569
+ if @api_client.config.debugging
4570
+ @api_client.config.logger.debug 'Calling API: ConversationApi.insert_pbx_address ...'
4571
+ end
4572
+ # verify the required parameter 'pbx_address' is set
4573
+ if @api_client.config.client_side_validation && pbx_address.nil?
4574
+ fail ArgumentError, "Missing the required parameter 'pbx_address' when calling ConversationApi.insert_pbx_address"
4575
+ end
4576
+ # resource path
4577
+ local_var_path = '/conversation/pbx/address'
4578
+
4579
+ # query parameters
4580
+ query_params = opts[:query_params] || {}
4581
+
4582
+ # header parameters
4583
+ header_params = opts[:header_params] || {}
4584
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
4585
+ # HTTP header 'Accept' (if needed)
4586
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4587
+ # HTTP header 'Content-Type'
4588
+ content_type = @api_client.select_header_content_type(['application/json'])
4589
+ if !content_type.nil?
4590
+ header_params['Content-Type'] = content_type
4591
+ end
4592
+
4593
+ # form parameters
4594
+ form_params = opts[:form_params] || {}
4595
+
4596
+ # http body (model)
4597
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(pbx_address)
4598
+
4599
+ # return_type
4600
+ return_type = opts[:debug_return_type] || 'ConversationPbxAddressResponse'
4601
+
4602
+ # auth_names
4603
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
4604
+
4605
+ new_options = opts.merge(
4606
+ :operation => :"ConversationApi.insert_pbx_address",
4607
+ :header_params => header_params,
4608
+ :query_params => query_params,
4609
+ :form_params => form_params,
4610
+ :body => post_body,
4611
+ :auth_names => auth_names,
4612
+ :return_type => return_type
4613
+ )
4614
+
4615
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4616
+ if @api_client.config.debugging
4617
+ @api_client.config.logger.debug "API called: ConversationApi#insert_pbx_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4618
+ end
4619
+ return data, status_code, headers
4620
+ end
4621
+
4303
4622
  # Insert pbx audio
4304
4623
  # Insert a pbx audio
4305
4624
  # @param pbx_audio [ConversationPbxAudio] Pbx Audio
@@ -5047,6 +5366,139 @@ module UltracartClient
5047
5366
  return data, status_code, headers
5048
5367
  end
5049
5368
 
5369
+ # Protect pbx phoneNumber from deletion
5370
+ # Protect a pbx phoneNumber from deletion. This is a one-way operation and cannot be undone through the API.
5371
+ # @param conversation_pbx_phone_number_uuid [String]
5372
+ # @param [Hash] opts the optional parameters
5373
+ # @return [ConversationPbxPhoneNumberResponse]
5374
+ def protect_pbx_phone_number(conversation_pbx_phone_number_uuid, opts = {})
5375
+ data, _status_code, _headers = protect_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid, opts)
5376
+ data
5377
+ end
5378
+
5379
+ # Protect pbx phoneNumber from deletion
5380
+ # Protect a pbx phoneNumber from deletion. This is a one-way operation and cannot be undone through the API.
5381
+ # @param conversation_pbx_phone_number_uuid [String]
5382
+ # @param [Hash] opts the optional parameters
5383
+ # @return [Array<(ConversationPbxPhoneNumberResponse, Integer, Hash)>] ConversationPbxPhoneNumberResponse data, response status code and response headers
5384
+ def protect_pbx_phone_number_with_http_info(conversation_pbx_phone_number_uuid, opts = {})
5385
+ if @api_client.config.debugging
5386
+ @api_client.config.logger.debug 'Calling API: ConversationApi.protect_pbx_phone_number ...'
5387
+ end
5388
+ # verify the required parameter 'conversation_pbx_phone_number_uuid' is set
5389
+ if @api_client.config.client_side_validation && conversation_pbx_phone_number_uuid.nil?
5390
+ fail ArgumentError, "Missing the required parameter 'conversation_pbx_phone_number_uuid' when calling ConversationApi.protect_pbx_phone_number"
5391
+ end
5392
+ # resource path
5393
+ local_var_path = '/conversation/pbx/phone_number/{conversationPbxPhoneNumberUuid}/protect'.sub('{' + 'conversationPbxPhoneNumberUuid' + '}', CGI.escape(conversation_pbx_phone_number_uuid.to_s))
5394
+
5395
+ # query parameters
5396
+ query_params = opts[:query_params] || {}
5397
+
5398
+ # header parameters
5399
+ header_params = opts[:header_params] || {}
5400
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5401
+ # HTTP header 'Accept' (if needed)
5402
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5403
+
5404
+ # form parameters
5405
+ form_params = opts[:form_params] || {}
5406
+
5407
+ # http body (model)
5408
+ post_body = opts[:debug_body]
5409
+
5410
+ # return_type
5411
+ return_type = opts[:debug_return_type] || 'ConversationPbxPhoneNumberResponse'
5412
+
5413
+ # auth_names
5414
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5415
+
5416
+ new_options = opts.merge(
5417
+ :operation => :"ConversationApi.protect_pbx_phone_number",
5418
+ :header_params => header_params,
5419
+ :query_params => query_params,
5420
+ :form_params => form_params,
5421
+ :body => post_body,
5422
+ :auth_names => auth_names,
5423
+ :return_type => return_type
5424
+ )
5425
+
5426
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
5427
+ if @api_client.config.debugging
5428
+ @api_client.config.logger.debug "API called: ConversationApi#protect_pbx_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5429
+ end
5430
+ return data, status_code, headers
5431
+ end
5432
+
5433
+ # Purchase pbx phone number
5434
+ # Purchase a phone number from Twilio. The phone_number must be from the available phone number search results.
5435
+ # @param phone_number_purchase_request [ConversationPbxPhoneNumberPurchaseRequest] Phone number purchase request
5436
+ # @param [Hash] opts the optional parameters
5437
+ # @return [ConversationPbxPhoneNumberResponse]
5438
+ def purchase_pbx_phone_number(phone_number_purchase_request, opts = {})
5439
+ data, _status_code, _headers = purchase_pbx_phone_number_with_http_info(phone_number_purchase_request, opts)
5440
+ data
5441
+ end
5442
+
5443
+ # Purchase pbx phone number
5444
+ # Purchase a phone number from Twilio. The phone_number must be from the available phone number search results.
5445
+ # @param phone_number_purchase_request [ConversationPbxPhoneNumberPurchaseRequest] Phone number purchase request
5446
+ # @param [Hash] opts the optional parameters
5447
+ # @return [Array<(ConversationPbxPhoneNumberResponse, Integer, Hash)>] ConversationPbxPhoneNumberResponse data, response status code and response headers
5448
+ def purchase_pbx_phone_number_with_http_info(phone_number_purchase_request, opts = {})
5449
+ if @api_client.config.debugging
5450
+ @api_client.config.logger.debug 'Calling API: ConversationApi.purchase_pbx_phone_number ...'
5451
+ end
5452
+ # verify the required parameter 'phone_number_purchase_request' is set
5453
+ if @api_client.config.client_side_validation && phone_number_purchase_request.nil?
5454
+ fail ArgumentError, "Missing the required parameter 'phone_number_purchase_request' when calling ConversationApi.purchase_pbx_phone_number"
5455
+ end
5456
+ # resource path
5457
+ local_var_path = '/conversation/pbx/phone_number'
5458
+
5459
+ # query parameters
5460
+ query_params = opts[:query_params] || {}
5461
+
5462
+ # header parameters
5463
+ header_params = opts[:header_params] || {}
5464
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5465
+ # HTTP header 'Accept' (if needed)
5466
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5467
+ # HTTP header 'Content-Type'
5468
+ content_type = @api_client.select_header_content_type(['application/json'])
5469
+ if !content_type.nil?
5470
+ header_params['Content-Type'] = content_type
5471
+ end
5472
+
5473
+ # form parameters
5474
+ form_params = opts[:form_params] || {}
5475
+
5476
+ # http body (model)
5477
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(phone_number_purchase_request)
5478
+
5479
+ # return_type
5480
+ return_type = opts[:debug_return_type] || 'ConversationPbxPhoneNumberResponse'
5481
+
5482
+ # auth_names
5483
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5484
+
5485
+ new_options = opts.merge(
5486
+ :operation => :"ConversationApi.purchase_pbx_phone_number",
5487
+ :header_params => header_params,
5488
+ :query_params => query_params,
5489
+ :form_params => form_params,
5490
+ :body => post_body,
5491
+ :auth_names => auth_names,
5492
+ :return_type => return_type
5493
+ )
5494
+
5495
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5496
+ if @api_client.config.debugging
5497
+ @api_client.config.logger.debug "API called: ConversationApi#purchase_pbx_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5498
+ end
5499
+ return data, status_code, headers
5500
+ end
5501
+
5050
5502
  # reset statistics within the queue
5051
5503
  # reset statistics within the queue
5052
5504
  # @param queue_uuid [String]
@@ -5180,6 +5632,89 @@ module UltracartClient
5180
5632
  return data, status_code, headers
5181
5633
  end
5182
5634
 
5635
+ # Search for available phone numbers
5636
+ # Search for available phone numbers from Twilio that can be purchased
5637
+ # @param country [String] ISO country code (e.g., US, CA, GB)
5638
+ # @param [Hash] opts the optional parameters
5639
+ # @option opts [String] :area_code Area code filter (e.g., 614)
5640
+ # @option opts [String] :contains Pattern to match (e.g., 555, *PIZZA)
5641
+ # @option opts [Boolean] :sms_enabled Filter for SMS capability
5642
+ # @option opts [Boolean] :voice_enabled Filter for voice capability
5643
+ # @option opts [String] :type Phone number type
5644
+ # @option opts [Integer] :limit Max results (default 20, max 100)
5645
+ # @return [ConversationPbxAvailablePhoneNumbersResponse]
5646
+ def search_pbx_available_phone_numbers(country, opts = {})
5647
+ data, _status_code, _headers = search_pbx_available_phone_numbers_with_http_info(country, opts)
5648
+ data
5649
+ end
5650
+
5651
+ # Search for available phone numbers
5652
+ # Search for available phone numbers from Twilio that can be purchased
5653
+ # @param country [String] ISO country code (e.g., US, CA, GB)
5654
+ # @param [Hash] opts the optional parameters
5655
+ # @option opts [String] :area_code Area code filter (e.g., 614)
5656
+ # @option opts [String] :contains Pattern to match (e.g., 555, *PIZZA)
5657
+ # @option opts [Boolean] :sms_enabled Filter for SMS capability
5658
+ # @option opts [Boolean] :voice_enabled Filter for voice capability
5659
+ # @option opts [String] :type Phone number type
5660
+ # @option opts [Integer] :limit Max results (default 20, max 100)
5661
+ # @return [Array<(ConversationPbxAvailablePhoneNumbersResponse, Integer, Hash)>] ConversationPbxAvailablePhoneNumbersResponse data, response status code and response headers
5662
+ def search_pbx_available_phone_numbers_with_http_info(country, opts = {})
5663
+ if @api_client.config.debugging
5664
+ @api_client.config.logger.debug 'Calling API: ConversationApi.search_pbx_available_phone_numbers ...'
5665
+ end
5666
+ # verify the required parameter 'country' is set
5667
+ if @api_client.config.client_side_validation && country.nil?
5668
+ fail ArgumentError, "Missing the required parameter 'country' when calling ConversationApi.search_pbx_available_phone_numbers"
5669
+ end
5670
+ # resource path
5671
+ local_var_path = '/conversation/pbx/phone_number/search'
5672
+
5673
+ # query parameters
5674
+ query_params = opts[:query_params] || {}
5675
+ query_params[:'country'] = country
5676
+ query_params[:'area_code'] = opts[:'area_code'] if !opts[:'area_code'].nil?
5677
+ query_params[:'contains'] = opts[:'contains'] if !opts[:'contains'].nil?
5678
+ query_params[:'sms_enabled'] = opts[:'sms_enabled'] if !opts[:'sms_enabled'].nil?
5679
+ query_params[:'voice_enabled'] = opts[:'voice_enabled'] if !opts[:'voice_enabled'].nil?
5680
+ query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
5681
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
5682
+
5683
+ # header parameters
5684
+ header_params = opts[:header_params] || {}
5685
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
5686
+ # HTTP header 'Accept' (if needed)
5687
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5688
+
5689
+ # form parameters
5690
+ form_params = opts[:form_params] || {}
5691
+
5692
+ # http body (model)
5693
+ post_body = opts[:debug_body]
5694
+
5695
+ # return_type
5696
+ return_type = opts[:debug_return_type] || 'ConversationPbxAvailablePhoneNumbersResponse'
5697
+
5698
+ # auth_names
5699
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
5700
+
5701
+ new_options = opts.merge(
5702
+ :operation => :"ConversationApi.search_pbx_available_phone_numbers",
5703
+ :header_params => header_params,
5704
+ :query_params => query_params,
5705
+ :form_params => form_params,
5706
+ :body => post_body,
5707
+ :auth_names => auth_names,
5708
+ :return_type => return_type
5709
+ )
5710
+
5711
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
5712
+ if @api_client.config.debugging
5713
+ @api_client.config.logger.debug "API called: ConversationApi#search_pbx_available_phone_numbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5714
+ end
5715
+ return data, status_code, headers
5716
+ end
5717
+
5183
5718
  # Unsubscribe any SMS participants in this conversation
5184
5719
  # Unsubscribe any SMS participants in this conversation
5185
5720
  # @param conversation_uuid [String]
@@ -5763,6 +6298,81 @@ module UltracartClient
5763
6298
  return data, status_code, headers
5764
6299
  end
5765
6300
 
6301
+ # Update pbx address
6302
+ # Update a pbx address
6303
+ # @param conversation_pbx_address_uuid [String]
6304
+ # @param pbx_address [ConversationPbxAddress] Pbx Address
6305
+ # @param [Hash] opts the optional parameters
6306
+ # @return [ConversationPbxAddressResponse]
6307
+ def update_pbx_address(conversation_pbx_address_uuid, pbx_address, opts = {})
6308
+ data, _status_code, _headers = update_pbx_address_with_http_info(conversation_pbx_address_uuid, pbx_address, opts)
6309
+ data
6310
+ end
6311
+
6312
+ # Update pbx address
6313
+ # Update a pbx address
6314
+ # @param conversation_pbx_address_uuid [String]
6315
+ # @param pbx_address [ConversationPbxAddress] Pbx Address
6316
+ # @param [Hash] opts the optional parameters
6317
+ # @return [Array<(ConversationPbxAddressResponse, Integer, Hash)>] ConversationPbxAddressResponse data, response status code and response headers
6318
+ def update_pbx_address_with_http_info(conversation_pbx_address_uuid, pbx_address, opts = {})
6319
+ if @api_client.config.debugging
6320
+ @api_client.config.logger.debug 'Calling API: ConversationApi.update_pbx_address ...'
6321
+ end
6322
+ # verify the required parameter 'conversation_pbx_address_uuid' is set
6323
+ if @api_client.config.client_side_validation && conversation_pbx_address_uuid.nil?
6324
+ fail ArgumentError, "Missing the required parameter 'conversation_pbx_address_uuid' when calling ConversationApi.update_pbx_address"
6325
+ end
6326
+ # verify the required parameter 'pbx_address' is set
6327
+ if @api_client.config.client_side_validation && pbx_address.nil?
6328
+ fail ArgumentError, "Missing the required parameter 'pbx_address' when calling ConversationApi.update_pbx_address"
6329
+ end
6330
+ # resource path
6331
+ local_var_path = '/conversation/pbx/address/{conversationPbxAddressUuid}'.sub('{' + 'conversationPbxAddressUuid' + '}', CGI.escape(conversation_pbx_address_uuid.to_s))
6332
+
6333
+ # query parameters
6334
+ query_params = opts[:query_params] || {}
6335
+
6336
+ # header parameters
6337
+ header_params = opts[:header_params] || {}
6338
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
6339
+ # HTTP header 'Accept' (if needed)
6340
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6341
+ # HTTP header 'Content-Type'
6342
+ content_type = @api_client.select_header_content_type(['application/json'])
6343
+ if !content_type.nil?
6344
+ header_params['Content-Type'] = content_type
6345
+ end
6346
+
6347
+ # form parameters
6348
+ form_params = opts[:form_params] || {}
6349
+
6350
+ # http body (model)
6351
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(pbx_address)
6352
+
6353
+ # return_type
6354
+ return_type = opts[:debug_return_type] || 'ConversationPbxAddressResponse'
6355
+
6356
+ # auth_names
6357
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
6358
+
6359
+ new_options = opts.merge(
6360
+ :operation => :"ConversationApi.update_pbx_address",
6361
+ :header_params => header_params,
6362
+ :query_params => query_params,
6363
+ :form_params => form_params,
6364
+ :body => post_body,
6365
+ :auth_names => auth_names,
6366
+ :return_type => return_type
6367
+ )
6368
+
6369
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
6370
+ if @api_client.config.debugging
6371
+ @api_client.config.logger.debug "API called: ConversationApi#update_pbx_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6372
+ end
6373
+ return data, status_code, headers
6374
+ end
6375
+
5766
6376
  # Update pbx agent
5767
6377
  # Update a pbx agent
5768
6378
  # @param conversation_pbx_agent_uuid [String]