wavix-ruby-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 788d6d38aeb24c7ee557b44ee9333b7f7d897bdb3601534351b24d038ded9792
+  data.tar.gz: 31fdb41dba157b025731bb89d4b438ed0e05bc89c9cf59c68ee8106f72c330a8
+SHA512:
+  metadata.gz: 2101d93afc6dc2f1da96e83a6834d92fcc0dd03afc8e9a1dfd1a704ee97a90548862e3ecdc4e17ffb003e1d08fa16212fb7e7b4f3ccaec6a7f87db9c6b95a655
+  data.tar.gz: 90ece83619ce1f36dc241a671df57bf158b2c7ca5233e16cb0a1013d4e03b1bc106d0580976aa56cebcf832f1968c1bb898f28206a2724dc5766f2bd126781db

data/.fern/metadata.json

@@ -0,0 +1,10 @@
+{
+  "cliVersion": "5.45.3",
+  "generatorName": "fernapi/fern-ruby-sdk",
+  "generatorVersion": "1.13.1",
+  "originGitCommit": "af69033e3cb9260efdbfbf64452f841499bb8fc4",
+  "originGitCommitIsDirty": false,
+  "invokedBy": "manual",
+  "requestedVersion": "1.0.0",
+  "sdkVersion": "1.0.0"
+}

data/.fernignore

@@ -0,0 +1,5 @@
+# Files Fern must NOT overwrite on regeneration (treated like .gitignore).
+LICENSE
+README.md
+.fernignore
+SECURITY.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/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 Wavix
+
+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,271 @@
+# Wavix Ruby SDK
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fwavix%2Fwavix-ruby-sdk)
+
+The official Wavix Ruby SDK provides programmatic access to the
+[Wavix](https://wavix.com) APIs. Use it to add messaging, voice, and account
+management capabilities to your application.
+
+Use the SDK to:
+
+- Send and receive SMS and MMS messages.
+- Place and programmatically control calls.
+- Search for, buy, and manage phone numbers.
+- Validate phone numbers.
+- Manage SIP trunks.
+- Retrieve call detail records (CDRs).
+
+
+## Table of contents
+
+- [Installation](#installation)
+- [Authentication](#authentication)
+- [Quickstart](#quickstart)
+- [Error handling](#error-handling)
+- [Pagination](#pagination)
+- [Rate limits and retries](#rate-limits-and-retries)
+  - [Retries](#retries)
+  - [Idempotency](#idempotency)
+- [Advanced](#advanced)
+  - [Timeouts](#timeouts)
+  - [Additional headers](#additional-headers)
+  - [Additional query parameters](#additional-query-parameters)
+- [SDK and API compatibility](#sdk-and-api-compatibility)
+- [Release notes](#release-notes)
+- [Major-version upgrades](#major-version-upgrades)
+- [Documentation](#documentation)
+- [Resources and support](#resources-and-support)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+gem install wavix-ruby-sdk
+```
+
+**Requirements:** Ruby 3.3 or later.
+
+## Authentication
+
+Create an API key in the [Wavix portal](https://app.wavix.com). Store the key
+in an environment variable and pass it to the client.
+
+```shell
+export WAVIX_API_KEY="your-api-key"
+```
+
+```ruby
+require "wavix"
+
+client = Wavix::Client.new(token: ENV.fetch("WAVIX_API_KEY"))
+```
+
+> [!CAUTION]
+> Don't commit API keys or tokens to source control. In production, store
+> credentials in environment variables or a secrets manager.
+
+
+## Quickstart
+
+Create a client and send an SMS message:
+
+```ruby
+require "wavix"
+
+client = Wavix::Client.new(token: "<token>")
+
+client.sms_and_mms.messages.send_(
+  from: "Wavix",
+  to: "+447537151866",
+  message_body: {
+    text: "Hi there, this is a message from Wavix",
+    media: nil
+  },
+  callback_url: "https://you-site.com/webhook",
+  validity: 3600,
+  tag: "Fall sale"
+)
+```
+
+## Error handling
+
+When an API request fails, the SDK raises an error that you can rescue by
+type:
+
+```ruby
+require "wavix"
+
+client = Wavix::Client.new(
+    base_url: "https://example.com"
+)
+
+begin
+    result = client.sms_and_mms.messages.send_
+rescue Wavix::Errors::TimeoutError
+    puts "API didn't respond before our timeout elapsed"
+rescue Wavix::Errors::ServiceUnavailableError
+    puts "API returned status 503, is probably overloaded, try again later"
+rescue Wavix::Errors::ServerError
+    puts "API returned some other 5xx status, this is probably a bug"
+rescue Wavix::Errors::ResponseError => e
+    puts "API returned an unexpected status other than 5xx: #{e.code} #{e.message}"
+rescue Wavix::Errors::ApiError => e
+    puts "Some other error occurred when calling the API: #{e.message}"
+end
+```
+
+Handle errors that aren't covered by these SDK error types separately, or
+raise them again so that your application doesn't ignore unexpected failures.
+
+## Pagination
+
+List operations use automatic page-number pagination. The SDK requests
+additional pages as you iterate through the results.
+
+The Wavix APIs support these pagination parameters:
+
+- `page`: Specifies the page to retrieve.
+- `per_page`: Specifies the number of items per page. The default is `25`.
+  The minimum is `1`, and the maximum is `100`.
+
+## Rate limits and retries
+
+Rate limits vary by endpoint. When a request exceeds an endpoint's rate
+limit, the Wavix API returns an HTTP `429 Too Many Requests` response.
+
+The SDK can retry `429` responses as described in [Retries](#retries).
+Configure retries according to your application's traffic patterns and
+latency requirements.
+
+### Retries
+
+The SDK automatically retries eligible requests. By default, the SDK makes up
+to two retry attempts.
+
+A request is eligible for retry when it returns one of these HTTP status
+codes:
+
+- `408 Request Timeout`.
+- `429 Too Many Requests`.
+- These server errors: `500`, `502`, `503`, `504`, `521`, `522`, and `524`.
+
+These status codes aren't configurable.
+
+Use `max_retries` to set the retry limit:
+
+```ruby
+require "wavix"
+
+client = Wavix::Client.new(
+    base_url: "https://example.com",
+    max_retries: 3  # Configure max retries (default is 2)
+)
+```
+
+> [!IMPORTANT]
+> A retry can repeat an operation if the server processes the original
+> request but the client doesn't receive the response. Before you retry an
+> operation that sends a message, places a call, or changes a resource,
+> confirm that the operation can be repeated safely.
+
+### Idempotency
+
+The Wavix APIs don't support idempotency keys. A repeated request can repeat
+the operation, including sending a message, placing a call, or changing a
+resource.
+
+Before you retry a request that changes data or starts an operation, check
+whether the original request succeeded. When duplicate operations could
+affect customers or incur charges, track request state in your application
+and prevent the same operation from being submitted more than once.
+
+## Advanced
+
+### Timeouts
+
+The SDK uses a fixed 60-second request timeout.
+
+### Additional headers
+
+Use `additional_headers` to add headers to an individual request:
+
+```ruby
+require "wavix"
+
+response = client.sms_and_mms.messages.send_(
+    ...,
+    request_options: {
+        additional_headers: {
+            "X-Custom-Header" => "custom-value"
+        }
+    }
+)
+```
+
+### Additional query parameters
+
+Use `additional_query_parameters` to add query parameters to an individual
+request:
+
+```ruby
+require "wavix"
+
+response = client.sms_and_mms.messages.send_(
+    ...,
+    request_options: {
+        additional_query_parameters: {
+            "custom_param" => "custom-value"
+        }
+    }
+)
+```
+
+## SDK and API compatibility
+
+Each SDK release supports the current version of the Wavix APIs available
+when that SDK version is released. Update the SDK regularly to access the
+latest API capabilities and fixes.
+
+Before you update the SDK, review the
+[GitHub releases](https://github.com/wavix/wavix-ruby-sdk/releases) for changes
+that might affect your application.
+
+## Release notes
+
+See [GitHub releases](https://github.com/wavix/wavix-ruby-sdk/releases) for new
+features, fixes, and breaking changes in each SDK release.
+
+## Major-version upgrades
+
+The SDK doesn't provide separate migration guides. Breaking changes ship only
+in major versions, so before you upgrade, review the
+[GitHub releases](https://github.com/wavix/wavix-ruby-sdk/releases) for breaking
+changes, then update and test in a development environment before you deploy.
+
+## Documentation
+
+- For API guides and API reference documentation, see the
+  [Wavix documentation](https://docs.wavix.com).
+- For SDK methods and types, see the
+  [Ruby SDK reference](https://github.com/wavix/wavix-ruby-sdk/blob/HEAD/reference.md).
+
+## Resources and support
+
+- **Versioning:** The SDK follows [Semantic Versioning](https://semver.org).
+  Breaking changes are released in major versions.
+- **Security:** Report vulnerabilities privately by following the instructions
+  in [SECURITY.md](./SECURITY.md). Don't report vulnerabilities in public
+  issues.
+- **Support:** For product and API support, contact
+  [support@wavix.com](mailto:support@wavix.com).
+- **Issues:** To report an SDK bug or request a feature, open a
+  [GitHub issue](https://github.com/wavix/wavix-ruby-sdk/issues).
+- **License:** The SDK is available under the [MIT License](./LICENSE).
+
+## Contributing
+
+The SDK source code is generated. Changes made directly to generated files are
+overwritten in the next release and can't be merged as submitted. Before you
+prepare a code change, open an issue to discuss the proposed update.
+
+You can submit README improvements directly in a pull request.

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/SECURITY.md

@@ -0,0 +1,25 @@
+# Security Policy
+
+## Reporting a vulnerability
+
+We take the security of the Wavix SDKs and API seriously. Please report any
+security vulnerability **privately** — do not open a public GitHub issue or
+pull request.
+
+- **Email:** support@wavix.com
+- Or use GitHub's **"Report a vulnerability"** button on the Security tab.
+
+Please include a description of the issue, steps to reproduce, the affected
+version, and the potential impact. We will acknowledge your report within
+3 business days and keep you updated as we investigate and ship a fix. Please
+give us a reasonable window to release a fix before any public disclosure.
+
+## Supported versions
+
+Security fixes are released for the latest published major version of this SDK.
+
+## Scope
+
+This repository contains an auto-generated SDK. Suspected vulnerabilities in the
+Wavix API itself (rather than the generated client code) should be reported
+through the same private channel.

data/custom.gemspec.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Custom gemspec configuration file
+# This file is automatically loaded by the main gemspec file. The 'spec' variable is available
+# in this context from the main gemspec file. You can modify this file to add custom metadata,
+# dependencies, or other gemspec configurations. If you do make changes to this file, you will
+# need to add it to the .fernignore file to prevent your changes from being overwritten.
+
+def add_custom_gemspec_data(spec)
+  # Example custom configurations (uncomment and modify as needed)
+
+  # spec.authors = ["Your name"]
+  # spec.email = ["your.email@example.com"]
+  # spec.homepage = "https://github.com/your-org/wavix-ruby"
+  # spec.license = "Your license"
+end