Class: SlackWebApi::RemindersController

Inherits:
BaseController show all
Defined in:
lib/slack_web_api/controllers/reminders_controller.rb

Overview

RemindersController

Constant Summary

Constants inherited from BaseController

BaseController::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

#initialize, #new_parameter, #new_request_builder, #new_response_handler, user_agent, user_agent_parameters

Constructor Details

This class inherits a constructor from SlackWebApi::BaseController

Instance Method Details

#reminders_add(token, text, time, user: nil) ⇒ ApiResponse

Creates a reminder. scope: reminders:write the Unix timestamp (up to five years from now), the number of seconds until the reminder (if within 24 hours), or a natural language description (Ex. “in 15 minutes,” or “every Thursday”) reminder. If no user is specified, the reminder will go to user who created it.

Parameters:

  • token (String) —

    Required parameter: Authentication token. Requires

  • text (String) —

    Required parameter: The content of the reminder

  • time (String) —

    Required parameter: When this reminder should happen:

  • user (String) (defaults to: nil) —

    Optional parameter: The user who will receive the

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/slack_web_api/controllers/reminders_controller.rb', line 21

def reminders_add(token,
                  text,
                  time,
                  user: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/reminders.add',
                                 Server::DEFAULT)
               .header_param(new_parameter(token, key: 'token')
                              .is_required(true))
               .form_param(new_parameter(text, key: 'text')
                            .is_required(true))
               .form_param(new_parameter(time, key: 'time')
                            .is_required(true))
               .form_param(new_parameter(user, key: 'user'))
               .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('slackAuth')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(RemindersAddSchema.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             RemindersAddErrorSchemaException))
    .execute
end

#reminders_complete(token: nil, reminder: nil) ⇒ ApiResponse

Marks a reminder as complete. scope: reminders:write marked as complete

Parameters:

  • token (String) (defaults to: nil) —

    Optional parameter: Authentication token. Requires

  • reminder (String) (defaults to: nil) —

    Optional parameter: The ID of the reminder to be

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/slack_web_api/controllers/reminders_controller.rb', line 55

def reminders_complete(token: nil,
                       reminder: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/reminders.complete',
                                 Server::DEFAULT)
               .header_param(new_parameter(token, key: 'token'))
               .form_param(new_parameter(reminder, key: 'reminder'))
               .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('slackAuth')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(RemindersCompleteSchema.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             RemindersCompleteErrorSchemaException))
    .execute
end

#reminders_delete(token: nil, reminder: nil) ⇒ ApiResponse

Deletes a reminder. scope: reminders:write

Parameters:

  • token (String) (defaults to: nil) —

    Optional parameter: Authentication token. Requires

  • reminder (String) (defaults to: nil) —

    Optional parameter: The ID of the reminder

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/slack_web_api/controllers/reminders_controller.rb', line 81

def reminders_delete(token: nil,
                     reminder: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/reminders.delete',
                                 Server::DEFAULT)
               .header_param(new_parameter(token, key: 'token'))
               .form_param(new_parameter(reminder, key: 'reminder'))
               .header_param(new_parameter('application/x-www-form-urlencoded', key: 'content-type'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('slackAuth')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(RemindersDeleteSchema.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             RemindersDeleteErrorSchemaException))
    .execute
end

#reminders_info(token: nil, reminder: nil) ⇒ ApiResponse

Gets information about a reminder. scope: reminders:read

Parameters:

  • token (String) (defaults to: nil) —

    Optional parameter: Authentication token. Requires

  • reminder (String) (defaults to: nil) —

    Optional parameter: The ID of the reminder

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/slack_web_api/controllers/reminders_controller.rb', line 107

def reminders_info(token: nil,
                   reminder: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/reminders.info',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
               .query_param(new_parameter(token, key: 'token'))
               .query_param(new_parameter(reminder, key: 'reminder'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('slackAuth')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(RemindersInfoSchema.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             RemindersInfoErrorSchemaException))
    .execute
end

#reminders_list(token: nil) ⇒ ApiResponse

Lists all reminders created by or for a given user. scope: reminders:read

Parameters:

  • token (String) (defaults to: nil) —

    Optional parameter: Authentication token. Requires

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/slack_web_api/controllers/reminders_controller.rb', line 132

def reminders_list(token: nil)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/reminders.list',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/x-www-form-urlencoded', key: 'Content-Type'))
               .query_param(new_parameter(token, key: 'token'))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('slackAuth')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(RemindersListSchema.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Typical error response',
                             RemindersListErrorSchemaException))
    .execute
end