Class: Telnyx::Resources::BulkSimCardActions

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/bulk_sim_card_actions.rb

Overview

View SIM card actions, their progress and timestamps using the SIM Card Actions API

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ BulkSimCardActions

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

Parameters:



65
66
67
 
# File 'lib/telnyx/resources/bulk_sim_card_actions.rb', line 65

def initialize(client:)
  @client = client
end

Instance Method Details

#list(filter_action_type: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::BulkSimCardActionListResponse>

This API lists a paginated collection of bulk SIM card actions. A bulk SIM card action contains details about a collection of individual SIM card actions.

Parameters:

Returns:

See Also:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/telnyx/resources/bulk_sim_card_actions.rb', line 45

def list(params = {})
  parsed, options = Telnyx::BulkSimCardActionListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "bulk_sim_card_actions",
    query: query.transform_keys(
      filter_action_type: "filter[action_type]",
      page_number: "page[number]",
      page_size: "page[size]"
    ),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::Models::BulkSimCardActionListResponse,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ Telnyx::Models::BulkSimCardActionRetrieveResponse

This API fetches information about a bulk SIM card action. A bulk SIM card action contains details about a collection of individual SIM card actions.

Parameters:

  • id (String) —

    Identifies the resource.

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

Returns:

See Also:



20
21
22
23
24
25
26
27
 
# File 'lib/telnyx/resources/bulk_sim_card_actions.rb', line 20

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["bulk_sim_card_actions/%1$s", id],
    model: Telnyx::Models::BulkSimCardActionRetrieveResponse,
    options: params[:request_options]
  )
end