Class: Telnyx::Resources::PortingOrders::ActivationJobs

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

Overview

Endpoints related to porting orders management.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ ActivationJobs

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

Parameters:



99
100
101
 
# File 'lib/telnyx/resources/porting_orders/activation_jobs.rb', line 99

def initialize(client:)
  @client = client
end

Instance Method Details

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

Returns a list of your porting activation jobs.

Parameters:

  • id (String) —

    Porting Order id

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

Returns:

See Also:



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/telnyx/resources/porting_orders/activation_jobs.rb', line 83

def list(id, params = {})
  parsed, options = Telnyx::PortingOrders::ActivationJobListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["porting_orders/%1$s/activation_jobs", id],
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::PortingOrdersActivationJob,
    options: options
  )
end

#retrieve(activation_job_id, id:, request_options: {}) ⇒ Telnyx::Models::PortingOrders::ActivationJobRetrieveResponse

Returns a porting activation job.

Parameters:

  • activation_job_id (String) —

    Activation Job Identifier

  • id (String) —

    Porting Order id

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

Returns:

See Also:



21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/telnyx/resources/porting_orders/activation_jobs.rb', line 21

def retrieve(activation_job_id, params)
  parsed, options = Telnyx::PortingOrders::ActivationJobRetrieveParams.dump_request(params)
  id =
    parsed.delete(:id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["porting_orders/%1$s/activation_jobs/%2$s", id, activation_job_id],
    model: Telnyx::Models::PortingOrders::ActivationJobRetrieveResponse,
    options: options
  )
end

#update(activation_job_id, id:, activate_at: nil, request_options: {}) ⇒ Telnyx::Models::PortingOrders::ActivationJobUpdateResponse

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

Updates the activation time of a porting activation job.

Parameters:

  • activation_job_id (String) —

    Path param: Activation Job Identifier

  • id (String) —

    Path param: Porting Order id

  • activate_at (Time) —

    Body param: The desired activation time. The activation time should be between a

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

Returns:

See Also:



53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/telnyx/resources/porting_orders/activation_jobs.rb', line 53

def update(activation_job_id, params)
  parsed, options = Telnyx::PortingOrders::ActivationJobUpdateParams.dump_request(params)
  id =
    parsed.delete(:id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :patch,
    path: ["porting_orders/%1$s/activation_jobs/%2$s", id, activation_job_id],
    body: parsed,
    model: Telnyx::Models::PortingOrders::ActivationJobUpdateResponse,
    options: options
  )
end