accessgrid 0.1.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f95e77022beec6a20cd5a55350ff8cd5ad15233ec74d13b22d49587d8fafed9
-  data.tar.gz: 9c20b6923726a61c5865b9b58c7f55fe008e7756e0d99f800e2a6efaca3e18aa
+  metadata.gz: 05f4bc4f464d21efa501041653ae1252c64f6d5cca1a29b30394b51ea0cdd486
+  data.tar.gz: e26bba2fb9ccb37ecfaa5f32676453c9b5a5369b49d11f6cc2385a26345eead6
 SHA512:
-  metadata.gz: 5d48b2324e989be2ecb79c152b27cda9aae991990aa3de176cf080aee89ffed78c262fd06116fdfa3eb65da719031554a03065e7c6862d5c27c9329bc6104020
-  data.tar.gz: 9d5585bc8bccb446f0432fa6116d30ddfbac4a358638c5a3b9ee31e7f0879dfe3a55e46cde0793a282c8abc10cec12d0689ceb9a9a09ca75ea53193afce7eceb
+  metadata.gz: 181d498ca94e2514ecf4c5296acf2b4cb5d975efbd77cfa0915280dcc610b7860740cb58ad1d3909f5ca137a30ca610347e10de6d85608c72fbe022e31923eb4
+  data.tar.gz: d9ccd5c9bf41ba8f68415ea1ad9f72b68b48fa2799f76ce53726cd3fca93466a56e38fe6320b907c57cb67dbb7f8aac06674cd7cba7ac97a31ab44fb32d6ea11

data/README.md

@@ -1,6 +1,6 @@
-# AccessGrid SDK
+# ![AccessGrid Logo](accessgrid.png)
 
-A Ruby SDK for interacting with the [AccessGrid.com](https://www.accessgrid.com) API. This SDK provides a simple interface for managing NFC key cards and enterprise templates. Full docs at https://www.accessgrid.com/docs
+AccessGrid is a Ruby SDK for interacting with the [AccessGrid.com](https://www.accessgrid.com) API. This SDK provides a simple interface for managing NFC key cards and enterprise templates. Full docs at https://www.accessgrid.com/docs
 
 ## Installation
 
@@ -43,15 +43,25 @@ client = AccessGrid.new(account_id, secret_key)
 card = client.access_cards.issue(
   card_template_id: card_template_id,
   employee_id: "123456789",
-  card_number: "16187",
   tag_id: "DDEADB33FB00B5",
   full_name: "Employee name",
   email: "employee@yourwebsite.com",
   phone_number: "+19547212241",
   classification: "full_time",
-  start_date: "2025-01-31T22:46:25.601Z",
-  expiration_date: "2025-04-30T22:46:25.601Z",
-  employee_photo: "[image_in_base64_encoded_format]"
+  department: "Engineering",
+  location: "San Francisco",
+  site_name: "HQ Building A",
+  workstation: "4F-207",
+  mail_stop: "MS-401",
+  company_address: "123 Main St, San Francisco, CA 94105",
+  start_date: Time.now.utc.iso8601(3),
+  expiration_date: 3.months.from_now.utc.iso8601(3),
+  employee_photo: "[image_in_base64_encoded_format]",
+  title: "Engineering Manager",
+  metadata: {
+    "department": "engineering",
+    "badge_type": "contractor"
+  }
 )
 
 # Provision is an alias for issue (for backwards compatibility)
@@ -64,6 +74,22 @@ card = client.access_cards.provision(
 puts "Install URL: #{card.url}"
 ```
 
+#### Get a card
+
+```ruby
+card = client.access_cards.get(card_id: "0xc4rd1d")
+
+puts "Card ID: #{card.id}"
+puts "State: #{card.state}"
+puts "Full Name: #{card.full_name}"
+puts "Install URL: #{card.install_url}"
+puts "Expiration Date: #{card.expiration_date}"
+puts "Card Number: #{card.card_number}"
+puts "Site Code: #{card.site_code}"
+puts "Devices: #{card.devices.length}"
+puts "Metadata: #{card.metadata}"
+```
+
 #### Update a card
 
 ```ruby
@@ -111,27 +137,24 @@ client.access_cards.delete("0xc4rd1d")
 
 ```ruby
 template = client.console.create_template(
-  name: "Employee NFC key",
+  name: "Employee Access Pass",
   platform: "apple",
   use_case: "employee_badge",
   protocol: "desfire",
   allow_on_multiple_devices: true,
   watch_count: 2,
   iphone_count: 3,
-  design: {
-    background_color: "#FFFFFF",
-    label_color: "#000000",
-    label_secondary_color: "#333333",
-    background_image: "[image_in_base64_encoded_format]",
-    logo_image: "[image_in_base64_encoded_format]",
-    icon_image: "[image_in_base64_encoded_format]"
-  },
-  support_info: {
-    support_url: "https://help.yourcompany.com",
-    support_phone_number: "+1-555-123-4567",
-    support_email: "support@yourcompany.com",
-    privacy_policy_url: "https://yourcompany.com/privacy",
-    terms_and_conditions_url: "https://yourcompany.com/terms"
+  background_color: "#FFFFFF",
+  label_color: "#000000",
+  label_secondary_color: "#333333",
+  support_url: "https://help.yourcompany.com",
+  support_phone_number: "+1-555-123-4567",
+  support_email: "support@yourcompany.com",
+  privacy_policy_url: "https://yourcompany.com/privacy",
+  terms_and_conditions_url: "https://yourcompany.com/terms",
+  metadata: {
+    version: "2.1",
+    approval_status: "approved"
   }
 )
 ```
@@ -143,7 +166,6 @@ template = client.console.update_template(
   "0xd3adb00b5",
   {
     name: "Updated Employee NFC key",
-    allow_on_multiple_devices: true,
     watch_count: 2,
     iphone_count: 3,
     support_info: {
@@ -189,6 +211,199 @@ events = client.console.event_log(
 )
 ```
 
+#### List pass template pairs
+
+```ruby
+response = client.console.list_pass_template_pairs(page: 1, per_page: 20)
+
+response['card_template_pairs'].each do |pair|
+  puts "#{pair.name} (#{pair.id})"
+  puts "  iOS: #{pair.ios_template&.name}"
+  puts "  Android: #{pair.android_template&.name}"
+end
+
+puts response['pagination'] # { "current_page" => 1, "total_pages" => 5, ... }
+```
+
+#### List ledger items
+
+```ruby
+response = client.console.list_ledger_items(
+  page: 1,
+  per_page: 50,
+  start_date: '2025-01-01T00:00:00Z',
+  end_date: '2025-06-30T23:59:59Z'
+)
+
+response['ledger_items'].each do |item|
+  puts "#{item.kind}: #{item.amount} (#{item.created_at})"
+
+  if item.access_pass
+    puts "  Pass: #{item.access_pass.full_name} (#{item.access_pass.state})"
+    if item.access_pass.pass_template
+      puts "  Template: #{item.access_pass.pass_template.name}"
+    end
+  end
+end
+
+puts response['pagination'] # { "current_page" => 1, "total_pages" => 3, ... }
+```
+
+#### iOS In-App Provisioning Preflight
+
+```ruby
+response = client.console.ios_preflight(
+  card_template_id: "0xt3mp14t3-3x1d",
+  access_pass_ex_id: "0xp455-3x1d"
+)
+
+puts "Provisioning Credential ID: #{response.provisioning_credential_identifier}"
+puts "Sharing Instance ID: #{response.sharing_instance_identifier}"
+puts "Card Template ID: #{response.card_template_identifier}"
+puts "Environment ID: #{response.environment_identifier}"
+```
+
+### Webhooks
+
+#### Create a webhook
+
+```ruby
+webhook = client.console.webhooks.create(
+  name: 'Production',
+  url: 'https://example.com/webhooks',
+  subscribed_events: ['ag.access_pass.issued']
+)
+
+puts "Webhook created: #{webhook.id}"
+puts "Private key: #{webhook.private_key}"
+```
+
+#### List webhooks
+
+```ruby
+webhooks = client.console.webhooks.list
+
+webhooks.each do |webhook|
+  puts "ID: #{webhook.id}, Name: #{webhook.name}"
+end
+```
+
+#### Delete a webhook
+
+```ruby
+client.console.webhooks.delete('abc123')
+```
+
+### HID Organizations
+
+#### Create an HID org
+
+```ruby
+org = client.console.hid.orgs.create(
+  name: 'My Org',
+  full_address: '1 Main St, NY NY',
+  phone: '+1-555-0000',
+  first_name: 'Ada',
+  last_name: 'Lovelace'
+)
+
+puts "Created org: #{org.name} (ID: #{org.id})"
+puts "Slug: #{org.slug}"
+```
+
+#### List HID orgs
+
+```ruby
+orgs = client.console.hid.orgs.list
+
+orgs.each do |org|
+  puts "Org ID: #{org.id}, Name: #{org.name}, Slug: #{org.slug}"
+end
+```
+
+#### Activate an HID org
+
+```ruby
+result = client.console.hid.orgs.activate(
+  email: 'admin@example.com',
+  password: 'hid-password-123'
+)
+
+puts "Completed registration for org: #{result.name}"
+puts "Status: #{result.status}"
+```
+
+### Landing Pages
+
+#### List landing pages
+
+```ruby
+landing_pages = client.console.list_landing_pages
+
+landing_pages.each do |page|
+  puts "ID: #{page.id}, Name: #{page.name}, Kind: #{page.kind}"
+  puts "  Password Protected: #{page.password_protected}"
+  puts "  Logo URL: #{page.logo_url}" if page.logo_url
+end
+```
+
+#### Create a landing page
+
+```ruby
+landing_page = client.console.create_landing_page(
+  name: "Miami Office Access Pass",
+  kind: "universal",
+  additional_text: "Welcome to the Miami Office",
+  bg_color: "#f1f5f9",
+  allow_immediate_download: true
+)
+
+puts "Landing page created: #{landing_page.id}"
+puts "Name: #{landing_page.name}, Kind: #{landing_page.kind}"
+```
+
+#### Update a landing page
+
+```ruby
+landing_page = client.console.update_landing_page(
+  landing_page_id: "0xlandingpage1d",
+  name: "Updated Miami Office Access Pass",
+  additional_text: "Welcome! Tap below to get your access pass.",
+  bg_color: "#e2e8f0"
+)
+
+puts "Landing page updated: #{landing_page.id}"
+puts "Name: #{landing_page.name}"
+```
+
+### Credential Profiles
+
+#### List credential profiles
+
+```ruby
+profiles = client.console.credential_profiles.list
+
+profiles.each do |profile|
+  puts "ID: #{profile.id}, Name: #{profile.name}, AID: #{profile.aid}"
+end
+```
+
+#### Create a credential profile
+
+```ruby
+profile = client.console.credential_profiles.create(
+  name: 'Main Office Profile',
+  app_name: 'KEY-ID-main',
+  keys: [
+    { value: 'your_32_char_hex_master_key_here' },
+    { value: 'your_32_char_hex__read_key__here' }
+  ]
+)
+
+puts "Profile created: #{profile.id}"
+puts "AID: #{profile.aid}"
+```
+
 ## Configuration
 
 The SDK can be configured with a custom API endpoint:
@@ -226,7 +441,7 @@ end
 
 ## Requirements
 
-- Ruby 2.6 or higher
+- Ruby 2.19 or higher
 
 ## Security
 
@@ -246,6 +461,38 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/access-grid/accessgrid-rb.
 
+## Feature Matrix
+
+| Endpoint | Method | Supported |
+|---|---|:---:|
+| POST /v1/key-cards | `access_cards.issue()` | Y |
+| GET /v1/key-cards/{id} | `access_cards.get()` | Y |
+| PATCH /v1/key-cards/{id} | `access_cards.update()` | Y |
+| GET /v1/key-cards | `access_cards.list()` | Y |
+| POST /v1/key-cards/{id}/suspend | `access_cards.suspend()` | Y |
+| POST /v1/key-cards/{id}/resume | `access_cards.resume()` | Y |
+| POST /v1/key-cards/{id}/unlink | `access_cards.unlink()` | Y |
+| POST /v1/key-cards/{id}/delete | `access_cards.delete()` | Y |
+| POST /v1/console/card-templates | `console.create_template()` | Y |
+| PUT /v1/console/card-templates/{id} | `console.update_template()` | Y |
+| GET /v1/console/card-templates/{id} | `console.read_template()` | Y |
+| GET /v1/console/card-templates/{id}/logs | `console.get_logs()` / `console.event_log()` | Y |
+| GET /v1/console/card-template-pairs | `console.list_pass_template_pairs()` | Y |
+| POST /v1/console/card-template-pairs | `console.create_pass_template_pair()` | Y |
+| POST /v1/console/card-templates/{id}/ios_preflight | `console.ios_preflight()` | Y |
+| GET /v1/console/ledger-items | `console.list_ledger_items()` / `console.ledger_items()` | Y |
+| GET /v1/console/webhooks | `console.webhooks.list()` | Y |
+| POST /v1/console/webhooks | `console.webhooks.create()` | Y |
+| DELETE /v1/console/webhooks/{id} | `console.webhooks.delete()` | Y |
+| GET /v1/console/landing-pages | `console.list_landing_pages()` | Y |
+| POST /v1/console/landing-pages | `console.create_landing_page()` | Y |
+| PUT /v1/console/landing-pages/{id} | `console.update_landing_page()` | Y |
+| GET /v1/console/credential-profiles | `console.credential_profiles.list()` | Y |
+| POST /v1/console/credential-profiles | `console.credential_profiles.create()` | Y |
+| POST /v1/console/hid/orgs | `console.hid.orgs.create()` | Y |
+| POST /v1/console/hid/orgs/activate | `console.hid.orgs.activate()` | Y |
+| GET /v1/console/hid/orgs | `console.hid.orgs.list()` | Y |
+
 ## License
 
-The gem is available as open source under the terms of the MIT License.
+The gem is available as open source under the terms of the MIT License.

data/lib/accessgrid/access_cards.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 # lib/accessgrid/access_cards.rb
 module AccessGrid
+  # Manages NFC key card lifecycle operations.
   class AccessCards
     def initialize(client)
       @client = client
@@ -9,32 +12,28 @@ module AccessGrid
       response = @client.make_request(:post, '/v1/key-cards', params)
       Card.new(response)
     end
-    
+
     # Alias provision to issue for backward compatibility
     alias provision issue
 
+    def get(card_id:)
+      response = @client.make_request(:get, "/v1/key-cards/#{card_id}")
+      Card.new(response)
+    end
+
     def update(card_id, params)
       response = @client.make_request(:patch, "/v1/key-cards/#{card_id}", params)
       Card.new(response)
     end
-    
+
     def list(template_id, state = nil)
       params = { template_id: template_id }
       params[:state] = state if state
-      
+
       response = @client.make_request(:get, '/v1/key-cards', nil, params)
       response.fetch('keys', []).map { |item| Card.new(item) }
     end
 
-    private def manage_state(card_id, action)
-      response = @client.make_request(
-        :post, 
-        "/v1/key-cards/#{card_id}/#{action}", 
-        {}
-      )
-      Card.new(response)
-    end
-
     def suspend(card_id)
       manage_state(card_id, 'suspend')
     end
@@ -46,27 +45,56 @@ module AccessGrid
     def unlink(card_id)
       manage_state(card_id, 'unlink')
     end
-    
+
     def delete(card_id)
       manage_state(card_id, 'delete')
     end
+
+    private
+
+    def manage_state(card_id, action)
+      response = @client.make_request(
+        :post,
+        "/v1/key-cards/#{card_id}/#{action}"
+      )
+      Card.new(response)
+    end
   end
 
+  # Represents an NFC key card with its attributes and state.
   class Card
-    attr_reader :id, :state, :url, :full_name, :expiration_date
+    attr_reader :id, :state, :url, :install_url, :details, :full_name,
+                :expiration_date, :card_template_id, :card_number, :site_code,
+                :file_data, :direct_install_url, :devices, :metadata, :temporary,
+                :employee_id, :organization_name, :created_at
 
     def initialize(data)
-      @id = data['id']
-      @state = data['state']
-      @url = data['install_url']
-      @full_name = data['full_name']
-      @expiration_date = data['expiration_date']
+      data ||= {}
+      install_url = data.fetch('install_url', nil)
+      @id = data.fetch('id', nil)
+      @state = data.fetch('state', nil)
+      @url = install_url
+      @install_url = install_url
+      @details = data.fetch('details', nil)
+      @full_name = data.fetch('full_name', nil)
+      @expiration_date = data.fetch('expiration_date', nil)
+      @card_template_id = data.fetch('card_template_id', nil)
+      @card_number = data.fetch('card_number', nil)
+      @site_code = data.fetch('site_code', nil)
+      @file_data = data.fetch('file_data', nil)
+      @direct_install_url = data.fetch('direct_install_url', nil)
+      @devices = data.fetch('devices', [])
+      @metadata = data.fetch('metadata', {})
+      @temporary = data.fetch('temporary', nil)
+      @employee_id = data.fetch('employee_id', nil)
+      @organization_name = data.fetch('organization_name', nil)
+      @created_at = data.fetch('created_at', nil)
     end
-    
+
     def to_s
       "Card(name='#{@full_name}', id='#{@id}', state='#{@state}')"
     end
-    
+
     alias inspect to_s
   end
-end
+end

data/lib/accessgrid/console.rb

@@ -1,8 +1,16 @@
+# frozen_string_literal: true
+
 # lib/accessgrid/console.rb
 module AccessGrid
+  # Manages enterprise template and logging operations.
   class Console
+    attr_reader :webhooks, :hid, :credential_profiles
+
     def initialize(client)
       @client = client
+      @webhooks = Webhooks.new(client)
+      @hid = HID.new(client)
+      @credential_profiles = CredentialProfiles.new(client)
     end
 
     def create_template(params)
@@ -24,15 +32,13 @@ module AccessGrid
 
     def get_logs(template_id, params = {})
       response = @client.make_request(:get, "/v1/console/card-templates/#{template_id}/logs", nil, params)
-      
+
       # Return full response to match Python's behavior
-      if response['logs']
-        response['logs'] = response['logs'].map { |log| Event.new(log) }
-      end
-      
+      response['logs'] = response['logs'].map { |log| Event.new(log) } if response['logs']
+
       response
     end
-    
+
     # Keep event_log for backwards compatibility
     def event_log(params)
       template_id = params.delete(:card_template_id)
@@ -40,29 +46,75 @@ module AccessGrid
       response['logs'] || []
     end
 
+    def list_pass_template_pairs(params = {})
+      response = @client.make_request(:get, '/v1/console/card-template-pairs', nil, params)
+
+      if response['card_template_pairs']
+        response['card_template_pairs'] = response['card_template_pairs'].map { |pair| PassTemplatePair.new(pair) }
+      end
+
+      response
+    end
+
+    def create_pass_template_pair(params)
+      response = @client.make_request(:post, '/v1/console/card-template-pairs', params)
+      PassTemplatePair.new(response)
+    end
+
+    def list_ledger_items(params = {})
+      response = @client.make_request(:get, '/v1/console/ledger-items', nil, params)
+
+      if response['ledger_items']
+        response['ledger_items'] = response['ledger_items'].map { |item| LedgerItem.new(item) }
+      end
+
+      response
+    end
+
+    alias ledger_items list_ledger_items
+
+    def ios_preflight(card_template_id:, access_pass_ex_id:)
+      data = { access_pass_ex_id: access_pass_ex_id }
+      response = @client.make_request(:post, "/v1/console/card-templates/#{card_template_id}/ios_preflight", data)
+      IosPreflight.new(response)
+    end
+
+    def list_landing_pages
+      response = @client.make_request(:get, '/v1/console/landing-pages')
+      pages = response.is_a?(Array) ? response : response.fetch('landing_pages', [])
+      pages.map { |page| LandingPage.new(page) }
+    end
+
+    def create_landing_page(**params)
+      response = @client.make_request(:post, '/v1/console/landing-pages', params)
+      LandingPage.new(response)
+    end
+
+    def update_landing_page(landing_page_id:, **params)
+      response = @client.make_request(:put, "/v1/console/landing-pages/#{landing_page_id}", params)
+      LandingPage.new(response)
+    end
+
     private
 
     def transform_template_params(params)
-      design = params.delete(:design) || {}
-      support_info = params.delete(:support_info) || {}
-      
-      params.merge(
-        background_color: design[:background_color],
-        label_color: design[:label_color],
-        label_secondary_color: design[:label_secondary_color],
-        support_url: support_info[:support_url],
-        support_phone_number: support_info[:support_phone_number],
-        support_email: support_info[:support_email],
-        privacy_policy_url: support_info[:privacy_policy_url],
-        terms_and_conditions_url: support_info[:terms_and_conditions_url]
-      )
+      design = params.delete(:design)
+      support_info = params.delete(:support_info)
+
+      # Only merge nested keys if they were provided (backward compat)
+      params.merge!(design) if design
+      params.merge!(support_info) if support_info
+
+      params
     end
   end
 
+  # Represents a card template configuration.
   class Template
-    attr_reader :id, :name, :platform, :protocol, :use_case, :created_at, 
+    attr_reader :id, :name, :platform, :protocol, :use_case, :created_at,
                 :last_published_at, :issued_keys_count, :active_keys_count,
-                :allowed_device_counts, :support_settings, :terms_settings, :style_settings
+                :allowed_device_counts, :support_settings, :terms_settings, :style_settings,
+                :metadata
 
     def initialize(data)
       @id = data['id']
@@ -78,19 +130,251 @@ module AccessGrid
       @support_settings = data['support_settings']
       @terms_settings = data['terms_settings']
       @style_settings = data['style_settings']
+      @metadata = data['metadata'] || {}
     end
   end
 
+  # Represents a template activity log event.
   class Event
     attr_reader :type, :timestamp, :user_id, :ip_address, :user_agent, :metadata
 
     def initialize(data)
+      metadata = data['metadata']
       @type = data['event']
       @timestamp = data['created_at']
-      @user_id = data['metadata']['user_id'] if data['metadata'] && data['metadata']['user_id']
+      @user_id = metadata['user_id'] if metadata && metadata['user_id']
       @ip_address = data['ip_address']
       @user_agent = data['user_agent']
+      @metadata = metadata
+    end
+  end
+
+  # Represents a paired iOS and Android template configuration.
+  class PassTemplatePair
+    attr_reader :id, :name, :created_at, :android_template, :ios_template
+
+    def initialize(data)
+      android_template = data['android_template']
+      ios_template = data['ios_template']
+      @id = data['id']
+      @name = data['name']
+      @created_at = data['created_at']
+      @android_template = android_template ? TemplateInfo.new(android_template) : nil
+      @ios_template = ios_template ? TemplateInfo.new(ios_template) : nil
+    end
+  end
+
+  # Minimal template info used within PassTemplatePair.
+  class TemplateInfo
+    attr_reader :id, :name, :platform
+
+    def initialize(data)
+      @id = data['id']
+      @name = data['name']
+      @platform = data['platform']
+    end
+  end
+
+  # Represents an iOS In-App Provisioning preflight response.
+  class IosPreflight
+    attr_reader :provisioning_credential_identifier, :sharing_instance_identifier,
+                :card_template_identifier, :environment_identifier
+
+    def initialize(data)
+      @provisioning_credential_identifier = data['provisioningCredentialIdentifier']
+      @sharing_instance_identifier = data['sharingInstanceIdentifier']
+      @card_template_identifier = data['cardTemplateIdentifier']
+      @environment_identifier = data['environmentIdentifier']
+    end
+  end
+
+  # Represents a billing ledger item.
+  class LedgerItem
+    attr_reader :created_at, :amount, :id, :kind, :metadata, :access_pass
+
+    def initialize(data)
+      @created_at = data['created_at']
+      @amount = data['amount']
+      @id = data['id']
+      @kind = data['kind']
+      @metadata = data['metadata']
+      @access_pass = data['access_pass'] ? LedgerItemAccessPass.new(data['access_pass']) : nil
+    end
+  end
+
+  # Represents an access pass reference within a ledger item.
+  class LedgerItemAccessPass
+    attr_reader :id, :full_name, :state, :metadata, :unified_access_pass_ex_id, :pass_template
+
+    def initialize(data)
+      @id = data['id']
+      @full_name = data['full_name']
+      @state = data['state']
       @metadata = data['metadata']
+      @unified_access_pass_ex_id = data['unified_access_pass_ex_id']
+      @pass_template = data['pass_template'] ? LedgerItemPassTemplate.new(data['pass_template']) : nil
+    end
+  end
+
+  # Represents a pass template reference within a ledger item's access pass.
+  class LedgerItemPassTemplate
+    attr_reader :id, :name, :protocol, :platform, :use_case
+
+    def initialize(data)
+      @id = data['id']
+      @name = data['name']
+      @protocol = data['protocol']
+      @platform = data['platform']
+      @use_case = data['use_case']
+    end
+  end
+
+  # Represents a landing page configuration.
+  class LandingPage
+    attr_reader :id, :name, :created_at, :kind, :password_protected, :logo_url
+
+    def initialize(data)
+      @id = data['id']
+      @name = data['name']
+      @created_at = data['created_at']
+      @kind = data['kind']
+      @password_protected = data['password_protected']
+      @logo_url = data['logo_url']
+    end
+  end
+
+  # Represents a credential profile configuration.
+  class CredentialProfile
+    attr_reader :id, :aid, :name, :apple_id, :created_at, :card_storage, :keys, :files
+
+    def initialize(data)
+      @id = data['id']
+      @aid = data['aid']
+      @name = data['name']
+      @apple_id = data['apple_id']
+      @created_at = data['created_at']
+      @card_storage = data['card_storage']
+      @keys = data['keys'] || []
+      @files = data['files'] || []
+    end
+  end
+
+  # Manages credential profile operations.
+  class CredentialProfiles
+    def initialize(client)
+      @client = client
+    end
+
+    def create(**params)
+      response = @client.make_request(:post, '/v1/console/credential-profiles', params)
+      CredentialProfile.new(response)
+    end
+
+    def list
+      response = @client.make_request(:get, '/v1/console/credential-profiles')
+      profiles = response.is_a?(Array) ? response : response.fetch('credential_profiles', [])
+      profiles.map { |profile| CredentialProfile.new(profile) }
+    end
+  end
+
+  # Manages webhook operations.
+  class Webhooks
+    def initialize(client)
+      @client = client
+    end
+
+    def create(name:, url:, subscribed_events:, auth_method: 'bearer_token')
+      data = {
+        name: name,
+        url: url,
+        subscribed_events: subscribed_events,
+        auth_method: auth_method
+      }
+      response = @client.make_request(:post, '/v1/console/webhooks', data)
+      Webhook.new(response)
+    end
+
+    def list(**params)
+      response = @client.make_request(:get, '/v1/console/webhooks', nil, params)
+      (response['webhooks'] || []).map { |wh| Webhook.new(wh) }
+    end
+
+    def delete(webhook_id)
+      @client.make_request(:delete, "/v1/console/webhooks/#{webhook_id}")
+    end
+  end
+
+  # Represents a webhook configuration.
+  class Webhook
+    attr_reader :id, :name, :url, :auth_method, :subscribed_events,
+                :created_at, :private_key, :client_cert, :cert_expires_at
+
+    def initialize(data)
+      @id = data['id']
+      @name = data['name']
+      @url = data['url']
+      @auth_method = data['auth_method']
+      @subscribed_events = data['subscribed_events']
+      @created_at = data['created_at']
+      @private_key = data['private_key']
+      @client_cert = data['client_cert']
+      @cert_expires_at = data['cert_expires_at']
+    end
+  end
+
+  # Provides access to HID-related services.
+  class HID
+    attr_reader :orgs
+
+    def initialize(client)
+      @orgs = HIDOrgs.new(client)
+    end
+  end
+
+  # Manages HID organization operations.
+  class HIDOrgs
+    def initialize(client)
+      @client = client
+    end
+
+    def create(name:, full_address:, phone:, first_name:, last_name:)
+      data = {
+        name: name,
+        full_address: full_address,
+        phone: phone,
+        first_name: first_name,
+        last_name: last_name
+      }
+      response = @client.make_request(:post, '/v1/console/hid/orgs', data)
+      HidOrg.new(response)
+    end
+
+    def list
+      response = @client.make_request(:get, '/v1/console/hid/orgs')
+      response.map { |org| HidOrg.new(org) }
+    end
+
+    def activate(email:, password:)
+      data = { email: email, password: password }
+      response = @client.make_request(:post, '/v1/console/hid/orgs/activate', data)
+      HidOrg.new(response)
+    end
+  end
+
+  # Represents an HID organization.
+  class HidOrg
+    attr_reader :id, :name, :slug, :first_name, :last_name, :phone, :full_address, :status, :created_at
+
+    def initialize(data)
+      @id = data['id']
+      @name = data['name']
+      @slug = data['slug']
+      @first_name = data['first_name']
+      @last_name = data['last_name']
+      @phone = data['phone']
+      @full_address = data['full_address']
+      @status = data['status']
+      @created_at = data['created_at']
     end
   end
-end
+end

data/lib/accessgrid/error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module AccessGrid
+  # base error
+  class Error < StandardError; end
+
+  # Raised when API credentials are invalid.
+  class AuthenticationError < Error; end
+
+  # Raised when a requested resource does not exist.
+  class ResourceNotFoundError < Error; end
+
+  # Raised when request parameters fail validation.
+  class ValidationError < Error; end
+
+  # additional error classes to match Python version
+  class AccessGridError < Error; end
+end

data/lib/accessgrid/request.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require 'uri'
+
+module AccessGrid
+  # Builds and configures HTTP requests for the AccessGrid API.
+  class Request
+    PAYLOAD_SIGNATURE_PARAM = :sig_payload
+    HTTP_METHODS = {
+      get: Net::HTTP::Get,
+      post: Net::HTTP::Post,
+      put: Net::HTTP::Put,
+      patch: Net::HTTP::Patch,
+      delete: Net::HTTP::Delete
+    }.freeze
+
+    attr_reader :account_id, :body, :http_method, :params, :payload, :uri
+
+    def initialize(attrs)
+      # required attributes
+      @http_method = attrs.fetch(:http_method)
+      @provided_host = attrs.fetch(:host)
+      @provided_path = attrs.fetch(:path)
+
+      # optional attributes
+      @account_id = attrs.fetch(:account_id, nil)
+      @body = attrs.fetch(:body, nil)
+      @params = attrs.fetch(:params, nil) || {}
+
+      # computed attributes
+      initialize_payload
+      initialize_uri
+    end
+
+    def net_http_request
+      return @net_http_request if defined?(@net_http_request)
+
+      @net_http_request = generate_net_http_request!.tap do |req|
+        req['Content-Type'] = 'application/json'
+        req['X-ACCT-ID'] = account_id
+        req['User-Agent'] = "accessgrid.rb @ v#{AccessGrid::VERSION}"
+
+        req.body = body.to_json if body && !get?
+      end
+    end
+
+    private
+
+    def generate_net_http_request!
+      klass = HTTP_METHODS.fetch(http_method) do
+        raise ArgumentError, "Unsupported HTTP method: #{http_method}"
+      end
+      klass.new(uri.request_uri)
+    end
+
+    def initialize_payload
+      return @payload if defined?(@payload)
+      return @payload = default_payload unless post_without_body_or_get?
+
+      if resource_id
+        @payload = { id: resource_id }.to_json
+        @params[PAYLOAD_SIGNATURE_PARAM] = @payload
+      else
+        @payload = '{}'
+      end
+
+      @payload
+    end
+
+    def initialize_uri
+      @uri = URI.parse("#{@provided_host}#{@provided_path}").tap do |parsed_uri|
+        parsed_uri.query = URI.encode_www_form(@params) if @params.any?
+      end
+    end
+
+    def resource_id
+      return @resource_id if defined?(@resource_id)
+      return @resource_id = nil unless post_without_body_or_get?
+
+      parts = @provided_path.strip.split('/')
+      return @resource_id = nil unless parts.length >= 2
+
+      last_part = parts.last
+      second_to_last_part = parts[-2]
+      @resource_id = %w[suspend resume unlink delete].include?(last_part) ? second_to_last_part : last_part
+    end
+
+    def get?
+      http_method == :get
+    end
+
+    def delete?
+      http_method == :delete
+    end
+
+    def post?
+      http_method == :post
+    end
+
+    def empty_body?
+      body.nil? || body.empty?
+    end
+
+    def post_without_body_or_get?
+      get? || delete? || (post? && empty_body?)
+    end
+
+    def default_payload
+      body&.to_json || ''
+    end
+  end
+end

data/lib/accessgrid/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 # lib/accessgrid/version.rb
 module AccessGrid
-  VERSION = '0.1.3'
-end
+  VERSION = '0.4.0'
+end

data/lib/accessgrid.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # lib/accessgrid.rb
 require 'base64'
 require 'json'
@@ -5,171 +7,97 @@ require 'net/http'
 require 'openssl'
 require 'uri'
 
-require_relative 'accessgrid/version'
 require_relative 'accessgrid/access_cards'
 require_relative 'accessgrid/console'
+require_relative 'accessgrid/error'
+require_relative 'accessgrid/request'
+require_relative 'accessgrid/version'
 
+# Ruby SDK for the AccessGrid API.
 module AccessGrid
-  class Error < StandardError; end
-  class AuthenticationError < Error; end
-  class ResourceNotFoundError < Error; end
-  class ValidationError < Error; end
-  
-  # Additional error classes to match Python version
-  class AccessGridError < Error; end
-  
+  # API client for AccessGrid key card and template management.
   class Client
-    attr_reader :account_id, :api_secret, :api_host
-    
+    attr_reader :access_cards, :account_id, :api_secret, :api_host, :console
+
     def initialize(account_id, api_secret, api_host = 'https://api.accessgrid.com')
-      if account_id.nil? || account_id.empty?
-        raise ArgumentError, "Account ID is required"
-      end
-      
-      if api_secret.nil? || api_secret.empty?
-        raise ArgumentError, "API Secret is required"
-      end
-      
+      raise ArgumentError, 'Account ID is required' if account_id.nil? || account_id.empty?
+      raise ArgumentError, 'API Secret is required' if api_secret.nil? || api_secret.empty?
+
       @account_id = account_id
       @api_secret = api_secret
       @api_host = api_host.chomp('/')
+      @access_cards = AccessCards.new(self)
+      @console = Console.new(self)
     end
 
-    def access_cards
-      @access_cards ||= AccessCards.new(self)
-    end
+    def make_request(method, path, body = nil, params = nil)
+      request = Request.new(
+        account_id: account_id,
+        body: body,
+        host: api_host,
+        http_method: method,
+        params: params,
+        path: path
+      )
 
-    def console
-      @console ||= Console.new(self)
+      execute_and_process_request!(request)
     end
 
-    def make_request(method, path, body = nil, params = nil)
-      uri = URI.parse("#{api_host}#{path}")
-      
-      # Add query parameters if present
-      if params && !params.empty?
-        uri.query = URI.encode_www_form(params)
-      end
-      
-      http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = uri.scheme == 'https'
-
-      # Create request object based on method
-      request = case method
-      when :get
-        Net::HTTP::Get.new(uri.request_uri)
-      when :post
-        Net::HTTP::Post.new(uri.request_uri)
-      when :put
-        Net::HTTP::Put.new(uri.request_uri)
-      when :patch
-        Net::HTTP::Patch.new(uri.request_uri)
-      else
-        raise ArgumentError, "Unsupported HTTP method: #{method}"
-      end
+    private
+
+    def execute_and_process_request!(request)
+      # set up net http
+      uri = request.uri
+      http = Net::HTTP.new(uri.host, uri.port).tap { |http| http.use_ssl = uri.scheme == 'https' }
 
-      # Set headers
-      request['Content-Type'] = 'application/json'
-      request['X-ACCT-ID'] = account_id
-      request['User-Agent'] = "accessgrid.rb @ v#{AccessGrid::VERSION}"
-      
-      # Extract resource ID from the path if needed for signature
-      resource_id = nil
-      if method == :get || (method == :post && (body.nil? || body.empty?))
-        parts = path.strip.split('/')
-        if parts.length >= 2
-          if ['suspend', 'resume', 'unlink', 'delete'].include?(parts.last)
-            resource_id = parts[-2]
-          else
-            resource_id = parts.last
-          end
-        end
-      end
-      
-      # Handle signature generation
-      if method == :get || (method == :post && (body.nil? || body.empty?))
-        payload = resource_id ? { id: resource_id }.to_json : '{}'
-        
-        # Include sig_payload in query params if needed
-        if resource_id
-          if params.nil?
-            params = {}
-          end
-          params[:sig_payload] = { id: resource_id }.to_json
-          
-          # Update the URI with the new params
-          uri.query = URI.encode_www_form(params)
-          request = case method
-          when :get
-            Net::HTTP::Get.new(uri.request_uri)
-          when :post
-            Net::HTTP::Post.new(uri.request_uri)
-          end
-          
-          # Reset headers after creating new request
-          request['Content-Type'] = 'application/json'
-          request['X-ACCT-ID'] = account_id
-          request['User-Agent'] = "accessgrid.rb @ v#{AccessGrid::VERSION}"
-        end
-      else
-        payload = body ? body.to_json : ""
-      end
-      
       # Generate signature
-      request['X-PAYLOAD-SIG'] = generate_signature(payload)
-      
-      # Add the body to the request
-      if body && method != :get
-        request.body = body.to_json
-      end
+      net_http_request = request.net_http_request
+      net_http_request['X-PAYLOAD-SIG'] = generate_signature_hash(request.payload)
 
       # Make request
-      response = http.request(request)
-      
+      response = http.request(net_http_request)
+
       # Parse response
       handle_response(response)
     end
 
-    private
-
-    def generate_signature(payload)
-      # Base64 encode the payload
-      encoded_payload = Base64.strict_encode64(payload.to_s)
-      
-      # Generate SHA256 hash
-      OpenSSL::HMAC.hexdigest(
-        OpenSSL::Digest.new('sha256'),
-        api_secret,
-        encoded_payload
-      )
-    end
-
     def handle_response(response)
       case response.code.to_i
-      when 200, 201, 202
-        JSON.parse(response.body)
-      when 401
-        raise AuthenticationError, 'Invalid credentials'
-      when 402
-        raise Error, 'Insufficient account balance'
-      when 404
-        raise ResourceNotFoundError, 'Resource not found'
-      when 422
-        raise ValidationError, JSON.parse(response.body)['message']
+      when 204 then {}
+      when 200, 201, 202 then JSON.parse(response.body)
+      when 401 then raise AuthenticationError, 'Invalid credentials'
+      when 402 then raise Error, 'Insufficient account balance'
+      when 404 then raise ResourceNotFoundError, 'Resource not found'
+      when 422 then raise ValidationError, JSON.parse(response.body)['message']
       else
-        error_message = response.body.empty? ? "HTTP Status #{response.code}" : response.body
-        begin
-          error_data = JSON.parse(response.body)
-          error_message = error_data['message'] if error_data['message']
-        rescue JSON::ParserError
-          # If it's not valid JSON, just use the response body
-        end
-        raise Error, "API request failed: #{error_message}"
+        process_unhandled_response(response)
       end
     end
+
+    def process_unhandled_response(response)
+      body = response.body
+      error_message = body.empty? ? "HTTP Status #{response.code}" : body
+
+      begin
+        error_data = JSON.parse(body)
+        error_message = error_data['message'] if error_data['message']
+      rescue JSON::ParserError
+        # If it's not valid JSON, just use the response body
+      end
+
+      raise Error, "API request failed: #{error_message}"
+    end
+
+    def generate_signature_hash(value)
+      # Base64 encode the value
+      encoded_value = Base64.strict_encode64(value.to_s)
+
+      # Generate SHA256 hash
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), api_secret, encoded_value)
+    end
   end
 
   def self.new(account_id, api_secret, api_host = 'https://api.accessgrid.com')
     Client.new(account_id, api_secret, api_host)
   end
-end
+end

metadata

@@ -1,71 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: accessgrid
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Auston Bunsen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-26 00:00:00.000000000 Z
+date: 2026-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 description: A Ruby client for the AccessGrid API
 email:
 - ab@accessgrid.com
@@ -78,6 +36,8 @@ files:
 - lib/accessgrid.rb
 - lib/accessgrid/access_cards.rb
 - lib/accessgrid/console.rb
+- lib/accessgrid/error.rb
+- lib/accessgrid/request.rb
 - lib/accessgrid/version.rb
 homepage: https://github.com/access-grid/accessgrid-rb
 licenses:
@@ -92,7 +52,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="