ultracart_api 3.2.14 → 3.2.15
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 +8 -4
- data/docs/EmailCommseqStepLog.md +10 -0
- data/docs/EmailCommseqStepLogsResponse.md +12 -0
- data/docs/StorefrontApi.md +55 -0
- data/lib/ultracart_api.rb +2 -0
- data/lib/ultracart_api/api/storefront_api.rb +65 -0
- data/lib/ultracart_api/models/email_commseq_step_log.rb +205 -0
- data/lib/ultracart_api/models/email_commseq_step_logs_response.rb +223 -0
- data/lib/ultracart_api/version.rb +1 -1
- metadata +6 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bc9bde08cb99dbff1869db3b6d3ea61df1c1dd099efa422b66c67bd46eb73d0d
|
|
4
|
+
data.tar.gz: 9f741b906df5a4e79f3998c46d82c5f6ae3177e1400c34b0dd097aeea1afae14
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b6a920d32426b5c3bbad90dfa18794bcbc0a694055e9eafbce2b40be47dc3741a02028015dceefafc71c2ecdad48a2623bd4f4373152019c56ddfb18d9cb9506
|
|
7
|
+
data.tar.gz: 209ce5b9f0ea5267ddce634399390936d410e4058283757a0f74a9aaaf4ddc0b497c105d692450388462ec2fbc00dc9f95dd400647c21a0261030c08ccd8c883
|
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.2.
|
|
10
|
+
- Package version: 3.2.15
|
|
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.2.
|
|
27
|
+
gem install ./ultracart_api-3.2.15.gem
|
|
28
28
|
```
|
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.2.
|
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.2.15.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.2.
|
|
35
|
+
gem 'ultracart_api', '~> 3.2.15'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -238,6 +238,7 @@ Class | Method | HTTP request | Description
|
|
|
238
238
|
*UltracartClient::StorefrontApi* | [**get_email_customers**](docs/StorefrontApi.md#get_email_customers) | **GET** /storefront/{storefront_oid}/email/customers | Get email customers
|
|
239
239
|
*UltracartClient::StorefrontApi* | [**get_email_dashboard_activity**](docs/StorefrontApi.md#get_email_dashboard_activity) | **GET** /storefront/{storefront_oid}/email/dashboard_activity | Get email dashboard activity
|
|
240
240
|
*UltracartClient::StorefrontApi* | [**get_email_dashboard_stats**](docs/StorefrontApi.md#get_email_dashboard_stats) | **GET** /storefront/{storefront_oid}/email/dashboard_stats | Get dashboard stats
|
|
241
|
+
*UltracartClient::StorefrontApi* | [**get_email_dispatch_logs**](docs/StorefrontApi.md#get_email_dispatch_logs) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/logs | Get email dispatch logs
|
|
241
242
|
*UltracartClient::StorefrontApi* | [**get_email_email**](docs/StorefrontApi.md#get_email_email) | **GET** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Get email email
|
|
242
243
|
*UltracartClient::StorefrontApi* | [**get_email_email_clicks**](docs/StorefrontApi.md#get_email_email_clicks) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/clicks | Get email email clicks
|
|
243
244
|
*UltracartClient::StorefrontApi* | [**get_email_email_customer_editor_url**](docs/StorefrontApi.md#get_email_email_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/orders/{order_id}/editor_url | Get email order customer editor url
|
|
@@ -610,6 +611,8 @@ Class | Method | HTTP request | Description
|
|
|
610
611
|
- [UltracartClient::EmailCommseqStat](docs/EmailCommseqStat.md)
|
|
611
612
|
- [UltracartClient::EmailCommseqStatResponse](docs/EmailCommseqStatResponse.md)
|
|
612
613
|
- [UltracartClient::EmailCommseqStep](docs/EmailCommseqStep.md)
|
|
614
|
+
- [UltracartClient::EmailCommseqStepLog](docs/EmailCommseqStepLog.md)
|
|
615
|
+
- [UltracartClient::EmailCommseqStepLogsResponse](docs/EmailCommseqStepLogsResponse.md)
|
|
613
616
|
- [UltracartClient::EmailCommseqsResponse](docs/EmailCommseqsResponse.md)
|
|
614
617
|
- [UltracartClient::EmailCustomer](docs/EmailCustomer.md)
|
|
615
618
|
- [UltracartClient::EmailCustomerEditorUrlResponse](docs/EmailCustomerEditorUrlResponse.md)
|
|
@@ -1035,6 +1038,7 @@ Not every change is committed to every SDK.
|
|
|
1035
1038
|
|
|
1036
1039
|
| Version | Date | Comments |
|
|
1037
1040
|
| --: | :-: | --- |
|
|
1041
|
+
| 3.2.15 | 07/13/2021 | storefront communications - added methods to retrieve step dispatch logs |
|
|
1038
1042
|
| 3.2.14 | 07/12/2021 | fix documentation bug on packing slip methods for order api |
|
|
1039
1043
|
| 3.2.13 | 07/12/2021 | coupon api - added hideFromCustomer flag |
|
|
1040
1044
|
| 3.2.12 | 07/09/2021 | new fulfillment and order methods for generation of packing slips |
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# UltracartClient::EmailCommseqStepLog
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**email** | **String** | Email | [optional]
|
|
7
|
+
**log** | **String** | Log text | [optional]
|
|
8
|
+
**log_dts** | **String** | Log date/time | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::EmailCommseqStepLogsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
|
7
|
+
**logs** | [**Array<EmailCommseqStepLog>**](EmailCommseqStepLog.md) | | [optional]
|
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
|
data/docs/StorefrontApi.md
CHANGED
|
@@ -48,6 +48,7 @@ Method | HTTP request | Description
|
|
|
48
48
|
[**get_email_customers**](StorefrontApi.md#get_email_customers) | **GET** /storefront/{storefront_oid}/email/customers | Get email customers
|
|
49
49
|
[**get_email_dashboard_activity**](StorefrontApi.md#get_email_dashboard_activity) | **GET** /storefront/{storefront_oid}/email/dashboard_activity | Get email dashboard activity
|
|
50
50
|
[**get_email_dashboard_stats**](StorefrontApi.md#get_email_dashboard_stats) | **GET** /storefront/{storefront_oid}/email/dashboard_stats | Get dashboard stats
|
|
51
|
+
[**get_email_dispatch_logs**](StorefrontApi.md#get_email_dispatch_logs) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/logs | Get email dispatch logs
|
|
51
52
|
[**get_email_email**](StorefrontApi.md#get_email_email) | **GET** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Get email email
|
|
52
53
|
[**get_email_email_clicks**](StorefrontApi.md#get_email_email_clicks) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/clicks | Get email email clicks
|
|
53
54
|
[**get_email_email_customer_editor_url**](StorefrontApi.md#get_email_email_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid}/orders/{order_id}/editor_url | Get email order customer editor url
|
|
@@ -2395,6 +2396,60 @@ Name | Type | Description | Notes
|
|
|
2395
2396
|
|
|
2396
2397
|
|
|
2397
2398
|
|
|
2399
|
+
# **get_email_dispatch_logs**
|
|
2400
|
+
> EmailCommseqStepLogsResponse get_email_dispatch_logs(storefront_oid, commseq_uuid, commseq_step_uuid)
|
|
2401
|
+
|
|
2402
|
+
Get email dispatch logs
|
|
2403
|
+
|
|
2404
|
+
### Example
|
|
2405
|
+
```ruby
|
|
2406
|
+
# load the gem
|
|
2407
|
+
require 'ultracart_api'
|
|
2408
|
+
|
|
2409
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
2410
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
2411
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
|
2412
|
+
|
|
2413
|
+
|
|
2414
|
+
storefront_oid = 56 # Integer |
|
|
2415
|
+
|
|
2416
|
+
commseq_uuid = 'commseq_uuid_example' # String |
|
|
2417
|
+
|
|
2418
|
+
commseq_step_uuid = 'commseq_step_uuid_example' # String |
|
|
2419
|
+
|
|
2420
|
+
|
|
2421
|
+
begin
|
|
2422
|
+
#Get email dispatch logs
|
|
2423
|
+
result = api_instance.get_email_dispatch_logs(storefront_oid, commseq_uuid, commseq_step_uuid)
|
|
2424
|
+
p result
|
|
2425
|
+
rescue UltracartClient::ApiError => e
|
|
2426
|
+
puts "Exception when calling StorefrontApi->get_email_dispatch_logs: #{e}"
|
|
2427
|
+
end
|
|
2428
|
+
```
|
|
2429
|
+
|
|
2430
|
+
### Parameters
|
|
2431
|
+
|
|
2432
|
+
Name | Type | Description | Notes
|
|
2433
|
+
------------- | ------------- | ------------- | -------------
|
|
2434
|
+
**storefront_oid** | **Integer**| |
|
|
2435
|
+
**commseq_uuid** | **String**| |
|
|
2436
|
+
**commseq_step_uuid** | **String**| |
|
|
2437
|
+
|
|
2438
|
+
### Return type
|
|
2439
|
+
|
|
2440
|
+
[**EmailCommseqStepLogsResponse**](EmailCommseqStepLogsResponse.md)
|
|
2441
|
+
|
|
2442
|
+
### Authorization
|
|
2443
|
+
|
|
2444
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2445
|
+
|
|
2446
|
+
### HTTP request headers
|
|
2447
|
+
|
|
2448
|
+
- **Content-Type**: application/json
|
|
2449
|
+
- **Accept**: application/json
|
|
2450
|
+
|
|
2451
|
+
|
|
2452
|
+
|
|
2398
2453
|
# **get_email_email**
|
|
2399
2454
|
> EmailCommseqEmailResponse get_email_email(storefront_oid, commseq_email_uuid)
|
|
2400
2455
|
|
data/lib/ultracart_api.rb
CHANGED
|
@@ -235,6 +235,8 @@ require 'ultracart_api/models/email_commseq_response'
|
|
|
235
235
|
require 'ultracart_api/models/email_commseq_stat'
|
|
236
236
|
require 'ultracart_api/models/email_commseq_stat_response'
|
|
237
237
|
require 'ultracart_api/models/email_commseq_step'
|
|
238
|
+
require 'ultracart_api/models/email_commseq_step_log'
|
|
239
|
+
require 'ultracart_api/models/email_commseq_step_logs_response'
|
|
238
240
|
require 'ultracart_api/models/email_commseqs_response'
|
|
239
241
|
require 'ultracart_api/models/email_customer'
|
|
240
242
|
require 'ultracart_api/models/email_customer_editor_url_response'
|
|
@@ -2596,6 +2596,71 @@ module UltracartClient
|
|
|
2596
2596
|
end
|
|
2597
2597
|
return data, status_code, headers
|
|
2598
2598
|
end
|
|
2599
|
+
# Get email dispatch logs
|
|
2600
|
+
# @param storefront_oid
|
|
2601
|
+
# @param commseq_uuid
|
|
2602
|
+
# @param commseq_step_uuid
|
|
2603
|
+
# @param [Hash] opts the optional parameters
|
|
2604
|
+
# @return [EmailCommseqStepLogsResponse]
|
|
2605
|
+
def get_email_dispatch_logs(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
|
|
2606
|
+
data, _status_code, _headers = get_email_dispatch_logs_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
|
|
2607
|
+
data
|
|
2608
|
+
end
|
|
2609
|
+
|
|
2610
|
+
# Get email dispatch logs
|
|
2611
|
+
# @param storefront_oid
|
|
2612
|
+
# @param commseq_uuid
|
|
2613
|
+
# @param commseq_step_uuid
|
|
2614
|
+
# @param [Hash] opts the optional parameters
|
|
2615
|
+
# @return [Array<(EmailCommseqStepLogsResponse, Fixnum, Hash)>] EmailCommseqStepLogsResponse data, response status code and response headers
|
|
2616
|
+
def get_email_dispatch_logs_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts = {})
|
|
2617
|
+
if @api_client.config.debugging
|
|
2618
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_dispatch_logs ...'
|
|
2619
|
+
end
|
|
2620
|
+
# verify the required parameter 'storefront_oid' is set
|
|
2621
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
|
2622
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_dispatch_logs"
|
|
2623
|
+
end
|
|
2624
|
+
# verify the required parameter 'commseq_uuid' is set
|
|
2625
|
+
if @api_client.config.client_side_validation && commseq_uuid.nil?
|
|
2626
|
+
fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.get_email_dispatch_logs"
|
|
2627
|
+
end
|
|
2628
|
+
# verify the required parameter 'commseq_step_uuid' is set
|
|
2629
|
+
if @api_client.config.client_side_validation && commseq_step_uuid.nil?
|
|
2630
|
+
fail ArgumentError, "Missing the required parameter 'commseq_step_uuid' when calling StorefrontApi.get_email_dispatch_logs"
|
|
2631
|
+
end
|
|
2632
|
+
# resource path
|
|
2633
|
+
local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/logs'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s).sub('{' + 'commseq_uuid' + '}', commseq_uuid.to_s).sub('{' + 'commseq_step_uuid' + '}', commseq_step_uuid.to_s)
|
|
2634
|
+
|
|
2635
|
+
# query parameters
|
|
2636
|
+
query_params = {}
|
|
2637
|
+
|
|
2638
|
+
# header parameters
|
|
2639
|
+
header_params = {}
|
|
2640
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
2641
|
+
# HTTP header 'Accept' (if needed)
|
|
2642
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2643
|
+
# HTTP header 'Content-Type'
|
|
2644
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
2645
|
+
|
|
2646
|
+
# form parameters
|
|
2647
|
+
form_params = {}
|
|
2648
|
+
|
|
2649
|
+
# http body (model)
|
|
2650
|
+
post_body = nil
|
|
2651
|
+
auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
2652
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
2653
|
+
:header_params => header_params,
|
|
2654
|
+
:query_params => query_params,
|
|
2655
|
+
:form_params => form_params,
|
|
2656
|
+
:body => post_body,
|
|
2657
|
+
:auth_names => auth_names,
|
|
2658
|
+
:return_type => 'EmailCommseqStepLogsResponse')
|
|
2659
|
+
if @api_client.config.debugging
|
|
2660
|
+
@api_client.config.logger.debug "API called: StorefrontApi#get_email_dispatch_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2661
|
+
end
|
|
2662
|
+
return data, status_code, headers
|
|
2663
|
+
end
|
|
2599
2664
|
# Get email email
|
|
2600
2665
|
# @param storefront_oid
|
|
2601
2666
|
# @param commseq_email_uuid
|
|
@@ -0,0 +1,205 @@
|
|
|
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 EmailCommseqStepLog
|
|
17
|
+
# Email
|
|
18
|
+
attr_accessor :email
|
|
19
|
+
|
|
20
|
+
# Log text
|
|
21
|
+
attr_accessor :log
|
|
22
|
+
|
|
23
|
+
# Log date/time
|
|
24
|
+
attr_accessor :log_dts
|
|
25
|
+
|
|
26
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
27
|
+
def self.attribute_map
|
|
28
|
+
{
|
|
29
|
+
:'email' => :'email',
|
|
30
|
+
:'log' => :'log',
|
|
31
|
+
:'log_dts' => :'log_dts'
|
|
32
|
+
}
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# Attribute type mapping.
|
|
36
|
+
def self.swagger_types
|
|
37
|
+
{
|
|
38
|
+
:'email' => :'String',
|
|
39
|
+
:'log' => :'String',
|
|
40
|
+
:'log_dts' => :'String'
|
|
41
|
+
}
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
# Initializes the object
|
|
45
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
46
|
+
def initialize(attributes = {})
|
|
47
|
+
return unless attributes.is_a?(Hash)
|
|
48
|
+
|
|
49
|
+
# convert string to symbol for hash key
|
|
50
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
|
51
|
+
|
|
52
|
+
if attributes.has_key?(:'email')
|
|
53
|
+
self.email = attributes[:'email']
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
if attributes.has_key?(:'log')
|
|
57
|
+
self.log = attributes[:'log']
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
if attributes.has_key?(:'log_dts')
|
|
61
|
+
self.log_dts = attributes[:'log_dts']
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
66
|
+
# @return Array for valid properties with the reasons
|
|
67
|
+
def list_invalid_properties
|
|
68
|
+
invalid_properties = Array.new
|
|
69
|
+
invalid_properties
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
# Check to see if the all the properties in the model are valid
|
|
73
|
+
# @return true if the model is valid
|
|
74
|
+
def valid?
|
|
75
|
+
true
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
# Checks equality by comparing each attribute.
|
|
79
|
+
# @param [Object] Object to be compared
|
|
80
|
+
def ==(o)
|
|
81
|
+
return true if self.equal?(o)
|
|
82
|
+
self.class == o.class &&
|
|
83
|
+
email == o.email &&
|
|
84
|
+
log == o.log &&
|
|
85
|
+
log_dts == o.log_dts
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
# @see the `==` method
|
|
89
|
+
# @param [Object] Object to be compared
|
|
90
|
+
def eql?(o)
|
|
91
|
+
self == o
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
# Calculates hash code according to all attributes.
|
|
95
|
+
# @return [Fixnum] Hash code
|
|
96
|
+
def hash
|
|
97
|
+
[email, log, log_dts].hash
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
# Builds the object from hash
|
|
101
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
102
|
+
# @return [Object] Returns the model itself
|
|
103
|
+
def build_from_hash(attributes)
|
|
104
|
+
return nil unless attributes.is_a?(Hash)
|
|
105
|
+
self.class.swagger_types.each_pair do |key, type|
|
|
106
|
+
if type =~ /\AArray<(.*)>/i
|
|
107
|
+
# check to ensure the input is an array given that the attribute
|
|
108
|
+
# is documented as an array but the input is not
|
|
109
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
110
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
|
111
|
+
end
|
|
112
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
113
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
114
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
self
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
# Deserializes the data based on type
|
|
121
|
+
# @param string type Data type
|
|
122
|
+
# @param string value Value to be deserialized
|
|
123
|
+
# @return [Object] Deserialized data
|
|
124
|
+
def _deserialize(type, value)
|
|
125
|
+
case type.to_sym
|
|
126
|
+
when :DateTime
|
|
127
|
+
DateTime.parse(value)
|
|
128
|
+
when :Date
|
|
129
|
+
Date.parse(value)
|
|
130
|
+
when :String
|
|
131
|
+
value.to_s
|
|
132
|
+
when :Integer
|
|
133
|
+
value.to_i
|
|
134
|
+
when :Float
|
|
135
|
+
value.to_f
|
|
136
|
+
when :BOOLEAN
|
|
137
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
138
|
+
true
|
|
139
|
+
else
|
|
140
|
+
false
|
|
141
|
+
end
|
|
142
|
+
when :Object
|
|
143
|
+
# generic object (usually a Hash), return directly
|
|
144
|
+
value
|
|
145
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
146
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
147
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
148
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
149
|
+
k_type = Regexp.last_match[:k_type]
|
|
150
|
+
v_type = Regexp.last_match[:v_type]
|
|
151
|
+
{}.tap do |hash|
|
|
152
|
+
value.each do |k, v|
|
|
153
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
154
|
+
end
|
|
155
|
+
end
|
|
156
|
+
else # model
|
|
157
|
+
temp_model = UltracartClient.const_get(type).new
|
|
158
|
+
temp_model.build_from_hash(value)
|
|
159
|
+
end
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
# Returns the string representation of the object
|
|
163
|
+
# @return [String] String presentation of the object
|
|
164
|
+
def to_s
|
|
165
|
+
to_hash.to_s
|
|
166
|
+
end
|
|
167
|
+
|
|
168
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
169
|
+
# @return [Hash] Returns the object in the form of hash
|
|
170
|
+
def to_body
|
|
171
|
+
to_hash
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
# Returns the object in the form of hash
|
|
175
|
+
# @return [Hash] Returns the object in the form of hash
|
|
176
|
+
def to_hash
|
|
177
|
+
hash = {}
|
|
178
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
179
|
+
value = self.send(attr)
|
|
180
|
+
next if value.nil?
|
|
181
|
+
hash[param] = _to_hash(value)
|
|
182
|
+
end
|
|
183
|
+
hash
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
# Outputs non-array value in the form of hash
|
|
187
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
188
|
+
# @param [Object] value Any valid value
|
|
189
|
+
# @return [Hash] Returns the value in the form of hash
|
|
190
|
+
def _to_hash(value)
|
|
191
|
+
if value.is_a?(Array)
|
|
192
|
+
value.compact.map { |v| _to_hash(v) }
|
|
193
|
+
elsif value.is_a?(Hash)
|
|
194
|
+
{}.tap do |hash|
|
|
195
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
196
|
+
end
|
|
197
|
+
elsif value.respond_to? :to_hash
|
|
198
|
+
value.to_hash
|
|
199
|
+
else
|
|
200
|
+
value
|
|
201
|
+
end
|
|
202
|
+
end
|
|
203
|
+
|
|
204
|
+
end
|
|
205
|
+
end
|
|
@@ -0,0 +1,223 @@
|
|
|
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 EmailCommseqStepLogsResponse
|
|
17
|
+
attr_accessor :error
|
|
18
|
+
|
|
19
|
+
attr_accessor :logs
|
|
20
|
+
|
|
21
|
+
attr_accessor :metadata
|
|
22
|
+
|
|
23
|
+
# Indicates if API call was successful
|
|
24
|
+
attr_accessor :success
|
|
25
|
+
|
|
26
|
+
attr_accessor :warning
|
|
27
|
+
|
|
28
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
29
|
+
def self.attribute_map
|
|
30
|
+
{
|
|
31
|
+
:'error' => :'error',
|
|
32
|
+
:'logs' => :'logs',
|
|
33
|
+
:'metadata' => :'metadata',
|
|
34
|
+
:'success' => :'success',
|
|
35
|
+
:'warning' => :'warning'
|
|
36
|
+
}
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
# Attribute type mapping.
|
|
40
|
+
def self.swagger_types
|
|
41
|
+
{
|
|
42
|
+
:'error' => :'Error',
|
|
43
|
+
:'logs' => :'Array<EmailCommseqStepLog>',
|
|
44
|
+
:'metadata' => :'ResponseMetadata',
|
|
45
|
+
:'success' => :'BOOLEAN',
|
|
46
|
+
:'warning' => :'Warning'
|
|
47
|
+
}
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# Initializes the object
|
|
51
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
52
|
+
def initialize(attributes = {})
|
|
53
|
+
return unless attributes.is_a?(Hash)
|
|
54
|
+
|
|
55
|
+
# convert string to symbol for hash key
|
|
56
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
|
57
|
+
|
|
58
|
+
if attributes.has_key?(:'error')
|
|
59
|
+
self.error = attributes[:'error']
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
if attributes.has_key?(:'logs')
|
|
63
|
+
if (value = attributes[:'logs']).is_a?(Array)
|
|
64
|
+
self.logs = value
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
if attributes.has_key?(:'metadata')
|
|
69
|
+
self.metadata = attributes[:'metadata']
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
if attributes.has_key?(:'success')
|
|
73
|
+
self.success = attributes[:'success']
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
if attributes.has_key?(:'warning')
|
|
77
|
+
self.warning = attributes[:'warning']
|
|
78
|
+
end
|
|
79
|
+
end
|
|
80
|
+
|
|
81
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
82
|
+
# @return Array for valid properties with the reasons
|
|
83
|
+
def list_invalid_properties
|
|
84
|
+
invalid_properties = Array.new
|
|
85
|
+
invalid_properties
|
|
86
|
+
end
|
|
87
|
+
|
|
88
|
+
# Check to see if the all the properties in the model are valid
|
|
89
|
+
# @return true if the model is valid
|
|
90
|
+
def valid?
|
|
91
|
+
true
|
|
92
|
+
end
|
|
93
|
+
|
|
94
|
+
# Checks equality by comparing each attribute.
|
|
95
|
+
# @param [Object] Object to be compared
|
|
96
|
+
def ==(o)
|
|
97
|
+
return true if self.equal?(o)
|
|
98
|
+
self.class == o.class &&
|
|
99
|
+
error == o.error &&
|
|
100
|
+
logs == o.logs &&
|
|
101
|
+
metadata == o.metadata &&
|
|
102
|
+
success == o.success &&
|
|
103
|
+
warning == o.warning
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
# @see the `==` method
|
|
107
|
+
# @param [Object] Object to be compared
|
|
108
|
+
def eql?(o)
|
|
109
|
+
self == o
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
# Calculates hash code according to all attributes.
|
|
113
|
+
# @return [Fixnum] Hash code
|
|
114
|
+
def hash
|
|
115
|
+
[error, logs, metadata, success, warning].hash
|
|
116
|
+
end
|
|
117
|
+
|
|
118
|
+
# Builds the object from hash
|
|
119
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
120
|
+
# @return [Object] Returns the model itself
|
|
121
|
+
def build_from_hash(attributes)
|
|
122
|
+
return nil unless attributes.is_a?(Hash)
|
|
123
|
+
self.class.swagger_types.each_pair do |key, type|
|
|
124
|
+
if type =~ /\AArray<(.*)>/i
|
|
125
|
+
# check to ensure the input is an array given that the attribute
|
|
126
|
+
# is documented as an array but the input is not
|
|
127
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
128
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
|
129
|
+
end
|
|
130
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
131
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
132
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
self
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
# Deserializes the data based on type
|
|
139
|
+
# @param string type Data type
|
|
140
|
+
# @param string value Value to be deserialized
|
|
141
|
+
# @return [Object] Deserialized data
|
|
142
|
+
def _deserialize(type, value)
|
|
143
|
+
case type.to_sym
|
|
144
|
+
when :DateTime
|
|
145
|
+
DateTime.parse(value)
|
|
146
|
+
when :Date
|
|
147
|
+
Date.parse(value)
|
|
148
|
+
when :String
|
|
149
|
+
value.to_s
|
|
150
|
+
when :Integer
|
|
151
|
+
value.to_i
|
|
152
|
+
when :Float
|
|
153
|
+
value.to_f
|
|
154
|
+
when :BOOLEAN
|
|
155
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
156
|
+
true
|
|
157
|
+
else
|
|
158
|
+
false
|
|
159
|
+
end
|
|
160
|
+
when :Object
|
|
161
|
+
# generic object (usually a Hash), return directly
|
|
162
|
+
value
|
|
163
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
164
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
165
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
166
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
167
|
+
k_type = Regexp.last_match[:k_type]
|
|
168
|
+
v_type = Regexp.last_match[:v_type]
|
|
169
|
+
{}.tap do |hash|
|
|
170
|
+
value.each do |k, v|
|
|
171
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
172
|
+
end
|
|
173
|
+
end
|
|
174
|
+
else # model
|
|
175
|
+
temp_model = UltracartClient.const_get(type).new
|
|
176
|
+
temp_model.build_from_hash(value)
|
|
177
|
+
end
|
|
178
|
+
end
|
|
179
|
+
|
|
180
|
+
# Returns the string representation of the object
|
|
181
|
+
# @return [String] String presentation of the object
|
|
182
|
+
def to_s
|
|
183
|
+
to_hash.to_s
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
187
|
+
# @return [Hash] Returns the object in the form of hash
|
|
188
|
+
def to_body
|
|
189
|
+
to_hash
|
|
190
|
+
end
|
|
191
|
+
|
|
192
|
+
# Returns the object in the form of hash
|
|
193
|
+
# @return [Hash] Returns the object in the form of hash
|
|
194
|
+
def to_hash
|
|
195
|
+
hash = {}
|
|
196
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
197
|
+
value = self.send(attr)
|
|
198
|
+
next if value.nil?
|
|
199
|
+
hash[param] = _to_hash(value)
|
|
200
|
+
end
|
|
201
|
+
hash
|
|
202
|
+
end
|
|
203
|
+
|
|
204
|
+
# Outputs non-array value in the form of hash
|
|
205
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
206
|
+
# @param [Object] value Any valid value
|
|
207
|
+
# @return [Hash] Returns the value in the form of hash
|
|
208
|
+
def _to_hash(value)
|
|
209
|
+
if value.is_a?(Array)
|
|
210
|
+
value.compact.map { |v| _to_hash(v) }
|
|
211
|
+
elsif value.is_a?(Hash)
|
|
212
|
+
{}.tap do |hash|
|
|
213
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
214
|
+
end
|
|
215
|
+
elsif value.respond_to? :to_hash
|
|
216
|
+
value.to_hash
|
|
217
|
+
else
|
|
218
|
+
value
|
|
219
|
+
end
|
|
220
|
+
end
|
|
221
|
+
|
|
222
|
+
end
|
|
223
|
+
end
|
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.2.
|
|
4
|
+
version: 3.2.15
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- UltraCart
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-07-
|
|
11
|
+
date: 2021-07-13 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|
|
@@ -425,6 +425,8 @@ files:
|
|
|
425
425
|
- docs/EmailCommseqStat.md
|
|
426
426
|
- docs/EmailCommseqStatResponse.md
|
|
427
427
|
- docs/EmailCommseqStep.md
|
|
428
|
+
- docs/EmailCommseqStepLog.md
|
|
429
|
+
- docs/EmailCommseqStepLogsResponse.md
|
|
428
430
|
- docs/EmailCommseqsResponse.md
|
|
429
431
|
- docs/EmailCustomer.md
|
|
430
432
|
- docs/EmailCustomerEditorUrlResponse.md
|
|
@@ -1035,6 +1037,8 @@ files:
|
|
|
1035
1037
|
- lib/ultracart_api/models/email_commseq_stat.rb
|
|
1036
1038
|
- lib/ultracart_api/models/email_commseq_stat_response.rb
|
|
1037
1039
|
- lib/ultracart_api/models/email_commseq_step.rb
|
|
1040
|
+
- lib/ultracart_api/models/email_commseq_step_log.rb
|
|
1041
|
+
- lib/ultracart_api/models/email_commseq_step_logs_response.rb
|
|
1038
1042
|
- lib/ultracart_api/models/email_commseqs_response.rb
|
|
1039
1043
|
- lib/ultracart_api/models/email_customer.rb
|
|
1040
1044
|
- lib/ultracart_api/models/email_customer_editor_url_response.rb
|