nextbillionai 0.1.0.pre.alpha.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 233baef30082a8fa88ad62338f2ad878c880b684da4e50fbd914fa83c1616acb
+  data.tar.gz: ccbfc62bae7f209cd503f2097a23b9e4978cdb7b97caaf3c888e2b698b495929
+SHA512:
+  metadata.gz: c43f1150522d66e2a44a875cebd97b9685d9bbb6404f0b8ddab62a4cb8c033555da47f70df5ca7646a756cd5aa70e8ca67b20dd93d332faf6bb065f6389c2d00
+  data.tar.gz: 2aa163fb399113d89797cbee102ef14adb44ea6bc230e0e3cb2c53b3623ecbb9f3cff236a7a1a408b211234a6f063e6e43d2bb05c6ed82cfb203b3767ea92936

data/.ignore

@@ -0,0 +1,2 @@
+rbi/*
+sig/*

data/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changelog
+
+## 0.1.0-alpha.4 (2025-07-30)
+
+Full Changelog: [v0.1.0-alpha.3...v0.1.0-alpha.4](https://github.com/nextbillion-ai/nextbillion-sdk-ruby/compare/v0.1.0-alpha.3...v0.1.0-alpha.4)
+
+## 0.1.0-alpha.3 (2025-07-30)
+
+Full Changelog: [v0.1.0-alpha.2...v0.1.0-alpha.3](https://github.com/nextbillion-ai/nextbillion-sdk-ruby/compare/v0.1.0-alpha.2...v0.1.0-alpha.3)
+
+### Features
+
+* publish to ruby gem and align namings ([fbbe47b](https://github.com/nextbillion-ai/nextbillion-sdk-ruby/commit/fbbe47b9ed0748a180b5860006aa1876283d2809))
+
+## 0.1.0-alpha.2 (2025-07-30)
+
+Full Changelog: [v0.1.0-alpha.1...v0.1.0-alpha.2](https://github.com/nextbillion-ai/nextbillion-sdk-ruby/compare/v0.1.0-alpha.1...v0.1.0-alpha.2)
+
+### Features
+
+* **api:** manual updates ([f4fa783](https://github.com/nextbillion-ai/nextbillion-sdk-ruby/commit/f4fa783d78f05d19c8f4fb775d1d544b3041b788))
+
+## 0.1.0-alpha.1 (2025-07-30)
+
+Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/nextbillion-ai/nextbillion-sdk-ruby/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)
+
+### Features
+
+* **api:** update via SDK Studio ([b352d7a](https://github.com/nextbillion-ai/nextbillion-sdk-ruby/commit/b352d7a808092cc076a51d0002b86a9f11e81db0))
+* **api:** update via SDK Studio ([638f57b](https://github.com/nextbillion-ai/nextbillion-sdk-ruby/commit/638f57bc812ef59128727e197de66dba3f2e85fe))
+* **api:** update via SDK Studio ([7a4eae1](https://github.com/nextbillion-ai/nextbillion-sdk-ruby/commit/7a4eae18e57537fc7bb857c31ee9c9d77969e3f0))
+* Fix for ruby ([67228ca](https://github.com/nextbillion-ai/nextbillion-sdk-ruby/commit/67228ca9daab6177365254060268bbead0d3c1ae))
+* re-order endpoints ([82c7fe3](https://github.com/nextbillion-ai/nextbillion-sdk-ruby/commit/82c7fe3742f5424a5a7b1bd276217b842f0dcf7d))
+
+
+### Bug Fixes
+
+* **internal:** ensure sorbet test always runs serially ([0d7090a](https://github.com/nextbillion-ai/nextbillion-sdk-ruby/commit/0d7090a1efe112429f98c8cd3ce69c335e742694))
+
+
+### Chores
+
+* configure new SDK language ([825bd79](https://github.com/nextbillion-ai/nextbillion-sdk-ruby/commit/825bd794411f02660a74c502381e0be8620e168c))
+* update SDK settings ([4d4489c](https://github.com/nextbillion-ai/nextbillion-sdk-ruby/commit/4d4489ccc7d02faab3c7a4863e4e61c1258e6744))

data/README.md

@@ -0,0 +1,259 @@
+# Nextbillion SDK Ruby API library
+
+The Nextbillion SDK Ruby library provides convenient access to the Nextbillion SDK REST API from any Ruby 3.2.0+ application. It ships with comprehensive types & docstrings in Yard, RBS, and RBI – [see below](https://github.com/nextbillion-ai/nextbillion-sdk-ruby#Sorbet) for usage with Sorbet. The standard library's `net/http` is used as the HTTP transport, with connection pooling via the `connection_pool` gem.
+
+It is generated with [Stainless](https://www.stainless.com/).
+
+## Documentation
+
+Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/nextbillionai).
+
+The REST API documentation can be found on [docs.nextbillion.ai](https://docs.nextbillion.ai).
+
+## Installation
+
+To use this gem, install via Bundler by adding the following to your application's `Gemfile`:
+
+<!-- x-release-please-start-version -->
+
+```ruby
+gem "nextbillionai", "~> 0.1.0.pre.alpha.4"
+```
+
+<!-- x-release-please-end -->
+
+## Usage
+
+```ruby
+require "bundler/setup"
+require "nextbillionai"
+
+nextbillion_sdk = Nextbillionai::Client.new(
+  api_key: ENV["NEXTBILLION_SDK_API_KEY"] # This is the default and can be omitted
+)
+
+response = nextbillion_sdk.directions.compute_route(
+  destination: "1.335368,103.785517",
+  origin: "1.312164,103.841062"
+)
+
+puts(response.msg)
+```
+
+### Handling errors
+
+When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Nextbillionai::Errors::APIError` will be thrown:
+
+```ruby
+begin
+  direction = nextbillion_sdk.directions.compute_route(
+    destination: "1.335368,103.785517",
+    origin: "1.312164,103.841062"
+  )
+rescue Nextbillionai::Errors::APIConnectionError => e
+  puts("The server could not be reached")
+  puts(e.cause)  # an underlying Exception, likely raised within `net/http`
+rescue Nextbillionai::Errors::RateLimitError => e
+  puts("A 429 status code was received; we should back off a bit.")
+rescue Nextbillionai::Errors::APIStatusError => e
+  puts("Another non-200-range status code was received")
+  puts(e.status)
+end
+```
+
+Error codes are as follows:
+
+| Cause            | Error Type                 |
+| ---------------- | -------------------------- |
+| HTTP 400         | `BadRequestError`          |
+| HTTP 401         | `AuthenticationError`      |
+| HTTP 403         | `PermissionDeniedError`    |
+| HTTP 404         | `NotFoundError`            |
+| HTTP 409         | `ConflictError`            |
+| HTTP 422         | `UnprocessableEntityError` |
+| HTTP 429         | `RateLimitError`           |
+| HTTP >= 500      | `InternalServerError`      |
+| Other HTTP error | `APIStatusError`           |
+| Timeout          | `APITimeoutError`          |
+| Network error    | `APIConnectionError`       |
+
+### Retries
+
+Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
+
+Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.
+
+You can use the `max_retries` option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+nextbillion_sdk = Nextbillionai::Client.new(
+  max_retries: 0 # default is 2
+)
+
+# Or, configure per-request:
+nextbillion_sdk.directions.compute_route(
+  destination: "1.335368,103.785517",
+  origin: "1.312164,103.841062",
+  request_options: {max_retries: 5}
+)
+```
+
+### Timeouts
+
+By default, requests will time out after 60 seconds. You can use the timeout option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+nextbillion_sdk = Nextbillionai::Client.new(
+  timeout: nil # default is 60
+)
+
+# Or, configure per-request:
+nextbillion_sdk.directions.compute_route(
+  destination: "1.335368,103.785517",
+  origin: "1.312164,103.841062",
+  request_options: {timeout: 5}
+)
+```
+
+On timeout, `Nextbillionai::Errors::APITimeoutError` is raised.
+
+Note that requests that time out are retried by default.
+
+## Advanced concepts
+
+### BaseModel
+
+All parameter and response objects inherit from `Nextbillionai::Internal::Type::BaseModel`, which provides several conveniences, including:
+
+1. All fields, including unknown ones, are accessible with `obj[:prop]` syntax, and can be destructured with `obj => {prop: prop}` or pattern-matching syntax.
+
+2. Structural equivalence for equality; if two API calls return the same values, comparing the responses with == will return true.
+
+3. Both instances and the classes themselves can be pretty-printed.
+
+4. Helpers such as `#to_h`, `#deep_to_h`, `#to_json`, and `#to_yaml`.
+
+### Making custom or undocumented requests
+
+#### Undocumented properties
+
+You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
+
+Note: the `extra_` parameters of the same name overrides the documented parameters.
+
+```ruby
+response =
+  nextbillion_sdk.directions.compute_route(
+    destination: "1.335368,103.785517",
+    origin: "1.312164,103.841062",
+    request_options: {
+      extra_query: {my_query_parameter: value},
+      extra_body: {my_body_parameter: value},
+      extra_headers: {"my-header": value}
+    }
+  )
+
+puts(response[:my_undocumented_property])
+```
+
+#### Undocumented request params
+
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using `client.request`, like so:
+
+```ruby
+response = client.request(
+  method: :post,
+  path: '/undocumented/endpoint',
+  query: {"dog": "woof"},
+  headers: {"useful-header": "interesting-value"},
+  body: {"hello": "world"}
+)
+```
+
+### Concurrency & connection pooling
+
+The `Nextbillionai::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
+
+Each instance of `Nextbillionai::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
+
+When all available connections from the pool are checked out, requests wait for a new connection to become available, with queue time counting towards the request timeout.
+
+Unless otherwise specified, other classes in the SDK do not have locks protecting their underlying data structure.
+
+## Sorbet
+
+This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitions, and has no dependency on sorbet-runtime.
+
+You can provide typesafe request parameters like so:
+
+```ruby
+nextbillion_sdk.directions.compute_route(
+  destination: "1.335368,103.785517",
+  origin: "1.312164,103.841062"
+)
+```
+
+Or, equivalently:
+
+```ruby
+# Hashes work, but are not typesafe:
+nextbillion_sdk.directions.compute_route(
+  destination: "1.335368,103.785517",
+  origin: "1.312164,103.841062"
+)
+
+# You can also splat a full Params class:
+params = Nextbillionai::DirectionComputeRouteParams.new(
+  destination: "1.335368,103.785517",
+  origin: "1.312164,103.841062"
+)
+nextbillion_sdk.directions.compute_route(**params)
+```
+
+### Enums
+
+Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
+
+```ruby
+# :start
+puts(Nextbillionai::Fleetify::Routes::StepCreateParams::Type::START)
+
+# Revealed type: `T.all(Nextbillionai::Fleetify::Routes::StepCreateParams::Type, Symbol)`
+T.reveal_type(Nextbillionai::Fleetify::Routes::StepCreateParams::Type::START)
+```
+
+Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
+
+```ruby
+# Using the enum constants preserves the tagged type information:
+nextbillion_sdk.fleetify.routes.steps.create(
+  type: Nextbillionai::Fleetify::Routes::StepCreateParams::Type::START,
+  # …
+)
+
+# Literal values are also permissible:
+nextbillion_sdk.fleetify.routes.steps.create(
+  type: :start,
+  # …
+)
+```
+
+## Versioning
+
+This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.
+
+This package considers improvements to the (non-runtime) `*.rbi` and `*.rbs` type definitions to be non-breaking changes.
+
+## Requirements
+
+Ruby 3.2.0 or higher.
+
+## Contributing
+
+See [the contributing documentation](https://github.com/nextbillion-ai/nextbillion-sdk-ruby/tree/main/CONTRIBUTING.md).

data/SECURITY.md

@@ -0,0 +1,27 @@
+# Security Policy
+
+## Reporting Security Issues
+
+This SDK is generated by [Stainless Software Inc](http://stainless.com). Stainless takes security seriously, and encourages you to report any security vulnerability promptly so that appropriate action can be taken.
+
+To report a security issue, please contact the Stainless team at security@stainless.com.
+
+## Responsible Disclosure
+
+We appreciate the efforts of security researchers and individuals who help us maintain the security of
+SDKs we generate. If you believe you have found a security vulnerability, please adhere to responsible
+disclosure practices by allowing us a reasonable amount of time to investigate and address the issue
+before making any information public.
+
+## Reporting Non-SDK Related Security Issues
+
+If you encounter security issues that are not directly related to SDKs but pertain to the services
+or products provided by Nextbillion SDK, please follow the respective company's security reporting guidelines.
+
+### Nextbillion SDK Terms and Policies
+
+Please contact yun@nextbillion.ai for any questions or concerns regarding the security of our services.
+
+---
+
+Thank you for helping us keep the SDKs and systems they interact with secure.

data/lib/nextbillionai/client.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  class Client < Nextbillionai::Internal::Transport::BaseClient
+    # Default max number of retries to attempt after a failed retryable request.
+    DEFAULT_MAX_RETRIES = 2
+
+    # Default per-request timeout.
+    DEFAULT_TIMEOUT_IN_SECONDS = 60.0
+
+    # Default initial retry delay in seconds.
+    # Overall delay is calculated using exponential backoff + jitter.
+    DEFAULT_INITIAL_RETRY_DELAY = 0.5
+
+    # Default max retry delay in seconds.
+    DEFAULT_MAX_RETRY_DELAY = 8.0
+
+    # @return [String]
+    attr_reader :api_key
+
+    # @return [Nextbillionai::Resources::Fleetify]
+    attr_reader :fleetify
+
+    # @return [Nextbillionai::Resources::Skynet]
+    attr_reader :skynet
+
+    # @return [Nextbillionai::Resources::Geocode]
+    attr_reader :geocode
+
+    # @return [Nextbillionai::Resources::Optimization]
+    attr_reader :optimization
+
+    # @return [Nextbillionai::Resources::Geofence]
+    attr_reader :geofence
+
+    # @return [Nextbillionai::Resources::Discover]
+    attr_reader :discover
+
+    # @return [Nextbillionai::Resources::Browse]
+    attr_reader :browse
+
+    # @return [Nextbillionai::Resources::Mdm]
+    attr_reader :mdm
+
+    # @return [Nextbillionai::Resources::Isochrone]
+    attr_reader :isochrone
+
+    # @return [Nextbillionai::Resources::Restrictions]
+    attr_reader :restrictions
+
+    # @return [Nextbillionai::Resources::RestrictionsItems]
+    attr_reader :restrictions_items
+
+    # @return [Nextbillionai::Resources::DistanceMatrix]
+    attr_reader :distance_matrix
+
+    # @return [Nextbillionai::Resources::Autocomplete]
+    attr_reader :autocomplete
+
+    # @return [Nextbillionai::Resources::Navigation]
+    attr_reader :navigation
+
+    # @return [Nextbillionai::Resources::Map]
+    attr_reader :map
+
+    # @return [Nextbillionai::Resources::Autosuggest]
+    attr_reader :autosuggest
+
+    # @return [Nextbillionai::Resources::Directions]
+    attr_reader :directions
+
+    # @return [Nextbillionai::Resources::Batch]
+    attr_reader :batch
+
+    # @return [Nextbillionai::Resources::Multigeocode]
+    attr_reader :multigeocode
+
+    # @return [Nextbillionai::Resources::Revgeocode]
+    attr_reader :revgeocode
+
+    # @return [Nextbillionai::Resources::RouteReport]
+    attr_reader :route_report
+
+    # @return [Nextbillionai::Resources::SnapToRoads]
+    attr_reader :snap_to_roads
+
+    # @return [Nextbillionai::Resources::Postalcode]
+    attr_reader :postalcode
+
+    # @return [Nextbillionai::Resources::Lookup]
+    attr_reader :lookup
+
+    # @return [Nextbillionai::Resources::Areas]
+    attr_reader :areas
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_query
+      {"key" => @api_key}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param api_key [String, nil] Defaults to `ENV["NEXTBILLION_SDK_API_KEY"]`
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["NEXTBILLION_SDK_BASE_URL"]`
+    #
+    # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
+    #
+    # @param timeout [Float]
+    #
+    # @param initial_retry_delay [Float]
+    #
+    # @param max_retry_delay [Float]
+    def initialize(
+      api_key: ENV["NEXTBILLION_SDK_API_KEY"],
+      base_url: ENV["NEXTBILLION_SDK_BASE_URL"],
+      max_retries: self.class::DEFAULT_MAX_RETRIES,
+      timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: self.class::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: self.class::DEFAULT_MAX_RETRY_DELAY
+    )
+      base_url ||= "https://api.nextbillion.io"
+
+      if api_key.nil?
+        raise ArgumentError.new("api_key is required, and can be set via environ: \"NEXTBILLION_SDK_API_KEY\"")
+      end
+
+      @api_key = api_key.to_s
+
+      super(
+        base_url: base_url,
+        timeout: timeout,
+        max_retries: max_retries,
+        initial_retry_delay: initial_retry_delay,
+        max_retry_delay: max_retry_delay
+      )
+
+      @fleetify = Nextbillionai::Resources::Fleetify.new(client: self)
+      @skynet = Nextbillionai::Resources::Skynet.new(client: self)
+      @geocode = Nextbillionai::Resources::Geocode.new(client: self)
+      @optimization = Nextbillionai::Resources::Optimization.new(client: self)
+      @geofence = Nextbillionai::Resources::Geofence.new(client: self)
+      @discover = Nextbillionai::Resources::Discover.new(client: self)
+      @browse = Nextbillionai::Resources::Browse.new(client: self)
+      @mdm = Nextbillionai::Resources::Mdm.new(client: self)
+      @isochrone = Nextbillionai::Resources::Isochrone.new(client: self)
+      @restrictions = Nextbillionai::Resources::Restrictions.new(client: self)
+      @restrictions_items = Nextbillionai::Resources::RestrictionsItems.new(client: self)
+      @distance_matrix = Nextbillionai::Resources::DistanceMatrix.new(client: self)
+      @autocomplete = Nextbillionai::Resources::Autocomplete.new(client: self)
+      @navigation = Nextbillionai::Resources::Navigation.new(client: self)
+      @map = Nextbillionai::Resources::Map.new(client: self)
+      @autosuggest = Nextbillionai::Resources::Autosuggest.new(client: self)
+      @directions = Nextbillionai::Resources::Directions.new(client: self)
+      @batch = Nextbillionai::Resources::Batch.new(client: self)
+      @multigeocode = Nextbillionai::Resources::Multigeocode.new(client: self)
+      @revgeocode = Nextbillionai::Resources::Revgeocode.new(client: self)
+      @route_report = Nextbillionai::Resources::RouteReport.new(client: self)
+      @snap_to_roads = Nextbillionai::Resources::SnapToRoads.new(client: self)
+      @postalcode = Nextbillionai::Resources::Postalcode.new(client: self)
+      @lookup = Nextbillionai::Resources::Lookup.new(client: self)
+      @areas = Nextbillionai::Resources::Areas.new(client: self)
+    end
+  end
+end