straddle 0.5.0 → 1.0.0

data/lib/straddle/models/representative_created_v1_webhook_event.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class RepresentativeCreatedV1WebhookEvent < Straddle::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   Unique identifier for the account associated with this event.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::Representative]
+      required :data, -> { Straddle::Representative }
+
+      # @!attribute event_id
+      #   Unique identifier for this event.
+      #
+      #   @return [String]
+      required :event_id, String
+
+      # @!attribute event_type
+      #   Type of this event.
+      #
+      #   @return [String]
+      required :event_type, String
+
+      # @!method initialize(account_id:, data:, event_id:, event_type:)
+      #   @param account_id [String] Unique identifier for the account associated with this event.
+      #
+      #   @param data [Straddle::Models::Representative]
+      #
+      #   @param event_id [String] Unique identifier for this event.
+      #
+      #   @param event_type [String] Type of this event.
+    end
+  end
+end

data/lib/straddle/models/representative_event_v1_webhook_event.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class RepresentativeEventV1WebhookEvent < Straddle::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   Unique identifier for the account associated with this event.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::Representative]
+      required :data, -> { Straddle::Representative }
+
+      # @!attribute event_id
+      #   Unique identifier for this event.
+      #
+      #   @return [String]
+      required :event_id, String
+
+      # @!attribute event_type
+      #   Type of this event.
+      #
+      #   @return [String]
+      required :event_type, String
+
+      # @!method initialize(account_id:, data:, event_id:, event_type:)
+      #   @param account_id [String] Unique identifier for the account associated with this event.
+      #
+      #   @param data [Straddle::Models::Representative]
+      #
+      #   @param event_id [String] Unique identifier for this event.
+      #
+      #   @param event_type [String] Type of this event.
+    end
+  end
+end

data/lib/straddle/models/representative_list.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Representatives#list
+    class RepresentativeList < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #   Representatives returned for this page.
+      #
+      #   @return [Array<Straddle::Models::Representative>]
+      required :data, -> { Straddle::Internal::Type::ArrayOf[Straddle::Representative] }
+
+      # @!attribute meta
+      #   Metadata for an API request and a page of results.
+      #
+      #   @return [Straddle::Models::PageMetadata]
+      required :meta, -> { Straddle::PageMetadata }
+
+      # @!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::RepresentativeList::ResponseType]
+      required :response_type, enum: -> { Straddle::RepresentativeList::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::RepresentativeList} for more details.
+      #
+      #   @param data [Array<Straddle::Models::Representative>] Representatives returned for this page.
+      #
+      #   @param meta [Straddle::Models::PageMetadata] Metadata for an API request and a page of results.
+      #
+      #   @param response_type [Symbol, Straddle::Models::RepresentativeList::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::RepresentativeList#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/representative_list_params.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Representatives#list
+    class RepresentativeListParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   Account ID used to filter the results.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute level
+      #   Scope of representatives to return.
+      #
+      #   @return [Symbol, Straddle::Models::RepresentativeListParams::Level, nil]
+      optional :level, enum: -> { Straddle::RepresentativeListParams::Level }
+
+      # @!attribute organization_id
+      #   Organization ID used to filter the results.
+      #
+      #   @return [String, nil]
+      optional :organization_id, String
+
+      # @!attribute page_number
+      #   Page number. Defaults to `1`.
+      #
+      #   @return [Integer, nil]
+      optional :page_number, Integer
+
+      # @!attribute page_size
+      #   Number of results per page. Defaults to `100`. Maximum `1000`.
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!attribute platform_id
+      #   Platform ID used to filter the results.
+      #
+      #   @return [String, nil]
+      optional :platform_id, String
+
+      # @!attribute sort_by
+      #   Field used to sort results. Defaults to `id`.
+      #
+      #   @return [String, nil]
+      optional :sort_by, String
+
+      # @!attribute sort_order
+      #   Sort direction. Defaults to `asc`.
+      #
+      #   @return [Symbol, Straddle::Models::RepresentativeListParams::SortOrder, nil]
+      optional :sort_order, enum: -> { Straddle::RepresentativeListParams::SortOrder }
+
+      # @!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(account_id: nil, level: nil, organization_id: nil, page_number: nil, page_size: nil, platform_id: nil, sort_by: nil, sort_order: nil, correlation_id: nil, request_id: nil, request_options: {})
+      #   @param account_id [String] Account ID used to filter the results.
+      #
+      #   @param level [Symbol, Straddle::Models::RepresentativeListParams::Level] Scope of representatives to return.
+      #
+      #   @param organization_id [String] Organization ID used to filter the results.
+      #
+      #   @param page_number [Integer] Page number. Defaults to `1`.
+      #
+      #   @param page_size [Integer] Number of results per page. Defaults to `100`. Maximum `1000`.
+      #
+      #   @param platform_id [String] Platform ID used to filter the results.
+      #
+      #   @param sort_by [String] Field used to sort results. Defaults to `id`.
+      #
+      #   @param sort_order [Symbol, Straddle::Models::RepresentativeListParams::SortOrder] Sort direction. Defaults to `asc`.
+      #
+      #   @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}]
+
+      module Level
+        extend Straddle::Internal::Type::Enum
+
+        ACCOUNT = :account
+        PLATFORM = :platform
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module SortOrder
+        extend Straddle::Internal::Type::Enum
+
+        ASC = :asc
+        DESC = :desc
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/representative_list_unmasked_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Representatives#list_unmasked
+    class RepresentativeListUnmaskedParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute representative_id
+      #
+      #   @return [String]
+      required :representative_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(representative_id:, correlation_id: nil, request_id: nil, request_options: {})
+      #   @param representative_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/representative_relationship.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class RepresentativeRelationship < Straddle::Internal::Type::BaseModel
+      # @!attribute control
+      #   Whether the representative controls, manages, or directs the business. Each
+      #   legal entity must have one representative with `control` set to `true`.
+      #
+      #   @return [Boolean]
+      required :control, Straddle::Internal::Type::Boolean
+
+      # @!attribute owner
+      #   Whether the representative owns any equity in the business.
+      #
+      #   @return [Boolean]
+      required :owner, Straddle::Internal::Type::Boolean
+
+      # @!attribute primary
+      #   Whether this person is the account's primary representative. The primary
+      #   representative provides personal and business information and accepts the
+      #   services agreement. An account can have only one primary representative.
+      #
+      #   @return [Boolean]
+      required :primary, Straddle::Internal::Type::Boolean
+
+      # @!attribute percent_ownership
+      #   The representative's ownership percentage. Required when `owner` is `true`.
+      #
+      #   @return [Float, nil]
+      optional :percent_ownership, Float, nil?: true
+
+      # @!attribute title
+      #   The representative's job title.
+      #
+      #   @return [String, nil]
+      optional :title, String, nil?: true
+
+      # @!method initialize(control:, owner:, primary:, percent_ownership: nil, title: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::RepresentativeRelationship} for more details.
+      #
+      #   @param control [Boolean] Whether the representative controls, manages, or directs the business. Each lega
+      #
+      #   @param owner [Boolean] Whether the representative owns any equity in the business.
+      #
+      #   @param primary [Boolean] Whether this person is the account's primary representative. The primary represe
+      #
+      #   @param percent_ownership [Float, nil] The representative's ownership percentage. Required when `owner` is `true`.
+      #
+      #   @param title [String, nil] The representative's job title.
+    end
+  end
+end

data/lib/straddle/models/representative_response.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Representatives#create
+    class RepresentativeResponse < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::Representative]
+      required :data, -> { Straddle::Representative }
+
+      # @!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::RepresentativeResponse::ResponseType]
+      required :response_type, enum: -> { Straddle::RepresentativeResponse::ResponseType }
+
+      # @!method initialize(data:, meta:, response_type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Straddle::Models::RepresentativeResponse} for more details.
+      #
+      #   @param data [Straddle::Models::Representative]
+      #
+      #   @param meta [Straddle::Models::ResponseMetadata] Metadata for an API request.
+      #
+      #   @param response_type [Symbol, Straddle::Models::RepresentativeResponse::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::RepresentativeResponse#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/representative_retrieve_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Representatives#retrieve
+    class RepresentativeRetrieveParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute representative_id
+      #
+      #   @return [String]
+      required :representative_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(representative_id:, correlation_id: nil, request_id: nil, request_options: {})
+      #   @param representative_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/representative_status_detail.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class RepresentativeStatusDetail < Straddle::Internal::Type::BaseModel
+      # @!attribute code
+      #   Machine-readable status code from the source.
+      #
+      #   @return [String]
+      required :code, String
+
+      # @!attribute message
+      #   Human-readable description of the representative's status.
+      #
+      #   @return [String]
+      required :message, String
+
+      # @!attribute reason
+      #   Machine-readable reason for the representative's status.
+      #
+      #   @return [Symbol, Straddle::Models::RepresentativeStatusDetail::Reason]
+      required :reason, enum: -> { Straddle::RepresentativeStatusDetail::Reason }
+
+      # @!attribute source
+      #   System that produced the representative status detail.
+      #
+      #   @return [Symbol, Straddle::Models::RepresentativeStatusDetail::Source]
+      required :source, enum: -> { Straddle::RepresentativeStatusDetail::Source }
+
+      # @!method initialize(code:, message:, reason:, source:)
+      #   @param code [String] Machine-readable status code from the source.
+      #
+      #   @param message [String] Human-readable description of the representative's status.
+      #
+      #   @param reason [Symbol, Straddle::Models::RepresentativeStatusDetail::Reason] Machine-readable reason for the representative's status.
+      #
+      #   @param source [Symbol, Straddle::Models::RepresentativeStatusDetail::Source] System that produced the representative status detail.
+
+      # Machine-readable reason for the representative's status.
+      #
+      # @see Straddle::Models::RepresentativeStatusDetail#reason
+      module Reason
+        extend Straddle::Internal::Type::Enum
+
+        UNVERIFIED = :unverified
+        IN_REVIEW = :in_review
+        PENDING = :pending
+        STUCK = :stuck
+        VERIFIED = :verified
+        FAILED_VERIFICATION = :failed_verification
+        DISABLED = :disabled
+        NEW = :new
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # System that produced the representative status detail.
+      #
+      # @see Straddle::Models::RepresentativeStatusDetail#source
+      module Source
+        extend Straddle::Internal::Type::Enum
+
+        WATCHTOWER = :watchtower
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/straddle/models/representative_update_params.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Representatives#update
+    class RepresentativeUpdateParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      # @!attribute representative_id
+      #
+      #   @return [String]
+      required :representative_id, String
+
+      # @!attribute dob
+      #   Representative's date of birth in `YYYY-MM-DD` format.
+      #
+      #   @return [Date]
+      required :dob, Date
+
+      # @!attribute email
+      #   Representative's email address.
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute first_name
+      #   Representative's first name.
+      #
+      #   @return [String]
+      required :first_name, String
+
+      # @!attribute last_name
+      #   Representative's last name.
+      #
+      #   @return [String]
+      required :last_name, String
+
+      # @!attribute mobile_number
+      #   Representative's mobile phone number in E.164 format.
+      #
+      #   @return [String]
+      required :mobile_number, String
+
+      # @!attribute relationship
+      #
+      #   @return [Straddle::Models::RepresentativeRelationship]
+      required :relationship, -> { Straddle::RepresentativeRelationship }
+
+      # @!attribute ssn_last4
+      #   Last four digits of the representative's Social Security number.
+      #
+      #   @return [String]
+      required :ssn_last4, String
+
+      # @!attribute external_id
+      #   Your unique ID for the representative.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, nil?: true
+
+      # @!attribute metadata
+      #   Up to 20 user-defined 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
+
+      # @!method initialize(representative_id:, dob:, email:, first_name:, last_name:, mobile_number:, relationship:, ssn_last4:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+      #   @param representative_id [String]
+      #
+      #   @param dob [Date] Representative's date of birth in `YYYY-MM-DD` format.
+      #
+      #   @param email [String] Representative's email address.
+      #
+      #   @param first_name [String] Representative's first name.
+      #
+      #   @param last_name [String] Representative's last name.
+      #
+      #   @param mobile_number [String] Representative's mobile phone number in E.164 format.
+      #
+      #   @param relationship [Straddle::Models::RepresentativeRelationship]
+      #
+      #   @param ssn_last4 [String] Last four digits of the representative's Social Security number.
+      #
+      #   @param external_id [String, nil] Your unique ID for the representative.
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Up to 20 user-defined key-value pairs.
+      #
+      #   @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 request_options [Straddle::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/straddle/models/response_metadata.rb

@@ -4,23 +4,23 @@ module Straddle
   module Models
     class ResponseMetadata < Straddle::Internal::Type::BaseModel
       # @!attribute api_request_id
-      #   Unique identifier for this API request, useful for troubleshooting.
+      #   Unique identifier for the API request.
       #
       #   @return [String]
       required :api_request_id, String
 
       # @!attribute api_request_timestamp
-      #   Timestamp for this API request, useful for troubleshooting.
+      #   UTC timestamp for the API request.
       #
       #   @return [Time]
       required :api_request_timestamp, Time
 
       # @!method initialize(api_request_id:, api_request_timestamp:)
-      #   Metadata about the API request, including an identifier and timestamp.
+      #   Metadata for an API request.
       #
-      #   @param api_request_id [String] Unique identifier for this API request, useful for troubleshooting.
+      #   @param api_request_id [String] Unique identifier for the API request.
       #
-      #   @param api_request_timestamp [Time] Timestamp for this API request, useful for troubleshooting.
+      #   @param api_request_timestamp [Time] UTC timestamp for the API request.
     end
   end
 end

data/lib/straddle/models/response_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # 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.
+    module ResponseType
+      extend Straddle::Internal::Type::Enum
+
+      OBJECT = :object
+      ARRAY = :array
+      ERROR = :error
+      NONE = :none
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end