Class: Twilio::REST::Notify::V1::CredentialList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/notify/v1/credential.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ CredentialList

Initialize the CredentialList

Parameters:

  • version (Version)

    Version that contains the resource


20
21
22
23
24
25
26
# File 'lib/twilio-ruby/rest/notify/v1/credential.rb', line 20

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Credentials"
end

Instance Method Details

#create(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset) ⇒ CredentialInstance

Create the CredentialInstance

Parameters:

  • type (credential.PushService) (defaults to: nil)

    The Credential type. Can be: `gcm`, `fcm`, or `apn`.

  • friendly_name (String) (defaults to: :unset)

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

  • certificate (String) (defaults to: :unset)
    APN only

    The URL-encoded representation of the

    certificate. Strip everything outside of the headers, e.g. `—–BEGIN CERTIFICATE—–MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.….A==—–END CERTIFICATE—–`

  • private_key (String) (defaults to: :unset)
    APN only

    The URL-encoded representation of the

    private key. Strip everything outside of the headers, e.g. `—–BEGIN RSA PRIVATE KEY—–MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieRn.—–END RSA PRIVATE KEY—–`

  • sandbox (Boolean) (defaults to: :unset)
    APN only

    Whether to send the credential to sandbox

    APNs. Can be `true` to send to sandbox APNs or `false` to send to production.

  • api_key (String) (defaults to: :unset)
    GCM only

    The `Server key` of your project from

    Firebase console under Settings / Cloud messaging.

  • secret (String) (defaults to: :unset)
    FCM only

    The `Server key` of your project from Firebase

    console under Settings / Cloud messaging.

Returns:


130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'lib/twilio-ruby/rest/notify/v1/credential.rb', line 130

def create(type: nil, friendly_name: :unset, certificate: :unset, private_key: :unset, sandbox: :unset, api_key: :unset, secret: :unset)
  data = Twilio::Values.of({
      'Type' => type,
      'FriendlyName' => friendly_name,
      'Certificate' => certificate,
      'PrivateKey' => private_key,
      'Sandbox' => sandbox,
      'ApiKey' => api_key,
      'Secret' => secret,
  })

  payload = @version.create('POST', @uri, data: data)

  CredentialInstance.new(@version, payload, )
end

#eachObject

When passed a block, yields CredentialInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.


66
67
68
69
70
71
72
73
74
# File 'lib/twilio-ruby/rest/notify/v1/credential.rb', line 66

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of CredentialInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of CredentialInstance


100
101
102
103
104
105
106
# File 'lib/twilio-ruby/rest/notify/v1/credential.rb', line 100

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  CredentialPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists CredentialInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.

Parameters:

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil)

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array)

    Array of up to limit results


39
40
41
# File 'lib/twilio-ruby/rest/notify/v1/credential.rb', line 39

def list(limit: nil, page_size: nil)
  self.stream(limit: limit, page_size: page_size).entries
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of CredentialInstance records from the API. Request is executed immediately.

Parameters:

  • page_token (String) (defaults to: :unset)

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset)

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • (Page)

    Page of CredentialInstance


83
84
85
86
87
88
89
90
91
92
93
# File 'lib/twilio-ruby/rest/notify/v1/credential.rb', line 83

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  CredentialPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams CredentialInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil)

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable)

    Enumerable that will yield up to limit results


54
55
56
57
58
59
60
# File 'lib/twilio-ruby/rest/notify/v1/credential.rb', line 54

def stream(limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_sObject

Provide a user friendly representation


148
149
150
# File 'lib/twilio-ruby/rest/notify/v1/credential.rb', line 148

def to_s
  '#<Twilio.Notify.V1.CredentialList>'
end