netsuite_api 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3974a301fe87a4275e736c4a8ba9baed955c95f19daebfc99a0415bf6c5a32f
-  data.tar.gz: 6ec6116a64a4a52e3b59cd66c9066bd68d140adab6527ed9647979a1de3af872
+  metadata.gz: a19005bb2dadcffb65d996a094dbf0f55c866531b46a4cf1201b1acc05e84699
+  data.tar.gz: abff7e2b360b63df02b2ebb9edb800d6ec7293d3337fa02c366623a8d98e4171
 SHA512:
-  metadata.gz: f6438fc9fb9225961945fdf572389357f03b97690e5984c9708fd11f85c4695c58b6a0c8388cde5a4b4d490ab27490b27cfee6b2672f92284586661a469ba1ad
-  data.tar.gz: c758d278fe44237943c066343c9c3d8bb62ac69720582179d278691ea3967dc833109bbf4e94e7cc2af7fd66db12a96d0b23718bf3793b89c979954bace242df
+  metadata.gz: d64199bf0624819643df0ac0b56f61da172274a96ebaa1b81b2713a97cfc99f8005fc5ab4d5d40ec07567b468f6cdf5df01ebbc01051556033643ea093b9ba5e
+  data.tar.gz: fb661b28e3c79df42d0116f7256d78bfba4f7e000c1b97256fd7ec9b43a847fa2ec1a7ef0f685c6d9c778d9c0c2531d7acf3892c9a87f378ac89c20697fcb573

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    netsuite_api (0.1.1)
-      activesupport (~> 6.0)
-      faraday (~> 2.0)
-      securerandom (~> 0.3)
+    netsuite_api (0.1.2)
+      activesupport
+      faraday
+      securerandom
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,14 +1,17 @@
 # NetsuiteApi
 
 This library is designed to help ruby/rails based applications communicate with the publicly available REST API for NetSuite.
+
 If you are unfamiliar with the NetSuite REST API, you should first read the documentation located at [SuiteTalk REST Web Services API Guide](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/book_1559132836.html).
 
+The NetSuite REST API document could be found at [NetSuite REST API Browser: Record API v1](https://system.netsuite.com/help/helpcenter/en_US/APIs/REST_API_Browser/record/v1/2024.1/index.html#tag-account)
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'netsuite_api'
+gem 'netsuite_api', '0.1.4'
 ```
 
 And then execute:
@@ -19,9 +22,106 @@ Or install it yourself as:
 
     $ gem install netsuite_api
 
-## Usage
+## Basic Usage
+
+### Setup Credential Information
+
+Set All the credential information in your project .env file
+```
+NETSUITE_HOST = ""
+NETSUITE_ACCOUNT_ID = ""
+NETSUITE_CONSUMER_KEY = ""
+NETSUITE_CONSUMER_SECRET = ""
+NETSUITE_TOKEN = ""
+NETSUITE_TOKEN_SECRET = ""
+NETSUITE_PDF_HOST =
+```
+
+or pass those information when initialize NetsuiteApi instance, for example, initializing NetsuiteApi::Invoice
+```
+NetsuiteApi::Invoice.new(netsuite_host: "", netsuite_pdf_host: "", account_id: "", consumer_key: "", token: "", token_secret: "", consumer_secret: "")
+```
+
+## NetsuiteApi Object Usage
+
+There are 7 objects could be used: `NetsuiteApi::Invoice`, `NetsuiteApi::CreditMemo`, `NetsuiteApi::Payment`, `NetsuiteApi::Customer`, `NetsuiteApi::Contact`, `NetsuiteApi::Vendor`, `NetsuiteApi::VendorBill`. 
+
+More information about the objects could be found in `lib/netsuite_api`.
+
+All the objects have method to get record, create data, update data, delete data in NetSuite through Netsuite REST API. 
+
+Following section shows an example of using `NetsuiteApi::Invoice`. The way to use other objects is similar.
+
+### Get data
+
+* Get a specific invoice data. 
+```
+service = NetsuiteApi::Invoice.new
+service.get(netsuite_invoice_id)
+```
+
+* Query some invoice data.
+```
+# query invoices which entity is 12
+
+service = NetsuiteApi::Invoice.new
+query_params = { "q" => "entity EQUAL 12" }
+service.query(query_params)
+```
+More information about the query parameters could be found in [Record Collection Filtering](https://docs.oracle.com/en/cloud/saas/netsuite/ns-online-help/section_1545222128.html#Record-Collection-Filtering)
+
+
+### Create data
+
+* Create an invoice
+```
+service = NetsuiteApi::Invoice.new
+params = {
+    "entity" => {
+        "id" => "12"
+    },
+    "postingperiod" => "121",
+    "item" => {
+        "items" => [
+            {
+                "amount" => 100.0,
+                "item" => {
+                    "id" => "26"
+                }
+            }
+        ]
+    },
+    "subsidiary" => {
+        "id" => "8"
+    },
+    "currency" => {
+        "id": "2"
+    }
+}
+service.create(invoice_params)
+```
+
+
+### Update data
+
+* Update an invoice
+```
+service = NetsuiteApi::Invoice.new
+update_params = { "otherRefNum": "1234" }
+invoice_id = 1
+service.update(invoice_id, update_params)
+```
+
+
+### Delete data
+
+* Delete an invoice
+```
+service = NetsuiteApi::Invoice.new
+invoice_id = 1
+service.delete(invoice_id)
+```
 
-TODO: Write usage instructions here
 
 ## Development
 
@@ -31,7 +131,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/netsuite_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/iceland101113/netsuite_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/netsuite_api/version.rb

@@ -1,3 +1,3 @@
 module NetsuiteApi
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

data/netsuite_api.gemspec

@@ -39,7 +39,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "webmock", "~> 3.0"
   # spec.add_development_dependency "pry", 
-  spec.add_dependency "faraday", "~> 2.0"
-  spec.add_dependency "activesupport", "~> 6.0"
-  spec.add_dependency "securerandom", "~> 0.3"
+  spec.add_dependency "faraday"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "securerandom"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: netsuite_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - HueiYi Lucy Cheng
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-07 00:00:00.000000000 Z
+date: 2024-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,44 +70,44 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: securerandom
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0'
 description: Ruby Library for NetSuite REST API. Originally developed by HueiYi Lucy
   Cheng.
 email: