helloextend_api_client 1.0.2

data/docs/PlansList.md

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

data/docs/Product.md

@@ -0,0 +1,45 @@
+# HelloextendApiClient::Product
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**brand** | **String** | Product Brand, Manufacturer or Vendor | [optional] 
+**category** | **String** | Product category. Can be any value and may be used by Extend to map the product to warranty plans. | [optional] 
+**created_at** | **Float** | The timestamp when the object was created (internal) | [optional] [readonly] 
+**description** | **String** | Product description | [optional] 
+**enabled** | **Boolean** | Enable/disable selling of warranties on this product | [optional] 
+**image_url** | **String** | A url pointing to the primary image for the product | [optional] 
+**mfr_warranty** | [**ProductMfrWarranty**](ProductMfrWarranty.md) |  | [optional] 
+**price** | **Float** | The base retail price of the product (in cents) | 
+**title** | **String** | Product name | 
+**updated_at** | **Float** | The timestamp when the object was last updated (internal) | [optional] [readonly] 
+**status** | **String** |  | [optional] [readonly] 
+**reference_id** | **String** | This is the unique identifier that identifies the product. This can be a product SKU, or variant id.  | 
+**parent_reference_id** | **String** | This is the id of the parent product, if there is one. This allows nesting of a single parent product with multiple variants (such as multiple color options for the same product) | [optional] 
+**plans** | **Array<String>** | A list of all extended warranty plans for which the product is eligible, listed by planId.  The Offers SDK or Offers API will provide more detail about which plan options to display for a given product at a given time. | [optional] 
+**identifiers** | [**ProductIdentifiers**](ProductIdentifiers.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::Product.new(brand: ACME,
+                                 category: sports,
+                                 created_at: 1557267465,
+                                 description: One Dozen. Tickle your friends! Suprise your opponent!,
+                                 enabled: true,
+                                 image_url: https://bit.ly/2VN88Jf,
+                                 mfr_warranty: null,
+                                 price: 2599,
+                                 title: Explosive Tennis Balls,
+                                 updated_at: 1557267465,
+                                 status: new,
+                                 reference_id: 2324f800-7575-4c65-bd2c-588c89e8ab7f,
+                                 parent_reference_id: 2324f800-7575-4c65-bd2c-588c89e8ab7f,
+                                 plans: null,
+                                 identifiers: null)
+```
+
+

data/docs/ProductIdentifiers.md

@@ -0,0 +1,25 @@
+# HelloextendApiClient::ProductIdentifiers
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **String** | A unique identifier for the product that is specific to your store | [optional] 
+**gtin** | **String** | <p>Global Trade Item Number (GTIN) - A unique identifier for trade items, developed by GS1. <a href='https://www.gs1.org/standards/id-keys/gtin'>Learn more here</a></p> | [optional] 
+**upc** | **String** | The Universal Product Code (UPC) barcode | [optional] 
+**asin** | **String** | The Amazon Standard Identification Number (ASIN) | [optional] 
+**barcode** | **String** | The product's barcode. Non-Standard | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::ProductIdentifiers.new(sku: KS944RUR,
+                                 gtin: 012345678901234,
+                                 upc: 0123456789012,
+                                 asin: 0123456789,
+                                 barcode: 123)
+```
+
+

data/docs/ProductMfrWarranty.md

@@ -0,0 +1,21 @@
+# HelloextendApiClient::ProductMfrWarranty
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**parts** | **Float** | Length of the manufacturers warranty for parts in months. | [optional] 
+**labor** | **Float** | Length of the manufacturers warranty for labor in months. | [optional] 
+**url** | **String** | Link to the manufacturers warranty for this product. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'HelloextendApiClient'
+
+instance = HelloextendApiClient::ProductMfrWarranty.new(parts: 12,
+                                 labor: 12,
+                                 url: http://example.com)
+```
+
+

data/docs/ProductsApi.md

@@ -0,0 +1,241 @@
+# HelloextendApiClient::ProductsApi
+
+All URIs are relative to *https://api-demo.helloextend.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**stores_store_id_products_post**](ProductsApi.md#stores_store_id_products_post) | **POST** /stores/{storeId}/products | Create a product
+[**stores_store_id_products_product_id_delete**](ProductsApi.md#stores_store_id_products_product_id_delete) | **DELETE** /stores/{storeId}/products/{productId} | Delete a product
+[**stores_store_id_products_product_id_get**](ProductsApi.md#stores_store_id_products_product_id_get) | **GET** /stores/{storeId}/products/{productId} | Get a product
+[**stores_store_id_products_product_id_put**](ProductsApi.md#stores_store_id_products_product_id_put) | **PUT** /stores/{storeId}/products/{productId} | Update a product
+
+
+
+## stores_store_id_products_post
+
+> Product stores_store_id_products_post(store_id, opts)
+
+Create a product
+
+### 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::ProductsApi.new
+store_id = 'c57ed096-24ef-49a4-a20a-d1b8bf770980' # String | Unique identifier for a Store on Extend
+opts = {
+  batch: true, # Boolean | Use the value true if passing a batch of products.
+  upsert: true, # Boolean | If true, will update products that already exist.
+  product: HelloextendApiClient::Product.new # Product | 
+}
+
+begin
+  #Create a product
+  result = api_instance.stores_store_id_products_post(store_id, opts)
+  p result
+rescue HelloextendApiClient::ApiError => e
+  puts "Exception when calling ProductsApi->stores_store_id_products_post: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **store_id** | [**String**](.md)| Unique identifier for a Store on Extend | 
+ **batch** | **Boolean**| Use the value true if passing a batch of products. | [optional] 
+ **upsert** | **Boolean**| If true, will update products that already exist. | [optional] 
+ **product** | [**Product**](Product.md)|  | [optional] 
+
+### Return type
+
+[**Product**](Product.md)
+
+### Authorization
+
+[ExtendAccessToken](../README.md#ExtendAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## stores_store_id_products_product_id_delete
+
+> stores_store_id_products_product_id_delete(store_id, product_id)
+
+Delete a product
+
+### 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::ProductsApi.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
+  #Delete a product
+  api_instance.stores_store_id_products_product_id_delete(store_id, product_id)
+rescue HelloextendApiClient::ApiError => e
+  puts "Exception when calling ProductsApi->stores_store_id_products_product_id_delete: #{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
+
+nil (empty response body)
+
+### Authorization
+
+[ExtendAccessToken](../README.md#ExtendAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## stores_store_id_products_product_id_get
+
+> Product stores_store_id_products_product_id_get(store_id, product_id)
+
+Get a product
+
+Returns information about a product
+
+### 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::ProductsApi.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 a product
+  result = api_instance.stores_store_id_products_product_id_get(store_id, product_id)
+  p result
+rescue HelloextendApiClient::ApiError => e
+  puts "Exception when calling ProductsApi->stores_store_id_products_product_id_get: #{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
+
+[**Product**](Product.md)
+
+### Authorization
+
+[ExtendAccessToken](../README.md#ExtendAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## stores_store_id_products_product_id_put
+
+> Product stores_store_id_products_product_id_put(store_id, product_id, opts)
+
+Update a product
+
+When you update a product, you may not update the referenceId.
+
+### 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::ProductsApi.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.
+opts = {
+  unknown_base_type: HelloextendApiClient::UNKNOWN_BASE_TYPE.new # UNKNOWN_BASE_TYPE | 
+}
+
+begin
+  #Update a product
+  result = api_instance.stores_store_id_products_product_id_put(store_id, product_id, opts)
+  p result
+rescue HelloextendApiClient::ApiError => e
+  puts "Exception when calling ProductsApi->stores_store_id_products_product_id_put: #{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. | 
+ **unknown_base_type** | [**UNKNOWN_BASE_TYPE**](UNKNOWN_BASE_TYPE.md)|  | [optional] 
+
+### Return type
+
+[**Product**](Product.md)
+
+### Authorization
+
+[ExtendAccessToken](../README.md#ExtendAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/git_push.sh

@@ -0,0 +1,58 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/helloextend_api_client.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#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>
+
+The version of the OpenAPI document: Default
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1-SNAPSHOT
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "helloextend_api_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "helloextend_api_client"
+  s.version     = HelloextendApiClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Daniel Pritchett"]
+  s.email       = ["daniel@dpritchett.net"]
+  s.homepage    = "https://github.com/dpritchett/helloextend-ruby-client"
+  s.summary     = "REST API Client for the helloextend.com ecommerce warranty API"
+  s.description = "REST API Client for the helloextend.com ecommerce warranty API"
+  s.license     = 'MIT'
+  s.required_ruby_version = "~> 2.7.1"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end