Class: MethodRuby::Resources::Entities::Attributes

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

Overview

Attribute data for entities

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Attributes

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

Parameters:



120
121
122
 
# File 'lib/method_ruby/resources/entities/attributes.rb', line 120

def initialize(client:)
  @client = client
end

Instance Method Details

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

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

Creates a new attribute retrieval for the specified entity.

Parameters:

  • entity_id (String) —

    Path param: Unique identifier for the entity.

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

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

  • attributes (Array<String>) —

    Body param: Specific attributes to request.

  • idempotency_key (String) —

    Header param: Idempotency key for safely retrying a write request. Reuse the sam

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

Returns:

See Also:



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

def create(entity_id, params)
  parsed, options = MethodRuby::Entities::AttributeCreateParams.dump_request(params)
  header_params = {method_version: "method-version", idempotency_key: "idempotency-key"}
  @client.request(
    method: :post,
    path: ["entities/%1$s/attributes", entity_id],
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: MethodRuby::Models::Entities::AttributeCreateResponse,
    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::AttributeListResponse

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

Returns a list of attributes for the specified entity.

Parameters:

  • entity_id (String) —

    Path param: Unique identifier for the entity.

  • method_version (Symbol, MethodRuby::Models::Entities::AttributeListParams::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:



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

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

#retrieve(attr_id, entity_id:, method_version:, request_options: {}) ⇒ MethodRuby::Models::Entities::AttributeRetrieveResponse

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

Returns a single entity attribute by its identifier.

Parameters:

Returns:

See Also:



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

def retrieve(attr_id, params)
  parsed, options = MethodRuby::Entities::AttributeRetrieveParams.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/attributes/%2$s", entity_id, attr_id],
    headers: parsed.transform_keys(method_version: "method-version"),
    model: MethodRuby::Models::Entities::AttributeRetrieveResponse,
    security: {secret_key: true},
    options: options
  )
end