Class: Telnyx::Resources::TrafficPolicyProfiles

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

Overview

Traffic Policy Profiles operations

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ TrafficPolicyProfiles

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

Parameters:



189
190
191
 
# File 'lib/telnyx/resources/traffic_policy_profiles.rb', line 189

def initialize(client:)
  @client = client
end

Instance Method Details

#create(type:, domains: nil, ip_ranges: nil, limit_bw_kbps: nil, services: nil, request_options: {}) ⇒ Telnyx::Models::TrafficPolicyProfileCreateResponse

Create a new traffic policy profile. At least one of ‘services`, `ip_ranges`, or `domains` must be provided.

Parameters:

Returns:

See Also:



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

def create(params)
  parsed, options = Telnyx::TrafficPolicyProfileCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "traffic_policy_profiles",
    body: parsed,
    model: Telnyx::Models::TrafficPolicyProfileCreateResponse,
    options: options
  )
end

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

Deletes the traffic policy profile.

Parameters:

  • id (String) —

    Identifies the traffic policy profile.

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

Returns:

See Also:



142
143
144
145
146
147
148
149
 
# File 'lib/telnyx/resources/traffic_policy_profiles.rb', line 142

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

#list(filter_service: nil, filter_type: nil, page_number: nil, page_size: nil, sort: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::TrafficPolicyProfile>

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

Get all traffic policy profiles belonging to the user that match the given filters.

Parameters:

Returns:

See Also:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/telnyx/resources/traffic_policy_profiles.rb', line 113

def list(params = {})
  parsed, options = Telnyx::TrafficPolicyProfileListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "traffic_policy_profiles",
    query: query.transform_keys(
      filter_service: "filter[service]",
      filter_type: "filter[type]",
      page_number: "page[number]",
      page_size: "page[size]"
    ),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::TrafficPolicyProfile,
    options: options
  )
end

#list_services(filter_group: nil, filter_name: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::TrafficPolicyProfileListServicesResponse>

Get all available PCEF services that can be used in traffic policy profiles.

Parameters:

  • filter_group (String) —

    Filter services by group.

  • filter_name (String) —

    Filter services by name.

  • page_number (Integer) —

    The page number to load.

  • page_size (Integer) —

    The size of the page.

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

Returns:

See Also:



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/telnyx/resources/traffic_policy_profiles.rb', line 168

def list_services(params = {})
  parsed, options = Telnyx::TrafficPolicyProfileListServicesParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "traffic_policy_profiles/services",
    query: query.transform_keys(
      filter_group: "filter[group]",
      filter_name: "filter[name]",
      page_number: "page[number]",
      page_size: "page[size]"
    ),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::Models::TrafficPolicyProfileListServicesResponse,
    options: options
  )
end

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

Returns the details regarding a specific traffic policy profile.

Parameters:

  • id (String) —

    Identifies the traffic policy profile.

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

Returns:

See Also:



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

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

#update(id, domains: nil, ip_ranges: nil, limit_bw_kbps: nil, services: nil, type: nil, request_options: {}) ⇒ Telnyx::Models::TrafficPolicyProfileUpdateResponse

Updates a traffic policy profile.

Parameters:

Returns:

See Also:



79
80
81
82
83
84
85
86
87
88
 
# File 'lib/telnyx/resources/traffic_policy_profiles.rb', line 79

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