noths 0.1.0 → 0.2.0

data/schemas/refunds.json

@@ -9,6 +9,13 @@
       "operations": [
         {
           "parameters": [
+            {
+              "paramType": "query",
+              "name": "token",
+              "type": "string",
+              "description": "Authentication credential",
+              "required": true
+            },
             {
               "paramType": "path",
               "name": "order_id",
@@ -57,11 +64,9 @@
           ],
           "method": "post",
           "nickname": "Refunds#create",
-          "authorizations": {
-            "token": [
-
-            ]
-          }
+          "consumes": [
+            "application/x-www-form-urlencoded"
+          ]
         }
       ]
     }

data/spec/api/orders_api_spec.rb

@@ -1,38 +1,18 @@
-=begin
-#Noths
-
-#www.notonthehighstreet.com API client
-
-OpenAPI spec version: 1.0
-
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
-
-=end
-
-require 'spec_helper'
-require 'json'
+# frozen_string_literal: true
 
 # Unit tests for Noths::OrdersApi
 # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
 # Please update as you see appropriate
 describe 'OrdersApi' do
-  before do
-    # run before each test
-    @instance = Noths::OrdersApi.new
-  end
-
-  after do
-    # run after each test
-  end
+  let(:instance) { Noths::OrdersApi.new }
 
   describe 'test an instance of OrdersApi' do
     it 'should create an instance of OrdersApi' do
-      expect(@instance).to be_instance_of(Noths::OrdersApi)
+      expect(instance).to be_instance_of(Noths::OrdersApi)
     end
   end
 
-  # unit tests for api_v1_orders_acceptance
+  # unit tests for orders_acceptance
   # Accept an order
   #           Accept an order that is in the placed state.           Note: In rare instances orders may not transition to the 'accepted' state           immediately. 
   # @param token Authentication credential
@@ -42,26 +22,22 @@ describe 'OrdersApi' do
   # @param [Hash] opts the optional parameters
   # @option opts [String] :confirmation_note 
   # @return [nil]
-  describe 'api_v1_orders_acceptance test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
+  describe 'orders_acceptance test' do
+    it 'should work'
   end
 
-  # unit tests for api_v1_orders_acceptance_bulk
+  # unit tests for orders_acceptance_bulk
   # Accept multiple orders
   # Returns an array of hashes containing order ids and status codes. A status code of 200 indicates that the order was eligible to be accepted and is expected to be processed successfully. This is not a guarantee that the order will be accepted. Processing acceptance is not instantaneous and may take some time while funds are captured.     Example response:     <pre>     [       {         \"id\": 12,         \"status\": 200,         \"errors\": []       },       {         \"id\": 22,         \"status\": 404,         \"errors\": [           {             \"code\": \"RESOURCE_NOT_FOUND\",             \"title\": \"Couldn't find the requested resource\"           }         ]       }     ]     </pre> 
   # @param token Authentication credential
-  # @param  
+  # @param payload 
   # @param [Hash] opts the optional parameters
   # @return [nil]
-  describe 'api_v1_orders_acceptance_bulk test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
+  describe 'orders_acceptance_bulk test' do
+    it 'should work'
   end
 
-  # unit tests for api_v1_orders_decline
+  # unit tests for orders_decline
   # Decline an order
   # Declines an order that is in the placed state
   # @param token Authentication credential
@@ -69,53 +45,45 @@ describe 'OrdersApi' do
   # @param decline_reason 
   # @param [Hash] opts the optional parameters
   # @return [nil]
-  describe 'api_v1_orders_decline test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
+  describe 'orders_decline test' do
+    it 'should work'
   end
 
-  # unit tests for api_v1_orders_decline_bulk
+  # unit tests for orders_decline_bulk
   # Decline multiple orders
   # Returns an array of hashes containing order ids and status codes. A status code of 200       indicates a successful update whereas a code of 400 indicates failure.     Example response:     <pre>     [       {         \"id\": 12,         \"status\": 200,         \"errors\": []       },       {         \"id\": 22,         \"status\": 404,         \"errors\": [           {             \"code\": \"RESOURCE_NOT_FOUND\",             \"title\": \"Couldn't find the requested resource\"           }         ]       }     ]     </pre> 
   # @param token Authentication credential
-  # @param  
+  # @param payload 
   # @param [Hash] opts the optional parameters
   # @return [nil]
-  describe 'api_v1_orders_decline_bulk test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
+  describe 'orders_decline_bulk test' do
+    it 'should work'
   end
 
-  # unit tests for api_v1_orders_dispatch_note
+  # unit tests for orders_dispatch_note
   # Generate a dispatch note pdf or gift note pdf.
   # Force the kind of document by passing the force_type parameter. A gift note can only be printed for an order that is a gift, which will be the default behaviour.<p/>Here is an example of how to obtain a pdf using curl:       <pre>curl -XPOST [URL] > document.pdf</pre>
   # @param token Authentication credential
   # @param id Order id
   # @param [Hash] opts the optional parameters
   # @option opts [String] :force_type Type of document
-  # @return [nil]
-  describe 'api_v1_orders_dispatch_note test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
+  # @return [File]
+  describe 'orders_dispatch_note test' do
+    it 'should work'
   end
 
-  # unit tests for api_v1_orders_dispatch_notes_bulk
+  # unit tests for orders_dispatch_notes_bulk
   # Generate pdf with dispatch note for each order
   # <p/> Here is an example of how to obtain a pdf using curl:       <pre>curl -H \"Content-Type: application/json\" -d '[{\"id\": 123}, {\"id\": 456}]' -XPOST [URL] > document.pdf</pre><p/>       Ensure that the Content-Type header is set to \"Content-Type: application/json\".<p/>
   # @param token Authentication credential
-  # @param  
+  # @param payload 
   # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'api_v1_orders_dispatch_notes_bulk test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
+  # @return [File]
+  describe 'orders_dispatch_notes_bulk test' do
+    it 'should work'
   end
 
-  # unit tests for api_v1_orders_dispatch_order
+  # unit tests for orders_dispatch_order
   # Dispatch an order
   # Dispatches an order that is in an accepted state and has also had its dispatch note printed
   # @param token Authentication credential
@@ -127,27 +95,23 @@ describe 'OrdersApi' do
   # @option opts [String] :parcel_tracking_url 
   # @option opts [BOOLEAN] :ignore_unresolved_enquiries Defaults to false
   # @return [nil]
-  describe 'api_v1_orders_dispatch_order test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
+  describe 'orders_dispatch_order test' do
+    it 'should work'
   end
 
-  # unit tests for api_v1_orders_dispatch_orders_bulk
+  # unit tests for orders_dispatch_orders_bulk
   # Dispatch multiple orders
   # Returns an array of hashes containing order ids and status codes. A status code of 200       indicates a successful update whereas a code of 400 indicates failure.     Example response:     <pre>     [       {         \"id\": 12,         \"status\": 200,         \"errors\": []       },       {         \"id\": 22,         \"status\": 404,         \"errors\": [           {             \"code\": \"RESOURCE_NOT_FOUND\",             \"title\": \"Couldn't find the requested resource\"           }         ]       }     ]     </pre> 
   # @param token Authentication credential
-  # @param  
+  # @param payload 
   # @param [Hash] opts the optional parameters
   # @option opts [BOOLEAN] :ignore_unresolved_enquiries Defaults to false
   # @return [nil]
-  describe 'api_v1_orders_dispatch_orders_bulk test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
+  describe 'orders_dispatch_orders_bulk test' do
+    it 'should work'
   end
 
-  # unit tests for api_v1_orders_index
+  # unit tests for orders_index
   # Fetch orders
   # Lists orders descending by placed at time by default.<p/>If you just want a count, use per_page=0 and offset=0 .
   # @param token Authentication credential
@@ -174,55 +138,47 @@ describe 'OrdersApi' do
   # @option opts [String] :query Matches your query to information related to your orders
   # @option opts [BOOLEAN] :repeat_customer 
   # @option opts [String] :sort Defaults to placed_at
-  # @option opts [String] :state State
+  # @option opts [Array<String>] :state State
   # @return [OrderIndex]
-  describe 'api_v1_orders_index test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
+  describe 'orders_index test' do
+    it 'should work'
   end
 
-  # unit tests for api_v1_orders_invoice
+  # unit tests for orders_invoice
   # Generate a vat invoice pdf.
   # &lt;p&gt;Invoices are currently only applicable for the UK site&lt;/p&gt;Here is an example of how to obtain a pdf using curl:       &lt;pre&gt;curl -XPOST [URL] &gt; document.pdf&lt;/pre&gt;
   # @param token Authentication credential
   # @param id Order id
   # @param type Type of invoice
   # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'api_v1_orders_invoice test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
+  # @return [File]
+  describe 'orders_invoice test' do
+    it 'should work'
   end
 
-  # unit tests for api_v1_orders_order_details
+  # unit tests for orders_order_details
   # Generate an order details pdf
   # Here is an example of how to obtain a pdf using curl:       &lt;pre&gt;curl -XPOST [URL] &gt; document.pdf&lt;/pre&gt;
   # @param token Authentication credential
   # @param id Order id
   # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'api_v1_orders_order_details test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
+  # @return [File]
+  describe 'orders_order_details test' do
+    it 'should work'
   end
 
-  # unit tests for api_v1_orders_order_details_bulk
+  # unit tests for orders_order_details_bulk
   # Generate pdf with order details for each order
   # &lt;p/&gt; Here is an example of how to obtain a pdf using curl:       &lt;pre&gt;curl -H \&quot;Content-Type: application/json\&quot; -d &#39;[{\&quot;id\&quot;: 123}, {\&quot;id\&quot;: 456}]&#39; -XPOST [URL] &gt; document.pdf&lt;/pre&gt;&lt;p/&gt;       Ensure that the Content-Type header is set to \&quot;Content-Type: application/json\&quot;.&lt;p/&gt;
   # @param token Authentication credential
-  # @param  
+  # @param payload 
   # @param [Hash] opts the optional parameters
-  # @return [nil]
-  describe 'api_v1_orders_order_details_bulk test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
+  # @return [File]
+  describe 'orders_order_details_bulk test' do
+    it 'should work'
   end
 
-  # unit tests for api_v1_orders_show
+  # unit tests for orders_show
   # Fetch a single Order
   # 
   # @param token Authentication credential
@@ -230,10 +186,8 @@ describe 'OrdersApi' do
   # @param [Hash] opts the optional parameters
   # @option opts [String] :include         Comma separated list of nodes to expand. Currently the available values are:         &lt;br /&gt;&lt;b style&#x3D;\&quot;margin-left: 10px\&quot;&gt;financials&lt;/b&gt;         &lt;p style&#x3D;\&quot;margin-left: 20px\&quot;&gt;           Additional financial data about this order, eg: commission and discount amounts.         &lt;/p&gt; 
   # @return [Order]
-  describe 'api_v1_orders_show test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
+  describe 'orders_show test' do
+    it 'should work'
   end
 
 end

data/spec/api/refunds_api_spec.rb

@@ -1,38 +1,18 @@
-=begin
-#Noths
-
-#www.notonthehighstreet.com API client
-
-OpenAPI spec version: 1.0
-
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
-
-=end
-
-require 'spec_helper'
-require 'json'
+# frozen_string_literal: true
 
 # Unit tests for Noths::RefundsApi
 # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
 # Please update as you see appropriate
 describe 'RefundsApi' do
-  before do
-    # run before each test
-    @instance = Noths::RefundsApi.new
-  end
-
-  after do
-    # run after each test
-  end
+  let(:instance) { Noths::RefundsApi.new }
 
   describe 'test an instance of RefundsApi' do
     it 'should create an instance of RefundsApi' do
-      expect(@instance).to be_instance_of(Noths::RefundsApi)
+      expect(instance).to be_instance_of(Noths::RefundsApi)
     end
   end
 
-  # unit tests for api_v1_refunds_create
+  # unit tests for refunds_create
   # Refund an order
   # Refunds all or part of an order
   # @param token Authentication credential
@@ -41,10 +21,8 @@ describe 'RefundsApi' do
   # @param cents 
   # @param [Hash] opts the optional parameters
   # @return [RefundResponse]
-  describe 'api_v1_refunds_create test' do
-    it "should work" do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
+  describe 'refunds_create test' do
+    it 'should work'
   end
 
 end

data/spec/api_client_spec.rb

@@ -1,16 +1,4 @@
-=begin
-#Noths
-
-#www.notonthehighstreet.com API client
-
-OpenAPI spec version: 1.0
-
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
-
-=end
-
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Noths::ApiClient do
   context 'initialization' do
@@ -124,7 +112,7 @@ describe Noths::ApiClient do
       #api_client = Noths::ApiClient.new
       #_model = Noths::ModelName.new
       # update the model attribute below
-      #_model.id = 1 
+      #_model.id = 1
       # update the expected value (hash) below
       #expected = {id: 1, name: '', tags: []}
       #expect(api_client.object_to_hash(_model)).to eq(expected)

data/spec/configuration_spec.rb

@@ -1,41 +1,25 @@
-=begin
-#Noths
-
-#www.notonthehighstreet.com API client
-
-OpenAPI spec version: 1.0
-
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
-
-=end
-
-require 'spec_helper'
+# frozen_string_literal: true
 
 describe Noths::Configuration do
   let(:config) { Noths::Configuration.default }
 
-  before(:each) do
-    # uncomment below to setup host and base_path
-    #require 'URI'
-    #uri = URI.parse("http://localhost")
-    #Noths.configure do |c|
-    #  c.host = uri.host
-    #  c.base_path = uri.path
-    #end
+  before do
+    Noths.configure do |c|
+      c.scheme    = 'https'
+      c.host      = 'api.example.com'
+      c.base_path = '/v1'
+    end
   end
 
   describe '#base_url' do
     it 'should have the default value' do
-      # uncomment below to test default value of the base path
-      #expect(config.base_url).to eq("http://localhost")
+      expect(config.base_url).to eq("https://api.example.com/v1")
     end
 
     it 'should remove trailing slashes' do
       [nil, '', '/', '//'].each do |base_path|
         config.base_path = base_path
-        # uncomment below to test trailing slashes
-        #expect(config.base_url).to eq("http://localhost")
+        expect(config.base_url).to eq("https://api.example.com")
       end
     end
   end

data/spec/models/acceptance_bulk_model_spec.rb

@@ -1,59 +1,28 @@
-=begin
-#Noths
-
-#www.notonthehighstreet.com API client
-
-OpenAPI spec version: 1.0
-
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.3.1
-
-=end
-
-require 'spec_helper'
-require 'json'
-require 'date'
+# frozen_string_literal: true
 
 # Unit tests for Noths::AcceptanceBulkModel
-# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
-# Please update as you see appropriate
 describe 'AcceptanceBulkModel' do
-  before do
-    # run before each test
-    @instance = Noths::AcceptanceBulkModel.new
-  end
-
-  after do
-    # run after each test
-  end
+  let(:instance) { Noths::AcceptanceBulkModel.new }
 
   describe 'test an instance of AcceptanceBulkModel' do
     it 'should create an instance of AcceptanceBulkModel' do
-      expect(@instance).to be_instance_of(Noths::AcceptanceBulkModel)
+      expect(instance).to be_instance_of(Noths::AcceptanceBulkModel)
     end
   end
   describe 'test attribute "id"' do
-    it 'should work' do
-       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
+    it 'should work'
   end
 
   describe 'test attribute "estimated_delivery_date"' do
-    it 'should work' do
-       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
+    it 'should work'
   end
 
   describe 'test attribute "estimated_dispatch_at"' do
-    it 'should work' do
-       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
+    it 'should work'
   end
 
   describe 'test attribute "confirmation_note"' do
-    it 'should work' do
-       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
+    it 'should work'
   end
 
 end