Class: Telnyx::Resources::RequirementGroups

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

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:



152
153
154
 
# File 'lib/telnyx/resources/requirement_groups.rb', line 152

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

Create a new requirement group

Parameters:

Returns:

See Also:



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

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

Delete a requirement group by ID

Parameters:

  • id (String) —

    ID of the requirement group

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

Returns:

See Also:



120
121
122
123
124
125
126
127
 
# File 'lib/telnyx/resources/requirement_groups.rb', line 120

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.

List requirement groups

Parameters:

Returns:

See Also:



97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/telnyx/resources/requirement_groups.rb', line 97

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

Get a single requirement group by ID

Parameters:

  • id (String) —

    ID of the requirement group to retrieve

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

Returns:

See Also:



48
49
50
51
52
53
54
55
 
# File 'lib/telnyx/resources/requirement_groups.rb', line 48

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

Submit a Requirement Group for Approval

Parameters:

  • id (String) —

    ID of the requirement group to submit

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

Returns:

See Also:



140
141
142
143
144
145
146
147
 
# File 'lib/telnyx/resources/requirement_groups.rb', line 140

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

Update requirement values in requirement group

Parameters:

Returns:

See Also:



72
73
74
75
76
77
78
79
80
81
 
# File 'lib/telnyx/resources/requirement_groups.rb', line 72

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