ultracart-rest-sdk 4.1.27__py3-none-any.whl → 4.1.39__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 +1 -1
- ultracart/api/conversation_api.py +945 -69
- ultracart/api/customer_api.py +171 -0
- ultracart/api/item_api.py +452 -0
- ultracart/api/order_api.py +153 -0
- ultracart/api_client.py +1 -1
- ultracart/configuration.py +1 -1
- ultracart/model/conversation_agent_auth.py +4 -0
- ultracart/model/conversation_agent_profile.py +22 -0
- ultracart/model/conversation_mcp_server.py +297 -0
- ultracart/model/conversation_mcp_server_response.py +292 -0
- ultracart/model/conversation_mcp_server_tools_response.py +290 -0
- ultracart/model/conversation_mcp_servers_response.py +292 -0
- ultracart/model/conversation_message.py +4 -0
- ultracart/model/conversation_pbx_agent.py +4 -0
- ultracart/model/conversation_pbx_queue.py +13 -0
- ultracart/model/conversation_virtual_agent_capabilities.py +4 -0
- ultracart/model/coupon_free_item_with_item_purchase_and_free_shipping.py +4 -0
- ultracart/model/coupon_percent_off_items_and_free_shipping.py +4 -0
- ultracart/model/customer_query.py +8 -0
- ultracart/model/email_commseq_email.py +12 -0
- ultracart/model/item_inventory_update.py +272 -0
- ultracart/model/item_inventory_update_request.py +270 -0
- ultracart/model/item_related_item.py +2 -0
- ultracart/model/item_shipping.py +4 -0
- ultracart/model/item_shipping_distribution_center_response.py +292 -0
- ultracart/model/order_assign_to_affiliate_request.py +275 -0
- ultracart/models/__init__.py +8 -0
- {ultracart_rest_sdk-4.1.27.dist-info → ultracart_rest_sdk-4.1.39.dist-info}/METADATA +1 -1
- {ultracart_rest_sdk-4.1.27.dist-info → ultracart_rest_sdk-4.1.39.dist-info}/RECORD +33 -25
- {ultracart_rest_sdk-4.1.27.dist-info → ultracart_rest_sdk-4.1.39.dist-info}/LICENSE +0 -0
- {ultracart_rest_sdk-4.1.27.dist-info → ultracart_rest_sdk-4.1.39.dist-info}/WHEEL +0 -0
- {ultracart_rest_sdk-4.1.27.dist-info → ultracart_rest_sdk-4.1.39.dist-info}/top_level.txt +0 -0
ultracart/api/order_api.py
CHANGED
|
@@ -28,6 +28,7 @@ from ultracart.model.accounts_receivable_retry_stats_response import AccountsRec
|
|
|
28
28
|
from ultracart.model.base_response import BaseResponse
|
|
29
29
|
from ultracart.model.error_response import ErrorResponse
|
|
30
30
|
from ultracart.model.order import Order
|
|
31
|
+
from ultracart.model.order_assign_to_affiliate_request import OrderAssignToAffiliateRequest
|
|
31
32
|
from ultracart.model.order_by_token_query import OrderByTokenQuery
|
|
32
33
|
from ultracart.model.order_edi_documents_response import OrderEdiDocumentsResponse
|
|
33
34
|
from ultracart.model.order_format import OrderFormat
|
|
@@ -129,6 +130,70 @@ class OrderApi(object):
|
|
|
129
130
|
},
|
|
130
131
|
api_client=api_client
|
|
131
132
|
)
|
|
133
|
+
self.assign_to_affiliate_endpoint = _Endpoint(
|
|
134
|
+
settings={
|
|
135
|
+
'response_type': (OrderResponse,),
|
|
136
|
+
'auth': [
|
|
137
|
+
'ultraCartOauth',
|
|
138
|
+
'ultraCartSimpleApiKey'
|
|
139
|
+
],
|
|
140
|
+
'endpoint_path': '/order/orders/{order_id}/assignToAffiliate',
|
|
141
|
+
'operation_id': 'assign_to_affiliate',
|
|
142
|
+
'http_method': 'POST',
|
|
143
|
+
'servers': None,
|
|
144
|
+
},
|
|
145
|
+
params_map={
|
|
146
|
+
'all': [
|
|
147
|
+
'order_id',
|
|
148
|
+
'assign_to_affiliate_request',
|
|
149
|
+
'expand',
|
|
150
|
+
],
|
|
151
|
+
'required': [
|
|
152
|
+
'order_id',
|
|
153
|
+
'assign_to_affiliate_request',
|
|
154
|
+
],
|
|
155
|
+
'nullable': [
|
|
156
|
+
],
|
|
157
|
+
'enum': [
|
|
158
|
+
],
|
|
159
|
+
'validation': [
|
|
160
|
+
]
|
|
161
|
+
},
|
|
162
|
+
root_map={
|
|
163
|
+
'validations': {
|
|
164
|
+
},
|
|
165
|
+
'allowed_values': {
|
|
166
|
+
},
|
|
167
|
+
'openapi_types': {
|
|
168
|
+
'order_id':
|
|
169
|
+
(str,),
|
|
170
|
+
'assign_to_affiliate_request':
|
|
171
|
+
(OrderAssignToAffiliateRequest,),
|
|
172
|
+
'expand':
|
|
173
|
+
(str,),
|
|
174
|
+
},
|
|
175
|
+
'attribute_map': {
|
|
176
|
+
'order_id': 'order_id',
|
|
177
|
+
'expand': '_expand',
|
|
178
|
+
},
|
|
179
|
+
'location_map': {
|
|
180
|
+
'order_id': 'path',
|
|
181
|
+
'assign_to_affiliate_request': 'body',
|
|
182
|
+
'expand': 'query',
|
|
183
|
+
},
|
|
184
|
+
'collection_format_map': {
|
|
185
|
+
}
|
|
186
|
+
},
|
|
187
|
+
headers_map={
|
|
188
|
+
'accept': [
|
|
189
|
+
'application/json'
|
|
190
|
+
],
|
|
191
|
+
'content_type': [
|
|
192
|
+
'application/json'
|
|
193
|
+
]
|
|
194
|
+
},
|
|
195
|
+
api_client=api_client
|
|
196
|
+
)
|
|
132
197
|
self.block_refund_on_order_endpoint = _Endpoint(
|
|
133
198
|
settings={
|
|
134
199
|
'response_type': None,
|
|
@@ -2033,6 +2098,94 @@ class OrderApi(object):
|
|
|
2033
2098
|
desired_total
|
|
2034
2099
|
return self.adjust_order_total_endpoint.call_with_http_info(**kwargs)
|
|
2035
2100
|
|
|
2101
|
+
def assign_to_affiliate(
|
|
2102
|
+
self,
|
|
2103
|
+
order_id,
|
|
2104
|
+
assign_to_affiliate_request,
|
|
2105
|
+
**kwargs
|
|
2106
|
+
):
|
|
2107
|
+
"""Assigns an order to an affiliate # noqa: E501
|
|
2108
|
+
|
|
2109
|
+
Assigns an order to an affiliate. # noqa: E501
|
|
2110
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2111
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2112
|
+
|
|
2113
|
+
>>> thread = api.assign_to_affiliate(order_id, assign_to_affiliate_request, async_req=True)
|
|
2114
|
+
>>> result = thread.get()
|
|
2115
|
+
|
|
2116
|
+
Args:
|
|
2117
|
+
order_id (str): The order id to assign to the affiliate.
|
|
2118
|
+
assign_to_affiliate_request (OrderAssignToAffiliateRequest): Assign to affiliate request
|
|
2119
|
+
|
|
2120
|
+
Keyword Args:
|
|
2121
|
+
expand (str): The object expansion to perform on the result. See documentation for examples. [optional]
|
|
2122
|
+
_return_http_data_only (bool): response data without head status
|
|
2123
|
+
code and headers. Default is True.
|
|
2124
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2125
|
+
will be returned without reading/decoding response data.
|
|
2126
|
+
Default is True.
|
|
2127
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2128
|
+
one number provided, it will be total request timeout. It can also
|
|
2129
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
2130
|
+
Default is None.
|
|
2131
|
+
_check_input_type (bool): specifies if type checking
|
|
2132
|
+
should be done one the data sent to the server.
|
|
2133
|
+
Default is True.
|
|
2134
|
+
_check_return_type (bool): specifies if type checking
|
|
2135
|
+
should be done one the data received from the server.
|
|
2136
|
+
Default is True.
|
|
2137
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
2138
|
+
are serialized names, as specified in the OpenAPI document.
|
|
2139
|
+
False if the variable names in the input data
|
|
2140
|
+
are pythonic names, e.g. snake case (default)
|
|
2141
|
+
_content_type (str/None): force body content-type.
|
|
2142
|
+
Default is None and content-type will be predicted by allowed
|
|
2143
|
+
content-types and body.
|
|
2144
|
+
_host_index (int/None): specifies the index of the server
|
|
2145
|
+
that we want to use.
|
|
2146
|
+
Default is read from the configuration.
|
|
2147
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
2148
|
+
request; this effectively ignores the authentication
|
|
2149
|
+
in the spec for a single request.
|
|
2150
|
+
Default is None
|
|
2151
|
+
async_req (bool): execute request asynchronously
|
|
2152
|
+
|
|
2153
|
+
Returns:
|
|
2154
|
+
OrderResponse
|
|
2155
|
+
If the method is called asynchronously, returns the request
|
|
2156
|
+
thread.
|
|
2157
|
+
"""
|
|
2158
|
+
kwargs['async_req'] = kwargs.get(
|
|
2159
|
+
'async_req', False
|
|
2160
|
+
)
|
|
2161
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2162
|
+
'_return_http_data_only', True
|
|
2163
|
+
)
|
|
2164
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
2165
|
+
'_preload_content', True
|
|
2166
|
+
)
|
|
2167
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
2168
|
+
'_request_timeout', None
|
|
2169
|
+
)
|
|
2170
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
2171
|
+
'_check_input_type', True
|
|
2172
|
+
)
|
|
2173
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
2174
|
+
'_check_return_type', True
|
|
2175
|
+
)
|
|
2176
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
2177
|
+
'_spec_property_naming', False
|
|
2178
|
+
)
|
|
2179
|
+
kwargs['_content_type'] = kwargs.get(
|
|
2180
|
+
'_content_type')
|
|
2181
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2182
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2183
|
+
kwargs['order_id'] = \
|
|
2184
|
+
order_id
|
|
2185
|
+
kwargs['assign_to_affiliate_request'] = \
|
|
2186
|
+
assign_to_affiliate_request
|
|
2187
|
+
return self.assign_to_affiliate_endpoint.call_with_http_info(**kwargs)
|
|
2188
|
+
|
|
2036
2189
|
def block_refund_on_order(
|
|
2037
2190
|
self,
|
|
2038
2191
|
order_id,
|
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.
|
|
80
|
+
self.user_agent = 'OpenAPI-Generator/4.1.39/python'
|
|
81
81
|
|
|
82
82
|
def __enter__(self):
|
|
83
83
|
return self
|
ultracart/configuration.py
CHANGED
|
@@ -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.
|
|
425
|
+
"SDK Package Version: 4.1.39".\
|
|
426
426
|
format(env=sys.platform, pyversion=sys.version)
|
|
427
427
|
|
|
428
428
|
def get_host_settings(self):
|
|
@@ -100,6 +100,7 @@ class ConversationAgentAuth(ModelNormal):
|
|
|
100
100
|
'pbx_voice_identity': (str,), # noqa: E501
|
|
101
101
|
'pbx_voice_token': (str,), # noqa: E501
|
|
102
102
|
'pbx_worker_token': (str,), # noqa: E501
|
|
103
|
+
'pbx_worker_token_v2': (str,), # noqa: E501
|
|
103
104
|
'twilio_accounts': ([ConversationTwilioAccount],), # noqa: E501
|
|
104
105
|
'user_id': (int,), # noqa: E501
|
|
105
106
|
'websocket_url': (str,), # noqa: E501
|
|
@@ -123,6 +124,7 @@ class ConversationAgentAuth(ModelNormal):
|
|
|
123
124
|
'pbx_voice_identity': 'pbx_voice_identity', # noqa: E501
|
|
124
125
|
'pbx_voice_token': 'pbx_voice_token', # noqa: E501
|
|
125
126
|
'pbx_worker_token': 'pbx_worker_token', # noqa: E501
|
|
127
|
+
'pbx_worker_token_v2': 'pbx_worker_token_v2', # noqa: E501
|
|
126
128
|
'twilio_accounts': 'twilio_accounts', # noqa: E501
|
|
127
129
|
'user_id': 'user_id', # noqa: E501
|
|
128
130
|
'websocket_url': 'websocket_url', # noqa: E501
|
|
@@ -181,6 +183,7 @@ class ConversationAgentAuth(ModelNormal):
|
|
|
181
183
|
pbx_voice_identity (str): [optional] # noqa: E501
|
|
182
184
|
pbx_voice_token (str): [optional] # noqa: E501
|
|
183
185
|
pbx_worker_token (str): [optional] # noqa: E501
|
|
186
|
+
pbx_worker_token_v2 (str): [optional] # noqa: E501
|
|
184
187
|
twilio_accounts ([ConversationTwilioAccount]): [optional] # noqa: E501
|
|
185
188
|
user_id (int): UltraCart User ID. [optional] # noqa: E501
|
|
186
189
|
websocket_url (str): [optional] # noqa: E501
|
|
@@ -281,6 +284,7 @@ class ConversationAgentAuth(ModelNormal):
|
|
|
281
284
|
pbx_voice_identity (str): [optional] # noqa: E501
|
|
282
285
|
pbx_voice_token (str): [optional] # noqa: E501
|
|
283
286
|
pbx_worker_token (str): [optional] # noqa: E501
|
|
287
|
+
pbx_worker_token_v2 (str): [optional] # noqa: E501
|
|
284
288
|
twilio_accounts ([ConversationTwilioAccount]): [optional] # noqa: E501
|
|
285
289
|
user_id (int): UltraCart User ID. [optional] # noqa: E501
|
|
286
290
|
websocket_url (str): [optional] # noqa: E501
|
|
@@ -30,6 +30,10 @@ from ultracart.model_utils import ( # noqa: F401
|
|
|
30
30
|
from ultracart.exceptions import ApiAttributeError
|
|
31
31
|
|
|
32
32
|
|
|
33
|
+
def lazy_import():
|
|
34
|
+
from ultracart.model.conversation_virtual_agent_capabilities import ConversationVirtualAgentCapabilities
|
|
35
|
+
globals()['ConversationVirtualAgentCapabilities'] = ConversationVirtualAgentCapabilities
|
|
36
|
+
|
|
33
37
|
|
|
34
38
|
class ConversationAgentProfile(ModelNormal):
|
|
35
39
|
"""NOTE: This class is auto generated by OpenAPI Generator.
|
|
@@ -72,6 +76,7 @@ class ConversationAgentProfile(ModelNormal):
|
|
|
72
76
|
This must be a method because a model may have properties that are
|
|
73
77
|
of type self, this must run after the class is loaded
|
|
74
78
|
"""
|
|
79
|
+
lazy_import()
|
|
75
80
|
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
|
|
76
81
|
|
|
77
82
|
_nullable = False
|
|
@@ -86,11 +91,14 @@ class ConversationAgentProfile(ModelNormal):
|
|
|
86
91
|
openapi_types (dict): The key is attribute name
|
|
87
92
|
and the value is attribute type.
|
|
88
93
|
"""
|
|
94
|
+
lazy_import()
|
|
89
95
|
return {
|
|
90
96
|
'ai': (bool,), # noqa: E501
|
|
97
|
+
'ai_capabilities': (ConversationVirtualAgentCapabilities,), # noqa: E501
|
|
91
98
|
'ai_chat_instructions': (str,), # noqa: E501
|
|
92
99
|
'ai_persona': (str,), # noqa: E501
|
|
93
100
|
'ai_sms_instructions': (str,), # noqa: E501
|
|
101
|
+
'ai_ticket_instructions': (str,), # noqa: E501
|
|
94
102
|
'chat_limit': (int,), # noqa: E501
|
|
95
103
|
'default_language_iso_code': (str,), # noqa: E501
|
|
96
104
|
'default_status': (str,), # noqa: E501
|
|
@@ -99,6 +107,8 @@ class ConversationAgentProfile(ModelNormal):
|
|
|
99
107
|
'profile_image_upload_key': (str,), # noqa: E501
|
|
100
108
|
'profile_image_url': (str,), # noqa: E501
|
|
101
109
|
'user_id': (int,), # noqa: E501
|
|
110
|
+
'zohodesk_classifications': ([str],), # noqa: E501
|
|
111
|
+
'zohodesk_departments': ([str],), # noqa: E501
|
|
102
112
|
}
|
|
103
113
|
|
|
104
114
|
@cached_property
|
|
@@ -108,9 +118,11 @@ class ConversationAgentProfile(ModelNormal):
|
|
|
108
118
|
|
|
109
119
|
attribute_map = {
|
|
110
120
|
'ai': 'ai', # noqa: E501
|
|
121
|
+
'ai_capabilities': 'ai_capabilities', # noqa: E501
|
|
111
122
|
'ai_chat_instructions': 'ai_chat_instructions', # noqa: E501
|
|
112
123
|
'ai_persona': 'ai_persona', # noqa: E501
|
|
113
124
|
'ai_sms_instructions': 'ai_sms_instructions', # noqa: E501
|
|
125
|
+
'ai_ticket_instructions': 'ai_ticket_instructions', # noqa: E501
|
|
114
126
|
'chat_limit': 'chat_limit', # noqa: E501
|
|
115
127
|
'default_language_iso_code': 'default_language_iso_code', # noqa: E501
|
|
116
128
|
'default_status': 'default_status', # noqa: E501
|
|
@@ -119,6 +131,8 @@ class ConversationAgentProfile(ModelNormal):
|
|
|
119
131
|
'profile_image_upload_key': 'profile_image_upload_key', # noqa: E501
|
|
120
132
|
'profile_image_url': 'profile_image_url', # noqa: E501
|
|
121
133
|
'user_id': 'user_id', # noqa: E501
|
|
134
|
+
'zohodesk_classifications': 'zohodesk_classifications', # noqa: E501
|
|
135
|
+
'zohodesk_departments': 'zohodesk_departments', # noqa: E501
|
|
122
136
|
}
|
|
123
137
|
|
|
124
138
|
read_only_vars = {
|
|
@@ -163,9 +177,11 @@ class ConversationAgentProfile(ModelNormal):
|
|
|
163
177
|
through its discriminator because we passed in
|
|
164
178
|
_visited_composed_classes = (Animal,)
|
|
165
179
|
ai (bool): AI powered chat bot. [optional] # noqa: E501
|
|
180
|
+
ai_capabilities (ConversationVirtualAgentCapabilities): [optional] # noqa: E501
|
|
166
181
|
ai_chat_instructions (str): Additional instructions for this AI when handle web chats. [optional] # noqa: E501
|
|
167
182
|
ai_persona (str): Persona of this AI agent. [optional] # noqa: E501
|
|
168
183
|
ai_sms_instructions (str): Additional instructions for this AI when handle SMS messages. [optional] # noqa: E501
|
|
184
|
+
ai_ticket_instructions (str): Additional instructions for this AI when handling ticket draft replies. [optional] # noqa: E501
|
|
169
185
|
chat_limit (int): The number of engagement chats that can be pushed on them at any given time.. [optional] # noqa: E501
|
|
170
186
|
default_language_iso_code (str): The default language the agent is chatting in. [optional] # noqa: E501
|
|
171
187
|
default_status (str): Default status when the agent loads conversations app.. [optional] # noqa: E501
|
|
@@ -174,6 +190,8 @@ class ConversationAgentProfile(ModelNormal):
|
|
|
174
190
|
profile_image_upload_key (str): An upload key used to update the profile image.. [optional] # noqa: E501
|
|
175
191
|
profile_image_url (str): Their current profile image URL. [optional] # noqa: E501
|
|
176
192
|
user_id (int): User ID associated with the agent. Populated by getAgentProfiles call only.. [optional] # noqa: E501
|
|
193
|
+
zohodesk_classifications ([str]): Restrict this agent to drafting replies only to tickets with these classifications. [optional] # noqa: E501
|
|
194
|
+
zohodesk_departments ([str]): Restrict this agent to drafting replies only to these department ids. [optional] # noqa: E501
|
|
177
195
|
"""
|
|
178
196
|
|
|
179
197
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -260,9 +278,11 @@ class ConversationAgentProfile(ModelNormal):
|
|
|
260
278
|
through its discriminator because we passed in
|
|
261
279
|
_visited_composed_classes = (Animal,)
|
|
262
280
|
ai (bool): AI powered chat bot. [optional] # noqa: E501
|
|
281
|
+
ai_capabilities (ConversationVirtualAgentCapabilities): [optional] # noqa: E501
|
|
263
282
|
ai_chat_instructions (str): Additional instructions for this AI when handle web chats. [optional] # noqa: E501
|
|
264
283
|
ai_persona (str): Persona of this AI agent. [optional] # noqa: E501
|
|
265
284
|
ai_sms_instructions (str): Additional instructions for this AI when handle SMS messages. [optional] # noqa: E501
|
|
285
|
+
ai_ticket_instructions (str): Additional instructions for this AI when handling ticket draft replies. [optional] # noqa: E501
|
|
266
286
|
chat_limit (int): The number of engagement chats that can be pushed on them at any given time.. [optional] # noqa: E501
|
|
267
287
|
default_language_iso_code (str): The default language the agent is chatting in. [optional] # noqa: E501
|
|
268
288
|
default_status (str): Default status when the agent loads conversations app.. [optional] # noqa: E501
|
|
@@ -271,6 +291,8 @@ class ConversationAgentProfile(ModelNormal):
|
|
|
271
291
|
profile_image_upload_key (str): An upload key used to update the profile image.. [optional] # noqa: E501
|
|
272
292
|
profile_image_url (str): Their current profile image URL. [optional] # noqa: E501
|
|
273
293
|
user_id (int): User ID associated with the agent. Populated by getAgentProfiles call only.. [optional] # noqa: E501
|
|
294
|
+
zohodesk_classifications ([str]): Restrict this agent to drafting replies only to tickets with these classifications. [optional] # noqa: E501
|
|
295
|
+
zohodesk_departments ([str]): Restrict this agent to drafting replies only to these department ids. [optional] # noqa: E501
|
|
274
296
|
"""
|
|
275
297
|
|
|
276
298
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -0,0 +1,297 @@
|
|
|
1
|
+
"""
|
|
2
|
+
UltraCart Rest API V2
|
|
3
|
+
|
|
4
|
+
UltraCart REST API Version 2 # noqa: E501
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
|
7
|
+
Contact: support@ultracart.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
"""
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
import re # noqa: F401
|
|
13
|
+
import sys # noqa: F401
|
|
14
|
+
|
|
15
|
+
from ultracart.model_utils import ( # noqa: F401
|
|
16
|
+
ApiTypeError,
|
|
17
|
+
ModelComposed,
|
|
18
|
+
ModelNormal,
|
|
19
|
+
ModelSimple,
|
|
20
|
+
cached_property,
|
|
21
|
+
change_keys_js_to_python,
|
|
22
|
+
convert_js_args_to_python_args,
|
|
23
|
+
date,
|
|
24
|
+
datetime,
|
|
25
|
+
file_type,
|
|
26
|
+
none_type,
|
|
27
|
+
validate_get_composed_info,
|
|
28
|
+
OpenApiModel
|
|
29
|
+
)
|
|
30
|
+
from ultracart.exceptions import ApiAttributeError
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
class ConversationMcpServer(ModelNormal):
|
|
35
|
+
"""NOTE: This class is auto generated by OpenAPI Generator.
|
|
36
|
+
Ref: https://openapi-generator.tech
|
|
37
|
+
|
|
38
|
+
Do not edit the class manually.
|
|
39
|
+
|
|
40
|
+
Attributes:
|
|
41
|
+
allowed_values (dict): The key is the tuple path to the attribute
|
|
42
|
+
and the for var_name this is (var_name,). The value is a dict
|
|
43
|
+
with a capitalized key describing the allowed value and an allowed
|
|
44
|
+
value. These dicts store the allowed enum values.
|
|
45
|
+
attribute_map (dict): The key is attribute name
|
|
46
|
+
and the value is json key in definition.
|
|
47
|
+
discriminator_value_class_map (dict): A dict to go from the discriminator
|
|
48
|
+
variable value to the discriminator class name.
|
|
49
|
+
validations (dict): The key is the tuple path to the attribute
|
|
50
|
+
and the for var_name this is (var_name,). The value is a dict
|
|
51
|
+
that stores validations for max_length, min_length, max_items,
|
|
52
|
+
min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
|
|
53
|
+
inclusive_minimum, and regex.
|
|
54
|
+
additional_properties_type (tuple): A tuple of classes accepted
|
|
55
|
+
as additional properties values.
|
|
56
|
+
"""
|
|
57
|
+
|
|
58
|
+
allowed_values = {
|
|
59
|
+
('auth_method',): {
|
|
60
|
+
'NONE': "none",
|
|
61
|
+
'HEADER': "header",
|
|
62
|
+
'BASIC': "basic",
|
|
63
|
+
},
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
validations = {
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
@cached_property
|
|
70
|
+
def additional_properties_type():
|
|
71
|
+
"""
|
|
72
|
+
This must be a method because a model may have properties that are
|
|
73
|
+
of type self, this must run after the class is loaded
|
|
74
|
+
"""
|
|
75
|
+
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
|
|
76
|
+
|
|
77
|
+
_nullable = False
|
|
78
|
+
|
|
79
|
+
@cached_property
|
|
80
|
+
def openapi_types():
|
|
81
|
+
"""
|
|
82
|
+
This must be a method because a model may have properties that are
|
|
83
|
+
of type self, this must run after the class is loaded
|
|
84
|
+
|
|
85
|
+
Returns
|
|
86
|
+
openapi_types (dict): The key is attribute name
|
|
87
|
+
and the value is attribute type.
|
|
88
|
+
"""
|
|
89
|
+
return {
|
|
90
|
+
'auth_method': (str,), # noqa: E501
|
|
91
|
+
'basic_password': (str,), # noqa: E501
|
|
92
|
+
'basic_user_name': (str,), # noqa: E501
|
|
93
|
+
'header_name': (str,), # noqa: E501
|
|
94
|
+
'header_value': (str,), # noqa: E501
|
|
95
|
+
'mcp_server_uuid': (str,), # noqa: E501
|
|
96
|
+
'priority': (int,), # noqa: E501
|
|
97
|
+
'url': (str,), # noqa: E501
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
@cached_property
|
|
101
|
+
def discriminator():
|
|
102
|
+
return None
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
attribute_map = {
|
|
106
|
+
'auth_method': 'auth_method', # noqa: E501
|
|
107
|
+
'basic_password': 'basic_password', # noqa: E501
|
|
108
|
+
'basic_user_name': 'basic_user_name', # noqa: E501
|
|
109
|
+
'header_name': 'header_name', # noqa: E501
|
|
110
|
+
'header_value': 'header_value', # noqa: E501
|
|
111
|
+
'mcp_server_uuid': 'mcp_server_uuid', # noqa: E501
|
|
112
|
+
'priority': 'priority', # noqa: E501
|
|
113
|
+
'url': 'url', # noqa: E501
|
|
114
|
+
}
|
|
115
|
+
|
|
116
|
+
read_only_vars = {
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
_composed_schemas = {}
|
|
120
|
+
|
|
121
|
+
@classmethod
|
|
122
|
+
@convert_js_args_to_python_args
|
|
123
|
+
def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
|
|
124
|
+
"""ConversationMcpServer - a model defined in OpenAPI
|
|
125
|
+
|
|
126
|
+
Keyword Args:
|
|
127
|
+
_check_type (bool): if True, values for parameters in openapi_types
|
|
128
|
+
will be type checked and a TypeError will be
|
|
129
|
+
raised if the wrong type is input.
|
|
130
|
+
Defaults to True
|
|
131
|
+
_path_to_item (tuple/list): This is a list of keys or values to
|
|
132
|
+
drill down to the model in received_data
|
|
133
|
+
when deserializing a response
|
|
134
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
135
|
+
are serialized names, as specified in the OpenAPI document.
|
|
136
|
+
False if the variable names in the input data
|
|
137
|
+
are pythonic names, e.g. snake case (default)
|
|
138
|
+
_configuration (Configuration): the instance to use when
|
|
139
|
+
deserializing a file_type parameter.
|
|
140
|
+
If passed, type conversion is attempted
|
|
141
|
+
If omitted no type conversion is done.
|
|
142
|
+
_visited_composed_classes (tuple): This stores a tuple of
|
|
143
|
+
classes that we have traveled through so that
|
|
144
|
+
if we see that class again we will not use its
|
|
145
|
+
discriminator again.
|
|
146
|
+
When traveling through a discriminator, the
|
|
147
|
+
composed schema that is
|
|
148
|
+
is traveled through is added to this set.
|
|
149
|
+
For example if Animal has a discriminator
|
|
150
|
+
petType and we pass in "Dog", and the class Dog
|
|
151
|
+
allOf includes Animal, we move through Animal
|
|
152
|
+
once using the discriminator, and pick Dog.
|
|
153
|
+
Then in Dog, we will make an instance of the
|
|
154
|
+
Animal class but this time we won't travel
|
|
155
|
+
through its discriminator because we passed in
|
|
156
|
+
_visited_composed_classes = (Animal,)
|
|
157
|
+
auth_method (str): Authorization Method. [optional] # noqa: E501
|
|
158
|
+
basic_password (str): Basic password. [optional] # noqa: E501
|
|
159
|
+
basic_user_name (str): Basic user name. [optional] # noqa: E501
|
|
160
|
+
header_name (str): Header name. [optional] # noqa: E501
|
|
161
|
+
header_value (str): Header value. [optional] # noqa: E501
|
|
162
|
+
mcp_server_uuid (str): UUID of the MCP server configuration. [optional] # noqa: E501
|
|
163
|
+
priority (int): Priority on which the MCP server tools are incorporated into the model. Lower number comes first. [optional] # noqa: E501
|
|
164
|
+
url (str): URL to the MCP server (must be https). [optional] # noqa: E501
|
|
165
|
+
"""
|
|
166
|
+
|
|
167
|
+
_check_type = kwargs.pop('_check_type', True)
|
|
168
|
+
_spec_property_naming = kwargs.pop('_spec_property_naming', True)
|
|
169
|
+
_path_to_item = kwargs.pop('_path_to_item', ())
|
|
170
|
+
_configuration = kwargs.pop('_configuration', None)
|
|
171
|
+
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
|
|
172
|
+
|
|
173
|
+
self = super(OpenApiModel, cls).__new__(cls)
|
|
174
|
+
|
|
175
|
+
if args:
|
|
176
|
+
for arg in args:
|
|
177
|
+
if isinstance(arg, dict):
|
|
178
|
+
kwargs.update(arg)
|
|
179
|
+
else:
|
|
180
|
+
raise ApiTypeError(
|
|
181
|
+
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
|
|
182
|
+
args,
|
|
183
|
+
self.__class__.__name__,
|
|
184
|
+
),
|
|
185
|
+
path_to_item=_path_to_item,
|
|
186
|
+
valid_classes=(self.__class__,),
|
|
187
|
+
)
|
|
188
|
+
|
|
189
|
+
self._data_store = {}
|
|
190
|
+
self._check_type = _check_type
|
|
191
|
+
self._spec_property_naming = _spec_property_naming
|
|
192
|
+
self._path_to_item = _path_to_item
|
|
193
|
+
self._configuration = _configuration
|
|
194
|
+
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
195
|
+
|
|
196
|
+
for var_name, var_value in kwargs.items():
|
|
197
|
+
if var_name not in self.attribute_map and \
|
|
198
|
+
self._configuration is not None and \
|
|
199
|
+
self._configuration.discard_unknown_keys and \
|
|
200
|
+
self.additional_properties_type is None:
|
|
201
|
+
# discard variable.
|
|
202
|
+
continue
|
|
203
|
+
setattr(self, var_name, var_value)
|
|
204
|
+
return self
|
|
205
|
+
|
|
206
|
+
required_properties = set([
|
|
207
|
+
'_data_store',
|
|
208
|
+
'_check_type',
|
|
209
|
+
'_spec_property_naming',
|
|
210
|
+
'_path_to_item',
|
|
211
|
+
'_configuration',
|
|
212
|
+
'_visited_composed_classes',
|
|
213
|
+
])
|
|
214
|
+
|
|
215
|
+
@convert_js_args_to_python_args
|
|
216
|
+
def __init__(self, *args, **kwargs): # noqa: E501
|
|
217
|
+
"""ConversationMcpServer - a model defined in OpenAPI
|
|
218
|
+
|
|
219
|
+
Keyword Args:
|
|
220
|
+
_check_type (bool): if True, values for parameters in openapi_types
|
|
221
|
+
will be type checked and a TypeError will be
|
|
222
|
+
raised if the wrong type is input.
|
|
223
|
+
Defaults to True
|
|
224
|
+
_path_to_item (tuple/list): This is a list of keys or values to
|
|
225
|
+
drill down to the model in received_data
|
|
226
|
+
when deserializing a response
|
|
227
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
228
|
+
are serialized names, as specified in the OpenAPI document.
|
|
229
|
+
False if the variable names in the input data
|
|
230
|
+
are pythonic names, e.g. snake case (default)
|
|
231
|
+
_configuration (Configuration): the instance to use when
|
|
232
|
+
deserializing a file_type parameter.
|
|
233
|
+
If passed, type conversion is attempted
|
|
234
|
+
If omitted no type conversion is done.
|
|
235
|
+
_visited_composed_classes (tuple): This stores a tuple of
|
|
236
|
+
classes that we have traveled through so that
|
|
237
|
+
if we see that class again we will not use its
|
|
238
|
+
discriminator again.
|
|
239
|
+
When traveling through a discriminator, the
|
|
240
|
+
composed schema that is
|
|
241
|
+
is traveled through is added to this set.
|
|
242
|
+
For example if Animal has a discriminator
|
|
243
|
+
petType and we pass in "Dog", and the class Dog
|
|
244
|
+
allOf includes Animal, we move through Animal
|
|
245
|
+
once using the discriminator, and pick Dog.
|
|
246
|
+
Then in Dog, we will make an instance of the
|
|
247
|
+
Animal class but this time we won't travel
|
|
248
|
+
through its discriminator because we passed in
|
|
249
|
+
_visited_composed_classes = (Animal,)
|
|
250
|
+
auth_method (str): Authorization Method. [optional] # noqa: E501
|
|
251
|
+
basic_password (str): Basic password. [optional] # noqa: E501
|
|
252
|
+
basic_user_name (str): Basic user name. [optional] # noqa: E501
|
|
253
|
+
header_name (str): Header name. [optional] # noqa: E501
|
|
254
|
+
header_value (str): Header value. [optional] # noqa: E501
|
|
255
|
+
mcp_server_uuid (str): UUID of the MCP server configuration. [optional] # noqa: E501
|
|
256
|
+
priority (int): Priority on which the MCP server tools are incorporated into the model. Lower number comes first. [optional] # noqa: E501
|
|
257
|
+
url (str): URL to the MCP server (must be https). [optional] # noqa: E501
|
|
258
|
+
"""
|
|
259
|
+
|
|
260
|
+
_check_type = kwargs.pop('_check_type', True)
|
|
261
|
+
_spec_property_naming = kwargs.pop('_spec_property_naming', False)
|
|
262
|
+
_path_to_item = kwargs.pop('_path_to_item', ())
|
|
263
|
+
_configuration = kwargs.pop('_configuration', None)
|
|
264
|
+
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
|
|
265
|
+
|
|
266
|
+
if args:
|
|
267
|
+
for arg in args:
|
|
268
|
+
if isinstance(arg, dict):
|
|
269
|
+
kwargs.update(arg)
|
|
270
|
+
else:
|
|
271
|
+
raise ApiTypeError(
|
|
272
|
+
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
|
|
273
|
+
args,
|
|
274
|
+
self.__class__.__name__,
|
|
275
|
+
),
|
|
276
|
+
path_to_item=_path_to_item,
|
|
277
|
+
valid_classes=(self.__class__,),
|
|
278
|
+
)
|
|
279
|
+
|
|
280
|
+
self._data_store = {}
|
|
281
|
+
self._check_type = _check_type
|
|
282
|
+
self._spec_property_naming = _spec_property_naming
|
|
283
|
+
self._path_to_item = _path_to_item
|
|
284
|
+
self._configuration = _configuration
|
|
285
|
+
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
286
|
+
|
|
287
|
+
for var_name, var_value in kwargs.items():
|
|
288
|
+
if var_name not in self.attribute_map and \
|
|
289
|
+
self._configuration is not None and \
|
|
290
|
+
self._configuration.discard_unknown_keys and \
|
|
291
|
+
self.additional_properties_type is None:
|
|
292
|
+
# discard variable.
|
|
293
|
+
continue
|
|
294
|
+
setattr(self, var_name, var_value)
|
|
295
|
+
if var_name in self.read_only_vars:
|
|
296
|
+
raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
|
|
297
|
+
f"class with read only attributes.")
|