Class: Telnyx::Resources::RequirementGroups

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/requirement_groups.rb,
sig/telnyx/resources/requirement_groups.rbs

Overview

Requirement Groups

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ RequirementGroups

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

Parameters:



159
160
161
 
# File 'lib/telnyx/resources/requirement_groups.rb', line 159

def initialize(client:)
  @client = client
end

Instance Method Details

#create(action:, country_code:, phone_number_type:, customer_reference: nil, regulatory_requirements: nil, request_options: {}) ⇒ Telnyx::Models::RequirementGroup

Creates a regulatory requirement group for a country, number type, and ordering or porting action. Optional customer-reference and requirement values are retained on the created group.

Parameters:

Returns:

See Also:



28
29
30
31
32
33
34
35
36
37
 
# File 'lib/telnyx/resources/requirement_groups.rb', line 28

def create(params)
  parsed, options = Telnyx::RequirementGroupCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "requirement_groups",
    body: parsed,
    model: Telnyx::RequirementGroup,
    options: options
  )
end

#delete(id, request_options: {}) ⇒ Telnyx::Models::RequirementGroup

Deletes the regulatory requirement group identified by id. The response contains the deleted requirement-group representation.

Parameters:

  • id (String) —

    ID of the requirement group

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

Returns:

See Also:



126
127
128
129
130
131
132
133
 
# File 'lib/telnyx/resources/requirement_groups.rb', line 126

def delete(id, params = {})
  @client.request(
    method: :delete,
    path: ["requirement_groups/%1$s", id],
    model: Telnyx::RequirementGroup,
    options: params[:request_options]
  )
end

#list(filter: nil, request_options: {}) ⇒ Array<Telnyx::Models::RequirementGroup>

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

Returns regulatory requirement groups for the account. Results can be filtered by country, number type, action, approval status, and customer reference.

Parameters:

Returns:

See Also:



102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/telnyx/resources/requirement_groups.rb', line 102

def list(params = {})
  parsed, options = Telnyx::RequirementGroupListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "requirement_groups",
    query: query,
    model: Telnyx::Internal::Type::ArrayOf[Telnyx::RequirementGroup],
    options: options
  )
end

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

Returns the regulatory requirement group identified by id, including its requirement values and current approval status.

Parameters:

  • id (String) —

    ID of the requirement group to retrieve

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

Returns:

See Also:



51
52
53
54
55
56
57
58
 
# File 'lib/telnyx/resources/requirement_groups.rb', line 51

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

#submit_for_approval(id, request_options: {}) ⇒ Telnyx::Models::RequirementGroup

Submits the specified regulatory requirement group for approval. The response contains the requirement group with its resulting approval status.

Parameters:

  • id (String) —

    ID of the requirement group to submit

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

Returns:

See Also:



147
148
149
150
151
152
153
154
 
# File 'lib/telnyx/resources/requirement_groups.rb', line 147

def submit_for_approval(id, params = {})
  @client.request(
    method: :post,
    path: ["requirement_groups/%1$s/submit_for_approval", id],
    model: Telnyx::RequirementGroup,
    options: params[:request_options]
  )
end

#update(id, customer_reference: nil, regulatory_requirements: nil, request_options: {}) ⇒ Telnyx::Models::RequirementGroup

Updates the customer reference or regulatory requirement values on the specified requirement group. The response contains the updated group.

Parameters:

Returns:

See Also:



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/telnyx/resources/requirement_groups.rb', line 76

def update(id, params = {})
  parsed, options = Telnyx::RequirementGroupUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["requirement_groups/%1$s", id],
    body: parsed,
    model: Telnyx::RequirementGroup,
    options: options
  )
end