helloextend_api_client 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 755034bcf174711deda51894028b01db245e579d1f2603fe3406b891df492520
+  data.tar.gz: e103fae0a49247a16146e8230eb501af87d8943727acbecd4f66ed9e4d6c5347
+SHA512:
+  metadata.gz: 2670f4a176b26460b4cfc06e5230882ed1680b270e8498195229c1513f3a58a12a8555286534894e29a16069c7e10cf21760888a5d86d9605a7a70ab578e83c4
+  data.tar.gz: 785112f5542af7da5aae9342851c12746fdfd98fab52499098f833af30147f7db680d0427b01ce554d2cc90f445046169f352c9e9fb8fef0e061d130cf40377a

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/README.md

@@ -0,0 +1,151 @@
+# helloextend_api_client
+
+HelloextendApiClient - the Ruby gem for the Extend API Reference
+
+# Introduction
+Welcome to the Extend API Documentation! Our goal is to make your integration as clear and easy as possible, so if you have feedback or suggestions for our API or reference docs, [please let us know](mailto:devs@helloextend.com).
+
+  If you are implementing the API for the first time, please use the latest \"2019-08-01\" API version. If you have already implemented the API and haven't specified a version, you are on the \"Default\" API version.
+
+ #### You can get up and running with Extend with just 5 simple steps:
+
+*   Create an account with Extend, and get an access token from your Extend merchant portal
+
+*   Sync your store's products to Extend
+*   Get the relevant Extend warranty SKUs and add them to your store
+
+*   Add the JS SDK snippets to your store's website, which will enable warranty offers to be displayed in your store
+
+*   Record warranty purchases with Extend so we can create a new contract and deliver it to the customer, or record warranty returns / refunds so we can cancel the contract and account for the refunded amount
+ <div class='wrapper tip'><h2>Pro Tip! Keep your store's products up to date</h2><p>To make sure you are selling warranty plans on all eligible products (and not selling them on ineligible ones), it is best to keep your store's products in sync with Extend. If you update your products infrequently, it might be easiest to manually upload or edit products in your merchant portal. If you do update frequently, though, consider integrating with our Products API resource.</p><p>Need help? <a href='mailto:devs@helloextend.com'>Contact us!</a> We love to help!</p></div>
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: Default
+- Package version: 1.0.2
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build helloextend_api_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./helloextend_api_client-1.0.2.gem
+```
+
+(for development, run `gem install --dev ./helloextend_api_client-1.0.2.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 'helloextend_api_client', '~> 1.0.2'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'helloextend_api_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```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::ContractsApi.new
+store_id = 'c57ed096-24ef-49a4-a20a-d1b8bf770980' # String | Unique identifier for a Store on Extend
+contract_id = 'cc957cb3-3d5d-430b-90a2-9ec96ee4c3cf' # String | Unique identifier for an Extend warranty Contract
+
+begin
+  #Get invoice information for a contract
+  result = api_instance.contract_invoice(store_id, contract_id)
+  p result
+rescue HelloextendApiClient::ApiError => e
+  puts "Exception when calling ContractsApi->contract_invoice: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api-demo.helloextend.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*HelloextendApiClient::ContractsApi* | [**contract_invoice**](docs/ContractsApi.md#contract_invoice) | **GET** /stores/{storeId}/contracts/{contractId}/invoice | Get invoice information for a contract
+*HelloextendApiClient::ContractsApi* | [**create_contracts**](docs/ContractsApi.md#create_contracts) | **POST** /stores/{storeId}/contracts | Create a warranty contract
+*HelloextendApiClient::ContractsApi* | [**refund_contract**](docs/ContractsApi.md#refund_contract) | **POST** /stores/{storeId}/contracts/{contractId}/refund | Cancel a warranty contract and request a refund
+*HelloextendApiClient::OffersApi* | [**get_offer**](docs/OffersApi.md#get_offer) | **GET** /offers?storeId&#x3D;{storeId}&amp;productId&#x3D;{productId} | Get Offer information
+*HelloextendApiClient::PlansApi* | [**offers_liststore_idstore_id_get**](docs/PlansApi.md#offers_liststore_idstore_id_get) | **GET** /offers/list?storeId&#x3D;{storeId} | A list of warranty plans available to the store
+*HelloextendApiClient::ProductsApi* | [**stores_store_id_products_post**](docs/ProductsApi.md#stores_store_id_products_post) | **POST** /stores/{storeId}/products | Create a product
+*HelloextendApiClient::ProductsApi* | [**stores_store_id_products_product_id_delete**](docs/ProductsApi.md#stores_store_id_products_product_id_delete) | **DELETE** /stores/{storeId}/products/{productId} | Delete a product
+*HelloextendApiClient::ProductsApi* | [**stores_store_id_products_product_id_get**](docs/ProductsApi.md#stores_store_id_products_product_id_get) | **GET** /stores/{storeId}/products/{productId} | Get a product
+*HelloextendApiClient::ProductsApi* | [**stores_store_id_products_product_id_put**](docs/ProductsApi.md#stores_store_id_products_product_id_put) | **PUT** /stores/{storeId}/products/{productId} | Update a product
+
+
+## Documentation for Models
+
+ - [HelloextendApiClient::Address](docs/Address.md)
+ - [HelloextendApiClient::Amount](docs/Amount.md)
+ - [HelloextendApiClient::Contract](docs/Contract.md)
+ - [HelloextendApiClient::ContractPlan](docs/ContractPlan.md)
+ - [HelloextendApiClient::ContractProduct](docs/ContractProduct.md)
+ - [HelloextendApiClient::Customer](docs/Customer.md)
+ - [HelloextendApiClient::Error](docs/Error.md)
+ - [HelloextendApiClient::Invoice](docs/Invoice.md)
+ - [HelloextendApiClient::InvoiceDetails](docs/InvoiceDetails.md)
+ - [HelloextendApiClient::InvoiceDiscount](docs/InvoiceDiscount.md)
+ - [HelloextendApiClient::InvoiceItems](docs/InvoiceItems.md)
+ - [HelloextendApiClient::InvoiceMetadata](docs/InvoiceMetadata.md)
+ - [HelloextendApiClient::InvoiceMetadataProduct](docs/InvoiceMetadataProduct.md)
+ - [HelloextendApiClient::InvoicePayee](docs/InvoicePayee.md)
+ - [HelloextendApiClient::InvoicePayer](docs/InvoicePayer.md)
+ - [HelloextendApiClient::Offer](docs/Offer.md)
+ - [HelloextendApiClient::OfferPlan](docs/OfferPlan.md)
+ - [HelloextendApiClient::OfferPlanContract](docs/OfferPlanContract.md)
+ - [HelloextendApiClient::Plan](docs/Plan.md)
+ - [HelloextendApiClient::PlanDetails](docs/PlanDetails.md)
+ - [HelloextendApiClient::PlanPrices](docs/PlanPrices.md)
+ - [HelloextendApiClient::PlansList](docs/PlansList.md)
+ - [HelloextendApiClient::Product](docs/Product.md)
+ - [HelloextendApiClient::ProductIdentifiers](docs/ProductIdentifiers.md)
+ - [HelloextendApiClient::ProductMfrWarranty](docs/ProductMfrWarranty.md)
+
+
+## Documentation for Authorization
+
+
+### ExtendAccessToken
+
+
+- **Type**: API key
+- **API key parameter name**: X-Extend-Access-Token
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Address.md

@@ -0,0 +1,27 @@
+# HelloextendApiClient::Address
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**address1** | **String** |  | 
+**address2** | **String** |  | [optional] 
+**city** | **String** |  | [optional] 
+**country_code** | **String** | This is an ISO 3166 formatted country code. See <a href='https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes for examples'>https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes for examples</a> for more information | [optional] 
+**postal_code** | **String** |  | [optional] 
+**province_code** | **String** | This is an ISO 3166-2 formatted region. See <a href='https://en.wikipedia.org/wiki/ISO_3166-2'>https://en.wikipedia.org/wiki/ISO_3166-2</a> for more information | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::Address.new(address1: 535 Mission Street,
+                                 address2: 11th Floor,
+                                 city: San Francisco,
+                                 country_code: USA,
+                                 postal_code: 94526,
+                                 province_code: CA)
+```
+
+

data/docs/Amount.md

@@ -0,0 +1,19 @@
+# HelloextendApiClient::Amount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency_code** | **String** | This is an ISO-4217 currency code. See <a href='https://en.wikipedia.org/wiki/ISO_4217'>https://en.wikipedia.org/wiki/ISO_4217</a> for more information | [optional] 
+**amount** | **Float** | Amount, in cents, eg $19.99 would be 1999 | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::Amount.new(currency_code: USD,
+                                 amount: 1999)
+```
+
+

data/docs/Contract.md

@@ -0,0 +1,39 @@
+# HelloextendApiClient::Contract
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique Extend ID for the warranty contract. Use this for reference when recording returns / refunds. | [optional] [readonly] 
+**created_at** | **Float** | The timestamp when the object was created (internal). | [optional] [readonly] 
+**updated_at** | **Float** | The timestamp when the object was updated (internal). | [optional] [readonly] 
+**transaction_id** | **String** | Your store's unique transaction identifier, which may be used to query for transactions in the future | 
+**po_number** | **String** | An optional merchant generated purchase order number used for reconciliation | [optional] 
+**transaction_total** | **Integer** | The total sale transaction amount, in the base unit (i.e. cents) with no currency code. This will help us more easily find transactions and associated warranty contracts during the claims process. | [optional] 
+**customer** | [**Customer**](Customer.md) |  | 
+**product** | [**ContractProduct**](ContractProduct.md) |  | 
+**currency** | **String** | This is an ISO-4217 currency code. See <a href='https://en.wikipedia.org/wiki/ISO_4217'>https://en.wikipedia.org/wiki/ISO_4217</a> for more information | 
+**transaction_date** | **Float** | The sale transaction date. The warranty contract term is based on this date. This is the epoch time as an integer. | 
+**plan** | [**ContractPlan**](ContractPlan.md) |  | 
+**status** | **String** | The current status of the contract. When requesting a refund, this will have a different value. | [optional] [readonly] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::Contract.new(id: cc957cb3-3d5d-430b-90a2-9ec96ee4c3cf,
+                                 created_at: 1557267465,
+                                 updated_at: 1557267556,
+                                 transaction_id: 99999999,
+                                 po_number: ABC-123,
+                                 transaction_total: 14999,
+                                 customer: null,
+                                 product: null,
+                                 currency: USD,
+                                 transaction_date: 1563388069,
+                                 plan: null,
+                                 status: null)
+```
+
+

data/docs/ContractPlan.md

@@ -0,0 +1,19 @@
+# HelloextendApiClient::ContractPlan
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**purchase_price** | **Float** | Price paid for the plan at time of sale. Please ensure this is the same price that was listed on the offer or this request might be rejected. | 
+**plan_id** | **String** | The plan id being purchased. This is provided in the sdk as well as being visible per product once the product has been approved as warrantable. | 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::ContractPlan.new(purchase_price: 499,
+                                 plan_id: 10001-misc-elec-adh-replace-1y)
+```
+
+

data/docs/ContractProduct.md

@@ -0,0 +1,27 @@
+# HelloextendApiClient::ContractProduct
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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. | 
+**purchase_price** | **Integer** | The price paid for the product, in the base unit (i.e. cents) with no currency code. If this amount was lower than the retail price, Extend will assume the price was discounted. | 
+**manufacturer_warranty_length** | **Integer** | The duration of the product's manufacturer warranty as a numer of months. | [optional] [readonly] 
+**manufacturer_warranty_length_parts** | **Integer** | The manufacturer warranty length parts. | [optional] [readonly] 
+**manufacturer_warranty_length_labor** | **Integer** | The manufacturer warranty length labor. | [optional] [readonly] 
+**serial_number** | **String** | The serial number of the product. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::ContractProduct.new(reference_id: SKU-123-456,
+                                 purchase_price: 14999,
+                                 manufacturer_warranty_length: 12,
+                                 manufacturer_warranty_length_parts: 123456,
+                                 manufacturer_warranty_length_labor: 123456,
+                                 serial_number: ABCD123456)
+```
+
+

data/docs/ContractsApi.md

@@ -0,0 +1,180 @@
+# HelloextendApiClient::ContractsApi
+
+All URIs are relative to *https://api-demo.helloextend.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**contract_invoice**](ContractsApi.md#contract_invoice) | **GET** /stores/{storeId}/contracts/{contractId}/invoice | Get invoice information for a contract
+[**create_contracts**](ContractsApi.md#create_contracts) | **POST** /stores/{storeId}/contracts | Create a warranty contract
+[**refund_contract**](ContractsApi.md#refund_contract) | **POST** /stores/{storeId}/contracts/{contractId}/refund | Cancel a warranty contract and request a refund
+
+
+
+## contract_invoice
+
+> Invoice contract_invoice(store_id, contract_id)
+
+Get invoice information for a contract
+
+Extend automatically generates an invoice to the merchant whenever a warranty contract is sold.  If it helps with your record-keeping and back end reconciliation, you can get the invoice details using this API call.  If you sent us a purchase order number when making the 'Create a warranty contract' call, we'll include that in the invoice, too, for your reference.
+
+### 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::ContractsApi.new
+store_id = 'c57ed096-24ef-49a4-a20a-d1b8bf770980' # String | Unique identifier for a Store on Extend
+contract_id = 'cc957cb3-3d5d-430b-90a2-9ec96ee4c3cf' # String | Unique identifier for an Extend warranty Contract
+
+begin
+  #Get invoice information for a contract
+  result = api_instance.contract_invoice(store_id, contract_id)
+  p result
+rescue HelloextendApiClient::ApiError => e
+  puts "Exception when calling ContractsApi->contract_invoice: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **store_id** | [**String**](.md)| Unique identifier for a Store on Extend | 
+ **contract_id** | [**String**](.md)| Unique identifier for an Extend warranty Contract | 
+
+### Return type
+
+[**Invoice**](Invoice.md)
+
+### Authorization
+
+[ExtendAccessToken](../README.md#ExtendAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## create_contracts
+
+> Contract create_contracts(store_id, contract)
+
+Create a warranty contract
+
+### 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::ContractsApi.new
+store_id = 'c57ed096-24ef-49a4-a20a-d1b8bf770980' # String | Unique identifier for a Store on Extend
+contract = HelloextendApiClient::Contract.new # Contract | 
+
+begin
+  #Create a warranty contract
+  result = api_instance.create_contracts(store_id, contract)
+  p result
+rescue HelloextendApiClient::ApiError => e
+  puts "Exception when calling ContractsApi->create_contracts: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **store_id** | [**String**](.md)| Unique identifier for a Store on Extend | 
+ **contract** | [**Contract**](Contract.md)|  | 
+
+### Return type
+
+[**Contract**](Contract.md)
+
+### Authorization
+
+[ExtendAccessToken](../README.md#ExtendAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## refund_contract
+
+> refund_contract(store_id, contract_id, opts)
+
+Cancel a warranty contract and request a refund
+
+This endpoint is your way to report a refunded warranty contract to Extend. If a customer returns an item for which a warranty was purchased, or just the warranty itself, to your store, you should let Extend know so we can cancel the warranty contract. We will also refund you, the merchant, in the next invoice. The amount Extend will refund you (and the amount you should refund to the customer), depends on the date of the refund and the terms of the warranty contract. <div class='wrapper tip'><h2>Pro Tip! Check the refund amount before you refund your customer</h2>  To make sure you refund your customer the same amount as Extend will be refunding you, there is a three-step process:  <ul><li>Send the cancellation API request to Extend with query parameter \"commit\" set to FALSE. This gives you a preview of the cancellation, Including the amount that would be refunded (the \"cancellation quote\") </li><li>Issue a refund to the customer for the amount matching the cancellation quote</li><li>Re-send the cancellation API request to Extend with query parameter \"commit\" set to TRUE. This will cause Extend to cancel the contract and issue the merchant refund for the amount matching the cancellation quote</li></ul></div><div class='wrapper important'><h2>Important:</h2>  Please note that this endpoint <strong>does not cause Extend to refund the customer</strong> - they would get the refund from the store where they purchased the product and warranty contract. A successful call to this endpoint <strong>will void the customer’s warranty contract</strong>, and initiate reimbursement to you, the merchant.</div>
+
+### 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::ContractsApi.new
+store_id = 'c57ed096-24ef-49a4-a20a-d1b8bf770980' # String | Unique identifier for a Store on Extend
+contract_id = 'cc957cb3-3d5d-430b-90a2-9ec96ee4c3cf' # String | Unique identifier for an Extend warranty Contract
+opts = {
+  commit: true # Boolean | Use the value <strong>\"false\"</strong> to get a preview of the cancellation quote - the amount you will be refunded for the cancelled contract. If you use the value <strong>\"true\"</strong> or omit the query parameter, Extend will execute the contract cancellation.
+}
+
+begin
+  #Cancel a warranty contract and request a refund
+  api_instance.refund_contract(store_id, contract_id, opts)
+rescue HelloextendApiClient::ApiError => e
+  puts "Exception when calling ContractsApi->refund_contract: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **store_id** | [**String**](.md)| Unique identifier for a Store on Extend | 
+ **contract_id** | [**String**](.md)| Unique identifier for an Extend warranty Contract | 
+ **commit** | **Boolean**| Use the value &lt;strong&gt;\&quot;false\&quot;&lt;/strong&gt; to get a preview of the cancellation quote - the amount you will be refunded for the cancelled contract. If you use the value &lt;strong&gt;\&quot;true\&quot;&lt;/strong&gt; or omit the query parameter, Extend will execute the contract cancellation. | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ExtendAccessToken](../README.md#ExtendAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+