ultracart-rest-sdk 4.1.10__py3-none-any.whl → 4.1.12__py3-none-any.whl

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.
ultracart/__init__.py CHANGED
@@ -11,7 +11,7 @@
11
11
  """
12
12
 
13
13
 
14
- __version__ = "4.1.10"
14
+ __version__ = "4.1.12"
15
15
 
16
16
  # import ApiClient
17
17
  from ultracart.api_client import ApiClient
@@ -79,6 +79,10 @@ from ultracart.model.conversation_search_request import ConversationSearchReques
79
79
  from ultracart.model.conversation_search_response import ConversationSearchResponse
80
80
  from ultracart.model.conversation_start_request import ConversationStartRequest
81
81
  from ultracart.model.conversation_start_response import ConversationStartResponse
82
+ from ultracart.model.conversation_virtual_agent_budget import ConversationVirtualAgentBudget
83
+ from ultracart.model.conversation_virtual_agent_budget_response import ConversationVirtualAgentBudgetResponse
84
+ from ultracart.model.conversation_virtual_agent_capabilities import ConversationVirtualAgentCapabilities
85
+ from ultracart.model.conversation_virtual_agent_capabilities_response import ConversationVirtualAgentCapabilitiesResponse
82
86
  from ultracart.model.conversation_webchat_context import ConversationWebchatContext
83
87
  from ultracart.model.conversation_webchat_queue_status_update_request import ConversationWebchatQueueStatusUpdateRequest
84
88
  from ultracart.model.conversation_webchat_queue_statuses_response import ConversationWebchatQueueStatusesResponse
@@ -2768,6 +2772,96 @@ class ConversationApi(object):
2768
2772
  },
2769
2773
  api_client=api_client
2770
2774
  )
2775
+ self.get_virtual_agent_budget_endpoint = _Endpoint(
2776
+ settings={
2777
+ 'response_type': (ConversationVirtualAgentBudgetResponse,),
2778
+ 'auth': [
2779
+ 'ultraCartOauth',
2780
+ 'ultraCartSimpleApiKey'
2781
+ ],
2782
+ 'endpoint_path': '/conversation/virtualagent/budget',
2783
+ 'operation_id': 'get_virtual_agent_budget',
2784
+ 'http_method': 'GET',
2785
+ 'servers': None,
2786
+ },
2787
+ params_map={
2788
+ 'all': [
2789
+ ],
2790
+ 'required': [],
2791
+ 'nullable': [
2792
+ ],
2793
+ 'enum': [
2794
+ ],
2795
+ 'validation': [
2796
+ ]
2797
+ },
2798
+ root_map={
2799
+ 'validations': {
2800
+ },
2801
+ 'allowed_values': {
2802
+ },
2803
+ 'openapi_types': {
2804
+ },
2805
+ 'attribute_map': {
2806
+ },
2807
+ 'location_map': {
2808
+ },
2809
+ 'collection_format_map': {
2810
+ }
2811
+ },
2812
+ headers_map={
2813
+ 'accept': [
2814
+ 'application/json'
2815
+ ],
2816
+ 'content_type': [],
2817
+ },
2818
+ api_client=api_client
2819
+ )
2820
+ self.get_virtual_agent_capabilities_endpoint = _Endpoint(
2821
+ settings={
2822
+ 'response_type': (ConversationVirtualAgentCapabilitiesResponse,),
2823
+ 'auth': [
2824
+ 'ultraCartOauth',
2825
+ 'ultraCartSimpleApiKey'
2826
+ ],
2827
+ 'endpoint_path': '/conversation/virtualagent/capabilities',
2828
+ 'operation_id': 'get_virtual_agent_capabilities',
2829
+ 'http_method': 'GET',
2830
+ 'servers': None,
2831
+ },
2832
+ params_map={
2833
+ 'all': [
2834
+ ],
2835
+ 'required': [],
2836
+ 'nullable': [
2837
+ ],
2838
+ 'enum': [
2839
+ ],
2840
+ 'validation': [
2841
+ ]
2842
+ },
2843
+ root_map={
2844
+ 'validations': {
2845
+ },
2846
+ 'allowed_values': {
2847
+ },
2848
+ 'openapi_types': {
2849
+ },
2850
+ 'attribute_map': {
2851
+ },
2852
+ 'location_map': {
2853
+ },
2854
+ 'collection_format_map': {
2855
+ }
2856
+ },
2857
+ headers_map={
2858
+ 'accept': [
2859
+ 'application/json'
2860
+ ],
2861
+ 'content_type': [],
2862
+ },
2863
+ api_client=api_client
2864
+ )
2771
2865
  self.insert_conversation_canned_message_endpoint = _Endpoint(
2772
2866
  settings={
2773
2867
  'response_type': (ConversationCannedMessageResponse,),
@@ -4488,6 +4582,112 @@ class ConversationApi(object):
4488
4582
  },
4489
4583
  api_client=api_client
4490
4584
  )
4585
+ self.update_virtual_agent_budget_endpoint = _Endpoint(
4586
+ settings={
4587
+ 'response_type': (ConversationVirtualAgentBudgetResponse,),
4588
+ 'auth': [
4589
+ 'ultraCartOauth',
4590
+ 'ultraCartSimpleApiKey'
4591
+ ],
4592
+ 'endpoint_path': '/conversation/virtualagent/budget',
4593
+ 'operation_id': 'update_virtual_agent_budget',
4594
+ 'http_method': 'PUT',
4595
+ 'servers': None,
4596
+ },
4597
+ params_map={
4598
+ 'all': [
4599
+ 'virtual_agent_budget',
4600
+ ],
4601
+ 'required': [
4602
+ 'virtual_agent_budget',
4603
+ ],
4604
+ 'nullable': [
4605
+ ],
4606
+ 'enum': [
4607
+ ],
4608
+ 'validation': [
4609
+ ]
4610
+ },
4611
+ root_map={
4612
+ 'validations': {
4613
+ },
4614
+ 'allowed_values': {
4615
+ },
4616
+ 'openapi_types': {
4617
+ 'virtual_agent_budget':
4618
+ (ConversationVirtualAgentBudget,),
4619
+ },
4620
+ 'attribute_map': {
4621
+ },
4622
+ 'location_map': {
4623
+ 'virtual_agent_budget': 'body',
4624
+ },
4625
+ 'collection_format_map': {
4626
+ }
4627
+ },
4628
+ headers_map={
4629
+ 'accept': [
4630
+ 'application/json'
4631
+ ],
4632
+ 'content_type': [
4633
+ 'application/json'
4634
+ ]
4635
+ },
4636
+ api_client=api_client
4637
+ )
4638
+ self.update_virtual_agent_capabilities_endpoint = _Endpoint(
4639
+ settings={
4640
+ 'response_type': (ConversationVirtualAgentCapabilitiesResponse,),
4641
+ 'auth': [
4642
+ 'ultraCartOauth',
4643
+ 'ultraCartSimpleApiKey'
4644
+ ],
4645
+ 'endpoint_path': '/conversation/virtualagent/capabilities',
4646
+ 'operation_id': 'update_virtual_agent_capabilities',
4647
+ 'http_method': 'PUT',
4648
+ 'servers': None,
4649
+ },
4650
+ params_map={
4651
+ 'all': [
4652
+ 'virtual_agent_capabilities',
4653
+ ],
4654
+ 'required': [
4655
+ 'virtual_agent_capabilities',
4656
+ ],
4657
+ 'nullable': [
4658
+ ],
4659
+ 'enum': [
4660
+ ],
4661
+ 'validation': [
4662
+ ]
4663
+ },
4664
+ root_map={
4665
+ 'validations': {
4666
+ },
4667
+ 'allowed_values': {
4668
+ },
4669
+ 'openapi_types': {
4670
+ 'virtual_agent_capabilities':
4671
+ (ConversationVirtualAgentCapabilities,),
4672
+ },
4673
+ 'attribute_map': {
4674
+ },
4675
+ 'location_map': {
4676
+ 'virtual_agent_capabilities': 'body',
4677
+ },
4678
+ 'collection_format_map': {
4679
+ }
4680
+ },
4681
+ headers_map={
4682
+ 'accept': [
4683
+ 'application/json'
4684
+ ],
4685
+ 'content_type': [
4686
+ 'application/json'
4687
+ ]
4688
+ },
4689
+ api_client=api_client
4690
+ )
4491
4691
 
4492
4692
  def delete_conversation_canned_message(
4493
4693
  self,
@@ -8801,6 +9001,162 @@ class ConversationApi(object):
8801
9001
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
8802
9002
  return self.get_pbx_voicemail_mailboxes_endpoint.call_with_http_info(**kwargs)
8803
9003
 
9004
+ def get_virtual_agent_budget(
9005
+ self,
9006
+ **kwargs
9007
+ ):
9008
+ """Get virtual agent budget # noqa: E501
9009
+
9010
+ Retrieve virtual agent budget # noqa: E501
9011
+ This method makes a synchronous HTTP request by default. To make an
9012
+ asynchronous HTTP request, please pass async_req=True
9013
+
9014
+ >>> thread = api.get_virtual_agent_budget(async_req=True)
9015
+ >>> result = thread.get()
9016
+
9017
+
9018
+ Keyword Args:
9019
+ _return_http_data_only (bool): response data without head status
9020
+ code and headers. Default is True.
9021
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
9022
+ will be returned without reading/decoding response data.
9023
+ Default is True.
9024
+ _request_timeout (int/float/tuple): timeout setting for this request. If
9025
+ one number provided, it will be total request timeout. It can also
9026
+ be a pair (tuple) of (connection, read) timeouts.
9027
+ Default is None.
9028
+ _check_input_type (bool): specifies if type checking
9029
+ should be done one the data sent to the server.
9030
+ Default is True.
9031
+ _check_return_type (bool): specifies if type checking
9032
+ should be done one the data received from the server.
9033
+ Default is True.
9034
+ _spec_property_naming (bool): True if the variable names in the input data
9035
+ are serialized names, as specified in the OpenAPI document.
9036
+ False if the variable names in the input data
9037
+ are pythonic names, e.g. snake case (default)
9038
+ _content_type (str/None): force body content-type.
9039
+ Default is None and content-type will be predicted by allowed
9040
+ content-types and body.
9041
+ _host_index (int/None): specifies the index of the server
9042
+ that we want to use.
9043
+ Default is read from the configuration.
9044
+ _request_auths (list): set to override the auth_settings for an a single
9045
+ request; this effectively ignores the authentication
9046
+ in the spec for a single request.
9047
+ Default is None
9048
+ async_req (bool): execute request asynchronously
9049
+
9050
+ Returns:
9051
+ ConversationVirtualAgentBudgetResponse
9052
+ If the method is called asynchronously, returns the request
9053
+ thread.
9054
+ """
9055
+ kwargs['async_req'] = kwargs.get(
9056
+ 'async_req', False
9057
+ )
9058
+ kwargs['_return_http_data_only'] = kwargs.get(
9059
+ '_return_http_data_only', True
9060
+ )
9061
+ kwargs['_preload_content'] = kwargs.get(
9062
+ '_preload_content', True
9063
+ )
9064
+ kwargs['_request_timeout'] = kwargs.get(
9065
+ '_request_timeout', None
9066
+ )
9067
+ kwargs['_check_input_type'] = kwargs.get(
9068
+ '_check_input_type', True
9069
+ )
9070
+ kwargs['_check_return_type'] = kwargs.get(
9071
+ '_check_return_type', True
9072
+ )
9073
+ kwargs['_spec_property_naming'] = kwargs.get(
9074
+ '_spec_property_naming', False
9075
+ )
9076
+ kwargs['_content_type'] = kwargs.get(
9077
+ '_content_type')
9078
+ kwargs['_host_index'] = kwargs.get('_host_index')
9079
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
9080
+ return self.get_virtual_agent_budget_endpoint.call_with_http_info(**kwargs)
9081
+
9082
+ def get_virtual_agent_capabilities(
9083
+ self,
9084
+ **kwargs
9085
+ ):
9086
+ """Get virtual agent capabilities # noqa: E501
9087
+
9088
+ Retrieve virtual agent capabilities # noqa: E501
9089
+ This method makes a synchronous HTTP request by default. To make an
9090
+ asynchronous HTTP request, please pass async_req=True
9091
+
9092
+ >>> thread = api.get_virtual_agent_capabilities(async_req=True)
9093
+ >>> result = thread.get()
9094
+
9095
+
9096
+ Keyword Args:
9097
+ _return_http_data_only (bool): response data without head status
9098
+ code and headers. Default is True.
9099
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
9100
+ will be returned without reading/decoding response data.
9101
+ Default is True.
9102
+ _request_timeout (int/float/tuple): timeout setting for this request. If
9103
+ one number provided, it will be total request timeout. It can also
9104
+ be a pair (tuple) of (connection, read) timeouts.
9105
+ Default is None.
9106
+ _check_input_type (bool): specifies if type checking
9107
+ should be done one the data sent to the server.
9108
+ Default is True.
9109
+ _check_return_type (bool): specifies if type checking
9110
+ should be done one the data received from the server.
9111
+ Default is True.
9112
+ _spec_property_naming (bool): True if the variable names in the input data
9113
+ are serialized names, as specified in the OpenAPI document.
9114
+ False if the variable names in the input data
9115
+ are pythonic names, e.g. snake case (default)
9116
+ _content_type (str/None): force body content-type.
9117
+ Default is None and content-type will be predicted by allowed
9118
+ content-types and body.
9119
+ _host_index (int/None): specifies the index of the server
9120
+ that we want to use.
9121
+ Default is read from the configuration.
9122
+ _request_auths (list): set to override the auth_settings for an a single
9123
+ request; this effectively ignores the authentication
9124
+ in the spec for a single request.
9125
+ Default is None
9126
+ async_req (bool): execute request asynchronously
9127
+
9128
+ Returns:
9129
+ ConversationVirtualAgentCapabilitiesResponse
9130
+ If the method is called asynchronously, returns the request
9131
+ thread.
9132
+ """
9133
+ kwargs['async_req'] = kwargs.get(
9134
+ 'async_req', False
9135
+ )
9136
+ kwargs['_return_http_data_only'] = kwargs.get(
9137
+ '_return_http_data_only', True
9138
+ )
9139
+ kwargs['_preload_content'] = kwargs.get(
9140
+ '_preload_content', True
9141
+ )
9142
+ kwargs['_request_timeout'] = kwargs.get(
9143
+ '_request_timeout', None
9144
+ )
9145
+ kwargs['_check_input_type'] = kwargs.get(
9146
+ '_check_input_type', True
9147
+ )
9148
+ kwargs['_check_return_type'] = kwargs.get(
9149
+ '_check_return_type', True
9150
+ )
9151
+ kwargs['_spec_property_naming'] = kwargs.get(
9152
+ '_spec_property_naming', False
9153
+ )
9154
+ kwargs['_content_type'] = kwargs.get(
9155
+ '_content_type')
9156
+ kwargs['_host_index'] = kwargs.get('_host_index')
9157
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
9158
+ return self.get_virtual_agent_capabilities_endpoint.call_with_http_info(**kwargs)
9159
+
8804
9160
  def insert_conversation_canned_message(
8805
9161
  self,
8806
9162
  canned_message,
@@ -11427,3 +11783,169 @@ class ConversationApi(object):
11427
11783
  pbx_voicemail_mailbox
11428
11784
  return self.update_pbx_voicemail_mailbox_endpoint.call_with_http_info(**kwargs)
11429
11785
 
11786
+ def update_virtual_agent_budget(
11787
+ self,
11788
+ virtual_agent_budget,
11789
+ **kwargs
11790
+ ):
11791
+ """Update virtual agent budget # noqa: E501
11792
+
11793
+ Update virtual agent budget # noqa: E501
11794
+ This method makes a synchronous HTTP request by default. To make an
11795
+ asynchronous HTTP request, please pass async_req=True
11796
+
11797
+ >>> thread = api.update_virtual_agent_budget(virtual_agent_budget, async_req=True)
11798
+ >>> result = thread.get()
11799
+
11800
+ Args:
11801
+ virtual_agent_budget (ConversationVirtualAgentBudget): Virtual Agent Budget
11802
+
11803
+ Keyword Args:
11804
+ _return_http_data_only (bool): response data without head status
11805
+ code and headers. Default is True.
11806
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
11807
+ will be returned without reading/decoding response data.
11808
+ Default is True.
11809
+ _request_timeout (int/float/tuple): timeout setting for this request. If
11810
+ one number provided, it will be total request timeout. It can also
11811
+ be a pair (tuple) of (connection, read) timeouts.
11812
+ Default is None.
11813
+ _check_input_type (bool): specifies if type checking
11814
+ should be done one the data sent to the server.
11815
+ Default is True.
11816
+ _check_return_type (bool): specifies if type checking
11817
+ should be done one the data received from the server.
11818
+ Default is True.
11819
+ _spec_property_naming (bool): True if the variable names in the input data
11820
+ are serialized names, as specified in the OpenAPI document.
11821
+ False if the variable names in the input data
11822
+ are pythonic names, e.g. snake case (default)
11823
+ _content_type (str/None): force body content-type.
11824
+ Default is None and content-type will be predicted by allowed
11825
+ content-types and body.
11826
+ _host_index (int/None): specifies the index of the server
11827
+ that we want to use.
11828
+ Default is read from the configuration.
11829
+ _request_auths (list): set to override the auth_settings for an a single
11830
+ request; this effectively ignores the authentication
11831
+ in the spec for a single request.
11832
+ Default is None
11833
+ async_req (bool): execute request asynchronously
11834
+
11835
+ Returns:
11836
+ ConversationVirtualAgentBudgetResponse
11837
+ If the method is called asynchronously, returns the request
11838
+ thread.
11839
+ """
11840
+ kwargs['async_req'] = kwargs.get(
11841
+ 'async_req', False
11842
+ )
11843
+ kwargs['_return_http_data_only'] = kwargs.get(
11844
+ '_return_http_data_only', True
11845
+ )
11846
+ kwargs['_preload_content'] = kwargs.get(
11847
+ '_preload_content', True
11848
+ )
11849
+ kwargs['_request_timeout'] = kwargs.get(
11850
+ '_request_timeout', None
11851
+ )
11852
+ kwargs['_check_input_type'] = kwargs.get(
11853
+ '_check_input_type', True
11854
+ )
11855
+ kwargs['_check_return_type'] = kwargs.get(
11856
+ '_check_return_type', True
11857
+ )
11858
+ kwargs['_spec_property_naming'] = kwargs.get(
11859
+ '_spec_property_naming', False
11860
+ )
11861
+ kwargs['_content_type'] = kwargs.get(
11862
+ '_content_type')
11863
+ kwargs['_host_index'] = kwargs.get('_host_index')
11864
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
11865
+ kwargs['virtual_agent_budget'] = \
11866
+ virtual_agent_budget
11867
+ return self.update_virtual_agent_budget_endpoint.call_with_http_info(**kwargs)
11868
+
11869
+ def update_virtual_agent_capabilities(
11870
+ self,
11871
+ virtual_agent_capabilities,
11872
+ **kwargs
11873
+ ):
11874
+ """Update virtual agent capabilities # noqa: E501
11875
+
11876
+ Update virtual agent capabilities # noqa: E501
11877
+ This method makes a synchronous HTTP request by default. To make an
11878
+ asynchronous HTTP request, please pass async_req=True
11879
+
11880
+ >>> thread = api.update_virtual_agent_capabilities(virtual_agent_capabilities, async_req=True)
11881
+ >>> result = thread.get()
11882
+
11883
+ Args:
11884
+ virtual_agent_capabilities (ConversationVirtualAgentCapabilities): Virtual Agent Capabilities
11885
+
11886
+ Keyword Args:
11887
+ _return_http_data_only (bool): response data without head status
11888
+ code and headers. Default is True.
11889
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
11890
+ will be returned without reading/decoding response data.
11891
+ Default is True.
11892
+ _request_timeout (int/float/tuple): timeout setting for this request. If
11893
+ one number provided, it will be total request timeout. It can also
11894
+ be a pair (tuple) of (connection, read) timeouts.
11895
+ Default is None.
11896
+ _check_input_type (bool): specifies if type checking
11897
+ should be done one the data sent to the server.
11898
+ Default is True.
11899
+ _check_return_type (bool): specifies if type checking
11900
+ should be done one the data received from the server.
11901
+ Default is True.
11902
+ _spec_property_naming (bool): True if the variable names in the input data
11903
+ are serialized names, as specified in the OpenAPI document.
11904
+ False if the variable names in the input data
11905
+ are pythonic names, e.g. snake case (default)
11906
+ _content_type (str/None): force body content-type.
11907
+ Default is None and content-type will be predicted by allowed
11908
+ content-types and body.
11909
+ _host_index (int/None): specifies the index of the server
11910
+ that we want to use.
11911
+ Default is read from the configuration.
11912
+ _request_auths (list): set to override the auth_settings for an a single
11913
+ request; this effectively ignores the authentication
11914
+ in the spec for a single request.
11915
+ Default is None
11916
+ async_req (bool): execute request asynchronously
11917
+
11918
+ Returns:
11919
+ ConversationVirtualAgentCapabilitiesResponse
11920
+ If the method is called asynchronously, returns the request
11921
+ thread.
11922
+ """
11923
+ kwargs['async_req'] = kwargs.get(
11924
+ 'async_req', False
11925
+ )
11926
+ kwargs['_return_http_data_only'] = kwargs.get(
11927
+ '_return_http_data_only', True
11928
+ )
11929
+ kwargs['_preload_content'] = kwargs.get(
11930
+ '_preload_content', True
11931
+ )
11932
+ kwargs['_request_timeout'] = kwargs.get(
11933
+ '_request_timeout', None
11934
+ )
11935
+ kwargs['_check_input_type'] = kwargs.get(
11936
+ '_check_input_type', True
11937
+ )
11938
+ kwargs['_check_return_type'] = kwargs.get(
11939
+ '_check_return_type', True
11940
+ )
11941
+ kwargs['_spec_property_naming'] = kwargs.get(
11942
+ '_spec_property_naming', False
11943
+ )
11944
+ kwargs['_content_type'] = kwargs.get(
11945
+ '_content_type')
11946
+ kwargs['_host_index'] = kwargs.get('_host_index')
11947
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
11948
+ kwargs['virtual_agent_capabilities'] = \
11949
+ virtual_agent_capabilities
11950
+ return self.update_virtual_agent_capabilities_endpoint.call_with_http_info(**kwargs)
11951
+
ultracart/api_client.py CHANGED
@@ -77,7 +77,7 @@ class ApiClient(object):
77
77
  self.default_headers[header_name] = header_value
78
78
  self.cookie = cookie
79
79
  # Set default User-Agent.
80
- self.user_agent = 'OpenAPI-Generator/4.1.10/python'
80
+ self.user_agent = 'OpenAPI-Generator/4.1.12/python'
81
81
 
82
82
  def __enter__(self):
83
83
  return self
@@ -422,7 +422,7 @@ conf = ultracart.Configuration(
422
422
  "OS: {env}\n"\
423
423
  "Python Version: {pyversion}\n"\
424
424
  "Version of the API: 2.0.0\n"\
425
- "SDK Package Version: 4.1.10".\
425
+ "SDK Package Version: 4.1.12".\
426
426
  format(env=sys.platform, pyversion=sys.version)
427
427
 
428
428
  def get_host_settings(self):