attio 0.2.0 → 0.3.0

data/lib/attio/resources/deals.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module Attio
+  module Resources
+    # Deals resource for managing sales opportunities
+    #
+    # @example List all deals
+    #   client.deals.list
+    #
+    # @example Create a new deal
+    #   client.deals.create(
+    #     data: {
+    #       name: "Enterprise Contract",
+    #       value: 50000,
+    #       stage_id: "stage_123",
+    #       company_id: "company_456"
+    #     }
+    #   )
+    #
+    # @example Update deal stage
+    #   client.deals.update_stage(id: "deal_123", stage_id: "stage_won")
+    class Deals < Base
+      # List all deals
+      #
+      # @param params [Hash] Optional query parameters
+      # @option params [Hash] :filter Filter conditions
+      # @option params [Array<Hash>] :sorts Sort criteria
+      # @option params [Integer] :limit Maximum number of results
+      # @option params [String] :offset Pagination offset
+      # @return [Hash] The API response
+      def list(params = {})
+        request(:get, "objects/deals/records", params)
+      end
+
+      # Get a specific deal
+      #
+      # @param id [String] The deal ID
+      # @return [Hash] The deal data
+      def get(id:)
+        validate_id!(id, "Deal")
+        request(:get, "objects/deals/records/#{id}")
+      end
+
+      # Create a new deal
+      #
+      # @param data [Hash] The deal data
+      # @option data [String] :name The deal name (required)
+      # @option data [Float] :value The deal value
+      # @option data [String] :stage_id The stage ID
+      # @option data [String] :company_id Associated company ID
+      # @option data [String] :owner_id The owner user ID
+      # @option data [Date] :close_date Expected close date
+      # @option data [String] :currency Currency code (USD, EUR, etc.)
+      # @option data [Float] :probability Win probability (0-100)
+      # @return [Hash] The created deal
+      def create(data:)
+        validate_required_hash!(data, "Data")
+        validate_required_string!(data[:name], "Deal name")
+
+        request(:post, "objects/deals/records", { data: data })
+      end
+
+      # Update a deal
+      #
+      # @param id [String] The deal ID to update
+      # @param data [Hash] The data to update
+      # @return [Hash] The updated deal
+      def update(id:, data:)
+        validate_id!(id, "Deal")
+        validate_required_hash!(data, "Data")
+
+        request(:patch, "objects/deals/records/#{id}", { data: data })
+      end
+
+      # Delete a deal
+      #
+      # @param id [String] The deal ID to delete
+      # @return [Hash] Confirmation of deletion
+      def delete(id:)
+        validate_id!(id, "Deal")
+        request(:delete, "objects/deals/records/#{id}")
+      end
+
+      # Update a deal's stage
+      #
+      # @param id [String] The deal ID
+      # @param stage_id [String] The new stage ID
+      # @return [Hash] The updated deal
+      def update_stage(id:, stage_id:)
+        validate_id!(id, "Deal")
+        validate_required_string!(stage_id, "Stage")
+
+        update(id: id, data: { stage_id: stage_id })
+      end
+
+      # Mark a deal as won
+      #
+      # @param id [String] The deal ID
+      # @param won_date [Date, String] The date the deal was won (defaults to today)
+      # @param actual_value [Float] The actual value (optional, defaults to deal value)
+      # @return [Hash] The updated deal
+      def mark_won(id:, won_date: nil, actual_value: nil)
+        validate_id!(id, "Deal")
+
+        data = { status: "won" }
+        data[:won_date] = won_date if won_date
+        data[:actual_value] = actual_value if actual_value
+
+        update(id: id, data: data)
+      end
+
+      # Mark a deal as lost
+      #
+      # @param id [String] The deal ID
+      # @param lost_reason [String] The reason for losing the deal
+      # @param lost_date [Date, String] The date the deal was lost (defaults to today)
+      # @return [Hash] The updated deal
+      def mark_lost(id:, lost_reason: nil, lost_date: nil)
+        validate_id!(id, "Deal")
+
+        data = { status: "lost" }
+        data[:lost_reason] = lost_reason if lost_reason
+        data[:lost_date] = lost_date if lost_date
+
+        update(id: id, data: data)
+      end
+
+      # List deals by stage
+      #
+      # @param stage_id [String] The stage ID to filter by
+      # @param params [Hash] Additional query parameters
+      # @return [Hash] Deals in the specified stage
+      def list_by_stage(stage_id:, params: {})
+        validate_required_string!(stage_id, "Stage")
+
+        filter = { stage_id: { "$eq" => stage_id } }
+        merged_params = params.merge(filter: filter)
+        list(merged_params)
+      end
+
+      # List deals by company
+      #
+      # @param company_id [String] The company ID to filter by
+      # @param params [Hash] Additional query parameters
+      # @return [Hash] Deals for the specified company
+      def list_by_company(company_id:, params: {})
+        validate_required_string!(company_id, "Company")
+
+        filter = { company_id: { "$eq" => company_id } }
+        merged_params = params.merge(filter: filter)
+        list(merged_params)
+      end
+
+      # List deals by owner
+      #
+      # @param owner_id [String] The owner user ID to filter by
+      # @param params [Hash] Additional query parameters
+      # @return [Hash] Deals owned by the specified user
+      def list_by_owner(owner_id:, params: {})
+        validate_required_string!(owner_id, "Owner")
+
+        filter = { owner_id: { "$eq" => owner_id } }
+        merged_params = params.merge(filter: filter)
+        list(merged_params)
+      end
+
+      # Calculate pipeline value
+      #
+      # @param stage_id [String] Optional stage ID to filter by
+      # @param owner_id [String] Optional owner ID to filter by
+      # @return [Hash] Pipeline statistics including total value, count, and average
+      def pipeline_value(stage_id: nil, owner_id: nil)
+        params = { filter: {} }
+        params[:filter][:stage_id] = { "$eq" => stage_id } if stage_id
+        params[:filter][:owner_id] = { "$eq" => owner_id } if owner_id
+
+        # This would typically be a specialized endpoint, but we'll use list
+        # and let the client calculate the statistics
+        list(params)
+      end
+    end
+  end
+end

data/lib/attio/resources/meta.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Attio
+  module Resources
+    # Meta resource for API metadata and identification
+    #
+    # @example Identify the current API key
+    #   client.meta.identify
+    #   # => { "workspace" => { "id" => "...", "name" => "..." }, "user" => { ... } }
+    #
+    # @example Get API status
+    #   client.meta.status
+    #   # => { "status" => "operational", "version" => "v2" }
+    class Meta < Base
+      # Identify the current API key and get workspace/user information
+      #
+      # @return [Hash] Information about the authenticated workspace and user
+      def identify
+        request(:get, "meta/identify")
+      end
+
+      # Get API status and version information
+      #
+      # @return [Hash] API status and version details
+      def status
+        request(:get, "meta/status")
+      end
+
+      # Get rate limit information for the current API key
+      #
+      # @return [Hash] Current rate limit status
+      def rate_limits
+        request(:get, "meta/rate_limits")
+      end
+
+      # Get workspace configuration and settings
+      #
+      # @return [Hash] Workspace configuration details
+      def workspace_config
+        request(:get, "meta/workspace_config")
+      end
+
+      # Validate an API key without making changes
+      #
+      # @return [Hash] Validation result with key permissions
+      def validate_key
+        request(:post, "meta/validate", {})
+      end
+
+      # Get available API endpoints and their documentation
+      #
+      # @return [Hash] List of available endpoints with descriptions
+      def endpoints
+        request(:get, "meta/endpoints")
+      end
+
+      # Get workspace usage statistics
+      #
+      # @return [Hash] Usage statistics including record counts, API calls, etc.
+      def usage_stats
+        request(:get, "meta/usage")
+      end
+
+      # Get feature flags and capabilities for the workspace
+      #
+      # @return [Hash] Enabled features and capabilities
+      def features
+        request(:get, "meta/features")
+      end
+    end
+  end
+end

data/lib/attio/resources/workspace_members.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Attio
+  module Resources
+    # Workspace Members resource for managing workspace member access
+    #
+    # @example List all workspace members
+    #   client.workspace_members.list
+    #
+    # @example Get a specific member
+    #   client.workspace_members.get(member_id: "user_123")
+    #
+    # @example Invite a new member
+    #   client.workspace_members.invite(
+    #     email: "new.member@example.com",
+    #     role: "member"
+    #   )
+    class WorkspaceMembers < Base
+      # List all workspace members
+      #
+      # @param params [Hash] Optional query parameters
+      # @option params [Integer] :limit Maximum number of results
+      # @option params [String] :offset Pagination offset
+      # @return [Hash] The API response
+      def list(params = {})
+        request(:get, "workspace_members", params)
+      end
+
+      # Get a specific workspace member
+      #
+      # @param member_id [String] The member ID
+      # @return [Hash] The member data
+      def get(member_id:)
+        validate_id!(member_id, "Member")
+        request(:get, "workspace_members/#{member_id}")
+      end
+
+      # Invite a new member to the workspace
+      #
+      # @param email [String] The email address to invite
+      # @param role [String] The role to assign (admin, member, guest)
+      # @param data [Hash] Additional member data
+      # @return [Hash] The created invitation
+      def invite(email:, role: "member", data: {})
+        validate_required_string!(email, "Email")
+        validate_required_string!(role, "Role")
+
+        raise ArgumentError, "Role must be one of: admin, member, guest" unless %w[admin member guest].include?(role)
+
+        body = data.merge(email: email, role: role)
+        request(:post, "workspace_members/invitations", body)
+      end
+
+      # Update a workspace member's role or permissions
+      #
+      # @param member_id [String] The member ID to update
+      # @param data [Hash] The data to update
+      # @option data [String] :role The new role
+      # @option data [Hash] :permissions Custom permissions
+      # @return [Hash] The updated member
+      def update(member_id:, data:)
+        validate_id!(member_id, "Member")
+        validate_required_hash!(data, "Data")
+
+        request(:patch, "workspace_members/#{member_id}", data)
+      end
+
+      # Remove a member from the workspace
+      #
+      # @param member_id [String] The member ID to remove
+      # @return [Hash] Confirmation of removal
+      def remove(member_id:)
+        validate_id!(member_id, "Member")
+        request(:delete, "workspace_members/#{member_id}")
+      end
+
+      # Accept a workspace invitation
+      #
+      # @param invitation_token [String] The invitation token
+      # @return [Hash] The workspace member data
+      def accept_invitation(invitation_token:)
+        validate_required_string!(invitation_token, "Invitation token")
+        request(:post, "workspace_members/invitations/#{invitation_token}/accept")
+      end
+
+      # Resend an invitation
+      #
+      # @param member_id [String] The member ID with pending invitation
+      # @return [Hash] Confirmation of resent invitation
+      def resend_invitation(member_id:)
+        validate_id!(member_id, "Member")
+        request(:post, "workspace_members/#{member_id}/resend_invitation")
+      end
+
+      # Get current member (self)
+      #
+      # @return [Hash] The current authenticated member's data
+      def me
+        request(:get, "workspace_members/me")
+      end
+    end
+  end
+end

data/lib/attio/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Attio
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/attio.rb

@@ -18,6 +18,11 @@ require "attio/resources/notes"
 require "attio/resources/tasks"
 require "attio/resources/comments"
 require "attio/resources/threads"
+require "attio/resources/workspace_members"
+require "attio/resources/deals"
+require "attio/resources/meta"
+require "attio/resources/bulk"
+require "attio/rate_limiter"
 
 # The main Attio module provides access to the Attio API client.
 #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attio
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ernest Sim
@@ -48,6 +48,7 @@ files:
 - ".rubocop.yml"
 - ".yardopts"
 - CHANGELOG.md
+- CLAUDE.md
 - CODE_OF_CONDUCT.md
 - CONCEPTS.md
 - CONTRIBUTING.md
@@ -114,16 +115,21 @@ files:
 - lib/attio/errors.rb
 - lib/attio/http_client.rb
 - lib/attio/logger.rb
+- lib/attio/rate_limiter.rb
 - lib/attio/resources/attributes.rb
 - lib/attio/resources/base.rb
+- lib/attio/resources/bulk.rb
 - lib/attio/resources/comments.rb
+- lib/attio/resources/deals.rb
 - lib/attio/resources/lists.rb
+- lib/attio/resources/meta.rb
 - lib/attio/resources/notes.rb
 - lib/attio/resources/objects.rb
 - lib/attio/resources/records.rb
 - lib/attio/resources/tasks.rb
 - lib/attio/resources/threads.rb
 - lib/attio/resources/users.rb
+- lib/attio/resources/workspace_members.rb
 - lib/attio/resources/workspaces.rb
 - lib/attio/retry_handler.rb
 - lib/attio/version.rb