ultracart_api 3.7.38 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67158a76743074e8b813d7cba7026488e7e072342a8e5a78bfcf5d7926b415c8
-  data.tar.gz: 368fd92091c21b7373defede99ee0db00e579f3a9f8d293a164196674202b533
+  metadata.gz: 525852c2356a09418a97f953e0837e873dd3dd21dac6d43617b7c160104921ac
+  data.tar.gz: 81e824756f7b0bede13c30efa96e2e470865aa925b2f72ebb06dc05f79a3bbbe
 SHA512:
-  metadata.gz: '065385085d3fae43fd22175af668d00b54b103fde9fb7dfd62b05dd760b0c69969ffdaf59c5b7fee13857e0e1de6fd4ccab61b9b085605aac7e93b3eef0f2fb7'
-  data.tar.gz: 84b1752eca49d07935315dd0528110d00534413a12dcc7616d1f9541a2ff31717438c1dceaafcfb759e76662d77a8d8589655e162f2bf4be98ea3f807c29a2f9
+  metadata.gz: 95b9909635079523f412cc6992311022444d40ea5d039400b35b6110430298a6f62fe59e71a73b3ccc433a40a5d139338f2fa06707075209efd03ed7e07e913e
+  data.tar.gz: a2b8970f62a2a3d39b197b67883394eadbfab62f7f26a325c0185b6d05eac3125b5b9894dd10a4ce88c99c07495260d0e5b293670aac4df9c859658f0814a41e

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.7.38
+- Package version: 3.8.0
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.7.38.gem
+gem install ./ultracart_api-3.8.0.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.7.38.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.8.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 3.7.38'
+    gem 'ultracart_api', '~> 3.8.0'
 
 ### Install from Git
 
@@ -173,6 +173,14 @@ Class | Method | HTTP request | Description
 *UltracartClient::FulfillmentApi* | [**get_distribution_centers**](docs/FulfillmentApi.md#get_distribution_centers) | **GET** /fulfillment/distribution_centers | Retrieve distribution centers
 *UltracartClient::FulfillmentApi* | [**ship_orders**](docs/FulfillmentApi.md#ship_orders) | **POST** /fulfillment/distribution_centers/{distribution_center_code}/shipments | Mark orders as shipped
 *UltracartClient::FulfillmentApi* | [**update_inventory**](docs/FulfillmentApi.md#update_inventory) | **POST** /fulfillment/distribution_centers/{distribution_center_code}/inventory | Update inventory
+*UltracartClient::GiftCertificateApi* | [**add_gift_certificate_ledger_entry**](docs/GiftCertificateApi.md#add_gift_certificate_ledger_entry) | **POST** /gift_certificate/gift_certificates/{gift_certificate_oid}/ledger_entry | Add a gift certificate ledger entry
+*UltracartClient::GiftCertificateApi* | [**create_gift_certificate**](docs/GiftCertificateApi.md#create_gift_certificate) | **POST** /gift_certificate/gift_certificates | Create a gift certificate
+*UltracartClient::GiftCertificateApi* | [**delete_gift_certificate**](docs/GiftCertificateApi.md#delete_gift_certificate) | **DELETE** /gift_certificate/gift_certificates/{gift_certificate_oid} | Delete a gift certificate
+*UltracartClient::GiftCertificateApi* | [**get_gift_certificate_by_code**](docs/GiftCertificateApi.md#get_gift_certificate_by_code) | **POST** /gift_certificate/gift_certificates/by_code/{code} | Retrieve gift certificate by code
+*UltracartClient::GiftCertificateApi* | [**get_gift_certificate_by_oid**](docs/GiftCertificateApi.md#get_gift_certificate_by_oid) | **POST** /gift_certificate/gift_certificates/{gift_certificate_oid} | Retrieve gift certificate by oid
+*UltracartClient::GiftCertificateApi* | [**get_gift_certificates_by_email**](docs/GiftCertificateApi.md#get_gift_certificates_by_email) | **POST** /gift_certificate/gift_certificates/by_email/{email} | Retrieve gift certificate by email
+*UltracartClient::GiftCertificateApi* | [**get_gift_certificates_by_query**](docs/GiftCertificateApi.md#get_gift_certificates_by_query) | **POST** /gift_certificate/gift_certificates/query | Retrieve gift certificates by query
+*UltracartClient::GiftCertificateApi* | [**update_gift_certificate**](docs/GiftCertificateApi.md#update_gift_certificate) | **PUT** /gift_certificate/gift_certificates/{gift_certificate_oid} | Update a gift certificate
 *UltracartClient::IntegrationLogApi* | [**get_integration_log**](docs/IntegrationLogApi.md#get_integration_log) | **GET** /integration_log/query/{pk}/{sk} | Retrieve an integration log
 *UltracartClient::IntegrationLogApi* | [**get_integration_log_file**](docs/IntegrationLogApi.md#get_integration_log_file) | **GET** /integration_log/query/{pk}/{sk}/{uuid} | Retrieve an integration log file
 *UltracartClient::IntegrationLogApi* | [**get_integration_log_summaries_query**](docs/IntegrationLogApi.md#get_integration_log_summaries_query) | **POST** /integration_log/summary/query | Retrieve integration log summaries
@@ -738,6 +746,12 @@ Class | Method | HTTP request | Description
  - [UltracartClient::GeoPoint](docs/GeoPoint.md)
  - [UltracartClient::GeocodeRequest](docs/GeocodeRequest.md)
  - [UltracartClient::GeocodeResponse](docs/GeocodeResponse.md)
+ - [UltracartClient::GiftCertificate](docs/GiftCertificate.md)
+ - [UltracartClient::GiftCertificateCreateRequest](docs/GiftCertificateCreateRequest.md)
+ - [UltracartClient::GiftCertificateLedgerEntry](docs/GiftCertificateLedgerEntry.md)
+ - [UltracartClient::GiftCertificateQuery](docs/GiftCertificateQuery.md)
+ - [UltracartClient::GiftCertificateResponse](docs/GiftCertificateResponse.md)
+ - [UltracartClient::GiftCertificatesResponse](docs/GiftCertificatesResponse.md)
  - [UltracartClient::Group](docs/Group.md)
  - [UltracartClient::GroupResponse](docs/GroupResponse.md)
  - [UltracartClient::GroupUserMembership](docs/GroupUserMembership.md)
@@ -1129,6 +1143,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.8.0 | 02/16/2022 | gift certificate api (testing) |
 | 3.7.38 | 02/15/2022 | gift certificate api (currently in testing) |
 | 3.6.38 | 02/07/2022 | Exposed auto order logs |
 | 3.6.37 | 02/04/2022 | insurance type for insurance payments |

data/docs/GiftCertificate.md

@@ -0,0 +1,19 @@
+# UltracartClient::GiftCertificate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**activated** | **BOOLEAN** | True if this gift certificate is activated and ready to apply to purchases. | [optional] 
+**code** | **String** | The code used by the customer to purchase against this gift certificate. | [optional] 
+**deleted** | **BOOLEAN** | True if this gift certificate was deleted. | [optional] 
+**email** | **String** | Email of the customer associated with this gift certificate. | [optional] 
+**expiration_dts** | **String** | Expiration date time. | [optional] 
+**gift_certificate_oid** | **Integer** | Gift certificate oid. | [optional] 
+**ledger_entries** | [**Array<GiftCertificateLedgerEntry>**](GiftCertificateLedgerEntry.md) | A list of all ledger activity for this gift certificate. | [optional] 
+**merchant_id** | **String** | Merchant Id | [optional] 
+**merchant_note** | **String** | A list of all ledger activity for this gift certificate. | [optional] 
+**original_balance** | **Float** | Original balance of the gift certificate. | [optional] 
+**reference_order_id** | **String** | The order used to purchase this gift certificate.  This value is ONLY set during checkout when a certificate is purchased, not when it is used.  Any usage is recorded in the ledger | [optional] 
+**remaining_balance** | **Float** | The remaining balance on the gift certificate.  This is never set directly, but calculated from the ledger.  To change the remaining balance, add a ledger entry. | [optional] 
+
+

data/docs/GiftCertificateApi.md

@@ -0,0 +1,433 @@
+# UltracartClient::GiftCertificateApi
+
+All URIs are relative to *https://secure.ultracart.com/rest/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**add_gift_certificate_ledger_entry**](GiftCertificateApi.md#add_gift_certificate_ledger_entry) | **POST** /gift_certificate/gift_certificates/{gift_certificate_oid}/ledger_entry | Add a gift certificate ledger entry
+[**create_gift_certificate**](GiftCertificateApi.md#create_gift_certificate) | **POST** /gift_certificate/gift_certificates | Create a gift certificate
+[**delete_gift_certificate**](GiftCertificateApi.md#delete_gift_certificate) | **DELETE** /gift_certificate/gift_certificates/{gift_certificate_oid} | Delete a gift certificate
+[**get_gift_certificate_by_code**](GiftCertificateApi.md#get_gift_certificate_by_code) | **POST** /gift_certificate/gift_certificates/by_code/{code} | Retrieve gift certificate by code
+[**get_gift_certificate_by_oid**](GiftCertificateApi.md#get_gift_certificate_by_oid) | **POST** /gift_certificate/gift_certificates/{gift_certificate_oid} | Retrieve gift certificate by oid
+[**get_gift_certificates_by_email**](GiftCertificateApi.md#get_gift_certificates_by_email) | **POST** /gift_certificate/gift_certificates/by_email/{email} | Retrieve gift certificate by email
+[**get_gift_certificates_by_query**](GiftCertificateApi.md#get_gift_certificates_by_query) | **POST** /gift_certificate/gift_certificates/query | Retrieve gift certificates by query
+[**update_gift_certificate**](GiftCertificateApi.md#update_gift_certificate) | **PUT** /gift_certificate/gift_certificates/{gift_certificate_oid} | Update a gift certificate
+
+
+# **add_gift_certificate_ledger_entry**
+> GiftCertificateResponse add_gift_certificate_ledger_entry(gift_certificate_oid, gift_certificate_ledger_entry)
+
+Add a gift certificate ledger entry
+
+Adds a ledger entry for this gift certificate. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::GiftCertificateApi.new_using_api_key(simple_key, false, false)
+
+
+gift_certificate_oid = 56 # Integer | 
+
+gift_certificate_ledger_entry = UltracartClient::GiftCertificateLedgerEntry.new # GiftCertificateLedgerEntry | Gift certificate ledger entry
+
+
+begin
+  #Add a gift certificate ledger entry
+  result = api_instance.add_gift_certificate_ledger_entry(gift_certificate_oid, gift_certificate_ledger_entry)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling GiftCertificateApi->add_gift_certificate_ledger_entry: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **gift_certificate_oid** | **Integer**|  | 
+ **gift_certificate_ledger_entry** | [**GiftCertificateLedgerEntry**](GiftCertificateLedgerEntry.md)| Gift certificate ledger entry | 
+
+### Return type
+
+[**GiftCertificateResponse**](GiftCertificateResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_gift_certificate**
+> GiftCertificateResponse create_gift_certificate(gift_certificate_create_request)
+
+Create a gift certificate
+
+Creates a gift certificate for this merchant account. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::GiftCertificateApi.new_using_api_key(simple_key, false, false)
+
+
+gift_certificate_create_request = UltracartClient::GiftCertificateCreateRequest.new # GiftCertificateCreateRequest | Gift certificate create request
+
+
+begin
+  #Create a gift certificate
+  result = api_instance.create_gift_certificate(gift_certificate_create_request)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling GiftCertificateApi->create_gift_certificate: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **gift_certificate_create_request** | [**GiftCertificateCreateRequest**](GiftCertificateCreateRequest.md)| Gift certificate create request | 
+
+### Return type
+
+[**GiftCertificateResponse**](GiftCertificateResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_gift_certificate**
+> delete_gift_certificate(gift_certificate_oid)
+
+Delete a gift certificate
+
+Deletes a gift certificate for this merchant account. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::GiftCertificateApi.new_using_api_key(simple_key, false, false)
+
+
+gift_certificate_oid = 56 # Integer | 
+
+
+begin
+  #Delete a gift certificate
+  api_instance.delete_gift_certificate(gift_certificate_oid)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling GiftCertificateApi->delete_gift_certificate: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **gift_certificate_oid** | **Integer**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_gift_certificate_by_code**
+> GiftCertificateResponse get_gift_certificate_by_code(code)
+
+Retrieve gift certificate by code
+
+Retrieves a gift certificate from the account based on the code (the value the customer enters at checkout time). 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::GiftCertificateApi.new_using_api_key(simple_key, false, false)
+
+
+code = 'code_example' # String | 
+
+
+begin
+  #Retrieve gift certificate by code
+  result = api_instance.get_gift_certificate_by_code(code)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling GiftCertificateApi->get_gift_certificate_by_code: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **code** | **String**|  | 
+
+### Return type
+
+[**GiftCertificateResponse**](GiftCertificateResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_gift_certificate_by_oid**
+> GiftCertificateResponse get_gift_certificate_by_oid(gift_certificate_oid)
+
+Retrieve gift certificate by oid
+
+Retrieves a gift certificate from the account based on the internal primary key. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::GiftCertificateApi.new_using_api_key(simple_key, false, false)
+
+
+gift_certificate_oid = 56 # Integer | 
+
+
+begin
+  #Retrieve gift certificate by oid
+  result = api_instance.get_gift_certificate_by_oid(gift_certificate_oid)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling GiftCertificateApi->get_gift_certificate_by_oid: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **gift_certificate_oid** | **Integer**|  | 
+
+### Return type
+
+[**GiftCertificateResponse**](GiftCertificateResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_gift_certificates_by_email**
+> GiftCertificatesResponse get_gift_certificates_by_email(email)
+
+Retrieve gift certificate by email
+
+Retrieves all gift certificates from the account based on customer email. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::GiftCertificateApi.new_using_api_key(simple_key, false, false)
+
+
+email = 'email_example' # String | 
+
+
+begin
+  #Retrieve gift certificate by email
+  result = api_instance.get_gift_certificates_by_email(email)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling GiftCertificateApi->get_gift_certificates_by_email: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **email** | **String**|  | 
+
+### Return type
+
+[**GiftCertificatesResponse**](GiftCertificatesResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_gift_certificates_by_query**
+> GiftCertificatesResponse get_gift_certificates_by_query(gift_certificate_query, opts)
+
+Retrieve gift certificates by query
+
+Retrieves gift certificates from the account.  If no parameters are specified, all gift certificates 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. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::GiftCertificateApi.new_using_api_key(simple_key, false, false)
+
+
+gift_certificate_query = UltracartClient::GiftCertificateQuery.new # GiftCertificateQuery | Gift certificates query
+
+opts = { 
+  _limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
+  _offset: 0, # Integer | Pagination of the record set.  Offset is a zero based index.
+  _since: '_since_example', # String | Fetch customers that have been created/modified since this date/time.
+  _sort: '_sort_example', # String | The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+  _expand: '_expand_example' # String | The object expansion to perform on the result.  See documentation for examples
+}
+
+begin
+  #Retrieve gift certificates by query
+  result = api_instance.get_gift_certificates_by_query(gift_certificate_query, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling GiftCertificateApi->get_gift_certificates_by_query: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **gift_certificate_query** | [**GiftCertificateQuery**](GiftCertificateQuery.md)| Gift certificates query | 
+ **_limit** | **Integer**| The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100]
+ **_offset** | **Integer**| Pagination of the record set.  Offset is a zero based index. | [optional] [default to 0]
+ **_since** | **String**| Fetch customers that have been created/modified since this date/time. | [optional] 
+ **_sort** | **String**| The sort order of the customers.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] 
+ **_expand** | **String**| The object expansion to perform on the result.  See documentation for examples | [optional] 
+
+### Return type
+
+[**GiftCertificatesResponse**](GiftCertificatesResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_gift_certificate**
+> GiftCertificateResponse update_gift_certificate(gift_certificate_oid, gift_certificate)
+
+Update a gift certificate
+
+Update a gift certificate for this merchant account. 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::GiftCertificateApi.new_using_api_key(simple_key, false, false)
+
+
+gift_certificate_oid = 56 # Integer | 
+
+gift_certificate = UltracartClient::GiftCertificate.new # GiftCertificate | Gift certificate
+
+
+begin
+  #Update a gift certificate
+  result = api_instance.update_gift_certificate(gift_certificate_oid, gift_certificate)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling GiftCertificateApi->update_gift_certificate: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **gift_certificate_oid** | **Integer**|  | 
+ **gift_certificate** | [**GiftCertificate**](GiftCertificate.md)| Gift certificate | 
+
+### Return type
+
+[**GiftCertificateResponse**](GiftCertificateResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/GiftCertificateCreateRequest.md

@@ -0,0 +1,11 @@
+# UltracartClient::GiftCertificateCreateRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | Initial amount of this gift certificate. | [optional] 
+**expiration_dts** | **String** | Expiration date time. | [optional] 
+**initial_ledger_description** | **String** | A brief description of how and/or why this gift certificate was created. | [optional] 
+**merchant_note** | **String** | Any internal details you wish to record about this gift certificate. | [optional] 
+
+

data/docs/GiftCertificateLedgerEntry.md

@@ -0,0 +1,13 @@
+# UltracartClient::GiftCertificateLedgerEntry
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | The amount of the activity. | [optional] 
+**description** | **String** | Description of what this ledger entry is used. | [optional] 
+**entry_dts** | **String** | Date time of this ledger activity. | [optional] 
+**gift_certificate_ledger_oid** | **Integer** | Gift certificate ledger oid is a primary key for this object, used internally. | [optional] 
+**gift_certificate_oid** | **Integer** | Gift certificate oid. | [optional] 
+**reference_order_id** | **String** | The order id if this gift certificate was used as part of the payment. | [optional] 
+
+

data/docs/GiftCertificateQuery.md

@@ -0,0 +1,16 @@
+# UltracartClient::GiftCertificateQuery
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Gift certificate code | [optional] 
+**email** | **String** | Email address of this gift certificate | [optional] 
+**expiration_dts_end** | **String** | Expiration date end | [optional] 
+**expiration_dts_start** | **String** | Expiration date start | [optional] 
+**original_balance_end** | **Float** | Original balance end | [optional] 
+**original_balance_start** | **Float** | Original balance start | [optional] 
+**reference_order_id** | **String** | Gift certificate reference order id | [optional] 
+**remaining_balance_end** | **Float** | Remaining balance end | [optional] 
+**remaining_balance_start** | **Float** | Remaining balance start | [optional] 
+
+

data/docs/GiftCertificateResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::GiftCertificateResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**gift_certificate** | [**GiftCertificate**](GiftCertificate.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

data/docs/GiftCertificatesResponse.md

@@ -0,0 +1,12 @@
+# UltracartClient::GiftCertificatesResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**gift_certificates** | [**Array<GiftCertificate>**](GiftCertificate.md) |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **BOOLEAN** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+