dear-inventory-ruby 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc16b0247ee5118afeefc165b65960ac156aa18e08646de3c076b06f3225d091
-  data.tar.gz: fd18222be798f9d38536629e2ffa62dd70d98a8de5e34e6f3ceaf1aff9b91345
+  metadata.gz: 51c48b4739e560045deac028714486d1db23d4f3424c59798638e8f0f935e425
+  data.tar.gz: 4cd9898b7d3202d14cc6488eb3cf7be1c09d6965a5f49d5ceac56172c4477ee5
 SHA512:
-  metadata.gz: 315173b6af1c0d160e46d9462e6d9ddf10a7a23a6fa5200ec4761d28b02602ac24fcffc1080a9a3b0c8ef1cd1b348f05ac1ad1197dcef97a5c67d60ebfd6a6ba
-  data.tar.gz: 0fada5827551de17542f6f3a36f492183447a3abc6fce2d501554aa8070ef96f8f9223156b98a5d8fbe50ae51252cb10576a89f92cb0185f00564d47e9e14e12
+  metadata.gz: f288879bd2f68534b6fe69afeafd8c8884ff9f4bcef34723147bfdf92541663bf6c788cfdde49558053bf8affa7faa0b697f9cd463324552e182a927b7d19175
+  data.tar.gz: ec3eee176bc1a6b496e05cdcfc84c658f43ae7070b236f91a20c2fd48b058486b4b10a77d5cdda8d6d0feefb76a8c74d39319790b77843e1cf91058d28325b36

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.2.5] - 2022-05-26
+
+- Add the new endpoint GET `/saleList`
+
 ## [0.2.4] - 2022-04-12
 
 - Add the new endpoint GET `/sale`

data/README.md

@@ -7,7 +7,7 @@ This specifing endpoints for DEAR Inventory API
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 0.2.4
+- Package version: 0.2.5
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://www.nhansg.com](https://www.nhansg.com)
 
@@ -24,16 +24,16 @@ gem build dear-inventory-ruby.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./dear-inventory-ruby-0.2.4.gem
+gem install ./dear-inventory-ruby-0.2.5.gem
 ```
 
-(for development, run `gem install --dev ./dear-inventory-ruby-0.2.4.gem` to install the development dependencies)
+(for development, run `gem install --dev ./dear-inventory-ruby-0.2.5.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 'dear-inventory-ruby', '~> 0.2.4'
+    gem 'dear-inventory-ruby', '~> 0.2.5'
 
 ### Install from Git
 
@@ -113,6 +113,7 @@ Class | Method | HTTP request | Description
 *DearInventoryRuby::InventoryApi* | [**get_price_tiers**](docs/InventoryApi.md#get_price_tiers) | **GET** /ref/priceTier | Allows you to retrieve the Price Tiers
 *DearInventoryRuby::InventoryApi* | [**get_sale**](docs/InventoryApi.md#get_sale) | **GET** /sale | Allows you to retrieve the Sale
 *DearInventoryRuby::InventoryApi* | [**get_sale_invoices**](docs/InventoryApi.md#get_sale_invoices) | **GET** /sale/invoice | Allows you to retrieve the sale invoices
+*DearInventoryRuby::InventoryApi* | [**get_sale_list**](docs/InventoryApi.md#get_sale_list) | **GET** /saleList | Allows you to retrieve the Sales based on conditions
 *DearInventoryRuby::InventoryApi* | [**get_sale_order**](docs/InventoryApi.md#get_sale_order) | **GET** /sale/order | Allows you to retrieve the Sale Order
 *DearInventoryRuby::InventoryApi* | [**get_sale_payment**](docs/InventoryApi.md#get_sale_payment) | **GET** /sale/payment | Allows you to retrieve the Sale Payments
 *DearInventoryRuby::InventoryApi* | [**get_sale_quote**](docs/InventoryApi.md#get_sale_quote) | **GET** /sale/quote | Allows you to retrieve the Sale Quote
@@ -150,6 +151,8 @@ Class | Method | HTTP request | Description
  - [DearInventoryRuby::SaleInvoiceLine](docs/SaleInvoiceLine.md)
  - [DearInventoryRuby::SaleInvoicePost](docs/SaleInvoicePost.md)
  - [DearInventoryRuby::SaleInvoices](docs/SaleInvoices.md)
+ - [DearInventoryRuby::SaleItem](docs/SaleItem.md)
+ - [DearInventoryRuby::SaleList](docs/SaleList.md)
  - [DearInventoryRuby::SaleOrder](docs/SaleOrder.md)
  - [DearInventoryRuby::SaleOrderLine](docs/SaleOrderLine.md)
  - [DearInventoryRuby::SalePayment](docs/SalePayment.md)

data/docs/InventoryApi.md

@@ -25,6 +25,7 @@ Method | HTTP request | Description
 [**get_price_tiers**](InventoryApi.md#get_price_tiers) | **GET** /ref/priceTier | Allows you to retrieve the Price Tiers
 [**get_sale**](InventoryApi.md#get_sale) | **GET** /sale | Allows you to retrieve the Sale
 [**get_sale_invoices**](InventoryApi.md#get_sale_invoices) | **GET** /sale/invoice | Allows you to retrieve the sale invoices
+[**get_sale_list**](InventoryApi.md#get_sale_list) | **GET** /saleList | Allows you to retrieve the Sales based on conditions
 [**get_sale_order**](InventoryApi.md#get_sale_order) | **GET** /sale/order | Allows you to retrieve the Sale Order
 [**get_sale_payment**](InventoryApi.md#get_sale_payment) | **GET** /sale/payment | Allows you to retrieve the Sale Payments
 [**get_sale_quote**](InventoryApi.md#get_sale_quote) | **GET** /sale/quote | Allows you to retrieve the Sale Quote
@@ -1330,6 +1331,97 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## get_sale_list
+
+> SaleList get_sale_list(opts)
+
+Allows you to retrieve the Sales based on conditions
+
+### Example
+
+```ruby
+# load the gem
+require 'dear-inventory-ruby'
+# setup authorization
+DearInventoryRuby.configure do |config|
+  # Configure API key authorization: accountID
+  config.api_key['api-auth-accountid'] = '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['api-auth-accountid'] = 'Bearer'
+
+  # Configure API key authorization: appKey
+  config.api_key['api-auth-applicationkey'] = '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['api-auth-applicationkey'] = 'Bearer'
+end
+
+api_instance = DearInventoryRuby::InventoryApi.new
+opts = {
+  page: '1', # String | Default is 1
+  limit: '100', # String | Default is 100
+  search: 'search_example', # String | Only return sales with search value contained in one of these fields: OrderNumber, Status, Customer, invoiceNumber, CustomerReference, CreditNoteNumber
+  created_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return sales created after specified date. Date must follow ISO 8601 format.
+  updated_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return sales changed after specified date. Date must follow ISO 8601 format.
+  ship_by: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Only return sales with Ship By date on or before specified date, with not authorised Shipment. Date must follow ISO 8601 format.
+  quote_status: 'quote_status_example', # String | Only return sales with specified quote status
+  order_status: 'order_status_example', # String | Only return sales with specified order status
+  combined_pick_status: 'combined_pick_status_example', # String | Only return sales with specified CombinedPickingStatus
+  combined_pack_status: 'combined_pack_status_example', # String | Only return sales with specified CombinedPackingStatus
+  combined_shipping_status: 'combined_shipping_status_example', # String | Only return sales with specified CombinedShippingStatus
+  combined_invoice_status: 'combined_invoice_status_example', # String | Only return sales with specified CombinedInvoiceStatus
+  credit_note_status: 'credit_note_status_example', # String | Only return sales with specified credit note status
+  external_id: 'external_id_example', # String | Only return sales with specified External ID
+  status: 'status_example', # String | Default is nil
+  ready_for_shipping: true, # Boolean | Only return sales with 'Authorised' pack and not 'Authorised' shipping
+  order_location_id: 'order_location_id_example' # String | Only return sales with specified Order Location ID
+}
+
+begin
+  #Allows you to retrieve the Sales based on conditions
+  result = api_instance.get_sale_list(opts)
+  p result
+rescue DearInventoryRuby::ApiError => e
+  puts "Exception when calling InventoryApi->get_sale_list: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **String**| Default is 1 | [optional] [default to '1']
+ **limit** | **String**| Default is 100 | [optional] [default to '100']
+ **search** | **String**| Only return sales with search value contained in one of these fields: OrderNumber, Status, Customer, invoiceNumber, CustomerReference, CreditNoteNumber | [optional] 
+ **created_since** | **DateTime**| Only return sales created after specified date. Date must follow ISO 8601 format. | [optional] 
+ **updated_since** | **DateTime**| Only return sales changed after specified date. Date must follow ISO 8601 format. | [optional] 
+ **ship_by** | **DateTime**| Only return sales with Ship By date on or before specified date, with not authorised Shipment. Date must follow ISO 8601 format. | [optional] 
+ **quote_status** | **String**| Only return sales with specified quote status | [optional] 
+ **order_status** | **String**| Only return sales with specified order status | [optional] 
+ **combined_pick_status** | **String**| Only return sales with specified CombinedPickingStatus | [optional] 
+ **combined_pack_status** | **String**| Only return sales with specified CombinedPackingStatus | [optional] 
+ **combined_shipping_status** | **String**| Only return sales with specified CombinedShippingStatus | [optional] 
+ **combined_invoice_status** | **String**| Only return sales with specified CombinedInvoiceStatus | [optional] 
+ **credit_note_status** | **String**| Only return sales with specified credit note status | [optional] 
+ **external_id** | **String**| Only return sales with specified External ID | [optional] 
+ **status** | **String**| Default is nil | [optional] 
+ **ready_for_shipping** | **Boolean**| Only return sales with 'Authorised' pack and not 'Authorised' shipping | [optional] 
+ **order_location_id** | **String**| Only return sales with specified Order Location ID | [optional] 
+
+### Return type
+
+[**SaleList**](SaleList.md)
+
+### Authorization
+
+[accountID](../README.md#accountID), [appKey](../README.md#appKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_sale_order
 
 > SaleOrder get_sale_order(opts)

data/docs/SaleItem.md

@@ -0,0 +1,77 @@
+# DearInventoryRuby::SaleItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sale_id** | **String** | Unique DEAR Sale identifier | [optional] 
+**order_number** | **String** | Sale Order number generated by DEAR | [optional] 
+**status** | **String** | Current sale status. Possible values are values | [optional] 
+**order_date** | **Date** | Date when Sale Order was created | [optional] 
+**invoice_date** | **Date** | Date when Invoice was issued | [optional] 
+**customer** | **String** | Name of the customer | [optional] 
+**customer_id** | **String** | Customer Identifier | [optional] 
+**invoice_number** | **String** | Invoice number generated by DEAR | [optional] 
+**customer_reference** | **String** | Optional Customer Reference (typically customer Purchase order number) supplied by the customer for the sale | [optional] 
+**invoice_amount** | **Float** | Total Invoice amount minus total Credit note amount in customer currency | [optional] 
+**paid_amount** | **Float** | Total Paid amount minus Refunded amount in customer currency | [optional] 
+**invoice_due_date** | **Date** | Date when invoice is due according to selected payment terms | [optional] 
+**ship_by** | **Date** | Date when shipment is due | [optional] 
+**base_currency** | **String** | 3 digit Base currency code (as configured in General Settings) | [optional] 
+**customer_currency** | **String** | 3 digit Customer currency code | [optional] 
+**credit_note_number** | **String** | Credit note number generated by DEAR. Is empty unless credit note is created | [optional] 
+**updated** | **Date** | Date when the sale was last created/updated last time | [optional] 
+**quote_status** | **String** | Sale Quote status. Possible Values are values | [optional] 
+**order_status** | **String** | Sale Order status. Possible Values are values | [optional] 
+**combined_picking_status** | **String** | Pick status. Possible Values are VOIDED, NOT AVAILABLE, PICKED, PICKING , NOT PICKED , PARTIALLY PICKED | [optional] 
+**combined_packing_status** | **String** | Pack status. Possible Values are VOIDED, NOT AVAILABLE, PACKED, PACKING, NOT PACKED, PARTIALLY PACKED | [optional] 
+**combined_shipping_status** | **String** | Ship status. Possible Values are VOIDED, NOT AVAILABLE, SHIPPED, SHIPPING , NOT SHIPPED , PARTIALLY SHIPPED | [optional] 
+**ful_filment_status** | **String** | Fulfilment status. Possible Values are FULFILLED, PARTIALLY FULFILLED, NOT AVAILABLE, NOT FULFILLED, VOIDED | [optional] 
+**combined_invoice_status** | **String** | Invoice status. Possible Values are VOIDED, DRAFT, AUTHORISED, NOT AVAILABLE, PAID | [optional] 
+**credit_note_status** | **String** | Credit Note status. Possible Values are VOIDED, DRAFT, AUTHORISED, NOT AVAILABLE | [optional] 
+**combined_payment_status** | **String** | Payment status. Possible Values are NOT REFUNDED, PREPAID, PARTIALLY PAID, UNPAID, PAID, VOIDED | [optional] 
+**type** | **String** | Type of Sale. Possible Values are Simple Sale, Advanced Sale , Service Sale | [optional] 
+**combined_tracking_numbers** | **String** | Tracking Numbers | [optional] 
+**source_channel** | **String** | Source of the sale. read-only field | [optional] 
+**external_id** | **String** | Custom field that is only available in API and allows to set arbitrary value for the sale for later search and any custom logic | [optional] 
+**order_location_id** | **String** | Sale Order Location ID | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::SaleItem.new(sale_id: nil,
+                                 order_number: nil,
+                                 status: nil,
+                                 order_date: nil,
+                                 invoice_date: nil,
+                                 customer: nil,
+                                 customer_id: nil,
+                                 invoice_number: nil,
+                                 customer_reference: nil,
+                                 invoice_amount: nil,
+                                 paid_amount: nil,
+                                 invoice_due_date: nil,
+                                 ship_by: nil,
+                                 base_currency: nil,
+                                 customer_currency: nil,
+                                 credit_note_number: nil,
+                                 updated: nil,
+                                 quote_status: nil,
+                                 order_status: nil,
+                                 combined_picking_status: nil,
+                                 combined_packing_status: nil,
+                                 combined_shipping_status: nil,
+                                 ful_filment_status: nil,
+                                 combined_invoice_status: nil,
+                                 credit_note_status: nil,
+                                 combined_payment_status: nil,
+                                 type: nil,
+                                 combined_tracking_numbers: nil,
+                                 source_channel: nil,
+                                 external_id: nil,
+                                 order_location_id: nil)
+```
+
+

data/docs/SaleList.md

@@ -0,0 +1,21 @@
+# DearInventoryRuby::SaleList
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **Float** | Total | [optional] 
+**page** | **Float** | Page | [optional] 
+**sale_list** | [**Array<SaleItem>**](SaleItem.md) | Array of SaleItem | [optional] 
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::SaleList.new(total: nil,
+                                 page: nil,
+                                 sale_list: nil)
+```
+
+

data/lib/dear-inventory-ruby/api/inventory_api.rb

@@ -1351,6 +1351,111 @@ module DearInventoryRuby
       return data, status_code, headers
     end
 
+    # Allows you to retrieve the Sales based on conditions
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :page Default is 1 (default to '1')
+    # @option opts [String] :limit Default is 100 (default to '100')
+    # @option opts [String] :search Only return sales with search value contained in one of these fields: OrderNumber, Status, Customer, invoiceNumber, CustomerReference, CreditNoteNumber
+    # @option opts [DateTime] :created_since Only return sales created after specified date. Date must follow ISO 8601 format.
+    # @option opts [DateTime] :updated_since Only return sales changed after specified date. Date must follow ISO 8601 format.
+    # @option opts [DateTime] :ship_by Only return sales with Ship By date on or before specified date, with not authorised Shipment. Date must follow ISO 8601 format.
+    # @option opts [String] :quote_status Only return sales with specified quote status
+    # @option opts [String] :order_status Only return sales with specified order status
+    # @option opts [String] :combined_pick_status Only return sales with specified CombinedPickingStatus
+    # @option opts [String] :combined_pack_status Only return sales with specified CombinedPackingStatus
+    # @option opts [String] :combined_shipping_status Only return sales with specified CombinedShippingStatus
+    # @option opts [String] :combined_invoice_status Only return sales with specified CombinedInvoiceStatus
+    # @option opts [String] :credit_note_status Only return sales with specified credit note status
+    # @option opts [String] :external_id Only return sales with specified External ID
+    # @option opts [String] :status Default is nil
+    # @option opts [Boolean] :ready_for_shipping Only return sales with 'Authorised' pack and not 'Authorised' shipping
+    # @option opts [String] :order_location_id Only return sales with specified Order Location ID
+    # @return [SaleList]
+    def get_sale_list(opts = {})
+      data, _status_code, _headers = get_sale_list_with_http_info(opts)
+      data
+    end
+
+    # Allows you to retrieve the Sales based on conditions
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :page Default is 1
+    # @option opts [String] :limit Default is 100
+    # @option opts [String] :search Only return sales with search value contained in one of these fields: OrderNumber, Status, Customer, invoiceNumber, CustomerReference, CreditNoteNumber
+    # @option opts [DateTime] :created_since Only return sales created after specified date. Date must follow ISO 8601 format.
+    # @option opts [DateTime] :updated_since Only return sales changed after specified date. Date must follow ISO 8601 format.
+    # @option opts [DateTime] :ship_by Only return sales with Ship By date on or before specified date, with not authorised Shipment. Date must follow ISO 8601 format.
+    # @option opts [String] :quote_status Only return sales with specified quote status
+    # @option opts [String] :order_status Only return sales with specified order status
+    # @option opts [String] :combined_pick_status Only return sales with specified CombinedPickingStatus
+    # @option opts [String] :combined_pack_status Only return sales with specified CombinedPackingStatus
+    # @option opts [String] :combined_shipping_status Only return sales with specified CombinedShippingStatus
+    # @option opts [String] :combined_invoice_status Only return sales with specified CombinedInvoiceStatus
+    # @option opts [String] :credit_note_status Only return sales with specified credit note status
+    # @option opts [String] :external_id Only return sales with specified External ID
+    # @option opts [String] :status Default is nil
+    # @option opts [Boolean] :ready_for_shipping Only return sales with 'Authorised' pack and not 'Authorised' shipping
+    # @option opts [String] :order_location_id Only return sales with specified Order Location ID
+    # @return [Array<(SaleList, Integer, Hash)>] SaleList data, response status code and response headers
+    def get_sale_list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InventoryApi.get_sale_list ...'
+      end
+      # resource path
+      local_var_path = '/saleList'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'Page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'Limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'Search'] = opts[:'search'] if !opts[:'search'].nil?
+      query_params[:'CreatedSince'] = opts[:'created_since'] if !opts[:'created_since'].nil?
+      query_params[:'UpdatedSince'] = opts[:'updated_since'] if !opts[:'updated_since'].nil?
+      query_params[:'ShipBy'] = opts[:'ship_by'] if !opts[:'ship_by'].nil?
+      query_params[:'QuoteStatus'] = opts[:'quote_status'] if !opts[:'quote_status'].nil?
+      query_params[:'OrderStatus'] = opts[:'order_status'] if !opts[:'order_status'].nil?
+      query_params[:'CombinedPickStatus'] = opts[:'combined_pick_status'] if !opts[:'combined_pick_status'].nil?
+      query_params[:'CombinedPackStatus'] = opts[:'combined_pack_status'] if !opts[:'combined_pack_status'].nil?
+      query_params[:'CombinedShippingStatus'] = opts[:'combined_shipping_status'] if !opts[:'combined_shipping_status'].nil?
+      query_params[:'CombinedInvoiceStatus'] = opts[:'combined_invoice_status'] if !opts[:'combined_invoice_status'].nil?
+      query_params[:'CreditNoteStatus'] = opts[:'credit_note_status'] if !opts[:'credit_note_status'].nil?
+      query_params[:'ExternalID'] = opts[:'external_id'] if !opts[:'external_id'].nil?
+      query_params[:'Status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'ReadyForShipping'] = opts[:'ready_for_shipping'] if !opts[:'ready_for_shipping'].nil?
+      query_params[:'OrderLocationID'] = opts[:'order_location_id'] if !opts[:'order_location_id'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'SaleList' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['accountID', 'appKey']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: InventoryApi#get_sale_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Allows you to retrieve the Sale Order
     # @param [Hash] opts the optional parameters
     # @option opts [String] :sale_id Unique DEAR Sale ID