maytes-api-client-rb 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 20554fbc0822fb7425d36ab1910c844cb60cabb55989a3a36ed3e4e6f7ce7ec6
+  data.tar.gz: 3ae75434416e7428a56c8e58e7fcc3a740a8eb49bf16fb4cc32b7a000d5e61e0
+SHA512:
+  metadata.gz: 267a7cdd7f40288025fe1b2d84fca38cc61595f602b0928c938942158bbf16274ce44c741b3e33be615efe71e5cb39ec9a68614596105c101d534f2dfe948713
+  data.tar.gz: c4b533c7a1c9727ad96faf6990b898abf3fea01f38bc3a86d26c8ccadf8ad145aebe9840da5e9b056776ced86597827ce2cdb5123caa5a4b36698ebb258f731b

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Maytes
+
+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,47 @@
+# Maytes Ruby SDK
+
+Official Ruby client for the [Maytes API](https://developers.maytes.co) — create,
+capture and cancel checkouts, and verify inbound webhook signatures.
+
+> **Generated package.** This repository is a build artefact, published from the
+> Maytes API service definition. Pull requests here are not accepted — file
+> issues instead, and fixes land upstream in the source model.
+
+## Install
+
+```bash
+gem install maytes-api-client-rb
+```
+
+## Usage
+
+The client mints an OAuth2 `client_credentials` token on first use, caches it,
+and — on a `401` — refreshes and retries the request once. There is no
+client-side expiry maths to get wrong, and no proactive refresh to schedule.
+
+```ruby
+require 'maytes_api_client'
+
+api = MaytesApiClient.create_maytes_api_client(
+  endpoint: endpoint, client_id: client_id, client_secret: client_secret,
+)
+checkout = api.create_checkout(request)
+
+event = MaytesApiClient.verify_webhook_signature(raw_body, signature_header, signing_secret)
+```
+
+The gem is `maytes-api-client-rb`; the require path is `maytes_api_client`.
+
+### Verifying webhooks
+
+Verify **before** parsing the body, and pass the raw request bytes — not a
+re-encoded object. Re-serialising changes the bytes and the signature will not
+match. The event id is stable across retries, so deduplicate on it.
+
+## Documentation
+
+Full integration docs: <https://developers.maytes.co>
+
+## License
+
+MIT — see [LICENSE](LICENSE).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/CancelCheckout409Response.md

@@ -0,0 +1,24 @@
+# MaytesApiClient::CancelCheckout409Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  |  |
+| **error** | **String** |  |  |
+| **code** | **String** |  |  |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CancelCheckout409Response.new(
+  message: null,
+  error: null,
+  code: null,
+  metadata: null
+)
+```
+

data/docs/CancelCheckoutRequest.md

@@ -0,0 +1,18 @@
+# MaytesApiClient::CancelCheckoutRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **merchant_order_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CancelCheckoutRequest.new(
+  merchant_order_id: null
+)
+```
+

data/docs/CancelCheckoutResponse.md

@@ -0,0 +1,18 @@
+# MaytesApiClient::CancelCheckoutResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**CheckoutCancelled**](CheckoutCancelled.md) |  |  |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CancelCheckoutResponse.new(
+  data: null
+)
+```
+

data/docs/CaptureCheckout409Response.md

@@ -0,0 +1,24 @@
+# MaytesApiClient::CaptureCheckout409Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  |  |
+| **error** | **String** |  |  |
+| **code** | **String** |  |  |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CaptureCheckout409Response.new(
+  message: null,
+  error: null,
+  code: null,
+  metadata: null
+)
+```
+

data/docs/CaptureCheckout422Response.md

@@ -0,0 +1,24 @@
+# MaytesApiClient::CaptureCheckout422Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  |  |
+| **error** | **String** |  |  |
+| **code** | **String** |  |  |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CaptureCheckout422Response.new(
+  message: null,
+  error: null,
+  code: null,
+  metadata: null
+)
+```
+

data/docs/CaptureCheckoutRequest.md

@@ -0,0 +1,24 @@
+# MaytesApiClient::CaptureCheckoutRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **merchant_order_id** | **String** |  | [optional] |
+| **expected_total_amount** | **Integer** |  | [optional] |
+| **currency** | **String** |  | [optional] |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CaptureCheckoutRequest.new(
+  merchant_order_id: null,
+  expected_total_amount: null,
+  currency: null,
+  metadata: null
+)
+```
+

data/docs/CaptureCheckoutResponse.md

@@ -0,0 +1,18 @@
+# MaytesApiClient::CaptureCheckoutResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**CheckoutCaptured**](CheckoutCaptured.md) |  |  |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CaptureCheckoutResponse.new(
+  data: null
+)
+```
+

data/docs/Checkout.md

@@ -0,0 +1,48 @@
+# MaytesApiClient::Checkout
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **checkout_uuid** | **String** |  |  |
+| **merchant_order_id** | **String** |  |  |
+| **status** | **String** |  |  |
+| **transaction_ref** | **String** |  |  |
+| **checkout_url** | **String** |  |  |
+| **merchant_expires_at** | **Time** |  |  |
+| **captured_at** | **Time** |  |  |
+| **return_url** | **String** |  |  |
+| **cancel_url** | **String** |  |  |
+| **amount** | **Integer** |  |  |
+| **currency** | **String** |  |  |
+| **service_fee** | [**Fee**](Fee.md) |  |  |
+| **refunded_amount** | **Integer** |  |  |
+| **merchant_processor_fee** | **Integer** |  |  |
+| **merchant_service_fee** | **Integer** |  |  |
+| **last_refund_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::Checkout.new(
+  checkout_uuid: null,
+  merchant_order_id: null,
+  status: null,
+  transaction_ref: null,
+  checkout_url: null,
+  merchant_expires_at: null,
+  captured_at: null,
+  return_url: null,
+  cancel_url: null,
+  amount: null,
+  currency: null,
+  service_fee: null,
+  refunded_amount: null,
+  merchant_processor_fee: null,
+  merchant_service_fee: null,
+  last_refund_at: null
+)
+```
+

data/docs/CheckoutCancelled.md

@@ -0,0 +1,22 @@
+# MaytesApiClient::CheckoutCancelled
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **checkout_uuid** | **String** |  |  |
+| **merchant_order_id** | **String** |  |  |
+| **status** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CheckoutCancelled.new(
+  checkout_uuid: null,
+  merchant_order_id: null,
+  status: null
+)
+```
+

data/docs/CheckoutCaptured.md

@@ -0,0 +1,28 @@
+# MaytesApiClient::CheckoutCaptured
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **checkout_uuid** | **String** |  |  |
+| **merchant_order_id** | **String** |  |  |
+| **status** | **String** |  |  |
+| **captured_at** | **Time** |  |  |
+| **amount** | **Integer** |  |  |
+| **currency** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CheckoutCaptured.new(
+  checkout_uuid: null,
+  merchant_order_id: null,
+  status: null,
+  captured_at: null,
+  amount: null,
+  currency: null
+)
+```
+

data/docs/CheckoutCreated.md

@@ -0,0 +1,24 @@
+# MaytesApiClient::CheckoutCreated
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **checkout_uuid** | **String** |  |  |
+| **status** | **String** |  |  |
+| **checkout_url** | **String** |  |  |
+| **expires_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CheckoutCreated.new(
+  checkout_uuid: null,
+  status: null,
+  checkout_url: null,
+  expires_at: null
+)
+```
+

data/docs/CheckoutDiscount.md

@@ -0,0 +1,30 @@
+# MaytesApiClient::CheckoutDiscount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **description** | **String** |  | [optional] |
+| **scope** | **String** |  |  |
+| **amount** | **Integer** |  |  |
+| **currency** | **String** |  |  |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **applies_to** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CheckoutDiscount.new(
+  name: null,
+  description: null,
+  scope: null,
+  amount: null,
+  currency: null,
+  metadata: null,
+  applies_to: null
+)
+```
+

data/docs/CheckoutFee.md

@@ -0,0 +1,32 @@
+# MaytesApiClient::CheckoutFee
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **description** | **String** |  | [optional] |
+| **fee_type** | **String** |  | [optional] |
+| **scope** | **String** |  |  |
+| **amount** | **Integer** |  |  |
+| **currency** | **String** |  |  |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **applies_to** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CheckoutFee.new(
+  name: null,
+  description: null,
+  fee_type: null,
+  scope: null,
+  amount: null,
+  currency: null,
+  metadata: null,
+  applies_to: null
+)
+```
+

data/docs/CreateCheckout401Response.md

@@ -0,0 +1,24 @@
+# MaytesApiClient::CreateCheckout401Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  |  |
+| **error** | **String** |  |  |
+| **code** | **String** |  |  |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CreateCheckout401Response.new(
+  message: null,
+  error: null,
+  code: null,
+  metadata: null
+)
+```
+

data/docs/CreateCheckout409Response.md

@@ -0,0 +1,24 @@
+# MaytesApiClient::CreateCheckout409Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  |  |
+| **error** | **String** |  |  |
+| **code** | **String** |  |  |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CreateCheckout409Response.new(
+  message: null,
+  error: null,
+  code: null,
+  metadata: null
+)
+```
+

data/docs/CreateCheckout422Response.md

@@ -0,0 +1,24 @@
+# MaytesApiClient::CreateCheckout422Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  |  |
+| **error** | **String** |  |  |
+| **code** | **String** |  |  |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CreateCheckout422Response.new(
+  message: null,
+  error: null,
+  code: null,
+  metadata: null
+)
+```
+

data/docs/CreateCheckoutRequest.md

@@ -0,0 +1,44 @@
+# MaytesApiClient::CreateCheckoutRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **merchant_order_id** | **String** |  | [optional] |
+| **merchant_expires_at** | **Time** |  | [optional] |
+| **total_amount** | **Integer** |  |  |
+| **currency** | **String** |  |  |
+| **return_url** | **String** |  |  |
+| **cancel_url** | **String** |  |  |
+| **items** | [**Array<LineItem>**](LineItem.md) |  |  |
+| **fees** | [**Array<CheckoutFee>**](CheckoutFee.md) |  | [optional] |
+| **discounts** | [**Array<CheckoutDiscount>**](CheckoutDiscount.md) |  | [optional] |
+| **tax** | [**Tax**](Tax.md) |  | [optional] |
+| **shipping_amount** | **Integer** |  | [optional] |
+| **customer_data** | [**CustomerData**](CustomerData.md) |  | [optional] |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **allocation_model** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CreateCheckoutRequest.new(
+  merchant_order_id: null,
+  merchant_expires_at: null,
+  total_amount: null,
+  currency: null,
+  return_url: null,
+  cancel_url: null,
+  items: null,
+  fees: null,
+  discounts: null,
+  tax: null,
+  shipping_amount: null,
+  customer_data: null,
+  metadata: null,
+  allocation_model: null
+)
+```
+

data/docs/CreateCheckoutResponse.md

@@ -0,0 +1,18 @@
+# MaytesApiClient::CreateCheckoutResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**CheckoutCreated**](CheckoutCreated.md) |  |  |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CreateCheckoutResponse.new(
+  data: null
+)
+```
+

data/docs/CreateRefundRequest.md

@@ -0,0 +1,20 @@
+# MaytesApiClient::CreateRefundRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reason** | **String** | Free-text reason; forwarded to Stripe as refund metadata. | [optional] |
+| **merchant_refund_ref** | **String** | Idempotency key scoped to the merchant. Repeating the same value returns the existing refund. |  |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CreateRefundRequest.new(
+  reason: null,
+  merchant_refund_ref: null
+)
+```
+

data/docs/CustomerData.md

@@ -0,0 +1,22 @@
+# MaytesApiClient::CustomerData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **mobile** | **String** |  | [optional] |
+| **email** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'maytes_api_client'
+
+instance = MaytesApiClient::CustomerData.new(
+  name: null,
+  mobile: null,
+  email: null
+)
+```
+