Class: Telnyx::Resources::MessagingProfiles::AutorespConfigs

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

Overview

Opt-Out Management

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ AutorespConfigs

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

Parameters:



165
166
167
 
# File 'lib/telnyx/resources/messaging_profiles/autoresp_configs.rb', line 165

def initialize(client:)
  @client = client
end

Instance Method Details

#create(profile_id, country_code:, keywords:, op:, resp_text: nil, request_options: {}) ⇒ Telnyx::Models::MessagingProfiles::AutoRespConfigResponse

Creates an auto-response rule on the specified messaging profile. Matching inbound messages trigger the configured response.

Parameters:

Returns:

See Also:



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

def create(profile_id, params)
  parsed, options = Telnyx::MessagingProfiles::AutorespConfigCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["messaging_profiles/%1$s/autoresp_configs", profile_id],
    body: parsed,
    model: Telnyx::MessagingProfiles::AutoRespConfigResponse,
    options: options
  )
end

#delete(autoresp_cfg_id, profile_id:, request_options: {}) ⇒ String

Deletes the specified auto-response rule from the messaging profile.

Parameters:

  • autoresp_cfg_id (String) —

    Unique identifier of the autoresp cfg.

  • profile_id (String) —

    Unique identifier of the profile.

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

Returns:

  • (String)

See Also:



148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/telnyx/resources/messaging_profiles/autoresp_configs.rb', line 148

def delete(autoresp_cfg_id, params)
  parsed, options = Telnyx::MessagingProfiles::AutorespConfigDeleteParams.dump_request(params)
  profile_id =
    parsed.delete(:profile_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["messaging_profiles/%1$s/autoresp_configs/%2$s", profile_id, autoresp_cfg_id],
    model: String,
    options: options
  )
end

#list(profile_id, country_code: nil, created_at: nil, updated_at: nil, request_options: {}) ⇒ Telnyx::Models::MessagingProfiles::AutorespConfigListResponse

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

Returns the auto-response rules configured for the specified messaging profile.

Parameters:

Returns:

See Also:



123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/telnyx/resources/messaging_profiles/autoresp_configs.rb', line 123

def list(profile_id, params = {})
  parsed, options = Telnyx::MessagingProfiles::AutorespConfigListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["messaging_profiles/%1$s/autoresp_configs", profile_id],
    query: query,
    model: Telnyx::Models::MessagingProfiles::AutorespConfigListResponse,
    options: options
  )
end

#retrieve(autoresp_cfg_id, profile_id:, request_options: {}) ⇒ Telnyx::Models::MessagingProfiles::AutoRespConfigResponse

Returns the matching criteria and response content for the specified auto-response rule.

Parameters:

  • autoresp_cfg_id (String) —

    Unique identifier of the autoresp cfg.

  • profile_id (String) —

    Unique identifier of the profile.

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

Returns:

See Also:



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

def retrieve(autoresp_cfg_id, params)
  parsed, options = Telnyx::MessagingProfiles::AutorespConfigRetrieveParams.dump_request(params)
  profile_id =
    parsed.delete(:profile_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["messaging_profiles/%1$s/autoresp_configs/%2$s", profile_id, autoresp_cfg_id],
    model: Telnyx::MessagingProfiles::AutoRespConfigResponse,
    options: options
  )
end

#update(autoresp_cfg_id, profile_id:, country_code:, keywords:, op:, resp_text: nil, request_options: {}) ⇒ Telnyx::Models::MessagingProfiles::AutoRespConfigResponse

Replaces the configuration of the specified auto-response rule.

Parameters:

  • autoresp_cfg_id (String) —

    Path param: Unique identifier of the autoresp cfg.

  • profile_id (String) —

    Path param: Unique identifier of the profile.

  • country_code (String) —

    Body param

  • keywords (Array<String>) —

    Body param

  • op (Symbol, Telnyx::Models::MessagingProfiles::AutoRespConfigCreate::Op) —

    Body param

  • resp_text (String) —

    Body param

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

Returns:

See Also:



88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/telnyx/resources/messaging_profiles/autoresp_configs.rb', line 88

def update(autoresp_cfg_id, params)
  parsed, options = Telnyx::MessagingProfiles::AutorespConfigUpdateParams.dump_request(params)
  profile_id =
    parsed.delete(:profile_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :put,
    path: ["messaging_profiles/%1$s/autoresp_configs/%2$s", profile_id, autoresp_cfg_id],
    body: parsed,
    model: Telnyx::MessagingProfiles::AutoRespConfigResponse,
    options: options
  )
end