ultracart_api 3.10.64 → 3.10.66

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e74b7dd569e12d9dc2fa15dab34cc3c7a51e0def27215ae4db499b3ded4d449f
4
- data.tar.gz: f25d0248fbbc32b8f176d02bd6ab7c903e79b59e8c2bd21dd21a6701ae85d952
3
+ metadata.gz: 60981a1ada3a2572ddef5170f97d2eb4cba62c7c723bcefe2c324cdc986409a5
4
+ data.tar.gz: 78f0b8ba85a5ac42899979ebd71ae15d1b61a18a1a70a0c90acb452c7cc69af1
5
5
  SHA512:
6
- metadata.gz: 8b5cc4db4e89400fd95e036f4aad16c948fdc953715cca0dce887b29d9abffad7cf5a108587b60a34d5b86172110fb685fbd6f4de6be69b3b72869df2514c379
7
- data.tar.gz: a362be05c9cb761584cac40b19d872b9931b9309c91f1a65443db277d6a6903e3247c700130a140e18b70d5bc50453be91cf5a90b5b22b01c0425211ba9aac2c
6
+ metadata.gz: 062ac7a2c505c0ec5e5ecef15b1463e9753ac5c04ee13e66126a24a8b975eb8e5ef51db49d47a43c6058513ac0501ee27f3793bad12f04328566c9e52c76fc07
7
+ data.tar.gz: 5b324d7ed16ee78766af15e8711bac5ddf088983199bf6b5816d9013a40a4e04f4bf60f55b0ca9719351546d532855de2b98f0e42521c520d8f445a25f08235c
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.64
10
+ - Package version: 3.10.66
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.64.gem
27
+ gem install ./ultracart_api-3.10.66.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.10.64.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.10.66.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.64'
35
+ gem 'ultracart_api', '~> 3.10.66'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -227,6 +227,7 @@ Class | Method | HTTP request | Description
227
227
  *UltracartClient::OrderApi* | [**get_orders_batch**](docs/OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
228
228
  *UltracartClient::OrderApi* | [**get_orders_by_query**](docs/OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
229
229
  *UltracartClient::OrderApi* | [**insert_order**](docs/OrderApi.md#insert_order) | **POST** /order/orders | Insert an order
230
+ *UltracartClient::OrderApi* | [**is_refundable_order**](docs/OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded
230
231
  *UltracartClient::OrderApi* | [**process_payment**](docs/OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
231
232
  *UltracartClient::OrderApi* | [**refund_order**](docs/OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
232
233
  *UltracartClient::OrderApi* | [**replacement**](docs/OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
@@ -581,6 +582,8 @@ Class | Method | HTTP request | Description
581
582
  - [UltracartClient::Conversation](docs/Conversation.md)
582
583
  - [UltracartClient::ConversationAgentAuth](docs/ConversationAgentAuth.md)
583
584
  - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
585
+ - [UltracartClient::ConversationEventAddCoupon](docs/ConversationEventAddCoupon.md)
586
+ - [UltracartClient::ConversationEventAddItem](docs/ConversationEventAddItem.md)
584
587
  - [UltracartClient::ConversationEventQueuePosition](docs/ConversationEventQueuePosition.md)
585
588
  - [UltracartClient::ConversationEventRRWeb](docs/ConversationEventRRWeb.md)
586
589
  - [UltracartClient::ConversationEventReadMessage](docs/ConversationEventReadMessage.md)
@@ -1003,6 +1006,7 @@ Class | Method | HTTP request | Description
1003
1006
  - [UltracartClient::OrderQuery](docs/OrderQuery.md)
1004
1007
  - [UltracartClient::OrderQueryBatch](docs/OrderQueryBatch.md)
1005
1008
  - [UltracartClient::OrderQuote](docs/OrderQuote.md)
1009
+ - [UltracartClient::OrderRefundableResponse](docs/OrderRefundableResponse.md)
1006
1010
  - [UltracartClient::OrderReplacement](docs/OrderReplacement.md)
1007
1011
  - [UltracartClient::OrderReplacementItem](docs/OrderReplacementItem.md)
1008
1012
  - [UltracartClient::OrderReplacementResponse](docs/OrderReplacementResponse.md)
@@ -1213,6 +1217,8 @@ Not every change is committed to every SDK.
1213
1217
 
1214
1218
  | Version | Date | Comments |
1215
1219
  | --: | :-: | --- |
1220
+ | 3.10.66 | 11/15/2022 | conversations - enw events for add coupon and items |
1221
+ | 3.10.65 | 11/15/2022 | order api new method is order refundable |
1216
1222
  | 3.10.64 | 11/15/2022 | increase order property length to 10k char |
1217
1223
  | 3.10.63 | 11/14/2022 | conversations - add allowed values for update agent status |
1218
1224
  | 3.10.62 | 11/09/2022 | conversations - add an enum of event typing |
@@ -0,0 +1,8 @@
1
+ # UltracartClient::ConversationEventAddCoupon
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **coupon_code** | **String** | | [optional]
7
+
8
+
@@ -0,0 +1,8 @@
1
+ # UltracartClient::ConversationEventAddItem
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **item_id** | **String** | | [optional]
7
+
8
+
@@ -4,6 +4,8 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **conversation_uuid** | **String** | Conversation UUID if the websocket message is tied to a specific conversation | [optional]
7
+ **event_add_coupon** | [**ConversationEventAddCoupon**](ConversationEventAddCoupon.md) | | [optional]
8
+ **event_add_item** | [**ConversationEventAddItem**](ConversationEventAddItem.md) | | [optional]
7
9
  **event_conversation_closed** | [**ConversationSummary**](ConversationSummary.md) | | [optional]
8
10
  **event_new_conversation** | [**ConversationSummary**](ConversationSummary.md) | | [optional]
9
11
  **event_new_message** | [**ConversationSummary**](ConversationSummary.md) | | [optional]
data/docs/OrderApi.md CHANGED
@@ -20,6 +20,7 @@ Method | HTTP request | Description
20
20
  [**get_orders_batch**](OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
21
21
  [**get_orders_by_query**](OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
22
22
  [**insert_order**](OrderApi.md#insert_order) | **POST** /order/orders | Insert an order
23
+ [**is_refundable_order**](OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded
23
24
  [**process_payment**](OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
24
25
  [**refund_order**](OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
25
26
  [**replacement**](OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
@@ -926,6 +927,56 @@ Name | Type | Description | Notes
926
927
 
927
928
 
928
929
 
930
+ # **is_refundable_order**
931
+ > OrderRefundableResponse is_refundable_order(order_id)
932
+
933
+ Determine if an order can be refunded
934
+
935
+ Determine if an order can be refunded based upon payment method and age
936
+
937
+ ### Example
938
+ ```ruby
939
+ # load the gem
940
+ require 'ultracart_api'
941
+
942
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
943
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
944
+ api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
945
+
946
+
947
+ order_id = 'order_id_example' # String | The order id to check for refundable order.
948
+
949
+
950
+ begin
951
+ #Determine if an order can be refunded
952
+ result = api_instance.is_refundable_order(order_id)
953
+ p result
954
+ rescue UltracartClient::ApiError => e
955
+ puts "Exception when calling OrderApi->is_refundable_order: #{e}"
956
+ end
957
+ ```
958
+
959
+ ### Parameters
960
+
961
+ Name | Type | Description | Notes
962
+ ------------- | ------------- | ------------- | -------------
963
+ **order_id** | **String**| The order id to check for refundable order. |
964
+
965
+ ### Return type
966
+
967
+ [**OrderRefundableResponse**](OrderRefundableResponse.md)
968
+
969
+ ### Authorization
970
+
971
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
972
+
973
+ ### HTTP request headers
974
+
975
+ - **Content-Type**: application/json; charset=UTF-8
976
+ - **Accept**: application/json
977
+
978
+
979
+
929
980
  # **process_payment**
930
981
  > OrderProcessPaymentResponse process_payment(order_id, process_payment_request)
931
982
 
@@ -0,0 +1,12 @@
1
+ # UltracartClient::OrderRefundableResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **refundable** | **BOOLEAN** | Whether the order is refundable or not. Null should be interpreted as false. | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -1037,6 +1037,61 @@ module UltracartClient
1037
1037
  end
1038
1038
  return data, status_code, headers
1039
1039
  end
1040
+ # Determine if an order can be refunded
1041
+ # Determine if an order can be refunded based upon payment method and age
1042
+ # @param order_id The order id to check for refundable order.
1043
+ # @param [Hash] opts the optional parameters
1044
+ # @return [OrderRefundableResponse]
1045
+ def is_refundable_order(order_id, opts = {})
1046
+ data, _status_code, _headers = is_refundable_order_with_http_info(order_id, opts)
1047
+ data
1048
+ end
1049
+
1050
+ # Determine if an order can be refunded
1051
+ # Determine if an order can be refunded based upon payment method and age
1052
+ # @param order_id The order id to check for refundable order.
1053
+ # @param [Hash] opts the optional parameters
1054
+ # @return [Array<(OrderRefundableResponse, Fixnum, Hash)>] OrderRefundableResponse data, response status code and response headers
1055
+ def is_refundable_order_with_http_info(order_id, opts = {})
1056
+ if @api_client.config.debugging
1057
+ @api_client.config.logger.debug 'Calling API: OrderApi.is_refundable_order ...'
1058
+ end
1059
+ # verify the required parameter 'order_id' is set
1060
+ if @api_client.config.client_side_validation && order_id.nil?
1061
+ fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.is_refundable_order"
1062
+ end
1063
+ # resource path
1064
+ local_var_path = '/order/orders/{order_id}/refundable'.sub('{' + 'order_id' + '}', order_id.to_s)
1065
+
1066
+ # query parameters
1067
+ query_params = {}
1068
+
1069
+ # header parameters
1070
+ header_params = {}
1071
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1072
+ # HTTP header 'Accept' (if needed)
1073
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1074
+ # HTTP header 'Content-Type'
1075
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1076
+
1077
+ # form parameters
1078
+ form_params = {}
1079
+
1080
+ # http body (model)
1081
+ post_body = nil
1082
+ auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1083
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
1084
+ :header_params => header_params,
1085
+ :query_params => query_params,
1086
+ :form_params => form_params,
1087
+ :body => post_body,
1088
+ :auth_names => auth_names,
1089
+ :return_type => 'OrderRefundableResponse')
1090
+ if @api_client.config.debugging
1091
+ @api_client.config.logger.debug "API called: OrderApi#is_refundable_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1092
+ end
1093
+ return data, status_code, headers
1094
+ end
1040
1095
  # Process payment
1041
1096
  # Process payment on order
1042
1097
  # @param order_id The order id to process payment on
@@ -0,0 +1,184 @@
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 ConversationEventAddCoupon
17
+ attr_accessor :coupon_code
18
+
19
+ # Attribute mapping from ruby-style variable name to JSON key.
20
+ def self.attribute_map
21
+ {
22
+ :'coupon_code' => :'coupon_code'
23
+ }
24
+ end
25
+
26
+ # Attribute type mapping.
27
+ def self.swagger_types
28
+ {
29
+ :'coupon_code' => :'String'
30
+ }
31
+ end
32
+
33
+ # Initializes the object
34
+ # @param [Hash] attributes Model attributes in the form of hash
35
+ def initialize(attributes = {})
36
+ return unless attributes.is_a?(Hash)
37
+
38
+ # convert string to symbol for hash key
39
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
40
+
41
+ if attributes.has_key?(:'coupon_code')
42
+ self.coupon_code = attributes[:'coupon_code']
43
+ end
44
+ end
45
+
46
+ # Show invalid properties with the reasons. Usually used together with valid?
47
+ # @return Array for valid properties with the reasons
48
+ def list_invalid_properties
49
+ invalid_properties = Array.new
50
+ invalid_properties
51
+ end
52
+
53
+ # Check to see if the all the properties in the model are valid
54
+ # @return true if the model is valid
55
+ def valid?
56
+ true
57
+ end
58
+
59
+ # Checks equality by comparing each attribute.
60
+ # @param [Object] Object to be compared
61
+ def ==(o)
62
+ return true if self.equal?(o)
63
+ self.class == o.class &&
64
+ coupon_code == o.coupon_code
65
+ end
66
+
67
+ # @see the `==` method
68
+ # @param [Object] Object to be compared
69
+ def eql?(o)
70
+ self == o
71
+ end
72
+
73
+ # Calculates hash code according to all attributes.
74
+ # @return [Fixnum] Hash code
75
+ def hash
76
+ [coupon_code].hash
77
+ end
78
+
79
+ # Builds the object from hash
80
+ # @param [Hash] attributes Model attributes in the form of hash
81
+ # @return [Object] Returns the model itself
82
+ def build_from_hash(attributes)
83
+ return nil unless attributes.is_a?(Hash)
84
+ self.class.swagger_types.each_pair do |key, type|
85
+ if type =~ /\AArray<(.*)>/i
86
+ # check to ensure the input is an array given that the attribute
87
+ # is documented as an array but the input is not
88
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
89
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
90
+ end
91
+ elsif !attributes[self.class.attribute_map[key]].nil?
92
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
93
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
94
+ end
95
+
96
+ self
97
+ end
98
+
99
+ # Deserializes the data based on type
100
+ # @param string type Data type
101
+ # @param string value Value to be deserialized
102
+ # @return [Object] Deserialized data
103
+ def _deserialize(type, value)
104
+ case type.to_sym
105
+ when :DateTime
106
+ DateTime.parse(value)
107
+ when :Date
108
+ Date.parse(value)
109
+ when :String
110
+ value.to_s
111
+ when :Integer
112
+ value.to_i
113
+ when :Float
114
+ value.to_f
115
+ when :BOOLEAN
116
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
117
+ true
118
+ else
119
+ false
120
+ end
121
+ when :Object
122
+ # generic object (usually a Hash), return directly
123
+ value
124
+ when /\AArray<(?<inner_type>.+)>\z/
125
+ inner_type = Regexp.last_match[:inner_type]
126
+ value.map { |v| _deserialize(inner_type, v) }
127
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
128
+ k_type = Regexp.last_match[:k_type]
129
+ v_type = Regexp.last_match[:v_type]
130
+ {}.tap do |hash|
131
+ value.each do |k, v|
132
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
133
+ end
134
+ end
135
+ else # model
136
+ temp_model = UltracartClient.const_get(type).new
137
+ temp_model.build_from_hash(value)
138
+ end
139
+ end
140
+
141
+ # Returns the string representation of the object
142
+ # @return [String] String presentation of the object
143
+ def to_s
144
+ to_hash.to_s
145
+ end
146
+
147
+ # to_body is an alias to to_hash (backward compatibility)
148
+ # @return [Hash] Returns the object in the form of hash
149
+ def to_body
150
+ to_hash
151
+ end
152
+
153
+ # Returns the object in the form of hash
154
+ # @return [Hash] Returns the object in the form of hash
155
+ def to_hash
156
+ hash = {}
157
+ self.class.attribute_map.each_pair do |attr, param|
158
+ value = self.send(attr)
159
+ next if value.nil?
160
+ hash[param] = _to_hash(value)
161
+ end
162
+ hash
163
+ end
164
+
165
+ # Outputs non-array value in the form of hash
166
+ # For object, use to_hash. Otherwise, just return the value
167
+ # @param [Object] value Any valid value
168
+ # @return [Hash] Returns the value in the form of hash
169
+ def _to_hash(value)
170
+ if value.is_a?(Array)
171
+ value.compact.map { |v| _to_hash(v) }
172
+ elsif value.is_a?(Hash)
173
+ {}.tap do |hash|
174
+ value.each { |k, v| hash[k] = _to_hash(v) }
175
+ end
176
+ elsif value.respond_to? :to_hash
177
+ value.to_hash
178
+ else
179
+ value
180
+ end
181
+ end
182
+
183
+ end
184
+ end
@@ -0,0 +1,184 @@
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 ConversationEventAddItem
17
+ attr_accessor :item_id
18
+
19
+ # Attribute mapping from ruby-style variable name to JSON key.
20
+ def self.attribute_map
21
+ {
22
+ :'item_id' => :'item_id'
23
+ }
24
+ end
25
+
26
+ # Attribute type mapping.
27
+ def self.swagger_types
28
+ {
29
+ :'item_id' => :'String'
30
+ }
31
+ end
32
+
33
+ # Initializes the object
34
+ # @param [Hash] attributes Model attributes in the form of hash
35
+ def initialize(attributes = {})
36
+ return unless attributes.is_a?(Hash)
37
+
38
+ # convert string to symbol for hash key
39
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
40
+
41
+ if attributes.has_key?(:'item_id')
42
+ self.item_id = attributes[:'item_id']
43
+ end
44
+ end
45
+
46
+ # Show invalid properties with the reasons. Usually used together with valid?
47
+ # @return Array for valid properties with the reasons
48
+ def list_invalid_properties
49
+ invalid_properties = Array.new
50
+ invalid_properties
51
+ end
52
+
53
+ # Check to see if the all the properties in the model are valid
54
+ # @return true if the model is valid
55
+ def valid?
56
+ true
57
+ end
58
+
59
+ # Checks equality by comparing each attribute.
60
+ # @param [Object] Object to be compared
61
+ def ==(o)
62
+ return true if self.equal?(o)
63
+ self.class == o.class &&
64
+ item_id == o.item_id
65
+ end
66
+
67
+ # @see the `==` method
68
+ # @param [Object] Object to be compared
69
+ def eql?(o)
70
+ self == o
71
+ end
72
+
73
+ # Calculates hash code according to all attributes.
74
+ # @return [Fixnum] Hash code
75
+ def hash
76
+ [item_id].hash
77
+ end
78
+
79
+ # Builds the object from hash
80
+ # @param [Hash] attributes Model attributes in the form of hash
81
+ # @return [Object] Returns the model itself
82
+ def build_from_hash(attributes)
83
+ return nil unless attributes.is_a?(Hash)
84
+ self.class.swagger_types.each_pair do |key, type|
85
+ if type =~ /\AArray<(.*)>/i
86
+ # check to ensure the input is an array given that the attribute
87
+ # is documented as an array but the input is not
88
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
89
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
90
+ end
91
+ elsif !attributes[self.class.attribute_map[key]].nil?
92
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
93
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
94
+ end
95
+
96
+ self
97
+ end
98
+
99
+ # Deserializes the data based on type
100
+ # @param string type Data type
101
+ # @param string value Value to be deserialized
102
+ # @return [Object] Deserialized data
103
+ def _deserialize(type, value)
104
+ case type.to_sym
105
+ when :DateTime
106
+ DateTime.parse(value)
107
+ when :Date
108
+ Date.parse(value)
109
+ when :String
110
+ value.to_s
111
+ when :Integer
112
+ value.to_i
113
+ when :Float
114
+ value.to_f
115
+ when :BOOLEAN
116
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
117
+ true
118
+ else
119
+ false
120
+ end
121
+ when :Object
122
+ # generic object (usually a Hash), return directly
123
+ value
124
+ when /\AArray<(?<inner_type>.+)>\z/
125
+ inner_type = Regexp.last_match[:inner_type]
126
+ value.map { |v| _deserialize(inner_type, v) }
127
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
128
+ k_type = Regexp.last_match[:k_type]
129
+ v_type = Regexp.last_match[:v_type]
130
+ {}.tap do |hash|
131
+ value.each do |k, v|
132
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
133
+ end
134
+ end
135
+ else # model
136
+ temp_model = UltracartClient.const_get(type).new
137
+ temp_model.build_from_hash(value)
138
+ end
139
+ end
140
+
141
+ # Returns the string representation of the object
142
+ # @return [String] String presentation of the object
143
+ def to_s
144
+ to_hash.to_s
145
+ end
146
+
147
+ # to_body is an alias to to_hash (backward compatibility)
148
+ # @return [Hash] Returns the object in the form of hash
149
+ def to_body
150
+ to_hash
151
+ end
152
+
153
+ # Returns the object in the form of hash
154
+ # @return [Hash] Returns the object in the form of hash
155
+ def to_hash
156
+ hash = {}
157
+ self.class.attribute_map.each_pair do |attr, param|
158
+ value = self.send(attr)
159
+ next if value.nil?
160
+ hash[param] = _to_hash(value)
161
+ end
162
+ hash
163
+ end
164
+
165
+ # Outputs non-array value in the form of hash
166
+ # For object, use to_hash. Otherwise, just return the value
167
+ # @param [Object] value Any valid value
168
+ # @return [Hash] Returns the value in the form of hash
169
+ def _to_hash(value)
170
+ if value.is_a?(Array)
171
+ value.compact.map { |v| _to_hash(v) }
172
+ elsif value.is_a?(Hash)
173
+ {}.tap do |hash|
174
+ value.each { |k, v| hash[k] = _to_hash(v) }
175
+ end
176
+ elsif value.respond_to? :to_hash
177
+ value.to_hash
178
+ else
179
+ value
180
+ end
181
+ end
182
+
183
+ end
184
+ end
@@ -17,6 +17,10 @@ module UltracartClient
17
17
  # Conversation UUID if the websocket message is tied to a specific conversation
18
18
  attr_accessor :conversation_uuid
19
19
 
20
+ attr_accessor :event_add_coupon
21
+
22
+ attr_accessor :event_add_item
23
+
20
24
  attr_accessor :event_conversation_closed
21
25
 
22
26
  attr_accessor :event_new_conversation
@@ -71,6 +75,8 @@ module UltracartClient
71
75
  def self.attribute_map
72
76
  {
73
77
  :'conversation_uuid' => :'conversation_uuid',
78
+ :'event_add_coupon' => :'event_add_coupon',
79
+ :'event_add_item' => :'event_add_item',
74
80
  :'event_conversation_closed' => :'event_conversation_closed',
75
81
  :'event_new_conversation' => :'event_new_conversation',
76
82
  :'event_new_message' => :'event_new_message',
@@ -91,6 +97,8 @@ module UltracartClient
91
97
  def self.swagger_types
92
98
  {
93
99
  :'conversation_uuid' => :'String',
100
+ :'event_add_coupon' => :'ConversationEventAddCoupon',
101
+ :'event_add_item' => :'ConversationEventAddItem',
94
102
  :'event_conversation_closed' => :'ConversationSummary',
95
103
  :'event_new_conversation' => :'ConversationSummary',
96
104
  :'event_new_message' => :'ConversationSummary',
@@ -119,6 +127,14 @@ module UltracartClient
119
127
  self.conversation_uuid = attributes[:'conversation_uuid']
120
128
  end
121
129
 
130
+ if attributes.has_key?(:'event_add_coupon')
131
+ self.event_add_coupon = attributes[:'event_add_coupon']
132
+ end
133
+
134
+ if attributes.has_key?(:'event_add_item')
135
+ self.event_add_item = attributes[:'event_add_item']
136
+ end
137
+
122
138
  if attributes.has_key?(:'event_conversation_closed')
123
139
  self.event_conversation_closed = attributes[:'event_conversation_closed']
124
140
  end
@@ -182,7 +198,7 @@ module UltracartClient
182
198
  # Check to see if the all the properties in the model are valid
183
199
  # @return true if the model is valid
184
200
  def valid?
185
- event_type_validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'read message', 'typing'])
201
+ event_type_validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'read message', 'typing', 'add coupon', 'add item'])
186
202
  return false unless event_type_validator.valid?(@event_type)
187
203
  type_validator = EnumAttributeValidator.new('String', ['message', 'event', 'ping', 'check queue position'])
188
204
  return false unless type_validator.valid?(@type)
@@ -192,7 +208,7 @@ module UltracartClient
192
208
  # Custom attribute writer method checking allowed values (enum).
193
209
  # @param [Object] event_type Object to be assigned
194
210
  def event_type=(event_type)
195
- validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'read message', 'typing'])
211
+ validator = EnumAttributeValidator.new('String', ['queue position', 'webchat start conversation', 'conversation closed', 'new conversation', 'new message', 'updated message', 'queue status update', 'rrweb', 'participant update', 'read message', 'typing', 'add coupon', 'add item'])
196
212
  unless validator.valid?(event_type)
197
213
  fail ArgumentError, 'invalid value for "event_type", must be one of #{validator.allowable_values}.'
198
214
  end
@@ -215,6 +231,8 @@ module UltracartClient
215
231
  return true if self.equal?(o)
216
232
  self.class == o.class &&
217
233
  conversation_uuid == o.conversation_uuid &&
234
+ event_add_coupon == o.event_add_coupon &&
235
+ event_add_item == o.event_add_item &&
218
236
  event_conversation_closed == o.event_conversation_closed &&
219
237
  event_new_conversation == o.event_new_conversation &&
220
238
  event_new_message == o.event_new_message &&
@@ -239,7 +257,7 @@ module UltracartClient
239
257
  # Calculates hash code according to all attributes.
240
258
  # @return [Fixnum] Hash code
241
259
  def hash
242
- [conversation_uuid, event_conversation_closed, event_new_conversation, event_new_message, event_participant_update, event_queue_position, event_queue_status_update, event_read_message, event_rrweb, event_type, event_typing, event_updated_message, message, type].hash
260
+ [conversation_uuid, event_add_coupon, event_add_item, event_conversation_closed, event_new_conversation, event_new_message, event_participant_update, event_queue_position, event_queue_status_update, event_read_message, event_rrweb, event_type, event_typing, event_updated_message, message, type].hash
243
261
  end
244
262
 
245
263
  # Builds the object from hash
@@ -0,0 +1,222 @@
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 OrderRefundableResponse
17
+ attr_accessor :error
18
+
19
+ attr_accessor :metadata
20
+
21
+ # Whether the order is refundable or not. Null should be interpreted as false.
22
+ attr_accessor :refundable
23
+
24
+ # Indicates if API call was successful
25
+ attr_accessor :success
26
+
27
+ attr_accessor :warning
28
+
29
+ # Attribute mapping from ruby-style variable name to JSON key.
30
+ def self.attribute_map
31
+ {
32
+ :'error' => :'error',
33
+ :'metadata' => :'metadata',
34
+ :'refundable' => :'refundable',
35
+ :'success' => :'success',
36
+ :'warning' => :'warning'
37
+ }
38
+ end
39
+
40
+ # Attribute type mapping.
41
+ def self.swagger_types
42
+ {
43
+ :'error' => :'Error',
44
+ :'metadata' => :'ResponseMetadata',
45
+ :'refundable' => :'BOOLEAN',
46
+ :'success' => :'BOOLEAN',
47
+ :'warning' => :'Warning'
48
+ }
49
+ end
50
+
51
+ # Initializes the object
52
+ # @param [Hash] attributes Model attributes in the form of hash
53
+ def initialize(attributes = {})
54
+ return unless attributes.is_a?(Hash)
55
+
56
+ # convert string to symbol for hash key
57
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
58
+
59
+ if attributes.has_key?(:'error')
60
+ self.error = attributes[:'error']
61
+ end
62
+
63
+ if attributes.has_key?(:'metadata')
64
+ self.metadata = attributes[:'metadata']
65
+ end
66
+
67
+ if attributes.has_key?(:'refundable')
68
+ self.refundable = attributes[:'refundable']
69
+ end
70
+
71
+ if attributes.has_key?(:'success')
72
+ self.success = attributes[:'success']
73
+ end
74
+
75
+ if attributes.has_key?(:'warning')
76
+ self.warning = attributes[:'warning']
77
+ end
78
+ end
79
+
80
+ # Show invalid properties with the reasons. Usually used together with valid?
81
+ # @return Array for valid properties with the reasons
82
+ def list_invalid_properties
83
+ invalid_properties = Array.new
84
+ invalid_properties
85
+ end
86
+
87
+ # Check to see if the all the properties in the model are valid
88
+ # @return true if the model is valid
89
+ def valid?
90
+ true
91
+ end
92
+
93
+ # Checks equality by comparing each attribute.
94
+ # @param [Object] Object to be compared
95
+ def ==(o)
96
+ return true if self.equal?(o)
97
+ self.class == o.class &&
98
+ error == o.error &&
99
+ metadata == o.metadata &&
100
+ refundable == o.refundable &&
101
+ success == o.success &&
102
+ warning == o.warning
103
+ end
104
+
105
+ # @see the `==` method
106
+ # @param [Object] Object to be compared
107
+ def eql?(o)
108
+ self == o
109
+ end
110
+
111
+ # Calculates hash code according to all attributes.
112
+ # @return [Fixnum] Hash code
113
+ def hash
114
+ [error, metadata, refundable, success, warning].hash
115
+ end
116
+
117
+ # Builds the object from hash
118
+ # @param [Hash] attributes Model attributes in the form of hash
119
+ # @return [Object] Returns the model itself
120
+ def build_from_hash(attributes)
121
+ return nil unless attributes.is_a?(Hash)
122
+ self.class.swagger_types.each_pair do |key, type|
123
+ if type =~ /\AArray<(.*)>/i
124
+ # check to ensure the input is an array given that the attribute
125
+ # is documented as an array but the input is not
126
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
127
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
128
+ end
129
+ elsif !attributes[self.class.attribute_map[key]].nil?
130
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
131
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
132
+ end
133
+
134
+ self
135
+ end
136
+
137
+ # Deserializes the data based on type
138
+ # @param string type Data type
139
+ # @param string value Value to be deserialized
140
+ # @return [Object] Deserialized data
141
+ def _deserialize(type, value)
142
+ case type.to_sym
143
+ when :DateTime
144
+ DateTime.parse(value)
145
+ when :Date
146
+ Date.parse(value)
147
+ when :String
148
+ value.to_s
149
+ when :Integer
150
+ value.to_i
151
+ when :Float
152
+ value.to_f
153
+ when :BOOLEAN
154
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
155
+ true
156
+ else
157
+ false
158
+ end
159
+ when :Object
160
+ # generic object (usually a Hash), return directly
161
+ value
162
+ when /\AArray<(?<inner_type>.+)>\z/
163
+ inner_type = Regexp.last_match[:inner_type]
164
+ value.map { |v| _deserialize(inner_type, v) }
165
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
166
+ k_type = Regexp.last_match[:k_type]
167
+ v_type = Regexp.last_match[:v_type]
168
+ {}.tap do |hash|
169
+ value.each do |k, v|
170
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
171
+ end
172
+ end
173
+ else # model
174
+ temp_model = UltracartClient.const_get(type).new
175
+ temp_model.build_from_hash(value)
176
+ end
177
+ end
178
+
179
+ # Returns the string representation of the object
180
+ # @return [String] String presentation of the object
181
+ def to_s
182
+ to_hash.to_s
183
+ end
184
+
185
+ # to_body is an alias to to_hash (backward compatibility)
186
+ # @return [Hash] Returns the object in the form of hash
187
+ def to_body
188
+ to_hash
189
+ end
190
+
191
+ # Returns the object in the form of hash
192
+ # @return [Hash] Returns the object in the form of hash
193
+ def to_hash
194
+ hash = {}
195
+ self.class.attribute_map.each_pair do |attr, param|
196
+ value = self.send(attr)
197
+ next if value.nil?
198
+ hash[param] = _to_hash(value)
199
+ end
200
+ hash
201
+ end
202
+
203
+ # Outputs non-array value in the form of hash
204
+ # For object, use to_hash. Otherwise, just return the value
205
+ # @param [Object] value Any valid value
206
+ # @return [Hash] Returns the value in the form of hash
207
+ def _to_hash(value)
208
+ if value.is_a?(Array)
209
+ value.compact.map { |v| _to_hash(v) }
210
+ elsif value.is_a?(Hash)
211
+ {}.tap do |hash|
212
+ value.each { |k, v| hash[k] = _to_hash(v) }
213
+ end
214
+ elsif value.respond_to? :to_hash
215
+ value.to_hash
216
+ else
217
+ value
218
+ end
219
+ end
220
+
221
+ end
222
+ end
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '3.10.64'
14
+ VERSION = '3.10.66'
15
15
  end
data/lib/ultracart_api.rb CHANGED
@@ -137,6 +137,8 @@ require 'ultracart_api/models/city_state_zip'
137
137
  require 'ultracart_api/models/conversation'
138
138
  require 'ultracart_api/models/conversation_agent_auth'
139
139
  require 'ultracart_api/models/conversation_agent_auth_response'
140
+ require 'ultracart_api/models/conversation_event_add_coupon'
141
+ require 'ultracart_api/models/conversation_event_add_item'
140
142
  require 'ultracart_api/models/conversation_event_queue_position'
141
143
  require 'ultracart_api/models/conversation_event_rr_web'
142
144
  require 'ultracart_api/models/conversation_event_read_message'
@@ -559,6 +561,7 @@ require 'ultracart_api/models/order_property'
559
561
  require 'ultracart_api/models/order_query'
560
562
  require 'ultracart_api/models/order_query_batch'
561
563
  require 'ultracart_api/models/order_quote'
564
+ require 'ultracart_api/models/order_refundable_response'
562
565
  require 'ultracart_api/models/order_replacement'
563
566
  require 'ultracart_api/models/order_replacement_item'
564
567
  require 'ultracart_api/models/order_replacement_response'
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ultracart_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.10.64
4
+ version: 3.10.66
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart
@@ -347,6 +347,8 @@ files:
347
347
  - docs/ConversationAgentAuth.md
348
348
  - docs/ConversationAgentAuthResponse.md
349
349
  - docs/ConversationApi.md
350
+ - docs/ConversationEventAddCoupon.md
351
+ - docs/ConversationEventAddItem.md
350
352
  - docs/ConversationEventQueuePosition.md
351
353
  - docs/ConversationEventRRWeb.md
352
354
  - docs/ConversationEventReadMessage.md
@@ -777,6 +779,7 @@ files:
777
779
  - docs/OrderQuery.md
778
780
  - docs/OrderQueryBatch.md
779
781
  - docs/OrderQuote.md
782
+ - docs/OrderRefundableResponse.md
780
783
  - docs/OrderReplacement.md
781
784
  - docs/OrderReplacementItem.md
782
785
  - docs/OrderReplacementResponse.md
@@ -1066,6 +1069,8 @@ files:
1066
1069
  - lib/ultracart_api/models/conversation.rb
1067
1070
  - lib/ultracart_api/models/conversation_agent_auth.rb
1068
1071
  - lib/ultracart_api/models/conversation_agent_auth_response.rb
1072
+ - lib/ultracart_api/models/conversation_event_add_coupon.rb
1073
+ - lib/ultracart_api/models/conversation_event_add_item.rb
1069
1074
  - lib/ultracart_api/models/conversation_event_queue_position.rb
1070
1075
  - lib/ultracart_api/models/conversation_event_read_message.rb
1071
1076
  - lib/ultracart_api/models/conversation_event_rr_web.rb
@@ -1488,6 +1493,7 @@ files:
1488
1493
  - lib/ultracart_api/models/order_query.rb
1489
1494
  - lib/ultracart_api/models/order_query_batch.rb
1490
1495
  - lib/ultracart_api/models/order_quote.rb
1496
+ - lib/ultracart_api/models/order_refundable_response.rb
1491
1497
  - lib/ultracart_api/models/order_replacement.rb
1492
1498
  - lib/ultracart_api/models/order_replacement_item.rb
1493
1499
  - lib/ultracart_api/models/order_replacement_response.rb