nz_post_api 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db4c2d341925855b00d54c677d88820dfcb183e16bf3a92e12c284bbdc665f80
-  data.tar.gz: 6ffccabb911d0b5683984b45c75b5aea2392771452794c0572a65bae0fea8350
+  metadata.gz: e8ec46eab576b5d457acc5ba5476a9b31140871f1a67018946abe82e72e6bd6e
+  data.tar.gz: e21a327af35cebc7933043c19546a7496b7ff079f07166e24d790a0320d0112c
 SHA512:
-  metadata.gz: 4d66466023a5ae7a3d341218fe006cf25d022747bfc7dbf08be4a2026629982507cba8837b884609c68f1b11a3ca270484c13b50f4e43fb02e72683420ada83b
-  data.tar.gz: 2dac646484e52891d15da15f731625fb28a8fc1a389f54b2f3b66302f5f9b4f111fc8a5727a6ae516c90d51dba0c659944d67c3804a79290c4a4cec4e884a5b2
+  metadata.gz: 34298ff6a6da402e7eeb864b725d536ff1379db1105e7fc97d8a39e0de961775ff0fa6ab99202cee7a5fa834e5af57025987ccfcb712d05230937bfb7c50be5f
+  data.tar.gz: c28df5d11dee6594d65da67e00261b972c1bdf87d73d4ecae3d033f6791929fbc13db0d536eb42bf5c3c7683fba2c4fd34c4b97c1f707d8e8a3be43175f6911b

data/README.md

@@ -31,21 +31,25 @@ expires_in = token_response["expires_in"]
 > [!IMPORTANT]
 > The access token expires after a certain period (indicated by `expires_in`). It is highly recommended to cache the `access_token` and reuse it until it expires to avoid unnecessary API calls and potential rate limiting.
 
-Then, initialize the client with the access token.
+Then, configure the gem and initialize the client.
 
 ```ruby
-client = NzPostApi::Client.new(client_id: "YOUR_CLIENT_ID", access_token: access_token)
+NzPostApi.configure do |config|
+  config.client_id = "YOUR_CLIENT_ID"
+  config.access_token = access_token
+  config.prod = true # set to true for production, defaults to false (UAT)
+end
+
+client = NzPostApi::Client.new
 ```
 
 ### Configuration
 
-By default, the gem uses the UAT environment. To use the production environment, configure the gem as follows:
+By default, the gem uses the UAT environment. Configuration options:
 
-```ruby
-NzPostApi.configure do |config|
-  config.prod = true # set to true for production, defaults to false (UAT)
-end
-```
+- `client_id` – Your NZ Post API client ID (required for API calls)
+- `access_token` – Bearer token from `NzPostApi::Auth.fetch_token` (required for API calls)
+- `prod` – Set to `true` for production, `false` for UAT (default)
 
 ### Parcel Address
 
@@ -69,6 +73,10 @@ end
 
 Create a new parcel label.
 
+- **NZ Post rates**: To use your own NZ Post rates, include `account_number` and `site_code` in the payload.
+- **Notification endpoint**: The `notification_endpoint` is a webhook URL. NZ Post will send HTTP requests to this endpoint when the parcel label status is updated.
+- **Service codes** (in `parcel_details`): `CPOLP` is Overnight Returns (supports pickup); `EROLE` is Economy Returns (only drop off, the pickup address street must have the prefix "PO Box" or "Private Bag" followed by digits).
+
 ```ruby
 label_client = client.parcel_label
 

data/lib/nz_post_api/auth.rb

@@ -2,17 +2,20 @@
 
 require "faraday"
 require "json"
+require "uri"
 
 module NzPostApi
   class Auth
     TOKEN_URL = "https://oauth.nzpost.co.nz/as/token.oauth2"
 
     def self.fetch_token(client_id, client_secret)
-      response = Faraday.post(TOKEN_URL, {
+      params = {
         client_id: client_id,
         client_secret: client_secret,
         grant_type: "client_credentials"
-      })
+      }
+      url_with_params = "#{TOKEN_URL}?#{URI.encode_www_form(params)}"
+      response = Faraday.post(url_with_params, nil)
 
       if response.success?
         JSON.parse(response.body)

data/lib/nz_post_api/client.rb

@@ -4,11 +4,15 @@ require "faraday"
 
 module NzPostApi
   class Client
-    attr_reader :client_id, :access_token
+    def initialize
+    end
+
+    def client_id
+      NzPostApi.configuration.client_id
+    end
 
-    def initialize(client_id:, access_token:)
-      @client_id = client_id
-      @access_token = access_token
+    def access_token
+      NzPostApi.configuration.access_token
     end
 
     def connection

data/lib/nz_post_api/configuration.rb

@@ -2,10 +2,12 @@
 
 module NzPostApi
   class Configuration
-    attr_accessor :prod
+    attr_accessor :prod, :client_id, :access_token
 
     def initialize
       @prod = false
+      @client_id = nil
+      @access_token = nil
     end
 
     def base_url

data/lib/nz_post_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NzPostApi
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nz_post_api
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Andy Chong
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-02-02 00:00:00.000000000 Z
+date: 2026-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday