Class: MethodRuby::Resources::Entities::Connect

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

Overview

Account connection sessions for entities

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Connect

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

Parameters:



134
135
136
 
# File 'lib/method_ruby/resources/entities/connect.rb', line 134

def initialize(client:)
  @client = client
end

Instance Method Details

#create(entity_id, method_version:, expand: nil, products: nil, subscriptions: nil, idempotency_key: nil, request_options: {}) ⇒ MethodRuby::Models::Entities::ConnectCreateResponse

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

Creates a new connect session for the specified entity.

Parameters:

  • entity_id (String) —

    Path param: Unique identifier for the entity.

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

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

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

    Query param: Expand connected accounts inline on entity connect resources.

  • products (Array<String>) —

    Body param: Products to request during the connect session.

  • subscriptions (Array<String>) —

    Body param: Subscriptions to request during the connect session.

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



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/method_ruby/resources/entities/connect.rb', line 32

def create(entity_id, params)
  query_params = [:expand]
  header_params = {method_version: "method-version", idempotency_key: "idempotency-key"}
  parsed, options = MethodRuby::Entities::ConnectCreateParams.dump_request(params)
  query = MethodRuby::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :post,
    path: ["entities/%1$s/connect", entity_id],
    query: query,
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*query_params, *header_params.keys),
    model: MethodRuby::Models::Entities::ConnectCreateResponse,
    security: {secret_key: true},
    options: options
  )
end

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

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

Returns a list of connect sessions for the specified entity.

Parameters:

  • entity_id (String) —

    Path param: Unique identifier for the entity.

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

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

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

    Query param: Expand connected accounts inline on entity connect resources.

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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/method_ruby/resources/entities/connect.rb', line 116

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

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

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

Returns a single entity connect session by its identifier.

Parameters:

Returns:

See Also:



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/method_ruby/resources/entities/connect.rb', line 69

def retrieve(cxn_id, params)
  query_params = [:expand]
  parsed, options = MethodRuby::Entities::ConnectRetrieveParams.dump_request(params)
  query = MethodRuby::Internal::Util.encode_query_params(parsed.slice(*query_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/connect/%2$s", entity_id, cxn_id],
    query: query,
    headers: parsed.except(*query_params).transform_keys(method_version: "method-version"),
    model: MethodRuby::Models::Entities::ConnectRetrieveResponse,
    security: {secret_key: true},
    options: options
  )
end