ultracart-rest-sdk 4.1.27__py3-none-any.whl → 4.1.37__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.
Files changed (30) hide show
  1. ultracart/__init__.py +1 -1
  2. ultracart/api/conversation_api.py +945 -69
  3. ultracart/api/customer_api.py +171 -0
  4. ultracart/api/item_api.py +315 -0
  5. ultracart/api/order_api.py +153 -0
  6. ultracart/api_client.py +1 -1
  7. ultracart/configuration.py +1 -1
  8. ultracart/model/conversation_agent_auth.py +4 -0
  9. ultracart/model/conversation_agent_profile.py +12 -0
  10. ultracart/model/conversation_mcp_server.py +297 -0
  11. ultracart/model/conversation_mcp_server_response.py +292 -0
  12. ultracart/model/conversation_mcp_server_tools_response.py +290 -0
  13. ultracart/model/conversation_mcp_servers_response.py +292 -0
  14. ultracart/model/conversation_message.py +4 -0
  15. ultracart/model/conversation_pbx_agent.py +4 -0
  16. ultracart/model/conversation_virtual_agent_capabilities.py +4 -0
  17. ultracart/model/coupon_free_item_with_item_purchase_and_free_shipping.py +4 -0
  18. ultracart/model/coupon_percent_off_items_and_free_shipping.py +4 -0
  19. ultracart/model/customer_query.py +8 -0
  20. ultracart/model/email_commseq_email.py +12 -0
  21. ultracart/model/item_related_item.py +2 -0
  22. ultracart/model/item_shipping.py +4 -0
  23. ultracart/model/item_shipping_distribution_center_response.py +292 -0
  24. ultracart/model/order_assign_to_affiliate_request.py +275 -0
  25. ultracart/models/__init__.py +6 -0
  26. {ultracart_rest_sdk-4.1.27.dist-info → ultracart_rest_sdk-4.1.37.dist-info}/METADATA +1 -1
  27. {ultracart_rest_sdk-4.1.27.dist-info → ultracart_rest_sdk-4.1.37.dist-info}/RECORD +30 -24
  28. {ultracart_rest_sdk-4.1.27.dist-info → ultracart_rest_sdk-4.1.37.dist-info}/LICENSE +0 -0
  29. {ultracart_rest_sdk-4.1.27.dist-info → ultracart_rest_sdk-4.1.37.dist-info}/WHEEL +0 -0
  30. {ultracart_rest_sdk-4.1.27.dist-info → ultracart_rest_sdk-4.1.37.dist-info}/top_level.txt +0 -0
@@ -1344,6 +1344,91 @@ class CustomerApi(object):
1344
1344
  },
1345
1345
  api_client=api_client
1346
1346
  )
1347
+ self.search_customers_endpoint = _Endpoint(
1348
+ settings={
1349
+ 'response_type': (CustomersResponse,),
1350
+ 'auth': [
1351
+ 'ultraCartOauth',
1352
+ 'ultraCartSimpleApiKey'
1353
+ ],
1354
+ 'endpoint_path': '/customer/customers/search',
1355
+ 'operation_id': 'search_customers',
1356
+ 'http_method': 'GET',
1357
+ 'servers': None,
1358
+ },
1359
+ params_map={
1360
+ 'all': [
1361
+ 'search_string',
1362
+ 'signup_dts_start',
1363
+ 'signup_dts_end',
1364
+ 'limit',
1365
+ 'offset',
1366
+ 'since',
1367
+ 'sort',
1368
+ 'expand',
1369
+ ],
1370
+ 'required': [],
1371
+ 'nullable': [
1372
+ ],
1373
+ 'enum': [
1374
+ ],
1375
+ 'validation': [
1376
+ ]
1377
+ },
1378
+ root_map={
1379
+ 'validations': {
1380
+ },
1381
+ 'allowed_values': {
1382
+ },
1383
+ 'openapi_types': {
1384
+ 'search_string':
1385
+ (str,),
1386
+ 'signup_dts_start':
1387
+ (str,),
1388
+ 'signup_dts_end':
1389
+ (str,),
1390
+ 'limit':
1391
+ (int,),
1392
+ 'offset':
1393
+ (int,),
1394
+ 'since':
1395
+ (str,),
1396
+ 'sort':
1397
+ (str,),
1398
+ 'expand':
1399
+ (str,),
1400
+ },
1401
+ 'attribute_map': {
1402
+ 'search_string': 'search_string',
1403
+ 'signup_dts_start': 'signup_dts_start',
1404
+ 'signup_dts_end': 'signup_dts_end',
1405
+ 'limit': '_limit',
1406
+ 'offset': '_offset',
1407
+ 'since': '_since',
1408
+ 'sort': '_sort',
1409
+ 'expand': '_expand',
1410
+ },
1411
+ 'location_map': {
1412
+ 'search_string': 'query',
1413
+ 'signup_dts_start': 'query',
1414
+ 'signup_dts_end': 'query',
1415
+ 'limit': 'query',
1416
+ 'offset': 'query',
1417
+ 'since': 'query',
1418
+ 'sort': 'query',
1419
+ 'expand': 'query',
1420
+ },
1421
+ 'collection_format_map': {
1422
+ }
1423
+ },
1424
+ headers_map={
1425
+ 'accept': [
1426
+ 'application/json'
1427
+ ],
1428
+ 'content_type': [],
1429
+ },
1430
+ api_client=api_client
1431
+ )
1347
1432
  self.update_customer_endpoint = _Endpoint(
1348
1433
  settings={
1349
1434
  'response_type': (CustomerResponse,),
@@ -3295,6 +3380,92 @@ class CustomerApi(object):
3295
3380
  lookup_request
3296
3381
  return self.search_customer_profile_values_endpoint.call_with_http_info(**kwargs)
3297
3382
 
3383
+ def search_customers(
3384
+ self,
3385
+ **kwargs
3386
+ ):
3387
+ """Search for customers # noqa: E501
3388
+
3389
+ Retrieves customers from the account by matching the search value against most customer fields. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. This search also goes against the cache so updates should not be performed with these result objects. Always re-query the individual customer profile if you are going to make updates. # noqa: E501
3390
+ This method makes a synchronous HTTP request by default. To make an
3391
+ asynchronous HTTP request, please pass async_req=True
3392
+
3393
+ >>> thread = api.search_customers(async_req=True)
3394
+ >>> result = thread.get()
3395
+
3396
+
3397
+ Keyword Args:
3398
+ search_string (str): Search. [optional]
3399
+ signup_dts_start (str): Signup date start. [optional]
3400
+ signup_dts_end (str): Signup date end. [optional]
3401
+ limit (int): The maximum number of records to return on this one API call. (Max 200). [optional] if omitted the server will use the default value of 100
3402
+ offset (int): Pagination of the record set. Offset is a zero based index.. [optional] if omitted the server will use the default value of 0
3403
+ since (str): Fetch customers that have been created/modified since this date/time.. [optional]
3404
+ sort (str): The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.. [optional]
3405
+ expand (str): The object expansion to perform on the result. See documentation for examples. [optional]
3406
+ _return_http_data_only (bool): response data without head status
3407
+ code and headers. Default is True.
3408
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
3409
+ will be returned without reading/decoding response data.
3410
+ Default is True.
3411
+ _request_timeout (int/float/tuple): timeout setting for this request. If
3412
+ one number provided, it will be total request timeout. It can also
3413
+ be a pair (tuple) of (connection, read) timeouts.
3414
+ Default is None.
3415
+ _check_input_type (bool): specifies if type checking
3416
+ should be done one the data sent to the server.
3417
+ Default is True.
3418
+ _check_return_type (bool): specifies if type checking
3419
+ should be done one the data received from the server.
3420
+ Default is True.
3421
+ _spec_property_naming (bool): True if the variable names in the input data
3422
+ are serialized names, as specified in the OpenAPI document.
3423
+ False if the variable names in the input data
3424
+ are pythonic names, e.g. snake case (default)
3425
+ _content_type (str/None): force body content-type.
3426
+ Default is None and content-type will be predicted by allowed
3427
+ content-types and body.
3428
+ _host_index (int/None): specifies the index of the server
3429
+ that we want to use.
3430
+ Default is read from the configuration.
3431
+ _request_auths (list): set to override the auth_settings for an a single
3432
+ request; this effectively ignores the authentication
3433
+ in the spec for a single request.
3434
+ Default is None
3435
+ async_req (bool): execute request asynchronously
3436
+
3437
+ Returns:
3438
+ CustomersResponse
3439
+ If the method is called asynchronously, returns the request
3440
+ thread.
3441
+ """
3442
+ kwargs['async_req'] = kwargs.get(
3443
+ 'async_req', False
3444
+ )
3445
+ kwargs['_return_http_data_only'] = kwargs.get(
3446
+ '_return_http_data_only', True
3447
+ )
3448
+ kwargs['_preload_content'] = kwargs.get(
3449
+ '_preload_content', True
3450
+ )
3451
+ kwargs['_request_timeout'] = kwargs.get(
3452
+ '_request_timeout', None
3453
+ )
3454
+ kwargs['_check_input_type'] = kwargs.get(
3455
+ '_check_input_type', True
3456
+ )
3457
+ kwargs['_check_return_type'] = kwargs.get(
3458
+ '_check_return_type', True
3459
+ )
3460
+ kwargs['_spec_property_naming'] = kwargs.get(
3461
+ '_spec_property_naming', False
3462
+ )
3463
+ kwargs['_content_type'] = kwargs.get(
3464
+ '_content_type')
3465
+ kwargs['_host_index'] = kwargs.get('_host_index')
3466
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
3467
+ return self.search_customers_endpoint.call_with_http_info(**kwargs)
3468
+
3298
3469
  def update_customer(
3299
3470
  self,
3300
3471
  customer_profile_oid,
ultracart/api/item_api.py CHANGED
@@ -33,6 +33,8 @@ from ultracart.model.item_response import ItemResponse
33
33
  from ultracart.model.item_review import ItemReview
34
34
  from ultracart.model.item_review_response import ItemReviewResponse
35
35
  from ultracart.model.item_reviews_response import ItemReviewsResponse
36
+ from ultracart.model.item_shipping_distribution_center import ItemShippingDistributionCenter
37
+ from ultracart.model.item_shipping_distribution_center_response import ItemShippingDistributionCenterResponse
36
38
  from ultracart.model.items_request import ItemsRequest
37
39
  from ultracart.model.items_response import ItemsResponse
38
40
  from ultracart.model.pricing_tiers_response import PricingTiersResponse
@@ -571,6 +573,74 @@ class ItemApi(object):
571
573
  },
572
574
  api_client=api_client
573
575
  )
576
+ self.get_item_shipping_distribution_center_by_code_endpoint = _Endpoint(
577
+ settings={
578
+ 'response_type': (ItemShippingDistributionCenterResponse,),
579
+ 'auth': [
580
+ 'ultraCartOauth',
581
+ 'ultraCartSimpleApiKey'
582
+ ],
583
+ 'endpoint_path': '/item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code}',
584
+ 'operation_id': 'get_item_shipping_distribution_center_by_code',
585
+ 'http_method': 'GET',
586
+ 'servers': None,
587
+ },
588
+ params_map={
589
+ 'all': [
590
+ 'merchant_item_oid',
591
+ 'distribution_center_code',
592
+ 'expand',
593
+ 'placeholders',
594
+ ],
595
+ 'required': [
596
+ 'merchant_item_oid',
597
+ 'distribution_center_code',
598
+ ],
599
+ 'nullable': [
600
+ ],
601
+ 'enum': [
602
+ ],
603
+ 'validation': [
604
+ ]
605
+ },
606
+ root_map={
607
+ 'validations': {
608
+ },
609
+ 'allowed_values': {
610
+ },
611
+ 'openapi_types': {
612
+ 'merchant_item_oid':
613
+ (int,),
614
+ 'distribution_center_code':
615
+ (str,),
616
+ 'expand':
617
+ (str,),
618
+ 'placeholders':
619
+ (bool,),
620
+ },
621
+ 'attribute_map': {
622
+ 'merchant_item_oid': 'merchant_item_oid',
623
+ 'distribution_center_code': 'distribution_center_code',
624
+ 'expand': '_expand',
625
+ 'placeholders': '_placeholders',
626
+ },
627
+ 'location_map': {
628
+ 'merchant_item_oid': 'path',
629
+ 'distribution_center_code': 'path',
630
+ 'expand': 'query',
631
+ 'placeholders': 'query',
632
+ },
633
+ 'collection_format_map': {
634
+ }
635
+ },
636
+ headers_map={
637
+ 'accept': [
638
+ 'application/json'
639
+ ],
640
+ 'content_type': [],
641
+ },
642
+ api_client=api_client
643
+ )
574
644
  self.get_items_endpoint = _Endpoint(
575
645
  settings={
576
646
  'response_type': (ItemsResponse,),
@@ -1253,6 +1323,71 @@ class ItemApi(object):
1253
1323
  },
1254
1324
  api_client=api_client
1255
1325
  )
1326
+ self.update_item_shipping_distribution_center_by_code_endpoint = _Endpoint(
1327
+ settings={
1328
+ 'response_type': None,
1329
+ 'auth': [
1330
+ 'ultraCartOauth',
1331
+ 'ultraCartSimpleApiKey'
1332
+ ],
1333
+ 'endpoint_path': '/item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code}',
1334
+ 'operation_id': 'update_item_shipping_distribution_center_by_code',
1335
+ 'http_method': 'PUT',
1336
+ 'servers': None,
1337
+ },
1338
+ params_map={
1339
+ 'all': [
1340
+ 'merchant_item_oid',
1341
+ 'distribution_center_code',
1342
+ 'item_shipping_distribution_center',
1343
+ ],
1344
+ 'required': [
1345
+ 'merchant_item_oid',
1346
+ 'distribution_center_code',
1347
+ 'item_shipping_distribution_center',
1348
+ ],
1349
+ 'nullable': [
1350
+ ],
1351
+ 'enum': [
1352
+ ],
1353
+ 'validation': [
1354
+ ]
1355
+ },
1356
+ root_map={
1357
+ 'validations': {
1358
+ },
1359
+ 'allowed_values': {
1360
+ },
1361
+ 'openapi_types': {
1362
+ 'merchant_item_oid':
1363
+ (int,),
1364
+ 'distribution_center_code':
1365
+ (str,),
1366
+ 'item_shipping_distribution_center':
1367
+ (ItemShippingDistributionCenter,),
1368
+ },
1369
+ 'attribute_map': {
1370
+ 'merchant_item_oid': 'merchant_item_oid',
1371
+ 'distribution_center_code': 'distribution_center_code',
1372
+ },
1373
+ 'location_map': {
1374
+ 'merchant_item_oid': 'path',
1375
+ 'distribution_center_code': 'path',
1376
+ 'item_shipping_distribution_center': 'body',
1377
+ },
1378
+ 'collection_format_map': {
1379
+ }
1380
+ },
1381
+ headers_map={
1382
+ 'accept': [
1383
+ 'application/json'
1384
+ ],
1385
+ 'content_type': [
1386
+ 'application/json; charset=UTF-8'
1387
+ ]
1388
+ },
1389
+ api_client=api_client
1390
+ )
1256
1391
  self.update_items_endpoint = _Endpoint(
1257
1392
  settings={
1258
1393
  'response_type': (ItemsResponse,),
@@ -2192,6 +2327,95 @@ class ItemApi(object):
2192
2327
  merchant_item_id
2193
2328
  return self.get_item_by_merchant_item_id_endpoint.call_with_http_info(**kwargs)
2194
2329
 
2330
+ def get_item_shipping_distribution_center_by_code(
2331
+ self,
2332
+ merchant_item_oid,
2333
+ distribution_center_code,
2334
+ **kwargs
2335
+ ):
2336
+ """Retrieve an item shipping distribution center # noqa: E501
2337
+
2338
+ Retrieve an item shipping distribution center. # noqa: E501
2339
+ This method makes a synchronous HTTP request by default. To make an
2340
+ asynchronous HTTP request, please pass async_req=True
2341
+
2342
+ >>> thread = api.get_item_shipping_distribution_center_by_code(merchant_item_oid, distribution_center_code, async_req=True)
2343
+ >>> result = thread.get()
2344
+
2345
+ Args:
2346
+ merchant_item_oid (int): The item oid to retrieve.
2347
+ distribution_center_code (str):
2348
+
2349
+ Keyword Args:
2350
+ expand (str): The object expansion to perform on the result. See documentation for examples. [optional]
2351
+ placeholders (bool): Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.. [optional]
2352
+ _return_http_data_only (bool): response data without head status
2353
+ code and headers. Default is True.
2354
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
2355
+ will be returned without reading/decoding response data.
2356
+ Default is True.
2357
+ _request_timeout (int/float/tuple): timeout setting for this request. If
2358
+ one number provided, it will be total request timeout. It can also
2359
+ be a pair (tuple) of (connection, read) timeouts.
2360
+ Default is None.
2361
+ _check_input_type (bool): specifies if type checking
2362
+ should be done one the data sent to the server.
2363
+ Default is True.
2364
+ _check_return_type (bool): specifies if type checking
2365
+ should be done one the data received from the server.
2366
+ Default is True.
2367
+ _spec_property_naming (bool): True if the variable names in the input data
2368
+ are serialized names, as specified in the OpenAPI document.
2369
+ False if the variable names in the input data
2370
+ are pythonic names, e.g. snake case (default)
2371
+ _content_type (str/None): force body content-type.
2372
+ Default is None and content-type will be predicted by allowed
2373
+ content-types and body.
2374
+ _host_index (int/None): specifies the index of the server
2375
+ that we want to use.
2376
+ Default is read from the configuration.
2377
+ _request_auths (list): set to override the auth_settings for an a single
2378
+ request; this effectively ignores the authentication
2379
+ in the spec for a single request.
2380
+ Default is None
2381
+ async_req (bool): execute request asynchronously
2382
+
2383
+ Returns:
2384
+ ItemShippingDistributionCenterResponse
2385
+ If the method is called asynchronously, returns the request
2386
+ thread.
2387
+ """
2388
+ kwargs['async_req'] = kwargs.get(
2389
+ 'async_req', False
2390
+ )
2391
+ kwargs['_return_http_data_only'] = kwargs.get(
2392
+ '_return_http_data_only', True
2393
+ )
2394
+ kwargs['_preload_content'] = kwargs.get(
2395
+ '_preload_content', True
2396
+ )
2397
+ kwargs['_request_timeout'] = kwargs.get(
2398
+ '_request_timeout', None
2399
+ )
2400
+ kwargs['_check_input_type'] = kwargs.get(
2401
+ '_check_input_type', True
2402
+ )
2403
+ kwargs['_check_return_type'] = kwargs.get(
2404
+ '_check_return_type', True
2405
+ )
2406
+ kwargs['_spec_property_naming'] = kwargs.get(
2407
+ '_spec_property_naming', False
2408
+ )
2409
+ kwargs['_content_type'] = kwargs.get(
2410
+ '_content_type')
2411
+ kwargs['_host_index'] = kwargs.get('_host_index')
2412
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
2413
+ kwargs['merchant_item_oid'] = \
2414
+ merchant_item_oid
2415
+ kwargs['distribution_center_code'] = \
2416
+ distribution_center_code
2417
+ return self.get_item_shipping_distribution_center_by_code_endpoint.call_with_http_info(**kwargs)
2418
+
2195
2419
  def get_items(
2196
2420
  self,
2197
2421
  **kwargs
@@ -3129,6 +3353,97 @@ class ItemApi(object):
3129
3353
  item
3130
3354
  return self.update_item_endpoint.call_with_http_info(**kwargs)
3131
3355
 
3356
+ def update_item_shipping_distribution_center_by_code(
3357
+ self,
3358
+ merchant_item_oid,
3359
+ distribution_center_code,
3360
+ item_shipping_distribution_center,
3361
+ **kwargs
3362
+ ):
3363
+ """Update an item shipping distribution center # noqa: E501
3364
+
3365
+ Update an item shipping distribution center # noqa: E501
3366
+ This method makes a synchronous HTTP request by default. To make an
3367
+ asynchronous HTTP request, please pass async_req=True
3368
+
3369
+ >>> thread = api.update_item_shipping_distribution_center_by_code(merchant_item_oid, distribution_center_code, item_shipping_distribution_center, async_req=True)
3370
+ >>> result = thread.get()
3371
+
3372
+ Args:
3373
+ merchant_item_oid (int): The item oid to update.
3374
+ distribution_center_code (str):
3375
+ item_shipping_distribution_center (ItemShippingDistributionCenter): Item shipping distribution center
3376
+
3377
+ Keyword Args:
3378
+ _return_http_data_only (bool): response data without head status
3379
+ code and headers. Default is True.
3380
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
3381
+ will be returned without reading/decoding response data.
3382
+ Default is True.
3383
+ _request_timeout (int/float/tuple): timeout setting for this request. If
3384
+ one number provided, it will be total request timeout. It can also
3385
+ be a pair (tuple) of (connection, read) timeouts.
3386
+ Default is None.
3387
+ _check_input_type (bool): specifies if type checking
3388
+ should be done one the data sent to the server.
3389
+ Default is True.
3390
+ _check_return_type (bool): specifies if type checking
3391
+ should be done one the data received from the server.
3392
+ Default is True.
3393
+ _spec_property_naming (bool): True if the variable names in the input data
3394
+ are serialized names, as specified in the OpenAPI document.
3395
+ False if the variable names in the input data
3396
+ are pythonic names, e.g. snake case (default)
3397
+ _content_type (str/None): force body content-type.
3398
+ Default is None and content-type will be predicted by allowed
3399
+ content-types and body.
3400
+ _host_index (int/None): specifies the index of the server
3401
+ that we want to use.
3402
+ Default is read from the configuration.
3403
+ _request_auths (list): set to override the auth_settings for an a single
3404
+ request; this effectively ignores the authentication
3405
+ in the spec for a single request.
3406
+ Default is None
3407
+ async_req (bool): execute request asynchronously
3408
+
3409
+ Returns:
3410
+ None
3411
+ If the method is called asynchronously, returns the request
3412
+ thread.
3413
+ """
3414
+ kwargs['async_req'] = kwargs.get(
3415
+ 'async_req', False
3416
+ )
3417
+ kwargs['_return_http_data_only'] = kwargs.get(
3418
+ '_return_http_data_only', True
3419
+ )
3420
+ kwargs['_preload_content'] = kwargs.get(
3421
+ '_preload_content', True
3422
+ )
3423
+ kwargs['_request_timeout'] = kwargs.get(
3424
+ '_request_timeout', None
3425
+ )
3426
+ kwargs['_check_input_type'] = kwargs.get(
3427
+ '_check_input_type', True
3428
+ )
3429
+ kwargs['_check_return_type'] = kwargs.get(
3430
+ '_check_return_type', True
3431
+ )
3432
+ kwargs['_spec_property_naming'] = kwargs.get(
3433
+ '_spec_property_naming', False
3434
+ )
3435
+ kwargs['_content_type'] = kwargs.get(
3436
+ '_content_type')
3437
+ kwargs['_host_index'] = kwargs.get('_host_index')
3438
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
3439
+ kwargs['merchant_item_oid'] = \
3440
+ merchant_item_oid
3441
+ kwargs['distribution_center_code'] = \
3442
+ distribution_center_code
3443
+ kwargs['item_shipping_distribution_center'] = \
3444
+ item_shipping_distribution_center
3445
+ return self.update_item_shipping_distribution_center_by_code_endpoint.call_with_http_info(**kwargs)
3446
+
3132
3447
  def update_items(
3133
3448
  self,
3134
3449
  items_request,