straddle 0.4.0 → 1.0.0

data/lib/straddle/models/charge_refund_params.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Charges#refund
+    class ChargeRefundParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute amount
+      #   Refund amount in cents. `null` refunds the full original amount. A value must be
+      #   greater than zero and no more than the original charge amount.
+      #
+      #   @return [Integer, nil]
+      optional :amount, Integer, nil?: true
+
+      # @!attribute description
+      #   Description for the refund payout. Defaults to a description that identifies the
+      #   original charge.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute external_id
+      #   Your unique identifier for the refund. Defaults to a new value if omitted.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, nil?: true
+
+      # @!attribute metadata
+      #   User-defined string key-value pairs for the refund payout.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, Straddle::Internal::Type::HashOf[String], nil?: true
+
+      # @!attribute payment_date
+      #   Date when Straddle submits the refund payout for processing. Defaults to today
+      #   if omitted.
+      #
+      #   @return [Date, nil]
+      optional :payment_date, Date, 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:, amount: nil, description: nil, external_id: nil, metadata: nil, payment_date: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::ChargeRefundParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param amount [Integer, nil] Refund amount in cents. `null` refunds the full original amount. A value must be
+      #
+      #   @param description [String, nil] Description for the refund payout. Defaults to a description that identifies the
+      #
+      #   @param external_id [String, nil] Your unique identifier for the refund. Defaults to a new value if omitted.
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] User-defined string key-value pairs for the refund payout.
+      #
+      #   @param payment_date [Date, nil] Date when Straddle submits the refund payout for processing. Defaults to today i
+      #
+      #   @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
+end

data/lib/straddle/models/charge_release_params.rb

@@ -13,27 +13,31 @@ module Straddle
       required :id, String
 
       # @!attribute reason
-      #   Details about why the charge status was updated.
+      #   Message explaining the charge status change.
       #
       #   @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
@@ -41,15 +45,15 @@ module Straddle
       # @!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] Details about why the charge status was updated.
+      #   @param reason [String, nil] Message explaining the charge status change.
       #
-      #   @param correlation_id [String]
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
       #
-      #   @param idempotency_key [String]
+      #   @param idempotency_key [String] Optional client-generated key for an idempotent request.
       #
-      #   @param request_id [String]
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
       #
-      #   @param straddle_account_id [String]
+      #   @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

data/lib/straddle/models/charge_response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Charges#create
+    class ChargeResponse < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::Charge]
+      required :data, -> { Straddle::Charge }
+
+      # @!attribute meta
+      #   Metadata for an API request.
+      #
+      #   @return [Straddle::Models::ResponseMetadata]
+      required :meta, -> { Straddle::ResponseMetadata }
+
+      # @!attribute response_type
+      #   Shape of the response envelope.
+      #
+      #   - `object` means `data` contains one JSON object.
+      #   - `array` means `data` contains an array of JSON objects.
+      #   - `error` means `error` contains the error details.
+      #   - `none` means the response contains no data.
+      #
+      #   @return [Symbol, Straddle::Models::ResponseType]
+      required :response_type, enum: -> { Straddle::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::ChargeResponse} for more details.
+      #
+      #   @param data [Straddle::Models::Charge]
+      #
+      #   @param meta [Straddle::Models::ResponseMetadata] Metadata for an API request.
+      #
+      #   @param response_type [Symbol, Straddle::Models::ResponseType] Shape of the response envelope.
+    end
+  end
+end

data/lib/straddle/models/charge_resubmit_params.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Charges#resubmit
+    class ChargeResubmitParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute description
+      #   Description for the resubmitted charge. Defaults to the original description if
+      #   omitted.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute external_id
+      #   Your unique identifier for the resubmitted charge. Defaults to a new value if
+      #   omitted.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, nil?: true
+
+      # @!attribute payment_date
+      #   Date when Straddle submits the resubmitted charge for processing. Defaults to
+      #   today if omitted.
+      #
+      #   @return [Date, nil]
+      optional :payment_date, Date, 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:, description: nil, external_id: nil, payment_date: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::ChargeResubmitParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param description [String, nil] Description for the resubmitted charge. Defaults to the original description if
+      #
+      #   @param external_id [String, nil] Your unique identifier for the resubmitted charge. Defaults to a new value if om
+      #
+      #   @param payment_date [Date, nil] Date when Straddle submits the resubmitted charge for processing. Defaults to to
+      #
+      #   @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
+end

data/lib/straddle/models/charge_retrieve_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Charges#retrieve
+    class ChargeRetrieveParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :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
+
+      # @!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:, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   @param 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 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
+end

data/lib/straddle/models/charge_settings.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class ChargeSettings < Straddle::Internal::Type::BaseModel
+      # @!attribute daily_amount
+      #   Daily charge amount limit in cents.
+      #
+      #   @return [Integer]
+      required :daily_amount, Integer
+
+      # @!attribute max_amount
+      #   Maximum amount in cents for one charge.
+      #
+      #   @return [Integer]
+      required :max_amount, Integer
+
+      # @!attribute monthly_amount
+      #   Monthly charge amount limit in cents.
+      #
+      #   @return [Integer]
+      required :monthly_amount, Integer
+
+      # @!attribute monthly_count
+      #   Maximum number of charges per calendar month.
+      #
+      #   @return [Integer]
+      required :monthly_count, Integer
+
+      # @!attribute funding_time
+      #   Funding schedule applied to charges.
+      #
+      #   @return [String, nil]
+      optional :funding_time, String, nil?: true
+
+      # @!attribute linked_bank_account_id
+      #   ID of the linked bank account used for charge settlement.
+      #
+      #   @return [String, nil]
+      optional :linked_bank_account_id, String, nil?: true
+
+      # @!method initialize(daily_amount:, max_amount:, monthly_amount:, monthly_count:, funding_time: nil, linked_bank_account_id: nil)
+      #   @param daily_amount [Integer] Daily charge amount limit in cents.
+      #
+      #   @param max_amount [Integer] Maximum amount in cents for one charge.
+      #
+      #   @param monthly_amount [Integer] Monthly charge amount limit in cents.
+      #
+      #   @param monthly_count [Integer] Maximum number of charges per calendar month.
+      #
+      #   @param funding_time [String, nil] Funding schedule applied to charges.
+      #
+      #   @param linked_bank_account_id [String, nil] ID of the linked bank account used for charge settlement.
+    end
+  end
+end

data/lib/straddle/models/charge_update_params.rb

@@ -13,47 +13,50 @@ module Straddle
       required :id, String
 
       # @!attribute amount
-      #   The amount of the charge in cents.
+      #   Amount in cents.
       #
       #   @return [Integer]
       required :amount, Integer
 
       # @!attribute description
-      #   An arbitrary description for the charge.
+      #   Updated description for the charge.
       #
       #   @return [String, nil]
       required :description, String, nil?: true
 
       # @!attribute payment_date
-      #   The desired date on which the payment should be occur. For charges, this means
-      #   the date you want the customer to be debited on.
+      #   New date for Straddle to submit the charge for processing.
       #
       #   @return [Date]
       required :payment_date, Date
 
       # @!attribute metadata
-      #   Up to 20 additional user-defined key-value pairs. Useful for storing additional
-      #   information about the charge in a structured format.
+      #   Replacement metadata for the charge. Up to 20 user-defined string key-value
+      #   pairs.
       #
       #   @return [Hash{Symbol=>String}, nil]
       optional :metadata, Straddle::Internal::Type::HashOf[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
@@ -64,21 +67,21 @@ module Straddle
       #
       #   @param id [String]
       #
-      #   @param amount [Integer] The amount of the charge in cents.
+      #   @param amount [Integer] Amount in cents.
       #
-      #   @param description [String, nil] An arbitrary description for the charge.
+      #   @param description [String, nil] Updated description for the charge.
       #
-      #   @param payment_date [Date] The desired date on which the payment should be occur. For charges, this means t
+      #   @param payment_date [Date] New date for Straddle to submit the charge for processing.
       #
-      #   @param metadata [Hash{Symbol=>String}, nil] Up to 20 additional user-defined key-value pairs. Useful for storing additional
+      #   @param metadata [Hash{Symbol=>String}, nil] Replacement metadata for the charge. Up to 20 user-defined string key-value pair
       #
-      #   @param correlation_id [String]
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
       #
-      #   @param idempotency_key [String]
+      #   @param idempotency_key [String] Optional client-generated key for an idempotent request.
       #
-      #   @param request_id [String]
+      #   @param request_id [String] Optional client-generated identifier for tracing one request.
       #
-      #   @param straddle_account_id [String]
+      #   @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

data/lib/straddle/models/charge_upload_authorization_proof_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Charges#upload_authorization_proof
+    class ChargeUploadAuthorizationProofParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute file
+      #   The document file to upload as proof of authorization for this charge. Supported
+      #   file types are PDF (.pdf), PNG (.png), JPEG (.jpg, .jpeg), Word (.doc), and Word
+      #   (.docx), with a maximum file size of 10 MiB (10,485,760 bytes). Empty (0-byte)
+      #   files are rejected. Uploaded files are validated for matching file signatures
+      #   (magic bytes) and file extension agreement.
+      #
+      #   @return [Pathname, StringIO, IO, String, Straddle::FilePart]
+      required :file, Straddle::Internal::Type::FileInput, api_name: :File
+
+      # @!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:, file:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::ChargeUploadAuthorizationProofParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param file [Pathname, StringIO, IO, String, Straddle::FilePart] The document file to upload as proof of authorization for this charge. Supported
+      #
+      #   @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
+end

data/lib/straddle/models/compliance_profile.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module ComplianceProfile
+      extend Straddle::Internal::Type::Union
+
+      variant -> { Straddle::ComplianceProfile::IndividualComplianceProfile }
+
+      variant -> { Straddle::ComplianceProfile::BusinessComplianceProfile }
+
+      class IndividualComplianceProfile < Straddle::Internal::Type::BaseModel
+        # @!attribute dob
+        #   Masked date of birth in `****-**-**` format.
+        #
+        #   @return [String, nil]
+        required :dob, String, nil?: true
+
+        # @!attribute ssn
+        #   Masked Social Security number in `***-**-****` format.
+        #
+        #   @return [String, nil]
+        required :ssn, String, nil?: true
+
+        # @!method initialize(dob:, ssn:)
+        #   @param dob [String, nil] Masked date of birth in `****-**-**` format.
+        #
+        #   @param ssn [String, nil] Masked Social Security number in `***-**-****` format.
+      end
+
+      class BusinessComplianceProfile < Straddle::Internal::Type::BaseModel
+        # @!attribute ein
+        #   Masked Employer Identification Number in `**-*******` format.
+        #
+        #   @return [String, nil]
+        required :ein, String, nil?: true
+
+        # @!attribute legal_business_name
+        #   Official registered business name associated with `ein`.
+        #
+        #   @return [String, nil]
+        required :legal_business_name, String, nil?: true
+
+        # @!attribute representatives
+        #   Representatives associated with the business. Valid only for `business`
+        #   customers.
+        #
+        #   @return [Array<Straddle::Models::BusinessCustomerRepresentative>, nil]
+        optional :representatives,
+                 -> { Straddle::Internal::Type::ArrayOf[Straddle::BusinessCustomerRepresentative] },
+                 nil?: true
+
+        # @!attribute website
+        #   Official business website URL.
+        #
+        #   @return [String, nil]
+        optional :website, String, nil?: true
+
+        # @!method initialize(ein:, legal_business_name:, representatives: nil, website: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Straddle::Models::ComplianceProfile::BusinessComplianceProfile} for more
+        #   details.
+        #
+        #   @param ein [String, nil] Masked Employer Identification Number in `**-*******` format.
+        #
+        #   @param legal_business_name [String, nil] Official registered business name associated with `ein`.
+        #
+        #   @param representatives [Array<Straddle::Models::BusinessCustomerRepresentative>, nil] Representatives associated with the business. Valid only for `business` customer
+        #
+        #   @param website [String, nil] Official business website URL.
+      end
+
+      # @!method self.variants
+      #   @return [Array(Straddle::Models::ComplianceProfile::IndividualComplianceProfile, Straddle::Models::ComplianceProfile::BusinessComplianceProfile)]
+    end
+  end
+end

data/lib/straddle/models/consent_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # How the customer authorized the charge. `internet` covers online and mobile
+    # authorization. `signed` covers written or PDF-signed agreements.
+    module ConsentType
+      extend Straddle::Internal::Type::Enum
+
+      INTERNET = :internet
+      SIGNED = :signed
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end