ultracart_api 3.2.14 → 3.3.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +19 -4
- data/docs/EmailCommseqStepLog.md +10 -0
- data/docs/EmailCommseqStepLogsResponse.md +12 -0
- data/docs/ScreenRecordingPageViewEvent.md +1 -0
- data/docs/SingleSignOnAuthorizeRequest.md +9 -0
- data/docs/SingleSignOnAuthorizeResponse.md +9 -0
- data/docs/SingleSignOnTokenRequest.md +9 -0
- data/docs/SingleSignOnTokenResponse.md +10 -0
- data/docs/SsoApi.md +201 -0
- data/docs/StorefrontApi.md +55 -0
- data/lib/ultracart_api.rb +7 -0
- data/lib/ultracart_api/api/sso_api.rb +243 -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/models/screen_recording_page_view_event.rb +10 -1
- data/lib/ultracart_api/models/single_sign_on_authorize_request.rb +195 -0
- data/lib/ultracart_api/models/single_sign_on_authorize_response.rb +195 -0
- data/lib/ultracart_api/models/single_sign_on_token_request.rb +195 -0
- data/lib/ultracart_api/models/single_sign_on_token_response.rb +205 -0
- data/lib/ultracart_api/version.rb +1 -1
- metadata +16 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 94efd609acdfdc97a1723452a7e90da9fc89b3f86ae5d02b8b48c706e969018c
|
4
|
+
data.tar.gz: 7412f2aa45760fad55ea1ff684488b3054ed0cc4e2a1b5d19e8bea83ebd5bcf8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 87b17f2a5b510b65647546cd87525be3840e6fb6564552c0629b5dfb696be2d89541eb669303d21bb4e55d400ad8ad850abc2190f4b9bce6a4a187f990235d90
|
7
|
+
data.tar.gz: fead47614254b4e61c3bd385a5c7c34553827cceec181ff91ef255b1dc78da3925b95629d3ed6fe7b3dbc440de4e60ee8830e88e23006460db12fe132ae554b5
|
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.3.2
|
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.3.2.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.2.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.3.2.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.3.2'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -194,6 +194,10 @@ Class | Method | HTTP request | Description
|
|
194
194
|
*UltracartClient::OrderApi* | [**resend_shipment_confirmation**](docs/OrderApi.md#resend_shipment_confirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
|
195
195
|
*UltracartClient::OrderApi* | [**update_accounts_receivable_retry_config**](docs/OrderApi.md#update_accounts_receivable_retry_config) | **POST** /order/accountsReceivableRetryConfig | Update A/R Retry Configuration
|
196
196
|
*UltracartClient::OrderApi* | [**update_order**](docs/OrderApi.md#update_order) | **PUT** /order/orders/{order_id} | Update an order
|
197
|
+
*UltracartClient::SsoApi* | [**get_sso_session_user**](docs/SsoApi.md#get_sso_session_user) | **GET** /sso/session/user | Get single sign on session user
|
198
|
+
*UltracartClient::SsoApi* | [**sso_authorize**](docs/SsoApi.md#sso_authorize) | **PUT** /sso/authorize | Authorize a single sign on session
|
199
|
+
*UltracartClient::SsoApi* | [**sso_session_revoke**](docs/SsoApi.md#sso_session_revoke) | **DELETE** /sso/session/revoke | Revoke single sign on session
|
200
|
+
*UltracartClient::SsoApi* | [**sso_token**](docs/SsoApi.md#sso_token) | **PUT** /sso/token | Exchange a single sign on code for a simple key token
|
197
201
|
*UltracartClient::StorefrontApi* | [**add_to_library**](docs/StorefrontApi.md#add_to_library) | **POST** /storefront/code_library | Add to library
|
198
202
|
*UltracartClient::StorefrontApi* | [**apply_to_store_front**](docs/StorefrontApi.md#apply_to_store_front) | **POST** /storefront/code_library/apply | Apply library item to storefront.
|
199
203
|
*UltracartClient::StorefrontApi* | [**archive_email_list**](docs/StorefrontApi.md#archive_email_list) | **POST** /storefront/{storefront_oid}/email/lists/{email_list_uuid}/archive | Archive email list
|
@@ -238,6 +242,7 @@ Class | Method | HTTP request | Description
|
|
238
242
|
*UltracartClient::StorefrontApi* | [**get_email_customers**](docs/StorefrontApi.md#get_email_customers) | **GET** /storefront/{storefront_oid}/email/customers | Get email customers
|
239
243
|
*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
244
|
*UltracartClient::StorefrontApi* | [**get_email_dashboard_stats**](docs/StorefrontApi.md#get_email_dashboard_stats) | **GET** /storefront/{storefront_oid}/email/dashboard_stats | Get dashboard stats
|
245
|
+
*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
246
|
*UltracartClient::StorefrontApi* | [**get_email_email**](docs/StorefrontApi.md#get_email_email) | **GET** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Get email email
|
242
247
|
*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
248
|
*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 +615,8 @@ Class | Method | HTTP request | Description
|
|
610
615
|
- [UltracartClient::EmailCommseqStat](docs/EmailCommseqStat.md)
|
611
616
|
- [UltracartClient::EmailCommseqStatResponse](docs/EmailCommseqStatResponse.md)
|
612
617
|
- [UltracartClient::EmailCommseqStep](docs/EmailCommseqStep.md)
|
618
|
+
- [UltracartClient::EmailCommseqStepLog](docs/EmailCommseqStepLog.md)
|
619
|
+
- [UltracartClient::EmailCommseqStepLogsResponse](docs/EmailCommseqStepLogsResponse.md)
|
613
620
|
- [UltracartClient::EmailCommseqsResponse](docs/EmailCommseqsResponse.md)
|
614
621
|
- [UltracartClient::EmailCustomer](docs/EmailCustomer.md)
|
615
622
|
- [UltracartClient::EmailCustomerEditorUrlResponse](docs/EmailCustomerEditorUrlResponse.md)
|
@@ -918,6 +925,10 @@ Class | Method | HTTP request | Description
|
|
918
925
|
- [UltracartClient::ScreenshotsResponse](docs/ScreenshotsResponse.md)
|
919
926
|
- [UltracartClient::SelfConfig](docs/SelfConfig.md)
|
920
927
|
- [UltracartClient::SimpleValue](docs/SimpleValue.md)
|
928
|
+
- [UltracartClient::SingleSignOnAuthorizeRequest](docs/SingleSignOnAuthorizeRequest.md)
|
929
|
+
- [UltracartClient::SingleSignOnAuthorizeResponse](docs/SingleSignOnAuthorizeResponse.md)
|
930
|
+
- [UltracartClient::SingleSignOnTokenRequest](docs/SingleSignOnTokenRequest.md)
|
931
|
+
- [UltracartClient::SingleSignOnTokenResponse](docs/SingleSignOnTokenResponse.md)
|
921
932
|
- [UltracartClient::SovosConfig](docs/SovosConfig.md)
|
922
933
|
- [UltracartClient::StateProvince](docs/StateProvince.md)
|
923
934
|
- [UltracartClient::StepWaiting](docs/StepWaiting.md)
|
@@ -1035,6 +1046,10 @@ Not every change is committed to every SDK.
|
|
1035
1046
|
|
1036
1047
|
| Version | Date | Comments |
|
1037
1048
|
| --: | :-: | --- |
|
1049
|
+
| 3.3.2 | 07/16/2021 | sso bug fixes |
|
1050
|
+
| 3.3.1 | 07/16/2021 | screen recording - event sub text used for assisting in UX rendering |
|
1051
|
+
| 3.3.0 | 07/16/2021 | new endpoint SingleSignOn |
|
1052
|
+
| 3.2.15 | 07/13/2021 | storefront communications - added methods to retrieve step dispatch logs |
|
1038
1053
|
| 3.2.14 | 07/12/2021 | fix documentation bug on packing slip methods for order api |
|
1039
1054
|
| 3.2.13 | 07/12/2021 | coupon api - added hideFromCustomer flag |
|
1040
1055
|
| 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
|
+
|
@@ -6,6 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
**name** | **String** | | [optional]
|
7
7
|
**params** | [**Array<ScreenRecordingPageViewEventParameter>**](ScreenRecordingPageViewEventParameter.md) | | [optional]
|
8
8
|
**prior_page_view** | **BOOLEAN** | | [optional]
|
9
|
+
**sub_text** | **String** | | [optional]
|
9
10
|
**timestamp** | **String** | Timestamp of the event | [optional]
|
10
11
|
**ts** | **Integer** | | [optional]
|
11
12
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# UltracartClient::SingleSignOnAuthorizeRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**redirect_uri** | **String** | The URL that the customer should be redirected to after they have approved a single sign on session. | [optional]
|
7
|
+
**state** | **String** | An optional state variable that you provide. It will be returned to you on the redirect. You can inspect the state to validate the request is legitimate. We recommend using this field. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# UltracartClient::SingleSignOnAuthorizeResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**expiration_dts** | **String** | Expiration date/time after which the single sign-on login operation will have timed out | [optional]
|
7
|
+
**login_url** | **String** | The URL that you should redirect the customer's browser to. This URL will begin the login process. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# UltracartClient::SingleSignOnTokenRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**code** | **String** | The code received on the redirect URI after the customer approved the single sign on request. | [optional]
|
7
|
+
**grant_type** | **String** | Grant type. The value should be simple_key. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# UltracartClient::SingleSignOnTokenResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**expiration_dts** | **String** | Expiration date/time after which time the key is no longer valid | [optional]
|
7
|
+
**ip_address** | **String** | IP address of the user which we recommend you lock the simple key's usage to. | [optional]
|
8
|
+
**simple_key** | **String** | The simple key that can then be used to make SDK calls on the users behalf. | [optional]
|
9
|
+
|
10
|
+
|
data/docs/SsoApi.md
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
# UltracartClient::SsoApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**get_sso_session_user**](SsoApi.md#get_sso_session_user) | **GET** /sso/session/user | Get single sign on session user
|
8
|
+
[**sso_authorize**](SsoApi.md#sso_authorize) | **PUT** /sso/authorize | Authorize a single sign on session
|
9
|
+
[**sso_session_revoke**](SsoApi.md#sso_session_revoke) | **DELETE** /sso/session/revoke | Revoke single sign on session
|
10
|
+
[**sso_token**](SsoApi.md#sso_token) | **PUT** /sso/token | Exchange a single sign on code for a simple key token
|
11
|
+
|
12
|
+
|
13
|
+
# **get_sso_session_user**
|
14
|
+
> User get_sso_session_user
|
15
|
+
|
16
|
+
Get single sign on session user
|
17
|
+
|
18
|
+
This is the equivalent of logging out of the single sign on session
|
19
|
+
|
20
|
+
### Example
|
21
|
+
```ruby
|
22
|
+
# load the gem
|
23
|
+
require 'ultracart_api'
|
24
|
+
|
25
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
26
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
27
|
+
api_instance = UltracartClient::SsoApi.new_using_api_key(simple_key, false, false)
|
28
|
+
|
29
|
+
|
30
|
+
|
31
|
+
begin
|
32
|
+
#Get single sign on session user
|
33
|
+
result = api_instance.get_sso_session_user
|
34
|
+
p result
|
35
|
+
rescue UltracartClient::ApiError => e
|
36
|
+
puts "Exception when calling SsoApi->get_sso_session_user: #{e}"
|
37
|
+
end
|
38
|
+
```
|
39
|
+
|
40
|
+
### Parameters
|
41
|
+
This endpoint does not need any parameter.
|
42
|
+
|
43
|
+
### Return type
|
44
|
+
|
45
|
+
[**User**](User.md)
|
46
|
+
|
47
|
+
### Authorization
|
48
|
+
|
49
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
50
|
+
|
51
|
+
### HTTP request headers
|
52
|
+
|
53
|
+
- **Content-Type**: application/json; charset=UTF-8
|
54
|
+
- **Accept**: application/json
|
55
|
+
|
56
|
+
|
57
|
+
|
58
|
+
# **sso_authorize**
|
59
|
+
> SingleSignOnAuthorizeResponse sso_authorize(authorization_request)
|
60
|
+
|
61
|
+
Authorize a single sign on session
|
62
|
+
|
63
|
+
Starts the process of authorizing a single sign on session.
|
64
|
+
|
65
|
+
### Example
|
66
|
+
```ruby
|
67
|
+
# load the gem
|
68
|
+
require 'ultracart_api'
|
69
|
+
|
70
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
71
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
72
|
+
api_instance = UltracartClient::SsoApi.new_using_api_key(simple_key, false, false)
|
73
|
+
|
74
|
+
|
75
|
+
authorization_request = UltracartClient::SingleSignOnAuthorizeRequest.new # SingleSignOnAuthorizeRequest | Authorization request
|
76
|
+
|
77
|
+
|
78
|
+
begin
|
79
|
+
#Authorize a single sign on session
|
80
|
+
result = api_instance.sso_authorize(authorization_request)
|
81
|
+
p result
|
82
|
+
rescue UltracartClient::ApiError => e
|
83
|
+
puts "Exception when calling SsoApi->sso_authorize: #{e}"
|
84
|
+
end
|
85
|
+
```
|
86
|
+
|
87
|
+
### Parameters
|
88
|
+
|
89
|
+
Name | Type | Description | Notes
|
90
|
+
------------- | ------------- | ------------- | -------------
|
91
|
+
**authorization_request** | [**SingleSignOnAuthorizeRequest**](SingleSignOnAuthorizeRequest.md)| Authorization request |
|
92
|
+
|
93
|
+
### Return type
|
94
|
+
|
95
|
+
[**SingleSignOnAuthorizeResponse**](SingleSignOnAuthorizeResponse.md)
|
96
|
+
|
97
|
+
### Authorization
|
98
|
+
|
99
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
100
|
+
|
101
|
+
### HTTP request headers
|
102
|
+
|
103
|
+
- **Content-Type**: application/json; charset=UTF-8
|
104
|
+
- **Accept**: application/json
|
105
|
+
|
106
|
+
|
107
|
+
|
108
|
+
# **sso_session_revoke**
|
109
|
+
> sso_session_revoke
|
110
|
+
|
111
|
+
Revoke single sign on session
|
112
|
+
|
113
|
+
This is the equivalent of logging out of the single sign on session
|
114
|
+
|
115
|
+
### Example
|
116
|
+
```ruby
|
117
|
+
# load the gem
|
118
|
+
require 'ultracart_api'
|
119
|
+
|
120
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
121
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
122
|
+
api_instance = UltracartClient::SsoApi.new_using_api_key(simple_key, false, false)
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
begin
|
127
|
+
#Revoke single sign on session
|
128
|
+
api_instance.sso_session_revoke
|
129
|
+
rescue UltracartClient::ApiError => e
|
130
|
+
puts "Exception when calling SsoApi->sso_session_revoke: #{e}"
|
131
|
+
end
|
132
|
+
```
|
133
|
+
|
134
|
+
### Parameters
|
135
|
+
This endpoint does not need any parameter.
|
136
|
+
|
137
|
+
### Return type
|
138
|
+
|
139
|
+
nil (empty response body)
|
140
|
+
|
141
|
+
### Authorization
|
142
|
+
|
143
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
144
|
+
|
145
|
+
### HTTP request headers
|
146
|
+
|
147
|
+
- **Content-Type**: application/json; charset=UTF-8
|
148
|
+
- **Accept**: application/json
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
# **sso_token**
|
153
|
+
> SingleSignOnTokenResponse sso_token(token_request)
|
154
|
+
|
155
|
+
Exchange a single sign on code for a simple key token
|
156
|
+
|
157
|
+
Called by your application after receiving the code back on the redirect URI to obtain a simple key token to make API calls with
|
158
|
+
|
159
|
+
### Example
|
160
|
+
```ruby
|
161
|
+
# load the gem
|
162
|
+
require 'ultracart_api'
|
163
|
+
|
164
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
165
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
166
|
+
api_instance = UltracartClient::SsoApi.new_using_api_key(simple_key, false, false)
|
167
|
+
|
168
|
+
|
169
|
+
token_request = UltracartClient::SingleSignOnTokenRequest.new # SingleSignOnTokenRequest | Token request
|
170
|
+
|
171
|
+
|
172
|
+
begin
|
173
|
+
#Exchange a single sign on code for a simple key token
|
174
|
+
result = api_instance.sso_token(token_request)
|
175
|
+
p result
|
176
|
+
rescue UltracartClient::ApiError => e
|
177
|
+
puts "Exception when calling SsoApi->sso_token: #{e}"
|
178
|
+
end
|
179
|
+
```
|
180
|
+
|
181
|
+
### Parameters
|
182
|
+
|
183
|
+
Name | Type | Description | Notes
|
184
|
+
------------- | ------------- | ------------- | -------------
|
185
|
+
**token_request** | [**SingleSignOnTokenRequest**](SingleSignOnTokenRequest.md)| Token request |
|
186
|
+
|
187
|
+
### Return type
|
188
|
+
|
189
|
+
[**SingleSignOnTokenResponse**](SingleSignOnTokenResponse.md)
|
190
|
+
|
191
|
+
### Authorization
|
192
|
+
|
193
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
194
|
+
|
195
|
+
### HTTP request headers
|
196
|
+
|
197
|
+
- **Content-Type**: application/json; charset=UTF-8
|
198
|
+
- **Accept**: application/json
|
199
|
+
|
200
|
+
|
201
|
+
|
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'
|
@@ -543,6 +545,10 @@ require 'ultracart_api/models/screen_recording_user_property'
|
|
543
545
|
require 'ultracart_api/models/screenshots_response'
|
544
546
|
require 'ultracart_api/models/self_config'
|
545
547
|
require 'ultracart_api/models/simple_value'
|
548
|
+
require 'ultracart_api/models/single_sign_on_authorize_request'
|
549
|
+
require 'ultracart_api/models/single_sign_on_authorize_response'
|
550
|
+
require 'ultracart_api/models/single_sign_on_token_request'
|
551
|
+
require 'ultracart_api/models/single_sign_on_token_response'
|
546
552
|
require 'ultracart_api/models/sovos_config'
|
547
553
|
require 'ultracart_api/models/state_province'
|
548
554
|
require 'ultracart_api/models/step_waiting'
|
@@ -611,6 +617,7 @@ require 'ultracart_api/api/integration_log_api'
|
|
611
617
|
require 'ultracart_api/api/item_api'
|
612
618
|
require 'ultracart_api/api/oauth_api'
|
613
619
|
require 'ultracart_api/api/order_api'
|
620
|
+
require 'ultracart_api/api/sso_api'
|
614
621
|
require 'ultracart_api/api/storefront_api'
|
615
622
|
require 'ultracart_api/api/tax_api'
|
616
623
|
require 'ultracart_api/api/user_api'
|