carsxe 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54269d1a4bf6332e4722a093638d6738f39b9f65cab485d5ec4e5b92c6bf5eb9
-  data.tar.gz: 1f5476046105594d78fdb501929ec2ad42fc7c97a5a8197c5174e96020391192
+  metadata.gz: 3e35bd5083bfa0a5a86f4f632bec00dba447d566093e52246d3d71788ddfe7ab
+  data.tar.gz: d4b13f4c039f7d492fdeee710e310e1a15f02b66ec69d6bd75d27eecd3266189
 SHA512:
-  metadata.gz: c9f41c7b1f51c34e00cf573066b0f257a80a86cfd1e0b3e9af9bd6dfd12423e893c0d3b8ec8acc7808e36aa69a8c71d448f82b3d9c6d4a65a064aa52cd5cd02b
-  data.tar.gz: 92be3f8ee6267ddcdcf6c6b626d747a5f91cb0117a5007afa73f462df926fd0b6665cbdcb3ccadf379ce747d33730f5ead948068c3a8346fe90eabc39ee3a75f
+  metadata.gz: 3b5f42e345655bfac2d0a3641bd6bfeb6033642ff50a0d1cf6e0e05ba3d1a2beaec2091106b11ce624c3f71d2e083ce811ba984a43098b1044959cd43f4dec0e
+  data.tar.gz: ffb7fa7f87f1a9b35d71fc4dce94c6d3f56ef9c0bcf9ce39d29cc1e71c4587d7c6312423fbdd7cad4e344af3994a260b704ce7a3918feda475972192dd521b83

data/CHANGELOG.md

@@ -1,5 +1,9 @@
-## [Unreleased]
-
-## [1.0.0] - 2025-09-10
-
-- Initial release
+## [Unreleased]
+
+## [1.3.0] - 2026-09-09
+
+- Add `recalls_ymm`, `ymm_options`, ownership lookups, and recalls-batch methods
+
+## [1.0.0] - 2025-09-10
+
+- Initial release

data/README.md

@@ -1,316 +1,516 @@
-# 🚗 CarsXE API (Ruby Gem)
-
-[![Gem Version](https://img.shields.io/gem/v/carsxe.svg)](https://rubygems.org/gems/carsxe)
-
-**CarsXE** is a powerful and developer-friendly API that gives you instant access to a wide range of vehicle data. From VIN decoding and market value estimation to vehicle history, images, OBD code explanations, and plate recognition, CarsXE provides everything you need to build automotive applications at scale.
-
-🌐 **Website:** [https://api.carsxe.com](https://api.carsxe.com)  
-📄 **Docs:** [https://api.carsxe.com/docs](https://api.carsxe.com/docs)  
-📦 **All Products:** [https://api.carsxe.com/all-products](https://api.carsxe.com/all-products)
-
-To get started with the CarsXE API, follow these steps:
-
-1. **Sign up for a CarsXE account:**
-   - [Register here](https://api.carsxe.com/register)
-   - Add a [payment method](https://api.carsxe.com/dashboard/billing#payment-methods) to activate your subscription and get your API key.
-
-2. **Install the CarsXE Ruby gem:**
-
-   Run this command in your terminal:
-
-   ```bash
-   gem install carsxe
-   ```
-
-   Or add it to your Gemfile:
-
-   ```ruby
-   gem 'carsxe'
-   ```
-
-   Then run `bundle install`.
-
-3. **Require the CarsXE API in your code:**
-
-   ```ruby
-   require 'carsxe'
-   ```
-
-4. **Initialize the API with your API key:**
-
-   ```ruby
-   API_KEY = 'YOUR_API_KEY'
-   carsxe = Carsxe::CarsXE.new(api_key: API_KEY)
-   ```
-
-5. **Use the various endpoint methods provided by the API to access the data you need.**
-
-## Usage
-
-```ruby
-vin = 'WBAFR7C57CC811956'
-
-begin
-  vehicle = carsxe.specs('vin' => vin)
-  puts vehicle['input']['vin']
-rescue StandardError => error
-  puts "Error: #{error.message}"
-end
-```
-
----
-
-## 📚 Endpoints
-
-The CarsXE API provides the following endpoint methods:
-
-### `specs` – Decode VIN & get full vehicle specifications
-
-**Required:**
-
-- `vin`
-
-**Optional:**
-
-- `deepdata`
-- `disableIntVINDecoding`
-
-**Example:**
-
-```ruby
-vehicle = carsxe.specs('vin' => 'WBAFR7C57CC811956')
-```
-
----
-
-### `int_vin_decoder` – Decode VIN with worldwide support
-
-**Required:**
-
-- `vin`
-
-**Optional:**
-
-- None
-
-**Example:**
-
-```ruby
-intvin = carsxe.int_vin_decoder('vin' => 'WF0MXXGBWM8R43240')
-```
-
----
-
-### `plate_decoder` – Decode license plate info (plate, country)
-
-**Required:**
-
-- `plate`
-- `country` (always required except for US, where it is optional and defaults to 'US')
-
-**Optional:**
-
-- `state` (required for some countries, e.g. US, AU, CA)
-- `district` (required for Pakistan)
-
-> **Note:**
->
-> - The `state` parameter is required only when applicable (for
->   specific countries such as US, AU, CA, etc.).
-> - For Pakistan (`country='pk'`), both `state` and `district`
->   are required.
-
-**Example:**
-
-```ruby
-decoded_plate = carsxe.plate_decoder('plate' => '7XER187', 'state' => 'CA', 'country' => 'US')
-```
-
----
-
-### `market_value` – Estimate vehicle market value based on VIN
-
-**Required:**
-
-- `vin`
-
-**Optional:**
-
-- `state`
-- `mileage`
-- `condition`
-
-**Example:**
-
-```ruby
-marketvalue = carsxe.market_value('vin' => 'WBAFR7C57CC811956', 'state' => 'CA', 'mileage' => '80000', 'condition' => 'good')
-```
-
----
-
-### `history` – Retrieve vehicle history
-
-**Required:**
-
-- `vin`
-
-**Optional:**
-
-- None
-
-**Example:**
-
-```ruby
-history = carsxe.history('vin' => 'WBAFR7C57CC811956')
-```
-
----
-
-### `images` – Fetch images by make, model, year, trim
-
-**Required:**
-
-- `make`
-- `model`
-
-**Optional:**
-
-- `year`
-- `trim`
-- `color`
-- `transparent`
-- `angle`
-- `photoType`
-- `size`
-- `license`
-
-**Example:**
-
-```ruby
-images = carsxe.images('make' => 'BMW', 'model' => 'X5', 'year' => '2019')
-```
-
----
-
-### `recalls` – Get safety recall data for a VIN
-
-**Required:**
-
-- `vin`
-
-**Optional:**
-
-- None
-
-**Example:**
-
-```ruby
-recalls = carsxe.recalls('vin' => '1C4JJXR64PW696340')
-```
-
----
-
-### `plate_image_recognition` – Read & decode plates from images
-
-**Required:**
-
-- `upload_url`
-
-**Optional:**
-
-- None
-
-**Example:**
-
-```ruby
-plateimg = carsxe.plate_image_recognition('upload_url' => 'https://api.carsxe.com/img/apis/plate_recognition.JPG')
-```
-
----
-
-### `vin_ocr` – Extract VINs from images using OCR
-
-**Required:**
-
-- `upload_url`
-
-**Optional:**
-
-- None
-
-**Example:**
-
-```ruby
-vinocr = carsxe.vin_ocr('upload_url' => 'https://api.carsxe.com/img/apis/plate_recognition.JPG')
-```
-
----
-
-### `year_make_model` – Query vehicle by year, make, model and trim (optional)
-
-**Required:**
-
-- `year`
-- `make`
-- `model`
-
-**Optional:**
-
-- `trim`
-
-**Example:**
-
-```ruby
-yymm = carsxe.year_make_model('year' => '2012', 'make' => 'BMW', 'model' => '5 Series')
-```
-
----
-
-### `obd_codes_decoder` – Decode OBD error/diagnostic codes
-
-**Required:**
-
-- `code`
-
-**Optional:**
-
-- None
-
-**Example:**
-
-```ruby
-obdcode = carsxe.obd_codes_decoder('code' => 'P0115')
-```
-
----
-
-### `lien_and_theft` – Check for lien and theft records
-
-**Required:**
-
-- `vin`
-
-**Optional:**
-
-- None
-
-**Example:**
-
-```ruby
-lientheft = carsxe.lien_and_theft('vin' => '2C3CDXFG1FH762860')
-```
-
----
-
-## Notes & Best Practices
-
-- **Parameter requirements:** Each endpoint requires specific parameters—see the Required/Optional fields above.
-- **Return values:** All responses are Ruby hashes for easy access and manipulation.
-- **Error handling:** Use begin/rescue blocks to gracefully handle API errors.
-- **More info:** For advanced usage and full details, visit the [official API documentation](https://api.carsxe.com/docs).
-
----
-
-## Overall
-
-CarsXE API provides a wide range of powerful, easy-to-use tools for accessing and integrating vehicle data into your applications and services. Whether you're a developer or a business owner, you can quickly get the information you need to take your projects to the next level—without hassle or inconvenience.
+# 🚗 CarsXE API (Ruby Gem)
+
+[![Gem Version](https://img.shields.io/gem/v/carsxe.svg)](https://rubygems.org/gems/carsxe)
+
+**CarsXE** is a powerful and developer-friendly API that gives you instant access to a wide range of vehicle data. From VIN decoding and market value estimation to vehicle history, images, OBD code explanations, and plate recognition, CarsXE provides everything you need to build automotive applications at scale.
+
+🌐 **Website:** [https://api.carsxe.com](https://api.carsxe.com)  
+📄 **Docs:** [https://api.carsxe.com/docs](https://api.carsxe.com/docs)  
+📦 **All Products:** [https://api.carsxe.com/all-products](https://api.carsxe.com/all-products)
+
+To get started with the CarsXE API, follow these steps:
+
+1. **Sign up for a CarsXE account:**
+   - [Register here](https://api.carsxe.com/register)
+   - Add a [payment method](https://api.carsxe.com/dashboard/billing#payment-methods) to activate your subscription and get your API key.
+
+2. **Install the CarsXE Ruby gem:**
+
+   Run this command in your terminal:
+
+   ```bash
+   gem install carsxe
+   ```
+
+   Or add it to your Gemfile:
+
+   ```ruby
+   gem 'carsxe'
+   ```
+
+   Then run `bundle install`.
+
+3. **Require the CarsXE API in your code:**
+
+   ```ruby
+   require 'carsxe'
+   ```
+
+4. **Initialize the API with your API key:**
+
+   ```ruby
+   API_KEY = 'YOUR_API_KEY'
+   carsxe = Carsxe::CarsXE.new(api_key: API_KEY)
+   ```
+
+5. **Use the various endpoint methods provided by the API to access the data you need.**
+
+## Usage
+
+```ruby
+vin = 'WBAFR7C57CC811956'
+
+begin
+  vehicle = carsxe.specs('vin' => vin)
+  puts vehicle['input']['vin']
+rescue StandardError => error
+  puts "Error: #{error.message}"
+end
+```
+
+---
+
+## 📚 Endpoints
+
+The CarsXE API provides the following endpoint methods:
+
+### `specs` – Decode VIN & get full vehicle specifications
+
+**Required:**
+
+- `vin`
+
+**Optional:**
+
+- `deepdata`
+- `disableIntVINDecoding`
+
+**Example:**
+
+```ruby
+vehicle = carsxe.specs('vin' => 'WBAFR7C57CC811956')
+```
+
+---
+
+### `int_vin_decoder` – Decode VIN with worldwide support
+
+**Required:**
+
+- `vin`
+
+**Optional:**
+
+- None
+
+**Example:**
+
+```ruby
+intvin = carsxe.int_vin_decoder('vin' => 'WF0MXXGBWM8R43240')
+```
+
+---
+
+### `plate_decoder` – Decode license plate info (plate, country)
+
+**Required:**
+
+- `plate`
+- `country` (always required except for US, where it is optional and defaults to 'US')
+
+**Optional:**
+
+- `state` (required for some countries, e.g. US, AU, CA)
+- `district` (required for Pakistan)
+
+> **Note:**
+>
+> - The `state` parameter is required only when applicable (for
+>   specific countries such as US, AU, CA, etc.).
+> - For Pakistan (`country='pk'`), both `state` and `district`
+>   are required.
+
+**Example:**
+
+```ruby
+decoded_plate = carsxe.plate_decoder('plate' => '7XER187', 'state' => 'CA', 'country' => 'US')
+```
+
+---
+
+### `market_value` – Estimate vehicle market value based on VIN
+
+**Required:**
+
+- `vin`
+
+**Optional:**
+
+- `state`
+- `mileage`
+- `condition`
+
+**Example:**
+
+```ruby
+marketvalue = carsxe.market_value('vin' => 'WBAFR7C57CC811956', 'state' => 'CA', 'mileage' => '80000', 'condition' => 'good')
+```
+
+---
+
+### `history` – Retrieve vehicle history
+
+**Required:**
+
+- `vin`
+
+**Optional:**
+
+- None
+
+**Example:**
+
+```ruby
+history = carsxe.history('vin' => 'WBAFR7C57CC811956')
+```
+
+---
+
+### `images` – Fetch images by make, model, year, trim
+
+**Required:**
+
+- `make`
+- `model`
+
+**Optional:**
+
+- `year`
+- `trim`
+- `color`
+- `transparent`
+- `angle`
+- `photoType`
+- `size`
+- `license`
+
+**Example:**
+
+```ruby
+images = carsxe.images('make' => 'BMW', 'model' => 'X5', 'year' => '2019')
+```
+
+---
+
+### `recalls` – Get safety recall data for a VIN
+
+**Required:**
+
+- `vin`
+
+**Optional:**
+
+- None
+
+**Example:**
+
+```ruby
+recalls = carsxe.recalls('vin' => '1C4JJXR64PW696340')
+```
+
+---
+
+### `plate_image_recognition` – Read & decode plates from images
+
+**Required:**
+
+- `upload_url`
+
+**Optional:**
+
+- None
+
+**Example:**
+
+```ruby
+plateimg = carsxe.plate_image_recognition('upload_url' => 'https://api.carsxe.com/img/apis/plate_recognition.JPG')
+```
+
+---
+
+### `vin_ocr` – Extract VINs from images using OCR
+
+**Required:**
+
+- `upload_url`
+
+**Optional:**
+
+- None
+
+**Example:**
+
+```ruby
+vinocr = carsxe.vin_ocr('upload_url' => 'https://api.carsxe.com/img/apis/plate_recognition.JPG')
+```
+
+---
+
+### `year_make_model` – Query vehicle by year, make, model and trim (optional)
+
+**Required:**
+
+- `year`
+- `make`
+- `model`
+
+**Optional:**
+
+- `trim`
+
+**Example:**
+
+```ruby
+yymm = carsxe.year_make_model('year' => '2012', 'make' => 'BMW', 'model' => '5 Series')
+```
+
+---
+
+### `obd_codes_decoder` – Decode OBD error/diagnostic codes
+
+**Required:**
+
+- `code`
+
+**Optional:**
+
+- None
+
+**Example:**
+
+```ruby
+obdcode = carsxe.obd_codes_decoder('code' => 'P0115')
+```
+
+---
+
+### `lien_and_theft` – Check for lien and theft records
+
+**Required:**
+
+- `vin`
+
+**Optional:**
+
+- None
+
+**Example:**
+
+```ruby
+lientheft = carsxe.lien_and_theft('vin' => '2C3CDXFG1FH762860')
+```
+
+---
+
+### `recalls_ymm` – Get safety recalls by year, make, and model
+
+**Required:**
+
+- `year`
+- `make`
+- `model`
+
+**Optional:**
+
+- None
+
+**Example:**
+
+```ruby
+recalls_ymm = carsxe.recalls_ymm('year' => '2026', 'make' => 'toyota', 'model' => 'corolla')
+```
+
+---
+
+### `recalls_batch_submit` – Submit VINs for bulk recall checking
+
+**Required (at least one of):**
+
+- `vins`
+- `csv`
+- `csvUrl`
+
+**Optional:**
+
+- `webhookUrl`
+
+**Example:**
+
+```ruby
+batch = carsxe.recalls_batch_submit('vins' => ['1HGBH41JXMN109186', '5YJSA1E26HF000001'])
+```
+
+---
+
+### `recalls_batch_status` – Check a bulk recalls batch
+
+**Required:**
+
+- `batchId`
+
+**Optional:**
+
+- None
+
+**Example:**
+
+```ruby
+status = carsxe.recalls_batch_status('batchId' => 'brb_mnablbn7_wvbaqv')
+```
+
+---
+
+### `recalls_batch_results` – Fetch bulk recalls results as JSON
+
+**Required:**
+
+- `batchId`
+
+**Optional:**
+
+- None
+
+**Example:**
+
+```ruby
+results = carsxe.recalls_batch_results('batchId' => 'brb_mnablbn7_wvbaqv')
+```
+
+---
+
+### `recalls_batch_download` – Download bulk recalls results as CSV
+
+**Required:**
+
+- `batchId`
+
+**Optional:**
+
+- None
+
+**Example:**
+
+```ruby
+csv = carsxe.recalls_batch_download('batchId' => 'brb_mnablbn7_wvbaqv')
+```
+
+---
+
+### `ymm_options` – List year, make, model, trim, or variant options
+
+**Required:**
+
+- None
+
+**Optional:**
+
+- `dimension`
+- `year`
+- `make`
+- `model`
+- `trim`
+
+**Example:**
+
+```ruby
+options = carsxe.ymm_options('year' => '2026', 'make' => 'Toyota')
+```
+
+---
+
+### `ownership_vin` – Look up registered owner(s) by VIN
+
+**Required:**
+
+- `vin`
+
+**Optional:**
+
+- `include`
+
+**Example:**
+
+```ruby
+owners = carsxe.ownership_vin('vin' => '1FT8X3BT0BEA61538')
+```
+
+---
+
+### `ownership_person` – Look up ownership by name and address
+
+**Required:**
+
+- `first_name`
+- `last_name`
+- `address`
+- `zip`
+
+**Optional:**
+
+- `include`
+
+**Example:**
+
+```ruby
+person = carsxe.ownership_person('first_name' => 'John', 'last_name' => 'Sample', 'address' => '123 Example St', 'zip' => '90210')
+```
+
+---
+
+### `ownership_address` – Look up residents at a street address
+
+**Required:**
+
+- `address`
+- `zip`
+
+**Optional:**
+
+- `include`
+- `variant`
+
+**Example:**
+
+```ruby
+address = carsxe.ownership_address('address' => '123 Example St', 'zip' => '90210')
+```
+
+---
+
+### `ownership_zip` – Search owners in a ZIP code
+
+**Required:**
+
+- `zip`
+
+**Optional:**
+
+- `gender`
+- `min_age`
+- `max_age`
+- `income`
+- `page`
+- `limit`
+- `include`
+- `variant`
+
+**Example:**
+
+```ruby
+zip_owners = carsxe.ownership_zip('zip' => '90210', 'limit' => '15')
+```
+
+---
+
+## Notes & Best Practices
+
+- **Parameter requirements:** Each endpoint requires specific parameters—see the Required/Optional fields above.
+- **Return values:** Responses are Ruby hashes. `recalls_batch_download` returns CSV text.
+- **Error handling:** Use begin/rescue blocks to gracefully handle API errors.
+- **More info:** For advanced usage and full details, visit the [official API documentation](https://api.carsxe.com/docs).
+
+---
+
+## Overall
+
+CarsXE API provides a wide range of powerful, easy-to-use tools for accessing and integrating vehicle data into your applications and services. Whether you're a developer or a business owner, you can quickly get the information you need to take your projects to the next level—without hassle or inconvenience.

data/lib/carsxe/carsxe.rb

@@ -55,7 +55,7 @@ module Carsxe
       url = "#{api_base_url}/platerecognition?key=#{api_key}&source=ruby"
       if params.size == 1
         first_key, first_value = params.first
-        post_json(url, { first_key => first_value })
+        post_json(url, {first_key => first_value})
       else
         raise ArgumentError, "Expected exactly one parameter, but got #{params.size}"
       end
@@ -65,7 +65,7 @@ module Carsxe
       url = "#{api_base_url}/v1/vinocr?key=#{api_key}&source=ruby"
       if params.size == 1
         first_key, first_value = params.first
-        post_json(url, { first_key => first_value })
+        post_json(url, {first_key => first_value})
       else
         raise ArgumentError, "Expected exactly one parameter, but got #{params.size}"
       end
@@ -83,6 +83,55 @@ module Carsxe
       get("v1/lien-theft", params, Types::VIN_INPUT)
     end
 
+    def recalls_ymm(params = {})
+      get("v1/recalls-ymm", params, Types::RECALLS_YMM_INPUT)
+    end
+
+    def recalls_batch_submit(params = {})
+      unless params["vins"] || params["csv"] || params["csvUrl"]
+        raise ArgumentError, "Missing required parameter(s): vins, csv, or csvUrl"
+      end
+
+      url = "#{api_base_url}/v1/recalls-batch/submit?key=#{api_key}&source=ruby"
+      payload = {}
+      %w[vins csv csvUrl webhookUrl].each do |key|
+        payload[key] = params[key] if params.key?(key) && !params[key].nil?
+      end
+      post_json(url, payload)
+    end
+
+    def recalls_batch_status(params = {})
+      get("v1/recalls-batch/status", params, Types::RECALLS_BATCH_INPUT)
+    end
+
+    def recalls_batch_results(params = {})
+      get("v1/recalls-batch/results", params, Types::RECALLS_BATCH_INPUT)
+    end
+
+    def recalls_batch_download(params = {})
+      get("v1/recalls-batch/download", params, Types::RECALLS_BATCH_INPUT)
+    end
+
+    def ymm_options(params = {})
+      get("v1/ymm-options", params, Types::YMM_OPTIONS_INPUT)
+    end
+
+    def ownership_vin(params = {})
+      get("v1/ownership/vin", params, Types::OWNERSHIP_VIN_INPUT)
+    end
+
+    def ownership_person(params = {})
+      get("v1/ownership/person", params, Types::OWNERSHIP_PERSON_INPUT)
+    end
+
+    def ownership_address(params = {})
+      get("v1/ownership/address", params, Types::OWNERSHIP_ADDRESS_INPUT)
+    end
+
+    def ownership_zip(params = {})
+      get("v1/ownership/zip", params, Types::OWNERSHIP_ZIP_INPUT)
+    end
+
     private
 
     # Determine required and optional keys from a param definition hash.
@@ -96,10 +145,10 @@ module Carsxe
       # Special case for plate decoder params
       if param_def.equal?(Types::PLATE_DECODER_PARAMS)
         country = if params && params["country"]
-                    params["country"].to_s.downcase
-                  else
-                    "us"
-                  end
+          params["country"].to_s.downcase
+        else
+          "us"
+        end
 
         if country == "pk" || country == "pakistan"
           required |= ["state", "district"]
@@ -115,7 +164,7 @@ module Carsxe
       if params
         missing = required.reject { |k| params.key?(k) && !params[k].nil? }
         unless missing.empty?
-          raise ArgumentError, "Missing required parameter(s): #{missing.join(', ')}"
+          raise ArgumentError, "Missing required parameter(s): #{missing.join(", ")}"
         end
       end
 
@@ -173,8 +222,9 @@ module Carsxe
 
     def parse_response(response)
       body = response.body.to_s
-      parsed=JSON.parse(body) 
-      parsed
+      JSON.parse(body)
+    rescue JSON::ParserError
+      body
     end
   end
-end
+end

data/lib/carsxe/types.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 #
 # Parameter "schemas" used by the client to determine required vs optional keys.
 # Values are :required or :optional (simple representation, enough for validation here).
@@ -10,30 +11,30 @@ module Carsxe
     }.freeze
 
     MARKET_VALUE_INPUT = {
-      "vin"       => :required,
-      "state"     => :optional,
-      "mileage"   => :optional,
+      "vin" => :required,
+      "state" => :optional,
+      "mileage" => :optional,
       "condition" => :optional
     }.freeze
 
     PLATE_DECODER_PARAMS = {
-      "plate"    => :required,
-      "country"  => :optional, # country is allowed but not strictly required by default
-      "state"    => :optional,
+      "plate" => :required,
+      "country" => :optional, # country is allowed but not strictly required by default
+      "state" => :optional,
       "district" => :optional
     }.freeze
 
     IMAGE_INPUT = {
-      "make"        => :required,
-      "model"       => :required,
-      "year"        => :optional,
-      "trim"        => :optional,
-      "color"       => :optional,
+      "make" => :required,
+      "model" => :required,
+      "year" => :optional,
+      "trim" => :optional,
+      "color" => :optional,
       "transparent" => :optional,
-      "angle"       => :optional,
-      "photoType"   => :optional,
-      "size"        => :optional,
-      "license"     => :optional
+      "angle" => :optional,
+      "photoType" => :optional,
+      "size" => :optional,
+      "license" => :optional
     }.freeze
 
     OBDCODESDECODER_INPUT = {
@@ -49,16 +50,66 @@ module Carsxe
     }.freeze
 
     YEAR_MAKE_MODEL_INPUT = {
-      "year"  => :required,
-      "make"  => :required,
+      "year" => :required,
+      "make" => :required,
       "model" => :required,
-      "trim"  => :optional
+      "trim" => :optional
     }.freeze
 
     SPECS_INPUT = {
-      "vin"                     => :required,
-      "deepData"                => :optional,
-      "disableIntVINDecoding"   => :optional
+      "vin" => :required,
+      "deepData" => :optional,
+      "disableIntVINDecoding" => :optional
+    }.freeze
+
+    RECALLS_YMM_INPUT = {
+      "year" => :required,
+      "make" => :required,
+      "model" => :required
+    }.freeze
+
+    RECALLS_BATCH_INPUT = {
+      "batchId" => :required
+    }.freeze
+
+    YMM_OPTIONS_INPUT = {
+      "dimension" => :optional,
+      "year" => :optional,
+      "make" => :optional,
+      "model" => :optional,
+      "trim" => :optional
+    }.freeze
+
+    OWNERSHIP_VIN_INPUT = {
+      "vin" => :required,
+      "include" => :optional
+    }.freeze
+
+    OWNERSHIP_PERSON_INPUT = {
+      "first_name" => :required,
+      "last_name" => :required,
+      "address" => :required,
+      "zip" => :required,
+      "include" => :optional
+    }.freeze
+
+    OWNERSHIP_ADDRESS_INPUT = {
+      "address" => :required,
+      "zip" => :required,
+      "include" => :optional,
+      "variant" => :optional
+    }.freeze
+
+    OWNERSHIP_ZIP_INPUT = {
+      "zip" => :required,
+      "gender" => :optional,
+      "min_age" => :optional,
+      "max_age" => :optional,
+      "income" => :optional,
+      "page" => :optional,
+      "limit" => :optional,
+      "include" => :optional,
+      "variant" => :optional
     }.freeze
   end
-end
+end

data/lib/carsxe/version.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
-
-module Carsxe
-  VERSION = "1.2.0"
-end
+# frozen_string_literal: true
+
+module Carsxe
+  VERSION = "1.3.0"
+end

data/lib/carsxe.rb

@@ -1,2 +1,2 @@
 require "carsxe/version"
-require "carsxe/carsxe"
+require "carsxe/carsxe"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: carsxe
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - CarsXE Developer
@@ -29,7 +29,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- carsxe-1.1.1.gem
 - lib/carsxe.rb
 - lib/carsxe/carsxe.rb
 - lib/carsxe/types.rb