dear-inventory-ruby 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9154483cff09f52ccea1190aad3f720ecb126ebb9432e5ac24245da56070d4b4
-  data.tar.gz: 00b191ff3026645a0891f3c6e00bcd2bdfe8224a806962186b6f04fe0da91422
+  metadata.gz: 6548443c3a747000b4d565792f143837bb32cc147974ed0ac2e96bb29fe86f40
+  data.tar.gz: a74524ffba3f733f9a84b18e7bc20e8117bcb436e19ad5ac7e3c8a72faf8d6e3
 SHA512:
-  metadata.gz: 4b7cbcadbbc3fc0c3965621b0ec03db7b2a737986cbb5b64149ff97b5b45fc06c5303d43b3f769609ace79e913b600d3a6d5ef346598703dfcbfe36202b55eff
-  data.tar.gz: 115a13db7743709a4756a97444a832e62ee37863b4f87c9507fe806548b9789dde4d3ffa829b3324fb669dbf8b54afa3e7046bd1968aad6c27c02c7f4810eddc
+  metadata.gz: b1b01d683d52ad6fc9005104f3c11d7fcdd323b7da96b94cb3e0a2e541ade53428a723c1101f44bc03bc3d12bd03710aadd21d9d42e2b901914be56d29fba371
+  data.tar.gz: 1f4f254e6262b20ba9375b97e6b6ec78a84b47cd6ee875b6f0df4292089ec9c3f841e5f23a6d7fd48435879ac0cb9ebe6ae15f392e32be2d24884ed2e2ba1e5d

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.2.3] - 2021-10-15
+
+- Update `POST` response of the endpoint `/webhooks`
+- Add some enums `AuthorizationType`, `WebhookType`
+
+## [0.2.2] - 2021-10-15
+
+- Update `POST` of the endpoint `/webhooks`
+
 ## [0.2.1] - 2021-10-15
 
 - Update param `TaskID` for `DELETE` of the endpoint `/sale/invoice`

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.2
+- Package version: 0.2.3
 - 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.2.gem
+gem install ./dear-inventory-ruby-0.2.3.gem
 ```
 
-(for development, run `gem install --dev ./dear-inventory-ruby-0.2.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./dear-inventory-ruby-0.2.3.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.2'
+    gem 'dear-inventory-ruby', '~> 0.2.3'
 
 ### Install from Git
 
@@ -130,6 +130,7 @@ Class | Method | HTTP request | Description
  - [DearInventoryRuby::Account](docs/Account.md)
  - [DearInventoryRuby::Accounts](docs/Accounts.md)
  - [DearInventoryRuby::Address](docs/Address.md)
+ - [DearInventoryRuby::AuthorizationType](docs/AuthorizationType.md)
  - [DearInventoryRuby::Contact](docs/Contact.md)
  - [DearInventoryRuby::Customer](docs/Customer.md)
  - [DearInventoryRuby::Customers](docs/Customers.md)
@@ -159,6 +160,7 @@ Class | Method | HTTP request | Description
  - [DearInventoryRuby::TaxComponent](docs/TaxComponent.md)
  - [DearInventoryRuby::Taxes](docs/Taxes.md)
  - [DearInventoryRuby::Webhook](docs/Webhook.md)
+ - [DearInventoryRuby::WebhookType](docs/WebhookType.md)
  - [DearInventoryRuby::Webhooks](docs/Webhooks.md)
 
 

data/docs/AuthorizationType.md

@@ -0,0 +1,16 @@
+# DearInventoryRuby::AuthorizationType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::AuthorizationType.new()
+```
+
+

data/docs/InventoryApi.md

@@ -528,7 +528,7 @@ Name | Type | Description  | Notes
 
 ## create_webhook
 
-> Webhooks create_webhook(webhook, opts)
+> Webhook create_webhook(webhook, opts)
 
 Allows you to create a Webhook
 
@@ -575,7 +575,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**Webhooks**](Webhooks.md)
+[**Webhook**](Webhook.md)
 
 ### Authorization
 
@@ -1882,7 +1882,7 @@ Name | Type | Description  | Notes
 
 ## update_webhook
 
-> Webhooks update_webhook(webhook, opts)
+> Webhook update_webhook(webhook, opts)
 
 Allows you to update a webhook
 
@@ -1905,7 +1905,7 @@ DearInventoryRuby.configure do |config|
 end
 
 api_instance = DearInventoryRuby::InventoryApi.new
-webhook = { "ID": "1cf8cb83-bf39-494b-87f9-1252b684d6d5", "Type": "Sale/OrderAuthorised", "Name": "Sale order has been authorised", "IsActive": true, "ExternalURL": "https://hookb.in/Zn8950P7", "ExternalAuthorizationType": "basicauth", "ExternalUserName": "Hello", "ExternalPassword": "123", "ExternalBearerToken": null, "ExternalHeaders": [ { "Key": "Key", "Value": "123" }, { "Key": "6", "Value": "0" }, { "Key": "New Key", "Value": "New Value" } ] } # Webhook | a webhook object with properties to update
+webhook = { "ID": "1cf8cb83-bf39-494b-87f9-1252b684d6d5", "Type": "Sale/OrderAuthorised", "Name": "Sale order has been authorised", "IsActive": true, "ExternalURL": "https://hookb.in/Zn8950P7", "ExternalAuthorizationType": "basicauth", "ExternalUserName": "Hello", "ExternalPassword": "123", "ExternalBearerToken": nil, "ExternalHeaders": [ { "Key": "Key", "Value": "123" }, { "Key": "6", "Value": "0" }, { "Key": "New Key", "Value": "New Value" } ] } # Webhook | a webhook object with properties to update
 opts = {
   summarize_errors: false # Boolean | If false return 200 OK and mix of successfully created objects and any with validation errors
 }
@@ -1929,7 +1929,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**Webhooks**](Webhooks.md)
+[**Webhook**](Webhook.md)
 
 ### Authorization
 

data/docs/WebhookType.md

@@ -0,0 +1,16 @@
+# DearInventoryRuby::WebhookType
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'DearInventoryRuby'
+
+instance = DearInventoryRuby::WebhookType.new()
+```
+
+

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

@@ -543,7 +543,7 @@ module DearInventoryRuby
     # @param webhook [Webhook] a webhook object with properties to create
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false)
-    # @return [Webhooks]
+    # @return [Webhook]
     def create_webhook(webhook, opts = {})
       data, _status_code, _headers = create_webhook_with_http_info(webhook, opts)
       data
@@ -553,7 +553,7 @@ module DearInventoryRuby
     # @param webhook [Webhook] a webhook object with properties to create
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors
-    # @return [Array<(Webhooks, Integer, Hash)>] Webhooks data, response status code and response headers
+    # @return [Array<(Webhook, Integer, Hash)>] Webhook data, response status code and response headers
     def create_webhook_with_http_info(webhook, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: InventoryApi.create_webhook ...'
@@ -583,7 +583,7 @@ module DearInventoryRuby
       post_body = opts[:body] || @api_client.object_to_http_body(webhook) 
 
       # return_type
-      return_type = opts[:return_type] || 'Webhooks' 
+      return_type = opts[:return_type] || 'Webhook' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['accountID', 'appKey']
@@ -1929,7 +1929,7 @@ module DearInventoryRuby
     # @param webhook [Webhook] a webhook object with properties to update
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors (default to false)
-    # @return [Webhooks]
+    # @return [Webhook]
     def update_webhook(webhook, opts = {})
       data, _status_code, _headers = update_webhook_with_http_info(webhook, opts)
       data
@@ -1939,7 +1939,7 @@ module DearInventoryRuby
     # @param webhook [Webhook] a webhook object with properties to update
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors
-    # @return [Array<(Webhooks, Integer, Hash)>] Webhooks data, response status code and response headers
+    # @return [Array<(Webhook, Integer, Hash)>] Webhook data, response status code and response headers
     def update_webhook_with_http_info(webhook, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: InventoryApi.update_webhook ...'
@@ -1969,7 +1969,7 @@ module DearInventoryRuby
       post_body = opts[:body] || @api_client.object_to_http_body(webhook) 
 
       # return_type
-      return_type = opts[:return_type] || 'Webhooks' 
+      return_type = opts[:return_type] || 'Webhook' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['accountID', 'appKey']

data/lib/dear-inventory-ruby/models/authorization_type.rb

@@ -0,0 +1,37 @@
+=begin
+#DEAR Inventory API
+
+#This specifing endpoints for DEAR Inventory API
+
+The version of the OpenAPI document: 2.0.0
+Contact: nnhansg@gmail.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module DearInventoryRuby
+  class AuthorizationType
+    BASICAUTH = "basicauth".freeze
+    BEARERAUTH = "bearerauth".freeze
+    NOAUTH = "noauth".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = AuthorizationType.constants.select { |c| AuthorizationType::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #AuthorizationType" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/dear-inventory-ruby/models/webhook_type.rb

@@ -0,0 +1,54 @@
+=begin
+#DEAR Inventory API
+
+#This specifing endpoints for DEAR Inventory API
+
+The version of the OpenAPI document: 2.0.0
+Contact: nnhansg@gmail.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module DearInventoryRuby
+  class WebhookType
+    SALE_QUOTE_AUTHORISED = "Sale/QuoteAuthorised".freeze
+    SALE_ORDER_AUTHORISED = "Sale/OrderAuthorised".freeze
+    SALE_VOIDED = "Sale/Voided".freeze
+    SALE_BACKORDERED = "Sale/Backordered".freeze
+    SALE_SHIPMENT_AUTHORISED = "Sale/ShipmentAuthorised".freeze
+    SALE_INVOICE_AUTHORISED = "Sale/InvoiceAuthorised".freeze
+    SALE_PICK_AUTHORISED = "Sale/PickAuthorised".freeze
+    SALE_PACK_AUTHORISED = "Sale/PackAuthorised".freeze
+    SALE_CREDIT_NOTE_AUTHORISED = "Sale/CreditNoteAuthorised".freeze
+    SALE_UNDO = "Sale/Undo".freeze
+    SALE_PARTIAL_PAYMENT_RECEIVED = "Sale/PartialPaymentReceived".freeze
+    SALE_FULL_PAYMENT_RECEIVED = "Sale/FullPaymentReceived".freeze
+    SALE_SHIPMENT_TRACKING_NUMBER_CHANGED = "Sale/ShipmentTrackingNumberChanged".freeze
+    PURCHASE_ORDER_AUTHORISED = "Purchase/OrderAuthorised".freeze
+    PURCHASE_INVOICE_AUTHORISED = "Purchase/InvoiceAuthorised".freeze
+    PURCHASE_STOCK_RECEIVED_AUTHORISED = "Purchase/StockReceivedAuthorised".freeze
+    PURCHASE_CREDIT_NOTE_AUTHORISED = "Purchase/CreditNoteAuthorised".freeze
+    CUSTOMER_UPDATED = "Customer/Updated".freeze
+    SUPPLIER_UPDATED = "Supplier/Updated".freeze
+    STOCK_AVAILABLE_STOCK_LEVEL_CHANGED = "Stock/AvailableStockLevelChanged".freeze
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      constantValues = WebhookType.constants.select { |c| WebhookType::const_get(c) == value }
+      raise "Invalid ENUM value #{value} for class #WebhookType" if constantValues.empty?
+      value
+    end
+  end
+end

data/lib/dear-inventory-ruby/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module DearInventoryRuby
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/lib/dear-inventory-ruby.rb

@@ -20,6 +20,7 @@ require 'dear-inventory-ruby/configuration'
 require 'dear-inventory-ruby/models/account'
 require 'dear-inventory-ruby/models/accounts'
 require 'dear-inventory-ruby/models/address'
+require 'dear-inventory-ruby/models/authorization_type'
 require 'dear-inventory-ruby/models/contact'
 require 'dear-inventory-ruby/models/customer'
 require 'dear-inventory-ruby/models/customers'
@@ -49,6 +50,7 @@ require 'dear-inventory-ruby/models/tax'
 require 'dear-inventory-ruby/models/tax_component'
 require 'dear-inventory-ruby/models/taxes'
 require 'dear-inventory-ruby/models/webhook'
+require 'dear-inventory-ruby/models/webhook_type'
 require 'dear-inventory-ruby/models/webhooks'
 
 # APIs

data/spec/api/inventory_api_spec.rb

@@ -133,7 +133,7 @@ describe 'InventoryApi' do
   # @param webhook a webhook object with properties to create
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors
-  # @return [Webhooks]
+  # @return [Webhook]
   describe 'create_webhook test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
@@ -409,7 +409,7 @@ describe 'InventoryApi' do
   # @param webhook a webhook object with properties to update
   # @param [Hash] opts the optional parameters
   # @option opts [Boolean] :summarize_errors If false return 200 OK and mix of successfully created objects and any with validation errors
-  # @return [Webhooks]
+  # @return [Webhook]
   describe 'update_webhook test' do
     it 'should work' do
       # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers

data/spec/models/authorization_type_spec.rb

@@ -0,0 +1,35 @@
+=begin
+#DEAR Inventory API
+
+#This specifing endpoints for DEAR Inventory API
+
+The version of the OpenAPI document: 2.0.0
+Contact: nnhansg@gmail.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for DearInventoryRuby::AuthorizationType
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AuthorizationType' do
+  before do
+    # run before each test
+    @instance = DearInventoryRuby::AuthorizationType.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AuthorizationType' do
+    it 'should create an instance of AuthorizationType' do
+      expect(@instance).to be_instance_of(DearInventoryRuby::AuthorizationType)
+    end
+  end
+end

data/spec/models/webhook_type_spec.rb

@@ -0,0 +1,35 @@
+=begin
+#DEAR Inventory API
+
+#This specifing endpoints for DEAR Inventory API
+
+The version of the OpenAPI document: 2.0.0
+Contact: nnhansg@gmail.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for DearInventoryRuby::WebhookType
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'WebhookType' do
+  before do
+    # run before each test
+    @instance = DearInventoryRuby::WebhookType.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of WebhookType' do
+    it 'should create an instance of WebhookType' do
+      expect(@instance).to be_instance_of(DearInventoryRuby::WebhookType)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dear-inventory-ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Nhan Nguyen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2021-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -87,6 +87,7 @@ files:
 - docs/Account.md
 - docs/Accounts.md
 - docs/Address.md
+- docs/AuthorizationType.md
 - docs/Contact.md
 - docs/Customer.md
 - docs/Customers.md
@@ -117,6 +118,7 @@ files:
 - docs/TaxComponent.md
 - docs/Taxes.md
 - docs/Webhook.md
+- docs/WebhookType.md
 - docs/Webhooks.md
 - git_push.sh
 - lib/dear-inventory-ruby.rb
@@ -127,6 +129,7 @@ files:
 - lib/dear-inventory-ruby/models/account.rb
 - lib/dear-inventory-ruby/models/accounts.rb
 - lib/dear-inventory-ruby/models/address.rb
+- lib/dear-inventory-ruby/models/authorization_type.rb
 - lib/dear-inventory-ruby/models/contact.rb
 - lib/dear-inventory-ruby/models/customer.rb
 - lib/dear-inventory-ruby/models/customers.rb
@@ -156,6 +159,7 @@ files:
 - lib/dear-inventory-ruby/models/tax_component.rb
 - lib/dear-inventory-ruby/models/taxes.rb
 - lib/dear-inventory-ruby/models/webhook.rb
+- lib/dear-inventory-ruby/models/webhook_type.rb
 - lib/dear-inventory-ruby/models/webhooks.rb
 - lib/dear-inventory-ruby/version.rb
 - spec/api/inventory_api_spec.rb
@@ -164,6 +168,7 @@ files:
 - spec/models/account_spec.rb
 - spec/models/accounts_spec.rb
 - spec/models/address_spec.rb
+- spec/models/authorization_type_spec.rb
 - spec/models/contact_spec.rb
 - spec/models/customer_spec.rb
 - spec/models/customers_spec.rb
@@ -193,6 +198,7 @@ files:
 - spec/models/tax_spec.rb
 - spec/models/taxes_spec.rb
 - spec/models/webhook_spec.rb
+- spec/models/webhook_type_spec.rb
 - spec/models/webhooks_spec.rb
 - spec/spec_helper.rb
 homepage: https://inventory.dearsystems.com
@@ -245,12 +251,14 @@ test_files:
 - spec/models/sale_invoice_delete_spec.rb
 - spec/models/sale_payment_spec.rb
 - spec/models/sale_additional_charge_spec.rb
+- spec/models/webhook_type_spec.rb
 - spec/models/taxes_spec.rb
 - spec/models/accounts_spec.rb
 - spec/models/me_spec.rb
 - spec/models/shipping_address_spec.rb
 - spec/models/sale_order_spec.rb
 - spec/models/sale_invoice_additional_charge_spec.rb
+- spec/models/authorization_type_spec.rb
 - spec/models/sale_invoices_spec.rb
 - spec/models/sale_quote_spec.rb
 - spec/models/sale_quote_line_spec.rb