Class: MethodRuby::Resources::Entities::Identities

Inherits:
Object
  • Object
show all
Defined in:
lib/method_ruby/resources/entities/identities.rb

Overview

Identity verification data for entities

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Identities

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 Identities.

Parameters:



119
120
121
 
# File 'lib/method_ruby/resources/entities/identities.rb', line 119

def initialize(client:)
  @client = client
end

Instance Method Details

#create(entity_id, method_version:, idempotency_key: nil, request_options: {}) ⇒ MethodRuby::Models::Entities::IdentityCreateResponse

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

Creates a new identity retrieval for the specified entity.

Parameters:

Returns:

See Also:



26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/method_ruby/resources/entities/identities.rb', line 26

def create(entity_id, params)
  parsed, options = MethodRuby::Entities::IdentityCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["entities/%1$s/identities", entity_id],
    headers: parsed.transform_keys(
      method_version: "method-version",
      idempotency_key: "idempotency-key"
    ),
    model: MethodRuby::Models::Entities::IdentityCreateResponse,
    security: {secret_key: true},
    options: options
  )
end

#list(entity_id, method_version:, from_date: nil, page: nil, page_cursor: nil, page_limit: nil, to_date: nil, request_options: {}) ⇒ MethodRuby::Models::Entities::IdentityListResponse

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

Returns a list of identity records for the specified entity.

Parameters:

  • entity_id (String) —

    Path param: Unique identifier for the entity.

  • method_version (Symbol, MethodRuby::Models::Entities::IdentityListParams::MethodVersion) —

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

  • from_date (Date) —

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

  • 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.

  • to_date (Date) —

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

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

Returns:

See Also:



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

def list(entity_id, params)
  query_params = [:from_date, :page, :page_cursor, :page_limit, :to_date]
  parsed, options = MethodRuby::Entities::IdentityListParams.dump_request(params)
  query = MethodRuby::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :get,
    path: ["entities/%1$s/identities", entity_id],
    query: query,
    headers: parsed.except(*query_params).transform_keys(method_version: "method-version"),
    model: MethodRuby::Models::Entities::IdentityListResponse,
    security: {secret_key: true},
    options: options
  )
end

#retrieve(idn_id, entity_id:, method_version:, request_options: {}) ⇒ MethodRuby::Models::Entities::IdentityRetrieveResponse

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

Returns a single entity identity record by its identifier.

Parameters:

Returns:

See Also:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/method_ruby/resources/entities/identities.rb', line 59

def retrieve(idn_id, params)
  parsed, options = MethodRuby::Entities::IdentityRetrieveParams.dump_request(params)
  entity_id =
    parsed.delete(:entity_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["entities/%1$s/identities/%2$s", entity_id, idn_id],
    headers: parsed.transform_keys(method_version: "method-version"),
    model: MethodRuby::Models::Entities::IdentityRetrieveResponse,
    security: {secret_key: true},
    options: options
  )
end