helloextend_api_client 1.0.2

data/docs/Customer.md

@@ -0,0 +1,23 @@
+# HelloextendApiClient::Customer
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**phone** | **String** |  | [optional] 
+**email** | **String** | While you can create a contract without passing an email address, we <b>strongly</b> recommend that you require and include the customer’s email address for every transaction including an extended warranty purchase.  Extend needs to be able to email the customer their warranty contract information and terms, and to be able to communicate with the customer throughout the life of the protection plan. | 
+**name** | **String** |  | 
+**address** | [**Address**](Address.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::Customer.new(phone: 123-456-7890,
+                                 email: BobRoss@gmail.com,
+                                 name: Bob Ross,
+                                 address: null)
+```
+
+

data/docs/Error.md

@@ -0,0 +1,19 @@
+# HelloextendApiClient::Error
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** |  | 
+**message** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::Error.new(code: null,
+                                 message: null)
+```
+
+

data/docs/Invoice.md

@@ -0,0 +1,27 @@
+# HelloextendApiClient::Invoice
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The invoice id, which is exactly the same as the corresponding contract id. | [optional] [readonly] 
+**details** | [**InvoiceDetails**](InvoiceDetails.md) |  | [optional] 
+**payee** | [**InvoicePayee**](InvoicePayee.md) |  | [optional] 
+**payer** | [**InvoicePayer**](InvoicePayer.md) |  | [optional] 
+**items** | [**Array<InvoiceItems>**](InvoiceItems.md) |  | [optional] 
+**total_amount_due** | [**Amount**](Amount.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::Invoice.new(id: cc957cb3-3d5d-430b-90a2-9ec96ee4c3cf,
+                                 details: null,
+                                 payee: null,
+                                 payer: null,
+                                 items: null,
+                                 total_amount_due: null)
+```
+
+

data/docs/InvoiceDetails.md

@@ -0,0 +1,19 @@
+# HelloextendApiClient::InvoiceDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**store_id** | **String** |  | [optional] 
+**invoice_date** | **DateTime** | A Date-Time stamp in ISO 8601 format (UTC) | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::InvoiceDetails.new(store_id: b1b2b3b5-3d5d-430b-90a2-9ec96ee4c3cf,
+                                 invoice_date: 2019-07-09T23:56Z)
+```
+
+

data/docs/InvoiceDiscount.md

@@ -0,0 +1,21 @@
+# HelloextendApiClient::InvoiceDiscount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**percent** | **Float** |  | [optional] 
+**label** | **String** |  | [optional] [default to 'Merchant revenue share']
+**amount** | [**Amount**](Amount.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::InvoiceDiscount.new(percent: 25,
+                                 label: null,
+                                 amount: null)
+```
+
+

data/docs/InvoiceItems.md

@@ -0,0 +1,31 @@
+# HelloextendApiClient::InvoiceItems
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** |  | [optional] 
+**transaction_date** | **DateTime** | A Date-Time stamp in ISO 8601 format (UTC) | [optional] [readonly] 
+**retail_price** | [**Amount**](Amount.md) |  | [optional] 
+**unit_price** | [**Amount**](Amount.md) |  | [optional] 
+**line_total** | [**Amount**](Amount.md) |  | [optional] 
+**quantity** | **Float** | Number of contracts sold (always 1) | [optional] 
+**discount** | [**InvoiceDiscount**](InvoiceDiscount.md) |  | [optional] 
+**metadata** | [**InvoiceMetadata**](InvoiceMetadata.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::InvoiceItems.new(title: Extend Protection Plan - AV Receiver,
+                                 transaction_date: 2019-07-09T23:56Z,
+                                 retail_price: null,
+                                 unit_price: null,
+                                 line_total: null,
+                                 quantity: 1,
+                                 discount: null,
+                                 metadata: null)
+```
+
+

data/docs/InvoiceMetadata.md

@@ -0,0 +1,21 @@
+# HelloextendApiClient::InvoiceMetadata
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**order_reference_id** | **String** | An optional purchase Order number referenced in the original contract | [optional] 
+**plan_id** | **String** | The plan that the contract applied to | [optional] 
+**product** | [**InvoiceMetadataProduct**](InvoiceMetadataProduct.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::InvoiceMetadata.new(order_reference_id: PO-12345,
+                                 plan_id: 10001-auto-part-base-replace-1y,
+                                 product: null)
+```
+
+

data/docs/InvoiceMetadataProduct.md

@@ -0,0 +1,21 @@
+# HelloextendApiClient::InvoiceMetadataProduct
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**reference_id** | **String** | The store-specific unique reference identifier for the product that the warranty plan is connected to. In other words, if the customer is buying a TV and a warranty plan for the TV, this would be the ID for the TV. Example ID types: a product SKU, variant ID, GTIN, or any other unique identifier you use in your store. Please see the documentation for <a href='/#tag/Store'>'Create a product'</a> for more information | [optional] 
+**price** | [**Amount**](Amount.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::InvoiceMetadataProduct.new(name: Xbox One X 1TB console,
+                                 reference_id: SKU-123-456,
+                                 price: null)
+```
+
+

data/docs/InvoicePayee.md

@@ -0,0 +1,23 @@
+# HelloextendApiClient::InvoicePayee
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**address** | [**Address**](Address.md) |  | [optional] 
+**email** | **String** |  | [optional] 
+**phone** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::InvoicePayee.new(name: Extend, Inc,
+                                 address: null,
+                                 email: billing@helloextend.com,
+                                 phone: 555-555-5555)
+```
+
+

data/docs/InvoicePayer.md

@@ -0,0 +1,23 @@
+# HelloextendApiClient::InvoicePayer
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**address** | [**Address**](Address.md) |  | [optional] 
+**email** | **String** |  | [optional] 
+**phone** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::InvoicePayer.new(name: ABC Televisions,
+                                 address: null,
+                                 email: sales@abctelevisions.com,
+                                 phone: 555-555-5555)
+```
+
+

data/docs/Offer.md

@@ -0,0 +1,17 @@
+# HelloextendApiClient::Offer
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**plans** | [**Array<OfferPlan>**](OfferPlan.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::Offer.new(plans: null)
+```
+
+

data/docs/OfferPlan.md

@@ -0,0 +1,23 @@
+# HelloextendApiClient::OfferPlan
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier for a warranty Plan | [optional] 
+**price** | **Float** | The offer price, in base units | [optional] 
+**contract** | [**OfferPlanContract**](OfferPlanContract.md) |  | [optional] 
+**url** | **String** | A link to the extended warranty plan terms and information.  Any offer display must include a “Learn More” or “See Plan Details” call-to-action that enables the customer to see exactly what the warranty plan covers | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::OfferPlan.new(id: AmazingAppliancePlan,
+                                 price: 199,
+                                 contract: null,
+                                 url: null)
+```
+
+

data/docs/OfferPlanContract.md

@@ -0,0 +1,27 @@
+# HelloextendApiClient::OfferPlanContract
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**coverage_starts** | **String** | Describes when the contract term begins, relative to the manufacturer’s warranty length.  For example, “immediate” means coverage starts immediately on the purchase date, and “after” means coverage starts after the manufacturer’s warranty has expired | [optional] 
+**coverage_includes** | **String** | Possible values include “base”, which means the extended warranty is a base plan covering mechanical and electrical failures through normal use, or “adh”, which means the plan includes coverage for accidental damage (i.e. “Accidental Damage in Handling”) | [optional] 
+**service_type** | **String** | This is the claims resolution service the plan includes.  Responses include “replacement” (the damaged item is replaced by a new or refurbished equivalent), “repair_depot” (the customer mails the damaged item to a repair facility), or “repair_onsite” (a repair technician goes out to the customer’s home to repair the item) | [optional] 
+**replacement_type** | **String** | Indicates whether the damaged item will be replaced by a “new” or “refurbished” item | [optional] 
+**deductible** | **Float** | The amount of the deductible charged to the customer during a claim, if there is one.  For most Extend protection plans, there is no deductible | [optional] 
+**term_length** | **Float** | The length of the extended warranty coverage, in months | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::OfferPlanContract.new(coverage_starts: immediate,
+                                 coverage_includes: adh,
+                                 service_type: replace,
+                                 replacement_type: new,
+                                 deductible: 0,
+                                 term_length: 36)
+```
+
+

data/docs/OffersApi.md

@@ -0,0 +1,58 @@
+# HelloextendApiClient::OffersApi
+
+All URIs are relative to *https://api-demo.helloextend.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_offer**](OffersApi.md#get_offer) | **GET** /offers?storeId={storeId}&productId={productId} | Get Offer information
+
+
+
+## get_offer
+
+> Offer get_offer(store_id, product_id)
+
+Get Offer information
+
+Returns warranty plans and pricing for a specific product. 
+
+### Example
+
+```ruby
+# load the gem
+require 'helloextend_api_client'
+
+api_instance = HelloextendApiClient::OffersApi.new
+store_id = 'c57ed096-24ef-49a4-a20a-d1b8bf770980' # String | Unique identifier for a Store on Extend
+product_id = 'product_id_example' # String | The unique referenceId passed to extend when creating a product.
+
+begin
+  #Get Offer information
+  result = api_instance.get_offer(store_id, product_id)
+  p result
+rescue HelloextendApiClient::ApiError => e
+  puts "Exception when calling OffersApi->get_offer: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **store_id** | [**String**](.md)| Unique identifier for a Store on Extend | 
+ **product_id** | [**String**](.md)| The unique referenceId passed to extend when creating a product. | 
+
+### Return type
+
+[**Offer**](Offer.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Plan.md

@@ -0,0 +1,21 @@
+# HelloextendApiClient::Plan
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique identifier for a warranty Plan | [optional] 
+**details** | [**PlanDetails**](PlanDetails.md) |  | [optional] 
+**prices** | [**PlanPrices**](PlanPrices.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::Plan.new(id: AmazingAppliancePlan,
+                                 details: null,
+                                 prices: null)
+```
+
+

data/docs/PlanDetails.md

@@ -0,0 +1,21 @@
+# HelloextendApiClient::PlanDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** | The name of the warranty plan. Use this in the product title for the warranty plan SKU(s) in your store | [optional] 
+**image_url** | **String** | The imageUrl for the warranty plan. Use this as the product image for the warranty plan SKU(s) in your store | [optional] 
+**term_length** | **Float** | The length of the extended warranty coverage, in months | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::PlanDetails.new(title: An amazing Appliance Plan,
+                                 image_url: null,
+                                 term_length: 36)
+```
+
+

data/docs/PlanPrices.md

@@ -0,0 +1,21 @@
+# HelloextendApiClient::PlanPrices
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**min** | **Integer** | The minimum price allowed for the warranty plan offered, in the base unit (i.e. cents) with no currency code | [optional] 
+**max** | **Integer** | The maximum price for the warranty plan offered, in the base unit (i.e. cents) with no currency code | [optional] 
+**points** | **Array<Integer>** | A list of all possible rounded price points at which the warranty plan could be offered. If your system does not allow dynamic pricing on the product page and in the cart, then create a seperate warranty plan SKU for each price point | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::PlanPrices.new(min: 99,
+                                 max: 1099,
+                                 points: [99,399,799,1099])
+```
+
+

data/docs/PlansApi.md

@@ -0,0 +1,61 @@
+# HelloextendApiClient::PlansApi
+
+All URIs are relative to *https://api-demo.helloextend.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**offers_liststore_idstore_id_get**](PlansApi.md#offers_liststore_idstore_id_get) | **GET** /offers/list?storeId={storeId} | A list of warranty plans available to the store
+
+
+
+## offers_liststore_idstore_id_get
+
+> PlansList offers_liststore_idstore_id_get(store_id)
+
+A list of warranty plans available to the store
+
+### Example
+
+```ruby
+# load the gem
+require 'helloextend_api_client'
+# setup authorization
+HelloextendApiClient.configure do |config|
+  # Configure API key authorization: ExtendAccessToken
+  config.api_key['X-Extend-Access-Token'] = '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-Extend-Access-Token'] = 'Bearer'
+end
+
+api_instance = HelloextendApiClient::PlansApi.new
+store_id = 'c57ed096-24ef-49a4-a20a-d1b8bf770980' # String | Unique identifier for a Store on Extend
+
+begin
+  #A list of warranty plans available to the store
+  result = api_instance.offers_liststore_idstore_id_get(store_id)
+  p result
+rescue HelloextendApiClient::ApiError => e
+  puts "Exception when calling PlansApi->offers_liststore_idstore_id_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **store_id** | [**String**](.md)| Unique identifier for a Store on Extend | 
+
+### Return type
+
+[**PlansList**](PlansList.md)
+
+### Authorization
+
+[ExtendAccessToken](../README.md#ExtendAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+