straddle 0.5.0 → 1.0.0

data/lib/straddle/models/organization_response.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Organizations#create
+    class OrganizationResponse < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::Organization]
+      required :data, -> { Straddle::Organization }
+
+      # @!attribute meta
+      #   Metadata for an API request.
+      #
+      #   @return [Straddle::Models::ResponseMetadata]
+      required :meta, -> { Straddle::ResponseMetadata }
+
+      # @!attribute response_type
+      #   Indicates how the response content is structured.
+      #
+      #   - `object` means `data` contains one JSON object.
+      #   - `array` means `data` contains an array of objects.
+      #   - `error` means `error` contains error details.
+      #   - `none` means the response has no data.
+      #
+      #   @return [Symbol, Straddle::Models::OrganizationResponse::ResponseType]
+      required :response_type, enum: -> { Straddle::OrganizationResponse::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::OrganizationResponse} for more details.
+      #
+      #   @param data [Straddle::Models::Organization]
+      #
+      #   @param meta [Straddle::Models::ResponseMetadata] Metadata for an API request.
+      #
+      #   @param response_type [Symbol, Straddle::Models::OrganizationResponse::ResponseType] Indicates how the response content is structured.
+
+      # Indicates how the response content is structured.
+      #
+      # - `object` means `data` contains one JSON object.
+      # - `array` means `data` contains an array of objects.
+      # - `error` means `error` contains error details.
+      # - `none` means the response has no data.
+      #
+      # @see Straddle::Models::OrganizationResponse#response_type
+      module ResponseType
+        extend Straddle::Internal::Type::Enum
+
+        OBJECT = :object
+        ARRAY = :array
+        ERROR = :error
+        NONE = :none
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/organization_retrieve_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Organizations#retrieve
+    class OrganizationRetrieveParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute organization_id
+      #
+      #   @return [String]
+      required :organization_id, String
+
+      # @!attribute correlation_id
+      #   Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @return [String, nil]
+      optional :correlation_id, String
+
+      # @!attribute request_id
+      #   Optional client-generated identifier for tracing one request.
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!method initialize(organization_id:, correlation_id: nil, request_id: nil, request_options: {})
+      #   @param organization_id [String]
+      #
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
+      #
+      #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/straddle/models/page_metadata.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class PageMetadata < Straddle::Internal::Type::BaseModel
+      # @!attribute api_request_id
+      #   Unique identifier for the API request.
+      #
+      #   @return [String]
+      required :api_request_id, String
+
+      # @!attribute api_request_timestamp
+      #   UTC timestamp for the API request.
+      #
+      #   @return [Time]
+      required :api_request_timestamp, Time
+
+      # @!attribute max_page_size
+      #   Maximum page size allowed for this endpoint.
+      #
+      #   @return [Integer]
+      required :max_page_size, Integer
+
+      # @!attribute page_number
+      #   Current page number.
+      #
+      #   @return [Integer]
+      required :page_number, Integer
+
+      # @!attribute page_size
+      #   Number of items per page.
+      #
+      #   @return [Integer]
+      required :page_size, Integer
+
+      # @!attribute sort_by
+      #   Field used to sort the results.
+      #
+      #   @return [String]
+      required :sort_by, String
+
+      # @!attribute sort_order
+      #   Sort direction for the results.
+      #
+      #   @return [Symbol, Straddle::Models::SortOrder]
+      required :sort_order, enum: -> { Straddle::SortOrder }
+
+      # @!attribute total_items
+      #   Total number of items available across all pages.
+      #
+      #   @return [Integer]
+      required :total_items, Integer
+
+      # @!attribute total_pages
+      #   Total number of pages available.
+      #
+      #   @return [Integer]
+      required :total_pages, Integer
+
+      # @!method initialize(api_request_id:, api_request_timestamp:, max_page_size:, page_number:, page_size:, sort_by:, sort_order:, total_items:, total_pages:)
+      #   Metadata for an API request and a page of results.
+      #
+      #   @param api_request_id [String] Unique identifier for the API request.
+      #
+      #   @param api_request_timestamp [Time] UTC timestamp for the API request.
+      #
+      #   @param max_page_size [Integer] Maximum page size allowed for this endpoint.
+      #
+      #   @param page_number [Integer] Current page number.
+      #
+      #   @param page_size [Integer] Number of items per page.
+      #
+      #   @param sort_by [String] Field used to sort the results.
+      #
+      #   @param sort_order [Symbol, Straddle::Models::SortOrder] Sort direction for the results.
+      #
+      #   @param total_items [Integer] Total number of items available across all pages.
+      #
+      #   @param total_pages [Integer] Total number of pages available.
+    end
+  end
+end

data/lib/straddle/models/paykey.rb

@@ -0,0 +1,143 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class Paykey < Straddle::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the paykey.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute config
+      #
+      #   @return [Straddle::Models::PaykeyConfiguration]
+      required :config, -> { Straddle::PaykeyConfiguration }
+
+      # @!attribute created_at
+      #   Timestamp of when the paykey was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute label
+      #   Human-readable label for the paykey.
+      #
+      #   @return [String]
+      required :label, String
+
+      # @!attribute paykey
+      #   Masked paykey value.
+      #
+      #   @return [String]
+      required :paykey, String
+
+      # @!attribute source
+      #
+      #   @return [Symbol, Straddle::Models::PaykeySource]
+      required :source, enum: -> { Straddle::PaykeySource }
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Straddle::Models::PaykeyStatus]
+      required :status, enum: -> { Straddle::PaykeyStatus }
+
+      # @!attribute updated_at
+      #   Timestamp of the most recent update to the paykey.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute balance
+      #
+      #   @return [Straddle::Models::PaykeyBalanceDetails, nil]
+      optional :balance, -> { Straddle::PaykeyBalanceDetails }
+
+      # @!attribute bank_data
+      #
+      #   @return [Straddle::Models::PaykeyBankDetails, nil]
+      optional :bank_data, -> { Straddle::PaykeyBankDetails }
+
+      # @!attribute customer_id
+      #   Unique identifier for the customer associated with the paykey.
+      #
+      #   @return [String, nil]
+      optional :customer_id, String, nil?: true
+
+      # @!attribute expires_at
+      #   Expiration date and time of the paykey, if applicable.
+      #
+      #   @return [Time, nil]
+      optional :expires_at, Time, nil?: true
+
+      # @!attribute external_id
+      #   Unique identifier for the paykey in your system.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, nil?: true
+
+      # @!attribute institution_name
+      #   Name of the financial institution.
+      #
+      #   @return [String, nil]
+      optional :institution_name, String, nil?: true
+
+      # @!attribute metadata
+      #   Up to 20 user-defined key-value pairs associated with the paykey.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true
+
+      # @!attribute status_details
+      #
+      #   @return [Straddle::Models::PaymentStatusDetails, nil]
+      optional :status_details, -> { Straddle::PaymentStatusDetails }
+
+      # @!attribute unblock_eligible
+      #   Whether the paykey is eligible for client-initiated unblocking. `true` only when
+      #   the paykey is blocked by an `R29` return and has not been unblocked before.
+      #   `false` for other blocked paykeys. `null` when the paykey is not blocked.
+      #
+      #   @return [Boolean, nil]
+      optional :unblock_eligible, Straddle::Internal::Type::Boolean, nil?: true
+
+      # @!method initialize(id:, config:, created_at:, label:, paykey:, source:, status:, updated_at:, balance: nil, bank_data: nil, customer_id: nil, expires_at: nil, external_id: nil, institution_name: nil, metadata: nil, status_details: nil, unblock_eligible: nil)
+      #   Some parameter documentations has been truncated, see {Straddle::Models::Paykey}
+      #   for more details.
+      #
+      #   @param id [String] Unique identifier for the paykey.
+      #
+      #   @param config [Straddle::Models::PaykeyConfiguration]
+      #
+      #   @param created_at [Time] Timestamp of when the paykey was created.
+      #
+      #   @param label [String] Human-readable label for the paykey.
+      #
+      #   @param paykey [String] Masked paykey value.
+      #
+      #   @param source [Symbol, Straddle::Models::PaykeySource]
+      #
+      #   @param status [Symbol, Straddle::Models::PaykeyStatus]
+      #
+      #   @param updated_at [Time] Timestamp of the most recent update to the paykey.
+      #
+      #   @param balance [Straddle::Models::PaykeyBalanceDetails]
+      #
+      #   @param bank_data [Straddle::Models::PaykeyBankDetails]
+      #
+      #   @param customer_id [String, nil] Unique identifier for the customer associated with the paykey.
+      #
+      #   @param expires_at [Time, nil] Expiration date and time of the paykey, if applicable.
+      #
+      #   @param external_id [String, nil] Unique identifier for the paykey in your system.
+      #
+      #   @param institution_name [String, nil] Name of the financial institution.
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Up to 20 user-defined key-value pairs associated with the paykey.
+      #
+      #   @param status_details [Straddle::Models::PaymentStatusDetails]
+      #
+      #   @param unblock_eligible [Boolean, nil] Whether the paykey is eligible for client-initiated unblocking. `true` only when
+    end
+  end
+end

data/lib/straddle/models/paykey_balance_details.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class PaykeyBalanceDetails < Straddle::Internal::Type::BaseModel
+      # @!attribute status
+      #
+      #   @return [Symbol, Straddle::Models::PaykeyBalanceRefreshStatus]
+      required :status, enum: -> { Straddle::PaykeyBalanceRefreshStatus }
+
+      # @!attribute account_balance
+      #   Most recently retrieved account balance in cents.
+      #
+      #   @return [Integer, nil]
+      optional :account_balance, Integer, nil?: true
+
+      # @!attribute updated_at
+      #   Timestamp of the most recent account balance update.
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, nil?: true
+
+      # @!method initialize(status:, account_balance: nil, updated_at: nil)
+      #   @param status [Symbol, Straddle::Models::PaykeyBalanceRefreshStatus]
+      #
+      #   @param account_balance [Integer, nil] Most recently retrieved account balance in cents.
+      #
+      #   @param updated_at [Time, nil] Timestamp of the most recent account balance update.
+    end
+  end
+end

data/lib/straddle/models/paykey_balance_refresh_status.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module PaykeyBalanceRefreshStatus
+      extend Straddle::Internal::Type::Enum
+
+      PENDING = :pending
+      COMPLETED = :completed
+      FAILED = :failed
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/straddle/models/paykey_bank_details.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class PaykeyBankDetails < Straddle::Internal::Type::BaseModel
+      # @!attribute account_number
+      #   Masked bank account number.
+      #
+      #   @return [String]
+      required :account_number, String
+
+      # @!attribute account_type
+      #
+      #   @return [Symbol, Straddle::Models::AccountType]
+      required :account_type, enum: -> { Straddle::AccountType }
+
+      # @!attribute routing_number
+      #   Bank routing number.
+      #
+      #   @return [String]
+      required :routing_number, String
+
+      # @!method initialize(account_number:, account_type:, routing_number:)
+      #   @param account_number [String] Masked bank account number.
+      #
+      #   @param account_type [Symbol, Straddle::Models::AccountType]
+      #
+      #   @param routing_number [String] Bank routing number.
+    end
+  end
+end

data/lib/straddle/models/paykey_cancel_params.rb

@@ -13,37 +13,48 @@ module Straddle
       required :id, String
 
       # @!attribute reason
+      #   Reason for canceling the paykey.
       #
       #   @return [String, nil]
       optional :reason, String, nil?: true
 
       # @!attribute correlation_id
+      #   Optional client-generated identifier for tracing a series of related requests.
       #
       #   @return [String, nil]
       optional :correlation_id, String
 
       # @!attribute idempotency_key
+      #   Optional client-generated key for an idempotent request.
       #
       #   @return [String, nil]
       optional :idempotency_key, String
 
       # @!attribute request_id
+      #   Optional client-generated identifier for tracing one request.
       #
       #   @return [String, nil]
       optional :request_id, String
 
       # @!attribute straddle_account_id
+      #   For platform requests, the embedded account UUID that sets the request scope.
       #
       #   @return [String, nil]
       optional :straddle_account_id, String
 
       # @!method initialize(id:, reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #   @param id [String]
-      #   @param reason [String, nil]
-      #   @param correlation_id [String]
-      #   @param idempotency_key [String]
-      #   @param request_id [String]
-      #   @param straddle_account_id [String]
+      #
+      #   @param reason [String, nil] Reason for canceling the paykey.
+      #
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+      #
+      #   @param idempotency_key [String] Optional client-generated key for an idempotent request.
+      #
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
+      #
+      #   @param straddle_account_id [String] For platform requests, the embedded account UUID that sets the request scope.
+      #
       #   @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/straddle/models/paykey_configuration.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class PaykeyConfiguration < Straddle::Internal::Type::BaseModel
+      # @!attribute processing_method
+      #
+      #   @return [Symbol, Straddle::Models::PaykeyProcessingMode, nil]
+      optional :processing_method, enum: -> { Straddle::PaykeyProcessingMode }
+
+      # @!attribute sandbox_outcome
+      #
+      #   @return [Symbol, Straddle::Models::SimulatedPaykeyOutcome, nil]
+      optional :sandbox_outcome, enum: -> { Straddle::SimulatedPaykeyOutcome }
+
+      # @!method initialize(processing_method: nil, sandbox_outcome: nil)
+      #   @param processing_method [Symbol, Straddle::Models::PaykeyProcessingMode]
+      #   @param sandbox_outcome [Symbol, Straddle::Models::SimulatedPaykeyOutcome]
+    end
+  end
+end