class Twilio::NotificationsApi
- Twilio::NotificationsApi
- Reference
- Object
Defined in:
twilio/api/notifications_api.crConstant Summary
-
FETCH_NOTIFICATION_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
FETCH_NOTIFICATION_MAX_LENGTH_FOR_SID =
34 -
FETCH_NOTIFICATION_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
FETCH_NOTIFICATION_MIN_LENGTH_FOR_SID =
34 -
FETCH_NOTIFICATION_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/ -
FETCH_NOTIFICATION_PATTERN_FOR_SID =
/^NO[0-9a-fA-F]{32}$/ -
LIST_NOTIFICATION_MAX_FOR_PAGE_SIZE =
Int32.new("1000") -
LIST_NOTIFICATION_MAX_LENGTH_FOR_ACCOUNT_SID =
34 -
LIST_NOTIFICATION_MIN_FOR_PAGE_SIZE =
Int32.new("1") -
LIST_NOTIFICATION_MIN_LENGTH_FOR_ACCOUNT_SID =
34 -
LIST_NOTIFICATION_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
Constructors
Instance Method Summary
- #account_sid : String
- #account_sid=(account_sid : String)
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_fetch_notification(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list_notification(*, account_sid : String | Nil = @account_sid, log : Int32 | Nil = nil, message_date : Time | Nil = nil, message_date_before : Time | Nil = nil, message_date_after : Time | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#fetch_notification(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Twilio::NotificationInstance
Fetch a notification belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Notification resource to fetch.
-
#fetch_notification(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, &block : Crest::Response -> ) : Nil
Fetch a notification belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Notification resource to fetch.
-
#fetch_notification_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Tuple(Twilio::NotificationInstance, Int32, Hash(String, Array(String) | String))
Fetch a notification belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Notification resource to fetch.
-
#list_notification(*, account_sid : String | Nil = @account_sid, log : Int32 | Nil = nil, message_date : Time | Nil = nil, message_date_before : Time | Nil = nil, message_date_after : Time | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListNotificationResponse
Retrieve a list of notifications belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Notification resources to read.
-
#list_notification(*, account_sid : String | Nil = @account_sid, log : Int32 | Nil = nil, message_date : Time | Nil = nil, message_date_before : Time | Nil = nil, message_date_after : Time | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a list of notifications belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Notification resources to read.
-
#list_notification_with_http_info(*, account_sid : String | Nil = @account_sid, log : Int32 | Nil = nil, message_date : Time | Nil = nil, message_date_before : Time | Nil = nil, message_date_after : Time | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListNotificationResponse, Int32, Hash(String, Array(String) | String))
Retrieve a list of notifications belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Notification resources to read.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
Fetch a notification belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Notification resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Notification resource to fetch. @return [Twilio::NotificationInstance]
Fetch a notification belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Notification resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Notification resource to fetch. @return nil
Fetch a notification belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Notification resource to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Notification resource to fetch. @return [Tuple(Twilio::NotificationInstance, Integer, Hash)] Twilio::NotificationInstance, response status code and response headers
Retrieve a list of notifications belonging to the account used to make the request
@required @param account_sid [String?] The SID of the Account that created the Notification resources to read.
@optional @param log [Int32?] Only read notifications of the specified log level. Can be: 0 to read only ERROR notifications or 1 to read only WARNING notifications. By default, all notifications are read.
@optional @param message_date [Time?] Only show notifications for the specified date, formatted as YYYY-MM-DD. You can also specify an inequality, such as <=YYYY-MM-DD for messages logged at or before midnight on a date, or >=YYYY-MM-DD for messages logged at or after midnight on a date.
@optional @param message_date_before [Time?] Only show notifications for the specified date, formatted as YYYY-MM-DD. You can also specify an inequality, such as <=YYYY-MM-DD for messages logged at or before midnight on a date, or >=YYYY-MM-DD for messages logged at or after midnight on a date.
@optional @param message_date_after [Time?] Only show notifications for the specified date, formatted as YYYY-MM-DD. You can also specify an inequality, such as <=YYYY-MM-DD for messages logged at or before midnight on a date, or >=YYYY-MM-DD for messages logged at or after midnight on a date.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Twilio::ListNotificationResponse]
Retrieve a list of notifications belonging to the account used to make the request
@required @param account_sid [String?] The SID of the Account that created the Notification resources to read.
@optional @param log [Int32?] Only read notifications of the specified log level. Can be: 0 to read only ERROR notifications or 1 to read only WARNING notifications. By default, all notifications are read.
@optional @param message_date [Time?] Only show notifications for the specified date, formatted as YYYY-MM-DD. You can also specify an inequality, such as <=YYYY-MM-DD for messages logged at or before midnight on a date, or >=YYYY-MM-DD for messages logged at or after midnight on a date.
@optional @param message_date_before [Time?] Only show notifications for the specified date, formatted as YYYY-MM-DD. You can also specify an inequality, such as <=YYYY-MM-DD for messages logged at or before midnight on a date, or >=YYYY-MM-DD for messages logged at or after midnight on a date.
@optional @param message_date_after [Time?] Only show notifications for the specified date, formatted as YYYY-MM-DD. You can also specify an inequality, such as <=YYYY-MM-DD for messages logged at or before midnight on a date, or >=YYYY-MM-DD for messages logged at or after midnight on a date.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return nil
Retrieve a list of notifications belonging to the account used to make the request
@required @param account_sid [String?] The SID of the Account that created the Notification resources to read.
@optional @param log [Int32?] Only read notifications of the specified log level. Can be: 0 to read only ERROR notifications or 1 to read only WARNING notifications. By default, all notifications are read.
@optional @param message_date [Time?] Only show notifications for the specified date, formatted as YYYY-MM-DD. You can also specify an inequality, such as <=YYYY-MM-DD for messages logged at or before midnight on a date, or >=YYYY-MM-DD for messages logged at or after midnight on a date.
@optional @param message_date_before [Time?] Only show notifications for the specified date, formatted as YYYY-MM-DD. You can also specify an inequality, such as <=YYYY-MM-DD for messages logged at or before midnight on a date, or >=YYYY-MM-DD for messages logged at or after midnight on a date.
@optional @param message_date_after [Time?] Only show notifications for the specified date, formatted as YYYY-MM-DD. You can also specify an inequality, such as <=YYYY-MM-DD for messages logged at or before midnight on a date, or >=YYYY-MM-DD for messages logged at or after midnight on a date.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Tuple(Twilio::ListNotificationResponse, Integer, Hash)] Twilio::ListNotificationResponse, response status code and response headers