Module: Oktakit::Client::Templates

Included in:
Oktakit::Client
Defined in:
lib/oktakit/client/templates.rb

Instance Method Summary collapse

Instance Method Details

#add_sms_template(options = {}) ⇒ Hash<Sawyer::Resource>

Add SMS Template

Examples:

Oktakit.add_sms_template

Parameters:

  • options (:query) (defaults to: {}) —
    Hash

    Optional. Query params for request

  • options (:headers) (defaults to: {}) —
    Hash

    Optional. Header params for the request.

  • options (:accept) (defaults to: {}) —
    String

    Optional. The content type to accept. Default application/json

  • options (:content_type) (defaults to: {}) —
    String

    Optional. The content type for the request. Default application/json

  • options (Hash) (defaults to: {}) —

    Optional. Body params for request.

Returns:

  • (Hash<Sawyer::Resource>) —

    The created SMS Template.

See Also:



15
16
17
 
# File 'lib/oktakit/client/templates.rb', line 15

def add_sms_template(options = {})
  post('/templates/sms', options)
end

#get_sms_template(id, options = {}) ⇒ Hash<Sawyer::Resource>

Get SMS Template

Examples:

Oktakit.get_sms_template('id')

Parameters:

  • options (:query) (defaults to: {}) —
    Hash

    Optional. Query params for request

  • options (:headers) (defaults to: {}) —
    Hash

    Optional. Header params for the request.

  • options (:accept) (defaults to: {}) —
    String

    Optional. The content type to accept. Default application/json

  • options (:content_type) (defaults to: {}) —
    String

    Optional. The content type for the request. Default application/json

  • options (Hash) (defaults to: {}) —

    Optional. Body params for request.

Returns:

  • (Hash<Sawyer::Resource>) —

    Fetched SMS Template

See Also:



31
32
33
 
# File 'lib/oktakit/client/templates.rb', line 31

def get_sms_template(id, options = {})
  get("/templates/sms/#{id}", options)
end

#list_sms_templates(options = {}) ⇒ Array<Sawyer::Resource>

List SMS Templates

Examples:

Oktakit.list_sms_templates

Parameters:

  • options (:query) (defaults to: {}) —
    Hash

    Optional. Query params for request

  • options (:headers) (defaults to: {}) —
    Hash

    Optional. Header params for the request.

  • options (:accept) (defaults to: {}) —
    String

    Optional. The content type to accept. Default application/json

  • options (:content_type) (defaults to: {}) —
    String

    Optional. The content type for the request. Default application/json

  • options (Hash) (defaults to: {}) —

    Optional. Body params for request.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of SMS Template

See Also:



46
47
48
 
# File 'lib/oktakit/client/templates.rb', line 46

def list_sms_templates(options = {})
  get('/templates/sms', options)
end

#partial_sms_template_update(id, options = {}) ⇒ Hash<Sawyer::Resource>

Partial SMS Template Update

Examples:

Oktakit.partial_sms_template_update('id')

Parameters:

  • options (:query) (defaults to: {}) —
    Hash

    Optional. Query params for request

  • options (:headers) (defaults to: {}) —
    Hash

    Optional. Header params for the request.

  • options (:accept) (defaults to: {}) —
    String

    Optional. The content type to accept. Default application/json

  • options (:content_type) (defaults to: {}) —
    String

    Optional. The content type for the request. Default application/json

  • options (Hash) (defaults to: {}) —

    Optional. Body params for request.

Returns:

  • (Hash<Sawyer::Resource>) —

    Updated Sms Template

See Also:



78
79
80
 
# File 'lib/oktakit/client/templates.rb', line 78

def partial_sms_template_update(id, options = {})
  post("/templates/sms/#{id}", options)
end

#remove_sms_template(id, options = {}) ⇒ Hash<Sawyer::Resource>

Remove SMS Template

Examples:

Oktakit.remove_sms_template('id')

Parameters:

  • options (:query) (defaults to: {}) —
    Hash

    Optional. Query params for request

  • options (:headers) (defaults to: {}) —
    Hash

    Optional. Header params for the request.

  • options (:accept) (defaults to: {}) —
    String

    Optional. The content type to accept. Default application/json

  • options (:content_type) (defaults to: {}) —
    String

    Optional. The content type for the request. Default application/json

  • options (Hash) (defaults to: {}) —

    Optional. Body params for request.

Returns:

  • (Hash<Sawyer::Resource>) —

    There is no content in the response.

See Also:



94
95
96
 
# File 'lib/oktakit/client/templates.rb', line 94

def remove_sms_template(id, options = {})
  delete("/templates/sms/#{id}", options)
end

#update_sms_template(id, options = {}) ⇒ Hash<Sawyer::Resource>

Update Sms Template

Examples:

Oktakit.update_sms_template('id')

Parameters:

  • options (:query) (defaults to: {}) —
    Hash

    Optional. Query params for request

  • options (:headers) (defaults to: {}) —
    Hash

    Optional. Header params for the request.

  • options (:accept) (defaults to: {}) —
    String

    Optional. The content type to accept. Default application/json

  • options (:content_type) (defaults to: {}) —
    String

    Optional. The content type for the request. Default application/json

  • options (Hash) (defaults to: {}) —

    Optional. Body params for request.

Returns:

  • (Hash<Sawyer::Resource>) —

    Updated SMS Template

See Also:



62
63
64
 
# File 'lib/oktakit/client/templates.rb', line 62

def update_sms_template(id, options = {})
  put("/templates/sms/#{id}", options)
end