losant_rest 1.0.8 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.ruby-version +1 -0
- data/.travis.yml +3 -2
- data/README.md +19 -8
- data/docs/_schemas.md +210 -184
- data/docs/application.md +20 -0
- data/docs/applicationApiToken.md +130 -0
- data/docs/applicationApiTokens.md +83 -0
- data/docs/applicationKey.md +15 -0
- data/docs/applicationKeys.md +10 -0
- data/docs/applications.md +10 -0
- data/docs/auditLog.md +5 -0
- data/docs/auditLogs.md +5 -0
- data/docs/auth.md +20 -8
- data/docs/dashboard.md +13 -0
- data/docs/dashboards.md +10 -0
- data/docs/data.md +10 -0
- data/docs/device.md +55 -0
- data/docs/deviceRecipe.md +20 -0
- data/docs/deviceRecipes.md +10 -0
- data/docs/devices.md +20 -0
- data/docs/event.md +15 -0
- data/docs/events.md +20 -0
- data/docs/flow.md +35 -0
- data/docs/flows.md +10 -0
- data/docs/me.md +61 -0
- data/docs/org.md +51 -0
- data/docs/orgInvites.md +6 -0
- data/docs/orgs.md +11 -0
- data/docs/solution.md +15 -0
- data/docs/solutionUser.md +15 -0
- data/docs/solutionUsers.md +10 -0
- data/docs/solutions.md +10 -0
- data/docs/webhook.md +15 -0
- data/docs/webhooks.md +10 -0
- data/lib/losant_rest.rb +2 -2
- data/lib/losant_rest/application.rb +24 -0
- data/lib/losant_rest/{access_token.rb → application_api_token.rb} +47 -23
- data/lib/losant_rest/{access_tokens.rb → application_api_tokens.rb} +27 -11
- data/lib/losant_rest/application_key.rb +18 -0
- data/lib/losant_rest/application_keys.rb +12 -0
- data/lib/losant_rest/applications.rb +12 -0
- data/lib/losant_rest/audit_log.rb +6 -0
- data/lib/losant_rest/audit_logs.rb +6 -0
- data/lib/losant_rest/auth.rb +20 -8
- data/lib/losant_rest/client.rb +8 -8
- data/lib/losant_rest/dashboard.rb +15 -0
- data/lib/losant_rest/dashboards.rb +12 -0
- data/lib/losant_rest/data.rb +12 -0
- data/lib/losant_rest/device.rb +66 -0
- data/lib/losant_rest/device_recipe.rb +24 -0
- data/lib/losant_rest/device_recipes.rb +12 -0
- data/lib/losant_rest/devices.rb +24 -0
- data/lib/losant_rest/event.rb +18 -0
- data/lib/losant_rest/events.rb +24 -0
- data/lib/losant_rest/flow.rb +42 -0
- data/lib/losant_rest/flows.rb +12 -0
- data/lib/losant_rest/me.rb +74 -0
- data/lib/losant_rest/org.rb +62 -0
- data/lib/losant_rest/org_invites.rb +6 -0
- data/lib/losant_rest/orgs.rb +14 -0
- data/lib/losant_rest/solution.rb +18 -0
- data/lib/losant_rest/solution_user.rb +18 -0
- data/lib/losant_rest/solution_users.rb +12 -0
- data/lib/losant_rest/solutions.rb +12 -0
- data/lib/losant_rest/version.rb +1 -1
- data/lib/losant_rest/webhook.rb +18 -0
- data/lib/losant_rest/webhooks.rb +12 -0
- data/losant_rest.gemspec +3 -3
- data/schemas/{accessToken.json → apiToken.json} +31 -3
- data/schemas/{accessTokenPatch.json → apiTokenPatch.json} +4 -0
- data/schemas/applicationApiTokenPost.json +116 -0
- data/schemas/auditLog.json +3 -1
- data/schemas/auditLogFilter.json +3 -1
- data/schemas/auditLogs.json +3 -1
- data/schemas/event.json +4 -2
- data/schemas/events.json +4 -2
- metadata +17 -19
- data/.rbenv-version +0 -1
- data/docs/accessToken.md +0 -107
- data/docs/accessTokens.md +0 -68
- data/schemas/accessTokenPost.json +0 -32
- data/schemas/accessTokens.json +0 -65
- data/schemas/deviceState.json +0 -31
data/docs/webhook.md
CHANGED
@@ -24,6 +24,11 @@ result = client.webhook.delete(
|
|
24
24
|
puts result
|
25
25
|
```
|
26
26
|
|
27
|
+
#### Authentication
|
28
|
+
The client must be configured with a valid api access token to call this
|
29
|
+
action. The token must include at least one of the following scopes:
|
30
|
+
all.Application, all.Organization, all.User, webhook.*, or webhook.delete.
|
31
|
+
|
27
32
|
#### Available Parameters
|
28
33
|
|
29
34
|
| Name | Type | Required | Description | Default | Example |
|
@@ -58,6 +63,11 @@ result = client.webhook.get(
|
|
58
63
|
puts result
|
59
64
|
```
|
60
65
|
|
66
|
+
#### Authentication
|
67
|
+
The client must be configured with a valid api access token to call this
|
68
|
+
action. The token must include at least one of the following scopes:
|
69
|
+
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, webhook.*, or webhook.get.
|
70
|
+
|
61
71
|
#### Available Parameters
|
62
72
|
|
63
73
|
| Name | Type | Required | Description | Default | Example |
|
@@ -93,6 +103,11 @@ result = client.webhook.patch(
|
|
93
103
|
puts result
|
94
104
|
```
|
95
105
|
|
106
|
+
#### Authentication
|
107
|
+
The client must be configured with a valid api access token to call this
|
108
|
+
action. The token must include at least one of the following scopes:
|
109
|
+
all.Application, all.Organization, all.User, webhook.*, or webhook.patch.
|
110
|
+
|
96
111
|
#### Available Parameters
|
97
112
|
|
98
113
|
| Name | Type | Required | Description | Default | Example |
|
data/docs/webhooks.md
CHANGED
@@ -21,6 +21,11 @@ result = client.webhooks.get(applicationId: my_application_id)
|
|
21
21
|
puts result
|
22
22
|
```
|
23
23
|
|
24
|
+
#### Authentication
|
25
|
+
The client must be configured with a valid api access token to call this
|
26
|
+
action. The token must include at least one of the following scopes:
|
27
|
+
all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, webhooks.*, or webhooks.get.
|
28
|
+
|
24
29
|
#### Available Parameters
|
25
30
|
|
26
31
|
| Name | Type | Required | Description | Default | Example |
|
@@ -60,6 +65,11 @@ result = client.webhooks.post(
|
|
60
65
|
puts result
|
61
66
|
```
|
62
67
|
|
68
|
+
#### Authentication
|
69
|
+
The client must be configured with a valid api access token to call this
|
70
|
+
action. The token must include at least one of the following scopes:
|
71
|
+
all.Application, all.Organization, all.User, webhooks.*, or webhooks.post.
|
72
|
+
|
63
73
|
#### Available Parameters
|
64
74
|
|
65
75
|
| Name | Type | Required | Description | Default | Example |
|
data/lib/losant_rest.rb
CHANGED
@@ -23,9 +23,9 @@
|
|
23
23
|
require_relative "losant_rest/version"
|
24
24
|
require_relative "losant_rest/error"
|
25
25
|
require_relative "losant_rest/utils"
|
26
|
-
require_relative "losant_rest/access_token"
|
27
|
-
require_relative "losant_rest/access_tokens"
|
28
26
|
require_relative "losant_rest/application"
|
27
|
+
require_relative "losant_rest/application_api_token"
|
28
|
+
require_relative "losant_rest/application_api_tokens"
|
29
29
|
require_relative "losant_rest/application_key"
|
30
30
|
require_relative "losant_rest/application_keys"
|
31
31
|
require_relative "losant_rest/applications"
|
@@ -31,6 +31,12 @@ module LosantRest
|
|
31
31
|
|
32
32
|
# Deletes an application
|
33
33
|
#
|
34
|
+
# Authentication:
|
35
|
+
# The client must be configured with a valid api
|
36
|
+
# access token to call this action. The token
|
37
|
+
# must include at least one of the following scopes:
|
38
|
+
# all.Application, all.Organization, all.User, application.*, or application.delete.
|
39
|
+
#
|
34
40
|
# Parameters:
|
35
41
|
# * {string} applicationId - ID of the associated application
|
36
42
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
@@ -69,6 +75,12 @@ module LosantRest
|
|
69
75
|
|
70
76
|
# Retrieves information on an application
|
71
77
|
#
|
78
|
+
# Authentication:
|
79
|
+
# The client must be configured with a valid api
|
80
|
+
# access token to call this action. The token
|
81
|
+
# must include at least one of the following scopes:
|
82
|
+
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.get.
|
83
|
+
#
|
72
84
|
# Parameters:
|
73
85
|
# * {string} applicationId - ID of the associated application
|
74
86
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
@@ -107,6 +119,12 @@ module LosantRest
|
|
107
119
|
|
108
120
|
# Updates information about an application
|
109
121
|
#
|
122
|
+
# Authentication:
|
123
|
+
# The client must be configured with a valid api
|
124
|
+
# access token to call this action. The token
|
125
|
+
# must include at least one of the following scopes:
|
126
|
+
# all.Application, all.Organization, all.User, application.*, or application.patch.
|
127
|
+
#
|
110
128
|
# Parameters:
|
111
129
|
# * {string} applicationId - ID of the associated application
|
112
130
|
# * {hash} application - Object containing new application properties (https://api.losant.com/#/definitions/applicationPatch)
|
@@ -148,6 +166,12 @@ module LosantRest
|
|
148
166
|
|
149
167
|
# Returns payload counts for the time range specified for this application
|
150
168
|
#
|
169
|
+
# Authentication:
|
170
|
+
# The client must be configured with a valid api
|
171
|
+
# access token to call this action. The token
|
172
|
+
# must include at least one of the following scopes:
|
173
|
+
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, application.*, or application.payloadCounts.
|
174
|
+
#
|
151
175
|
# Parameters:
|
152
176
|
# * {string} applicationId - ID of the associated application
|
153
177
|
# * {string} start - Start of range for payload count query (ms since epoch)
|
@@ -22,42 +22,50 @@
|
|
22
22
|
|
23
23
|
module LosantRest
|
24
24
|
|
25
|
-
# Class containing all the actions for the
|
26
|
-
class
|
25
|
+
# Class containing all the actions for the Application Api Token Resource
|
26
|
+
class ApplicationApiToken
|
27
27
|
|
28
28
|
def initialize(client)
|
29
29
|
@client = client
|
30
30
|
end
|
31
31
|
|
32
|
-
# Deletes an
|
32
|
+
# Deletes an API Token
|
33
|
+
#
|
34
|
+
# Authentication:
|
35
|
+
# The client must be configured with a valid api
|
36
|
+
# access token to call this action. The token
|
37
|
+
# must include at least one of the following scopes:
|
38
|
+
# all.Application, all.Organization, all.User, applicationApiToken.*, or applicationApiToken.delete.
|
33
39
|
#
|
34
40
|
# Parameters:
|
35
|
-
# * {string}
|
41
|
+
# * {string} applicationId - ID associated with the application
|
42
|
+
# * {string} apiTokenId - ID associated with the API token
|
36
43
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
37
44
|
# * {boolean} _actions - Return resource actions in response
|
38
45
|
# * {boolean} _links - Return resource link in response
|
39
46
|
# * {boolean} _embedded - Return embedded resources in response
|
40
47
|
#
|
41
48
|
# Responses:
|
42
|
-
# * 200 - If
|
49
|
+
# * 200 - If API token was successfully deleted (https://api.losant.com/#/definitions/success)
|
43
50
|
#
|
44
51
|
# Errors:
|
45
52
|
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
46
|
-
# * 404 - Error if
|
53
|
+
# * 404 - Error if API token was not found (https://api.losant.com/#/definitions/error)
|
47
54
|
def delete(params = {})
|
48
55
|
params = Utils.symbolize_hash_keys(params)
|
49
56
|
query_params = { _actions: false, _links: true, _embedded: true }
|
50
57
|
headers = {}
|
51
58
|
body = nil
|
52
59
|
|
53
|
-
raise ArgumentError.new("
|
60
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
61
|
+
raise ArgumentError.new("apiTokenId is required") unless params.has_key?(:apiTokenId)
|
54
62
|
|
55
63
|
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
56
64
|
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
57
65
|
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
58
66
|
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
59
67
|
|
60
|
-
path = "/
|
68
|
+
path = "/applications/#{params[:applicationId]}/tokens/#{params[:apiTokenId]}"
|
61
69
|
|
62
70
|
@client.request(
|
63
71
|
method: :delete,
|
@@ -67,35 +75,43 @@ module LosantRest
|
|
67
75
|
body: body)
|
68
76
|
end
|
69
77
|
|
70
|
-
# Retrieves information on an
|
78
|
+
# Retrieves information on an API token
|
79
|
+
#
|
80
|
+
# Authentication:
|
81
|
+
# The client must be configured with a valid api
|
82
|
+
# access token to call this action. The token
|
83
|
+
# must include at least one of the following scopes:
|
84
|
+
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationApiToken.*, or applicationApiToken.get.
|
71
85
|
#
|
72
86
|
# Parameters:
|
73
|
-
# * {string}
|
87
|
+
# * {string} applicationId - ID associated with the application
|
88
|
+
# * {string} apiTokenId - ID associated with the API token
|
74
89
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
75
90
|
# * {boolean} _actions - Return resource actions in response
|
76
91
|
# * {boolean} _links - Return resource link in response
|
77
92
|
# * {boolean} _embedded - Return embedded resources in response
|
78
93
|
#
|
79
94
|
# Responses:
|
80
|
-
# * 200 -
|
95
|
+
# * 200 - API token information (https://api.losant.com/#/definitions/apiToken)
|
81
96
|
#
|
82
97
|
# Errors:
|
83
98
|
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
84
|
-
# * 404 - Error if
|
99
|
+
# * 404 - Error if API token was not found (https://api.losant.com/#/definitions/error)
|
85
100
|
def get(params = {})
|
86
101
|
params = Utils.symbolize_hash_keys(params)
|
87
102
|
query_params = { _actions: false, _links: true, _embedded: true }
|
88
103
|
headers = {}
|
89
104
|
body = nil
|
90
105
|
|
91
|
-
raise ArgumentError.new("
|
106
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
107
|
+
raise ArgumentError.new("apiTokenId is required") unless params.has_key?(:apiTokenId)
|
92
108
|
|
93
109
|
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
94
110
|
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
95
111
|
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
96
112
|
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
97
113
|
|
98
|
-
path = "/
|
114
|
+
path = "/applications/#{params[:applicationId]}/tokens/#{params[:apiTokenId]}"
|
99
115
|
|
100
116
|
@client.request(
|
101
117
|
method: :get,
|
@@ -105,38 +121,46 @@ module LosantRest
|
|
105
121
|
body: body)
|
106
122
|
end
|
107
123
|
|
108
|
-
# Updates information about an
|
124
|
+
# Updates information about an API token
|
125
|
+
#
|
126
|
+
# Authentication:
|
127
|
+
# The client must be configured with a valid api
|
128
|
+
# access token to call this action. The token
|
129
|
+
# must include at least one of the following scopes:
|
130
|
+
# all.Application, all.Organization, all.User, applicationApiToken.*, or applicationApiToken.patch.
|
109
131
|
#
|
110
132
|
# Parameters:
|
111
|
-
# * {string}
|
112
|
-
# * {
|
133
|
+
# * {string} applicationId - ID associated with the application
|
134
|
+
# * {string} apiTokenId - ID associated with the API token
|
135
|
+
# * {hash} apiToken - Object containing new properties of the API token (https://api.losant.com/#/definitions/apiTokenPatch)
|
113
136
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
114
137
|
# * {boolean} _actions - Return resource actions in response
|
115
138
|
# * {boolean} _links - Return resource link in response
|
116
139
|
# * {boolean} _embedded - Return embedded resources in response
|
117
140
|
#
|
118
141
|
# Responses:
|
119
|
-
# * 200 - Updated
|
142
|
+
# * 200 - Updated API token information (https://api.losant.com/#/definitions/apiToken)
|
120
143
|
#
|
121
144
|
# Errors:
|
122
145
|
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
123
|
-
# * 404 - Error if
|
146
|
+
# * 404 - Error if API token was not found (https://api.losant.com/#/definitions/error)
|
124
147
|
def patch(params = {})
|
125
148
|
params = Utils.symbolize_hash_keys(params)
|
126
149
|
query_params = { _actions: false, _links: true, _embedded: true }
|
127
150
|
headers = {}
|
128
151
|
body = nil
|
129
152
|
|
130
|
-
raise ArgumentError.new("
|
131
|
-
raise ArgumentError.new("
|
153
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
154
|
+
raise ArgumentError.new("apiTokenId is required") unless params.has_key?(:apiTokenId)
|
155
|
+
raise ArgumentError.new("apiToken is required") unless params.has_key?(:apiToken)
|
132
156
|
|
133
|
-
body = params[:
|
157
|
+
body = params[:apiToken] if params.has_key?(:apiToken)
|
134
158
|
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
135
159
|
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
136
160
|
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
137
161
|
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
138
162
|
|
139
|
-
path = "/
|
163
|
+
path = "/applications/#{params[:applicationId]}/tokens/#{params[:apiTokenId]}"
|
140
164
|
|
141
165
|
@client.request(
|
142
166
|
method: :patch,
|
@@ -22,23 +22,30 @@
|
|
22
22
|
|
23
23
|
module LosantRest
|
24
24
|
|
25
|
-
# Class containing all the actions for the
|
26
|
-
class
|
25
|
+
# Class containing all the actions for the Application Api Tokens Resource
|
26
|
+
class ApplicationApiTokens
|
27
27
|
|
28
28
|
def initialize(client)
|
29
29
|
@client = client
|
30
30
|
end
|
31
31
|
|
32
|
-
# Returns the
|
32
|
+
# Returns the API tokens for an application
|
33
|
+
#
|
34
|
+
# Authentication:
|
35
|
+
# The client must be configured with a valid api
|
36
|
+
# access token to call this action. The token
|
37
|
+
# must include at least one of the following scopes:
|
38
|
+
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationApiTokens.*, or applicationApiTokens.get.
|
33
39
|
#
|
34
40
|
# Parameters:
|
41
|
+
# * {string} applicationId - ID associated with the application
|
35
42
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
36
43
|
# * {boolean} _actions - Return resource actions in response
|
37
44
|
# * {boolean} _links - Return resource link in response
|
38
45
|
# * {boolean} _embedded - Return embedded resources in response
|
39
46
|
#
|
40
47
|
# Responses:
|
41
|
-
# * 200 - Collection of
|
48
|
+
# * 200 - Collection of API tokens (https://api.losant.com/#/definitions/apiToken)
|
42
49
|
#
|
43
50
|
# Errors:
|
44
51
|
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
@@ -48,13 +55,14 @@ module LosantRest
|
|
48
55
|
headers = {}
|
49
56
|
body = nil
|
50
57
|
|
58
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
51
59
|
|
52
60
|
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
53
61
|
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
54
62
|
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
55
63
|
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
56
64
|
|
57
|
-
path = "/
|
65
|
+
path = "/applications/#{params[:applicationId]}/tokens"
|
58
66
|
|
59
67
|
@client.request(
|
60
68
|
method: :get,
|
@@ -64,17 +72,24 @@ module LosantRest
|
|
64
72
|
body: body)
|
65
73
|
end
|
66
74
|
|
67
|
-
# Create a new
|
75
|
+
# Create a new API token for an application
|
76
|
+
#
|
77
|
+
# Authentication:
|
78
|
+
# The client must be configured with a valid api
|
79
|
+
# access token to call this action. The token
|
80
|
+
# must include at least one of the following scopes:
|
81
|
+
# all.Application, all.Organization, all.User, applicationApiTokens.*, or applicationApiTokens.post.
|
68
82
|
#
|
69
83
|
# Parameters:
|
70
|
-
# * {
|
84
|
+
# * {string} applicationId - ID associated with the application
|
85
|
+
# * {hash} apiToken - API token information (https://api.losant.com/#/definitions/applicationApiTokenPost)
|
71
86
|
# * {string} losantdomain - Domain scope of request (rarely needed)
|
72
87
|
# * {boolean} _actions - Return resource actions in response
|
73
88
|
# * {boolean} _links - Return resource link in response
|
74
89
|
# * {boolean} _embedded - Return embedded resources in response
|
75
90
|
#
|
76
91
|
# Responses:
|
77
|
-
# * 201 - The successfully created
|
92
|
+
# * 201 - The successfully created API token (https://api.losant.com/#/definitions/apiToken)
|
78
93
|
#
|
79
94
|
# Errors:
|
80
95
|
# * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
|
@@ -84,15 +99,16 @@ module LosantRest
|
|
84
99
|
headers = {}
|
85
100
|
body = nil
|
86
101
|
|
87
|
-
raise ArgumentError.new("
|
102
|
+
raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
|
103
|
+
raise ArgumentError.new("apiToken is required") unless params.has_key?(:apiToken)
|
88
104
|
|
89
|
-
body = params[:
|
105
|
+
body = params[:apiToken] if params.has_key?(:apiToken)
|
90
106
|
headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
|
91
107
|
query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
|
92
108
|
query_params[:_links] = params[:_links] if params.has_key?(:_links)
|
93
109
|
query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
|
94
110
|
|
95
|
-
path = "/
|
111
|
+
path = "/applications/#{params[:applicationId]}/tokens"
|
96
112
|
|
97
113
|
@client.request(
|
98
114
|
method: :post,
|
@@ -31,6 +31,12 @@ module LosantRest
|
|
31
31
|
|
32
32
|
# Deletes an applicationKey
|
33
33
|
#
|
34
|
+
# Authentication:
|
35
|
+
# The client must be configured with a valid api
|
36
|
+
# access token to call this action. The token
|
37
|
+
# must include at least one of the following scopes:
|
38
|
+
# all.Application, all.Organization, all.User, applicationKey.*, or applicationKey.delete.
|
39
|
+
#
|
34
40
|
# Parameters:
|
35
41
|
# * {string} applicationId - ID associated with the application
|
36
42
|
# * {string} applicationKeyId - ID associated with the applicationKey
|
@@ -71,6 +77,12 @@ module LosantRest
|
|
71
77
|
|
72
78
|
# Retrieves information on an applicationKey
|
73
79
|
#
|
80
|
+
# Authentication:
|
81
|
+
# The client must be configured with a valid api
|
82
|
+
# access token to call this action. The token
|
83
|
+
# must include at least one of the following scopes:
|
84
|
+
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationKey.*, or applicationKey.get.
|
85
|
+
#
|
74
86
|
# Parameters:
|
75
87
|
# * {string} applicationId - ID associated with the application
|
76
88
|
# * {string} applicationKeyId - ID associated with the applicationKey
|
@@ -111,6 +123,12 @@ module LosantRest
|
|
111
123
|
|
112
124
|
# Updates information about an applicationKey
|
113
125
|
#
|
126
|
+
# Authentication:
|
127
|
+
# The client must be configured with a valid api
|
128
|
+
# access token to call this action. The token
|
129
|
+
# must include at least one of the following scopes:
|
130
|
+
# all.Application, all.Organization, all.User, applicationKey.*, or applicationKey.patch.
|
131
|
+
#
|
114
132
|
# Parameters:
|
115
133
|
# * {string} applicationId - ID associated with the application
|
116
134
|
# * {string} applicationKeyId - ID associated with the applicationKey
|
@@ -31,6 +31,12 @@ module LosantRest
|
|
31
31
|
|
32
32
|
# Returns the applicationKeys for an application
|
33
33
|
#
|
34
|
+
# Authentication:
|
35
|
+
# The client must be configured with a valid api
|
36
|
+
# access token to call this action. The token
|
37
|
+
# must include at least one of the following scopes:
|
38
|
+
# all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, applicationKeys.*, or applicationKeys.get.
|
39
|
+
#
|
34
40
|
# Parameters:
|
35
41
|
# * {string} applicationId - ID associated with the application
|
36
42
|
# * {string} sortField - Field to sort the results by. Accepted values are: key, status, id, creationDate
|
@@ -81,6 +87,12 @@ module LosantRest
|
|
81
87
|
|
82
88
|
# Create a new applicationKey for an application
|
83
89
|
#
|
90
|
+
# Authentication:
|
91
|
+
# The client must be configured with a valid api
|
92
|
+
# access token to call this action. The token
|
93
|
+
# must include at least one of the following scopes:
|
94
|
+
# all.Application, all.Organization, all.User, applicationKeys.*, or applicationKeys.post.
|
95
|
+
#
|
84
96
|
# Parameters:
|
85
97
|
# * {string} applicationId - ID associated with the application
|
86
98
|
# * {hash} applicationKey - ApplicationKey information (https://api.losant.com/#/definitions/applicationKeyPost)
|