Class: Telnyx::Resources::CustomStorageCredentials

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

Overview

Call Recordings operations.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ CustomStorageCredentials

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

Parameters:



114
115
116
 
# File 'lib/telnyx/resources/custom_storage_credentials.rb', line 114

def initialize(client:)
  @client = client
end

Instance Method Details

#create(connection_id, backend:, configuration:, request_options: {}) ⇒ Telnyx::Models::CustomStorageCredentialCreateResponse

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

Creates a custom storage credentials configuration.

Parameters:

Returns:

See Also:



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

def create(connection_id, params)
  parsed, options = Telnyx::CustomStorageCredentialCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["custom_storage_credentials/%1$s", connection_id],
    body: parsed,
    model: Telnyx::Models::CustomStorageCredentialCreateResponse,
    options: options
  )
end

#delete(connection_id, request_options: {}) ⇒ nil

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

Deletes a stored custom credentials configuration.

Parameters:

  • connection_id (String) —

    Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection

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

Returns:

  • (nil)

See Also:



102
103
104
105
106
107
108
109
 
# File 'lib/telnyx/resources/custom_storage_credentials.rb', line 102

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

#retrieve(connection_id, request_options: {}) ⇒ Telnyx::Models::CustomStorageCredentialRetrieveResponse

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

Returns the information about custom storage credentials.

Parameters:

  • connection_id (String) —

    Uniquely identifies a Telnyx application (Call Control, TeXML) or Sip connection

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

Returns:

See Also:



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

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

#update(connection_id, backend:, configuration:, request_options: {}) ⇒ Telnyx::Models::CustomStorageCredentialUpdateResponse

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

Updates a stored custom credentials configuration.

Parameters:

Returns:

See Also:



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

def update(connection_id, params)
  parsed, options = Telnyx::CustomStorageCredentialUpdateParams.dump_request(params)
  @client.request(
    method: :put,
    path: ["custom_storage_credentials/%1$s", connection_id],
    body: parsed,
    model: Telnyx::Models::CustomStorageCredentialUpdateResponse,
    options: options
  )
end