helloextend_api_client 1.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +151 -0
- data/Rakefile +10 -0
- data/docs/Address.md +27 -0
- data/docs/Amount.md +19 -0
- data/docs/Contract.md +39 -0
- data/docs/ContractPlan.md +19 -0
- data/docs/ContractProduct.md +27 -0
- data/docs/ContractsApi.md +180 -0
- data/docs/Customer.md +23 -0
- data/docs/Error.md +19 -0
- data/docs/Invoice.md +27 -0
- data/docs/InvoiceDetails.md +19 -0
- data/docs/InvoiceDiscount.md +21 -0
- data/docs/InvoiceItems.md +31 -0
- data/docs/InvoiceMetadata.md +21 -0
- data/docs/InvoiceMetadataProduct.md +21 -0
- data/docs/InvoicePayee.md +23 -0
- data/docs/InvoicePayer.md +23 -0
- data/docs/Offer.md +17 -0
- data/docs/OfferPlan.md +23 -0
- data/docs/OfferPlanContract.md +27 -0
- data/docs/OffersApi.md +58 -0
- data/docs/Plan.md +21 -0
- data/docs/PlanDetails.md +21 -0
- data/docs/PlanPrices.md +21 -0
- data/docs/PlansApi.md +61 -0
- data/docs/PlansList.md +17 -0
- data/docs/Product.md +45 -0
- data/docs/ProductIdentifiers.md +25 -0
- data/docs/ProductMfrWarranty.md +21 -0
- data/docs/ProductsApi.md +241 -0
- data/git_push.sh +58 -0
- data/helloextend_api_client.gemspec +39 -0
- data/lib/helloextend_api_client.rb +68 -0
- data/lib/helloextend_api_client/api/contracts_api.rb +229 -0
- data/lib/helloextend_api_client/api/offers_api.rb +90 -0
- data/lib/helloextend_api_client/api/plans_api.rb +82 -0
- data/lib/helloextend_api_client/api/products_api.rb +298 -0
- data/lib/helloextend_api_client/api_client.rb +388 -0
- data/lib/helloextend_api_client/api_error.rb +57 -0
- data/lib/helloextend_api_client/configuration.rb +248 -0
- data/lib/helloextend_api_client/models/address.rb +259 -0
- data/lib/helloextend_api_client/models/amount.rb +217 -0
- data/lib/helloextend_api_client/models/contract.rb +378 -0
- data/lib/helloextend_api_client/models/contract_plan.rb +228 -0
- data/lib/helloextend_api_client/models/contract_product.rb +268 -0
- data/lib/helloextend_api_client/models/customer.rb +245 -0
- data/lib/helloextend_api_client/models/error.rb +225 -0
- data/lib/helloextend_api_client/models/invoice.rb +254 -0
- data/lib/helloextend_api_client/models/invoice_details.rb +216 -0
- data/lib/helloextend_api_client/models/invoice_discount.rb +226 -0
- data/lib/helloextend_api_client/models/invoice_items.rb +271 -0
- data/lib/helloextend_api_client/models/invoice_metadata.rb +226 -0
- data/lib/helloextend_api_client/models/invoice_metadata_product.rb +225 -0
- data/lib/helloextend_api_client/models/invoice_payee.rb +233 -0
- data/lib/helloextend_api_client/models/invoice_payer.rb +233 -0
- data/lib/helloextend_api_client/models/offer.rb +208 -0
- data/lib/helloextend_api_client/models/offer_plan.rb +236 -0
- data/lib/helloextend_api_client/models/offer_plan_contract.rb +258 -0
- data/lib/helloextend_api_client/models/plan.rb +225 -0
- data/lib/helloextend_api_client/models/plan_details.rb +227 -0
- data/lib/helloextend_api_client/models/plan_prices.rb +230 -0
- data/lib/helloextend_api_client/models/plans_list.rb +208 -0
- data/lib/helloextend_api_client/models/product.rb +429 -0
- data/lib/helloextend_api_client/models/product_identifiers.rb +247 -0
- data/lib/helloextend_api_client/models/product_mfr_warranty.rb +228 -0
- data/lib/helloextend_api_client/version.rb +15 -0
- data/spec/api/contracts_api_spec.rb +74 -0
- data/spec/api/offers_api_spec.rb +48 -0
- data/spec/api/plans_api_spec.rb +46 -0
- data/spec/api/products_api_spec.rb +88 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/address_spec.rb +71 -0
- data/spec/models/amount_spec.rb +47 -0
- data/spec/models/contract_plan_spec.rb +47 -0
- data/spec/models/contract_product_spec.rb +71 -0
- data/spec/models/contract_spec.rb +111 -0
- data/spec/models/customer_spec.rb +59 -0
- data/spec/models/error_spec.rb +47 -0
- data/spec/models/invoice_details_spec.rb +47 -0
- data/spec/models/invoice_discount_spec.rb +53 -0
- data/spec/models/invoice_items_spec.rb +83 -0
- data/spec/models/invoice_metadata_product_spec.rb +53 -0
- data/spec/models/invoice_metadata_spec.rb +53 -0
- data/spec/models/invoice_payee_spec.rb +59 -0
- data/spec/models/invoice_payer_spec.rb +59 -0
- data/spec/models/invoice_spec.rb +71 -0
- data/spec/models/offer_plan_contract_spec.rb +71 -0
- data/spec/models/offer_plan_spec.rb +59 -0
- data/spec/models/offer_spec.rb +41 -0
- data/spec/models/plan_details_spec.rb +53 -0
- data/spec/models/plan_prices_spec.rb +53 -0
- data/spec/models/plan_spec.rb +53 -0
- data/spec/models/plans_list_spec.rb +41 -0
- data/spec/models/product_identifiers_spec.rb +65 -0
- data/spec/models/product_mfr_warranty_spec.rb +53 -0
- data/spec/models/product_spec.rb +129 -0
- data/spec/spec_helper.rb +111 -0
- metadata +235 -0
@@ -0,0 +1,15 @@
|
|
1
|
+
=begin
|
2
|
+
#Extend API Reference
|
3
|
+
|
4
|
+
## 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>
|
5
|
+
|
6
|
+
The version of the OpenAPI document: Default
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
module HelloextendApiClient
|
14
|
+
VERSION = '1.0.2'
|
15
|
+
end
|
@@ -0,0 +1,74 @@
|
|
1
|
+
=begin
|
2
|
+
#Extend API Reference
|
3
|
+
|
4
|
+
## 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>
|
5
|
+
|
6
|
+
The version of the OpenAPI document: Default
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
|
16
|
+
# Unit tests for HelloextendApiClient::ContractsApi
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe 'ContractsApi' do
|
20
|
+
before do
|
21
|
+
# run before each test
|
22
|
+
@api_instance = HelloextendApiClient::ContractsApi.new
|
23
|
+
end
|
24
|
+
|
25
|
+
after do
|
26
|
+
# run after each test
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test an instance of ContractsApi' do
|
30
|
+
it 'should create an instance of ContractsApi' do
|
31
|
+
expect(@api_instance).to be_instance_of(HelloextendApiClient::ContractsApi)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# unit tests for contract_invoice
|
36
|
+
# Get invoice information for a contract
|
37
|
+
# 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.
|
38
|
+
# @param store_id Unique identifier for a Store on Extend
|
39
|
+
# @param contract_id Unique identifier for an Extend warranty Contract
|
40
|
+
# @param [Hash] opts the optional parameters
|
41
|
+
# @return [Invoice]
|
42
|
+
describe 'contract_invoice test' do
|
43
|
+
it 'should work' do
|
44
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
# unit tests for create_contracts
|
49
|
+
# Create a warranty contract
|
50
|
+
# @param store_id Unique identifier for a Store on Extend
|
51
|
+
# @param contract
|
52
|
+
# @param [Hash] opts the optional parameters
|
53
|
+
# @return [Contract]
|
54
|
+
describe 'create_contracts test' do
|
55
|
+
it 'should work' do
|
56
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
57
|
+
end
|
58
|
+
end
|
59
|
+
|
60
|
+
# unit tests for refund_contract
|
61
|
+
# Cancel a warranty contract and request a refund
|
62
|
+
# 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>
|
63
|
+
# @param store_id Unique identifier for a Store on Extend
|
64
|
+
# @param contract_id Unique identifier for an Extend warranty Contract
|
65
|
+
# @param [Hash] opts the optional parameters
|
66
|
+
# @option opts [Boolean] :commit 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.
|
67
|
+
# @return [nil]
|
68
|
+
describe 'refund_contract test' do
|
69
|
+
it 'should work' do
|
70
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
end
|
@@ -0,0 +1,48 @@
|
|
1
|
+
=begin
|
2
|
+
#Extend API Reference
|
3
|
+
|
4
|
+
## 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>
|
5
|
+
|
6
|
+
The version of the OpenAPI document: Default
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
|
16
|
+
# Unit tests for HelloextendApiClient::OffersApi
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe 'OffersApi' do
|
20
|
+
before do
|
21
|
+
# run before each test
|
22
|
+
@api_instance = HelloextendApiClient::OffersApi.new
|
23
|
+
end
|
24
|
+
|
25
|
+
after do
|
26
|
+
# run after each test
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test an instance of OffersApi' do
|
30
|
+
it 'should create an instance of OffersApi' do
|
31
|
+
expect(@api_instance).to be_instance_of(HelloextendApiClient::OffersApi)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# unit tests for get_offer
|
36
|
+
# Get Offer information
|
37
|
+
# Returns warranty plans and pricing for a specific product.
|
38
|
+
# @param store_id Unique identifier for a Store on Extend
|
39
|
+
# @param product_id The unique referenceId passed to extend when creating a product.
|
40
|
+
# @param [Hash] opts the optional parameters
|
41
|
+
# @return [Offer]
|
42
|
+
describe 'get_offer test' do
|
43
|
+
it 'should work' do
|
44
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
45
|
+
end
|
46
|
+
end
|
47
|
+
|
48
|
+
end
|
@@ -0,0 +1,46 @@
|
|
1
|
+
=begin
|
2
|
+
#Extend API Reference
|
3
|
+
|
4
|
+
## 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>
|
5
|
+
|
6
|
+
The version of the OpenAPI document: Default
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
|
16
|
+
# Unit tests for HelloextendApiClient::PlansApi
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe 'PlansApi' do
|
20
|
+
before do
|
21
|
+
# run before each test
|
22
|
+
@api_instance = HelloextendApiClient::PlansApi.new
|
23
|
+
end
|
24
|
+
|
25
|
+
after do
|
26
|
+
# run after each test
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test an instance of PlansApi' do
|
30
|
+
it 'should create an instance of PlansApi' do
|
31
|
+
expect(@api_instance).to be_instance_of(HelloextendApiClient::PlansApi)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# unit tests for offers_liststore_idstore_id_get
|
36
|
+
# A list of warranty plans available to the store
|
37
|
+
# @param store_id Unique identifier for a Store on Extend
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @return [PlansList]
|
40
|
+
describe 'offers_liststore_idstore_id_get test' do
|
41
|
+
it 'should work' do
|
42
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
end
|
@@ -0,0 +1,88 @@
|
|
1
|
+
=begin
|
2
|
+
#Extend API Reference
|
3
|
+
|
4
|
+
## 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>
|
5
|
+
|
6
|
+
The version of the OpenAPI document: Default
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
|
16
|
+
# Unit tests for HelloextendApiClient::ProductsApi
|
17
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe 'ProductsApi' do
|
20
|
+
before do
|
21
|
+
# run before each test
|
22
|
+
@api_instance = HelloextendApiClient::ProductsApi.new
|
23
|
+
end
|
24
|
+
|
25
|
+
after do
|
26
|
+
# run after each test
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test an instance of ProductsApi' do
|
30
|
+
it 'should create an instance of ProductsApi' do
|
31
|
+
expect(@api_instance).to be_instance_of(HelloextendApiClient::ProductsApi)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# unit tests for stores_store_id_products_post
|
36
|
+
# Create a product
|
37
|
+
# @param store_id Unique identifier for a Store on Extend
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @option opts [Boolean] :batch Use the value true if passing a batch of products.
|
40
|
+
# @option opts [Boolean] :upsert If true, will update products that already exist.
|
41
|
+
# @option opts [Product] :product
|
42
|
+
# @return [Product]
|
43
|
+
describe 'stores_store_id_products_post test' do
|
44
|
+
it 'should work' do
|
45
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
49
|
+
# unit tests for stores_store_id_products_product_id_delete
|
50
|
+
# Delete a product
|
51
|
+
# @param store_id Unique identifier for a Store on Extend
|
52
|
+
# @param product_id The unique referenceId passed to extend when creating a product.
|
53
|
+
# @param [Hash] opts the optional parameters
|
54
|
+
# @return [nil]
|
55
|
+
describe 'stores_store_id_products_product_id_delete test' do
|
56
|
+
it 'should work' do
|
57
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
# unit tests for stores_store_id_products_product_id_get
|
62
|
+
# Get a product
|
63
|
+
# Returns information about a product
|
64
|
+
# @param store_id Unique identifier for a Store on Extend
|
65
|
+
# @param product_id The unique referenceId passed to extend when creating a product.
|
66
|
+
# @param [Hash] opts the optional parameters
|
67
|
+
# @return [Product]
|
68
|
+
describe 'stores_store_id_products_product_id_get test' do
|
69
|
+
it 'should work' do
|
70
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
71
|
+
end
|
72
|
+
end
|
73
|
+
|
74
|
+
# unit tests for stores_store_id_products_product_id_put
|
75
|
+
# Update a product
|
76
|
+
# When you update a product, you may not update the referenceId.
|
77
|
+
# @param store_id Unique identifier for a Store on Extend
|
78
|
+
# @param product_id The unique referenceId passed to extend when creating a product.
|
79
|
+
# @param [Hash] opts the optional parameters
|
80
|
+
# @option opts [UNKNOWN_BASE_TYPE] :unknown_base_type
|
81
|
+
# @return [Product]
|
82
|
+
describe 'stores_store_id_products_product_id_put test' do
|
83
|
+
it 'should work' do
|
84
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
85
|
+
end
|
86
|
+
end
|
87
|
+
|
88
|
+
end
|
@@ -0,0 +1,226 @@
|
|
1
|
+
=begin
|
2
|
+
#Extend API Reference
|
3
|
+
|
4
|
+
## 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>
|
5
|
+
|
6
|
+
The version of the OpenAPI document: Default
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.1-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
|
15
|
+
describe HelloextendApiClient::ApiClient do
|
16
|
+
context 'initialization' do
|
17
|
+
context 'URL stuff' do
|
18
|
+
context 'host' do
|
19
|
+
it 'removes http from host' do
|
20
|
+
HelloextendApiClient.configure { |c| c.host = 'http://example.com' }
|
21
|
+
expect(HelloextendApiClient::Configuration.default.host).to eq('example.com')
|
22
|
+
end
|
23
|
+
|
24
|
+
it 'removes https from host' do
|
25
|
+
HelloextendApiClient.configure { |c| c.host = 'https://wookiee.com' }
|
26
|
+
expect(HelloextendApiClient::ApiClient.default.config.host).to eq('wookiee.com')
|
27
|
+
end
|
28
|
+
|
29
|
+
it 'removes trailing path from host' do
|
30
|
+
HelloextendApiClient.configure { |c| c.host = 'hobo.com/v4' }
|
31
|
+
expect(HelloextendApiClient::Configuration.default.host).to eq('hobo.com')
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
context 'base_path' do
|
36
|
+
it "prepends a slash to base_path" do
|
37
|
+
HelloextendApiClient.configure { |c| c.base_path = 'v4/dog' }
|
38
|
+
expect(HelloextendApiClient::Configuration.default.base_path).to eq('/v4/dog')
|
39
|
+
end
|
40
|
+
|
41
|
+
it "doesn't prepend a slash if one is already there" do
|
42
|
+
HelloextendApiClient.configure { |c| c.base_path = '/v4/dog' }
|
43
|
+
expect(HelloextendApiClient::Configuration.default.base_path).to eq('/v4/dog')
|
44
|
+
end
|
45
|
+
|
46
|
+
it "ends up as a blank string if nil" do
|
47
|
+
HelloextendApiClient.configure { |c| c.base_path = nil }
|
48
|
+
expect(HelloextendApiClient::Configuration.default.base_path).to eq('')
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
describe 'params_encoding in #build_request' do
|
55
|
+
let(:config) { HelloextendApiClient::Configuration.new }
|
56
|
+
let(:api_client) { HelloextendApiClient::ApiClient.new(config) }
|
57
|
+
|
58
|
+
it 'defaults to nil' do
|
59
|
+
expect(HelloextendApiClient::Configuration.default.params_encoding).to eq(nil)
|
60
|
+
expect(config.params_encoding).to eq(nil)
|
61
|
+
|
62
|
+
request = api_client.build_request(:get, '/test')
|
63
|
+
expect(request.options[:params_encoding]).to eq(nil)
|
64
|
+
end
|
65
|
+
|
66
|
+
it 'can be customized' do
|
67
|
+
config.params_encoding = :multi
|
68
|
+
request = api_client.build_request(:get, '/test')
|
69
|
+
expect(request.options[:params_encoding]).to eq(:multi)
|
70
|
+
end
|
71
|
+
end
|
72
|
+
|
73
|
+
describe 'timeout in #build_request' do
|
74
|
+
let(:config) { HelloextendApiClient::Configuration.new }
|
75
|
+
let(:api_client) { HelloextendApiClient::ApiClient.new(config) }
|
76
|
+
|
77
|
+
it 'defaults to 0' do
|
78
|
+
expect(HelloextendApiClient::Configuration.default.timeout).to eq(0)
|
79
|
+
expect(config.timeout).to eq(0)
|
80
|
+
|
81
|
+
request = api_client.build_request(:get, '/test')
|
82
|
+
expect(request.options[:timeout]).to eq(0)
|
83
|
+
end
|
84
|
+
|
85
|
+
it 'can be customized' do
|
86
|
+
config.timeout = 100
|
87
|
+
request = api_client.build_request(:get, '/test')
|
88
|
+
expect(request.options[:timeout]).to eq(100)
|
89
|
+
end
|
90
|
+
end
|
91
|
+
|
92
|
+
describe '#deserialize' do
|
93
|
+
it "handles Array<Integer>" do
|
94
|
+
api_client = HelloextendApiClient::ApiClient.new
|
95
|
+
headers = { 'Content-Type' => 'application/json' }
|
96
|
+
response = double('response', headers: headers, body: '[12, 34]')
|
97
|
+
data = api_client.deserialize(response, 'Array<Integer>')
|
98
|
+
expect(data).to be_instance_of(Array)
|
99
|
+
expect(data).to eq([12, 34])
|
100
|
+
end
|
101
|
+
|
102
|
+
it 'handles Array<Array<Integer>>' do
|
103
|
+
api_client = HelloextendApiClient::ApiClient.new
|
104
|
+
headers = { 'Content-Type' => 'application/json' }
|
105
|
+
response = double('response', headers: headers, body: '[[12, 34], [56]]')
|
106
|
+
data = api_client.deserialize(response, 'Array<Array<Integer>>')
|
107
|
+
expect(data).to be_instance_of(Array)
|
108
|
+
expect(data).to eq([[12, 34], [56]])
|
109
|
+
end
|
110
|
+
|
111
|
+
it 'handles Hash<String, String>' do
|
112
|
+
api_client = HelloextendApiClient::ApiClient.new
|
113
|
+
headers = { 'Content-Type' => 'application/json' }
|
114
|
+
response = double('response', headers: headers, body: '{"message": "Hello"}')
|
115
|
+
data = api_client.deserialize(response, 'Hash<String, String>')
|
116
|
+
expect(data).to be_instance_of(Hash)
|
117
|
+
expect(data).to eq(:message => 'Hello')
|
118
|
+
end
|
119
|
+
end
|
120
|
+
|
121
|
+
describe "#object_to_hash" do
|
122
|
+
it 'ignores nils and includes empty arrays' do
|
123
|
+
# uncomment below to test object_to_hash for model
|
124
|
+
# api_client = HelloextendApiClient::ApiClient.new
|
125
|
+
# _model = HelloextendApiClient::ModelName.new
|
126
|
+
# update the model attribute below
|
127
|
+
# _model.id = 1
|
128
|
+
# update the expected value (hash) below
|
129
|
+
# expected = {id: 1, name: '', tags: []}
|
130
|
+
# expect(api_client.object_to_hash(_model)).to eq(expected)
|
131
|
+
end
|
132
|
+
end
|
133
|
+
|
134
|
+
describe '#build_collection_param' do
|
135
|
+
let(:param) { ['aa', 'bb', 'cc'] }
|
136
|
+
let(:api_client) { HelloextendApiClient::ApiClient.new }
|
137
|
+
|
138
|
+
it 'works for csv' do
|
139
|
+
expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
|
140
|
+
end
|
141
|
+
|
142
|
+
it 'works for ssv' do
|
143
|
+
expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
|
144
|
+
end
|
145
|
+
|
146
|
+
it 'works for tsv' do
|
147
|
+
expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
|
148
|
+
end
|
149
|
+
|
150
|
+
it 'works for pipes' do
|
151
|
+
expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
|
152
|
+
end
|
153
|
+
|
154
|
+
it 'works for multi' do
|
155
|
+
expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
|
156
|
+
end
|
157
|
+
|
158
|
+
it 'fails for invalid collection format' do
|
159
|
+
expect { api_client.build_collection_param(param, :INVALID) }.to raise_error(RuntimeError, 'unknown collection format: :INVALID')
|
160
|
+
end
|
161
|
+
end
|
162
|
+
|
163
|
+
describe '#json_mime?' do
|
164
|
+
let(:api_client) { HelloextendApiClient::ApiClient.new }
|
165
|
+
|
166
|
+
it 'works' do
|
167
|
+
expect(api_client.json_mime?(nil)).to eq false
|
168
|
+
expect(api_client.json_mime?('')).to eq false
|
169
|
+
|
170
|
+
expect(api_client.json_mime?('application/json')).to eq true
|
171
|
+
expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
|
172
|
+
expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
|
173
|
+
|
174
|
+
expect(api_client.json_mime?('application/xml')).to eq false
|
175
|
+
expect(api_client.json_mime?('text/plain')).to eq false
|
176
|
+
expect(api_client.json_mime?('application/jsonp')).to eq false
|
177
|
+
end
|
178
|
+
end
|
179
|
+
|
180
|
+
describe '#select_header_accept' do
|
181
|
+
let(:api_client) { HelloextendApiClient::ApiClient.new }
|
182
|
+
|
183
|
+
it 'works' do
|
184
|
+
expect(api_client.select_header_accept(nil)).to be_nil
|
185
|
+
expect(api_client.select_header_accept([])).to be_nil
|
186
|
+
|
187
|
+
expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
|
188
|
+
expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
|
189
|
+
expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
|
190
|
+
|
191
|
+
expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
|
192
|
+
expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
|
193
|
+
end
|
194
|
+
end
|
195
|
+
|
196
|
+
describe '#select_header_content_type' do
|
197
|
+
let(:api_client) { HelloextendApiClient::ApiClient.new }
|
198
|
+
|
199
|
+
it 'works' do
|
200
|
+
expect(api_client.select_header_content_type(nil)).to eq('application/json')
|
201
|
+
expect(api_client.select_header_content_type([])).to eq('application/json')
|
202
|
+
|
203
|
+
expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
|
204
|
+
expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
|
205
|
+
expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
|
206
|
+
expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
|
207
|
+
expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
|
208
|
+
end
|
209
|
+
end
|
210
|
+
|
211
|
+
describe '#sanitize_filename' do
|
212
|
+
let(:api_client) { HelloextendApiClient::ApiClient.new }
|
213
|
+
|
214
|
+
it 'works' do
|
215
|
+
expect(api_client.sanitize_filename('sun')).to eq('sun')
|
216
|
+
expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
|
217
|
+
expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
|
218
|
+
expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
|
219
|
+
expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
|
220
|
+
expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
|
221
|
+
expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
|
222
|
+
expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
|
223
|
+
expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
|
224
|
+
end
|
225
|
+
end
|
226
|
+
end
|