losant_rest 2.1.0 → 2.1.1

data/lib/platform_rest/edge_deployments.rb

@@ -108,7 +108,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  201 - If deployment release has been initiated successfully (https://api.losant.com/#/definitions/success)
+    # *  202 - If deployment release has been accepted for processing (https://api.losant.com/#/definitions/success)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -155,7 +155,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  201 - If deployment removal has been initiated successfully (https://api.losant.com/#/definitions/success)
+    # *  202 - If deployment removal has been accepted for processing (https://api.losant.com/#/definitions/success)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -202,7 +202,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  201 - If deployment replacement has been initiated successfully (https://api.losant.com/#/definitions/success)
+    # *  202 - If deployment replacement has been accepted for processing (https://api.losant.com/#/definitions/success)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/platform_rest/embedded_deployments.rb

@@ -152,7 +152,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  201 - If deployment release has been initiated successfully (https://api.losant.com/#/definitions/success)
+    # *  202 - If deployment release has been accepted for processing (https://api.losant.com/#/definitions/success)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -199,7 +199,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  201 - If deployment removal has been initiated successfully (https://api.losant.com/#/definitions/success)
+    # *  202 - If deployment removal has been accepted for processing (https://api.losant.com/#/definitions/success)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -246,7 +246,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  201 - If deployment replacement has been initiated successfully (https://api.losant.com/#/definitions/success)
+    # *  202 - If deployment replacement has been accepted for processing (https://api.losant.com/#/definitions/success)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/platform_rest/experience.rb

@@ -95,7 +95,7 @@ module PlatformRest
     # *  {string} removeVersions - If this is set, all Experience Versions and their contents will be removed (except for develop).
     # *  {string} keepViews - If this is set, Experience Views (in the develop version) will not be removed.
     # *  {string} keepEndpoints - If this is set, Experience Endpoints (in the develop version) will not be removed.
-    # *  {string} removeWorkflows - If this is set, all Experience Workflows (in the develop version) will ve removed.
+    # *  {string} removeWorkflows - If this is set, all Experience Workflows (in the develop version) will be removed.
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response

data/lib/platform_rest/file.rb

@@ -142,7 +142,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  201 - Returns a new file or directory that was created by the move, if a directory a job will kick off to move all the directories children. (https://api.losant.com/#/definitions/file)
+    # *  201 - Returns a new file or directory that was created by the move, if a directory a job will kick off to move all the directory's children. (https://api.losant.com/#/definitions/file)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -191,7 +191,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  201 - Successfully updated file and the information needed to upload the file content (https://api.losant.com/#/definitions/fileUploadPostResponse)
+    # *  200 - Successfully updated file and the information needed to upload the file content (https://api.losant.com/#/definitions/fileUploadPostResponse)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/platform_rest/instance_api_tokens.rb

@@ -53,7 +53,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - Collection of API tokens (https://api.losant.com/#/definitions/apiToken)
+    # *  200 - Collection of API tokens (https://api.losant.com/#/definitions/apiTokens)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/platform_rest/instance_member.rb

@@ -141,7 +141,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - The modified instance member (https://api.losant.com/#/definitions/instanceMemberPatch)
+    # *  200 - The modified instance member (https://api.losant.com/#/definitions/instanceMember)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/platform_rest/instance_org.rb

@@ -328,7 +328,7 @@ module PlatformRest
         body: body)
     end
 
-    # Returns payload counts per resolution in the time range specified for all application this organization owns
+    # Returns payload counts per resolution in the time range specified for all applications this organization owns
     #
     # Authentication:
     # The client must be configured with a valid api

data/lib/platform_rest/instance_org_invite.rb

@@ -97,7 +97,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - A single organization invite (https://api.losant.com/#/definitions/orgInvite)
+    # *  200 - A single organization invite (https://api.losant.com/#/definitions/instanceOrgInvite)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -146,7 +146,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  201 - The new org invite (https://api.losant.com/#/definitions/orgInvite)
+    # *  201 - The new org invite (https://api.losant.com/#/definitions/instanceOrgInvite)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/platform_rest/instance_org_invites.rb

@@ -52,7 +52,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - A collection of instance organization invitations (https://api.losant.com/#/definitions/orgInviteCollection)
+    # *  200 - A collection of instance organization invitations (https://api.losant.com/#/definitions/instanceOrgInvites)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -103,7 +103,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  201 - The new organization invite (https://api.losant.com/#/definitions/orgInviteCollection)
+    # *  201 - The new organization invite (https://api.losant.com/#/definitions/instanceOrgInvite)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/platform_rest/instance_org_members.rb

@@ -103,7 +103,8 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - The newly created instance member (https://api.losant.com/#/definitions/instanceOrgMember)
+    # *  201 - The newly added instance org member (https://api.losant.com/#/definitions/instanceOrgMember)
+    # *  202 - An invite was sent to the new member's email address (https://api.losant.com/#/definitions/instanceOrgInviteSent)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/platform_rest/instance_orgs.rb

@@ -109,7 +109,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - The newly created organization (https://api.losant.com/#/definitions/org)
+    # *  201 - The newly created organization (https://api.losant.com/#/definitions/instanceOrg)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/platform_rest/me.rb

@@ -258,7 +258,7 @@ module PlatformRest
         body: body)
     end
 
-    # Disconnects the user from Github
+    # Disconnects the user from GitHub
     #
     # Authentication:
     # The client must be configured with a valid api

data/lib/platform_rest/notebook.rb

@@ -42,7 +42,7 @@ module PlatformRest
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} notebookId - ID associated with the notebook
-    # *  {undefined} executionId - The ID of the execution to cancel
+    # *  {string} executionId - The ID of the execution to cancel
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response

data/lib/platform_rest/org.rb

@@ -418,7 +418,7 @@ module PlatformRest
         body: body)
     end
 
-    # Returns payload counts per resolution in the time range specified for all application this organization owns
+    # Returns payload counts per resolution in the time range specified for all applications this organization owns
     #
     # Authentication:
     # The client must be configured with a valid api

data/lib/platform_rest/private_file.rb

@@ -145,7 +145,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  201 - Returns a new private file or directory that was created by the move, if a directory a job will kick off to move all the directories children. (https://api.losant.com/#/definitions/file)
+    # *  201 - Returns a new private file or directory that was created by the move, if a directory a job will kick off to move all the directory's children. (https://api.losant.com/#/definitions/file)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -195,7 +195,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  201 - Successfully updated private file and the information needed to upload the file content (https://api.losant.com/#/definitions/fileUploadPostResponse)
+    # *  200 - Successfully updated private file and the information needed to upload the file content (https://api.losant.com/#/definitions/fileUploadPostResponse)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/platform_rest/resource_job.rb

@@ -42,7 +42,7 @@ module PlatformRest
     # Parameters:
     # *  {string} applicationId - ID associated with the application
     # *  {string} resourceJobId - ID associated with the resource job
-    # *  {undefined} executionId - The ID of the execution to cancel
+    # *  {string} executionId - The ID of the execution to cancel
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -291,7 +291,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  201 - Successfully updated resource job (https://api.losant.com/#/definitions/resourceJob)
+    # *  200 - Successfully updated resource job (https://api.losant.com/#/definitions/resourceJob)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/platform_rest/user_api_tokens.rb

@@ -52,7 +52,7 @@ module PlatformRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - Collection of API tokens (https://api.losant.com/#/definitions/apiToken)
+    # *  200 - Collection of API tokens (https://api.losant.com/#/definitions/apiTokens)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -84,7 +84,7 @@ module PlatformRest
         body: body)
     end
 
-    # Create a new API token for an user
+    # Create a new API token for a user
     #
     # Authentication:
     # The client must be configured with a valid api

data/lib/platform_rest/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module PlatformRest
-  VERSION = "2.1.0"
+  VERSION = "2.1.1"
 end