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

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

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:



154
155
156
 
# File 'lib/telnyx/resources/messaging_profiles/autoresp_configs.rb', line 154

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

Create auto-response setting

Parameters:

Returns:

See Also:



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/telnyx/resources/messaging_profiles/autoresp_configs.rb', line 22

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

Delete Auto-Response Setting

Parameters:

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

Returns:

  • (String)

See Also:



137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/telnyx/resources/messaging_profiles/autoresp_configs.rb', line 137

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.

List Auto-Response Settings

Parameters:

Returns:

See Also:



114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/telnyx/resources/messaging_profiles/autoresp_configs.rb', line 114

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

Get Auto-Response Setting

Parameters:

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

Returns:

See Also:



44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/telnyx/resources/messaging_profiles/autoresp_configs.rb', line 44

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

Update Auto-Response Setting

Parameters:

Returns:

See Also:



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

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