-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
regenerating client for API v1.27.0 and bumping package version
- Loading branch information
Showing
43 changed files
with
3,293 additions
and
69 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,269 @@ | ||
| # Instance Notification Rule Actions | ||
|
|
||
| Details on the various actions that can be performed on the | ||
| Instance Notification Rule resource, including the expected | ||
| parameters and the potential responses. | ||
|
|
||
| ##### Contents | ||
|
|
||
| * [Delete](#delete) | ||
| * [Evaluate](#evaluate) | ||
| * [Get](#get) | ||
| * [Logs](#logs) | ||
| * [Patch](#patch) | ||
|
|
||
| <br/> | ||
|
|
||
| ## Delete | ||
|
|
||
| Deletes a notification rule | ||
|
|
||
| ```javascript | ||
| var params = { | ||
| instanceId: myInstanceId, | ||
| notificationRuleId: myNotificationRuleId | ||
| }; | ||
|
|
||
| // with callbacks | ||
| client.instanceNotificationRule.delete(params, function (err, result) { | ||
| if (err) { return console.error(err); } | ||
| console.log(result); | ||
| }); | ||
|
|
||
| // with promises | ||
| client.instanceNotificationRule.delete(params) | ||
| .then(console.log) | ||
| .catch(console.error); | ||
| ``` | ||
|
|
||
| #### Authentication | ||
| The client must be configured with a valid api access token to call this | ||
| action. The token must include at least one of the following scopes: | ||
| all.Instance, all.User, instanceNotificationRule.*, or instanceNotificationRule.delete. | ||
|
|
||
| #### Available Parameters | ||
|
|
||
| | Name | Type | Required | Description | Default | Example | | ||
| | ---- | ---- | -------- | ----------- | ------- | ------- | | ||
| | instanceId | string | Y | ID associated with the instance | | 575ec7417ae143cd83dc4a96 | | ||
| | notificationRuleId | string | Y | ID associated with the notification rule | | 575ec7417ae143cd83dc4a95 | | ||
| | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com | | ||
|
|
||
| #### Successful Responses | ||
|
|
||
| | Code | Type | Description | | ||
| | ---- | ---- | ----------- | | ||
| | 200 | [Success](../lib/schemas/success.json) | If notification rule was successfully deleted | | ||
|
|
||
| #### Error Responses | ||
|
|
||
| | Code | Type | Description | | ||
| | ---- | ---- | ----------- | | ||
| | 400 | [Error](../lib/schemas/error.json) | Error if malformed request | | ||
| | 404 | [Error](../lib/schemas/error.json) | Error if notification rule was not found | | ||
|
|
||
| <br/> | ||
|
|
||
| ## Evaluate | ||
|
|
||
| Queues the evaluation of a notification rule | ||
|
|
||
| ```javascript | ||
| var params = { | ||
| instanceId: myInstanceId, | ||
| notificationRuleId: myNotificationRuleId, | ||
| evaluationOptions: myEvaluationOptions | ||
| }; | ||
|
|
||
| // with callbacks | ||
| client.instanceNotificationRule.evaluate(params, function (err, result) { | ||
| if (err) { return console.error(err); } | ||
| console.log(result); | ||
| }); | ||
|
|
||
| // with promises | ||
| client.instanceNotificationRule.evaluate(params) | ||
| .then(console.log) | ||
| .catch(console.error); | ||
| ``` | ||
|
|
||
| #### Authentication | ||
| The client must be configured with a valid api access token to call this | ||
| action. The token must include at least one of the following scopes: | ||
| all.Instance, all.User, instanceNotificationRule.*, or instanceNotificationRule.evaluate. | ||
|
|
||
| #### Available Parameters | ||
|
|
||
| | Name | Type | Required | Description | Default | Example | | ||
| | ---- | ---- | -------- | ----------- | ------- | ------- | | ||
| | instanceId | string | Y | ID associated with the instance | | 575ec7417ae143cd83dc4a96 | | ||
| | notificationRuleId | string | Y | ID associated with the notification rule | | 575ec7417ae143cd83dc4a95 | | ||
| | evaluationOptions | [Notification Rule Evaluation Options](../lib/schemas/notificationRuleEvaluationOptions.json) | Y | The options for the evaluation | | [Notification Rule Evaluation Options Example](_schemas.md#notification-rule-evaluation-options-example) | | ||
| | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com | | ||
|
|
||
| #### Successful Responses | ||
|
|
||
| | Code | Type | Description | | ||
| | ---- | ---- | ----------- | | ||
| | 202 | [Job Enqueued API Result](../lib/schemas/jobEnqueuedResult.json) | If the evaluation was successfully queued | | ||
|
|
||
| #### Error Responses | ||
|
|
||
| | Code | Type | Description | | ||
| | ---- | ---- | ----------- | | ||
| | 400 | [Error](../lib/schemas/error.json) | Error if malformed request | | ||
| | 404 | [Error](../lib/schemas/error.json) | Error if notification rule was not found | | ||
|
|
||
| <br/> | ||
|
|
||
| ## Get | ||
|
|
||
| Retrieves information on a notification rule | ||
|
|
||
| ```javascript | ||
| var params = { | ||
| instanceId: myInstanceId, | ||
| notificationRuleId: myNotificationRuleId | ||
| }; | ||
|
|
||
| // with callbacks | ||
| client.instanceNotificationRule.get(params, function (err, result) { | ||
| if (err) { return console.error(err); } | ||
| console.log(result); | ||
| }); | ||
|
|
||
| // with promises | ||
| client.instanceNotificationRule.get(params) | ||
| .then(console.log) | ||
| .catch(console.error); | ||
| ``` | ||
|
|
||
| #### Authentication | ||
| The client must be configured with a valid api access token to call this | ||
| action. The token must include at least one of the following scopes: | ||
| all.Instance, all.Instance.read, all.User, all.User.read, instanceNotificationRule.*, or instanceNotificationRule.get. | ||
|
|
||
| #### Available Parameters | ||
|
|
||
| | Name | Type | Required | Description | Default | Example | | ||
| | ---- | ---- | -------- | ----------- | ------- | ------- | | ||
| | instanceId | string | Y | ID associated with the instance | | 575ec7417ae143cd83dc4a96 | | ||
| | notificationRuleId | string | Y | ID associated with the notification rule | | 575ec7417ae143cd83dc4a95 | | ||
| | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com | | ||
|
|
||
| #### Successful Responses | ||
|
|
||
| | Code | Type | Description | | ||
| | ---- | ---- | ----------- | | ||
| | 200 | [Notification Rule](../lib/schemas/notificationRule.json) | Notification rule information | | ||
|
|
||
| #### Error Responses | ||
|
|
||
| | Code | Type | Description | | ||
| | ---- | ---- | ----------- | | ||
| | 400 | [Error](../lib/schemas/error.json) | Error if malformed request | | ||
| | 404 | [Error](../lib/schemas/error.json) | Error if notification rule was not found | | ||
|
|
||
| <br/> | ||
|
|
||
| ## Logs | ||
|
|
||
| Retrieves information on notification rule deliveries | ||
|
|
||
| ```javascript | ||
| var params = { | ||
| instanceId: myInstanceId, | ||
| notificationRuleId: myNotificationRuleId | ||
| }; | ||
|
|
||
| // with callbacks | ||
| client.instanceNotificationRule.logs(params, function (err, result) { | ||
| if (err) { return console.error(err); } | ||
| console.log(result); | ||
| }); | ||
|
|
||
| // with promises | ||
| client.instanceNotificationRule.logs(params) | ||
| .then(console.log) | ||
| .catch(console.error); | ||
| ``` | ||
|
|
||
| #### Authentication | ||
| The client must be configured with a valid api access token to call this | ||
| action. The token must include at least one of the following scopes: | ||
| all.Instance, all.User, instanceNotificationRule.*, or instanceNotificationRule.logs. | ||
|
|
||
| #### Available Parameters | ||
|
|
||
| | Name | Type | Required | Description | Default | Example | | ||
| | ---- | ---- | -------- | ----------- | ------- | ------- | | ||
| | instanceId | string | Y | ID associated with the instance | | 575ec7417ae143cd83dc4a96 | | ||
| | notificationRuleId | string | Y | ID associated with the notification rule | | 575ec7417ae143cd83dc4a95 | | ||
| | limit | string | N | Max log entries to return (ordered by time descending) | 1 | 10 | | ||
| | since | string | N | Look for log entries since this time (ms since epoch) | | 1465790400000 | | ||
| | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com | | ||
|
|
||
| #### Successful Responses | ||
|
|
||
| | Code | Type | Description | | ||
| | ---- | ---- | ----------- | | ||
| | 200 | [Notification Rule Delivery Logs](../lib/schemas/notificationRuleDeliveryLogs.json) | Notification delivery information | | ||
|
|
||
| #### Error Responses | ||
|
|
||
| | Code | Type | Description | | ||
| | ---- | ---- | ----------- | | ||
| | 400 | [Error](../lib/schemas/error.json) | Error if malformed request | | ||
| | 404 | [Error](../lib/schemas/error.json) | Error if notification rule was not found | | ||
|
|
||
| <br/> | ||
|
|
||
| ## Patch | ||
|
|
||
| Updates information about a notification rule | ||
|
|
||
| ```javascript | ||
| var params = { | ||
| instanceId: myInstanceId, | ||
| notificationRuleId: myNotificationRuleId, | ||
| notificationRule: myNotificationRule | ||
| }; | ||
|
|
||
| // with callbacks | ||
| client.instanceNotificationRule.patch(params, function (err, result) { | ||
| if (err) { return console.error(err); } | ||
| console.log(result); | ||
| }); | ||
|
|
||
| // with promises | ||
| client.instanceNotificationRule.patch(params) | ||
| .then(console.log) | ||
| .catch(console.error); | ||
| ``` | ||
|
|
||
| #### Authentication | ||
| The client must be configured with a valid api access token to call this | ||
| action. The token must include at least one of the following scopes: | ||
| all.Instance, all.User, instanceNotificationRule.*, or instanceNotificationRule.patch. | ||
|
|
||
| #### Available Parameters | ||
|
|
||
| | Name | Type | Required | Description | Default | Example | | ||
| | ---- | ---- | -------- | ----------- | ------- | ------- | | ||
| | instanceId | string | Y | ID associated with the instance | | 575ec7417ae143cd83dc4a96 | | ||
| | notificationRuleId | string | Y | ID associated with the notification rule | | 575ec7417ae143cd83dc4a95 | | ||
| | notificationRule | [Notification Rule Patch](../lib/schemas/notificationRulePatch.json) | Y | Object containing new properties of the notification rule | | [Notification Rule Patch Example](_schemas.md#notification-rule-patch-example) | | ||
| | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com | | ||
|
|
||
| #### Successful Responses | ||
|
|
||
| | Code | Type | Description | | ||
| | ---- | ---- | ----------- | | ||
| | 200 | [Notification Rule](../lib/schemas/notificationRule.json) | Updated notification rule information | | ||
|
|
||
| #### Error Responses | ||
|
|
||
| | Code | Type | Description | | ||
| | ---- | ---- | ----------- | | ||
| | 400 | [Error](../lib/schemas/error.json) | Error if malformed request | | ||
| | 404 | [Error](../lib/schemas/error.json) | Error if notification rule was not found | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| # Instance Notification Rules Actions | ||
|
|
||
| Details on the various actions that can be performed on the | ||
| Instance Notification Rules resource, including the expected | ||
| parameters and the potential responses. | ||
|
|
||
| ##### Contents | ||
|
|
||
| * [Get](#get) | ||
| * [Post](#post) | ||
|
|
||
| <br/> | ||
|
|
||
| ## Get | ||
|
|
||
| Returns the notification rules for an instance | ||
|
|
||
| ```javascript | ||
| var params = { | ||
| instanceId: myInstanceId | ||
| }; | ||
|
|
||
| // with callbacks | ||
| client.instanceNotificationRules.get(params, function (err, result) { | ||
| if (err) { return console.error(err); } | ||
| console.log(result); | ||
| }); | ||
|
|
||
| // with promises | ||
| client.instanceNotificationRules.get(params) | ||
| .then(console.log) | ||
| .catch(console.error); | ||
| ``` | ||
|
|
||
| #### Authentication | ||
| The client must be configured with a valid api access token to call this | ||
| action. The token must include at least one of the following scopes: | ||
| all.Instance, all.Instance.read, all.User, all.User.read, instanceNotificationRules.*, or instanceNotificationRules.get. | ||
|
|
||
| #### Available Parameters | ||
|
|
||
| | Name | Type | Required | Description | Default | Example | | ||
| | ---- | ---- | -------- | ----------- | ------- | ------- | | ||
| | instanceId | string | Y | ID associated with the instance | | 575ec7417ae143cd83dc4a96 | | ||
| | sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name | | ||
| | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc | | ||
| | page | string | N | Which page of results to return | 0 | 0 | | ||
| | perPage | string | N | How many items to return per page | 100 | 10 | | ||
| | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | key | | ||
| | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*rule | | ||
| | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com | | ||
|
|
||
| #### Successful Responses | ||
|
|
||
| | Code | Type | Description | | ||
| | ---- | ---- | ----------- | | ||
| | 200 | [Notification Rules](../lib/schemas/notificationRules.json) | Collection of notification rules | | ||
|
|
||
| #### Error Responses | ||
|
|
||
| | Code | Type | Description | | ||
| | ---- | ---- | ----------- | | ||
| | 400 | [Error](../lib/schemas/error.json) | Error if malformed request | | ||
|
|
||
| <br/> | ||
|
|
||
| ## Post | ||
|
|
||
| Create a new notification rule for an instance | ||
|
|
||
| ```javascript | ||
| var params = { | ||
| instanceId: myInstanceId, | ||
| notificationRule: myNotificationRule | ||
| }; | ||
|
|
||
| // with callbacks | ||
| client.instanceNotificationRules.post(params, function (err, result) { | ||
| if (err) { return console.error(err); } | ||
| console.log(result); | ||
| }); | ||
|
|
||
| // with promises | ||
| client.instanceNotificationRules.post(params) | ||
| .then(console.log) | ||
| .catch(console.error); | ||
| ``` | ||
|
|
||
| #### Authentication | ||
| The client must be configured with a valid api access token to call this | ||
| action. The token must include at least one of the following scopes: | ||
| all.Instance, all.User, instanceNotificationRules.*, or instanceNotificationRules.post. | ||
|
|
||
| #### Available Parameters | ||
|
|
||
| | Name | Type | Required | Description | Default | Example | | ||
| | ---- | ---- | -------- | ----------- | ------- | ------- | | ||
| | instanceId | string | Y | ID associated with the instance | | 575ec7417ae143cd83dc4a96 | | ||
| | notificationRule | [Notification Rule Post](../lib/schemas/notificationRulePost.json) | Y | Notification rule information | | [Notification Rule Post Example](_schemas.md#notification-rule-post-example) | | ||
| | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com | | ||
|
|
||
| #### Successful Responses | ||
|
|
||
| | Code | Type | Description | | ||
| | ---- | ---- | ----------- | | ||
| | 201 | [Notification Rule](../lib/schemas/notificationRule.json) | The successfully created notification rule | | ||
|
|
||
| #### Error Responses | ||
|
|
||
| | Code | Type | Description | | ||
| | ---- | ---- | ----------- | | ||
| | 400 | [Error](../lib/schemas/error.json) | Error if malformed request | |
Oops, something went wrong.