Class: Telnyx::Resources::MobilePushCredentials

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

Overview

Mobile push credential management

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ MobilePushCredentials

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

Parameters:



104
105
106
 
# File 'lib/telnyx/resources/mobile_push_credentials.rb', line 104

def initialize(client:)
  @client = client
end

Instance Method Details

#create(create_mobile_push_credential_request:, request_options: {}) ⇒ Telnyx::Models::PushCredentialResponse

Creates a new mobile push credential for delivering push notifications to iOS or Android apps, and returns the created credential.

Parameters:

Returns:

See Also:



18
19
20
21
22
23
24
25
26
27
 
# File 'lib/telnyx/resources/mobile_push_credentials.rb', line 18

def create(params)
  parsed, options = Telnyx::MobilePushCredentialCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "mobile_push_credentials",
    body: parsed[:create_mobile_push_credential_request],
    model: Telnyx::PushCredentialResponse,
    options: options
  )
end

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

Deletes a mobile push credential based on the given push_credential_id

Parameters:

  • push_credential_id (String) —

    The unique identifier of a mobile push credential

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

Returns:

  • (nil)

See Also:



92
93
94
95
96
97
98
99
 
# File 'lib/telnyx/resources/mobile_push_credentials.rb', line 92

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

#list(filter: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::PushCredential>

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

Returns a paginated list of the mobile push credentials on your account, with support for filtering.

Parameters:

Returns:

See Also:



68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/telnyx/resources/mobile_push_credentials.rb', line 68

def list(params = {})
  parsed, options = Telnyx::MobilePushCredentialListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "mobile_push_credentials",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::PushCredential,
    options: options
  )
end

#retrieve(push_credential_id, request_options: {}) ⇒ Telnyx::Models::PushCredentialResponse

Retrieves mobile push credential based on the given push_credential_id

Parameters:

  • push_credential_id (String) —

    The unique identifier of a mobile push credential

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

Returns:

See Also:



40
41
42
43
44
45
46
47
 
# File 'lib/telnyx/resources/mobile_push_credentials.rb', line 40

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