ultracart_api 4.1.118 → 4.1.119
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.
- checksums.yaml +4 -4
- data/README.md +5 -2
- data/docs/AffiliateApi.md +55 -0
- data/docs/OrderQuery.md +2 -0
- data/docs/OrderQueryPaymentTransactionFilter.md +20 -0
- data/lib/ultracart_api/api/affiliate_api.rb +67 -0
- data/lib/ultracart_api/models/order_query.rb +13 -1
- data/lib/ultracart_api/models/order_query_payment_transaction_filter.rb +230 -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: 4cf4bee30274207012c1c3dfd2a9cd429b13d31f193ad834951370c8c02b45a0
|
|
4
|
+
data.tar.gz: 92ec72e558b07eaef77342cf40b6674b4a98b07658f8e431b2332d87d85ae381
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3fa4f9f70cfef94a728fe4e13dd9f43e1dfa0b8b06bdc674cf415a4ddd220e6f8c0c543ce7004a8db19a33310b13bbeebcd39e20da2861d3c58bcb68c5b5084e
|
|
7
|
+
data.tar.gz: e4c6815d86ee8db01ab9d862351d96e41dde30b169371684da6aabc5a860dbdb5ce5d655192fba16ae5b30f17f4229609c98eb0fc662913d50fa5a2cf5b9b625
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
9
|
- API version: 2.0.0
|
|
10
|
-
- Package version: 4.1.
|
|
10
|
+
- Package version: 4.1.119
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
- For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
|
|
|
16
16
|
gemfile:
|
|
17
17
|
|
|
18
18
|
```shell
|
|
19
|
-
gem 'ultracart_api', '4.1.
|
|
19
|
+
gem 'ultracart_api', '4.1.119'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -88,6 +88,7 @@ Class | Method | HTTP request | Description
|
|
|
88
88
|
*UltracartClient::AffiliateApi* | [**get_clicks_by_query**](docs/AffiliateApi.md#get_clicks_by_query) | **POST** /affiliate/clicks/query | Retrieve clicks
|
|
89
89
|
*UltracartClient::AffiliateApi* | [**get_ledgers_by_query**](docs/AffiliateApi.md#get_ledgers_by_query) | **POST** /affiliate/ledgers/query | Retrieve ledger entries
|
|
90
90
|
*UltracartClient::AffiliateApi* | [**insert_affiliate**](docs/AffiliateApi.md#insert_affiliate) | **POST** /affiliate/affiliates | Insert an affiliate
|
|
91
|
+
*UltracartClient::AffiliateApi* | [**send_affiliate_welcome_email**](docs/AffiliateApi.md#send_affiliate_welcome_email) | **POST** /affiliate/affiliates/{affiliate_oid}/welcome_email | Send a welcome email to an affiliate
|
|
91
92
|
*UltracartClient::AffiliateApi* | [**update_affiliate**](docs/AffiliateApi.md#update_affiliate) | **PUT** /affiliate/affiliates/{affiliate_oid} | Update an affiliate
|
|
92
93
|
*UltracartClient::AutoOrderApi* | [**cancel_auto_order_item_by_reference_order_id**](docs/AutoOrderApi.md#cancel_auto_order_item_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id}/items/original/{original_item_id}/cancel | Cancel a single item on an auto order
|
|
93
94
|
*UltracartClient::AutoOrderApi* | [**consolidate_auto_orders**](docs/AutoOrderApi.md#consolidate_auto_orders) | **PUT** /auto_order/auto_orders/{auto_order_oid}/consolidate | Consolidates multiple auto orders
|
|
@@ -1541,6 +1542,7 @@ Class | Method | HTTP request | Description
|
|
|
1541
1542
|
- [UltracartClient::OrderProperty](docs/OrderProperty.md)
|
|
1542
1543
|
- [UltracartClient::OrderQuery](docs/OrderQuery.md)
|
|
1543
1544
|
- [UltracartClient::OrderQueryBatch](docs/OrderQueryBatch.md)
|
|
1545
|
+
- [UltracartClient::OrderQueryPaymentTransactionFilter](docs/OrderQueryPaymentTransactionFilter.md)
|
|
1544
1546
|
- [UltracartClient::OrderQuote](docs/OrderQuote.md)
|
|
1545
1547
|
- [UltracartClient::OrderReason](docs/OrderReason.md)
|
|
1546
1548
|
- [UltracartClient::OrderRefundableResponse](docs/OrderRefundableResponse.md)
|
|
@@ -1823,6 +1825,7 @@ Not every change is committed to every SDK.
|
|
|
1823
1825
|
|
|
1824
1826
|
| Version | Date | Comments |
|
|
1825
1827
|
| --: | :-: | --- |
|
|
1828
|
+
| 4.1.119 | 07/15/2026 | order api - query transaction details for cache target |
|
|
1826
1829
|
| 4.1.118 | 07/14/2026 | affiliate - send welcome letter method |
|
|
1827
1830
|
| 4.1.117 | 07/14/2026 | conversation - join method resolve_only flag added |
|
|
1828
1831
|
| 4.1.116 | 07/10/2026 | customer - method to search quickbooks online customers |
|
data/docs/AffiliateApi.md
CHANGED
|
@@ -10,6 +10,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
10
10
|
| [**get_clicks_by_query**](AffiliateApi.md#get_clicks_by_query) | **POST** /affiliate/clicks/query | Retrieve clicks |
|
|
11
11
|
| [**get_ledgers_by_query**](AffiliateApi.md#get_ledgers_by_query) | **POST** /affiliate/ledgers/query | Retrieve ledger entries |
|
|
12
12
|
| [**insert_affiliate**](AffiliateApi.md#insert_affiliate) | **POST** /affiliate/affiliates | Insert an affiliate |
|
|
13
|
+
| [**send_affiliate_welcome_email**](AffiliateApi.md#send_affiliate_welcome_email) | **POST** /affiliate/affiliates/{affiliate_oid}/welcome_email | Send a welcome email to an affiliate |
|
|
13
14
|
| [**update_affiliate**](AffiliateApi.md#update_affiliate) | **PUT** /affiliate/affiliates/{affiliate_oid} | Update an affiliate |
|
|
14
15
|
|
|
15
16
|
|
|
@@ -328,6 +329,7 @@ end
|
|
|
328
329
|
| Name | Type | Description | Notes |
|
|
329
330
|
| ---- | ---- | ----------- | ----- |
|
|
330
331
|
| **affiliate** | [**Affiliate**](Affiliate.md) | Affiliate to insert | |
|
|
332
|
+
| **send_welcome_email** | **Boolean** | Whether to send a welcome email to the affiliate after it is created. Defaults to false. | [optional][default to false] |
|
|
331
333
|
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
|
332
334
|
|
|
333
335
|
### Return type
|
|
@@ -344,6 +346,59 @@ end
|
|
|
344
346
|
- **Accept**: application/json
|
|
345
347
|
|
|
346
348
|
|
|
349
|
+
## send_affiliate_welcome_email
|
|
350
|
+
|
|
351
|
+
> send_affiliate_welcome_email(affiliate_oid)
|
|
352
|
+
|
|
353
|
+
Send a welcome email to an affiliate
|
|
354
|
+
|
|
355
|
+
Sends a welcome email to the specified affiliate using the welcome letter configured on the merchant's active affiliate program.
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
### Examples
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
(No example for this operation).
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
#### Using the send_affiliate_welcome_email_with_http_info variant
|
|
365
|
+
|
|
366
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
367
|
+
|
|
368
|
+
> <Array(nil, Integer, Hash)> send_affiliate_welcome_email_with_http_info(affiliate_oid)
|
|
369
|
+
|
|
370
|
+
```ruby
|
|
371
|
+
begin
|
|
372
|
+
# Send a welcome email to an affiliate
|
|
373
|
+
data, status_code, headers = api_instance.send_affiliate_welcome_email_with_http_info(affiliate_oid)
|
|
374
|
+
p status_code # => 2xx
|
|
375
|
+
p headers # => { ... }
|
|
376
|
+
p data # => nil
|
|
377
|
+
rescue UltracartClient::ApiError => e
|
|
378
|
+
puts "Error when calling AffiliateApi->send_affiliate_welcome_email_with_http_info: #{e}"
|
|
379
|
+
end
|
|
380
|
+
```
|
|
381
|
+
|
|
382
|
+
### Parameters
|
|
383
|
+
|
|
384
|
+
| Name | Type | Description | Notes |
|
|
385
|
+
| ---- | ---- | ----------- | ----- |
|
|
386
|
+
| **affiliate_oid** | **Integer** | The affiliate oid to send the welcome email to. | |
|
|
387
|
+
|
|
388
|
+
### Return type
|
|
389
|
+
|
|
390
|
+
nil (empty response body)
|
|
391
|
+
|
|
392
|
+
### Authorization
|
|
393
|
+
|
|
394
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
395
|
+
|
|
396
|
+
### HTTP request headers
|
|
397
|
+
|
|
398
|
+
- **Content-Type**: Not defined
|
|
399
|
+
- **Accept**: application/json
|
|
400
|
+
|
|
401
|
+
|
|
347
402
|
## update_affiliate
|
|
348
403
|
|
|
349
404
|
> <AffiliateResponse> update_affiliate(affiliate_oid, affiliate, opts)
|
data/docs/OrderQuery.md
CHANGED
|
@@ -32,6 +32,7 @@
|
|
|
32
32
|
| **payment_date_begin** | **String** | Date/time that the order was successfully processed | [optional] |
|
|
33
33
|
| **payment_date_end** | **String** | Date/time that the order was successfully processed | [optional] |
|
|
34
34
|
| **payment_method** | **String** | Payment method | [optional] |
|
|
35
|
+
| **payment_transaction_filters** | [**Array<OrderQueryPaymentTransactionFilter>**](OrderQueryPaymentTransactionFilter.md) | Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache which uses the ElasticSearch cache. The origin or database path cannot search transaction details. The rotating gateway is just another pair, name equals rotatingTransactionGatewayCode or rotatingTransactionGatewayName. | [optional] |
|
|
35
36
|
| **phone** | **String** | Phone | [optional] |
|
|
36
37
|
| **postal_code** | **String** | Postal code | [optional] |
|
|
37
38
|
| **purchase_order_number** | **String** | Purchase order number | [optional] |
|
|
@@ -82,6 +83,7 @@ instance = UltracartClient::OrderQuery.new(
|
|
|
82
83
|
payment_date_begin: null,
|
|
83
84
|
payment_date_end: null,
|
|
84
85
|
payment_method: null,
|
|
86
|
+
payment_transaction_filters: null,
|
|
85
87
|
phone: null,
|
|
86
88
|
postal_code: null,
|
|
87
89
|
purchase_order_number: null,
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::OrderQueryPaymentTransactionFilter
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Transaction detail name to match exactly. Optional, omit to match the value across any detail name. | [optional] |
|
|
8
|
+
| **value** | **String** | Transaction detail value to match exactly. Required. Wildcards are not permitted. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::OrderQueryPaymentTransactionFilter.new(
|
|
16
|
+
name: null,
|
|
17
|
+
value: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -401,6 +401,7 @@ module UltracartClient
|
|
|
401
401
|
# Insert an affiliate on the UltraCart account. The affiliate is created within the merchant's active affiliate program.
|
|
402
402
|
# @param affiliate [Affiliate] Affiliate to insert
|
|
403
403
|
# @param [Hash] opts the optional parameters
|
|
404
|
+
# @option opts [Boolean] :send_welcome_email Whether to send a welcome email to the affiliate after it is created. Defaults to false. (default to false)
|
|
404
405
|
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
405
406
|
# @return [AffiliateResponse]
|
|
406
407
|
def insert_affiliate(affiliate, opts = {})
|
|
@@ -412,6 +413,7 @@ module UltracartClient
|
|
|
412
413
|
# Insert an affiliate on the UltraCart account. The affiliate is created within the merchant's active affiliate program.
|
|
413
414
|
# @param affiliate [Affiliate] Affiliate to insert
|
|
414
415
|
# @param [Hash] opts the optional parameters
|
|
416
|
+
# @option opts [Boolean] :send_welcome_email Whether to send a welcome email to the affiliate after it is created. Defaults to false. (default to false)
|
|
415
417
|
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
416
418
|
# @return [Array<(AffiliateResponse, Integer, Hash)>] AffiliateResponse data, response status code and response headers
|
|
417
419
|
def insert_affiliate_with_http_info(affiliate, opts = {})
|
|
@@ -427,6 +429,7 @@ module UltracartClient
|
|
|
427
429
|
|
|
428
430
|
# query parameters
|
|
429
431
|
query_params = opts[:query_params] || {}
|
|
432
|
+
query_params[:'send_welcome_email'] = opts[:'send_welcome_email'] if !opts[:'send_welcome_email'].nil?
|
|
430
433
|
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
|
431
434
|
|
|
432
435
|
# header parameters
|
|
@@ -469,6 +472,70 @@ module UltracartClient
|
|
|
469
472
|
return data, status_code, headers
|
|
470
473
|
end
|
|
471
474
|
|
|
475
|
+
# Send a welcome email to an affiliate
|
|
476
|
+
# Sends a welcome email to the specified affiliate using the welcome letter configured on the merchant's active affiliate program.
|
|
477
|
+
# @param affiliate_oid [Integer] The affiliate oid to send the welcome email to.
|
|
478
|
+
# @param [Hash] opts the optional parameters
|
|
479
|
+
# @return [nil]
|
|
480
|
+
def send_affiliate_welcome_email(affiliate_oid, opts = {})
|
|
481
|
+
send_affiliate_welcome_email_with_http_info(affiliate_oid, opts)
|
|
482
|
+
nil
|
|
483
|
+
end
|
|
484
|
+
|
|
485
|
+
# Send a welcome email to an affiliate
|
|
486
|
+
# Sends a welcome email to the specified affiliate using the welcome letter configured on the merchant's active affiliate program.
|
|
487
|
+
# @param affiliate_oid [Integer] The affiliate oid to send the welcome email to.
|
|
488
|
+
# @param [Hash] opts the optional parameters
|
|
489
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
490
|
+
def send_affiliate_welcome_email_with_http_info(affiliate_oid, opts = {})
|
|
491
|
+
if @api_client.config.debugging
|
|
492
|
+
@api_client.config.logger.debug 'Calling API: AffiliateApi.send_affiliate_welcome_email ...'
|
|
493
|
+
end
|
|
494
|
+
# verify the required parameter 'affiliate_oid' is set
|
|
495
|
+
if @api_client.config.client_side_validation && affiliate_oid.nil?
|
|
496
|
+
fail ArgumentError, "Missing the required parameter 'affiliate_oid' when calling AffiliateApi.send_affiliate_welcome_email"
|
|
497
|
+
end
|
|
498
|
+
# resource path
|
|
499
|
+
local_var_path = '/affiliate/affiliates/{affiliate_oid}/welcome_email'.sub('{' + 'affiliate_oid' + '}', CGI.escape(affiliate_oid.to_s))
|
|
500
|
+
|
|
501
|
+
# query parameters
|
|
502
|
+
query_params = opts[:query_params] || {}
|
|
503
|
+
|
|
504
|
+
# header parameters
|
|
505
|
+
header_params = opts[:header_params] || {}
|
|
506
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
507
|
+
# HTTP header 'Accept' (if needed)
|
|
508
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
509
|
+
|
|
510
|
+
# form parameters
|
|
511
|
+
form_params = opts[:form_params] || {}
|
|
512
|
+
|
|
513
|
+
# http body (model)
|
|
514
|
+
post_body = opts[:debug_body]
|
|
515
|
+
|
|
516
|
+
# return_type
|
|
517
|
+
return_type = opts[:debug_return_type]
|
|
518
|
+
|
|
519
|
+
# auth_names
|
|
520
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
521
|
+
|
|
522
|
+
new_options = opts.merge(
|
|
523
|
+
:operation => :"AffiliateApi.send_affiliate_welcome_email",
|
|
524
|
+
:header_params => header_params,
|
|
525
|
+
:query_params => query_params,
|
|
526
|
+
:form_params => form_params,
|
|
527
|
+
:body => post_body,
|
|
528
|
+
:auth_names => auth_names,
|
|
529
|
+
:return_type => return_type
|
|
530
|
+
)
|
|
531
|
+
|
|
532
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
533
|
+
if @api_client.config.debugging
|
|
534
|
+
@api_client.config.logger.debug "API called: AffiliateApi#send_affiliate_welcome_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
535
|
+
end
|
|
536
|
+
return data, status_code, headers
|
|
537
|
+
end
|
|
538
|
+
|
|
472
539
|
# Update an affiliate
|
|
473
540
|
# Update an affiliate on the UltraCart account. This is a full replacement of the affiliate; omitted fields are reset to their defaults, with the exception of password which is only changed when supplied.
|
|
474
541
|
# @param affiliate_oid [Integer] The affiliate oid to update.
|
|
@@ -99,6 +99,9 @@ module UltracartClient
|
|
|
99
99
|
# Payment method
|
|
100
100
|
attr_accessor :payment_method
|
|
101
101
|
|
|
102
|
+
# Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache which uses the ElasticSearch cache. The origin or database path cannot search transaction details. The rotating gateway is just another pair, name equals rotatingTransactionGatewayCode or rotatingTransactionGatewayName.
|
|
103
|
+
attr_accessor :payment_transaction_filters
|
|
104
|
+
|
|
102
105
|
# Phone
|
|
103
106
|
attr_accessor :phone
|
|
104
107
|
|
|
@@ -197,6 +200,7 @@ module UltracartClient
|
|
|
197
200
|
:'payment_date_begin' => :'payment_date_begin',
|
|
198
201
|
:'payment_date_end' => :'payment_date_end',
|
|
199
202
|
:'payment_method' => :'payment_method',
|
|
203
|
+
:'payment_transaction_filters' => :'payment_transaction_filters',
|
|
200
204
|
:'phone' => :'phone',
|
|
201
205
|
:'postal_code' => :'postal_code',
|
|
202
206
|
:'purchase_order_number' => :'purchase_order_number',
|
|
@@ -251,6 +255,7 @@ module UltracartClient
|
|
|
251
255
|
:'payment_date_begin' => :'String',
|
|
252
256
|
:'payment_date_end' => :'String',
|
|
253
257
|
:'payment_method' => :'String',
|
|
258
|
+
:'payment_transaction_filters' => :'Array<OrderQueryPaymentTransactionFilter>',
|
|
254
259
|
:'phone' => :'String',
|
|
255
260
|
:'postal_code' => :'String',
|
|
256
261
|
:'purchase_order_number' => :'String',
|
|
@@ -402,6 +407,12 @@ module UltracartClient
|
|
|
402
407
|
self.payment_method = attributes[:'payment_method']
|
|
403
408
|
end
|
|
404
409
|
|
|
410
|
+
if attributes.key?(:'payment_transaction_filters')
|
|
411
|
+
if (value = attributes[:'payment_transaction_filters']).is_a?(Array)
|
|
412
|
+
self.payment_transaction_filters = value
|
|
413
|
+
end
|
|
414
|
+
end
|
|
415
|
+
|
|
405
416
|
if attributes.key?(:'phone')
|
|
406
417
|
self.phone = attributes[:'phone']
|
|
407
418
|
end
|
|
@@ -725,6 +736,7 @@ module UltracartClient
|
|
|
725
736
|
payment_date_begin == o.payment_date_begin &&
|
|
726
737
|
payment_date_end == o.payment_date_end &&
|
|
727
738
|
payment_method == o.payment_method &&
|
|
739
|
+
payment_transaction_filters == o.payment_transaction_filters &&
|
|
728
740
|
phone == o.phone &&
|
|
729
741
|
postal_code == o.postal_code &&
|
|
730
742
|
purchase_order_number == o.purchase_order_number &&
|
|
@@ -751,7 +763,7 @@ module UltracartClient
|
|
|
751
763
|
# Calculates hash code according to all attributes.
|
|
752
764
|
# @return [Integer] Hash code
|
|
753
765
|
def hash
|
|
754
|
-
[cc_email, channel_partner_code, channel_partner_order_id, city, company, country_code, creation_date_begin, creation_date_end, current_stage, custom_field_1, custom_field_10, custom_field_2, custom_field_3, custom_field_4, custom_field_5, custom_field_6, custom_field_7, custom_field_8, custom_field_9, customer_profile_oid, email, first_name, item_id, last_name, order_id, payment_date_begin, payment_date_end, payment_method, phone, postal_code, purchase_order_number, query_target, refund_date_begin, refund_date_end, rma, screen_branding_theme_code, shipment_date_begin, shipment_date_end, shipped_on_date_begin, shipped_on_date_end, state_region, storefront_host_name, total].hash
|
|
766
|
+
[cc_email, channel_partner_code, channel_partner_order_id, city, company, country_code, creation_date_begin, creation_date_end, current_stage, custom_field_1, custom_field_10, custom_field_2, custom_field_3, custom_field_4, custom_field_5, custom_field_6, custom_field_7, custom_field_8, custom_field_9, customer_profile_oid, email, first_name, item_id, last_name, order_id, payment_date_begin, payment_date_end, payment_method, payment_transaction_filters, phone, postal_code, purchase_order_number, query_target, refund_date_begin, refund_date_end, rma, screen_branding_theme_code, shipment_date_begin, shipment_date_end, shipped_on_date_begin, shipped_on_date_end, state_region, storefront_host_name, total].hash
|
|
755
767
|
end
|
|
756
768
|
|
|
757
769
|
# Builds the object from hash
|
|
@@ -0,0 +1,230 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#UltraCart Rest API V2
|
|
3
|
+
|
|
4
|
+
#UltraCart REST API Version 2
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 2.0.0
|
|
7
|
+
Contact: support@ultracart.com
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
OpenAPI Generator version: 6.0.1-SNAPSHOT
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'date'
|
|
14
|
+
require 'time'
|
|
15
|
+
|
|
16
|
+
module UltracartClient
|
|
17
|
+
class OrderQueryPaymentTransactionFilter
|
|
18
|
+
# Transaction detail name to match exactly. Optional, omit to match the value across any detail name.
|
|
19
|
+
attr_accessor :name
|
|
20
|
+
|
|
21
|
+
# Transaction detail value to match exactly. Required. Wildcards are not permitted.
|
|
22
|
+
attr_accessor :value
|
|
23
|
+
|
|
24
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
25
|
+
def self.attribute_map
|
|
26
|
+
{
|
|
27
|
+
:'name' => :'name',
|
|
28
|
+
:'value' => :'value'
|
|
29
|
+
}
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Returns all the JSON keys this model knows about
|
|
33
|
+
def self.acceptable_attributes
|
|
34
|
+
attribute_map.values
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# Attribute type mapping.
|
|
38
|
+
def self.openapi_types
|
|
39
|
+
{
|
|
40
|
+
:'name' => :'String',
|
|
41
|
+
:'value' => :'String'
|
|
42
|
+
}
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
# List of attributes with nullable: true
|
|
46
|
+
def self.openapi_nullable
|
|
47
|
+
Set.new([
|
|
48
|
+
])
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# Initializes the object
|
|
52
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
53
|
+
def initialize(attributes = {})
|
|
54
|
+
if (!attributes.is_a?(Hash))
|
|
55
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::OrderQueryPaymentTransactionFilter` initialize method"
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
59
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
60
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
|
61
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::OrderQueryPaymentTransactionFilter`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
|
62
|
+
end
|
|
63
|
+
h[k.to_sym] = v
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
if attributes.key?(:'name')
|
|
67
|
+
self.name = attributes[:'name']
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
if attributes.key?(:'value')
|
|
71
|
+
self.value = attributes[:'value']
|
|
72
|
+
end
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
76
|
+
# @return Array for valid properties with the reasons
|
|
77
|
+
def list_invalid_properties
|
|
78
|
+
invalid_properties = Array.new
|
|
79
|
+
invalid_properties
|
|
80
|
+
end
|
|
81
|
+
|
|
82
|
+
# Check to see if the all the properties in the model are valid
|
|
83
|
+
# @return true if the model is valid
|
|
84
|
+
def valid?
|
|
85
|
+
true
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
# Checks equality by comparing each attribute.
|
|
89
|
+
# @param [Object] Object to be compared
|
|
90
|
+
def ==(o)
|
|
91
|
+
return true if self.equal?(o)
|
|
92
|
+
self.class == o.class &&
|
|
93
|
+
name == o.name &&
|
|
94
|
+
value == o.value
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
# @see the `==` method
|
|
98
|
+
# @param [Object] Object to be compared
|
|
99
|
+
def eql?(o)
|
|
100
|
+
self == o
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
# Calculates hash code according to all attributes.
|
|
104
|
+
# @return [Integer] Hash code
|
|
105
|
+
def hash
|
|
106
|
+
[name, value].hash
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
# Builds the object from hash
|
|
110
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
111
|
+
# @return [Object] Returns the model itself
|
|
112
|
+
def self.build_from_hash(attributes)
|
|
113
|
+
new.build_from_hash(attributes)
|
|
114
|
+
end
|
|
115
|
+
|
|
116
|
+
# Builds the object from hash
|
|
117
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
118
|
+
# @return [Object] Returns the model itself
|
|
119
|
+
def build_from_hash(attributes)
|
|
120
|
+
return nil unless attributes.is_a?(Hash)
|
|
121
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
122
|
+
self.class.openapi_types.each_pair do |key, type|
|
|
123
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
|
124
|
+
self.send("#{key}=", nil)
|
|
125
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
126
|
+
# check to ensure the input is an array given that the attribute
|
|
127
|
+
# is documented as an array but the input is not
|
|
128
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
129
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
|
130
|
+
end
|
|
131
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
132
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
133
|
+
end
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
self
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
# Deserializes the data based on type
|
|
140
|
+
# @param string type Data type
|
|
141
|
+
# @param string value Value to be deserialized
|
|
142
|
+
# @return [Object] Deserialized data
|
|
143
|
+
def _deserialize(type, value)
|
|
144
|
+
case type.to_sym
|
|
145
|
+
when :Time
|
|
146
|
+
Time.parse(value)
|
|
147
|
+
when :Date
|
|
148
|
+
Date.parse(value)
|
|
149
|
+
when :String
|
|
150
|
+
value.to_s
|
|
151
|
+
when :Integer
|
|
152
|
+
value.to_i
|
|
153
|
+
when :Float
|
|
154
|
+
value.to_f
|
|
155
|
+
when :Boolean
|
|
156
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
157
|
+
true
|
|
158
|
+
else
|
|
159
|
+
false
|
|
160
|
+
end
|
|
161
|
+
when :Object
|
|
162
|
+
# generic object (usually a Hash), return directly
|
|
163
|
+
value
|
|
164
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
165
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
166
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
167
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
168
|
+
k_type = Regexp.last_match[:k_type]
|
|
169
|
+
v_type = Regexp.last_match[:v_type]
|
|
170
|
+
{}.tap do |hash|
|
|
171
|
+
value.each do |k, v|
|
|
172
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
173
|
+
end
|
|
174
|
+
end
|
|
175
|
+
else # model
|
|
176
|
+
# models (e.g. Pet) or oneOf
|
|
177
|
+
klass = UltracartClient.const_get(type)
|
|
178
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
|
179
|
+
end
|
|
180
|
+
end
|
|
181
|
+
|
|
182
|
+
# Returns the string representation of the object
|
|
183
|
+
# @return [String] String presentation of the object
|
|
184
|
+
def to_s
|
|
185
|
+
to_hash.to_s
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
189
|
+
# @return [Hash] Returns the object in the form of hash
|
|
190
|
+
def to_body
|
|
191
|
+
to_hash
|
|
192
|
+
end
|
|
193
|
+
|
|
194
|
+
# Returns the object in the form of hash
|
|
195
|
+
# @return [Hash] Returns the object in the form of hash
|
|
196
|
+
def to_hash
|
|
197
|
+
hash = {}
|
|
198
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
199
|
+
value = self.send(attr)
|
|
200
|
+
if value.nil?
|
|
201
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
202
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
203
|
+
end
|
|
204
|
+
|
|
205
|
+
hash[param] = _to_hash(value)
|
|
206
|
+
end
|
|
207
|
+
hash
|
|
208
|
+
end
|
|
209
|
+
|
|
210
|
+
# Outputs non-array value in the form of hash
|
|
211
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
212
|
+
# @param [Object] value Any valid value
|
|
213
|
+
# @return [Hash] Returns the value in the form of hash
|
|
214
|
+
def _to_hash(value)
|
|
215
|
+
if value.is_a?(Array)
|
|
216
|
+
value.compact.map { |v| _to_hash(v) }
|
|
217
|
+
elsif value.is_a?(Hash)
|
|
218
|
+
{}.tap do |hash|
|
|
219
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
220
|
+
end
|
|
221
|
+
elsif value.respond_to? :to_hash
|
|
222
|
+
value.to_hash
|
|
223
|
+
else
|
|
224
|
+
value
|
|
225
|
+
end
|
|
226
|
+
end
|
|
227
|
+
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
end
|
data/lib/ultracart_api.rb
CHANGED
|
@@ -842,6 +842,7 @@ require 'ultracart_api/models/order_process_payment_response'
|
|
|
842
842
|
require 'ultracart_api/models/order_property'
|
|
843
843
|
require 'ultracart_api/models/order_query'
|
|
844
844
|
require 'ultracart_api/models/order_query_batch'
|
|
845
|
+
require 'ultracart_api/models/order_query_payment_transaction_filter'
|
|
845
846
|
require 'ultracart_api/models/order_quote'
|
|
846
847
|
require 'ultracart_api/models/order_reason'
|
|
847
848
|
require 'ultracart_api/models/order_refundable_response'
|
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: 4.1.
|
|
4
|
+
version: 4.1.119
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- UltraCart
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-07-
|
|
11
|
+
date: 2026-07-15 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|
|
@@ -903,6 +903,7 @@ files:
|
|
|
903
903
|
- docs/OrderProperty.md
|
|
904
904
|
- docs/OrderQuery.md
|
|
905
905
|
- docs/OrderQueryBatch.md
|
|
906
|
+
- docs/OrderQueryPaymentTransactionFilter.md
|
|
906
907
|
- docs/OrderQuote.md
|
|
907
908
|
- docs/OrderReason.md
|
|
908
909
|
- docs/OrderRefundableResponse.md
|
|
@@ -1967,6 +1968,7 @@ files:
|
|
|
1967
1968
|
- lib/ultracart_api/models/order_property.rb
|
|
1968
1969
|
- lib/ultracart_api/models/order_query.rb
|
|
1969
1970
|
- lib/ultracart_api/models/order_query_batch.rb
|
|
1971
|
+
- lib/ultracart_api/models/order_query_payment_transaction_filter.rb
|
|
1970
1972
|
- lib/ultracart_api/models/order_quote.rb
|
|
1971
1973
|
- lib/ultracart_api/models/order_reason.rb
|
|
1972
1974
|
- lib/ultracart_api/models/order_refundable_response.rb
|