netsuite_api 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 007d3e8a1e0314c293ea7be440ec1565a58442402f783416ec6c62977424773d
-  data.tar.gz: 72420ff8f2a764d7eb5278e76ddfee5ed1f17eb3039277cdeb166f25503a88a9
+  metadata.gz: a19005bb2dadcffb65d996a094dbf0f55c866531b46a4cf1201b1acc05e84699
+  data.tar.gz: abff7e2b360b63df02b2ebb9edb800d6ec7293d3337fa02c366623a8d98e4171
 SHA512:
-  metadata.gz: fa6d2859d5376a90bb0a5808e902dcbd5c3dd77c0cb89f1c1b2df1a56c1edf743f5a4a8b37e77ee4a43d2c97bba829a96f9baf297e85feec51c3563ca4a0a346
-  data.tar.gz: 74aeef7a92fa667dc3a10fdd2594fa827d5a8b8d73db536899f0079dbac80ec9b61b168031a7d1fd9d99a671f32be28f0666f85474e4fdff1f459544548ce87c
+  metadata.gz: d64199bf0624819643df0ac0b56f61da172274a96ebaa1b81b2713a97cfc99f8005fc5ab4d5d40ec07567b468f6cdf5df01ebbc01051556033643ea093b9ba5e
+  data.tar.gz: fb661b28e3c79df42d0116f7256d78bfba4f7e000c1b97256fd7ec9b43a847fa2ec1a7ef0f685c6d9c778d9c0c2531d7acf3892c9a87f378ac89c20697fcb573

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.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: netsuite_api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  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