straddle 0.5.0 → 1.0.0

data/lib/straddle/models/customer_list_params.rb

@@ -56,38 +56,43 @@ module Straddle
       optional :search_text, String
 
       # @!attribute sort_by
+      #   Field used to sort the results.
       #
       #   @return [Symbol, Straddle::Models::CustomerListParams::SortBy, nil]
       optional :sort_by, enum: -> { Straddle::CustomerListParams::SortBy }
 
       # @!attribute sort_order
+      #   Order in which to sort the results.
       #
-      #   @return [Symbol, Straddle::Models::CustomerListParams::SortOrder, nil]
-      optional :sort_order, enum: -> { Straddle::CustomerListParams::SortOrder }
+      #   @return [Symbol, Straddle::Models::SortOrder, nil]
+      optional :sort_order, enum: -> { Straddle::SortOrder }
 
       # @!attribute status
       #   Filter customers by their current `status`.
       #
-      #   @return [Array<Symbol, Straddle::Models::CustomerListParams::Status>, nil]
-      optional :status, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::CustomerListParams::Status] }
+      #   @return [Array<Symbol, Straddle::Models::CustomerStatus>, nil]
+      optional :status, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::CustomerStatus] }
 
       # @!attribute types
       #   Filter by customer type `individual` or `business`.
       #
-      #   @return [Array<Symbol, Straddle::Models::CustomerListParams::Type>, nil]
-      optional :types, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::CustomerListParams::Type] }
+      #   @return [Array<Symbol, Straddle::Models::CustomerType>, nil]
+      optional :types, -> { Straddle::Internal::Type::ArrayOf[enum: Straddle::CustomerType] }
 
       # @!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
@@ -109,19 +114,19 @@ module Straddle
       #
       #   @param search_text [String] General search term to filter customers.
       #
-      #   @param sort_by [Symbol, Straddle::Models::CustomerListParams::SortBy]
+      #   @param sort_by [Symbol, Straddle::Models::CustomerListParams::SortBy] Field used to sort the results.
       #
-      #   @param sort_order [Symbol, Straddle::Models::CustomerListParams::SortOrder]
+      #   @param sort_order [Symbol, Straddle::Models::SortOrder] Order in which to sort the results.
       #
-      #   @param status [Array<Symbol, Straddle::Models::CustomerListParams::Status>] Filter customers by their current `status`.
+      #   @param status [Array<Symbol, Straddle::Models::CustomerStatus>] Filter customers by their current `status`.
       #
-      #   @param types [Array<Symbol, Straddle::Models::CustomerListParams::Type>] Filter by customer type `individual` or `business`.
+      #   @param types [Array<Symbol, Straddle::Models::CustomerType>] Filter by customer type `individual` or `business`.
       #
-      #   @param correlation_id [String]
+      #   @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
       #
-      #   @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}]
 
@@ -134,39 +139,6 @@ module Straddle
         # @!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
-
-      module Status
-        extend Straddle::Internal::Type::Enum
-
-        PENDING = :pending
-        REVIEW = :review
-        VERIFIED = :verified
-        INACTIVE = :inactive
-        REJECTED = :rejected
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      module Type
-        extend Straddle::Internal::Type::Enum
-
-        INDIVIDUAL = :individual
-        BUSINESS = :business
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/straddle/models/customer_list_unmasked_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Customers#list_unmasked
+    class CustomerListUnmaskedParams < 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/customer_refresh_review_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Customers#refresh_review
+    class CustomerRefreshReviewParams < 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 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:, correlation_id: nil, idempotency_key: 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 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/customer_response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Customers#create
+    class CustomerResponse < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Straddle::Models::Customer]
+      required :data, -> { Straddle::Customer }
+
+      # @!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::CustomerResponse} for more details.
+      #
+      #   @param data [Straddle::Models::Customer]
+      #
+      #   @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/customer_retrieve_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Customers#retrieve
+    class CustomerRetrieveParams < 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/customer_status.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module CustomerStatus
+      extend Straddle::Internal::Type::Enum
+
+      PENDING = :pending
+      REVIEW = :review
+      VERIFIED = :verified
+      INACTIVE = :inactive
+      REJECTED = :rejected
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/straddle/models/customer_summary.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    class CustomerSummary < Straddle::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the customer.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   Timestamp of when the customer record was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute email
+      #   The customer's email address.
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute name
+      #   Full name for an individual customer or business name for a business customer.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute phone
+      #   The customer's phone number in E.164 format.
+      #
+      #   @return [String]
+      required :phone, String
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Straddle::Models::CustomerStatus]
+      required :status, enum: -> { Straddle::CustomerStatus }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Straddle::Models::CustomerType]
+      required :type, enum: -> { Straddle::CustomerType }
+
+      # @!attribute updated_at
+      #   Timestamp of the most recent update to the customer record.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute external_id
+      #   Unique identifier for the customer in your system.
+      #
+      #   @return [String, nil]
+      optional :external_id, String, nil?: true
+
+      # @!method initialize(id:, created_at:, email:, name:, phone:, status:, type:, updated_at:, external_id: nil)
+      #   @param id [String] Unique identifier for the customer.
+      #
+      #   @param created_at [Time] Timestamp of when the customer record was created.
+      #
+      #   @param email [String] The customer's email address.
+      #
+      #   @param name [String] Full name for an individual customer or business name for a business customer.
+      #
+      #   @param phone [String] The customer's phone number in E.164 format.
+      #
+      #   @param status [Symbol, Straddle::Models::CustomerStatus]
+      #
+      #   @param type [Symbol, Straddle::Models::CustomerType]
+      #
+      #   @param updated_at [Time] Timestamp of the most recent update to the customer record.
+      #
+      #   @param external_id [String, nil] Unique identifier for the customer in your system.
+    end
+  end
+end

data/lib/straddle/models/customer_summary_list.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    # @see Straddle::Resources::Customers#list
+    class CustomerSummaryList < Straddle::Internal::Type::BaseModel
+      # @!attribute data
+      #   Customers returned for this page.
+      #
+      #   @return [Array<Straddle::Models::CustomerSummary>]
+      required :data, -> { Straddle::Internal::Type::ArrayOf[Straddle::CustomerSummary] }
+
+      # @!attribute meta
+      #   Metadata for an API request and a page of results.
+      #
+      #   @return [Straddle::Models::PageMetadata]
+      required :meta, -> { Straddle::PageMetadata }
+
+      # @!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::CustomerSummaryList} for more details.
+      #
+      #   @param data [Array<Straddle::Models::CustomerSummary>] Customers 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::ResponseType] Shape of the response envelope.
+    end
+  end
+end

data/lib/straddle/models/customer_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Models
+    module CustomerType
+      extend Straddle::Internal::Type::Enum
+
+      INDIVIDUAL = :individual
+      BUSINESS = :business
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end