Class: Telnyx::Resources::PortingOrders::AdditionalDocuments

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

Overview

Endpoints related to porting orders management.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ AdditionalDocuments

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

Parameters:



97
98
99
 
# File 'lib/telnyx/resources/porting_orders/additional_documents.rb', line 97

def initialize(client:)
  @client = client
end

Instance Method Details

#create(id, additional_documents: nil, request_options: {}) ⇒ Telnyx::Models::PortingOrders::AdditionalDocumentCreateResponse

Creates a list of additional documents for a porting order.

Parameters:

Returns:

See Also:



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

def create(id, params = {})
  parsed, options = Telnyx::PortingOrders::AdditionalDocumentCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["porting_orders/%1$s/additional_documents", id],
    body: parsed,
    model: Telnyx::Models::PortingOrders::AdditionalDocumentCreateResponse,
    options: options
  )
end

#delete(additional_document_id, id:, request_options: {}) ⇒ nil

Deletes an additional document for a porting order.

Parameters:

  • additional_document_id (String) —

    Additional document identification.

  • id (String) —

    Porting Order id

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

Returns:

  • (nil)

See Also:



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/telnyx/resources/porting_orders/additional_documents.rb', line 80

def delete(additional_document_id, params)
  parsed, options = Telnyx::PortingOrders::AdditionalDocumentDeleteParams.dump_request(params)
  id =
    parsed.delete(:id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["porting_orders/%1$s/additional_documents/%2$s", id, additional_document_id],
    model: NilClass,
    options: options
  )
end

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

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

Returns a list of additional documents for a porting order.

Parameters:

Returns:

See Also:



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

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