Class: MethodRuby::Resources::Entities

Inherits:
Object
  • Object
show all
Defined in:
lib/method_ruby/resources/entities.rb,
lib/method_ruby/resources/entities/connect.rb,
lib/method_ruby/resources/entities/consent.rb,
lib/method_ruby/resources/entities/products.rb,
lib/method_ruby/resources/entities/vehicles.rb,
lib/method_ruby/resources/entities/attributes.rb,
lib/method_ruby/resources/entities/identities.rb,
lib/method_ruby/resources/entities/credit_scores.rb,
lib/method_ruby/resources/entities/subscriptions.rb,
lib/method_ruby/resources/entities/manual_connect.rb,
lib/method_ruby/resources/entities/verification_sessions.rb

Overview

Individuals, corporations, and receive-only entities

Defined Under Namespace

Classes: Attributes, Connect, Consent, CreditScores, Identities, ManualConnect, Products, Subscriptions, Vehicles, VerificationSessions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Entities

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Entities.

Parameters:



214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/method_ruby/resources/entities.rb', line 214

def initialize(client:)
  @client = client
  @attributes = MethodRuby::Resources::Entities::Attributes.new(client: client)
  @credit_scores = MethodRuby::Resources::Entities::CreditScores.new(client: client)
  @consent = MethodRuby::Resources::Entities::Consent.new(client: client)
  @vehicles = MethodRuby::Resources::Entities::Vehicles.new(client: client)
  @products = MethodRuby::Resources::Entities::Products.new(client: client)
  @subscriptions = MethodRuby::Resources::Entities::Subscriptions.new(client: client)
  @connect = MethodRuby::Resources::Entities::Connect.new(client: client)
  @manual_connect = MethodRuby::Resources::Entities::ManualConnect.new(client: client)
  @identities = MethodRuby::Resources::Entities::Identities.new(client: client)
  @verification_sessions = MethodRuby::Resources::Entities::VerificationSessions.new(client: client)
end

Instance Attribute Details

#attributes ⇒ MethodRuby::Resources::Entities::Attributes (readonly)

Attribute data for entities

Returns:



9
10
11
 
# File 'lib/method_ruby/resources/entities.rb', line 9

def attributes
  @attributes
end

#connect ⇒ MethodRuby::Resources::Entities::Connect (readonly)

Account connection sessions for entities

Returns:



33
34
35
 
# File 'lib/method_ruby/resources/entities.rb', line 33

def connect
  @connect
end

#consent ⇒ MethodRuby::Resources::Entities::Consent (readonly)

Consent management for entities

Returns:



17
18
19
 
# File 'lib/method_ruby/resources/entities.rb', line 17

def consent
  @consent
end

#credit_scores ⇒ MethodRuby::Resources::Entities::CreditScores (readonly)

Credit score data for entities

Returns:



13
14
15
 
# File 'lib/method_ruby/resources/entities.rb', line 13

def credit_scores
  @credit_scores
end

#identities ⇒ MethodRuby::Resources::Entities::Identities (readonly)

Identity verification data for entities

Returns:



41
42
43
 
# File 'lib/method_ruby/resources/entities.rb', line 41

def identities
  @identities
end

#manual_connect ⇒ MethodRuby::Resources::Entities::ManualConnect (readonly)

Account connection sessions for entities

Returns:



37
38
39
 
# File 'lib/method_ruby/resources/entities.rb', line 37

def manual_connect
  @manual_connect
end

#products ⇒ MethodRuby::Resources::Entities::Products (readonly)

Products associated with entities

Returns:



25
26
27
 
# File 'lib/method_ruby/resources/entities.rb', line 25

def products
  @products
end

#subscriptions ⇒ MethodRuby::Resources::Entities::Subscriptions (readonly)

Subscriptions for entities

Returns:



29
30
31
 
# File 'lib/method_ruby/resources/entities.rb', line 29

def subscriptions
  @subscriptions
end

#vehicles ⇒ MethodRuby::Resources::Entities::Vehicles (readonly)

Vehicle data for entities

Returns:



21
22
23
 
# File 'lib/method_ruby/resources/entities.rb', line 21

def vehicles
  @vehicles
end

#verification_sessions ⇒ MethodRuby::Resources::Entities::VerificationSessions (readonly)

Verification sessions for entities

Returns:



45
46
47
 
# File 'lib/method_ruby/resources/entities.rb', line 45

def verification_sessions
  @verification_sessions
end

Instance Method Details

#create(body:, method_version:, idempotency_key: nil, request_options: {}) ⇒ MethodRuby::Models::EntityCreateResponse

Some parameter documentations has been truncated, see Models::EntityCreateParams for more details.

Creates a new entity.

Parameters:

Returns:

See Also:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/method_ruby/resources/entities.rb', line 65

def create(params)
  parsed, options = MethodRuby::EntityCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "entities",
    headers: parsed.except(:body).transform_keys(
      method_version: "method-version",
      idempotency_key: "idempotency-key"
    ),
    body: parsed[:body],
    model: MethodRuby::Models::EntityCreateResponse,
    security: {secret_key: true},
    options: options
  )
end

#list(method_version:, expand: nil, from_date: nil, name: nil, page: nil, page_cursor: nil, page_limit: nil, status: nil, to_date: nil, type: nil, request_options: {}) ⇒ MethodRuby::Models::EntityListResponse

Some parameter documentations has been truncated, see Models::EntityListParams for more details.

Returns a paginated list of entities.

Parameters:

  • method_version (Symbol, MethodRuby::Models::EntityListParams::MethodVersion) —

    Header param: API version to use for this request. This spec targets ‘2025-12-01

  • expand (Array<Symbol, MethodRuby::Models::EntityListParams::Expand>) —

    Query param: Expand related entity resources inline. Supports the entity expanda

  • from_date (Date) —

    Query param: Filter results from this date (inclusive, YYYY-MM-DD format).

  • name (String) —

    Query param: Filter entities by their name.

  • page (Integer) —

    Query param: Page number for pagination (1-indexed).

  • page_cursor (String) —

    Query param: Cursor for cursor-based pagination. Use the value from ‘Pagination-

  • page_limit (Integer) —

    Query param: Number of items per page.

  • status (Symbol, MethodRuby::Models::EntityListParams::Status) —

    Query param: Filter entities by status.

  • to_date (Date) —

    Query param: Filter results to this date (inclusive, YYYY-MM-DD format).

  • type (Symbol, MethodRuby::Models::EntityListParams::Type) —

    Query param: Filter entities by type.

  • request_options (MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/method_ruby/resources/entities.rb', line 186

def list(params)
  query_params = [
    :expand,
    :from_date,
    :name,
    :page,
    :page_cursor,
    :page_limit,
    :status,
    :to_date,
    :type
  ]
  parsed, options = MethodRuby::EntityListParams.dump_request(params)
  query = MethodRuby::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :get,
    path: "entities",
    query: query,
    headers: parsed.except(*query_params).transform_keys(method_version: "method-version"),
    model: MethodRuby::Models::EntityListResponse,
    security: {secret_key: true},
    options: options
  )
end

#retrieve(entity_id, method_version:, expand: nil, request_options: {}) ⇒ MethodRuby::Models::EntityRetrieveResponse

Some parameter documentations has been truncated, see Models::EntityRetrieveParams for more details.

Returns a single entity by its identifier.

Parameters:

Returns:

See Also:



99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/method_ruby/resources/entities.rb', line 99

def retrieve(entity_id, params)
  query_params = [:expand]
  parsed, options = MethodRuby::EntityRetrieveParams.dump_request(params)
  query = MethodRuby::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :get,
    path: ["entities/%1$s", entity_id],
    query: query,
    headers: parsed.except(*query_params).transform_keys(method_version: "method-version"),
    model: MethodRuby::Models::EntityRetrieveResponse,
    security: {secret_key: true},
    options: options
  )
end

#update(entity_id, method_version:, address: nil, corporation: nil, individual: nil, metadata: nil, idempotency_key: nil, request_options: {}) ⇒ MethodRuby::Models::EntityUpdateResponse

Some parameter documentations has been truncated, see Models::EntityUpdateParams for more details.

Updates an existing entity.

Parameters:

Returns:

See Also:



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/method_ruby/resources/entities.rb', line 140

def update(entity_id, params)
  parsed, options = MethodRuby::EntityUpdateParams.dump_request(params)
  header_params = {method_version: "method-version", idempotency_key: "idempotency-key"}
  @client.request(
    method: :put,
    path: ["entities/%1$s", entity_id],
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: MethodRuby::Models::EntityUpdateResponse,
    security: {secret_key: true},
    options: options
  )
end