ultracart_api 3.10.103 → 3.10.105
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +8 -4
- data/docs/ConversationApi.md +51 -0
- data/docs/ItemAutoOrder.md +3 -0
- data/docs/OrderInternal.md +2 -1
- data/docs/OrderTransactionalMerchantNote.md +11 -0
- data/lib/ultracart_api/api/conversation_api.rb +55 -0
- data/lib/ultracart_api/models/item_auto_order.rb +31 -1
- data/lib/ultracart_api/models/order_internal.rb +17 -5
- data/lib/ultracart_api/models/order_transactional_merchant_note.rb +215 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +1 -0
- metadata +4 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 15db4fd92033b5a4ba8feb10486cce1da679c93269c7e529341ee550723f2a60
|
4
|
+
data.tar.gz: 316b4551e5fdc7d1fe5e689e3203dfcddc97eb0cb25dee71ba0218c96d89d224
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0a9f1a6ae31b460ccc05863a239e131cf9946b00e961cfa9d3d6f5b4ac58ebbf2735fa82c144ec573e10a700d873dd1d76b9a863175e5151d2e117b11dd3df75
|
7
|
+
data.tar.gz: e6f0239d6481e916ff3b02b86447f74959fb7c11a1c3fdae849a42d036d5d360dd09ad2da4105f17089bc9e01e927181432f687ecc7906c1da5a77e9a8a297b3
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.10.
|
10
|
+
- Package version: 3.10.105
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-3.10.
|
27
|
+
gem install ./ultracart_api-3.10.105.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.105.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ultracart_api', '~> 3.10.
|
35
|
+
gem 'ultracart_api', '~> 3.10.105'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -141,6 +141,7 @@ Class | Method | HTTP request | Description
|
|
141
141
|
*UltracartClient::ConversationApi* | [**get_conversation_context**](docs/ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
|
142
142
|
*UltracartClient::ConversationApi* | [**get_conversation_department_member_list**](docs/ConversationApi.md#get_conversation_department_member_list) | **GET** /conversation/department_members | Retrieve a list of possible department members
|
143
143
|
*UltracartClient::ConversationApi* | [**get_conversation_departments**](docs/ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
|
144
|
+
*UltracartClient::ConversationApi* | [**get_conversation_engagement**](docs/ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement
|
144
145
|
*UltracartClient::ConversationApi* | [**get_conversation_engagements**](docs/ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
|
145
146
|
*UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
146
147
|
*UltracartClient::ConversationApi* | [**get_conversation_multimedia_upload_url**](docs/ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
|
@@ -1087,6 +1088,7 @@ Class | Method | HTTP request | Description
|
|
1087
1088
|
- [UltracartClient::OrderTokenResponse](docs/OrderTokenResponse.md)
|
1088
1089
|
- [UltracartClient::OrderTrackingNumberDetail](docs/OrderTrackingNumberDetail.md)
|
1089
1090
|
- [UltracartClient::OrderTrackingNumberDetails](docs/OrderTrackingNumberDetails.md)
|
1091
|
+
- [UltracartClient::OrderTransactionalMerchantNote](docs/OrderTransactionalMerchantNote.md)
|
1090
1092
|
- [UltracartClient::OrdersResponse](docs/OrdersResponse.md)
|
1091
1093
|
- [UltracartClient::Permission](docs/Permission.md)
|
1092
1094
|
- [UltracartClient::PointOfSaleLocation](docs/PointOfSaleLocation.md)
|
@@ -1288,6 +1290,8 @@ Not every change is committed to every SDK.
|
|
1288
1290
|
|
1289
1291
|
| Version | Date | Comments |
|
1290
1292
|
| --: | :-: | --- |
|
1293
|
+
| 3.10.105 | 01/24/2023 | auto order - cancel minimum and change balance options |
|
1294
|
+
| 3.10.104 | 01/23/2023 | conversation - method to fetch single engagement record |
|
1291
1295
|
| 3.10.103 | 01/19/2023 | added skip_on_rebill field to coupon object |
|
1292
1296
|
| 3.10.102 | 01/19/2023 | convo - getConversationPermissions added |
|
1293
1297
|
| 3.10.101 | 01/18/2023 | conversation get dept member list method added |
|
data/docs/ConversationApi.md
CHANGED
@@ -14,6 +14,7 @@ Method | HTTP request | Description
|
|
14
14
|
[**get_conversation_context**](ConversationApi.md#get_conversation_context) | **PUT** /conversation/conversations/{conversation_uuid}/context | Get a webchat conversation context
|
15
15
|
[**get_conversation_department_member_list**](ConversationApi.md#get_conversation_department_member_list) | **GET** /conversation/department_members | Retrieve a list of possible department members
|
16
16
|
[**get_conversation_departments**](ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
|
17
|
+
[**get_conversation_engagement**](ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement
|
17
18
|
[**get_conversation_engagements**](ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
|
18
19
|
[**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
19
20
|
[**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conersation multimedia upload URL
|
@@ -511,6 +512,56 @@ This endpoint does not need any parameter.
|
|
511
512
|
|
512
513
|
|
513
514
|
|
515
|
+
# **get_conversation_engagement**
|
516
|
+
> ConversationEngagementResponse get_conversation_engagement(conversation_engagement_oid)
|
517
|
+
|
518
|
+
Retrieve an engagement
|
519
|
+
|
520
|
+
Retrieve an engagement
|
521
|
+
|
522
|
+
### Example
|
523
|
+
```ruby
|
524
|
+
# load the gem
|
525
|
+
require 'ultracart_api'
|
526
|
+
|
527
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
528
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
529
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
530
|
+
|
531
|
+
|
532
|
+
conversation_engagement_oid = 56 # Integer |
|
533
|
+
|
534
|
+
|
535
|
+
begin
|
536
|
+
#Retrieve an engagement
|
537
|
+
result = api_instance.get_conversation_engagement(conversation_engagement_oid)
|
538
|
+
p result
|
539
|
+
rescue UltracartClient::ApiError => e
|
540
|
+
puts "Exception when calling ConversationApi->get_conversation_engagement: #{e}"
|
541
|
+
end
|
542
|
+
```
|
543
|
+
|
544
|
+
### Parameters
|
545
|
+
|
546
|
+
Name | Type | Description | Notes
|
547
|
+
------------- | ------------- | ------------- | -------------
|
548
|
+
**conversation_engagement_oid** | **Integer**| |
|
549
|
+
|
550
|
+
### Return type
|
551
|
+
|
552
|
+
[**ConversationEngagementResponse**](ConversationEngagementResponse.md)
|
553
|
+
|
554
|
+
### Authorization
|
555
|
+
|
556
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
557
|
+
|
558
|
+
### HTTP request headers
|
559
|
+
|
560
|
+
- **Content-Type**: application/json
|
561
|
+
- **Accept**: application/json
|
562
|
+
|
563
|
+
|
564
|
+
|
514
565
|
# **get_conversation_engagements**
|
515
566
|
> ConversationEngagementsResponse get_conversation_engagements
|
516
567
|
|
data/docs/ItemAutoOrder.md
CHANGED
@@ -5,8 +5,11 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**auth_future_amount** | **Float** | Amount to try and authorize for the future rebill | [optional]
|
7
7
|
**auth_test_amount** | **Float** | Amount to try and test authorize | [optional]
|
8
|
+
**auto_order_cancel_charge_minimum_balance** | **BOOLEAN** | If true, the cost of the cancel item will be the remaining balance of the minimum rebill or lifetime value | [optional]
|
8
9
|
**auto_order_cancel_item_id** | **String** | Item id to attempt charging the customer for if they cancel | [optional]
|
9
10
|
**auto_order_cancel_item_oid** | **Integer** | Item object identifier to attempt charging the customer for if they cancel | [optional]
|
11
|
+
**auto_order_cancel_minimum_life_time_value** | **Float** | The minimum life time value that must be paid in order to not be charged the cancellation item. | [optional]
|
12
|
+
**auto_order_cancel_minimum_rebill_value** | **Float** | The minimum rebill value that must be paid in order to not be charged the cancellation item. | [optional]
|
10
13
|
**auto_order_downgrade_items** | **Array<String>** | List of downgrade items presented to customer service representatives | [optional]
|
11
14
|
**auto_order_paused** | **BOOLEAN** | True if the rebill processing of this item is paused | [optional]
|
12
15
|
**auto_order_prohibit_expiring_cards** | **Integer** | Minimum number of months before expiration for the card. Overrides the account level setting if higher. Set to zero to disable. | [optional]
|
data/docs/OrderInternal.md
CHANGED
@@ -4,9 +4,10 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**exported_to_accounting** | **BOOLEAN** | True if the order has been exported to QuickBooks. If QuickBooks is not configured, then this will already be true | [optional]
|
7
|
-
**merchant_notes** | **String** | Merchant notes | [optional]
|
7
|
+
**merchant_notes** | **String** | Merchant notes. Full notes in non-transactional mode. Just used to write a new merchant note when transaction merchant notes enabled. | [optional]
|
8
8
|
**placed_by_user** | **String** | If placed via the BEOE, this is the user that placed the order | [optional]
|
9
9
|
**refund_by_user** | **String** | User that issued the refund | [optional]
|
10
10
|
**sales_rep_code** | **String** | Sales rep code associated with the order | [optional]
|
11
|
+
**transactional_merchant_notes** | [**Array<OrderTransactionalMerchantNote>**](OrderTransactionalMerchantNote.md) | Transactional merchant notes | [optional]
|
11
12
|
|
12
13
|
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# UltracartClient::OrderTransactionalMerchantNote
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**ip_address** | **String** | IP Address | [optional]
|
7
|
+
**note** | **String** | note | [optional]
|
8
|
+
**note_dts** | **String** | Timestamp when the note was added | [optional]
|
9
|
+
**user** | **String** | User that wrote the merchant note | [optional]
|
10
|
+
|
11
|
+
|
@@ -551,6 +551,61 @@ module UltracartClient
|
|
551
551
|
end
|
552
552
|
return data, status_code, headers
|
553
553
|
end
|
554
|
+
# Retrieve an engagement
|
555
|
+
# Retrieve an engagement
|
556
|
+
# @param conversation_engagement_oid
|
557
|
+
# @param [Hash] opts the optional parameters
|
558
|
+
# @return [ConversationEngagementResponse]
|
559
|
+
def get_conversation_engagement(conversation_engagement_oid, opts = {})
|
560
|
+
data, _status_code, _headers = get_conversation_engagement_with_http_info(conversation_engagement_oid, opts)
|
561
|
+
data
|
562
|
+
end
|
563
|
+
|
564
|
+
# Retrieve an engagement
|
565
|
+
# Retrieve an engagement
|
566
|
+
# @param conversation_engagement_oid
|
567
|
+
# @param [Hash] opts the optional parameters
|
568
|
+
# @return [Array<(ConversationEngagementResponse, Fixnum, Hash)>] ConversationEngagementResponse data, response status code and response headers
|
569
|
+
def get_conversation_engagement_with_http_info(conversation_engagement_oid, opts = {})
|
570
|
+
if @api_client.config.debugging
|
571
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_engagement ...'
|
572
|
+
end
|
573
|
+
# verify the required parameter 'conversation_engagement_oid' is set
|
574
|
+
if @api_client.config.client_side_validation && conversation_engagement_oid.nil?
|
575
|
+
fail ArgumentError, "Missing the required parameter 'conversation_engagement_oid' when calling ConversationApi.get_conversation_engagement"
|
576
|
+
end
|
577
|
+
# resource path
|
578
|
+
local_var_path = '/conversation/engagements/{conversation_engagement_oid}'.sub('{' + 'conversation_engagement_oid' + '}', conversation_engagement_oid.to_s)
|
579
|
+
|
580
|
+
# query parameters
|
581
|
+
query_params = {}
|
582
|
+
|
583
|
+
# header parameters
|
584
|
+
header_params = {}
|
585
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
586
|
+
# HTTP header 'Accept' (if needed)
|
587
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
588
|
+
# HTTP header 'Content-Type'
|
589
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
590
|
+
|
591
|
+
# form parameters
|
592
|
+
form_params = {}
|
593
|
+
|
594
|
+
# http body (model)
|
595
|
+
post_body = nil
|
596
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
597
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
598
|
+
:header_params => header_params,
|
599
|
+
:query_params => query_params,
|
600
|
+
:form_params => form_params,
|
601
|
+
:body => post_body,
|
602
|
+
:auth_names => auth_names,
|
603
|
+
:return_type => 'ConversationEngagementResponse')
|
604
|
+
if @api_client.config.debugging
|
605
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_conversation_engagement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
606
|
+
end
|
607
|
+
return data, status_code, headers
|
608
|
+
end
|
554
609
|
# Retrieve a list of engagements ordered by name
|
555
610
|
# Retrieve a list of engagements ordered by name
|
556
611
|
# @param [Hash] opts the optional parameters
|
@@ -20,12 +20,21 @@ module UltracartClient
|
|
20
20
|
# Amount to try and test authorize
|
21
21
|
attr_accessor :auth_test_amount
|
22
22
|
|
23
|
+
# If true, the cost of the cancel item will be the remaining balance of the minimum rebill or lifetime value
|
24
|
+
attr_accessor :auto_order_cancel_charge_minimum_balance
|
25
|
+
|
23
26
|
# Item id to attempt charging the customer for if they cancel
|
24
27
|
attr_accessor :auto_order_cancel_item_id
|
25
28
|
|
26
29
|
# Item object identifier to attempt charging the customer for if they cancel
|
27
30
|
attr_accessor :auto_order_cancel_item_oid
|
28
31
|
|
32
|
+
# The minimum life time value that must be paid in order to not be charged the cancellation item.
|
33
|
+
attr_accessor :auto_order_cancel_minimum_life_time_value
|
34
|
+
|
35
|
+
# The minimum rebill value that must be paid in order to not be charged the cancellation item.
|
36
|
+
attr_accessor :auto_order_cancel_minimum_rebill_value
|
37
|
+
|
29
38
|
# List of downgrade items presented to customer service representatives
|
30
39
|
attr_accessor :auto_order_downgrade_items
|
31
40
|
|
@@ -70,8 +79,11 @@ module UltracartClient
|
|
70
79
|
{
|
71
80
|
:'auth_future_amount' => :'auth_future_amount',
|
72
81
|
:'auth_test_amount' => :'auth_test_amount',
|
82
|
+
:'auto_order_cancel_charge_minimum_balance' => :'auto_order_cancel_charge_minimum_balance',
|
73
83
|
:'auto_order_cancel_item_id' => :'auto_order_cancel_item_id',
|
74
84
|
:'auto_order_cancel_item_oid' => :'auto_order_cancel_item_oid',
|
85
|
+
:'auto_order_cancel_minimum_life_time_value' => :'auto_order_cancel_minimum_life_time_value',
|
86
|
+
:'auto_order_cancel_minimum_rebill_value' => :'auto_order_cancel_minimum_rebill_value',
|
75
87
|
:'auto_order_downgrade_items' => :'auto_order_downgrade_items',
|
76
88
|
:'auto_order_paused' => :'auto_order_paused',
|
77
89
|
:'auto_order_prohibit_expiring_cards' => :'auto_order_prohibit_expiring_cards',
|
@@ -93,8 +105,11 @@ module UltracartClient
|
|
93
105
|
{
|
94
106
|
:'auth_future_amount' => :'Float',
|
95
107
|
:'auth_test_amount' => :'Float',
|
108
|
+
:'auto_order_cancel_charge_minimum_balance' => :'BOOLEAN',
|
96
109
|
:'auto_order_cancel_item_id' => :'String',
|
97
110
|
:'auto_order_cancel_item_oid' => :'Integer',
|
111
|
+
:'auto_order_cancel_minimum_life_time_value' => :'Float',
|
112
|
+
:'auto_order_cancel_minimum_rebill_value' => :'Float',
|
98
113
|
:'auto_order_downgrade_items' => :'Array<String>',
|
99
114
|
:'auto_order_paused' => :'BOOLEAN',
|
100
115
|
:'auto_order_prohibit_expiring_cards' => :'Integer',
|
@@ -127,6 +142,10 @@ module UltracartClient
|
|
127
142
|
self.auth_test_amount = attributes[:'auth_test_amount']
|
128
143
|
end
|
129
144
|
|
145
|
+
if attributes.has_key?(:'auto_order_cancel_charge_minimum_balance')
|
146
|
+
self.auto_order_cancel_charge_minimum_balance = attributes[:'auto_order_cancel_charge_minimum_balance']
|
147
|
+
end
|
148
|
+
|
130
149
|
if attributes.has_key?(:'auto_order_cancel_item_id')
|
131
150
|
self.auto_order_cancel_item_id = attributes[:'auto_order_cancel_item_id']
|
132
151
|
end
|
@@ -135,6 +154,14 @@ module UltracartClient
|
|
135
154
|
self.auto_order_cancel_item_oid = attributes[:'auto_order_cancel_item_oid']
|
136
155
|
end
|
137
156
|
|
157
|
+
if attributes.has_key?(:'auto_order_cancel_minimum_life_time_value')
|
158
|
+
self.auto_order_cancel_minimum_life_time_value = attributes[:'auto_order_cancel_minimum_life_time_value']
|
159
|
+
end
|
160
|
+
|
161
|
+
if attributes.has_key?(:'auto_order_cancel_minimum_rebill_value')
|
162
|
+
self.auto_order_cancel_minimum_rebill_value = attributes[:'auto_order_cancel_minimum_rebill_value']
|
163
|
+
end
|
164
|
+
|
138
165
|
if attributes.has_key?(:'auto_order_downgrade_items')
|
139
166
|
if (value = attributes[:'auto_order_downgrade_items']).is_a?(Array)
|
140
167
|
self.auto_order_downgrade_items = value
|
@@ -231,8 +258,11 @@ module UltracartClient
|
|
231
258
|
self.class == o.class &&
|
232
259
|
auth_future_amount == o.auth_future_amount &&
|
233
260
|
auth_test_amount == o.auth_test_amount &&
|
261
|
+
auto_order_cancel_charge_minimum_balance == o.auto_order_cancel_charge_minimum_balance &&
|
234
262
|
auto_order_cancel_item_id == o.auto_order_cancel_item_id &&
|
235
263
|
auto_order_cancel_item_oid == o.auto_order_cancel_item_oid &&
|
264
|
+
auto_order_cancel_minimum_life_time_value == o.auto_order_cancel_minimum_life_time_value &&
|
265
|
+
auto_order_cancel_minimum_rebill_value == o.auto_order_cancel_minimum_rebill_value &&
|
236
266
|
auto_order_downgrade_items == o.auto_order_downgrade_items &&
|
237
267
|
auto_order_paused == o.auto_order_paused &&
|
238
268
|
auto_order_prohibit_expiring_cards == o.auto_order_prohibit_expiring_cards &&
|
@@ -257,7 +287,7 @@ module UltracartClient
|
|
257
287
|
# Calculates hash code according to all attributes.
|
258
288
|
# @return [Fixnum] Hash code
|
259
289
|
def hash
|
260
|
-
[auth_future_amount, auth_test_amount, auto_order_cancel_item_id, auto_order_cancel_item_oid, auto_order_downgrade_items, auto_order_paused, auto_order_prohibit_expiring_cards, auto_order_schedules, auto_order_upgrade_items, auto_order_upsell, auto_order_upsell_no_easy_cancel, auto_order_upsell_one_per_customer, auto_orderable, cancel_other_auto_orders, free_shipping_auto_order, refund_other_auto_orders, steps].hash
|
290
|
+
[auth_future_amount, auth_test_amount, auto_order_cancel_charge_minimum_balance, auto_order_cancel_item_id, auto_order_cancel_item_oid, auto_order_cancel_minimum_life_time_value, auto_order_cancel_minimum_rebill_value, auto_order_downgrade_items, auto_order_paused, auto_order_prohibit_expiring_cards, auto_order_schedules, auto_order_upgrade_items, auto_order_upsell, auto_order_upsell_no_easy_cancel, auto_order_upsell_one_per_customer, auto_orderable, cancel_other_auto_orders, free_shipping_auto_order, refund_other_auto_orders, steps].hash
|
261
291
|
end
|
262
292
|
|
263
293
|
# Builds the object from hash
|
@@ -17,7 +17,7 @@ module UltracartClient
|
|
17
17
|
# True if the order has been exported to QuickBooks. If QuickBooks is not configured, then this will already be true
|
18
18
|
attr_accessor :exported_to_accounting
|
19
19
|
|
20
|
-
# Merchant notes
|
20
|
+
# Merchant notes. Full notes in non-transactional mode. Just used to write a new merchant note when transaction merchant notes enabled.
|
21
21
|
attr_accessor :merchant_notes
|
22
22
|
|
23
23
|
# If placed via the BEOE, this is the user that placed the order
|
@@ -29,6 +29,9 @@ module UltracartClient
|
|
29
29
|
# Sales rep code associated with the order
|
30
30
|
attr_accessor :sales_rep_code
|
31
31
|
|
32
|
+
# Transactional merchant notes
|
33
|
+
attr_accessor :transactional_merchant_notes
|
34
|
+
|
32
35
|
# Attribute mapping from ruby-style variable name to JSON key.
|
33
36
|
def self.attribute_map
|
34
37
|
{
|
@@ -36,7 +39,8 @@ module UltracartClient
|
|
36
39
|
:'merchant_notes' => :'merchant_notes',
|
37
40
|
:'placed_by_user' => :'placed_by_user',
|
38
41
|
:'refund_by_user' => :'refund_by_user',
|
39
|
-
:'sales_rep_code' => :'sales_rep_code'
|
42
|
+
:'sales_rep_code' => :'sales_rep_code',
|
43
|
+
:'transactional_merchant_notes' => :'transactional_merchant_notes'
|
40
44
|
}
|
41
45
|
end
|
42
46
|
|
@@ -47,7 +51,8 @@ module UltracartClient
|
|
47
51
|
:'merchant_notes' => :'String',
|
48
52
|
:'placed_by_user' => :'String',
|
49
53
|
:'refund_by_user' => :'String',
|
50
|
-
:'sales_rep_code' => :'String'
|
54
|
+
:'sales_rep_code' => :'String',
|
55
|
+
:'transactional_merchant_notes' => :'Array<OrderTransactionalMerchantNote>'
|
51
56
|
}
|
52
57
|
end
|
53
58
|
|
@@ -78,6 +83,12 @@ module UltracartClient
|
|
78
83
|
if attributes.has_key?(:'sales_rep_code')
|
79
84
|
self.sales_rep_code = attributes[:'sales_rep_code']
|
80
85
|
end
|
86
|
+
|
87
|
+
if attributes.has_key?(:'transactional_merchant_notes')
|
88
|
+
if (value = attributes[:'transactional_merchant_notes']).is_a?(Array)
|
89
|
+
self.transactional_merchant_notes = value
|
90
|
+
end
|
91
|
+
end
|
81
92
|
end
|
82
93
|
|
83
94
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -117,7 +128,8 @@ module UltracartClient
|
|
117
128
|
merchant_notes == o.merchant_notes &&
|
118
129
|
placed_by_user == o.placed_by_user &&
|
119
130
|
refund_by_user == o.refund_by_user &&
|
120
|
-
sales_rep_code == o.sales_rep_code
|
131
|
+
sales_rep_code == o.sales_rep_code &&
|
132
|
+
transactional_merchant_notes == o.transactional_merchant_notes
|
121
133
|
end
|
122
134
|
|
123
135
|
# @see the `==` method
|
@@ -129,7 +141,7 @@ module UltracartClient
|
|
129
141
|
# Calculates hash code according to all attributes.
|
130
142
|
# @return [Fixnum] Hash code
|
131
143
|
def hash
|
132
|
-
[exported_to_accounting, merchant_notes, placed_by_user, refund_by_user, sales_rep_code].hash
|
144
|
+
[exported_to_accounting, merchant_notes, placed_by_user, refund_by_user, sales_rep_code, transactional_merchant_notes].hash
|
133
145
|
end
|
134
146
|
|
135
147
|
# Builds the object from hash
|
@@ -0,0 +1,215 @@
|
|
1
|
+
=begin
|
2
|
+
#UltraCart Rest API V2
|
3
|
+
|
4
|
+
#UltraCart REST API Version 2
|
5
|
+
|
6
|
+
OpenAPI spec version: 2.0.0
|
7
|
+
Contact: support@ultracart.com
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.15-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module UltracartClient
|
16
|
+
class OrderTransactionalMerchantNote
|
17
|
+
# IP Address
|
18
|
+
attr_accessor :ip_address
|
19
|
+
|
20
|
+
# note
|
21
|
+
attr_accessor :note
|
22
|
+
|
23
|
+
# Timestamp when the note was added
|
24
|
+
attr_accessor :note_dts
|
25
|
+
|
26
|
+
# User that wrote the merchant note
|
27
|
+
attr_accessor :user
|
28
|
+
|
29
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
30
|
+
def self.attribute_map
|
31
|
+
{
|
32
|
+
:'ip_address' => :'ip_address',
|
33
|
+
:'note' => :'note',
|
34
|
+
:'note_dts' => :'note_dts',
|
35
|
+
:'user' => :'user'
|
36
|
+
}
|
37
|
+
end
|
38
|
+
|
39
|
+
# Attribute type mapping.
|
40
|
+
def self.swagger_types
|
41
|
+
{
|
42
|
+
:'ip_address' => :'String',
|
43
|
+
:'note' => :'String',
|
44
|
+
:'note_dts' => :'String',
|
45
|
+
:'user' => :'String'
|
46
|
+
}
|
47
|
+
end
|
48
|
+
|
49
|
+
# Initializes the object
|
50
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
51
|
+
def initialize(attributes = {})
|
52
|
+
return unless attributes.is_a?(Hash)
|
53
|
+
|
54
|
+
# convert string to symbol for hash key
|
55
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
56
|
+
|
57
|
+
if attributes.has_key?(:'ip_address')
|
58
|
+
self.ip_address = attributes[:'ip_address']
|
59
|
+
end
|
60
|
+
|
61
|
+
if attributes.has_key?(:'note')
|
62
|
+
self.note = attributes[:'note']
|
63
|
+
end
|
64
|
+
|
65
|
+
if attributes.has_key?(:'note_dts')
|
66
|
+
self.note_dts = attributes[:'note_dts']
|
67
|
+
end
|
68
|
+
|
69
|
+
if attributes.has_key?(:'user')
|
70
|
+
self.user = attributes[:'user']
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
75
|
+
# @return Array for valid properties with the reasons
|
76
|
+
def list_invalid_properties
|
77
|
+
invalid_properties = Array.new
|
78
|
+
invalid_properties
|
79
|
+
end
|
80
|
+
|
81
|
+
# Check to see if the all the properties in the model are valid
|
82
|
+
# @return true if the model is valid
|
83
|
+
def valid?
|
84
|
+
true
|
85
|
+
end
|
86
|
+
|
87
|
+
# Checks equality by comparing each attribute.
|
88
|
+
# @param [Object] Object to be compared
|
89
|
+
def ==(o)
|
90
|
+
return true if self.equal?(o)
|
91
|
+
self.class == o.class &&
|
92
|
+
ip_address == o.ip_address &&
|
93
|
+
note == o.note &&
|
94
|
+
note_dts == o.note_dts &&
|
95
|
+
user == o.user
|
96
|
+
end
|
97
|
+
|
98
|
+
# @see the `==` method
|
99
|
+
# @param [Object] Object to be compared
|
100
|
+
def eql?(o)
|
101
|
+
self == o
|
102
|
+
end
|
103
|
+
|
104
|
+
# Calculates hash code according to all attributes.
|
105
|
+
# @return [Fixnum] Hash code
|
106
|
+
def hash
|
107
|
+
[ip_address, note, note_dts, user].hash
|
108
|
+
end
|
109
|
+
|
110
|
+
# Builds the object from hash
|
111
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
112
|
+
# @return [Object] Returns the model itself
|
113
|
+
def build_from_hash(attributes)
|
114
|
+
return nil unless attributes.is_a?(Hash)
|
115
|
+
self.class.swagger_types.each_pair do |key, type|
|
116
|
+
if type =~ /\AArray<(.*)>/i
|
117
|
+
# check to ensure the input is an array given that the attribute
|
118
|
+
# is documented as an array but the input is not
|
119
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
120
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
121
|
+
end
|
122
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
123
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
124
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
125
|
+
end
|
126
|
+
|
127
|
+
self
|
128
|
+
end
|
129
|
+
|
130
|
+
# Deserializes the data based on type
|
131
|
+
# @param string type Data type
|
132
|
+
# @param string value Value to be deserialized
|
133
|
+
# @return [Object] Deserialized data
|
134
|
+
def _deserialize(type, value)
|
135
|
+
case type.to_sym
|
136
|
+
when :DateTime
|
137
|
+
DateTime.parse(value)
|
138
|
+
when :Date
|
139
|
+
Date.parse(value)
|
140
|
+
when :String
|
141
|
+
value.to_s
|
142
|
+
when :Integer
|
143
|
+
value.to_i
|
144
|
+
when :Float
|
145
|
+
value.to_f
|
146
|
+
when :BOOLEAN
|
147
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
148
|
+
true
|
149
|
+
else
|
150
|
+
false
|
151
|
+
end
|
152
|
+
when :Object
|
153
|
+
# generic object (usually a Hash), return directly
|
154
|
+
value
|
155
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
156
|
+
inner_type = Regexp.last_match[:inner_type]
|
157
|
+
value.map { |v| _deserialize(inner_type, v) }
|
158
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
159
|
+
k_type = Regexp.last_match[:k_type]
|
160
|
+
v_type = Regexp.last_match[:v_type]
|
161
|
+
{}.tap do |hash|
|
162
|
+
value.each do |k, v|
|
163
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
164
|
+
end
|
165
|
+
end
|
166
|
+
else # model
|
167
|
+
temp_model = UltracartClient.const_get(type).new
|
168
|
+
temp_model.build_from_hash(value)
|
169
|
+
end
|
170
|
+
end
|
171
|
+
|
172
|
+
# Returns the string representation of the object
|
173
|
+
# @return [String] String presentation of the object
|
174
|
+
def to_s
|
175
|
+
to_hash.to_s
|
176
|
+
end
|
177
|
+
|
178
|
+
# to_body is an alias to to_hash (backward compatibility)
|
179
|
+
# @return [Hash] Returns the object in the form of hash
|
180
|
+
def to_body
|
181
|
+
to_hash
|
182
|
+
end
|
183
|
+
|
184
|
+
# Returns the object in the form of hash
|
185
|
+
# @return [Hash] Returns the object in the form of hash
|
186
|
+
def to_hash
|
187
|
+
hash = {}
|
188
|
+
self.class.attribute_map.each_pair do |attr, param|
|
189
|
+
value = self.send(attr)
|
190
|
+
next if value.nil?
|
191
|
+
hash[param] = _to_hash(value)
|
192
|
+
end
|
193
|
+
hash
|
194
|
+
end
|
195
|
+
|
196
|
+
# Outputs non-array value in the form of hash
|
197
|
+
# For object, use to_hash. Otherwise, just return the value
|
198
|
+
# @param [Object] value Any valid value
|
199
|
+
# @return [Hash] Returns the value in the form of hash
|
200
|
+
def _to_hash(value)
|
201
|
+
if value.is_a?(Array)
|
202
|
+
value.compact.map { |v| _to_hash(v) }
|
203
|
+
elsif value.is_a?(Hash)
|
204
|
+
{}.tap do |hash|
|
205
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
206
|
+
end
|
207
|
+
elsif value.respond_to? :to_hash
|
208
|
+
value.to_hash
|
209
|
+
else
|
210
|
+
value
|
211
|
+
end
|
212
|
+
end
|
213
|
+
|
214
|
+
end
|
215
|
+
end
|
data/lib/ultracart_api.rb
CHANGED
@@ -617,6 +617,7 @@ require 'ultracart_api/models/order_taxes'
|
|
617
617
|
require 'ultracart_api/models/order_token_response'
|
618
618
|
require 'ultracart_api/models/order_tracking_number_detail'
|
619
619
|
require 'ultracart_api/models/order_tracking_number_details'
|
620
|
+
require 'ultracart_api/models/order_transactional_merchant_note'
|
620
621
|
require 'ultracart_api/models/orders_response'
|
621
622
|
require 'ultracart_api/models/permission'
|
622
623
|
require 'ultracart_api/models/point_of_sale_location'
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: ultracart_api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.10.
|
4
|
+
version: 3.10.105
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- UltraCart
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-01-
|
11
|
+
date: 2023-01-24 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -835,6 +835,7 @@ files:
|
|
835
835
|
- docs/OrderTokenResponse.md
|
836
836
|
- docs/OrderTrackingNumberDetail.md
|
837
837
|
- docs/OrderTrackingNumberDetails.md
|
838
|
+
- docs/OrderTransactionalMerchantNote.md
|
838
839
|
- docs/OrdersResponse.md
|
839
840
|
- docs/Permission.md
|
840
841
|
- docs/PointOfSaleLocation.md
|
@@ -1595,6 +1596,7 @@ files:
|
|
1595
1596
|
- lib/ultracart_api/models/order_token_response.rb
|
1596
1597
|
- lib/ultracart_api/models/order_tracking_number_detail.rb
|
1597
1598
|
- lib/ultracart_api/models/order_tracking_number_details.rb
|
1599
|
+
- lib/ultracart_api/models/order_transactional_merchant_note.rb
|
1598
1600
|
- lib/ultracart_api/models/orders_response.rb
|
1599
1601
|
- lib/ultracart_api/models/permission.rb
|
1600
1602
|
- lib/ultracart_api/models/point_of_sale_location.rb
|