Module: HelloextendApiClient

Defined in:
lib/helloextend_api_client/version.rb,
lib/helloextend_api_client.rb,
lib/helloextend_api_client/api_error.rb,
lib/helloextend_api_client/api_client.rb,
lib/helloextend_api_client/models/plan.rb,
lib/helloextend_api_client/models/error.rb,
lib/helloextend_api_client/models/offer.rb,
lib/helloextend_api_client/api/plans_api.rb,
lib/helloextend_api_client/configuration.rb,
lib/helloextend_api_client/models/amount.rb,
lib/helloextend_api_client/api/offers_api.rb,
lib/helloextend_api_client/models/address.rb,
lib/helloextend_api_client/models/invoice.rb,
lib/helloextend_api_client/models/product.rb,
lib/helloextend_api_client/models/contract.rb,
lib/helloextend_api_client/models/customer.rb,
lib/helloextend_api_client/api/products_api.rb,
lib/helloextend_api_client/api/contracts_api.rb,
lib/helloextend_api_client/models/offer_plan.rb,
lib/helloextend_api_client/models/plans_list.rb,
lib/helloextend_api_client/models/plan_prices.rb,
lib/helloextend_api_client/models/plan_details.rb,
lib/helloextend_api_client/models/contract_plan.rb,
lib/helloextend_api_client/models/invoice_items.rb,
lib/helloextend_api_client/models/invoice_payee.rb,
lib/helloextend_api_client/models/invoice_payer.rb,
lib/helloextend_api_client/models/invoice_details.rb,
lib/helloextend_api_client/models/contract_product.rb,
lib/helloextend_api_client/models/invoice_discount.rb,
lib/helloextend_api_client/models/invoice_metadata.rb,
lib/helloextend_api_client/models/offer_plan_contract.rb,
lib/helloextend_api_client/models/product_identifiers.rb,
lib/helloextend_api_client/models/product_mfr_warranty.rb,
lib/helloextend_api_client/models/invoice_metadata_product.rb

Overview

#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]([email protected]). 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=‘[email protected]’>Contact us!</a> We love to help!</p></div>

The version of the OpenAPI document: Default

Generated by: openapi-generator.tech OpenAPI Generator version: 4.3.1-SNAPSHOT

Defined Under Namespace

Classes: Address, Amount, ApiClient, ApiError, Configuration, Contract, ContractPlan, ContractProduct, ContractsApi, Customer, Error, Invoice, InvoiceDetails, InvoiceDiscount, InvoiceItems, InvoiceMetadata, InvoiceMetadataProduct, InvoicePayee, InvoicePayer, Offer, OfferPlan, OfferPlanContract, OffersApi, Plan, PlanDetails, PlanPrices, PlansApi, PlansList, Product, ProductIdentifiers, ProductMfrWarranty, ProductsApi

Constant Summary collapse

VERSION = 
'1.0.3'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

HelloextendApiClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



60
61
62
63
64
65
66
 
# File 'lib/helloextend_api_client.rb', line 60

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end