Class: Nylas::Configurations

Inherits:
Resource show all
Includes:
ApiOperations::Delete, ApiOperations::Get, ApiOperations::Post, ApiOperations::Put
Defined in:
lib/nylas/resources/configurations.rb

Overview

Nylas Scheduler Configurations API

Instance Method Summary collapse

Methods inherited from Resource

#initialize

Constructor Details

This class inherits a constructor from Nylas::Resource

Instance Method Details

#create(identifier:, request_body:) ⇒ Array(Hash, String)

Create a configuration.

Parameters:

  • identifier (String) —

    Grant ID or email account in which to create the object.

  • request_body (Hash) —

    The values to create the configuration with.

Returns:

  • (Array(Hash, String)) —

    The created configuration and API Request ID.



43
44
45
46
47
48
 
# File 'lib/nylas/resources/configurations.rb', line 43

def create(identifier:, request_body:)
  post(
    path: "#{api_uri}/v3/grants/#{identifier}/scheduling/configurations",
    request_body: request_body
  )
end

#destroy(identifier:, configuration_id:) ⇒ Array(TrueClass, String)

Delete a configuration.

Parameters:

  • identifier (String) —

    Grant ID or email account from which to delete an object.

  • configuration_id (String) —

    The id of the configuration to delete.

Returns:

  • (Array(TrueClass, String)) —

    True and the API Request ID for the delete operation.



68
69
70
71
72
73
74
 
# File 'lib/nylas/resources/configurations.rb', line 68

def destroy(identifier:, configuration_id:)
  _, request_id = delete(
    path: "#{api_uri}/v3/grants/#{identifier}/scheduling/configurations/#{configuration_id}"
  )

  [true, request_id]
end

#find(identifier:, configuration_id:) ⇒ Array(Hash, String)

Return a Configuration.

Parameters:

  • identifier (String) —

    Grant ID or email account to query.

  • configuration_id (String) —

    The id of the configuration to return.

Returns:

  • (Array(Hash, String)) —

    The configuration and API request ID.



32
33
34
35
36
 
# File 'lib/nylas/resources/configurations.rb', line 32

def find(identifier:, configuration_id:)
  get(
    path: "#{api_uri}/v3/grants/#{identifier}/scheduling/configurations/#{configuration_id}"
  )
end

#list(identifier:, query_params: nil) ⇒ Array(Array(Hash), String, String)

Return all Scheduler Configurations.

and next cursor.

Parameters:

  • identifier (String) —

    Grant ID or email account to query.

  • query_params (Hash, nil) (defaults to: nil) —

    Query params to pass to the request.

Returns:

  • (Array(Array(Hash), String, String)) —

    The list of configurations, API Request ID,



20
21
22
23
24
25
 
# File 'lib/nylas/resources/configurations.rb', line 20

def list(identifier:, query_params: nil)
  get_list(
    path: "#{api_uri}/v3/grants/#{identifier}/scheduling/configurations",
    query_params: query_params
  )
end

#update(identifier:, configuration_id:, request_body:) ⇒ Array(Hash, String)

Update a configuration.

Parameters:

  • identifier (String) —

    Grant ID or email account in which to update an object.

  • configuration_id (String) —

    The id of the configuration to update.

  • request_body (Hash) —

    The values to update the configuration with

Returns:

  • (Array(Hash, String)) —

    The updated configuration and API Request ID.



56
57
58
59
60
61
 
# File 'lib/nylas/resources/configurations.rb', line 56

def update(identifier:, configuration_id:, request_body:)
  put(
    path: "#{api_uri}/v3/grants/#{identifier}/scheduling/configurations/#{configuration_id}",
    request_body: request_body
  )
end