docs/CouponApi.md in ultracart_api-3.0.76 vs docs/CouponApi.md in ultracart_api-3.1.0
- old
+ new
@@ -34,22 +34,15 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
coupon_oid = 56 # Integer | The coupon_oid to delete.
begin
@@ -90,22 +83,15 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
coupon_delete_request = UltracartClient::CouponDeletesRequest.new # CouponDeletesRequest | Coupon oids to delete
begin
@@ -146,22 +132,15 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
coupon_delete_request = UltracartClient::CouponDeletesRequest.new # CouponDeletesRequest | Coupon oids to delete
begin
@@ -202,22 +181,15 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
merchant_code = 'merchant_code_example' # String | The coupon merchant code to examine.
begin
@@ -259,22 +231,15 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
coupon_oid = 56 # Integer | The coupon oid to generate codes.
coupon_codes_request = UltracartClient::CouponCodesRequest.new # CouponCodesRequest | Coupon code generation parameters
@@ -319,22 +284,15 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
merchant_code = 'merchant_code_example' # String | The merchant code to generate one time codes.
coupon_codes_request = UltracartClient::CouponCodesRequest.new # CouponCodesRequest | Coupon code generation parameters
@@ -379,23 +337,17 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
+
begin
#Retrieve auto apply rules and conditions
result = api_instance.get_auto_apply
p result
rescue UltracartClient::ApiError => e
@@ -430,22 +382,15 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
coupon_oid = 56 # Integer | The coupon oid to retrieve.
opts = {
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
@@ -491,22 +436,15 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
merchant_code = 'merchant_code_example' # String | The coupon merchant code to retrieve.
opts = {
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
@@ -552,22 +490,15 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
opts = {
merchant_code: 'merchant_code_example', # String | Merchant code
description: 'description_example', # String | Description
coupon_type: 'coupon_type_example', # String | Coupon type
@@ -634,22 +565,15 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
coupon_query = UltracartClient::CouponQuery.new # CouponQuery | Coupon query
opts = {
_limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
@@ -701,23 +625,17 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
+
begin
#Retrieve values needed for a coupon editor
result = api_instance.get_editor_values
p result
rescue UltracartClient::ApiError => e
@@ -752,22 +670,15 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
coupon = UltracartClient::Coupon.new # Coupon | Coupon to insert
opts = {
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
@@ -813,22 +724,15 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
coupons_request = UltracartClient::CouponsRequest.new # CouponsRequest | Coupons to insert (maximum 20)
opts = {
_expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
@@ -876,22 +780,15 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
opts = {
s: 's_example', # String |
m: 56 # Integer |
}
@@ -936,22 +833,15 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
conditions = UltracartClient::CouponAutoApplyConditions.new # CouponAutoApplyConditions | Conditions
begin
@@ -992,22 +882,15 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
coupon = UltracartClient::Coupon.new # Coupon | Coupon to update
coupon_oid = 56 # Integer | The coupon_oid to update.
@@ -1056,22 +939,15 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
coupons_request = UltracartClient::CouponsRequest.new # CouponsRequest | Coupons to update (synchronous maximum 20 / asynchronous maximum 100)
opts = {
_expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
@@ -1121,21 +997,14 @@
### Example
```ruby
# load the gem
require 'ultracart_api'
-# setup authorization
-UltracartClient.configure do |config|
- # Configure OAuth2 access token for authorization: ultraCartOauth
- config.access_token = 'YOUR ACCESS TOKEN'
- # Configure API key authorization: ultraCartSimpleApiKey
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
-end
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
-api_instance = UltracartClient::CouponApi.new
coupon_oid = 56 # Integer | The coupon oid to associate with the provided one-time codes.
upload_coupon_codes_request = UltracartClient::UploadCouponCodesRequest.new # UploadCouponCodesRequest | One-time coupon codes