ultracart_api 3.10.5 → 3.10.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +14 -4
- data/docs/CustomerApi.md +105 -0
- data/docs/CustomerEditorValues.md +1 -0
- data/docs/CustomerStoreCredit.md +13 -0
- data/docs/CustomerStoreCreditAddRequest.md +11 -0
- data/docs/CustomerStoreCreditLedgerEntry.md +14 -0
- data/docs/CustomerStoreCreditResponse.md +12 -0
- data/docs/EmailThirdPartyProvider.md +2 -0
- data/docs/EmailThirdPartyTag.md +9 -0
- data/docs/OrderSummary.md +2 -0
- data/lib/ultracart_api/api/customer_api.rb +116 -0
- data/lib/ultracart_api/models/customer_editor_values.rb +11 -1
- data/lib/ultracart_api/models/customer_store_credit.rb +233 -0
- data/lib/ultracart_api/models/customer_store_credit_add_request.rb +215 -0
- data/lib/ultracart_api/models/customer_store_credit_ledger_entry.rb +260 -0
- data/lib/ultracart_api/models/customer_store_credit_response.rb +221 -0
- data/lib/ultracart_api/models/email_third_party_provider.rb +26 -4
- data/lib/ultracart_api/models/email_third_party_tag.rb +195 -0
- data/lib/ultracart_api/models/order_summary.rb +19 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +5 -0
- metadata +12 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e24468024bc0a064d4ac6a7be482b00b99185f525e073446b45db8aab2be2294
|
4
|
+
data.tar.gz: fe8393e1c2e1c0f74701075d457bad6e8b9192cec8014c924bb52fedc9c915b9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7fa00e0ae02f75340f5f28bc0ef30660a3528da6154a288c7f3006c7f55a91ab0279e6471108f7c635866be958f398d9554e192e0d785c5a042edff35d508333
|
7
|
+
data.tar.gz: b7984cec0f373a3960ab81ef574e41be088a4f1e163cfd9b86dbc43773872877d9042bd06bbbda029b0b30ede7674fafc6cfc32bfedcc465994e73894b60b8c2
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.10.
|
10
|
+
- Package version: 3.10.8
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-3.10.
|
27
|
+
gem install ./ultracart_api-3.10.8.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.8.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ultracart_api', '~> 3.10.
|
35
|
+
gem 'ultracart_api', '~> 3.10.8'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -158,12 +158,14 @@ Class | Method | HTTP request | Description
|
|
158
158
|
*UltracartClient::CouponApi* | [**update_coupon**](docs/CouponApi.md#update_coupon) | **PUT** /coupon/coupons/{coupon_oid} | Update a coupon
|
159
159
|
*UltracartClient::CouponApi* | [**update_coupons**](docs/CouponApi.md#update_coupons) | **PUT** /coupon/coupons/batch | Update multiple coupons
|
160
160
|
*UltracartClient::CouponApi* | [**upload_coupon_codes**](docs/CouponApi.md#upload_coupon_codes) | **POST** /coupon/coupons/{coupon_oid}/upload_codes | Upload one-time codes for a coupon
|
161
|
+
*UltracartClient::CustomerApi* | [**add_customer_store_credit**](docs/CustomerApi.md#add_customer_store_credit) | **POST** /customer/customers/{customer_profile_oid}/store_credit | Adds store credit to a customer
|
161
162
|
*UltracartClient::CustomerApi* | [**adjust_internal_certificate**](docs/CustomerApi.md#adjust_internal_certificate) | **POST** /customer/customers/{customer_profile_oid}/adjust_cashback_balance | Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
162
163
|
*UltracartClient::CustomerApi* | [**delete_customer**](docs/CustomerApi.md#delete_customer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
|
163
164
|
*UltracartClient::CustomerApi* | [**get_customer**](docs/CustomerApi.md#get_customer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
|
164
165
|
*UltracartClient::CustomerApi* | [**get_customer_by_email**](docs/CustomerApi.md#get_customer_by_email) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email
|
165
166
|
*UltracartClient::CustomerApi* | [**get_customer_editor_values**](docs/CustomerApi.md#get_customer_editor_values) | **GET** /customer/editor_values | Retrieve values needed for a customer profile editor
|
166
167
|
*UltracartClient::CustomerApi* | [**get_customer_email_lists**](docs/CustomerApi.md#get_customer_email_lists) | **GET** /customer/email_lists | Retrieve all email lists across all storefronts
|
168
|
+
*UltracartClient::CustomerApi* | [**get_customer_store_credit**](docs/CustomerApi.md#get_customer_store_credit) | **GET** /customer/customers/{customer_profile_oid}/store_credit | Retrieve the customer store credit accumulated through loyalty programs
|
167
169
|
*UltracartClient::CustomerApi* | [**get_customers**](docs/CustomerApi.md#get_customers) | **GET** /customer/customers | Retrieve customers
|
168
170
|
*UltracartClient::CustomerApi* | [**get_customers_by_query**](docs/CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query
|
169
171
|
*UltracartClient::CustomerApi* | [**get_customers_for_data_tables**](docs/CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
|
@@ -642,6 +644,10 @@ Class | Method | HTTP request | Description
|
|
642
644
|
- [UltracartClient::CustomerReviewer](docs/CustomerReviewer.md)
|
643
645
|
- [UltracartClient::CustomerShipping](docs/CustomerShipping.md)
|
644
646
|
- [UltracartClient::CustomerSoftwareEntitlement](docs/CustomerSoftwareEntitlement.md)
|
647
|
+
- [UltracartClient::CustomerStoreCredit](docs/CustomerStoreCredit.md)
|
648
|
+
- [UltracartClient::CustomerStoreCreditAddRequest](docs/CustomerStoreCreditAddRequest.md)
|
649
|
+
- [UltracartClient::CustomerStoreCreditLedgerEntry](docs/CustomerStoreCreditLedgerEntry.md)
|
650
|
+
- [UltracartClient::CustomerStoreCreditResponse](docs/CustomerStoreCreditResponse.md)
|
645
651
|
- [UltracartClient::CustomerTag](docs/CustomerTag.md)
|
646
652
|
- [UltracartClient::CustomerTaxCodes](docs/CustomerTaxCodes.md)
|
647
653
|
- [UltracartClient::CustomersResponse](docs/CustomersResponse.md)
|
@@ -753,6 +759,7 @@ Class | Method | HTTP request | Description
|
|
753
759
|
- [UltracartClient::EmailThirdPartyListImportRequest](docs/EmailThirdPartyListImportRequest.md)
|
754
760
|
- [UltracartClient::EmailThirdPartyProvider](docs/EmailThirdPartyProvider.md)
|
755
761
|
- [UltracartClient::EmailThirdPartyProvidersResponse](docs/EmailThirdPartyProvidersResponse.md)
|
762
|
+
- [UltracartClient::EmailThirdPartyTag](docs/EmailThirdPartyTag.md)
|
756
763
|
- [UltracartClient::EmailVerifyTokenRequest](docs/EmailVerifyTokenRequest.md)
|
757
764
|
- [UltracartClient::EmailVerifyTokenResponse](docs/EmailVerifyTokenResponse.md)
|
758
765
|
- [UltracartClient::EmailVerifyTokenValidateRequest](docs/EmailVerifyTokenValidateRequest.md)
|
@@ -1172,6 +1179,9 @@ Not every change is committed to every SDK.
|
|
1172
1179
|
|
1173
1180
|
| Version | Date | Comments |
|
1174
1181
|
| --: | :-: | --- |
|
1182
|
+
| 3.10.8 | 05/27/2022 | customer store credit |
|
1183
|
+
| 3.10.7 | 05/23/2022 | add internal gift cert to order summary, addl provider info for storefront comm |
|
1184
|
+
| 3.10.6 | 05/23/2022 | add internal gift cert to order summary, addl provider info for storefront comm |
|
1175
1185
|
| 3.10.5 | 05/20/2022 | dependabot on java gson version |
|
1176
1186
|
| 3.10.4 | 05/20/2022 | dependabot on java gson |
|
1177
1187
|
| 3.10.3 | 05/20/2022 | OrderApi.generatePackingSkip calls had wrong return type |
|
data/docs/CustomerApi.md
CHANGED
@@ -4,12 +4,14 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**add_customer_store_credit**](CustomerApi.md#add_customer_store_credit) | **POST** /customer/customers/{customer_profile_oid}/store_credit | Adds store credit to a customer
|
7
8
|
[**adjust_internal_certificate**](CustomerApi.md#adjust_internal_certificate) | **POST** /customer/customers/{customer_profile_oid}/adjust_cashback_balance | Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
8
9
|
[**delete_customer**](CustomerApi.md#delete_customer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
|
9
10
|
[**get_customer**](CustomerApi.md#get_customer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
|
10
11
|
[**get_customer_by_email**](CustomerApi.md#get_customer_by_email) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email
|
11
12
|
[**get_customer_editor_values**](CustomerApi.md#get_customer_editor_values) | **GET** /customer/editor_values | Retrieve values needed for a customer profile editor
|
12
13
|
[**get_customer_email_lists**](CustomerApi.md#get_customer_email_lists) | **GET** /customer/email_lists | Retrieve all email lists across all storefronts
|
14
|
+
[**get_customer_store_credit**](CustomerApi.md#get_customer_store_credit) | **GET** /customer/customers/{customer_profile_oid}/store_credit | Retrieve the customer store credit accumulated through loyalty programs
|
13
15
|
[**get_customers**](CustomerApi.md#get_customers) | **GET** /customer/customers | Retrieve customers
|
14
16
|
[**get_customers_by_query**](CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query
|
15
17
|
[**get_customers_for_data_tables**](CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
|
@@ -20,6 +22,59 @@ Method | HTTP request | Description
|
|
20
22
|
[**validate_email_verification_token**](CustomerApi.md#validate_email_verification_token) | **POST** /customer/customers/email_verify/validate_token | Validate a token that can be used to verify a customer email address
|
21
23
|
|
22
24
|
|
25
|
+
# **add_customer_store_credit**
|
26
|
+
> BaseResponse add_customer_store_credit(customer_profile_oid, store_credit_request)
|
27
|
+
|
28
|
+
Adds store credit to a customer
|
29
|
+
|
30
|
+
Adds store credit to a customer
|
31
|
+
|
32
|
+
### Example
|
33
|
+
```ruby
|
34
|
+
# load the gem
|
35
|
+
require 'ultracart_api'
|
36
|
+
|
37
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
38
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
39
|
+
api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
|
40
|
+
|
41
|
+
|
42
|
+
customer_profile_oid = 56 # Integer | The customer oid to credit.
|
43
|
+
|
44
|
+
store_credit_request = UltracartClient::CustomerStoreCreditAddRequest.new # CustomerStoreCreditAddRequest | Store credit to add
|
45
|
+
|
46
|
+
|
47
|
+
begin
|
48
|
+
#Adds store credit to a customer
|
49
|
+
result = api_instance.add_customer_store_credit(customer_profile_oid, store_credit_request)
|
50
|
+
p result
|
51
|
+
rescue UltracartClient::ApiError => e
|
52
|
+
puts "Exception when calling CustomerApi->add_customer_store_credit: #{e}"
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
### Parameters
|
57
|
+
|
58
|
+
Name | Type | Description | Notes
|
59
|
+
------------- | ------------- | ------------- | -------------
|
60
|
+
**customer_profile_oid** | **Integer**| The customer oid to credit. |
|
61
|
+
**store_credit_request** | [**CustomerStoreCreditAddRequest**](CustomerStoreCreditAddRequest.md)| Store credit to add |
|
62
|
+
|
63
|
+
### Return type
|
64
|
+
|
65
|
+
[**BaseResponse**](BaseResponse.md)
|
66
|
+
|
67
|
+
### Authorization
|
68
|
+
|
69
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
70
|
+
|
71
|
+
### HTTP request headers
|
72
|
+
|
73
|
+
- **Content-Type**: application/json; charset=UTF-8
|
74
|
+
- **Accept**: application/json
|
75
|
+
|
76
|
+
|
77
|
+
|
23
78
|
# **adjust_internal_certificate**
|
24
79
|
> AdjustInternalCertificateResponse adjust_internal_certificate(customer_profile_oid, adjust_internal_certificate_request)
|
25
80
|
|
@@ -320,6 +375,56 @@ This endpoint does not need any parameter.
|
|
320
375
|
|
321
376
|
|
322
377
|
|
378
|
+
# **get_customer_store_credit**
|
379
|
+
> CustomerStoreCreditResponse get_customer_store_credit(customer_profile_oid)
|
380
|
+
|
381
|
+
Retrieve the customer store credit accumulated through loyalty programs
|
382
|
+
|
383
|
+
Retrieve the customer store credit accumulated through loyalty programs
|
384
|
+
|
385
|
+
### Example
|
386
|
+
```ruby
|
387
|
+
# load the gem
|
388
|
+
require 'ultracart_api'
|
389
|
+
|
390
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
391
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
392
|
+
api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
|
393
|
+
|
394
|
+
|
395
|
+
customer_profile_oid = 56 # Integer | The customer oid to retrieve.
|
396
|
+
|
397
|
+
|
398
|
+
begin
|
399
|
+
#Retrieve the customer store credit accumulated through loyalty programs
|
400
|
+
result = api_instance.get_customer_store_credit(customer_profile_oid)
|
401
|
+
p result
|
402
|
+
rescue UltracartClient::ApiError => e
|
403
|
+
puts "Exception when calling CustomerApi->get_customer_store_credit: #{e}"
|
404
|
+
end
|
405
|
+
```
|
406
|
+
|
407
|
+
### Parameters
|
408
|
+
|
409
|
+
Name | Type | Description | Notes
|
410
|
+
------------- | ------------- | ------------- | -------------
|
411
|
+
**customer_profile_oid** | **Integer**| The customer oid to retrieve. |
|
412
|
+
|
413
|
+
### Return type
|
414
|
+
|
415
|
+
[**CustomerStoreCreditResponse**](CustomerStoreCreditResponse.md)
|
416
|
+
|
417
|
+
### Authorization
|
418
|
+
|
419
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
420
|
+
|
421
|
+
### HTTP request headers
|
422
|
+
|
423
|
+
- **Content-Type**: application/json
|
424
|
+
- **Accept**: application/json
|
425
|
+
|
426
|
+
|
427
|
+
|
323
428
|
# **get_customers**
|
324
429
|
> CustomersResponse get_customers(opts)
|
325
430
|
|
@@ -8,6 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**card_exp_years** | **Array<String>** | card_exp_years | [optional]
|
9
9
|
**card_types** | **Array<String>** | card_types | [optional]
|
10
10
|
**countries** | [**Array<Country>**](Country.md) | countries | [optional]
|
11
|
+
**loyalty_program_type** | **String** | loyalty_program_type | [optional]
|
11
12
|
**qb_classes** | **Array<String>** | qb_classes | [optional]
|
12
13
|
**sales_rep_codes** | **Array<String>** | sales_rep_codes | [optional]
|
13
14
|
**state_optional_countries** | [**Array<Country>**](Country.md) | state_optional_countries | [optional]
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# UltracartClient::CustomerStoreCredit
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**available** | **Float** | | [optional]
|
7
|
+
**expiring** | **Float** | | [optional]
|
8
|
+
**future_ledgers** | [**Array<CustomerStoreCreditLedgerEntry>**](CustomerStoreCreditLedgerEntry.md) | | [optional]
|
9
|
+
**past_ledgers** | [**Array<CustomerStoreCreditLedgerEntry>**](CustomerStoreCreditLedgerEntry.md) | | [optional]
|
10
|
+
**total** | **Float** | | [optional]
|
11
|
+
**vesting** | **Float** | | [optional]
|
12
|
+
|
13
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# UltracartClient::CustomerStoreCreditAddRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**amount** | **Float** | Amount of store credit | [optional]
|
7
|
+
**description** | **String** | Description or reason for the store credit | [optional]
|
8
|
+
**expiration_days** | **Integer** | Optional days for store credit to expire or zero for no expiration | [optional]
|
9
|
+
**vesting_days** | **Integer** | Optional days for store credit to vesting or zero for immediately available | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# UltracartClient::CustomerStoreCreditLedgerEntry
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**action** | **String** | Identifies the state of this ledger entry whether the entry is Vesting or Expiring | [optional]
|
7
|
+
**amount** | **Float** | The amount of the activity. | [optional]
|
8
|
+
**description** | **String** | Description of what this ledger entry is used. | [optional]
|
9
|
+
**entry_dts** | **String** | Date time of this ledger activity. | [optional]
|
10
|
+
**gift_certificate_ledger_oid** | **Integer** | Gift certificate ledger oid is a primary key for this object, used internally. | [optional]
|
11
|
+
**gift_certificate_oid** | **Integer** | Gift certificate oid. | [optional]
|
12
|
+
**reference_order_id** | **String** | The order id if this gift certificate was used as part of the payment. | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::CustomerStoreCreditResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**customer_store_credit** | [**CustomerStoreCredit**](CustomerStoreCredit.md) | | [optional]
|
7
|
+
**error** | [**Error**](Error.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
|
+
|
@@ -12,5 +12,7 @@ Name | Type | Description | Notes
|
|
12
12
|
**supports_list_subscribe** | **BOOLEAN** | True if this provider can support list subscribe | [optional]
|
13
13
|
**supports_list_unsubscribe** | **BOOLEAN** | True if this provider can support list unsubscribe | [optional]
|
14
14
|
**supports_remove_tags** | **BOOLEAN** | True if this provider can support remove tags | [optional]
|
15
|
+
**tag_count** | **Integer** | tag_count | [optional]
|
16
|
+
**tags** | [**Array<EmailThirdPartyTag>**](EmailThirdPartyTag.md) | tags | [optional]
|
15
17
|
|
16
18
|
|
data/docs/OrderSummary.md
CHANGED
@@ -7,6 +7,8 @@ Name | Type | Description | Notes
|
|
7
7
|
**actual_payment_processing** | [**Currency**](Currency.md) | | [optional]
|
8
8
|
**actual_shipping** | [**Currency**](Currency.md) | | [optional]
|
9
9
|
**arbitrary_shipping_handling_total** | [**Currency**](Currency.md) | | [optional]
|
10
|
+
**internal_gift_certificate_amount** | [**Currency**](Currency.md) | | [optional]
|
11
|
+
**internal_gift_certificate_refunded** | [**Currency**](Currency.md) | | [optional]
|
10
12
|
**other_refunded** | [**Currency**](Currency.md) | | [optional]
|
11
13
|
**shipping_handling_refunded** | [**Currency**](Currency.md) | | [optional]
|
12
14
|
**shipping_handling_total** | [**Currency**](Currency.md) | | [optional]
|
@@ -32,6 +32,67 @@ module UltracartClient
|
|
32
32
|
UltracartClient::CustomerApi.new(api_client)
|
33
33
|
end
|
34
34
|
|
35
|
+
# Adds store credit to a customer
|
36
|
+
# Adds store credit to a customer
|
37
|
+
# @param customer_profile_oid The customer oid to credit.
|
38
|
+
# @param store_credit_request Store credit to add
|
39
|
+
# @param [Hash] opts the optional parameters
|
40
|
+
# @return [BaseResponse]
|
41
|
+
def add_customer_store_credit(customer_profile_oid, store_credit_request, opts = {})
|
42
|
+
data, _status_code, _headers = add_customer_store_credit_with_http_info(customer_profile_oid, store_credit_request, opts)
|
43
|
+
data
|
44
|
+
end
|
45
|
+
|
46
|
+
# Adds store credit to a customer
|
47
|
+
# Adds store credit to a customer
|
48
|
+
# @param customer_profile_oid The customer oid to credit.
|
49
|
+
# @param store_credit_request Store credit to add
|
50
|
+
# @param [Hash] opts the optional parameters
|
51
|
+
# @return [Array<(BaseResponse, Fixnum, Hash)>] BaseResponse data, response status code and response headers
|
52
|
+
def add_customer_store_credit_with_http_info(customer_profile_oid, store_credit_request, opts = {})
|
53
|
+
if @api_client.config.debugging
|
54
|
+
@api_client.config.logger.debug 'Calling API: CustomerApi.add_customer_store_credit ...'
|
55
|
+
end
|
56
|
+
# verify the required parameter 'customer_profile_oid' is set
|
57
|
+
if @api_client.config.client_side_validation && customer_profile_oid.nil?
|
58
|
+
fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.add_customer_store_credit"
|
59
|
+
end
|
60
|
+
# verify the required parameter 'store_credit_request' is set
|
61
|
+
if @api_client.config.client_side_validation && store_credit_request.nil?
|
62
|
+
fail ArgumentError, "Missing the required parameter 'store_credit_request' when calling CustomerApi.add_customer_store_credit"
|
63
|
+
end
|
64
|
+
# resource path
|
65
|
+
local_var_path = '/customer/customers/{customer_profile_oid}/store_credit'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s)
|
66
|
+
|
67
|
+
# query parameters
|
68
|
+
query_params = {}
|
69
|
+
|
70
|
+
# header parameters
|
71
|
+
header_params = {}
|
72
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
73
|
+
# HTTP header 'Accept' (if needed)
|
74
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
75
|
+
# HTTP header 'Content-Type'
|
76
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
77
|
+
|
78
|
+
# form parameters
|
79
|
+
form_params = {}
|
80
|
+
|
81
|
+
# http body (model)
|
82
|
+
post_body = @api_client.object_to_http_body(store_credit_request)
|
83
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
84
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
85
|
+
:header_params => header_params,
|
86
|
+
:query_params => query_params,
|
87
|
+
:form_params => form_params,
|
88
|
+
:body => post_body,
|
89
|
+
:auth_names => auth_names,
|
90
|
+
:return_type => 'BaseResponse')
|
91
|
+
if @api_client.config.debugging
|
92
|
+
@api_client.config.logger.debug "API called: CustomerApi#add_customer_store_credit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
93
|
+
end
|
94
|
+
return data, status_code, headers
|
95
|
+
end
|
35
96
|
# Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
36
97
|
# Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
37
98
|
# @param customer_profile_oid The customer profile oid
|
@@ -361,6 +422,61 @@ module UltracartClient
|
|
361
422
|
end
|
362
423
|
return data, status_code, headers
|
363
424
|
end
|
425
|
+
# Retrieve the customer store credit accumulated through loyalty programs
|
426
|
+
# Retrieve the customer store credit accumulated through loyalty programs
|
427
|
+
# @param customer_profile_oid The customer oid to retrieve.
|
428
|
+
# @param [Hash] opts the optional parameters
|
429
|
+
# @return [CustomerStoreCreditResponse]
|
430
|
+
def get_customer_store_credit(customer_profile_oid, opts = {})
|
431
|
+
data, _status_code, _headers = get_customer_store_credit_with_http_info(customer_profile_oid, opts)
|
432
|
+
data
|
433
|
+
end
|
434
|
+
|
435
|
+
# Retrieve the customer store credit accumulated through loyalty programs
|
436
|
+
# Retrieve the customer store credit accumulated through loyalty programs
|
437
|
+
# @param customer_profile_oid The customer oid to retrieve.
|
438
|
+
# @param [Hash] opts the optional parameters
|
439
|
+
# @return [Array<(CustomerStoreCreditResponse, Fixnum, Hash)>] CustomerStoreCreditResponse data, response status code and response headers
|
440
|
+
def get_customer_store_credit_with_http_info(customer_profile_oid, opts = {})
|
441
|
+
if @api_client.config.debugging
|
442
|
+
@api_client.config.logger.debug 'Calling API: CustomerApi.get_customer_store_credit ...'
|
443
|
+
end
|
444
|
+
# verify the required parameter 'customer_profile_oid' is set
|
445
|
+
if @api_client.config.client_side_validation && customer_profile_oid.nil?
|
446
|
+
fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.get_customer_store_credit"
|
447
|
+
end
|
448
|
+
# resource path
|
449
|
+
local_var_path = '/customer/customers/{customer_profile_oid}/store_credit'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s)
|
450
|
+
|
451
|
+
# query parameters
|
452
|
+
query_params = {}
|
453
|
+
|
454
|
+
# header parameters
|
455
|
+
header_params = {}
|
456
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
457
|
+
# HTTP header 'Accept' (if needed)
|
458
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
459
|
+
# HTTP header 'Content-Type'
|
460
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
461
|
+
|
462
|
+
# form parameters
|
463
|
+
form_params = {}
|
464
|
+
|
465
|
+
# http body (model)
|
466
|
+
post_body = nil
|
467
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
468
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
469
|
+
:header_params => header_params,
|
470
|
+
:query_params => query_params,
|
471
|
+
:form_params => form_params,
|
472
|
+
:body => post_body,
|
473
|
+
:auth_names => auth_names,
|
474
|
+
:return_type => 'CustomerStoreCreditResponse')
|
475
|
+
if @api_client.config.debugging
|
476
|
+
@api_client.config.logger.debug "API called: CustomerApi#get_customer_store_credit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
477
|
+
end
|
478
|
+
return data, status_code, headers
|
479
|
+
end
|
364
480
|
# Retrieve customers
|
365
481
|
# Retrieves customers from the account. If no parameters are specified, all customers will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
366
482
|
# @param [Hash] opts the optional parameters
|
@@ -29,6 +29,9 @@ module UltracartClient
|
|
29
29
|
# countries
|
30
30
|
attr_accessor :countries
|
31
31
|
|
32
|
+
# loyalty_program_type
|
33
|
+
attr_accessor :loyalty_program_type
|
34
|
+
|
32
35
|
# qb_classes
|
33
36
|
attr_accessor :qb_classes
|
34
37
|
|
@@ -49,6 +52,7 @@ module UltracartClient
|
|
49
52
|
:'card_exp_years' => :'card_exp_years',
|
50
53
|
:'card_types' => :'card_types',
|
51
54
|
:'countries' => :'countries',
|
55
|
+
:'loyalty_program_type' => :'loyalty_program_type',
|
52
56
|
:'qb_classes' => :'qb_classes',
|
53
57
|
:'sales_rep_codes' => :'sales_rep_codes',
|
54
58
|
:'state_optional_countries' => :'state_optional_countries',
|
@@ -64,6 +68,7 @@ module UltracartClient
|
|
64
68
|
:'card_exp_years' => :'Array<String>',
|
65
69
|
:'card_types' => :'Array<String>',
|
66
70
|
:'countries' => :'Array<Country>',
|
71
|
+
:'loyalty_program_type' => :'String',
|
67
72
|
:'qb_classes' => :'Array<String>',
|
68
73
|
:'sales_rep_codes' => :'Array<String>',
|
69
74
|
:'state_optional_countries' => :'Array<Country>',
|
@@ -109,6 +114,10 @@ module UltracartClient
|
|
109
114
|
end
|
110
115
|
end
|
111
116
|
|
117
|
+
if attributes.has_key?(:'loyalty_program_type')
|
118
|
+
self.loyalty_program_type = attributes[:'loyalty_program_type']
|
119
|
+
end
|
120
|
+
|
112
121
|
if attributes.has_key?(:'qb_classes')
|
113
122
|
if (value = attributes[:'qb_classes']).is_a?(Array)
|
114
123
|
self.qb_classes = value
|
@@ -157,6 +166,7 @@ module UltracartClient
|
|
157
166
|
card_exp_years == o.card_exp_years &&
|
158
167
|
card_types == o.card_types &&
|
159
168
|
countries == o.countries &&
|
169
|
+
loyalty_program_type == o.loyalty_program_type &&
|
160
170
|
qb_classes == o.qb_classes &&
|
161
171
|
sales_rep_codes == o.sales_rep_codes &&
|
162
172
|
state_optional_countries == o.state_optional_countries &&
|
@@ -172,7 +182,7 @@ module UltracartClient
|
|
172
182
|
# Calculates hash code according to all attributes.
|
173
183
|
# @return [Fixnum] Hash code
|
174
184
|
def hash
|
175
|
-
[affiliates, card_exp_months, card_exp_years, card_types, countries, qb_classes, sales_rep_codes, state_optional_countries, terms].hash
|
185
|
+
[affiliates, card_exp_months, card_exp_years, card_types, countries, loyalty_program_type, qb_classes, sales_rep_codes, state_optional_countries, terms].hash
|
176
186
|
end
|
177
187
|
|
178
188
|
# Builds the object from hash
|