payabli 3.0.2 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 215e41e74ef3bd2fa5cf53366a25cce7d0d084eec1ec74067d49b05607d58271
-  data.tar.gz: bd0c29b5a3d830ebe2ba870fe4b13a61a91a69abeda2b56345c3608aac8c394e
+  metadata.gz: ba6433fa0be5362832d5430527bae26321e6d8f10a8aa1a62366742fbce5b0a2
+  data.tar.gz: 427557254056844c433a4fc82e023b1144d5c82458aff1e5a77fb1264ed1a795
 SHA512:
-  metadata.gz: a97fd769f512ef83d9ecbabfe846f91da4d1871c816d163e6ed77f067927b5260484cc425481dcac1d63d63bf5ee4adaa042220ed5ecb8002a1398c9808ced6a
-  data.tar.gz: aa953f69cda7ae3ec828a9149c1c24f35079bed28933a7a408f83a36085f6390658b9994be3144551f277ba62149073d5c2ef294efa4ecb4aa7975a25be88e53
+  metadata.gz: f99db2b158290293363055837d01b63802afb3d81e5d3d2ff453599dd2578a56fd902f522de63b51c65744cb0e2a644183636b9d124e139a8ba15cdc3d65e226
+  data.tar.gz: 496bdb849ed1aeaf582a6c0af089da120cf00a1495a55948c4de04c7394d446d3ae8af055fb0ff71a0acb50a2fb6f2ffbf0aa911a3ee6ee3b45a17500f91a16b

data/.fern/metadata.json

@@ -1,15 +1,15 @@
 {
   "cliVersion": "5.56.0",
   "generatorName": "fernapi/fern-ruby-sdk",
-  "generatorVersion": "1.12.7",
+  "generatorVersion": "1.15.2",
   "generatorConfig": {
     "enableWireTests": true,
     "rubocopVariableNumberStyle": "snake_case"
   },
-  "originGitCommit": "1aeb9b5f59cac476a429df4671f575ed07ab5731",
+  "originGitCommit": "4a292ff89b1a47f4e159d99e6b8ac1d9af84a653",
   "originGitCommitIsDirty": true,
   "invokedBy": "ci",
-  "requestedVersion": "3.0.2",
+  "requestedVersion": "3.0.4",
   "ciProvider": "github",
-  "sdkVersion": "3.0.2"
+  "sdkVersion": "3.0.4"
 }

data/README.md

@@ -71,7 +71,10 @@ Instantiate and use the client with the following:
 ```ruby
 require "payabli"
 
-client = Payabli::Client.new(api_key: "<value>")
+client = Payabli::Client.new(
+  client_id: "<clientId>",
+  client_secret: "<clientSecret>"
+)
 
 client.money_in.getpaidv_2(
   customer_data: {

data/lib/payabli/client.rb

@@ -2,18 +2,42 @@
 
 module Payabli
   class Client
-    # @param api_key [String]
     # @param base_url [String, nil]
+    # @param client_id [String, nil]
+    # @param client_secret [String, nil]
+    # @param api_key [String, nil]
+    # @param max_retries [Integer]
     #
     # @return [void]
-    def initialize(api_key:, base_url: nil)
+    def initialize(base_url: nil, client_id: ENV.fetch("OAUTH_CLIENT_ID", nil), client_secret: ENV.fetch("OAUTH_CLIENT_SECRET", nil), api_key: nil, max_retries: 2)
+      if !client_id.to_s.empty? && !client_secret.to_s.empty?
+        # Create an unauthenticated client for the auth endpoint
+        auth_raw_client = Payabli::Internal::Http::RawClient.new(
+          base_url: base_url || Payabli::Environment::SANDBOX,
+          headers: {
+            "X-Fern-Language" => "Ruby"
+          }
+        )
+
+        # Create the auth client for token retrieval
+        auth_client = Payabli::Token::Client.new(client: auth_raw_client)
+
+        # Create the OAuth provider with the auth client and credentials
+        @auth_provider = Payabli::Internal::OAuthProvider.new(
+          auth_client: auth_client,
+          options: { base_url: base_url, client_id: client_id, client_secret: client_secret }
+        )
+      end
+
       @raw_client = Payabli::Internal::Http::RawClient.new(
         base_url: base_url || Payabli::Environment::SANDBOX,
         headers: {
-          "User-Agent" => "payabli/3.0.2",
+          "User-Agent" => "payabli/3.0.4",
           "X-Fern-Language" => "Ruby",
           requestToken: api_key.to_s
-        }
+        },
+        auth_provider: @auth_provider,
+        max_retries: max_retries
       )
     end
 
@@ -37,6 +61,11 @@ module Payabli
       @money_in ||= Payabli::MoneyIn::Client.new(client: @raw_client)
     end
 
+    # @return [Payabli::Token::Client]
+    def token
+      @token ||= Payabli::Token::Client.new(client: @raw_client)
+    end
+
     # @return [Payabli::Subscription::Client]
     def subscription
       @subscription ||= Payabli::Subscription::Client.new(client: @raw_client)

data/lib/payabli/customer/client.rb

@@ -11,7 +11,7 @@ module Payabli
       end
 
       # Creates a customer in an entrypoint. An identifier is required to create customer records. Change your
-      # identifier settings in Settings > Custom Fields in PartnerHub.
+      # identifier settings in Settings > Custom Fields in the Payabli Portal.
       # If you don't include an identifier, the record is rejected.
       #
       # @param request_options [Hash]

data/lib/payabli/internal/http/raw_client.rb

@@ -21,10 +21,14 @@ module Payabli
         # @param max_retries [Integer] The number of times to retry a failed request, defaults to 2.
         # @param timeout [Float] The timeout for the request, defaults to 60.0 seconds.
         # @param headers [Hash] The headers for the request.
-        def initialize(base_url:, max_retries: 2, timeout: 60.0, headers: {})
+        # @param auth_provider [Object, nil] An optional auth provider responding to
+        #   `auth_headers`. When present its headers are resolved on every request so
+        #   token-based schemes (e.g. OAuth) can refresh an expired token mid-session.
+        def initialize(base_url:, max_retries: 2, timeout: 60.0, headers: {}, auth_provider: nil)
           @base_url = base_url
           @max_retries = max_retries
           @timeout = timeout
+          @auth_provider = auth_provider
           @default_headers = {
             "X-Fern-Language": "Ruby",
             "X-Fern-SDK-Name": "payabli",
@@ -36,6 +40,9 @@ module Payabli
         # @return [HTTP::Response] The HTTP response.
         def send(request)
           url = build_url(request)
+          # Resolve auth headers once per request (not per retry) so token-based
+          # providers refresh at most once here; static providers are cheap.
+          auth_headers = resolve_auth_headers
           attempt = 0
           response = nil
 
@@ -43,8 +50,9 @@ module Payabli
             http_request = build_http_request(
               url:,
               method: request.method,
-              headers: request.encode_headers(protected_keys: @default_headers.keys),
-              body: request.encode_body
+              headers: request.encode_headers(protected_keys: @default_headers.keys + auth_headers.keys),
+              body: request.encode_body,
+              auth_headers: auth_headers
             )
 
             conn = connect(url)
@@ -157,12 +165,27 @@ module Payabli
                 "HTTP is only allowed for localhost. Use HTTPS or pass a localhost URL."
         end
 
+        # Resolves the auth headers to send with the next request. Delegates to the
+        # configured auth provider (if any) on every call so that token-based
+        # providers (e.g. OAuth client-credentials) can refresh an expired token
+        # before the request is sent. Returns an empty hash when no provider is set,
+        # which keeps the api-key / basic / bearer / no-auth paths unchanged.
+        # @return [Hash] The auth headers for the current request.
+        def resolve_auth_headers
+          return {} if @auth_provider.nil?
+
+          @auth_provider.auth_headers
+        end
+
         # @param url [URI::Generic] The url to the resource.
         # @param method [String] The HTTP method to use.
         # @param headers [Hash] The headers for the request.
         # @param body [String, nil] The body for the request.
+        # @param auth_headers [Hash] The auth headers resolved for this request. These
+        #   take precedence over the static default headers but not over per-request
+        #   headers, mirroring the previous baked-header precedence.
         # @return [HTTP::Request] The HTTP request.
-        def build_http_request(url:, method:, headers: {}, body: nil)
+        def build_http_request(url:, method:, headers: {}, body: nil, auth_headers: {})
           request = Net::HTTPGenericRequest.new(
             method,
             !body.nil?,
@@ -170,7 +193,7 @@ module Payabli
             url
           )
 
-          request_headers = @default_headers.merge(headers)
+          request_headers = @default_headers.merge(auth_headers).merge(headers)
           request_headers.each { |name, value| request[name] = value }
           request.body = body if body
 

data/lib/payabli/internal/oauth_provider.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Internal
+    class OAuthProvider
+      BUFFER_IN_SECONDS = 120 # 2 minutes
+
+      # @param auth_client [untyped]
+      # @param options [Hash[String, untyped]]
+      #
+      # @return [void]
+      def initialize(auth_client:, options:)
+        @auth_client = auth_client
+        @options = options
+        @access_token = nil
+        @expires_at = nil
+      end
+
+      # Returns a cached access token, refreshing if necessary.
+      # Refreshes the token if it's nil, or if we're within the buffer period before expiration.
+      #
+      # @return [String]
+      def token
+        return refresh if @access_token.nil? || token_needs_refresh?
+
+        @access_token
+      end
+
+      # Returns the authentication headers to be included in requests.
+      #
+      # @return [Hash[String, String]]
+      def auth_headers
+        access_token = token
+        {
+          Authorization: "Bearer #{access_token}"
+        }
+      end
+
+      # Checks if the token needs to be refreshed.
+      # Returns true if the token will expire within the buffer period.
+      #
+      # @return [Boolean]
+      private def token_needs_refresh?
+        return true if @expires_at.nil?
+
+        Time.now >= (@expires_at - BUFFER_IN_SECONDS)
+      end
+
+      # Refreshes the access token by calling the token endpoint.
+      #
+      # @return [String]
+      private def refresh
+        request_params = {
+          client_id: @options[:client_id],
+          client_secret: @options[:client_secret]
+        }
+
+        token_response = @auth_client.create_server_side_token(**request_params)
+
+        @access_token = token_response.access_token
+        @expires_at = Time.now + token_response.expires_in
+
+        @access_token
+      end
+    end
+  end
+end

data/lib/payabli/money_out/client.rb

@@ -18,13 +18,18 @@ module Payabli
       # When `autoCapture` is `true`, Payabli captures the transaction asynchronously after authorization. The response
       # confirms only that the transaction was authorized; it doesn't confirm that capture succeeded. To confirm
       # capture, listen for the
-      # [`payout_transaction_approvedcaptured`](/developers/webhooks/payout-transaction-approved-captured) webhook
-      # event.
+      # [`payout_transaction_approvedcaptured`](/developers/api-reference/webhooks-overview/payout-transaction-approved-captured)
+      # webhook event.
       #
       # If a velocity fraud alert is triggered, the endpoint returns a `202` response with `responseCode` `9051`, and
       # the authorization is held for risk review rather than rejected. If a risk policy blocks the transaction, the
       # endpoint returns a `422` response with `responseCode` `9005`, a terminal rejection.
       #
+      # For check payouts, Payabli validates the remit (mailing) address at authorization. If the address fails
+      # deliverability validation, the endpoint returns a `422` response and doesn't charge the paypoint. Correct the
+      # address and re-authorize. Other payout rails (ACH, RTP, virtual card, wire, and managed payables) aren't
+      # affected.
+      #
       # @param request_options [Hash]
       # @param params [Payabli::MoneyOut::Types::RequestOutAuthorize]
       # @option request_options [String] :base_url

data/lib/payabli/token/client.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Token
+    class Client
+      # @param client [Payabli::Internal::Http::RawClient]
+      #
+      # @return [void]
+      def initialize(client:)
+        @client = client
+      end
+
+      # Exchanges a client ID and client secret for a short-lived Bearer access token using the OAuth2
+      # client-credentials flow. Designed for server-to-server use: the credentials and the returned token stay on your
+      # backend. Send the returned `access_token` in the `Authorization` header as `Bearer <access_token>` on subsequent
+      # API calls. See the [OAuth authentication guide](/developers/oauth-authentication) for the full flow.
+      #
+      # @param request_options [Hash]
+      # @param params [Payabli::Token::Types::CreateServerSideTokenRequest]
+      # @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
+      #
+      # @return [Payabli::Types::PayabliAccessTokenResponse]
+      def create_server_side_token(request_options: {}, **params)
+        params = Payabli::Internal::Types::Utils.normalize_keys(params)
+        request = Payabli::Internal::JSON::Request.new(
+          base_url: request_options[:base_url],
+          method: "POST",
+          path: "v2/Token/serverside",
+          body: Payabli::Token::Types::CreateServerSideTokenRequest.new(params).to_h,
+          request_options: request_options
+        )
+        begin
+          response = @client.send(request)
+        rescue Net::HTTPRequestTimeout
+          raise Payabli::Errors::TimeoutError
+        end
+        code = response.code.to_i
+        if code.between?(200, 299)
+          Payabli::Types::PayabliAccessTokenResponse.load(response.body)
+        else
+          error_class = Payabli::Errors::ResponseError.subclass_for_code(code)
+          raise error_class.new(response.body, code: code)
+        end
+      end
+    end
+  end
+end

data/lib/payabli/token/types/create_server_side_token_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Token
+    module Types
+      class CreateServerSideTokenRequest < Internal::Types::Model
+        field :client_id, -> { String }, optional: false, nullable: false, api_name: "clientId"
+
+        field :client_secret, -> { String }, optional: false, nullable: false, api_name: "clientSecret"
+
+        field :state, -> { String }, optional: true, nullable: false
+
+        field :permissions, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+      end
+    end
+  end
+end

data/lib/payabli/types/add_device_response.rb

@@ -3,6 +3,10 @@
 module Payabli
   module Types
     class AddDeviceResponse < Internal::Types::Model
+      field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
+
+      field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
+
       field :page_identifier, -> { String }, optional: true, nullable: false, api_name: "pageIdentifier"
 
       field :response_data, -> { String }, optional: true, nullable: false, api_name: "responseData"

data/lib/payabli/types/add_method_response.rb

@@ -3,6 +3,10 @@
 module Payabli
   module Types
     class AddMethodResponse < Internal::Types::Model
+      field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
+
+      field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
+
       field :response_data, -> { Payabli::Types::AddMethodResponseResponseData }, optional: true, nullable: false, api_name: "responseData"
     end
   end

data/lib/payabli/types/add_response_response.rb

@@ -3,6 +3,10 @@
 module Payabli
   module Types
     class AddResponseResponse < Internal::Types::Model
+      field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
+
+      field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
+
       field :response_data, -> { Integer }, optional: true, nullable: false, api_name: "responseData"
     end
   end

data/lib/payabli/types/bill_pay_out_data.rb

@@ -5,27 +5,33 @@ module Payabli
     class BillPayOutData < Internal::Types::Model
       field :bill_id, -> { Integer }, optional: true, nullable: false, api_name: "billId"
 
-      field :comments, -> { String }, optional: true, nullable: false
+      field :lot_number, -> { String }, optional: true, nullable: false, api_name: "LotNumber"
 
-      field :due_date, -> { String }, optional: false, nullable: true, api_name: "dueDate"
+      field :accounting_field_1, -> { String }, optional: true, nullable: false, api_name: "AccountingField1"
 
-      field :invoice_date, -> { String }, optional: false, nullable: true, api_name: "invoiceDate"
+      field :accounting_field_2, -> { String }, optional: true, nullable: false, api_name: "AccountingField2"
+
+      field :terms, -> { Payabli::Types::Terms }, optional: true, nullable: false, api_name: "Terms"
+
+      field :additional_data, -> { String }, optional: true, nullable: false, api_name: "AdditionalData"
+
+      field :attachments, -> { Internal::Types::Array[Payabli::Types::FileContent] }, optional: true, nullable: false
 
       field :invoice_number, -> { String }, optional: true, nullable: false, api_name: "invoiceNumber"
 
       field :net_amount, -> { String }, optional: true, nullable: false, api_name: "netAmount"
 
-      field :discount, -> { String }, optional: true, nullable: false
+      field :invoice_date, -> { String }, optional: false, nullable: true, api_name: "invoiceDate"
 
-      field :terms, -> { Payabli::Types::Terms }, optional: true, nullable: false, api_name: "Terms"
+      field :due_date, -> { String }, optional: false, nullable: true, api_name: "dueDate"
 
-      field :accounting_field_1, -> { String }, optional: true, nullable: false, api_name: "AccountingField1"
+      field :comments, -> { String }, optional: true, nullable: false
 
-      field :accounting_field_2, -> { String }, optional: true, nullable: false, api_name: "AccountingField2"
+      field :identifier, -> { String }, optional: true, nullable: false
 
-      field :additional_data, -> { String }, optional: true, nullable: false, api_name: "AdditionalData"
+      field :discount, -> { String }, optional: true, nullable: false
 
-      field :attachments, -> { Internal::Types::Array[Payabli::Types::FileContent] }, optional: true, nullable: false
+      field :total_amount, -> { String }, optional: true, nullable: false, api_name: "totalAmount"
     end
   end
 end

data/lib/payabli/types/contacts_response.rb

@@ -3,13 +3,13 @@
 module Payabli
   module Types
     class ContactsResponse < Internal::Types::Model
-      field :contact_email, -> { String }, optional: true, nullable: false, api_name: "ContactEmail"
-
       field :contact_name, -> { String }, optional: true, nullable: false, api_name: "ContactName"
 
-      field :contact_phone, -> { String }, optional: true, nullable: false, api_name: "ContactPhone"
+      field :contact_email, -> { String }, optional: true, nullable: false, api_name: "ContactEmail"
 
       field :contact_title, -> { String }, optional: true, nullable: false, api_name: "ContactTitle"
+
+      field :contact_phone, -> { String }, optional: true, nullable: false, api_name: "ContactPhone"
     end
   end
 end

data/lib/payabli/types/get_method_response_response_data_customers_item.rb

@@ -3,6 +3,48 @@
 module Payabli
   module Types
     class GetMethodResponseResponseDataCustomersItem < Internal::Types::Model
+      field :additional_data, -> { Internal::Types::Hash[String, Internal::Types::Hash[String, Object]] }, optional: true, nullable: false, api_name: "additionalData"
+
+      field :billing_address_1, -> { String }, optional: true, nullable: false, api_name: "billingAddress1"
+
+      field :billing_address_2, -> { String }, optional: true, nullable: false, api_name: "billingAddress2"
+
+      field :billing_city, -> { String }, optional: true, nullable: false, api_name: "billingCity"
+
+      field :billing_country, -> { String }, optional: true, nullable: false, api_name: "billingCountry"
+
+      field :billing_email, -> { String }, optional: true, nullable: false, api_name: "billingEmail"
+
+      field :billing_phone, -> { String }, optional: true, nullable: false, api_name: "billingPhone"
+
+      field :billing_state, -> { String }, optional: true, nullable: false, api_name: "billingState"
+
+      field :billing_zip, -> { String }, optional: true, nullable: false, api_name: "billingZip"
+
+      field :company, -> { String }, optional: true, nullable: false
+
+      field :customer_id, -> { Integer }, optional: true, nullable: false, api_name: "customerId"
+
+      field :customer_number, -> { String }, optional: true, nullable: false, api_name: "customerNumber"
+
+      field :first_name, -> { String }, optional: true, nullable: false, api_name: "firstName"
+
+      field :identifier_fields, -> { Internal::Types::Array[String] }, optional: true, nullable: false, api_name: "identifierFields"
+
+      field :last_name, -> { String }, optional: true, nullable: false, api_name: "lastName"
+
+      field :shipping_address_1, -> { String }, optional: true, nullable: false, api_name: "shippingAddress1"
+
+      field :shipping_address_2, -> { String }, optional: true, nullable: false, api_name: "shippingAddress2"
+
+      field :shipping_city, -> { String }, optional: true, nullable: false, api_name: "shippingCity"
+
+      field :shipping_country, -> { String }, optional: true, nullable: false, api_name: "shippingCountry"
+
+      field :shipping_state, -> { String }, optional: true, nullable: false, api_name: "shippingState"
+
+      field :shipping_zip, -> { String }, optional: true, nullable: false, api_name: "shippingZip"
+
       field :balance, -> { Integer }, optional: true, nullable: false
 
       field :created, -> { String }, optional: true, nullable: false

data/lib/payabli/types/get_pay_link_from_id_response.rb

@@ -3,6 +3,10 @@
 module Payabli
   module Types
     class GetPayLinkFromIdResponse < Internal::Types::Model
+      field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
+
+      field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
+
       field :response_data, -> { Payabli::Types::PayabliPages }, optional: true, nullable: false, api_name: "responseData"
     end
   end

data/lib/payabli/types/modify_approval_bill_response.rb

@@ -4,6 +4,10 @@ module Payabli
   module Types
     # Response from approval-modification endpoints.
     class ModifyApprovalBillResponse < Internal::Types::Model
+      field :is_success, -> { Internal::Types::Boolean }, optional: true, nullable: false, api_name: "isSuccess"
+
+      field :response_text, -> { String }, optional: false, nullable: false, api_name: "responseText"
+
       field :response_data, -> { Integer }, optional: true, nullable: false, api_name: "responseData"
     end
   end

data/lib/payabli/types/notification_log_detail.rb

@@ -3,6 +3,30 @@
 module Payabli
   module Types
     class NotificationLogDetail < Internal::Types::Model
+      field :id, -> { String }, optional: false, nullable: false
+
+      field :org_id, -> { Integer }, optional: false, nullable: true, api_name: "orgId"
+
+      field :paypoint_id, -> { Integer }, optional: false, nullable: true, api_name: "paypointId"
+
+      field :notification_event, -> { String }, optional: false, nullable: true, api_name: "notificationEvent"
+
+      field :target, -> { String }, optional: false, nullable: true
+
+      field :response_status, -> { String }, optional: false, nullable: true, api_name: "responseStatus"
+
+      field :success, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+      field :job_data, -> { String }, optional: false, nullable: true, api_name: "jobData"
+
+      field :created_date, -> { String }, optional: false, nullable: false, api_name: "createdDate"
+
+      field :success_date, -> { String }, optional: false, nullable: true, api_name: "successDate"
+
+      field :last_failed_date, -> { String }, optional: false, nullable: true, api_name: "lastFailedDate"
+
+      field :is_in_progress, -> { Internal::Types::Boolean }, optional: false, nullable: false, api_name: "isInProgress"
+
       field :web_headers, -> { Internal::Types::Array[Payabli::Types::StringStringKeyValuePair] }, optional: true, nullable: false, api_name: "webHeaders"
 
       field :response_headers, -> { Internal::Types::Array[Payabli::Types::KeyValueArray] }, optional: true, nullable: false, api_name: "responseHeaders"

data/lib/payabli/types/payabli_access_token_response.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Payabli
+  module Types
+    # Successful response from the token endpoint. Returns the access token, its lifetime, and any state echoed from the
+    # request.
+    class PayabliAccessTokenResponse < Internal::Types::Model
+      field :token_type, -> { String }, optional: false, nullable: false
+
+      field :access_token, -> { String }, optional: false, nullable: false
+
+      field :expires_in, -> { Integer }, optional: false, nullable: false
+
+      field :state, -> { String }, optional: true, nullable: false
+    end
+  end
+end