ultracart_api 4.1.101 → 4.1.103

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.
@@ -13,6 +13,8 @@
13
13
  | **arbitrary_unit_cost_remaining_orders** | **Integer** | The number of rebills to give the arbitrary unit cost on before reverting to normal pricing. | [optional] |
14
14
  | **auto_order_item_oid** | **Integer** | Primary key of AutoOrderItem | [optional] |
15
15
  | **calculated_next_shipment_dts** | **String** | Calculated Date/time that this item is scheduled to rebill. Will be null if no more shipments are going to occur on this item | [optional] |
16
+ | **cancel_dts** | **String** | Date/time this item was cancelled (companion to cancel_reason). On update, null leaves the existing value unchanged; pass an empty string to clear it. | [optional] |
17
+ | **cancel_reason** | **String** | Reason this item was cancelled, captured when the item was cancelled by the customer or merchant. On update, null leaves the existing value unchanged; pass an empty string to clear it. | [optional] |
16
18
  | **first_order_dts** | **String** | Date/time of the first order of this item. Null if item added to auto order and has not been rebilled yet. | [optional] |
17
19
  | **frequency** | **String** | Frequency of the rebill if not a fixed schedule | [optional] |
18
20
  | **future_schedules** | [**Array<AutoOrderItemFutureSchedule>**](AutoOrderItemFutureSchedule.md) | The future rebill schedule for this item up to the next ten rebills | [optional] |
@@ -50,6 +52,8 @@ instance = UltracartClient::AutoOrderItem.new(
50
52
  arbitrary_unit_cost_remaining_orders: null,
51
53
  auto_order_item_oid: null,
52
54
  calculated_next_shipment_dts: null,
55
+ cancel_dts: null,
56
+ cancel_reason: null,
53
57
  first_order_dts: null,
54
58
  frequency: null,
55
59
  future_schedules: null,
@@ -0,0 +1,22 @@
1
+ # UltracartClient::EmailCommseqEnrollmentRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **email** | **String** | Email address of the customer to enroll | [optional] |
8
+ | **esp_commseq_uuid** | **String** | Communication sequence UUID | [optional] |
9
+ | **name** | **String** | Optional name of the customer to enroll | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::EmailCommseqEnrollmentRequest.new(
17
+ email: null,
18
+ esp_commseq_uuid: null,
19
+ name: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,30 @@
1
+ # UltracartClient::EmailCommseqEnrollmentResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **already_enrolled** | **Boolean** | True if the customer was already enrolled and therefore not enrolled again | [optional] |
8
+ | **enrolled** | **Boolean** | True if the customer was newly enrolled into the sequence | [optional] |
9
+ | **error** | [**Error**](Error.md) | | [optional] |
10
+ | **esp_customer_uuid** | **String** | The resolved ESP customer UUID for the enrolled email | [optional] |
11
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
12
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
13
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'ultracart_api'
19
+
20
+ instance = UltracartClient::EmailCommseqEnrollmentResponse.new(
21
+ already_enrolled: null,
22
+ enrolled: null,
23
+ error: null,
24
+ esp_customer_uuid: null,
25
+ metadata: null,
26
+ success: null,
27
+ warning: null
28
+ )
29
+ ```
30
+
@@ -32,6 +32,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
32
32
  | [**delete_screen_recording_segment**](StorefrontApi.md#delete_screen_recording_segment) | **DELETE** /storefront/{storefront_oid}/screen_recordings/segments/{screen_recording_segment_oid} | Delete screen recording segment |
33
33
  | [**delete_twilio_account**](StorefrontApi.md#delete_twilio_account) | **DELETE** /storefront/twilio/accounts/{esp_twilio_uuid} | delete Twilio account |
34
34
  | [**duplicate_library_item**](StorefrontApi.md#duplicate_library_item) | **POST** /storefront/code_library/{library_item_oid}/duplicate | Duplicate library item. |
35
+ | [**enroll_commseq_customer**](StorefrontApi.md#enroll_commseq_customer) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/enroll | Enroll a customer into a communication sequence |
35
36
  | [**favorite_screen_recording**](StorefrontApi.md#favorite_screen_recording) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Update favorite flag on screen recording |
36
37
  | [**geocode_address**](StorefrontApi.md#geocode_address) | **POST** /storefront/{storefront_oid}/email/geocode | Obtain lat/long for an address |
37
38
  | [**get_countries**](StorefrontApi.md#get_countries) | **GET** /storefront/{storefront_oid}/email/countries | Get countries |
@@ -1667,6 +1668,61 @@ end
1667
1668
  - **Accept**: application/json
1668
1669
 
1669
1670
 
1671
+ ## enroll_commseq_customer
1672
+
1673
+ > <EmailCommseqEnrollmentResponse> enroll_commseq_customer(storefront_oid, commseq_uuid, email_commseq_enrollment_request)
1674
+
1675
+ Enroll a customer into a communication sequence
1676
+
1677
+ Enrolls a single real customer (by email) into the communication sequence. A customer who is already enrolled will not be enrolled a second time.
1678
+
1679
+
1680
+ ### Examples
1681
+
1682
+
1683
+ (No example for this operation).
1684
+
1685
+
1686
+ #### Using the enroll_commseq_customer_with_http_info variant
1687
+
1688
+ This returns an Array which contains the response data, status code and headers.
1689
+
1690
+ > <Array(<EmailCommseqEnrollmentResponse>, Integer, Hash)> enroll_commseq_customer_with_http_info(storefront_oid, commseq_uuid, email_commseq_enrollment_request)
1691
+
1692
+ ```ruby
1693
+ begin
1694
+ # Enroll a customer into a communication sequence
1695
+ data, status_code, headers = api_instance.enroll_commseq_customer_with_http_info(storefront_oid, commseq_uuid, email_commseq_enrollment_request)
1696
+ p status_code # => 2xx
1697
+ p headers # => { ... }
1698
+ p data # => <EmailCommseqEnrollmentResponse>
1699
+ rescue UltracartClient::ApiError => e
1700
+ puts "Error when calling StorefrontApi->enroll_commseq_customer_with_http_info: #{e}"
1701
+ end
1702
+ ```
1703
+
1704
+ ### Parameters
1705
+
1706
+ | Name | Type | Description | Notes |
1707
+ | ---- | ---- | ----------- | ----- |
1708
+ | **storefront_oid** | **Integer** | | |
1709
+ | **commseq_uuid** | **String** | | |
1710
+ | **email_commseq_enrollment_request** | [**EmailCommseqEnrollmentRequest**](EmailCommseqEnrollmentRequest.md) | Commseq enrollment request | |
1711
+
1712
+ ### Return type
1713
+
1714
+ [**EmailCommseqEnrollmentResponse**](EmailCommseqEnrollmentResponse.md)
1715
+
1716
+ ### Authorization
1717
+
1718
+ [ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1719
+
1720
+ ### HTTP request headers
1721
+
1722
+ - **Content-Type**: application/json
1723
+ - **Accept**: application/json
1724
+
1725
+
1670
1726
  ## favorite_screen_recording
1671
1727
 
1672
1728
  > favorite_screen_recording(storefront_oid, screen_recording_uuid)
@@ -32,6 +32,215 @@ module UltracartClient
32
32
  UltracartClient::AffiliateApi.new(api_client)
33
33
  end
34
34
 
35
+ # Delete an affiliate
36
+ # Delete an affiliate on the UltraCart account. The affiliate is disabled within the active affiliate program; their ledger and click history is preserved.
37
+ # @param affiliate_oid [Integer] The affiliate oid to delete.
38
+ # @param [Hash] opts the optional parameters
39
+ # @return [nil]
40
+ def delete_affiliate(affiliate_oid, opts = {})
41
+ delete_affiliate_with_http_info(affiliate_oid, opts)
42
+ nil
43
+ end
44
+
45
+ # Delete an affiliate
46
+ # Delete an affiliate on the UltraCart account. The affiliate is disabled within the active affiliate program; their ledger and click history is preserved.
47
+ # @param affiliate_oid [Integer] The affiliate oid to delete.
48
+ # @param [Hash] opts the optional parameters
49
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
50
+ def delete_affiliate_with_http_info(affiliate_oid, opts = {})
51
+ if @api_client.config.debugging
52
+ @api_client.config.logger.debug 'Calling API: AffiliateApi.delete_affiliate ...'
53
+ end
54
+ # verify the required parameter 'affiliate_oid' is set
55
+ if @api_client.config.client_side_validation && affiliate_oid.nil?
56
+ fail ArgumentError, "Missing the required parameter 'affiliate_oid' when calling AffiliateApi.delete_affiliate"
57
+ end
58
+ # resource path
59
+ local_var_path = '/affiliate/affiliates/{affiliate_oid}'.sub('{' + 'affiliate_oid' + '}', CGI.escape(affiliate_oid.to_s))
60
+
61
+ # query parameters
62
+ query_params = opts[:query_params] || {}
63
+
64
+ # header parameters
65
+ header_params = opts[:header_params] || {}
66
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
67
+ # HTTP header 'Accept' (if needed)
68
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
69
+
70
+ # form parameters
71
+ form_params = opts[:form_params] || {}
72
+
73
+ # http body (model)
74
+ post_body = opts[:debug_body]
75
+
76
+ # return_type
77
+ return_type = opts[:debug_return_type]
78
+
79
+ # auth_names
80
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
81
+
82
+ new_options = opts.merge(
83
+ :operation => :"AffiliateApi.delete_affiliate",
84
+ :header_params => header_params,
85
+ :query_params => query_params,
86
+ :form_params => form_params,
87
+ :body => post_body,
88
+ :auth_names => auth_names,
89
+ :return_type => return_type
90
+ )
91
+
92
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
93
+ if @api_client.config.debugging
94
+ @api_client.config.logger.debug "API called: AffiliateApi#delete_affiliate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
95
+ end
96
+ return data, status_code, headers
97
+ end
98
+
99
+ # Retrieve an affiliate
100
+ # Retrieves a single affiliate using the specified affiliate oid.
101
+ # @param affiliate_oid [Integer] The affiliate oid to retrieve.
102
+ # @param [Hash] opts the optional parameters
103
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
104
+ # @return [AffiliateResponse]
105
+ def get_affiliate(affiliate_oid, opts = {})
106
+ data, _status_code, _headers = get_affiliate_with_http_info(affiliate_oid, opts)
107
+ data
108
+ end
109
+
110
+ # Retrieve an affiliate
111
+ # Retrieves a single affiliate using the specified affiliate oid.
112
+ # @param affiliate_oid [Integer] The affiliate oid to retrieve.
113
+ # @param [Hash] opts the optional parameters
114
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
115
+ # @return [Array<(AffiliateResponse, Integer, Hash)>] AffiliateResponse data, response status code and response headers
116
+ def get_affiliate_with_http_info(affiliate_oid, opts = {})
117
+ if @api_client.config.debugging
118
+ @api_client.config.logger.debug 'Calling API: AffiliateApi.get_affiliate ...'
119
+ end
120
+ # verify the required parameter 'affiliate_oid' is set
121
+ if @api_client.config.client_side_validation && affiliate_oid.nil?
122
+ fail ArgumentError, "Missing the required parameter 'affiliate_oid' when calling AffiliateApi.get_affiliate"
123
+ end
124
+ # resource path
125
+ local_var_path = '/affiliate/affiliates/{affiliate_oid}'.sub('{' + 'affiliate_oid' + '}', CGI.escape(affiliate_oid.to_s))
126
+
127
+ # query parameters
128
+ query_params = opts[:query_params] || {}
129
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
130
+
131
+ # header parameters
132
+ header_params = opts[:header_params] || {}
133
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
134
+ # HTTP header 'Accept' (if needed)
135
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
136
+
137
+ # form parameters
138
+ form_params = opts[:form_params] || {}
139
+
140
+ # http body (model)
141
+ post_body = opts[:debug_body]
142
+
143
+ # return_type
144
+ return_type = opts[:debug_return_type] || 'AffiliateResponse'
145
+
146
+ # auth_names
147
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
148
+
149
+ new_options = opts.merge(
150
+ :operation => :"AffiliateApi.get_affiliate",
151
+ :header_params => header_params,
152
+ :query_params => query_params,
153
+ :form_params => form_params,
154
+ :body => post_body,
155
+ :auth_names => auth_names,
156
+ :return_type => return_type
157
+ )
158
+
159
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
160
+ if @api_client.config.debugging
161
+ @api_client.config.logger.debug "API called: AffiliateApi#get_affiliate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
162
+ end
163
+ return data, status_code, headers
164
+ end
165
+
166
+ # Retrieve affiliates
167
+ # Retrieves a group of affiliates from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the affiliates returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
168
+ # @param affiliate_query [AffiliateQuery] Affiliate query
169
+ # @param [Hash] opts the optional parameters
170
+ # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
171
+ # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
172
+ # @option opts [String] :_sort The sort order of the affiliates. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
173
+ # @return [AffiliatesResponse]
174
+ def get_affiliates_by_query(affiliate_query, opts = {})
175
+ data, _status_code, _headers = get_affiliates_by_query_with_http_info(affiliate_query, opts)
176
+ data
177
+ end
178
+
179
+ # Retrieve affiliates
180
+ # Retrieves a group of affiliates from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the affiliates returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
181
+ # @param affiliate_query [AffiliateQuery] Affiliate query
182
+ # @param [Hash] opts the optional parameters
183
+ # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
184
+ # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
185
+ # @option opts [String] :_sort The sort order of the affiliates. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
186
+ # @return [Array<(AffiliatesResponse, Integer, Hash)>] AffiliatesResponse data, response status code and response headers
187
+ def get_affiliates_by_query_with_http_info(affiliate_query, opts = {})
188
+ if @api_client.config.debugging
189
+ @api_client.config.logger.debug 'Calling API: AffiliateApi.get_affiliates_by_query ...'
190
+ end
191
+ # verify the required parameter 'affiliate_query' is set
192
+ if @api_client.config.client_side_validation && affiliate_query.nil?
193
+ fail ArgumentError, "Missing the required parameter 'affiliate_query' when calling AffiliateApi.get_affiliates_by_query"
194
+ end
195
+ # resource path
196
+ local_var_path = '/affiliate/affiliates/query'
197
+
198
+ # query parameters
199
+ query_params = opts[:query_params] || {}
200
+ query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
201
+ query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
202
+ query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
203
+
204
+ # header parameters
205
+ header_params = opts[:header_params] || {}
206
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
207
+ # HTTP header 'Accept' (if needed)
208
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
209
+ # HTTP header 'Content-Type'
210
+ content_type = @api_client.select_header_content_type(['application/json'])
211
+ if !content_type.nil?
212
+ header_params['Content-Type'] = content_type
213
+ end
214
+
215
+ # form parameters
216
+ form_params = opts[:form_params] || {}
217
+
218
+ # http body (model)
219
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(affiliate_query)
220
+
221
+ # return_type
222
+ return_type = opts[:debug_return_type] || 'AffiliatesResponse'
223
+
224
+ # auth_names
225
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
226
+
227
+ new_options = opts.merge(
228
+ :operation => :"AffiliateApi.get_affiliates_by_query",
229
+ :header_params => header_params,
230
+ :query_params => query_params,
231
+ :form_params => form_params,
232
+ :body => post_body,
233
+ :auth_names => auth_names,
234
+ :return_type => return_type
235
+ )
236
+
237
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
238
+ if @api_client.config.debugging
239
+ @api_client.config.logger.debug "API called: AffiliateApi#get_affiliates_by_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
240
+ end
241
+ return data, status_code, headers
242
+ end
243
+
35
244
  # Retrieve clicks
36
245
  # Retrieves a group of clicks from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the clicks returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
37
246
  # @param click_query [AffiliateClickQuery] Click query
@@ -187,5 +396,155 @@ module UltracartClient
187
396
  end
188
397
  return data, status_code, headers
189
398
  end
399
+
400
+ # Insert an affiliate
401
+ # Insert an affiliate on the UltraCart account. The affiliate is created within the merchant's active affiliate program.
402
+ # @param affiliate [Affiliate] Affiliate to insert
403
+ # @param [Hash] opts the optional parameters
404
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
405
+ # @return [AffiliateResponse]
406
+ def insert_affiliate(affiliate, opts = {})
407
+ data, _status_code, _headers = insert_affiliate_with_http_info(affiliate, opts)
408
+ data
409
+ end
410
+
411
+ # Insert an affiliate
412
+ # Insert an affiliate on the UltraCart account. The affiliate is created within the merchant&#39;s active affiliate program.
413
+ # @param affiliate [Affiliate] Affiliate to insert
414
+ # @param [Hash] opts the optional parameters
415
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
416
+ # @return [Array<(AffiliateResponse, Integer, Hash)>] AffiliateResponse data, response status code and response headers
417
+ def insert_affiliate_with_http_info(affiliate, opts = {})
418
+ if @api_client.config.debugging
419
+ @api_client.config.logger.debug 'Calling API: AffiliateApi.insert_affiliate ...'
420
+ end
421
+ # verify the required parameter 'affiliate' is set
422
+ if @api_client.config.client_side_validation && affiliate.nil?
423
+ fail ArgumentError, "Missing the required parameter 'affiliate' when calling AffiliateApi.insert_affiliate"
424
+ end
425
+ # resource path
426
+ local_var_path = '/affiliate/affiliates'
427
+
428
+ # query parameters
429
+ query_params = opts[:query_params] || {}
430
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
431
+
432
+ # header parameters
433
+ header_params = opts[:header_params] || {}
434
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
435
+ # HTTP header 'Accept' (if needed)
436
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
437
+ # HTTP header 'Content-Type'
438
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
439
+ if !content_type.nil?
440
+ header_params['Content-Type'] = content_type
441
+ end
442
+
443
+ # form parameters
444
+ form_params = opts[:form_params] || {}
445
+
446
+ # http body (model)
447
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(affiliate)
448
+
449
+ # return_type
450
+ return_type = opts[:debug_return_type] || 'AffiliateResponse'
451
+
452
+ # auth_names
453
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
454
+
455
+ new_options = opts.merge(
456
+ :operation => :"AffiliateApi.insert_affiliate",
457
+ :header_params => header_params,
458
+ :query_params => query_params,
459
+ :form_params => form_params,
460
+ :body => post_body,
461
+ :auth_names => auth_names,
462
+ :return_type => return_type
463
+ )
464
+
465
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
466
+ if @api_client.config.debugging
467
+ @api_client.config.logger.debug "API called: AffiliateApi#insert_affiliate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
468
+ end
469
+ return data, status_code, headers
470
+ end
471
+
472
+ # Update an affiliate
473
+ # 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
+ # @param affiliate_oid [Integer] The affiliate oid to update.
475
+ # @param affiliate [Affiliate] Affiliate to update
476
+ # @param [Hash] opts the optional parameters
477
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
478
+ # @return [AffiliateResponse]
479
+ def update_affiliate(affiliate_oid, affiliate, opts = {})
480
+ data, _status_code, _headers = update_affiliate_with_http_info(affiliate_oid, affiliate, opts)
481
+ data
482
+ end
483
+
484
+ # Update an affiliate
485
+ # 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.
486
+ # @param affiliate_oid [Integer] The affiliate oid to update.
487
+ # @param affiliate [Affiliate] Affiliate to update
488
+ # @param [Hash] opts the optional parameters
489
+ # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
490
+ # @return [Array<(AffiliateResponse, Integer, Hash)>] AffiliateResponse data, response status code and response headers
491
+ def update_affiliate_with_http_info(affiliate_oid, affiliate, opts = {})
492
+ if @api_client.config.debugging
493
+ @api_client.config.logger.debug 'Calling API: AffiliateApi.update_affiliate ...'
494
+ end
495
+ # verify the required parameter 'affiliate_oid' is set
496
+ if @api_client.config.client_side_validation && affiliate_oid.nil?
497
+ fail ArgumentError, "Missing the required parameter 'affiliate_oid' when calling AffiliateApi.update_affiliate"
498
+ end
499
+ # verify the required parameter 'affiliate' is set
500
+ if @api_client.config.client_side_validation && affiliate.nil?
501
+ fail ArgumentError, "Missing the required parameter 'affiliate' when calling AffiliateApi.update_affiliate"
502
+ end
503
+ # resource path
504
+ local_var_path = '/affiliate/affiliates/{affiliate_oid}'.sub('{' + 'affiliate_oid' + '}', CGI.escape(affiliate_oid.to_s))
505
+
506
+ # query parameters
507
+ query_params = opts[:query_params] || {}
508
+ query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
509
+
510
+ # header parameters
511
+ header_params = opts[:header_params] || {}
512
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
513
+ # HTTP header 'Accept' (if needed)
514
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
515
+ # HTTP header 'Content-Type'
516
+ content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
517
+ if !content_type.nil?
518
+ header_params['Content-Type'] = content_type
519
+ end
520
+
521
+ # form parameters
522
+ form_params = opts[:form_params] || {}
523
+
524
+ # http body (model)
525
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(affiliate)
526
+
527
+ # return_type
528
+ return_type = opts[:debug_return_type] || 'AffiliateResponse'
529
+
530
+ # auth_names
531
+ auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
532
+
533
+ new_options = opts.merge(
534
+ :operation => :"AffiliateApi.update_affiliate",
535
+ :header_params => header_params,
536
+ :query_params => query_params,
537
+ :form_params => form_params,
538
+ :body => post_body,
539
+ :auth_names => auth_names,
540
+ :return_type => return_type
541
+ )
542
+
543
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
544
+ if @api_client.config.debugging
545
+ @api_client.config.logger.debug "API called: AffiliateApi#update_affiliate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
546
+ end
547
+ return data, status_code, headers
548
+ end
190
549
  end
191
550
  end
@@ -1932,6 +1932,87 @@ module UltracartClient
1932
1932
  return data, status_code, headers
1933
1933
  end
1934
1934
 
1935
+ # Enroll a customer into a communication sequence
1936
+ # Enrolls a single real customer (by email) into the communication sequence. A customer who is already enrolled will not be enrolled a second time.
1937
+ # @param storefront_oid [Integer]
1938
+ # @param commseq_uuid [String]
1939
+ # @param email_commseq_enrollment_request [EmailCommseqEnrollmentRequest] Commseq enrollment request
1940
+ # @param [Hash] opts the optional parameters
1941
+ # @return [EmailCommseqEnrollmentResponse]
1942
+ def enroll_commseq_customer(storefront_oid, commseq_uuid, email_commseq_enrollment_request, opts = {})
1943
+ data, _status_code, _headers = enroll_commseq_customer_with_http_info(storefront_oid, commseq_uuid, email_commseq_enrollment_request, opts)
1944
+ data
1945
+ end
1946
+
1947
+ # Enroll a customer into a communication sequence
1948
+ # Enrolls a single real customer (by email) into the communication sequence. A customer who is already enrolled will not be enrolled a second time.
1949
+ # @param storefront_oid [Integer]
1950
+ # @param commseq_uuid [String]
1951
+ # @param email_commseq_enrollment_request [EmailCommseqEnrollmentRequest] Commseq enrollment request
1952
+ # @param [Hash] opts the optional parameters
1953
+ # @return [Array<(EmailCommseqEnrollmentResponse, Integer, Hash)>] EmailCommseqEnrollmentResponse data, response status code and response headers
1954
+ def enroll_commseq_customer_with_http_info(storefront_oid, commseq_uuid, email_commseq_enrollment_request, opts = {})
1955
+ if @api_client.config.debugging
1956
+ @api_client.config.logger.debug 'Calling API: StorefrontApi.enroll_commseq_customer ...'
1957
+ end
1958
+ # verify the required parameter 'storefront_oid' is set
1959
+ if @api_client.config.client_side_validation && storefront_oid.nil?
1960
+ fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.enroll_commseq_customer"
1961
+ end
1962
+ # verify the required parameter 'commseq_uuid' is set
1963
+ if @api_client.config.client_side_validation && commseq_uuid.nil?
1964
+ fail ArgumentError, "Missing the required parameter 'commseq_uuid' when calling StorefrontApi.enroll_commseq_customer"
1965
+ end
1966
+ # verify the required parameter 'email_commseq_enrollment_request' is set
1967
+ if @api_client.config.client_side_validation && email_commseq_enrollment_request.nil?
1968
+ fail ArgumentError, "Missing the required parameter 'email_commseq_enrollment_request' when calling StorefrontApi.enroll_commseq_customer"
1969
+ end
1970
+ # resource path
1971
+ local_var_path = '/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/enroll'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_uuid' + '}', CGI.escape(commseq_uuid.to_s))
1972
+
1973
+ # query parameters
1974
+ query_params = opts[:query_params] || {}
1975
+
1976
+ # header parameters
1977
+ header_params = opts[:header_params] || {}
1978
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1979
+ # HTTP header 'Accept' (if needed)
1980
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1981
+ # HTTP header 'Content-Type'
1982
+ content_type = @api_client.select_header_content_type(['application/json'])
1983
+ if !content_type.nil?
1984
+ header_params['Content-Type'] = content_type
1985
+ end
1986
+
1987
+ # form parameters
1988
+ form_params = opts[:form_params] || {}
1989
+
1990
+ # http body (model)
1991
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(email_commseq_enrollment_request)
1992
+
1993
+ # return_type
1994
+ return_type = opts[:debug_return_type] || 'EmailCommseqEnrollmentResponse'
1995
+
1996
+ # auth_names
1997
+ auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
1998
+
1999
+ new_options = opts.merge(
2000
+ :operation => :"StorefrontApi.enroll_commseq_customer",
2001
+ :header_params => header_params,
2002
+ :query_params => query_params,
2003
+ :form_params => form_params,
2004
+ :body => post_body,
2005
+ :auth_names => auth_names,
2006
+ :return_type => return_type
2007
+ )
2008
+
2009
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2010
+ if @api_client.config.debugging
2011
+ @api_client.config.logger.debug "API called: StorefrontApi#enroll_commseq_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2012
+ end
2013
+ return data, status_code, headers
2014
+ end
2015
+
1935
2016
  # Update favorite flag on screen recording
1936
2017
  # Update favorite flag on screen recording
1937
2018
  # @param storefront_oid [Integer]