Class: Ansible::Ruby::Modules::Catapult

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/notification/catapult.rb

Overview

Allows notifications to be sent using sms / mms via the catapult bandwidth api.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#api_secret ⇒ String

Returns Api Secret from Api account page.

Returns:

  • (String) —

    Api Secret from Api account page.



36
 
# File 'lib/ansible/ruby/modules/generated/notification/catapult.rb', line 36

attribute :api_secret

#api_token ⇒ String

Returns Api Token from Api account page.

Returns:

  • (String) —

    Api Token from Api account page.



32
 
# File 'lib/ansible/ruby/modules/generated/notification/catapult.rb', line 32

attribute :api_token

#dest ⇒ String, ...

Returns The phone number or numbers the message should be sent to (must be in E.164 format, like C(+19195551212)).

Returns:

  • (String, Array<Integer>, Integer) —

    The phone number or numbers the message should be sent to (must be in E.164 format, like C(+19195551212)).



16
 
# File 'lib/ansible/ruby/modules/generated/notification/catapult.rb', line 16

attribute :dest

#media ⇒ String?

Returns For MMS messages, a media url to the location of the media to be sent with the message.

Returns:

  • (String, nil) —

    For MMS messages, a media url to the location of the media to be sent with the message.



24
 
# File 'lib/ansible/ruby/modules/generated/notification/catapult.rb', line 24

attribute :media

#msg ⇒ String

Returns The contents of the text message (must be 2048 characters or less).

Returns:

  • (String) —

    The contents of the text message (must be 2048 characters or less).



20
 
# File 'lib/ansible/ruby/modules/generated/notification/catapult.rb', line 20

attribute :msg

#src ⇒ String

Returns One of your catapult telephone numbers the message should come from (must be in E.164 format, like C(+19195551212)).

Returns:

  • (String) —

    One of your catapult telephone numbers the message should come from (must be in E.164 format, like C(+19195551212)).



12
 
# File 'lib/ansible/ruby/modules/generated/notification/catapult.rb', line 12

attribute :src

#user_id ⇒ String

Returns User Id from Api account page.

Returns:

  • (String) —

    User Id from Api account page.



28
 
# File 'lib/ansible/ruby/modules/generated/notification/catapult.rb', line 28

attribute :user_id