coss 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4cf53180039d6c9e703a7b8bc07bb83283fa2b786c1e24215e626a0d08e3f142
+  data.tar.gz: f65c4efc5537b94e093204a03b648dc536b184c9b221792c6f32e3b6b3afd260
+SHA512:
+  metadata.gz: 8932ef12f7f115d5f7b46dbc285d0ed5844a84e8fbe59e6bccaa16a687e278995c6d64b895d992ae66504864af380ba20fe5e81e5fbb41f5a6696f5650fa3ef6
+  data.tar.gz: ab01375c0f6aa26adf8e9fd8eb75026721ad19a560c0d86df8e8cd47bb6dac39fc4144096dc3cb84c6ab210d465022a1c5e0c91ea82fc4c59d8d4738713b1016

data/.fernignore

@@ -0,0 +1,11 @@
+# Hand-written (kept by `bun run sdks:generate`)
+.fernignore
+LICENSE
+CHANGELOG.md
+lib/coss/webhooks.rb
+test/custom
+.bundle
+vendor
+Gemfile.lock
+custom.gemspec.rb
+README.md

data/.rubocop.yml

@@ -0,0 +1,103 @@
+plugins:
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/AccessModifierDeclarations:
+  Enabled: false
+
+Lint/ConstantDefinitionInBlock:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+
+Naming/VariableNumber:
+  EnforcedStyle: normalcase
+  Severity: warning
+
+Style/Documentation:
+  Enabled: false
+
+Style/Lambda:
+  EnforcedStyle: literal
+
+Minitest/MultipleAssertions:
+  Enabled: false
+
+Minitest/UselessAssertion:
+  Enabled: false
+
+# Dynamic snippets are code samples for documentation, not standalone Ruby files.
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - "dynamic-snippets/**/*"
+
+# Indent hash elements 2 spaces from the start of the enclosing line rather than
+# aligning with the preceding paren or bracket. Generated code nests hashes inside
+# arrays and method calls; the "consistent" style is more readable there.
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+  Exclude:
+    - "dynamic-snippets/**/*"
+
+# Match Layout/FirstHashElementIndentation: indent the first argument 2 spaces
+# from the start of the method call's line, regardless of parenthesis position.
+# Dynamic snippets are code samples, not standalone Ruby files; exclude them to
+# keep this config symmetric with Layout/FirstHashElementIndentation above.
+Layout/FirstArgumentIndentation:
+  EnforcedStyle: consistent
+  Exclude:
+    - "dynamic-snippets/**/*"
+
+# The generator emits non-idiomatic class names (e.g. Get_With_Query, JSON_)
+# derived from IR type names whose wire form contains underscores or digits.
+# Rubocop never auto-corrected these (naming cops have no autocorrecter), so
+# disabling the cop keeps CI green without changing customer output. Fixing at
+# source would rename public types across every existing SDK and therefore
+# requires a ruby-v2 major-version bump with a generator migration.
+Naming/ClassAndModuleCamelCase:
+  Enabled: false
+
+# Integer literals are emitted unformatted (e.g. 1000000, not 1_000_000).
+# Rubocop has an autocorrecter for this cop, but the only caller of integer
+# emission is the dynamic-snippets path, which feeds customer-facing surfaces:
+# (1) snippet markdown in reference docs, (2) dynamic-snippets/*.rb sample
+# files. Neither is rubocop-gated (markdown isn't Ruby, dynamic-snippets/**/*
+# is excluded above), so formatting integers there would change docs/dashboard
+# output without any rubocop benefit. Disabling the cop keeps integers raw
+# everywhere and avoids customer-visible diffs.
+Style/NumericLiterals:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## 0.1.0
+
+- First release: every endpoint of the coss.com API (version `2026-10-10`), generated from its
+  OpenAPI document, with retries, idempotency keys on every `POST`, and webhook and log drain
+  signature verification.

data/CONTRIBUTING.md

@@ -0,0 +1,120 @@
+# Contributing
+
+Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.
+
+## Getting Started
+
+### Prerequisites
+
+- Ruby 3.0+
+- Bundler
+
+### Installation
+
+Install the project dependencies:
+
+```bash
+bundle install
+```
+
+### Building
+
+Build the gem:
+
+```bash
+gem build *.gemspec
+```
+
+### Testing
+
+Run the test suite:
+
+```bash
+bundle exec rspec
+```
+
+### Linting and Formatting
+
+Check code style:
+
+```bash
+bundle exec rubocop
+```
+
+Fix code style issues:
+
+```bash
+bundle exec rubocop -a
+```
+
+## About Generated Code
+
+**Important**: Most files in this SDK are automatically generated by [Fern](https://buildwithfern.com) from the API definition. Direct modifications to generated files will be overwritten the next time the SDK is generated.
+
+### Generated Files
+
+The following directories contain generated code:
+- `lib/` - API client classes and types
+- Most Ruby files in the project
+
+### How to Customize
+
+If you need to customize the SDK, you have two options:
+
+#### Option 1: Use `.fernignore`
+
+For custom code that should persist across SDK regenerations:
+
+1. Create a `.fernignore` file in the project root
+2. Add file patterns for files you want to preserve (similar to `.gitignore` syntax)
+3. Add your custom code to those files
+
+Files listed in `.fernignore` will not be overwritten when the SDK is regenerated.
+
+For more information, see the [Fern documentation on custom code](https://buildwithfern.com/learn/sdks/overview/custom-code).
+
+#### Option 2: Contribute to the Generator
+
+If you want to change how code is generated for all users of this SDK:
+
+1. The Ruby SDK generator lives in the [Fern repository](https://github.com/fern-api/fern)
+2. Generator code is located at `generators/ruby-v2/`
+3. Follow the [Fern contributing guidelines](https://github.com/fern-api/fern/blob/main/CONTRIBUTING.md)
+4. Submit a pull request with your changes to the generator
+
+This approach is best for:
+- Bug fixes in generated code
+- New features that would benefit all users
+- Improvements to code generation patterns
+
+## Making Changes
+
+### Workflow
+
+1. Create a new branch for your changes
+2. Make your modifications
+3. Run tests to ensure nothing breaks: `bundle exec rspec`
+4. Run linting: `bundle exec rubocop`
+5. Build the gem: `gem build *.gemspec`
+6. Commit your changes with a clear commit message
+7. Push your branch and create a pull request
+
+### Commit Messages
+
+Write clear, descriptive commit messages that explain what changed and why.
+
+### Code Style
+
+This project uses RuboCop for code formatting. Run `bundle exec rubocop` before committing to ensure your code meets the project's style guidelines.
+
+## Questions or Issues?
+
+If you have questions or run into issues:
+
+1. Check the [Fern documentation](https://buildwithfern.com)
+2. Search existing [GitHub issues](https://github.com/fern-api/fern/issues)
+3. Open a new issue if your question hasn't been addressed
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the same license as the project.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Cal.com, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# coss.com SDK for Ruby
+
+Every endpoint of the [coss.com](https://coss.com) API for Ruby 3.3+: email, Hooks, Risk,
+webhooks and more, with retries, idempotency keys and webhook verification. For Action Mailer,
+use [coss-rails](https://coss.com/docs/integrations/rails).
+
+```sh
+bundle add coss
+```
+
+```ruby
+require "coss"
+
+client = Coss::Client.new # reads COSS_API_KEY
+
+email = client.email.send_(
+  from: "Acme <hello@acme.com>",
+  to: ["ada@example.com"],
+  subject: "Welcome to Acme",
+  html: "<p>Thanks for signing up!</p>"
+)
+```
+
+- Guide: [coss.com/docs/sdks/ruby](https://coss.com/docs/sdks/ruby) (options, errors, lists, webhooks)
+- Every method: [reference.md](./reference.md), and each endpoint's page in the
+  [API reference](https://coss.com/docs/api-reference)
+
+The SDK is generated from the API's OpenAPI document in
+[cosscom/coss](https://github.com/cosscom/coss/tree/main/sdks/ruby). MIT licensed.

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test]
+
+task lint: %i[rubocop]
+
+# Run only the custom test file
+Minitest::TestTask.create(:customtest) do |t|
+  t.libs << "test"
+  t.test_globs = ["test/custom.test.rb"]
+end

data/custom.gemspec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Hand-written (listed in .fernignore): the gem's metadata, loaded by the generated gemspec.
+def add_custom_gemspec_data(spec)
+  spec.summary = "The coss.com SDK for Ruby"
+  spec.description = "Every endpoint of the coss.com API, typed, with retries, idempotency keys and webhook verification."
+  spec.homepage = "https://coss.com/docs/sdks/ruby"
+  spec.license = "MIT"
+  spec.metadata["source_code_uri"] = "https://github.com/cosscom/coss/tree/main/sdks/ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/cosscom/coss/blob/main/sdks/ruby/CHANGELOG.md"
+end

data/lib/coss/api_key/client.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Coss
+  module APIKey
+    class Client
+      # @param client [Coss::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Revokes the API key making this request, at once: every later request with it fails with `invalid_api_key`.
+      # `coss logout --revoke` uses it. Other keys are revoked in the dashboard.
+      #
+      # @param request_options [Hash]
+      # @param _params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
+      # @example
+      #   client.api_key.revoke
+      #
+      # @return [Coss::Types::DeletedAPIKey]
+      def revoke(request_options: {}, **_params)
+        request = Coss::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "DELETE",
+          path: "v1/api_key",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Coss::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Coss::Types::DeletedAPIKey.load(response.body))
+        else
+          error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+    end
+  end
+end

data/lib/coss/audit_events/client.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Coss
+  module AuditEvents
+    class Client
+      # @param client [Coss::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # The organization's audit log, newest first: changes made by members in the dashboard, by API keys (from any
+      # environment) and by coss.com support. The audit log is organization-wide, so every key of the organization reads
+      # the same events. Filter by action (an entry ending in `.` matches a whole resource, e.g. `domain.`), actor,
+      # target, environment or time. Pass the last `id` as `after` to get the next page while `has_more` is true.
+      # Reading the audit log is not itself logged.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String, nil] :action
+      # @option params [String, nil] :actor_type
+      # @option params [String, nil] :actor_id
+      # @option params [String, nil] :target_id
+      # @option params [String, nil] :environment_id
+      # @option params [String, nil] :from
+      # @option params [String, nil] :to
+      # @option params [Integer, nil] :limit
+      # @option params [String, nil] :after
+      #
+      # @example
+      #   client.audit_events.list
+      #
+      # @return [Coss::Types::AuditEventList]
+      def list(request_options: {}, **params)
+        params = Coss::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["action"] = params[:action] if params.key?(:action)
+        query_params["actor_type"] = params[:actor_type] if params.key?(:actor_type)
+        query_params["actor_id"] = params[:actor_id] if params.key?(:actor_id)
+        query_params["target_id"] = params[:target_id] if params.key?(:target_id)
+        query_params["environment_id"] = params[:environment_id] if params.key?(:environment_id)
+        query_params["from"] = params[:from] if params.key?(:from)
+        query_params["to"] = params[:to] if params.key?(:to)
+        query_params["limit"] = params[:limit] if params.key?(:limit)
+        query_params["after"] = params[:after] if params.key?(:after)
+
+        request = Coss::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/audit_events",
+          query: query_params,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Coss::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Coss::Types::AuditEventList.load(response.body))
+        else
+          error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String] :id
+      #
+      # @example
+      #   client.audit_events.get(id: "oaudit_01k7c8m4q2f3e9v6t5r1n0p8yz")
+      #
+      # @return [Coss::Types::AuditEvent]
+      def get(request_options: {}, **params)
+        params = Coss::Internal::Types::Utils.normalize_keys(params)
+        request = Coss::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/audit_events/#{URI.encode_uri_component(params[:id].to_s)}",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Coss::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Coss::Types::AuditEvent.load(response.body))
+        else
+          error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+    end
+  end
+end

data/lib/coss/audit_events/types/get_audit_events_request.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Coss
+  module AuditEvents
+    module Types
+      class GetAuditEventsRequest < Internal::Types::Model
+        field :id, -> { String }, optional: false, nullable: false
+      end
+    end
+  end
+end

data/lib/coss/audit_events/types/list_audit_events_request.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Coss
+  module AuditEvents
+    module Types
+      class ListAuditEventsRequest < Internal::Types::Model
+        field :action, -> { String }, optional: true, nullable: false
+
+        field :actor_type, -> { String }, optional: true, nullable: false
+
+        field :actor_id, -> { String }, optional: true, nullable: false
+
+        field :target_id, -> { String }, optional: true, nullable: false
+
+        field :environment_id, -> { String }, optional: true, nullable: false
+
+        field :from, -> { String }, optional: true, nullable: false
+
+        field :to, -> { String }, optional: true, nullable: false
+
+        field :limit, -> { Integer }, optional: true, nullable: false
+
+        field :after, -> { String }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/coss/billing/client.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Coss
+  module Billing
+    class Client
+      # @param client [Coss::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # The organization's plan (and contract), the current billing month's usage and what it would add to the next
+      # invoice so far, its standing (`past_due`, billing holds), payment method, and what the plan includes.
+      # Organization-wide: every environment's key sees the same. Plan changes are made in the dashboard; subscribe to
+      # the `billing.*` webhook events to follow them.
+      #
+      # @param request_options [Hash]
+      # @param _params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      #
+      # @example
+      #   client.billing.get
+      #
+      # @return [Coss::Types::Billing]
+      def get(request_options: {}, **_params)
+        request = Coss::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/billing",
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Coss::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Coss::Types::Billing.load(response.body))
+        else
+          error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # Billable usage over a range (the current billing month by default), per meter, dimension and bucket (`hour`,
+      # `day` or `month`, UTC), oldest first; with `group_by=environment`, per environment too. Only live environments
+      # are billed, so only they appear. Usage counts when it becomes billable (an email when the provider accepts it)
+      # and is kept for 400 days.
+      #
+      # @param request_options [Hash]
+      # @param params [Hash]
+      # @option request_options [String] :base_url
+      # @option request_options [Hash{String => Object}] :additional_headers
+      # @option request_options [Hash{String => Object}] :additional_query_parameters
+      # @option request_options [Hash{String => Object}] :additional_body_parameters
+      # @option request_options [Integer] :timeout_in_seconds
+      # @option params [String, nil] :from
+      # @option params [String, nil] :to
+      # @option params [Coss::Billing::Types::UsageBillingRequestGranularity, nil] :granularity
+      # @option params [Coss::Billing::Types::UsageBillingRequestGroupBy, nil] :group_by
+      # @option params [Coss::Billing::Types::UsageBillingRequestMeter, nil] :meter
+      #
+      # @example
+      #   client.billing.usage
+      #
+      # @return [Coss::Types::UsageList]
+      def usage(request_options: {}, **params)
+        params = Coss::Internal::Types::Utils.normalize_keys(params)
+        query_params = {}
+        query_params["from"] = params[:from] if params.key?(:from)
+        query_params["to"] = params[:to] if params.key?(:to)
+        query_params["granularity"] = params[:granularity] if params.key?(:granularity)
+        query_params["group_by"] = params[:group_by] if params.key?(:group_by)
+        query_params["meter"] = params[:meter] if params.key?(:meter)
+
+        request = Coss::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "GET",
+          path: "v1/billing/usage",
+          query: query_params,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Coss::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          (response.body.to_s.empty? ? nil : Coss::Types::UsageList.load(response.body))
+        else
+          error_class = Coss::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+
+      # @return [Coss::Invoices::Client]
+      def invoices
+        @invoices ||= Coss::Billing::Invoices::Client.new(client: @client)
+      end
+
+      # @return [Coss::Credits::Client]
+      def credits
+        @credits ||= Coss::Billing::Credits::Client.new(client: @client)
+      end
+    end
+  end
+end