diff --git a/R/.openapi-generator/FILES b/R/.openapi-generator/FILES index 4515a72..cd7a138 100644 --- a/R/.openapi-generator/FILES +++ b/R/.openapi-generator/FILES @@ -91,6 +91,7 @@ R/search_api.R R/search_constraints.R R/search_details.R R/search_result.R +R/search_result_hits.R R/search_term.R R/securable_principal.R R/shuttle_api.R @@ -182,6 +183,7 @@ docs/SearchApi.md docs/SearchConstraints.md docs/SearchDetails.md docs/SearchResult.md +docs/SearchResultHits.md docs/SearchTerm.md docs/SecurablePrincipal.md docs/ShuttleApi.md @@ -274,6 +276,7 @@ tests/testthat/test_search_api.R tests/testthat/test_search_constraints.R tests/testthat/test_search_details.R tests/testthat/test_search_result.R +tests/testthat/test_search_result_hits.R tests/testthat/test_search_term.R tests/testthat/test_securable_principal.R tests/testthat/test_shuttle_api.R diff --git a/R/NAMESPACE b/R/NAMESPACE index 35c917e..91f78c7 100644 --- a/R/NAMESPACE +++ b/R/NAMESPACE @@ -12,11 +12,13 @@ export(Acl) export(AclData) export(AdvancedSearch) export(Association) +export(AssociationDefinition) export(AssociationType) export(Auth0userBasic) export(Authorization) export(AuthorizedObjectsSearchResult) export(BulkDataCreation) +export(CollectionTemplateType) export(Constraint) export(ConstraintGroup) export(DataAssociation) @@ -31,21 +33,30 @@ export(EDMdiff) export(EdmRequest) export(Entity) export(EntityDataKey) +export(EntityDefinition) export(EntityKey) export(EntityKeyPair) export(EntityLinkingFeatures) export(EntityLinkingFeedback) export(EntityNeighborsFilter) export(EntitySet) +export(EntitySetCollection) export(EntitySetPropertyMetaData) export(EntitySetSelection) export(EntityType) +export(EntityTypeCollection) export(EntityTypePropertyMetadata) +export(Flight) +export(FlightPlanParameters) +export(FlightPlanParametersUpdate) export(FullQualifiedName) export(IndexingState) export(InlineObject) export(InlineResponse200) +export(Integration) +export(IntegrationJob) export(IntegrationResults) +export(IntegrationUpdate) export(LinkingFeedback) export(MaterializedViewAccount) export(MetadataUpdate) @@ -58,6 +69,7 @@ export(OrganizationExternalDatabaseTable) export(OrganizationExternalDatabaseTableColumnsPair) export(OrganizationMember) export(Principal) +export(PropertyDefinition) export(PropertyType) export(PropertyUsageSummary) export(Role) @@ -75,6 +87,7 @@ export(SortDefinition) # APIs export(AdminApi) export(AuthorizationsApi) +export(CollectionsApi) export(DataApi) export(DataIntegrationsApi) export(DatasetApi) @@ -85,3 +98,4 @@ export(OrganizationsApi) export(PermissionsApi) export(PrincipalApi) export(SearchApi) +export(ShuttleApi) diff --git a/R/R/access_check.R b/R/R/access_check.R index c441e45..8c59072 100644 --- a/R/R/access_check.R +++ b/R/R/access_check.R @@ -8,15 +8,13 @@ #' @docType class #' @title AccessCheck -#' #' @description AccessCheck Class -#' #' @format An \code{R6Class} generator object -#' #' @field aclKey list( character ) [optional] #' #' @field permissions list( character ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ AccessCheck <- R6::R6Class( public = list( `aclKey` = NULL, `permissions` = NULL, - initialize = function( - `aclKey`=NULL, `permissions`=NULL, ... - ) { + initialize = function(`aclKey`=NULL, `permissions`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`aclKey`)) { stopifnot(is.vector(`aclKey`)) @@ -61,7 +57,6 @@ AccessCheck <- R6::R6Class( if (!is.null(AccessCheckObject$`permissions`)) { self$`permissions` <- ApiClient$new()$deserializeObj(AccessCheckObject$`permissions`, "array[character]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -91,4 +86,3 @@ AccessCheck <- R6::R6Class( } ) ) - diff --git a/R/R/ace.R b/R/R/ace.R index 182be1e..e96575b 100644 --- a/R/R/ace.R +++ b/R/R/ace.R @@ -8,15 +8,13 @@ #' @docType class #' @title Ace -#' #' @description Ace Class -#' #' @format An \code{R6Class} generator object -#' #' @field principal \link{Principal} [optional] #' #' @field permissions list( character ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ Ace <- R6::R6Class( public = list( `principal` = NULL, `permissions` = NULL, - initialize = function( - `principal`=NULL, `permissions`=NULL, ... - ) { + initialize = function(`principal`=NULL, `permissions`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`principal`)) { stopifnot(R6::is.R6(`principal`)) @@ -62,7 +58,6 @@ Ace <- R6::R6Class( if (!is.null(AceObject$`permissions`)) { self$`permissions` <- ApiClient$new()$deserializeObj(AceObject$`permissions`, "array[character]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -92,4 +87,3 @@ Ace <- R6::R6Class( } ) ) - diff --git a/R/R/acl.R b/R/R/acl.R index eb1e872..d489c6d 100644 --- a/R/R/acl.R +++ b/R/R/acl.R @@ -8,15 +8,13 @@ #' @docType class #' @title Acl -#' #' @description Acl Class -#' #' @format An \code{R6Class} generator object -#' #' @field aclKey list( character ) [optional] #' #' @field aces list( \link{Ace} ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ Acl <- R6::R6Class( public = list( `aclKey` = NULL, `aces` = NULL, - initialize = function( - `aclKey`=NULL, `aces`=NULL, ... - ) { + initialize = function(`aclKey`=NULL, `aces`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`aclKey`)) { stopifnot(is.vector(`aclKey`)) @@ -61,7 +57,6 @@ Acl <- R6::R6Class( if (!is.null(AclObject$`aces`)) { self$`aces` <- ApiClient$new()$deserializeObj(AclObject$`aces`, "array[Ace]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -91,4 +86,3 @@ Acl <- R6::R6Class( } ) ) - diff --git a/R/R/acl_data.R b/R/R/acl_data.R index e49e947..9c91aaa 100644 --- a/R/R/acl_data.R +++ b/R/R/acl_data.R @@ -8,15 +8,13 @@ #' @docType class #' @title AclData -#' #' @description AclData Class -#' #' @format An \code{R6Class} generator object -#' #' @field action character [optional] #' #' @field acl \link{Acl} [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ AclData <- R6::R6Class( public = list( `action` = NULL, `acl` = NULL, - initialize = function( - `action`=NULL, `acl`=NULL, ... - ) { + initialize = function(`action`=NULL, `acl`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`action`)) { stopifnot(is.character(`action`), length(`action`) == 1) @@ -61,7 +57,6 @@ AclData <- R6::R6Class( aclObject$fromJSON(jsonlite::toJSON(AclDataObject$acl, auto_unbox = TRUE, digits = NA)) self$`acl` <- aclObject } - self }, toJSONString = function() { jsoncontent <- c( @@ -91,4 +86,3 @@ AclData <- R6::R6Class( } ) ) - diff --git a/R/R/admin_api.R b/R/R/admin_api.R index 0afdbb0..5bfb1a4 100644 --- a/R/R/admin_api.R +++ b/R/R/admin_api.R @@ -125,7 +125,7 @@ #' #################### reindex #################### #' #' library(openlattice) -#' var.request_body <- NULL # list(array[character]) | A map of entity set ids to entity key ids that determines what will be reindexed. If no entity key ids are provided then all entities in an entity set are reindexed. If no entity set ids are provided then all entity sets are scheduled for reindexing. +#' var.request_body <- {'key' => array$new()} # list(array[character]) | A map of entity set ids to entity key ids that determines what will be reindexed. If no entity key ids are provided then all entities in an entity set are reindexed. If no entity set ids are provided then all entity sets are scheduled for reindexing. #' #' #Merge job descriptions for performing a partial or full reindex of provided entity sets. #' api.instance <- AdminApi$new() @@ -145,7 +145,7 @@ #' #################### update_reindex #################### #' #' library(openlattice) -#' var.request_body <- NULL # list(array[character]) | A map of entity set ids to entity key ids that determines what will be reindexed. If no entity key ids are provided then all entities in an entity set are reindexed. If no entity set ids are provided then all entity sets are scheduled for reindexing. +#' var.request_body <- {'key' => array$new()} # list(array[character]) | A map of entity set ids to entity key ids that determines what will be reindexed. If no entity key ids are provided then all entities in an entity set are reindexed. If no entity set ids are provided then all entity sets are scheduled for reindexing. #' #' #Replaces job descriptions for performing a partial or full reindex of provided entity sets. #' api.instance <- AdminApi$new() diff --git a/R/R/advanced_search.R b/R/R/advanced_search.R index c7123da..14e639f 100644 --- a/R/R/advanced_search.R +++ b/R/R/advanced_search.R @@ -8,17 +8,15 @@ #' @docType class #' @title AdvancedSearch -#' #' @description AdvancedSearch Class -#' #' @format An \code{R6Class} generator object -#' #' @field searchFields list( \link{SearchDetails} ) [optional] #' #' @field start integer [optional] #' #' @field maxHits integer [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -28,9 +26,7 @@ AdvancedSearch <- R6::R6Class( `searchFields` = NULL, `start` = NULL, `maxHits` = NULL, - initialize = function( - `searchFields`=NULL, `start`=NULL, `maxHits`=NULL, ... - ) { + initialize = function(`searchFields`=NULL, `start`=NULL, `maxHits`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`searchFields`)) { stopifnot(is.vector(`searchFields`)) @@ -74,7 +70,6 @@ AdvancedSearch <- R6::R6Class( if (!is.null(AdvancedSearchObject$`maxHits`)) { self$`maxHits` <- AdvancedSearchObject$`maxHits` } - self }, toJSONString = function() { jsoncontent <- c( @@ -112,4 +107,3 @@ AdvancedSearch <- R6::R6Class( } ) ) - diff --git a/R/R/api_client.R b/R/R/api_client.R index 6b7987f..0ea581a 100644 --- a/R/R/api_client.R +++ b/R/R/api_client.R @@ -164,9 +164,7 @@ ApiClient <- R6::R6Class( else if (exists(returnType, pkgEnv) && !(c(returnType) %in% primitiveTypes)) { returnType <- get(returnType, envir = as.environment(pkgEnv)) returnObj <- returnType$new() - returnObj$fromJSON( - jsonlite::toJSON(obj, digits = NA, auto_unbox = TRUE) - ) + returnObj$fromJSON(jsonlite::toJSON(obj, digits = NA)) } # To handle primitive type diff --git a/R/R/association.R b/R/R/association.R index f1155d4..525eef5 100644 --- a/R/R/association.R +++ b/R/R/association.R @@ -8,11 +8,8 @@ #' @docType class #' @title Association -#' #' @description Association Class -#' #' @format An \code{R6Class} generator object -#' #' @field key \link{EntityKey} [optional] #' #' @field src \link{EntityKey} [optional] @@ -21,6 +18,7 @@ #' #' @field details named list( character ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -31,9 +29,7 @@ Association <- R6::R6Class( `src` = NULL, `dst` = NULL, `details` = NULL, - initialize = function( - `key`=NULL, `src`=NULL, `dst`=NULL, `details`=NULL, ... - ) { + initialize = function(`key`=NULL, `src`=NULL, `dst`=NULL, `details`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`key`)) { stopifnot(R6::is.R6(`key`)) @@ -94,7 +90,6 @@ Association <- R6::R6Class( if (!is.null(AssociationObject$`details`)) { self$`details` <- ApiClient$new()$deserializeObj(AssociationObject$`details`, "list(character)", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -140,4 +135,3 @@ Association <- R6::R6Class( } ) ) - diff --git a/R/R/association_definition.R b/R/R/association_definition.R new file mode 100644 index 0000000..ad815b1 --- /dev/null +++ b/R/R/association_definition.R @@ -0,0 +1,177 @@ +# OpenLattice API +# +# OpenLattice API +# +# The version of the OpenAPI document: 0.0.1 +# Contact: support@openlattice.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title AssociationDefinition +#' @description AssociationDefinition Class +#' @format An \code{R6Class} generator object +#' @field fqn \link{FullQualifiedName} [optional] +#' +#' @field entitySetName character [optional] +#' +#' @field propertyDefinitions named list( \link{PropertyDefinition} ) [optional] +#' +#' @field updateType character [optional] +#' +#' @field src character [optional] +#' +#' @field dst character [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +AssociationDefinition <- R6::R6Class( + 'AssociationDefinition', + public = list( + `fqn` = NULL, + `entitySetName` = NULL, + `propertyDefinitions` = NULL, + `updateType` = NULL, + `src` = NULL, + `dst` = NULL, + initialize = function(`fqn`=NULL, `entitySetName`=NULL, `propertyDefinitions`=NULL, `updateType`=NULL, `src`=NULL, `dst`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`fqn`)) { + stopifnot(R6::is.R6(`fqn`)) + self$`fqn` <- `fqn` + } + if (!is.null(`entitySetName`)) { + stopifnot(is.character(`entitySetName`), length(`entitySetName`) == 1) + self$`entitySetName` <- `entitySetName` + } + if (!is.null(`propertyDefinitions`)) { + stopifnot(is.vector(`propertyDefinitions`)) + sapply(`propertyDefinitions`, function(x) stopifnot(R6::is.R6(x))) + self$`propertyDefinitions` <- `propertyDefinitions` + } + if (!is.null(`updateType`)) { + stopifnot(is.character(`updateType`), length(`updateType`) == 1) + self$`updateType` <- `updateType` + } + if (!is.null(`src`)) { + stopifnot(is.character(`src`), length(`src`) == 1) + self$`src` <- `src` + } + if (!is.null(`dst`)) { + stopifnot(is.character(`dst`), length(`dst`) == 1) + self$`dst` <- `dst` + } + }, + toJSON = function() { + AssociationDefinitionObject <- list() + if (!is.null(self$`fqn`)) { + AssociationDefinitionObject[['fqn']] <- + self$`fqn`$toJSON() + } + if (!is.null(self$`entitySetName`)) { + AssociationDefinitionObject[['entitySetName']] <- + self$`entitySetName` + } + if (!is.null(self$`propertyDefinitions`)) { + AssociationDefinitionObject[['propertyDefinitions']] <- + lapply(self$`propertyDefinitions`, function(x) x$toJSON()) + } + if (!is.null(self$`updateType`)) { + AssociationDefinitionObject[['updateType']] <- + self$`updateType` + } + if (!is.null(self$`src`)) { + AssociationDefinitionObject[['src']] <- + self$`src` + } + if (!is.null(self$`dst`)) { + AssociationDefinitionObject[['dst']] <- + self$`dst` + } + + AssociationDefinitionObject + }, + fromJSON = function(AssociationDefinitionJson) { + AssociationDefinitionObject <- jsonlite::fromJSON(AssociationDefinitionJson) + if (!is.null(AssociationDefinitionObject$`fqn`)) { + fqnObject <- FullQualifiedName$new() + fqnObject$fromJSON(jsonlite::toJSON(AssociationDefinitionObject$fqn, auto_unbox = TRUE, digits = NA)) + self$`fqn` <- fqnObject + } + if (!is.null(AssociationDefinitionObject$`entitySetName`)) { + self$`entitySetName` <- AssociationDefinitionObject$`entitySetName` + } + if (!is.null(AssociationDefinitionObject$`propertyDefinitions`)) { + self$`propertyDefinitions` <- ApiClient$new()$deserializeObj(AssociationDefinitionObject$`propertyDefinitions`, "list(PropertyDefinition)", loadNamespace("openlattice")) + } + if (!is.null(AssociationDefinitionObject$`updateType`)) { + self$`updateType` <- AssociationDefinitionObject$`updateType` + } + if (!is.null(AssociationDefinitionObject$`src`)) { + self$`src` <- AssociationDefinitionObject$`src` + } + if (!is.null(AssociationDefinitionObject$`dst`)) { + self$`dst` <- AssociationDefinitionObject$`dst` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`fqn`)) { + sprintf( + '"fqn": + %s + ', + jsonlite::toJSON(self$`fqn`$toJSON(), auto_unbox=TRUE, digits = NA) + )}, + if (!is.null(self$`entitySetName`)) { + sprintf( + '"entitySetName": + "%s" + ', + self$`entitySetName` + )}, + if (!is.null(self$`propertyDefinitions`)) { + sprintf( + '"propertyDefinitions": + %s +', + jsonlite::toJSON(lapply(self$`propertyDefinitions`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) + )}, + if (!is.null(self$`updateType`)) { + sprintf( + '"updateType": + "%s" + ', + self$`updateType` + )}, + if (!is.null(self$`src`)) { + sprintf( + '"src": + "%s" + ', + self$`src` + )}, + if (!is.null(self$`dst`)) { + sprintf( + '"dst": + "%s" + ', + self$`dst` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(AssociationDefinitionJson) { + AssociationDefinitionObject <- jsonlite::fromJSON(AssociationDefinitionJson) + self$`fqn` <- FullQualifiedName$new()$fromJSON(jsonlite::toJSON(AssociationDefinitionObject$fqn, auto_unbox = TRUE, digits = NA)) + self$`entitySetName` <- AssociationDefinitionObject$`entitySetName` + self$`propertyDefinitions` <- ApiClient$new()$deserializeObj(AssociationDefinitionObject$`propertyDefinitions`, "list(PropertyDefinition)", loadNamespace("openlattice")) + self$`updateType` <- AssociationDefinitionObject$`updateType` + self$`src` <- AssociationDefinitionObject$`src` + self$`dst` <- AssociationDefinitionObject$`dst` + self + } + ) +) diff --git a/R/R/association_type.R b/R/R/association_type.R index 42e8da0..e4005e0 100644 --- a/R/R/association_type.R +++ b/R/R/association_type.R @@ -8,11 +8,8 @@ #' @docType class #' @title AssociationType -#' #' @description AssociationType Class -#' #' @format An \code{R6Class} generator object -#' #' @field entityType \link{EntityType} [optional] #' #' @field src list( character ) [optional] @@ -21,6 +18,7 @@ #' #' @field bidirectional character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -31,9 +29,7 @@ AssociationType <- R6::R6Class( `src` = NULL, `dst` = NULL, `bidirectional` = NULL, - initialize = function( - `entityType`=NULL, `src`=NULL, `dst`=NULL, `bidirectional`=NULL, ... - ) { + initialize = function(`entityType`=NULL, `src`=NULL, `dst`=NULL, `bidirectional`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`entityType`)) { stopifnot(R6::is.R6(`entityType`)) @@ -90,7 +86,6 @@ AssociationType <- R6::R6Class( if (!is.null(AssociationTypeObject$`bidirectional`)) { self$`bidirectional` <- AssociationTypeObject$`bidirectional` } - self }, toJSONString = function() { jsoncontent <- c( @@ -136,4 +131,3 @@ AssociationType <- R6::R6Class( } ) ) - diff --git a/R/R/auth0user_basic.R b/R/R/auth0user_basic.R index 050b161..b63f1be 100644 --- a/R/R/auth0user_basic.R +++ b/R/R/auth0user_basic.R @@ -8,11 +8,8 @@ #' @docType class #' @title Auth0userBasic -#' #' @description Auth0userBasic Class -#' #' @format An \code{R6Class} generator object -#' #' @field user_id character [optional] #' #' @field email character [optional] @@ -25,6 +22,7 @@ #' #' @field com/openlattice/organization list( character ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -37,9 +35,7 @@ Auth0userBasic <- R6::R6Class( `username` = NULL, `roles` = NULL, `com/openlattice/organization` = NULL, - initialize = function( - `user_id`=NULL, `email`=NULL, `nickname`=NULL, `username`=NULL, `roles`=NULL, `com/openlattice/organization`=NULL, ... - ) { + initialize = function(`user_id`=NULL, `email`=NULL, `nickname`=NULL, `username`=NULL, `roles`=NULL, `com/openlattice/organization`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`user_id`)) { stopifnot(is.character(`user_id`), length(`user_id`) == 1) @@ -117,7 +113,6 @@ Auth0userBasic <- R6::R6Class( if (!is.null(Auth0userBasicObject$`com/openlattice/organization`)) { self$`com/openlattice/organization` <- ApiClient$new()$deserializeObj(Auth0userBasicObject$`com/openlattice/organization`, "array[character]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -179,4 +174,3 @@ Auth0userBasic <- R6::R6Class( } ) ) - diff --git a/R/R/authorization.R b/R/R/authorization.R index fbcaaac..317778b 100644 --- a/R/R/authorization.R +++ b/R/R/authorization.R @@ -8,15 +8,13 @@ #' @docType class #' @title Authorization -#' #' @description Authorization Class -#' #' @format An \code{R6Class} generator object -#' #' @field aclKey list( character ) [optional] #' #' @field permissions named list( character ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ Authorization <- R6::R6Class( public = list( `aclKey` = NULL, `permissions` = NULL, - initialize = function( - `aclKey`=NULL, `permissions`=NULL, ... - ) { + initialize = function(`aclKey`=NULL, `permissions`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`aclKey`)) { stopifnot(is.vector(`aclKey`)) @@ -61,7 +57,6 @@ Authorization <- R6::R6Class( if (!is.null(AuthorizationObject$`permissions`)) { self$`permissions` <- ApiClient$new()$deserializeObj(AuthorizationObject$`permissions`, "list(character)", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -91,4 +86,3 @@ Authorization <- R6::R6Class( } ) ) - diff --git a/R/R/authorized_objects_search_result.R b/R/R/authorized_objects_search_result.R index a06e0ce..b1b6d1f 100644 --- a/R/R/authorized_objects_search_result.R +++ b/R/R/authorized_objects_search_result.R @@ -8,14 +8,12 @@ #' @docType class #' @title AuthorizedObjectsSearchResult -#' #' @description AuthorizedObjectsSearchResult Class -#' #' @format An \code{R6Class} generator object -#' #' @field pagingToken character [optional] #' -#' @field authorizedObjects list( array[character] ) [optional] +#' @field authorizedObjects list( \link{array[character]} ) [optional] +#' #' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON @@ -25,9 +23,7 @@ AuthorizedObjectsSearchResult <- R6::R6Class( public = list( `pagingToken` = NULL, `authorizedObjects` = NULL, - initialize = function( - `pagingToken`=NULL, `authorizedObjects`=NULL, ... - ) { + initialize = function(`pagingToken`=NULL, `authorizedObjects`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`pagingToken`)) { stopifnot(is.character(`pagingToken`), length(`pagingToken`) == 1) @@ -35,7 +31,7 @@ AuthorizedObjectsSearchResult <- R6::R6Class( } if (!is.null(`authorizedObjects`)) { stopifnot(is.vector(`authorizedObjects`)) - sapply(`authorizedObjects`, function(x) stopifnot(is.character(x))) + sapply(`authorizedObjects`, function(x) stopifnot(R6::is.R6(x))) self$`authorizedObjects` <- `authorizedObjects` } }, @@ -47,7 +43,7 @@ AuthorizedObjectsSearchResult <- R6::R6Class( } if (!is.null(self$`authorizedObjects`)) { AuthorizedObjectsSearchResultObject[['authorizedObjects']] <- - self$`authorizedObjects` + lapply(self$`authorizedObjects`, function(x) x$toJSON()) } AuthorizedObjectsSearchResultObject @@ -60,7 +56,6 @@ AuthorizedObjectsSearchResult <- R6::R6Class( if (!is.null(AuthorizedObjectsSearchResultObject$`authorizedObjects`)) { self$`authorizedObjects` <- ApiClient$new()$deserializeObj(AuthorizedObjectsSearchResultObject$`authorizedObjects`, "array[array[character]]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -74,9 +69,9 @@ AuthorizedObjectsSearchResult <- R6::R6Class( if (!is.null(self$`authorizedObjects`)) { sprintf( '"authorizedObjects": - [%s] - ', - paste(unlist(lapply(self$`authorizedObjects`, function(x) paste0('"', x, '"'))), collapse=",") + [%s] +', + paste(sapply(self$`authorizedObjects`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") )} ) jsoncontent <- paste(jsoncontent, collapse = ",") @@ -90,4 +85,3 @@ AuthorizedObjectsSearchResult <- R6::R6Class( } ) ) - diff --git a/R/R/bulk_data_creation.R b/R/R/bulk_data_creation.R index 281fb18..56666cd 100644 --- a/R/R/bulk_data_creation.R +++ b/R/R/bulk_data_creation.R @@ -8,15 +8,13 @@ #' @docType class #' @title BulkDataCreation -#' #' @description BulkDataCreation Class -#' #' @format An \code{R6Class} generator object -#' #' @field entities list( \link{Entity} ) [optional] #' #' @field associations list( \link{Association} ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ BulkDataCreation <- R6::R6Class( public = list( `entities` = NULL, `associations` = NULL, - initialize = function( - `entities`=NULL, `associations`=NULL, ... - ) { + initialize = function(`entities`=NULL, `associations`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`entities`)) { stopifnot(is.vector(`entities`)) @@ -61,7 +57,6 @@ BulkDataCreation <- R6::R6Class( if (!is.null(BulkDataCreationObject$`associations`)) { self$`associations` <- ApiClient$new()$deserializeObj(BulkDataCreationObject$`associations`, "array[Association]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -91,4 +86,3 @@ BulkDataCreation <- R6::R6Class( } ) ) - diff --git a/R/R/collection_template_type.R b/R/R/collection_template_type.R new file mode 100644 index 0000000..4e7159a --- /dev/null +++ b/R/R/collection_template_type.R @@ -0,0 +1,152 @@ +# OpenLattice API +# +# OpenLattice API +# +# The version of the OpenAPI document: 0.0.1 +# Contact: support@openlattice.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title CollectionTemplateType +#' @description CollectionTemplateType Class +#' @format An \code{R6Class} generator object +#' @field id character [optional] +#' +#' @field name character [optional] +#' +#' @field title character [optional] +#' +#' @field description character [optional] +#' +#' @field entityTypeId character [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +CollectionTemplateType <- R6::R6Class( + 'CollectionTemplateType', + public = list( + `id` = NULL, + `name` = NULL, + `title` = NULL, + `description` = NULL, + `entityTypeId` = NULL, + initialize = function(`id`=NULL, `name`=NULL, `title`=NULL, `description`=NULL, `entityTypeId`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`id`)) { + stopifnot(is.character(`id`), length(`id`) == 1) + self$`id` <- `id` + } + if (!is.null(`name`)) { + stopifnot(is.character(`name`), length(`name`) == 1) + self$`name` <- `name` + } + if (!is.null(`title`)) { + stopifnot(is.character(`title`), length(`title`) == 1) + self$`title` <- `title` + } + if (!is.null(`description`)) { + stopifnot(is.character(`description`), length(`description`) == 1) + self$`description` <- `description` + } + if (!is.null(`entityTypeId`)) { + stopifnot(is.character(`entityTypeId`), length(`entityTypeId`) == 1) + self$`entityTypeId` <- `entityTypeId` + } + }, + toJSON = function() { + CollectionTemplateTypeObject <- list() + if (!is.null(self$`id`)) { + CollectionTemplateTypeObject[['id']] <- + self$`id` + } + if (!is.null(self$`name`)) { + CollectionTemplateTypeObject[['name']] <- + self$`name` + } + if (!is.null(self$`title`)) { + CollectionTemplateTypeObject[['title']] <- + self$`title` + } + if (!is.null(self$`description`)) { + CollectionTemplateTypeObject[['description']] <- + self$`description` + } + if (!is.null(self$`entityTypeId`)) { + CollectionTemplateTypeObject[['entityTypeId']] <- + self$`entityTypeId` + } + + CollectionTemplateTypeObject + }, + fromJSON = function(CollectionTemplateTypeJson) { + CollectionTemplateTypeObject <- jsonlite::fromJSON(CollectionTemplateTypeJson) + if (!is.null(CollectionTemplateTypeObject$`id`)) { + self$`id` <- CollectionTemplateTypeObject$`id` + } + if (!is.null(CollectionTemplateTypeObject$`name`)) { + self$`name` <- CollectionTemplateTypeObject$`name` + } + if (!is.null(CollectionTemplateTypeObject$`title`)) { + self$`title` <- CollectionTemplateTypeObject$`title` + } + if (!is.null(CollectionTemplateTypeObject$`description`)) { + self$`description` <- CollectionTemplateTypeObject$`description` + } + if (!is.null(CollectionTemplateTypeObject$`entityTypeId`)) { + self$`entityTypeId` <- CollectionTemplateTypeObject$`entityTypeId` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`id`)) { + sprintf( + '"id": + "%s" + ', + self$`id` + )}, + if (!is.null(self$`name`)) { + sprintf( + '"name": + "%s" + ', + self$`name` + )}, + if (!is.null(self$`title`)) { + sprintf( + '"title": + "%s" + ', + self$`title` + )}, + if (!is.null(self$`description`)) { + sprintf( + '"description": + "%s" + ', + self$`description` + )}, + if (!is.null(self$`entityTypeId`)) { + sprintf( + '"entityTypeId": + "%s" + ', + self$`entityTypeId` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(CollectionTemplateTypeJson) { + CollectionTemplateTypeObject <- jsonlite::fromJSON(CollectionTemplateTypeJson) + self$`id` <- CollectionTemplateTypeObject$`id` + self$`name` <- CollectionTemplateTypeObject$`name` + self$`title` <- CollectionTemplateTypeObject$`title` + self$`description` <- CollectionTemplateTypeObject$`description` + self$`entityTypeId` <- CollectionTemplateTypeObject$`entityTypeId` + self + } + ) +) diff --git a/R/R/collections_api.R b/R/R/collections_api.R new file mode 100644 index 0000000..21a49f6 --- /dev/null +++ b/R/R/collections_api.R @@ -0,0 +1,1362 @@ +# OpenLattice API +# +# OpenLattice API +# +# The version of the OpenAPI document: 0.0.1 +# Contact: support@openlattice.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title Collections operations +#' @description openlattice.Collections +#' @format An \code{R6Class} generator object +#' @field apiClient Handles the client-server communication. +#' +#' @section Methods: +#' \describe{ +#' \strong{ add_type_to_entity_type_collection_template } \emph{ Appends type to template of the specified EntityTypeCollection } +#' +#' +#' \itemize{ +#' \item \emph{ @param } entity_type_collection_id \link{character} +#' \item \emph{ @param } collection_template_type \link{CollectionTemplateType} +#' +#' +#' \item status code : 200 | Success +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ create_entity_set_collection } \emph{ Creates a new EntitySetCollection } +#' +#' +#' \itemize{ +#' \item \emph{ @param } entity_set_collection \link{EntitySetCollection} +#' +#' +#' \item status code : 200 | Success +#' +#' \item return type : character +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ create_entity_type_collection } \emph{ Creates a new EntityTypeCollection } +#' +#' +#' \itemize{ +#' \item \emph{ @param } entity_type_collection \link{EntityTypeCollection} +#' +#' +#' \item status code : 200 | Success +#' +#' \item return type : character +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ delete_entity_set_collection } \emph{ Deletes the specified EntitySetCollection } +#' +#' +#' \itemize{ +#' \item \emph{ @param } entity_set_collection_id \link{character} +#' +#' +#' \item status code : 200 | Success +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ delete_entity_type_collection } \emph{ Deletes the specified EntityTypeCollection } +#' +#' +#' \itemize{ +#' \item \emph{ @param } entity_type_collection_id \link{character} +#' +#' +#' \item status code : 200 | Success +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ get_all_entity_set_collections } \emph{ Returns all EntitySetCollection objects } +#' +#' +#' \itemize{ +#' \item \emph{ @returnType } list( \link{EntitySetCollection} ) \cr +#' +#' +#' \item status code : 200 | Success +#' +#' \item return type : array[EntitySetCollection] +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ get_all_entity_type_collections } \emph{ Returns all EntityTypeCollection objects } +#' +#' +#' \itemize{ +#' \item \emph{ @returnType } list( \link{EntityTypeCollection} ) \cr +#' +#' +#' \item status code : 200 | Success +#' +#' \item return type : array[EntityTypeCollection] +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ get_entity_set_collection } \emph{ Returns the EntitySetCollection object for a given id } +#' +#' +#' \itemize{ +#' \item \emph{ @param } entity_set_collection_id \link{character} +#' \item \emph{ @returnType } \link{EntitySetCollection} \cr +#' +#' +#' \item status code : 200 | Success +#' +#' \item return type : EntitySetCollection +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ get_entity_set_collections_of_type } \emph{ Returns all authorized EntitySetCollections for a given EntityTypeCollection id } +#' +#' +#' \itemize{ +#' \item \emph{ @param } entity_set_collection_id \link{character} +#' \item \emph{ @returnType } list( \link{EntitySetCollection} ) \cr +#' +#' +#' \item status code : 200 | Success +#' +#' \item return type : array[EntitySetCollection] +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ get_entity_type_collection } \emph{ Returns the EntityTypeCollection object for a given id } +#' +#' +#' \itemize{ +#' \item \emph{ @param } entity_type_collection_id \link{character} +#' \item \emph{ @returnType } \link{EntityTypeCollection} \cr +#' +#' +#' \item status code : 200 | Success +#' +#' \item return type : EntityTypeCollection +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ remove_type_from_entity_type_collection_template } \emph{ Removes a key from an EntityTypeCollection template } +#' +#' +#' \itemize{ +#' \item \emph{ @param } entity_type_collection_id \link{character} +#' \item \emph{ @param } type_id \link{character} +#' +#' +#' \item status code : 200 | Success +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ update_entity_set_collection_metadata } \emph{ Updates metadata of the specified EntitySetCollection } +#' +#' +#' \itemize{ +#' \item \emph{ @param } entity_set_collection_id \link{character} +#' \item \emph{ @param } metadata_update \link{MetadataUpdate} +#' +#' +#' \item status code : 200 | Success +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ update_entity_set_collection_template } \emph{ Updates template of the specified EntitySetCollection } +#' +#' +#' \itemize{ +#' \item \emph{ @param } entity_set_collection_id \link{character} +#' \item \emph{ @param } request_body named list( \link{list(character)} ) +#' +#' +#' \item status code : 200 | Success +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ update_entity_type_collection_metadata } \emph{ Updates metadata of the specified EntityTypeCollection } +#' +#' +#' \itemize{ +#' \item \emph{ @param } entity_type_collection_id \link{character} +#' \item \emph{ @param } metadata_update \link{MetadataUpdate} +#' +#' +#' \item status code : 200 | Success +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' } +#' +#' +#' @examples +#' \dontrun{ +#' #################### add_type_to_entity_type_collection_template #################### +#' +#' library(openlattice) +#' var.entity_type_collection_id <- 'entity_type_collection_id_example' # character | +#' var.collection_template_type <- CollectionTemplateType$new() # CollectionTemplateType | +#' +#' #Appends type to template of the specified EntityTypeCollection +#' api.instance <- CollectionsApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$add_type_to_entity_type_collection_template(var.entity_type_collection_id, var.collection_template_type) +#' +#' +#' #################### create_entity_set_collection #################### +#' +#' library(openlattice) +#' var.entity_set_collection <- EntitySetCollection$new() # EntitySetCollection | +#' +#' #Creates a new EntitySetCollection +#' api.instance <- CollectionsApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$create_entity_set_collection(var.entity_set_collection) +#' +#' +#' #################### create_entity_type_collection #################### +#' +#' library(openlattice) +#' var.entity_type_collection <- EntityTypeCollection$new() # EntityTypeCollection | +#' +#' #Creates a new EntityTypeCollection +#' api.instance <- CollectionsApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$create_entity_type_collection(var.entity_type_collection) +#' +#' +#' #################### delete_entity_set_collection #################### +#' +#' library(openlattice) +#' var.entity_set_collection_id <- 'entity_set_collection_id_example' # character | +#' +#' #Deletes the specified EntitySetCollection +#' api.instance <- CollectionsApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$delete_entity_set_collection(var.entity_set_collection_id) +#' +#' +#' #################### delete_entity_type_collection #################### +#' +#' library(openlattice) +#' var.entity_type_collection_id <- 'entity_type_collection_id_example' # character | +#' +#' #Deletes the specified EntityTypeCollection +#' api.instance <- CollectionsApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$delete_entity_type_collection(var.entity_type_collection_id) +#' +#' +#' #################### get_all_entity_set_collections #################### +#' +#' library(openlattice) +#' +#' #Returns all EntitySetCollection objects +#' api.instance <- CollectionsApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$get_all_entity_set_collections() +#' +#' +#' #################### get_all_entity_type_collections #################### +#' +#' library(openlattice) +#' +#' #Returns all EntityTypeCollection objects +#' api.instance <- CollectionsApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$get_all_entity_type_collections() +#' +#' +#' #################### get_entity_set_collection #################### +#' +#' library(openlattice) +#' var.entity_set_collection_id <- 'entity_set_collection_id_example' # character | +#' +#' #Returns the EntitySetCollection object for a given id +#' api.instance <- CollectionsApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$get_entity_set_collection(var.entity_set_collection_id) +#' +#' +#' #################### get_entity_set_collections_of_type #################### +#' +#' library(openlattice) +#' var.entity_set_collection_id <- 'entity_set_collection_id_example' # character | +#' +#' #Returns all authorized EntitySetCollections for a given EntityTypeCollection id +#' api.instance <- CollectionsApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$get_entity_set_collections_of_type(var.entity_set_collection_id) +#' +#' +#' #################### get_entity_type_collection #################### +#' +#' library(openlattice) +#' var.entity_type_collection_id <- 'entity_type_collection_id_example' # character | +#' +#' #Returns the EntityTypeCollection object for a given id +#' api.instance <- CollectionsApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$get_entity_type_collection(var.entity_type_collection_id) +#' +#' +#' #################### remove_type_from_entity_type_collection_template #################### +#' +#' library(openlattice) +#' var.entity_type_collection_id <- 'entity_type_collection_id_example' # character | +#' var.type_id <- 'type_id_example' # character | +#' +#' #Removes a key from an EntityTypeCollection template +#' api.instance <- CollectionsApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$remove_type_from_entity_type_collection_template(var.entity_type_collection_id, var.type_id) +#' +#' +#' #################### update_entity_set_collection_metadata #################### +#' +#' library(openlattice) +#' var.entity_set_collection_id <- 'entity_set_collection_id_example' # character | +#' var.metadata_update <- MetadataUpdate$new() # MetadataUpdate | +#' +#' #Updates metadata of the specified EntitySetCollection +#' api.instance <- CollectionsApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$update_entity_set_collection_metadata(var.entity_set_collection_id, var.metadata_update) +#' +#' +#' #################### update_entity_set_collection_template #################### +#' +#' library(openlattice) +#' var.entity_set_collection_id <- 'entity_set_collection_id_example' # character | +#' var.request_body <- {'key' => 'request_body_example'} # list(character) | +#' +#' #Updates template of the specified EntitySetCollection +#' api.instance <- CollectionsApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$update_entity_set_collection_template(var.entity_set_collection_id, var.request_body) +#' +#' +#' #################### update_entity_type_collection_metadata #################### +#' +#' library(openlattice) +#' var.entity_type_collection_id <- 'entity_type_collection_id_example' # character | +#' var.metadata_update <- MetadataUpdate$new() # MetadataUpdate | +#' +#' #Updates metadata of the specified EntityTypeCollection +#' api.instance <- CollectionsApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$update_entity_type_collection_metadata(var.entity_type_collection_id, var.metadata_update) +#' +#' +#' } +#' @importFrom R6 R6Class +#' @importFrom base64enc base64encode +#' @export +CollectionsApi <- R6::R6Class( + 'CollectionsApi', + public = list( + apiClient = NULL, + initialize = function(apiClient){ + if (!missing(apiClient)) { + self$apiClient <- apiClient + } + else { + self$apiClient <- ApiClient$new() + } + }, + add_type_to_entity_type_collection_template = function(entity_type_collection_id, collection_template_type, ...){ + apiResponse <- self$add_type_to_entity_type_collection_templateWithHttpInfo(entity_type_collection_id, collection_template_type, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + add_type_to_entity_type_collection_templateWithHttpInfo = function(entity_type_collection_id, collection_template_type, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`entity_type_collection_id`)) { + stop("Missing required parameter `entity_type_collection_id`.") + } + + if (missing(`collection_template_type`)) { + stop("Missing required parameter `collection_template_type`.") + } + + if (!missing(`collection_template_type`)) { + body <- sprintf( + ' + %s + ', + jsonlite::toJSON(`collection_template_type`$toJSON(), auto_unbox=TRUE, digits = NA) + ) + } else { + body <- NULL + } + + urlPath <- "/datastore/collections/entity/type/{entityTypeCollectionId}/template" + if (!missing(`entity_type_collection_id`)) { + urlPath <- gsub(paste0("\\{", "entityTypeCollectionId", "\\}"), URLencode(as.character(`entity_type_collection_id`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "PATCH", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + create_entity_set_collection = function(entity_set_collection, ...){ + apiResponse <- self$create_entity_set_collectionWithHttpInfo(entity_set_collection, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + create_entity_set_collectionWithHttpInfo = function(entity_set_collection, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`entity_set_collection`)) { + stop("Missing required parameter `entity_set_collection`.") + } + + if (!missing(`entity_set_collection`)) { + body <- sprintf( + ' + %s + ', + jsonlite::toJSON(`entity_set_collection`$toJSON(), auto_unbox=TRUE, digits = NA) + ) + } else { + body <- NULL + } + + urlPath <- "/datastore/collections/entity/set" + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "POST", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "character", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + create_entity_type_collection = function(entity_type_collection, ...){ + apiResponse <- self$create_entity_type_collectionWithHttpInfo(entity_type_collection, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + create_entity_type_collectionWithHttpInfo = function(entity_type_collection, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`entity_type_collection`)) { + stop("Missing required parameter `entity_type_collection`.") + } + + if (!missing(`entity_type_collection`)) { + body <- sprintf( + ' + %s + ', + jsonlite::toJSON(`entity_type_collection`$toJSON(), auto_unbox=TRUE, digits = NA) + ) + } else { + body <- NULL + } + + urlPath <- "/datastore/collections/entity/type" + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "POST", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "character", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + delete_entity_set_collection = function(entity_set_collection_id, ...){ + apiResponse <- self$delete_entity_set_collectionWithHttpInfo(entity_set_collection_id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + delete_entity_set_collectionWithHttpInfo = function(entity_set_collection_id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`entity_set_collection_id`)) { + stop("Missing required parameter `entity_set_collection_id`.") + } + + urlPath <- "/datastore/collections/entity/set/{entitySetCollectionId}" + if (!missing(`entity_set_collection_id`)) { + urlPath <- gsub(paste0("\\{", "entitySetCollectionId", "\\}"), URLencode(as.character(`entity_set_collection_id`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "DELETE", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + delete_entity_type_collection = function(entity_type_collection_id, ...){ + apiResponse <- self$delete_entity_type_collectionWithHttpInfo(entity_type_collection_id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + delete_entity_type_collectionWithHttpInfo = function(entity_type_collection_id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`entity_type_collection_id`)) { + stop("Missing required parameter `entity_type_collection_id`.") + } + + urlPath <- "/datastore/collections/entity/type/{entityTypeCollectionId}" + if (!missing(`entity_type_collection_id`)) { + urlPath <- gsub(paste0("\\{", "entityTypeCollectionId", "\\}"), URLencode(as.character(`entity_type_collection_id`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "DELETE", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + get_all_entity_set_collections = function(...){ + apiResponse <- self$get_all_entity_set_collectionsWithHttpInfo(...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + get_all_entity_set_collectionsWithHttpInfo = function(...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + urlPath <- "/datastore/collections/entity/set" + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "array[EntitySetCollection]", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + get_all_entity_type_collections = function(...){ + apiResponse <- self$get_all_entity_type_collectionsWithHttpInfo(...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + get_all_entity_type_collectionsWithHttpInfo = function(...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + urlPath <- "/datastore/collections/entity/type" + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "array[EntityTypeCollection]", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + get_entity_set_collection = function(entity_set_collection_id, ...){ + apiResponse <- self$get_entity_set_collectionWithHttpInfo(entity_set_collection_id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + get_entity_set_collectionWithHttpInfo = function(entity_set_collection_id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`entity_set_collection_id`)) { + stop("Missing required parameter `entity_set_collection_id`.") + } + + urlPath <- "/datastore/collections/entity/set/{entitySetCollectionId}" + if (!missing(`entity_set_collection_id`)) { + urlPath <- gsub(paste0("\\{", "entitySetCollectionId", "\\}"), URLencode(as.character(`entity_set_collection_id`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "EntitySetCollection", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + get_entity_set_collections_of_type = function(entity_set_collection_id, ...){ + apiResponse <- self$get_entity_set_collections_of_typeWithHttpInfo(entity_set_collection_id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + get_entity_set_collections_of_typeWithHttpInfo = function(entity_set_collection_id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`entity_set_collection_id`)) { + stop("Missing required parameter `entity_set_collection_id`.") + } + + urlPath <- "/datastore/collections/entity/set/entity/type/{entitySetCollectionId}" + if (!missing(`entity_set_collection_id`)) { + urlPath <- gsub(paste0("\\{", "entitySetCollectionId", "\\}"), URLencode(as.character(`entity_set_collection_id`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "array[EntitySetCollection]", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + get_entity_type_collection = function(entity_type_collection_id, ...){ + apiResponse <- self$get_entity_type_collectionWithHttpInfo(entity_type_collection_id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + get_entity_type_collectionWithHttpInfo = function(entity_type_collection_id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`entity_type_collection_id`)) { + stop("Missing required parameter `entity_type_collection_id`.") + } + + urlPath <- "/datastore/collections/entity/type/{entityTypeCollectionId}" + if (!missing(`entity_type_collection_id`)) { + urlPath <- gsub(paste0("\\{", "entityTypeCollectionId", "\\}"), URLencode(as.character(`entity_type_collection_id`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "EntityTypeCollection", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + remove_type_from_entity_type_collection_template = function(entity_type_collection_id, type_id, ...){ + apiResponse <- self$remove_type_from_entity_type_collection_templateWithHttpInfo(entity_type_collection_id, type_id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + remove_type_from_entity_type_collection_templateWithHttpInfo = function(entity_type_collection_id, type_id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`entity_type_collection_id`)) { + stop("Missing required parameter `entity_type_collection_id`.") + } + + if (missing(`type_id`)) { + stop("Missing required parameter `type_id`.") + } + + urlPath <- "/datastore/collections/entity/type/{entityTypeCollectionId}/template/{typeId}" + if (!missing(`entity_type_collection_id`)) { + urlPath <- gsub(paste0("\\{", "entityTypeCollectionId", "\\}"), URLencode(as.character(`entity_type_collection_id`), reserved = TRUE), urlPath) + } + + if (!missing(`type_id`)) { + urlPath <- gsub(paste0("\\{", "typeId", "\\}"), URLencode(as.character(`type_id`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "DELETE", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + update_entity_set_collection_metadata = function(entity_set_collection_id, metadata_update, ...){ + apiResponse <- self$update_entity_set_collection_metadataWithHttpInfo(entity_set_collection_id, metadata_update, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + update_entity_set_collection_metadataWithHttpInfo = function(entity_set_collection_id, metadata_update, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`entity_set_collection_id`)) { + stop("Missing required parameter `entity_set_collection_id`.") + } + + if (missing(`metadata_update`)) { + stop("Missing required parameter `metadata_update`.") + } + + if (!missing(`metadata_update`)) { + body <- sprintf( + ' + %s + ', + jsonlite::toJSON(`metadata_update`$toJSON(), auto_unbox=TRUE, digits = NA) + ) + } else { + body <- NULL + } + + urlPath <- "/datastore/collections/entity/set/{entitySetCollectionId}" + if (!missing(`entity_set_collection_id`)) { + urlPath <- gsub(paste0("\\{", "entitySetCollectionId", "\\}"), URLencode(as.character(`entity_set_collection_id`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "PATCH", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + update_entity_set_collection_template = function(entity_set_collection_id, request_body, ...){ + apiResponse <- self$update_entity_set_collection_templateWithHttpInfo(entity_set_collection_id, request_body, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + update_entity_set_collection_templateWithHttpInfo = function(entity_set_collection_id, request_body, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`entity_set_collection_id`)) { + stop("Missing required parameter `entity_set_collection_id`.") + } + + if (missing(`request_body`)) { + stop("Missing required parameter `request_body`.") + } + + if (!missing(`request_body`)) { + body <- sprintf( + ' + %s +', + jsonlite::toJSON(`request_body`, digits=NA) + ) + } else { + body <- NULL + } + + urlPath <- "/datastore/collections/entity/set/{entitySetCollectionId}/template" + if (!missing(`entity_set_collection_id`)) { + urlPath <- gsub(paste0("\\{", "entitySetCollectionId", "\\}"), URLencode(as.character(`entity_set_collection_id`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "PATCH", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + update_entity_type_collection_metadata = function(entity_type_collection_id, metadata_update, ...){ + apiResponse <- self$update_entity_type_collection_metadataWithHttpInfo(entity_type_collection_id, metadata_update, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + update_entity_type_collection_metadataWithHttpInfo = function(entity_type_collection_id, metadata_update, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`entity_type_collection_id`)) { + stop("Missing required parameter `entity_type_collection_id`.") + } + + if (missing(`metadata_update`)) { + stop("Missing required parameter `metadata_update`.") + } + + if (!missing(`metadata_update`)) { + body <- sprintf( + ' + %s + ', + jsonlite::toJSON(`metadata_update`$toJSON(), auto_unbox=TRUE, digits = NA) + ) + } else { + body <- NULL + } + + urlPath <- "/datastore/collections/entity/type/{entityTypeCollectionId}" + if (!missing(`entity_type_collection_id`)) { + urlPath <- gsub(paste0("\\{", "entityTypeCollectionId", "\\}"), URLencode(as.character(`entity_type_collection_id`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "PATCH", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + } + ) +) diff --git a/R/R/constraint.R b/R/R/constraint.R index 5b3ae8e..8299a13 100644 --- a/R/R/constraint.R +++ b/R/R/constraint.R @@ -8,11 +8,8 @@ #' @docType class #' @title Constraint -#' #' @description Constraint Class -#' #' @format An \code{R6Class} generator object -#' #' @field type character [optional] #' #' @field searchTerm character [optional] @@ -31,12 +28,13 @@ #' #' @field unit character [optional] #' -#' @field zones list( array[array[numeric]] ) [optional] +#' @field zones list( \link{array[array[numeric]]} ) [optional] #' #' @field start character [optional] #' #' @field end character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -55,9 +53,7 @@ Constraint <- R6::R6Class( `zones` = NULL, `start` = NULL, `end` = NULL, - initialize = function( - `type`=NULL, `searchTerm`=NULL, `fuzzy`=NULL, `searchFields`=NULL, `propertyTypeId`=NULL, `latitude`=NULL, `longitude`=NULL, `radius`=NULL, `unit`=NULL, `zones`=NULL, `start`=NULL, `end`=NULL, ... - ) { + initialize = function(`type`=NULL, `searchTerm`=NULL, `fuzzy`=NULL, `searchFields`=NULL, `propertyTypeId`=NULL, `latitude`=NULL, `longitude`=NULL, `radius`=NULL, `unit`=NULL, `zones`=NULL, `start`=NULL, `end`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`type`)) { stopifnot(is.character(`type`), length(`type`) == 1) @@ -94,7 +90,7 @@ Constraint <- R6::R6Class( } if (!is.null(`zones`)) { stopifnot(is.vector(`zones`)) - sapply(`zones`, function(x) stopifnot(is.character(x))) + sapply(`zones`, function(x) stopifnot(R6::is.R6(x))) self$`zones` <- `zones` } if (!is.null(`start`)) { @@ -146,7 +142,7 @@ Constraint <- R6::R6Class( } if (!is.null(self$`zones`)) { ConstraintObject[['zones']] <- - self$`zones` + lapply(self$`zones`, function(x) x$toJSON()) } if (!is.null(self$`start`)) { ConstraintObject[['start']] <- @@ -197,7 +193,6 @@ Constraint <- R6::R6Class( if (!is.null(ConstraintObject$`end`)) { self$`end` <- ConstraintObject$`end` } - self }, toJSONString = function() { jsoncontent <- c( @@ -267,9 +262,9 @@ Constraint <- R6::R6Class( if (!is.null(self$`zones`)) { sprintf( '"zones": - [%s] - ', - paste(unlist(lapply(self$`zones`, function(x) paste0('"', x, '"'))), collapse=",") + [%s] +', + paste(sapply(self$`zones`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") )}, if (!is.null(self$`start`)) { sprintf( @@ -307,4 +302,3 @@ Constraint <- R6::R6Class( } ) ) - diff --git a/R/R/constraint_group.R b/R/R/constraint_group.R index 93cf50b..fff75ad 100644 --- a/R/R/constraint_group.R +++ b/R/R/constraint_group.R @@ -8,15 +8,13 @@ #' @docType class #' @title ConstraintGroup -#' #' @description ConstraintGroup Class -#' #' @format An \code{R6Class} generator object -#' #' @field min integer [optional] #' #' @field constraints list( \link{Constraint} ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ ConstraintGroup <- R6::R6Class( public = list( `min` = NULL, `constraints` = NULL, - initialize = function( - `min`=NULL, `constraints`=NULL, ... - ) { + initialize = function(`min`=NULL, `constraints`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`min`)) { stopifnot(is.numeric(`min`), length(`min`) == 1) @@ -60,7 +56,6 @@ ConstraintGroup <- R6::R6Class( if (!is.null(ConstraintGroupObject$`constraints`)) { self$`constraints` <- ApiClient$new()$deserializeObj(ConstraintGroupObject$`constraints`, "array[Constraint]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -90,4 +85,3 @@ ConstraintGroup <- R6::R6Class( } ) ) - diff --git a/R/R/data_api.R b/R/R/data_api.R index 86fa26e..2edd507 100644 --- a/R/R/data_api.R +++ b/R/R/data_api.R @@ -19,6 +19,7 @@ #' #' \itemize{ #' \item \emph{ @param } inline_object \link{InlineObject} +#' \item \emph{ @returnType } named list( \link{array} ) \cr #' #' #' \item status code : 200 | Edges @@ -51,7 +52,7 @@ #' #' \itemize{ #' \item \emph{ @param } set_id \link{character} -#' \item \emph{ @param } request_body list( list(array[character]) ) +#' \item \emph{ @param } request_body list( \link{list(array[character])} ) #' #' #' \item status code : 200 | Edges @@ -176,6 +177,7 @@ #' \itemize{ #' \item \emph{ @param } entity_set_id \link{character} #' \item \emph{ @param } entity_key_id \link{character} +#' \item \emph{ @returnType } named list( \link{array} ) \cr #' #' #' \item status code : 200 | An entity details object, with property type FQNs as keys. @@ -259,7 +261,7 @@ #' #' \itemize{ #' \item \emph{ @param } entity_set_id \link{character} -#' \item \emph{ @param } entity_set_selection \link{EntitySetSelection} +#' \item \emph{ @param } entity_set_selection list( \link{EntitySetSelection} ) #' #' #' \item status code : 200 | A list of entity keys that were generated @@ -627,7 +629,7 @@ #' #' library(openlattice) #' var.entity_set_id <- 'entity_set_id_example' # character | -#' var.entity_set_selection <- EntitySetSelection$new() # EntitySetSelection | +#' var.entity_set_selection <- list(EntitySetSelection$new()) # array[EntitySetSelection] | #' #' #Gets a list of entities by UUIDs #' api.instance <- DataApi$new() @@ -815,7 +817,7 @@ DataApi <- R6::R6Class( ' [%s] ', - paste(sapply(`data_edge_key`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`data_edge_key`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL @@ -884,7 +886,7 @@ DataApi <- R6::R6Class( ' [%s] ', - paste(sapply(`request_body`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`request_body`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL @@ -1076,7 +1078,7 @@ DataApi <- R6::R6Class( ' [%s] ', - paste(sapply(`request_body`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`request_body`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL @@ -1153,7 +1155,7 @@ DataApi <- R6::R6Class( ' [%s] ', - paste(sapply(`entity_neighbors_filter`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`entity_neighbors_filter`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL @@ -1225,7 +1227,7 @@ DataApi <- R6::R6Class( queryParams['type'] <- type - urlPath <- "/datastore/data/{entitySetId}/{entityKeyId}" + urlPath <- "/datastore/data/set/{entitySetId}/{entityKeyId}" if (!missing(`entity_set_id`)) { urlPath <- gsub(paste0("\\{", "entitySetId", "\\}"), URLencode(as.character(`entity_set_id`), reserved = TRUE), urlPath) } @@ -1298,7 +1300,7 @@ DataApi <- R6::R6Class( ' [%s] ', - paste(sapply(`request_body`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`request_body`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL @@ -1615,7 +1617,7 @@ DataApi <- R6::R6Class( ' [%s] ', - paste(sapply(`entity_set_selection`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`entity_set_selection`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL @@ -1684,9 +1686,9 @@ DataApi <- R6::R6Class( if (!missing(`entity_set_selection`)) { body <- sprintf( ' - %s - ', - jsonlite::toJSON(`entity_set_selection`$toJSON(), auto_unbox=TRUE, digits = NA) + [%s] +', + paste(sapply(`entity_set_selection`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL diff --git a/R/R/data_association.R b/R/R/data_association.R index fb7778a..4830dcf 100644 --- a/R/R/data_association.R +++ b/R/R/data_association.R @@ -8,17 +8,23 @@ #' @docType class #' @title DataAssociation -#' #' @description DataAssociation Class -#' #' @format An \code{R6Class} generator object -#' #' @field srcEntitySetId character [optional] #' #' @field srcEntityIndex character [optional] #' #' @field srcEntityKeyId character [optional] #' +#' @field dstEntitySetId character [optional] +#' +#' @field dstEntityIndex character [optional] +#' +#' @field dstEntityKeyId character [optional] +#' +#' @field data named list( \link{array[character]} ) [optional] +#' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -28,9 +34,11 @@ DataAssociation <- R6::R6Class( `srcEntitySetId` = NULL, `srcEntityIndex` = NULL, `srcEntityKeyId` = NULL, - initialize = function( - `srcEntitySetId`=NULL, `srcEntityIndex`=NULL, `srcEntityKeyId`=NULL, ... - ) { + `dstEntitySetId` = NULL, + `dstEntityIndex` = NULL, + `dstEntityKeyId` = NULL, + `data` = NULL, + initialize = function(`srcEntitySetId`=NULL, `srcEntityIndex`=NULL, `srcEntityKeyId`=NULL, `dstEntitySetId`=NULL, `dstEntityIndex`=NULL, `dstEntityKeyId`=NULL, `data`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`srcEntitySetId`)) { stopifnot(is.character(`srcEntitySetId`), length(`srcEntitySetId`) == 1) @@ -44,6 +52,23 @@ DataAssociation <- R6::R6Class( stopifnot(is.character(`srcEntityKeyId`), length(`srcEntityKeyId`) == 1) self$`srcEntityKeyId` <- `srcEntityKeyId` } + if (!is.null(`dstEntitySetId`)) { + stopifnot(is.character(`dstEntitySetId`), length(`dstEntitySetId`) == 1) + self$`dstEntitySetId` <- `dstEntitySetId` + } + if (!is.null(`dstEntityIndex`)) { + stopifnot(is.character(`dstEntityIndex`), length(`dstEntityIndex`) == 1) + self$`dstEntityIndex` <- `dstEntityIndex` + } + if (!is.null(`dstEntityKeyId`)) { + stopifnot(is.character(`dstEntityKeyId`), length(`dstEntityKeyId`) == 1) + self$`dstEntityKeyId` <- `dstEntityKeyId` + } + if (!is.null(`data`)) { + stopifnot(is.vector(`data`)) + sapply(`data`, function(x) stopifnot(R6::is.R6(x))) + self$`data` <- `data` + } }, toJSON = function() { DataAssociationObject <- list() @@ -59,6 +84,22 @@ DataAssociation <- R6::R6Class( DataAssociationObject[['srcEntityKeyId']] <- self$`srcEntityKeyId` } + if (!is.null(self$`dstEntitySetId`)) { + DataAssociationObject[['dstEntitySetId']] <- + self$`dstEntitySetId` + } + if (!is.null(self$`dstEntityIndex`)) { + DataAssociationObject[['dstEntityIndex']] <- + self$`dstEntityIndex` + } + if (!is.null(self$`dstEntityKeyId`)) { + DataAssociationObject[['dstEntityKeyId']] <- + self$`dstEntityKeyId` + } + if (!is.null(self$`data`)) { + DataAssociationObject[['data']] <- + lapply(self$`data`, function(x) x$toJSON()) + } DataAssociationObject }, @@ -73,7 +114,18 @@ DataAssociation <- R6::R6Class( if (!is.null(DataAssociationObject$`srcEntityKeyId`)) { self$`srcEntityKeyId` <- DataAssociationObject$`srcEntityKeyId` } - self + if (!is.null(DataAssociationObject$`dstEntitySetId`)) { + self$`dstEntitySetId` <- DataAssociationObject$`dstEntitySetId` + } + if (!is.null(DataAssociationObject$`dstEntityIndex`)) { + self$`dstEntityIndex` <- DataAssociationObject$`dstEntityIndex` + } + if (!is.null(DataAssociationObject$`dstEntityKeyId`)) { + self$`dstEntityKeyId` <- DataAssociationObject$`dstEntityKeyId` + } + if (!is.null(DataAssociationObject$`data`)) { + self$`data` <- ApiClient$new()$deserializeObj(DataAssociationObject$`data`, "list(array[character])", loadNamespace("openlattice")) + } }, toJSONString = function() { jsoncontent <- c( @@ -97,6 +149,34 @@ DataAssociation <- R6::R6Class( "%s" ', self$`srcEntityKeyId` + )}, + if (!is.null(self$`dstEntitySetId`)) { + sprintf( + '"dstEntitySetId": + "%s" + ', + self$`dstEntitySetId` + )}, + if (!is.null(self$`dstEntityIndex`)) { + sprintf( + '"dstEntityIndex": + "%s" + ', + self$`dstEntityIndex` + )}, + if (!is.null(self$`dstEntityKeyId`)) { + sprintf( + '"dstEntityKeyId": + "%s" + ', + self$`dstEntityKeyId` + )}, + if (!is.null(self$`data`)) { + sprintf( + '"data": + %s +', + jsonlite::toJSON(lapply(self$`data`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) )} ) jsoncontent <- paste(jsoncontent, collapse = ",") @@ -107,8 +187,11 @@ DataAssociation <- R6::R6Class( self$`srcEntitySetId` <- DataAssociationObject$`srcEntitySetId` self$`srcEntityIndex` <- DataAssociationObject$`srcEntityIndex` self$`srcEntityKeyId` <- DataAssociationObject$`srcEntityKeyId` + self$`dstEntitySetId` <- DataAssociationObject$`dstEntitySetId` + self$`dstEntityIndex` <- DataAssociationObject$`dstEntityIndex` + self$`dstEntityKeyId` <- DataAssociationObject$`dstEntityKeyId` + self$`data` <- ApiClient$new()$deserializeObj(DataAssociationObject$`data`, "list(array[character])", loadNamespace("openlattice")) self } ) ) - diff --git a/R/R/data_edge.R b/R/R/data_edge.R index 1644373..c56fb7a 100644 --- a/R/R/data_edge.R +++ b/R/R/data_edge.R @@ -8,17 +8,15 @@ #' @docType class #' @title DataEdge -#' #' @description DataEdge Class -#' #' @format An \code{R6Class} generator object -#' #' @field src \link{EntityDataKey} [optional] #' #' @field dst \link{EntityDataKey} [optional] #' #' @field data \link{DataEdgeData} [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -28,9 +26,7 @@ DataEdge <- R6::R6Class( `src` = NULL, `dst` = NULL, `data` = NULL, - initialize = function( - `src`=NULL, `dst`=NULL, `data`=NULL, ... - ) { + initialize = function(`src`=NULL, `dst`=NULL, `data`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`src`)) { stopifnot(R6::is.R6(`src`)) @@ -79,7 +75,6 @@ DataEdge <- R6::R6Class( dataObject$fromJSON(jsonlite::toJSON(DataEdgeObject$data, auto_unbox = TRUE, digits = NA)) self$`data` <- dataObject } - self }, toJSONString = function() { jsoncontent <- c( @@ -117,4 +112,3 @@ DataEdge <- R6::R6Class( } ) ) - diff --git a/R/R/data_edge_data.R b/R/R/data_edge_data.R index 1539fa9..a5d30a2 100644 --- a/R/R/data_edge_data.R +++ b/R/R/data_edge_data.R @@ -8,13 +8,11 @@ #' @docType class #' @title DataEdgeData -#' #' @description DataEdgeData Class -#' #' @format An \code{R6Class} generator object -#' #' @field additionalProperties list( character ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -22,9 +20,7 @@ DataEdgeData <- R6::R6Class( 'DataEdgeData', public = list( `additionalProperties` = NULL, - initialize = function( - `additionalProperties`=NULL, ... - ) { + initialize = function(`additionalProperties`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`additionalProperties`)) { stopifnot(is.vector(`additionalProperties`)) @@ -46,7 +42,6 @@ DataEdgeData <- R6::R6Class( if (!is.null(DataEdgeDataObject$`additionalProperties`)) { self$`additionalProperties` <- ApiClient$new()$deserializeObj(DataEdgeDataObject$`additionalProperties`, "array[character]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -68,4 +63,3 @@ DataEdgeData <- R6::R6Class( } ) ) - diff --git a/R/R/data_edge_key.R b/R/R/data_edge_key.R index 3ee3745..850a0c7 100644 --- a/R/R/data_edge_key.R +++ b/R/R/data_edge_key.R @@ -8,17 +8,15 @@ #' @docType class #' @title DataEdgeKey -#' #' @description DataEdgeKey Class -#' #' @format An \code{R6Class} generator object -#' #' @field src \link{EntityDataKey} [optional] #' #' @field dst \link{EntityDataKey} [optional] #' #' @field edge \link{EntityDataKey} [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -28,9 +26,7 @@ DataEdgeKey <- R6::R6Class( `src` = NULL, `dst` = NULL, `edge` = NULL, - initialize = function( - `src`=NULL, `dst`=NULL, `edge`=NULL, ... - ) { + initialize = function(`src`=NULL, `dst`=NULL, `edge`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`src`)) { stopifnot(R6::is.R6(`src`)) @@ -79,7 +75,6 @@ DataEdgeKey <- R6::R6Class( edgeObject$fromJSON(jsonlite::toJSON(DataEdgeKeyObject$edge, auto_unbox = TRUE, digits = NA)) self$`edge` <- edgeObject } - self }, toJSONString = function() { jsoncontent <- c( @@ -117,4 +112,3 @@ DataEdgeKey <- R6::R6Class( } ) ) - diff --git a/R/R/data_graph.R b/R/R/data_graph.R index 99d49bd..7f8ac9b 100644 --- a/R/R/data_graph.R +++ b/R/R/data_graph.R @@ -8,14 +8,12 @@ #' @docType class #' @title DataGraph -#' #' @description DataGraph Class -#' #' @format An \code{R6Class} generator object +#' @field entities named list( \link{array[list(array[character])]} ) [optional] #' -#' @field entities named list( array[list(array[character])] ) [optional] +#' @field associations named list( \link{array[DataAssociation]} ) [optional] #' -#' @field associations named list( array[DataAssociation] ) [optional] #' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON @@ -25,18 +23,16 @@ DataGraph <- R6::R6Class( public = list( `entities` = NULL, `associations` = NULL, - initialize = function( - `entities`=NULL, `associations`=NULL, ... - ) { + initialize = function(`entities`=NULL, `associations`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`entities`)) { stopifnot(is.vector(`entities`)) - sapply(`entities`, function(x) stopifnot(is.character(x))) + sapply(`entities`, function(x) stopifnot(R6::is.R6(x))) self$`entities` <- `entities` } if (!is.null(`associations`)) { stopifnot(is.vector(`associations`)) - sapply(`associations`, function(x) stopifnot(is.character(x))) + sapply(`associations`, function(x) stopifnot(R6::is.R6(x))) self$`associations` <- `associations` } }, @@ -44,11 +40,11 @@ DataGraph <- R6::R6Class( DataGraphObject <- list() if (!is.null(self$`entities`)) { DataGraphObject[['entities']] <- - self$`entities` + lapply(self$`entities`, function(x) x$toJSON()) } if (!is.null(self$`associations`)) { DataGraphObject[['associations']] <- - self$`associations` + lapply(self$`associations`, function(x) x$toJSON()) } DataGraphObject @@ -61,23 +57,22 @@ DataGraph <- R6::R6Class( if (!is.null(DataGraphObject$`associations`)) { self$`associations` <- ApiClient$new()$deserializeObj(DataGraphObject$`associations`, "list(array[DataAssociation])", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( if (!is.null(self$`entities`)) { sprintf( '"entities": - %s - ', - jsonlite::toJSON(lapply(self$`entities`, function(x){ x }), auto_unbox = TRUE, digits=NA) + %s +', + jsonlite::toJSON(lapply(self$`entities`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) )}, if (!is.null(self$`associations`)) { sprintf( '"associations": - %s - ', - jsonlite::toJSON(lapply(self$`associations`, function(x){ x }), auto_unbox = TRUE, digits=NA) + %s +', + jsonlite::toJSON(lapply(self$`associations`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) )} ) jsoncontent <- paste(jsoncontent, collapse = ",") @@ -91,4 +86,3 @@ DataGraph <- R6::R6Class( } ) ) - diff --git a/R/R/data_graph_ids.R b/R/R/data_graph_ids.R index b8c631d..7faa0c6 100644 --- a/R/R/data_graph_ids.R +++ b/R/R/data_graph_ids.R @@ -8,14 +8,12 @@ #' @docType class #' @title DataGraphIds -#' #' @description DataGraphIds Class -#' #' @format An \code{R6Class} generator object +#' @field entityKeyIds named list( \link{array[character]} ) [optional] #' -#' @field entityKeyIds named list( array[character] ) [optional] +#' @field entitySetIds named list( \link{array[character]} ) [optional] #' -#' @field entitySetIds named list( array[character] ) [optional] #' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON @@ -25,18 +23,16 @@ DataGraphIds <- R6::R6Class( public = list( `entityKeyIds` = NULL, `entitySetIds` = NULL, - initialize = function( - `entityKeyIds`=NULL, `entitySetIds`=NULL, ... - ) { + initialize = function(`entityKeyIds`=NULL, `entitySetIds`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`entityKeyIds`)) { stopifnot(is.vector(`entityKeyIds`)) - sapply(`entityKeyIds`, function(x) stopifnot(is.character(x))) + sapply(`entityKeyIds`, function(x) stopifnot(R6::is.R6(x))) self$`entityKeyIds` <- `entityKeyIds` } if (!is.null(`entitySetIds`)) { stopifnot(is.vector(`entitySetIds`)) - sapply(`entitySetIds`, function(x) stopifnot(is.character(x))) + sapply(`entitySetIds`, function(x) stopifnot(R6::is.R6(x))) self$`entitySetIds` <- `entitySetIds` } }, @@ -44,11 +40,11 @@ DataGraphIds <- R6::R6Class( DataGraphIdsObject <- list() if (!is.null(self$`entityKeyIds`)) { DataGraphIdsObject[['entityKeyIds']] <- - self$`entityKeyIds` + lapply(self$`entityKeyIds`, function(x) x$toJSON()) } if (!is.null(self$`entitySetIds`)) { DataGraphIdsObject[['entitySetIds']] <- - self$`entitySetIds` + lapply(self$`entitySetIds`, function(x) x$toJSON()) } DataGraphIdsObject @@ -61,23 +57,22 @@ DataGraphIds <- R6::R6Class( if (!is.null(DataGraphIdsObject$`entitySetIds`)) { self$`entitySetIds` <- ApiClient$new()$deserializeObj(DataGraphIdsObject$`entitySetIds`, "list(array[character])", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( if (!is.null(self$`entityKeyIds`)) { sprintf( '"entityKeyIds": - %s - ', - jsonlite::toJSON(lapply(self$`entityKeyIds`, function(x){ x }), auto_unbox = TRUE, digits=NA) + %s +', + jsonlite::toJSON(lapply(self$`entityKeyIds`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) )}, if (!is.null(self$`entitySetIds`)) { sprintf( '"entitySetIds": - %s - ', - jsonlite::toJSON(lapply(self$`entitySetIds`, function(x){ x }), auto_unbox = TRUE, digits=NA) + %s +', + jsonlite::toJSON(lapply(self$`entitySetIds`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) )} ) jsoncontent <- paste(jsoncontent, collapse = ",") @@ -91,4 +86,3 @@ DataGraphIds <- R6::R6Class( } ) ) - diff --git a/R/R/data_integrations_api.R b/R/R/data_integrations_api.R index 20178c0..09f128e 100644 --- a/R/R/data_integrations_api.R +++ b/R/R/data_integrations_api.R @@ -138,7 +138,7 @@ DataIntegrationsApi <- R6::R6Class( ' [%s] ', - paste(sapply(`entity_key`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`entity_key`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL diff --git a/R/R/data_search_result.R b/R/R/data_search_result.R index febbc00..24d99cb 100644 --- a/R/R/data_search_result.R +++ b/R/R/data_search_result.R @@ -8,15 +8,13 @@ #' @docType class #' @title DataSearchResult -#' #' @description DataSearchResult Class -#' #' @format An \code{R6Class} generator object -#' #' @field numHits integer [optional] #' #' @field hits list( list(array[character]) ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ DataSearchResult <- R6::R6Class( public = list( `numHits` = NULL, `hits` = NULL, - initialize = function( - `numHits`=NULL, `hits`=NULL, ... - ) { + initialize = function(`numHits`=NULL, `hits`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`numHits`)) { stopifnot(is.numeric(`numHits`), length(`numHits`) == 1) @@ -60,7 +56,6 @@ DataSearchResult <- R6::R6Class( if (!is.null(DataSearchResultObject$`hits`)) { self$`hits` <- ApiClient$new()$deserializeObj(DataSearchResultObject$`hits`, "array[list(array[character])]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -90,4 +85,3 @@ DataSearchResult <- R6::R6Class( } ) ) - diff --git a/R/R/dataset_api.R b/R/R/dataset_api.R index 2f14c80..80073d9 100644 --- a/R/R/dataset_api.R +++ b/R/R/dataset_api.R @@ -717,7 +717,7 @@ DatasetApi <- R6::R6Class( ' [%s] ', - paste(sapply(`request_body`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`request_body`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL diff --git a/R/R/ed_mdiff.R b/R/R/ed_mdiff.R index 816fcea..9699f09 100644 --- a/R/R/ed_mdiff.R +++ b/R/R/ed_mdiff.R @@ -8,15 +8,13 @@ #' @docType class #' @title EDMdiff -#' #' @description EDMdiff Class -#' #' @format An \code{R6Class} generator object -#' #' @field conflicts \link{EDM} [optional] #' #' @field diff \link{EDM} [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ EDMdiff <- R6::R6Class( public = list( `conflicts` = NULL, `diff` = NULL, - initialize = function( - `conflicts`=NULL, `diff`=NULL, ... - ) { + initialize = function(`conflicts`=NULL, `diff`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`conflicts`)) { stopifnot(R6::is.R6(`conflicts`)) @@ -63,7 +59,6 @@ EDMdiff <- R6::R6Class( diffObject$fromJSON(jsonlite::toJSON(EDMdiffObject$diff, auto_unbox = TRUE, digits = NA)) self$`diff` <- diffObject } - self }, toJSONString = function() { jsoncontent <- c( @@ -93,4 +88,3 @@ EDMdiff <- R6::R6Class( } ) ) - diff --git a/R/R/edm.R b/R/R/edm.R index 9494a57..9bde7b0 100644 --- a/R/R/edm.R +++ b/R/R/edm.R @@ -8,11 +8,8 @@ #' @docType class #' @title EDM -#' #' @description EDM Class -#' #' @format An \code{R6Class} generator object -#' #' @field namespaces list( character ) [optional] #' #' @field schemas list( \link{Schema} ) [optional] @@ -23,6 +20,7 @@ #' #' @field associationTypes list( \link{AssociationType} ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -34,9 +32,7 @@ EDM <- R6::R6Class( `propertyTypes` = NULL, `entityTypes` = NULL, `associationTypes` = NULL, - initialize = function( - `namespaces`=NULL, `schemas`=NULL, `propertyTypes`=NULL, `entityTypes`=NULL, `associationTypes`=NULL, ... - ) { + initialize = function(`namespaces`=NULL, `schemas`=NULL, `propertyTypes`=NULL, `entityTypes`=NULL, `associationTypes`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`namespaces`)) { stopifnot(is.vector(`namespaces`)) @@ -106,7 +102,6 @@ EDM <- R6::R6Class( if (!is.null(EDMObject$`associationTypes`)) { self$`associationTypes` <- ApiClient$new()$deserializeObj(EDMObject$`associationTypes`, "array[AssociationType]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -160,4 +155,3 @@ EDM <- R6::R6Class( } ) ) - diff --git a/R/R/edm_api.R b/R/R/edm_api.R index 187bf68..5c09b0a 100644 --- a/R/R/edm_api.R +++ b/R/R/edm_api.R @@ -1086,7 +1086,7 @@ #' #' library(openlattice) #' var.linking_entity_set_id <- 'linking_entity_set_id_example' # character | -#' var.request_body <- NULL # list(array[character]) | +#' var.request_body <- {'key' => array$new()} # list(array[character]) | #' #' #Adds the entity sets as linked entity sets to the linking entity sets #' api.instance <- EdmApi$new() @@ -1979,7 +1979,7 @@ #' #' library(openlattice) #' var.linking_entity_set_id <- 'linking_entity_set_id_example' # character | -#' var.request_body <- NULL # list(array[character]) | +#' var.request_body <- {'key' => array$new()} # list(array[character]) | #' #' #Removes/unlinks the linked entity sets from the linking entity set #' api.instance <- EdmApi$new() @@ -2330,7 +2330,7 @@ EdmApi <- R6::R6Class( ' [%s] ', - paste(sapply(`request_body`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`request_body`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL @@ -2642,7 +2642,7 @@ EdmApi <- R6::R6Class( ' [%s] ', - paste(sapply(`association_type`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`association_type`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL @@ -2753,7 +2753,7 @@ EdmApi <- R6::R6Class( ' [%s] ', - paste(sapply(`entity_set`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`entity_set`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL @@ -4068,7 +4068,7 @@ EdmApi <- R6::R6Class( ' [%s] ', - paste(sapply(`request_body`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`request_body`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL @@ -4421,7 +4421,7 @@ EdmApi <- R6::R6Class( ' [%s] ', - paste(sapply(`request_body`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`request_body`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL @@ -4944,7 +4944,7 @@ EdmApi <- R6::R6Class( ' [%s] ', - paste(sapply(`request_body`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`request_body`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL diff --git a/R/R/edm_request.R b/R/R/edm_request.R index 91be355..59dfe31 100644 --- a/R/R/edm_request.R +++ b/R/R/edm_request.R @@ -8,17 +8,15 @@ #' @docType class #' @title EdmRequest -#' #' @description EdmRequest Class -#' #' @format An \code{R6Class} generator object -#' #' @field action character [optional] #' #' @field propertyTypes list( character ) [optional] #' #' @field entityTypes list( character ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -28,9 +26,7 @@ EdmRequest <- R6::R6Class( `action` = NULL, `propertyTypes` = NULL, `entityTypes` = NULL, - initialize = function( - `action`=NULL, `propertyTypes`=NULL, `entityTypes`=NULL, ... - ) { + initialize = function(`action`=NULL, `propertyTypes`=NULL, `entityTypes`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`action`)) { stopifnot(is.character(`action`), length(`action`) == 1) @@ -75,7 +71,6 @@ EdmRequest <- R6::R6Class( if (!is.null(EdmRequestObject$`entityTypes`)) { self$`entityTypes` <- ApiClient$new()$deserializeObj(EdmRequestObject$`entityTypes`, "array[character]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -113,4 +108,3 @@ EdmRequest <- R6::R6Class( } ) ) - diff --git a/R/R/entity.R b/R/R/entity.R index 3ac12ed..a7a9963 100644 --- a/R/R/entity.R +++ b/R/R/entity.R @@ -8,15 +8,13 @@ #' @docType class #' @title Entity -#' #' @description Entity Class -#' #' @format An \code{R6Class} generator object -#' #' @field key \link{EntityKey} [optional] #' #' @field details named list( character ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ Entity <- R6::R6Class( public = list( `key` = NULL, `details` = NULL, - initialize = function( - `key`=NULL, `details`=NULL, ... - ) { + initialize = function(`key`=NULL, `details`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`key`)) { stopifnot(R6::is.R6(`key`)) @@ -62,7 +58,6 @@ Entity <- R6::R6Class( if (!is.null(EntityObject$`details`)) { self$`details` <- ApiClient$new()$deserializeObj(EntityObject$`details`, "list(character)", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -92,4 +87,3 @@ Entity <- R6::R6Class( } ) ) - diff --git a/R/R/entity_data_key.R b/R/R/entity_data_key.R index a681ae2..846d443 100644 --- a/R/R/entity_data_key.R +++ b/R/R/entity_data_key.R @@ -8,15 +8,13 @@ #' @docType class #' @title EntityDataKey -#' #' @description EntityDataKey Class -#' #' @format An \code{R6Class} generator object -#' #' @field entitySetId character [optional] #' #' @field entityKeyId character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ EntityDataKey <- R6::R6Class( public = list( `entitySetId` = NULL, `entityKeyId` = NULL, - initialize = function( - `entitySetId`=NULL, `entityKeyId`=NULL, ... - ) { + initialize = function(`entitySetId`=NULL, `entityKeyId`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`entitySetId`)) { stopifnot(is.character(`entitySetId`), length(`entitySetId`) == 1) @@ -59,7 +55,6 @@ EntityDataKey <- R6::R6Class( if (!is.null(EntityDataKeyObject$`entityKeyId`)) { self$`entityKeyId` <- EntityDataKeyObject$`entityKeyId` } - self }, toJSONString = function() { jsoncontent <- c( @@ -89,4 +84,3 @@ EntityDataKey <- R6::R6Class( } ) ) - diff --git a/R/R/entity_definition.R b/R/R/entity_definition.R new file mode 100644 index 0000000..a6e04fe --- /dev/null +++ b/R/R/entity_definition.R @@ -0,0 +1,133 @@ +# OpenLattice API +# +# OpenLattice API +# +# The version of the OpenAPI document: 0.0.1 +# Contact: support@openlattice.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title EntityDefinition +#' @description EntityDefinition Class +#' @format An \code{R6Class} generator object +#' @field fqn \link{FullQualifiedName} [optional] +#' +#' @field entitySetName character [optional] +#' +#' @field propertyDefinitions named list( \link{PropertyDefinition} ) [optional] +#' +#' @field updateType character [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +EntityDefinition <- R6::R6Class( + 'EntityDefinition', + public = list( + `fqn` = NULL, + `entitySetName` = NULL, + `propertyDefinitions` = NULL, + `updateType` = NULL, + initialize = function(`fqn`=NULL, `entitySetName`=NULL, `propertyDefinitions`=NULL, `updateType`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`fqn`)) { + stopifnot(R6::is.R6(`fqn`)) + self$`fqn` <- `fqn` + } + if (!is.null(`entitySetName`)) { + stopifnot(is.character(`entitySetName`), length(`entitySetName`) == 1) + self$`entitySetName` <- `entitySetName` + } + if (!is.null(`propertyDefinitions`)) { + stopifnot(is.vector(`propertyDefinitions`)) + sapply(`propertyDefinitions`, function(x) stopifnot(R6::is.R6(x))) + self$`propertyDefinitions` <- `propertyDefinitions` + } + if (!is.null(`updateType`)) { + stopifnot(is.character(`updateType`), length(`updateType`) == 1) + self$`updateType` <- `updateType` + } + }, + toJSON = function() { + EntityDefinitionObject <- list() + if (!is.null(self$`fqn`)) { + EntityDefinitionObject[['fqn']] <- + self$`fqn`$toJSON() + } + if (!is.null(self$`entitySetName`)) { + EntityDefinitionObject[['entitySetName']] <- + self$`entitySetName` + } + if (!is.null(self$`propertyDefinitions`)) { + EntityDefinitionObject[['propertyDefinitions']] <- + lapply(self$`propertyDefinitions`, function(x) x$toJSON()) + } + if (!is.null(self$`updateType`)) { + EntityDefinitionObject[['updateType']] <- + self$`updateType` + } + + EntityDefinitionObject + }, + fromJSON = function(EntityDefinitionJson) { + EntityDefinitionObject <- jsonlite::fromJSON(EntityDefinitionJson) + if (!is.null(EntityDefinitionObject$`fqn`)) { + fqnObject <- FullQualifiedName$new() + fqnObject$fromJSON(jsonlite::toJSON(EntityDefinitionObject$fqn, auto_unbox = TRUE, digits = NA)) + self$`fqn` <- fqnObject + } + if (!is.null(EntityDefinitionObject$`entitySetName`)) { + self$`entitySetName` <- EntityDefinitionObject$`entitySetName` + } + if (!is.null(EntityDefinitionObject$`propertyDefinitions`)) { + self$`propertyDefinitions` <- ApiClient$new()$deserializeObj(EntityDefinitionObject$`propertyDefinitions`, "list(PropertyDefinition)", loadNamespace("openlattice")) + } + if (!is.null(EntityDefinitionObject$`updateType`)) { + self$`updateType` <- EntityDefinitionObject$`updateType` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`fqn`)) { + sprintf( + '"fqn": + %s + ', + jsonlite::toJSON(self$`fqn`$toJSON(), auto_unbox=TRUE, digits = NA) + )}, + if (!is.null(self$`entitySetName`)) { + sprintf( + '"entitySetName": + "%s" + ', + self$`entitySetName` + )}, + if (!is.null(self$`propertyDefinitions`)) { + sprintf( + '"propertyDefinitions": + %s +', + jsonlite::toJSON(lapply(self$`propertyDefinitions`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) + )}, + if (!is.null(self$`updateType`)) { + sprintf( + '"updateType": + "%s" + ', + self$`updateType` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(EntityDefinitionJson) { + EntityDefinitionObject <- jsonlite::fromJSON(EntityDefinitionJson) + self$`fqn` <- FullQualifiedName$new()$fromJSON(jsonlite::toJSON(EntityDefinitionObject$fqn, auto_unbox = TRUE, digits = NA)) + self$`entitySetName` <- EntityDefinitionObject$`entitySetName` + self$`propertyDefinitions` <- ApiClient$new()$deserializeObj(EntityDefinitionObject$`propertyDefinitions`, "list(PropertyDefinition)", loadNamespace("openlattice")) + self$`updateType` <- EntityDefinitionObject$`updateType` + self + } + ) +) diff --git a/R/R/entity_key.R b/R/R/entity_key.R index 0129c94..455d8ef 100644 --- a/R/R/entity_key.R +++ b/R/R/entity_key.R @@ -8,15 +8,13 @@ #' @docType class #' @title EntityKey -#' #' @description EntityKey Class -#' #' @format An \code{R6Class} generator object -#' #' @field entitySetId character [optional] #' #' @field entityId character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ EntityKey <- R6::R6Class( public = list( `entitySetId` = NULL, `entityId` = NULL, - initialize = function( - `entitySetId`=NULL, `entityId`=NULL, ... - ) { + initialize = function(`entitySetId`=NULL, `entityId`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`entitySetId`)) { stopifnot(is.character(`entitySetId`), length(`entitySetId`) == 1) @@ -59,7 +55,6 @@ EntityKey <- R6::R6Class( if (!is.null(EntityKeyObject$`entityId`)) { self$`entityId` <- EntityKeyObject$`entityId` } - self }, toJSONString = function() { jsoncontent <- c( @@ -89,4 +84,3 @@ EntityKey <- R6::R6Class( } ) ) - diff --git a/R/R/entity_key_pair.R b/R/R/entity_key_pair.R index 1acc4ce..0382255 100644 --- a/R/R/entity_key_pair.R +++ b/R/R/entity_key_pair.R @@ -8,15 +8,13 @@ #' @docType class #' @title EntityKeyPair -#' #' @description EntityKeyPair Class -#' #' @format An \code{R6Class} generator object -#' #' @field first character [optional] #' #' @field second character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ EntityKeyPair <- R6::R6Class( public = list( `first` = NULL, `second` = NULL, - initialize = function( - `first`=NULL, `second`=NULL, ... - ) { + initialize = function(`first`=NULL, `second`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`first`)) { stopifnot(is.character(`first`), length(`first`) == 1) @@ -59,7 +55,6 @@ EntityKeyPair <- R6::R6Class( if (!is.null(EntityKeyPairObject$`second`)) { self$`second` <- EntityKeyPairObject$`second` } - self }, toJSONString = function() { jsoncontent <- c( @@ -89,4 +84,3 @@ EntityKeyPair <- R6::R6Class( } ) ) - diff --git a/R/R/entity_linking_features.R b/R/R/entity_linking_features.R index f979283..dcc0633 100644 --- a/R/R/entity_linking_features.R +++ b/R/R/entity_linking_features.R @@ -8,15 +8,13 @@ #' @docType class #' @title EntityLinkingFeatures -#' #' @description EntityLinkingFeatures Class -#' #' @format An \code{R6Class} generator object -#' #' @field entityLinkingFeedback \link{EntityLinkingFeedback} [optional] #' #' @field features named list( numeric ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ EntityLinkingFeatures <- R6::R6Class( public = list( `entityLinkingFeedback` = NULL, `features` = NULL, - initialize = function( - `entityLinkingFeedback`=NULL, `features`=NULL, ... - ) { + initialize = function(`entityLinkingFeedback`=NULL, `features`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`entityLinkingFeedback`)) { stopifnot(R6::is.R6(`entityLinkingFeedback`)) @@ -62,7 +58,6 @@ EntityLinkingFeatures <- R6::R6Class( if (!is.null(EntityLinkingFeaturesObject$`features`)) { self$`features` <- ApiClient$new()$deserializeObj(EntityLinkingFeaturesObject$`features`, "list(numeric)", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -92,4 +87,3 @@ EntityLinkingFeatures <- R6::R6Class( } ) ) - diff --git a/R/R/entity_linking_feedback.R b/R/R/entity_linking_feedback.R index affbeae..4b09147 100644 --- a/R/R/entity_linking_feedback.R +++ b/R/R/entity_linking_feedback.R @@ -8,15 +8,13 @@ #' @docType class #' @title EntityLinkingFeedback -#' #' @description EntityLinkingFeedback Class -#' #' @format An \code{R6Class} generator object -#' #' @field entityKeyPair \link{EntityKeyPair} [optional] #' #' @field linked character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ EntityLinkingFeedback <- R6::R6Class( public = list( `entityKeyPair` = NULL, `linked` = NULL, - initialize = function( - `entityKeyPair`=NULL, `linked`=NULL, ... - ) { + initialize = function(`entityKeyPair`=NULL, `linked`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`entityKeyPair`)) { stopifnot(R6::is.R6(`entityKeyPair`)) @@ -60,7 +56,6 @@ EntityLinkingFeedback <- R6::R6Class( if (!is.null(EntityLinkingFeedbackObject$`linked`)) { self$`linked` <- EntityLinkingFeedbackObject$`linked` } - self }, toJSONString = function() { jsoncontent <- c( @@ -90,4 +85,3 @@ EntityLinkingFeedback <- R6::R6Class( } ) ) - diff --git a/R/R/entity_neighbors_filter.R b/R/R/entity_neighbors_filter.R index b1ad339..e78b821 100644 --- a/R/R/entity_neighbors_filter.R +++ b/R/R/entity_neighbors_filter.R @@ -8,18 +8,16 @@ #' @docType class #' @title EntityNeighborsFilter -#' #' @description EntityNeighborsFilter Class -#' #' @format An \code{R6Class} generator object -#' #' @field entityKeyIds list( character ) [optional] #' -#' @field srcEntitySetIds list( character ) [optional] +#' @field src list( character ) [optional] #' -#' @field dstEntitySetIds list( character ) [optional] +#' @field dst list( character ) [optional] +#' +#' @field edge list( character ) [optional] #' -#' @field associationEntitySetIds list( character ) [optional] #' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON @@ -28,32 +26,30 @@ EntityNeighborsFilter <- R6::R6Class( 'EntityNeighborsFilter', public = list( `entityKeyIds` = NULL, - `srcEntitySetIds` = NULL, - `dstEntitySetIds` = NULL, - `associationEntitySetIds` = NULL, - initialize = function( - `entityKeyIds`=NULL, `srcEntitySetIds`=NULL, `dstEntitySetIds`=NULL, `associationEntitySetIds`=NULL, ... - ) { + `src` = NULL, + `dst` = NULL, + `edge` = NULL, + initialize = function(`entityKeyIds`=NULL, `src`=NULL, `dst`=NULL, `edge`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`entityKeyIds`)) { stopifnot(is.vector(`entityKeyIds`)) sapply(`entityKeyIds`, function(x) stopifnot(is.character(x))) self$`entityKeyIds` <- `entityKeyIds` } - if (!is.null(`srcEntitySetIds`)) { - stopifnot(is.vector(`srcEntitySetIds`)) - sapply(`srcEntitySetIds`, function(x) stopifnot(is.character(x))) - self$`srcEntitySetIds` <- `srcEntitySetIds` + if (!is.null(`src`)) { + stopifnot(is.vector(`src`)) + sapply(`src`, function(x) stopifnot(is.character(x))) + self$`src` <- `src` } - if (!is.null(`dstEntitySetIds`)) { - stopifnot(is.vector(`dstEntitySetIds`)) - sapply(`dstEntitySetIds`, function(x) stopifnot(is.character(x))) - self$`dstEntitySetIds` <- `dstEntitySetIds` + if (!is.null(`dst`)) { + stopifnot(is.vector(`dst`)) + sapply(`dst`, function(x) stopifnot(is.character(x))) + self$`dst` <- `dst` } - if (!is.null(`associationEntitySetIds`)) { - stopifnot(is.vector(`associationEntitySetIds`)) - sapply(`associationEntitySetIds`, function(x) stopifnot(is.character(x))) - self$`associationEntitySetIds` <- `associationEntitySetIds` + if (!is.null(`edge`)) { + stopifnot(is.vector(`edge`)) + sapply(`edge`, function(x) stopifnot(is.character(x))) + self$`edge` <- `edge` } }, toJSON = function() { @@ -62,17 +58,17 @@ EntityNeighborsFilter <- R6::R6Class( EntityNeighborsFilterObject[['entityKeyIds']] <- self$`entityKeyIds` } - if (!is.null(self$`srcEntitySetIds`)) { - EntityNeighborsFilterObject[['srcEntitySetIds']] <- - self$`srcEntitySetIds` + if (!is.null(self$`src`)) { + EntityNeighborsFilterObject[['src']] <- + self$`src` } - if (!is.null(self$`dstEntitySetIds`)) { - EntityNeighborsFilterObject[['dstEntitySetIds']] <- - self$`dstEntitySetIds` + if (!is.null(self$`dst`)) { + EntityNeighborsFilterObject[['dst']] <- + self$`dst` } - if (!is.null(self$`associationEntitySetIds`)) { - EntityNeighborsFilterObject[['associationEntitySetIds']] <- - self$`associationEntitySetIds` + if (!is.null(self$`edge`)) { + EntityNeighborsFilterObject[['edge']] <- + self$`edge` } EntityNeighborsFilterObject @@ -82,16 +78,15 @@ EntityNeighborsFilter <- R6::R6Class( if (!is.null(EntityNeighborsFilterObject$`entityKeyIds`)) { self$`entityKeyIds` <- ApiClient$new()$deserializeObj(EntityNeighborsFilterObject$`entityKeyIds`, "array[character]", loadNamespace("openlattice")) } - if (!is.null(EntityNeighborsFilterObject$`srcEntitySetIds`)) { - self$`srcEntitySetIds` <- ApiClient$new()$deserializeObj(EntityNeighborsFilterObject$`srcEntitySetIds`, "array[character]", loadNamespace("openlattice")) + if (!is.null(EntityNeighborsFilterObject$`src`)) { + self$`src` <- ApiClient$new()$deserializeObj(EntityNeighborsFilterObject$`src`, "array[character]", loadNamespace("openlattice")) } - if (!is.null(EntityNeighborsFilterObject$`dstEntitySetIds`)) { - self$`dstEntitySetIds` <- ApiClient$new()$deserializeObj(EntityNeighborsFilterObject$`dstEntitySetIds`, "array[character]", loadNamespace("openlattice")) + if (!is.null(EntityNeighborsFilterObject$`dst`)) { + self$`dst` <- ApiClient$new()$deserializeObj(EntityNeighborsFilterObject$`dst`, "array[character]", loadNamespace("openlattice")) } - if (!is.null(EntityNeighborsFilterObject$`associationEntitySetIds`)) { - self$`associationEntitySetIds` <- ApiClient$new()$deserializeObj(EntityNeighborsFilterObject$`associationEntitySetIds`, "array[character]", loadNamespace("openlattice")) + if (!is.null(EntityNeighborsFilterObject$`edge`)) { + self$`edge` <- ApiClient$new()$deserializeObj(EntityNeighborsFilterObject$`edge`, "array[character]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -102,26 +97,26 @@ EntityNeighborsFilter <- R6::R6Class( ', paste(unlist(lapply(self$`entityKeyIds`, function(x) paste0('"', x, '"'))), collapse=",") )}, - if (!is.null(self$`srcEntitySetIds`)) { + if (!is.null(self$`src`)) { sprintf( - '"srcEntitySetIds": + '"src": [%s] ', - paste(unlist(lapply(self$`srcEntitySetIds`, function(x) paste0('"', x, '"'))), collapse=",") + paste(unlist(lapply(self$`src`, function(x) paste0('"', x, '"'))), collapse=",") )}, - if (!is.null(self$`dstEntitySetIds`)) { + if (!is.null(self$`dst`)) { sprintf( - '"dstEntitySetIds": + '"dst": [%s] ', - paste(unlist(lapply(self$`dstEntitySetIds`, function(x) paste0('"', x, '"'))), collapse=",") + paste(unlist(lapply(self$`dst`, function(x) paste0('"', x, '"'))), collapse=",") )}, - if (!is.null(self$`associationEntitySetIds`)) { + if (!is.null(self$`edge`)) { sprintf( - '"associationEntitySetIds": + '"edge": [%s] ', - paste(unlist(lapply(self$`associationEntitySetIds`, function(x) paste0('"', x, '"'))), collapse=",") + paste(unlist(lapply(self$`edge`, function(x) paste0('"', x, '"'))), collapse=",") )} ) jsoncontent <- paste(jsoncontent, collapse = ",") @@ -130,11 +125,10 @@ EntityNeighborsFilter <- R6::R6Class( fromJSONString = function(EntityNeighborsFilterJson) { EntityNeighborsFilterObject <- jsonlite::fromJSON(EntityNeighborsFilterJson) self$`entityKeyIds` <- ApiClient$new()$deserializeObj(EntityNeighborsFilterObject$`entityKeyIds`, "array[character]", loadNamespace("openlattice")) - self$`srcEntitySetIds` <- ApiClient$new()$deserializeObj(EntityNeighborsFilterObject$`srcEntitySetIds`, "array[character]", loadNamespace("openlattice")) - self$`dstEntitySetIds` <- ApiClient$new()$deserializeObj(EntityNeighborsFilterObject$`dstEntitySetIds`, "array[character]", loadNamespace("openlattice")) - self$`associationEntitySetIds` <- ApiClient$new()$deserializeObj(EntityNeighborsFilterObject$`associationEntitySetIds`, "array[character]", loadNamespace("openlattice")) + self$`src` <- ApiClient$new()$deserializeObj(EntityNeighborsFilterObject$`src`, "array[character]", loadNamespace("openlattice")) + self$`dst` <- ApiClient$new()$deserializeObj(EntityNeighborsFilterObject$`dst`, "array[character]", loadNamespace("openlattice")) + self$`edge` <- ApiClient$new()$deserializeObj(EntityNeighborsFilterObject$`edge`, "array[character]", loadNamespace("openlattice")) self } ) ) - diff --git a/R/R/entity_set.R b/R/R/entity_set.R index 7a3c5eb..26d8c0f 100644 --- a/R/R/entity_set.R +++ b/R/R/entity_set.R @@ -8,11 +8,8 @@ #' @docType class #' @title EntitySet -#' #' @description EntitySet Class -#' #' @format An \code{R6Class} generator object -#' #' @field id character [optional] #' #' @field entityTypeId character [optional] @@ -35,6 +32,7 @@ #' #' @field partitions list( integer ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -52,9 +50,7 @@ EntitySet <- R6::R6Class( `organizationId` = NULL, `flags` = NULL, `partitions` = NULL, - initialize = function( - `id`=NULL, `entityTypeId`=NULL, `name`=NULL, `title`=NULL, `description`=NULL, `contacts`=NULL, `linking`=NULL, `linkedEntitySets`=NULL, `organizationId`=NULL, `flags`=NULL, `partitions`=NULL, ... - ) { + initialize = function(`id`=NULL, `entityTypeId`=NULL, `name`=NULL, `title`=NULL, `description`=NULL, `contacts`=NULL, `linking`=NULL, `linkedEntitySets`=NULL, `organizationId`=NULL, `flags`=NULL, `partitions`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`id`)) { stopifnot(is.character(`id`), length(`id`) == 1) @@ -188,7 +184,6 @@ EntitySet <- R6::R6Class( if (!is.null(EntitySetObject$`partitions`)) { self$`partitions` <- ApiClient$new()$deserializeObj(EntitySetObject$`partitions`, "array[integer]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -290,4 +285,3 @@ EntitySet <- R6::R6Class( } ) ) - diff --git a/R/R/entity_set_collection.R b/R/R/entity_set_collection.R new file mode 100644 index 0000000..aeaab43 --- /dev/null +++ b/R/R/entity_set_collection.R @@ -0,0 +1,220 @@ +# OpenLattice API +# +# OpenLattice API +# +# The version of the OpenAPI document: 0.0.1 +# Contact: support@openlattice.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title EntitySetCollection +#' @description EntitySetCollection Class +#' @format An \code{R6Class} generator object +#' @field id character [optional] +#' +#' @field name character [optional] +#' +#' @field title character [optional] +#' +#' @field description character [optional] +#' +#' @field entityTypeCollectionId character [optional] +#' +#' @field template named list( character ) [optional] +#' +#' @field contacts list( character ) [optional] +#' +#' @field organizationId character [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +EntitySetCollection <- R6::R6Class( + 'EntitySetCollection', + public = list( + `id` = NULL, + `name` = NULL, + `title` = NULL, + `description` = NULL, + `entityTypeCollectionId` = NULL, + `template` = NULL, + `contacts` = NULL, + `organizationId` = NULL, + initialize = function(`id`=NULL, `name`=NULL, `title`=NULL, `description`=NULL, `entityTypeCollectionId`=NULL, `template`=NULL, `contacts`=NULL, `organizationId`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`id`)) { + stopifnot(is.character(`id`), length(`id`) == 1) + self$`id` <- `id` + } + if (!is.null(`name`)) { + stopifnot(is.character(`name`), length(`name`) == 1) + self$`name` <- `name` + } + if (!is.null(`title`)) { + stopifnot(is.character(`title`), length(`title`) == 1) + self$`title` <- `title` + } + if (!is.null(`description`)) { + stopifnot(is.character(`description`), length(`description`) == 1) + self$`description` <- `description` + } + if (!is.null(`entityTypeCollectionId`)) { + stopifnot(is.character(`entityTypeCollectionId`), length(`entityTypeCollectionId`) == 1) + self$`entityTypeCollectionId` <- `entityTypeCollectionId` + } + if (!is.null(`template`)) { + stopifnot(is.vector(`template`)) + sapply(`template`, function(x) stopifnot(is.character(x))) + self$`template` <- `template` + } + if (!is.null(`contacts`)) { + stopifnot(is.vector(`contacts`)) + sapply(`contacts`, function(x) stopifnot(is.character(x))) + self$`contacts` <- `contacts` + } + if (!is.null(`organizationId`)) { + stopifnot(is.character(`organizationId`), length(`organizationId`) == 1) + self$`organizationId` <- `organizationId` + } + }, + toJSON = function() { + EntitySetCollectionObject <- list() + if (!is.null(self$`id`)) { + EntitySetCollectionObject[['id']] <- + self$`id` + } + if (!is.null(self$`name`)) { + EntitySetCollectionObject[['name']] <- + self$`name` + } + if (!is.null(self$`title`)) { + EntitySetCollectionObject[['title']] <- + self$`title` + } + if (!is.null(self$`description`)) { + EntitySetCollectionObject[['description']] <- + self$`description` + } + if (!is.null(self$`entityTypeCollectionId`)) { + EntitySetCollectionObject[['entityTypeCollectionId']] <- + self$`entityTypeCollectionId` + } + if (!is.null(self$`template`)) { + EntitySetCollectionObject[['template']] <- + self$`template` + } + if (!is.null(self$`contacts`)) { + EntitySetCollectionObject[['contacts']] <- + self$`contacts` + } + if (!is.null(self$`organizationId`)) { + EntitySetCollectionObject[['organizationId']] <- + self$`organizationId` + } + + EntitySetCollectionObject + }, + fromJSON = function(EntitySetCollectionJson) { + EntitySetCollectionObject <- jsonlite::fromJSON(EntitySetCollectionJson) + if (!is.null(EntitySetCollectionObject$`id`)) { + self$`id` <- EntitySetCollectionObject$`id` + } + if (!is.null(EntitySetCollectionObject$`name`)) { + self$`name` <- EntitySetCollectionObject$`name` + } + if (!is.null(EntitySetCollectionObject$`title`)) { + self$`title` <- EntitySetCollectionObject$`title` + } + if (!is.null(EntitySetCollectionObject$`description`)) { + self$`description` <- EntitySetCollectionObject$`description` + } + if (!is.null(EntitySetCollectionObject$`entityTypeCollectionId`)) { + self$`entityTypeCollectionId` <- EntitySetCollectionObject$`entityTypeCollectionId` + } + if (!is.null(EntitySetCollectionObject$`template`)) { + self$`template` <- ApiClient$new()$deserializeObj(EntitySetCollectionObject$`template`, "list(character)", loadNamespace("openlattice")) + } + if (!is.null(EntitySetCollectionObject$`contacts`)) { + self$`contacts` <- ApiClient$new()$deserializeObj(EntitySetCollectionObject$`contacts`, "array[character]", loadNamespace("openlattice")) + } + if (!is.null(EntitySetCollectionObject$`organizationId`)) { + self$`organizationId` <- EntitySetCollectionObject$`organizationId` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`id`)) { + sprintf( + '"id": + "%s" + ', + self$`id` + )}, + if (!is.null(self$`name`)) { + sprintf( + '"name": + "%s" + ', + self$`name` + )}, + if (!is.null(self$`title`)) { + sprintf( + '"title": + "%s" + ', + self$`title` + )}, + if (!is.null(self$`description`)) { + sprintf( + '"description": + "%s" + ', + self$`description` + )}, + if (!is.null(self$`entityTypeCollectionId`)) { + sprintf( + '"entityTypeCollectionId": + "%s" + ', + self$`entityTypeCollectionId` + )}, + if (!is.null(self$`template`)) { + sprintf( + '"template": + %s + ', + jsonlite::toJSON(lapply(self$`template`, function(x){ x }), auto_unbox = TRUE, digits=NA) + )}, + if (!is.null(self$`contacts`)) { + sprintf( + '"contacts": + [%s] + ', + paste(unlist(lapply(self$`contacts`, function(x) paste0('"', x, '"'))), collapse=",") + )}, + if (!is.null(self$`organizationId`)) { + sprintf( + '"organizationId": + "%s" + ', + self$`organizationId` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(EntitySetCollectionJson) { + EntitySetCollectionObject <- jsonlite::fromJSON(EntitySetCollectionJson) + self$`id` <- EntitySetCollectionObject$`id` + self$`name` <- EntitySetCollectionObject$`name` + self$`title` <- EntitySetCollectionObject$`title` + self$`description` <- EntitySetCollectionObject$`description` + self$`entityTypeCollectionId` <- EntitySetCollectionObject$`entityTypeCollectionId` + self$`template` <- ApiClient$new()$deserializeObj(EntitySetCollectionObject$`template`, "list(character)", loadNamespace("openlattice")) + self$`contacts` <- ApiClient$new()$deserializeObj(EntitySetCollectionObject$`contacts`, "array[character]", loadNamespace("openlattice")) + self$`organizationId` <- EntitySetCollectionObject$`organizationId` + self + } + ) +) diff --git a/R/R/entity_set_property_meta_data.R b/R/R/entity_set_property_meta_data.R index 1b02f4f..04d43cc 100644 --- a/R/R/entity_set_property_meta_data.R +++ b/R/R/entity_set_property_meta_data.R @@ -8,11 +8,8 @@ #' @docType class #' @title EntitySetPropertyMetaData -#' #' @description EntitySetPropertyMetaData Class -#' #' @format An \code{R6Class} generator object -#' #' @field title character [optional] #' #' @field description character [optional] @@ -21,6 +18,7 @@ #' #' @field defaultShow character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -31,9 +29,7 @@ EntitySetPropertyMetaData <- R6::R6Class( `description` = NULL, `propertyTags` = NULL, `defaultShow` = NULL, - initialize = function( - `title`=NULL, `description`=NULL, `propertyTags`=NULL, `defaultShow`=NULL, ... - ) { + initialize = function(`title`=NULL, `description`=NULL, `propertyTags`=NULL, `defaultShow`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`title`)) { stopifnot(is.character(`title`), length(`title`) == 1) @@ -87,7 +83,6 @@ EntitySetPropertyMetaData <- R6::R6Class( if (!is.null(EntitySetPropertyMetaDataObject$`defaultShow`)) { self$`defaultShow` <- EntitySetPropertyMetaDataObject$`defaultShow` } - self }, toJSONString = function() { jsoncontent <- c( @@ -133,4 +128,3 @@ EntitySetPropertyMetaData <- R6::R6Class( } ) ) - diff --git a/R/R/entity_set_selection.R b/R/R/entity_set_selection.R index 85dfba2..73f1cc2 100644 --- a/R/R/entity_set_selection.R +++ b/R/R/entity_set_selection.R @@ -8,15 +8,13 @@ #' @docType class #' @title EntitySetSelection -#' #' @description EntitySetSelection Class -#' #' @format An \code{R6Class} generator object -#' #' @field ids list( character ) [optional] #' #' @field properties list( character ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ EntitySetSelection <- R6::R6Class( public = list( `ids` = NULL, `properties` = NULL, - initialize = function( - `ids`=NULL, `properties`=NULL, ... - ) { + initialize = function(`ids`=NULL, `properties`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`ids`)) { stopifnot(is.vector(`ids`)) @@ -61,7 +57,6 @@ EntitySetSelection <- R6::R6Class( if (!is.null(EntitySetSelectionObject$`properties`)) { self$`properties` <- ApiClient$new()$deserializeObj(EntitySetSelectionObject$`properties`, "array[character]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -91,4 +86,3 @@ EntitySetSelection <- R6::R6Class( } ) ) - diff --git a/R/R/entity_sets_api.R b/R/R/entity_sets_api.R index 1897ea8..0452c88 100644 --- a/R/R/entity_sets_api.R +++ b/R/R/entity_sets_api.R @@ -312,7 +312,7 @@ #' #' library(openlattice) #' var.linking_entity_set_id <- 'linking_entity_set_id_example' # character | -#' var.request_body <- NULL # list(array[character]) | +#' var.request_body <- {'key' => array$new()} # list(array[character]) | #' #' #Adds the entity sets as linked entity sets to the linking entity sets #' api.instance <- EntitySetsApi$new() @@ -554,7 +554,7 @@ #' #' library(openlattice) #' var.linking_entity_set_id <- 'linking_entity_set_id_example' # character | -#' var.request_body <- NULL # list(array[character]) | +#' var.request_body <- {'key' => array$new()} # list(array[character]) | #' #' #Removes/unlinks the linked entity sets from the linking entity set #' api.instance <- EntitySetsApi$new() @@ -658,7 +658,7 @@ EntitySetsApi <- R6::R6Class( ' [%s] ', - paste(sapply(`request_body`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`request_body`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL @@ -796,7 +796,7 @@ EntitySetsApi <- R6::R6Class( ' [%s] ', - paste(sapply(`entity_set`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`entity_set`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL @@ -1115,7 +1115,7 @@ EntitySetsApi <- R6::R6Class( ' [%s] ', - paste(sapply(`request_body`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`request_body`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL @@ -1238,7 +1238,7 @@ EntitySetsApi <- R6::R6Class( ' [%s] ', - paste(sapply(`request_body`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`request_body`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL @@ -1357,7 +1357,7 @@ EntitySetsApi <- R6::R6Class( ' [%s] ', - paste(sapply(`request_body`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`request_body`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL diff --git a/R/R/entity_type.R b/R/R/entity_type.R index eb0eb23..297a329 100644 --- a/R/R/entity_type.R +++ b/R/R/entity_type.R @@ -8,11 +8,8 @@ #' @docType class #' @title EntityType -#' #' @description EntityType Class -#' #' @format An \code{R6Class} generator object -#' #' @field title character [optional] #' #' @field description character [optional] @@ -27,12 +24,13 @@ #' #' @field properties list( character ) [optional] #' -#' @field propertyTags named list( array[character] ) [optional] +#' @field propertyTags named list( \link{array[character]} ) [optional] #' #' @field basetype character [optional] #' #' @field category character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -49,9 +47,7 @@ EntityType <- R6::R6Class( `propertyTags` = NULL, `basetype` = NULL, `category` = NULL, - initialize = function( - `title`=NULL, `description`=NULL, `id`=NULL, `type`=NULL, `schemas`=NULL, `key`=NULL, `properties`=NULL, `propertyTags`=NULL, `basetype`=NULL, `category`=NULL, ... - ) { + initialize = function(`title`=NULL, `description`=NULL, `id`=NULL, `type`=NULL, `schemas`=NULL, `key`=NULL, `properties`=NULL, `propertyTags`=NULL, `basetype`=NULL, `category`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`title`)) { stopifnot(is.character(`title`), length(`title`) == 1) @@ -86,7 +82,7 @@ EntityType <- R6::R6Class( } if (!is.null(`propertyTags`)) { stopifnot(is.vector(`propertyTags`)) - sapply(`propertyTags`, function(x) stopifnot(is.character(x))) + sapply(`propertyTags`, function(x) stopifnot(R6::is.R6(x))) self$`propertyTags` <- `propertyTags` } if (!is.null(`basetype`)) { @@ -130,7 +126,7 @@ EntityType <- R6::R6Class( } if (!is.null(self$`propertyTags`)) { EntityTypeObject[['propertyTags']] <- - self$`propertyTags` + lapply(self$`propertyTags`, function(x) x$toJSON()) } if (!is.null(self$`basetype`)) { EntityTypeObject[['basetype']] <- @@ -177,7 +173,6 @@ EntityType <- R6::R6Class( if (!is.null(EntityTypeObject$`category`)) { self$`category` <- EntityTypeObject$`category` } - self }, toJSONString = function() { jsoncontent <- c( @@ -233,9 +228,9 @@ EntityType <- R6::R6Class( if (!is.null(self$`propertyTags`)) { sprintf( '"propertyTags": - %s - ', - jsonlite::toJSON(lapply(self$`propertyTags`, function(x){ x }), auto_unbox = TRUE, digits=NA) + %s +', + jsonlite::toJSON(lapply(self$`propertyTags`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) )}, if (!is.null(self$`basetype`)) { sprintf( @@ -271,4 +266,3 @@ EntityType <- R6::R6Class( } ) ) - diff --git a/R/R/entity_type_collection.R b/R/R/entity_type_collection.R new file mode 100644 index 0000000..2a4dd1c --- /dev/null +++ b/R/R/entity_type_collection.R @@ -0,0 +1,178 @@ +# OpenLattice API +# +# OpenLattice API +# +# The version of the OpenAPI document: 0.0.1 +# Contact: support@openlattice.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title EntityTypeCollection +#' @description EntityTypeCollection Class +#' @format An \code{R6Class} generator object +#' @field id character [optional] +#' +#' @field type \link{FullQualifiedName} [optional] +#' +#' @field title character [optional] +#' +#' @field description character [optional] +#' +#' @field schemas list( \link{FullQualifiedName} ) [optional] +#' +#' @field template list( \link{CollectionTemplateType} ) [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +EntityTypeCollection <- R6::R6Class( + 'EntityTypeCollection', + public = list( + `id` = NULL, + `type` = NULL, + `title` = NULL, + `description` = NULL, + `schemas` = NULL, + `template` = NULL, + initialize = function(`id`=NULL, `type`=NULL, `title`=NULL, `description`=NULL, `schemas`=NULL, `template`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`id`)) { + stopifnot(is.character(`id`), length(`id`) == 1) + self$`id` <- `id` + } + if (!is.null(`type`)) { + stopifnot(R6::is.R6(`type`)) + self$`type` <- `type` + } + if (!is.null(`title`)) { + stopifnot(is.character(`title`), length(`title`) == 1) + self$`title` <- `title` + } + if (!is.null(`description`)) { + stopifnot(is.character(`description`), length(`description`) == 1) + self$`description` <- `description` + } + if (!is.null(`schemas`)) { + stopifnot(is.vector(`schemas`)) + sapply(`schemas`, function(x) stopifnot(R6::is.R6(x))) + self$`schemas` <- `schemas` + } + if (!is.null(`template`)) { + stopifnot(is.vector(`template`)) + sapply(`template`, function(x) stopifnot(R6::is.R6(x))) + self$`template` <- `template` + } + }, + toJSON = function() { + EntityTypeCollectionObject <- list() + if (!is.null(self$`id`)) { + EntityTypeCollectionObject[['id']] <- + self$`id` + } + if (!is.null(self$`type`)) { + EntityTypeCollectionObject[['type']] <- + self$`type`$toJSON() + } + if (!is.null(self$`title`)) { + EntityTypeCollectionObject[['title']] <- + self$`title` + } + if (!is.null(self$`description`)) { + EntityTypeCollectionObject[['description']] <- + self$`description` + } + if (!is.null(self$`schemas`)) { + EntityTypeCollectionObject[['schemas']] <- + lapply(self$`schemas`, function(x) x$toJSON()) + } + if (!is.null(self$`template`)) { + EntityTypeCollectionObject[['template']] <- + lapply(self$`template`, function(x) x$toJSON()) + } + + EntityTypeCollectionObject + }, + fromJSON = function(EntityTypeCollectionJson) { + EntityTypeCollectionObject <- jsonlite::fromJSON(EntityTypeCollectionJson) + if (!is.null(EntityTypeCollectionObject$`id`)) { + self$`id` <- EntityTypeCollectionObject$`id` + } + if (!is.null(EntityTypeCollectionObject$`type`)) { + typeObject <- FullQualifiedName$new() + typeObject$fromJSON(jsonlite::toJSON(EntityTypeCollectionObject$type, auto_unbox = TRUE, digits = NA)) + self$`type` <- typeObject + } + if (!is.null(EntityTypeCollectionObject$`title`)) { + self$`title` <- EntityTypeCollectionObject$`title` + } + if (!is.null(EntityTypeCollectionObject$`description`)) { + self$`description` <- EntityTypeCollectionObject$`description` + } + if (!is.null(EntityTypeCollectionObject$`schemas`)) { + self$`schemas` <- ApiClient$new()$deserializeObj(EntityTypeCollectionObject$`schemas`, "array[FullQualifiedName]", loadNamespace("openlattice")) + } + if (!is.null(EntityTypeCollectionObject$`template`)) { + self$`template` <- ApiClient$new()$deserializeObj(EntityTypeCollectionObject$`template`, "array[CollectionTemplateType]", loadNamespace("openlattice")) + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`id`)) { + sprintf( + '"id": + "%s" + ', + self$`id` + )}, + if (!is.null(self$`type`)) { + sprintf( + '"type": + %s + ', + jsonlite::toJSON(self$`type`$toJSON(), auto_unbox=TRUE, digits = NA) + )}, + if (!is.null(self$`title`)) { + sprintf( + '"title": + "%s" + ', + self$`title` + )}, + if (!is.null(self$`description`)) { + sprintf( + '"description": + "%s" + ', + self$`description` + )}, + if (!is.null(self$`schemas`)) { + sprintf( + '"schemas": + [%s] +', + paste(sapply(self$`schemas`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") + )}, + if (!is.null(self$`template`)) { + sprintf( + '"template": + [%s] +', + paste(sapply(self$`template`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(EntityTypeCollectionJson) { + EntityTypeCollectionObject <- jsonlite::fromJSON(EntityTypeCollectionJson) + self$`id` <- EntityTypeCollectionObject$`id` + self$`type` <- FullQualifiedName$new()$fromJSON(jsonlite::toJSON(EntityTypeCollectionObject$type, auto_unbox = TRUE, digits = NA)) + self$`title` <- EntityTypeCollectionObject$`title` + self$`description` <- EntityTypeCollectionObject$`description` + self$`schemas` <- ApiClient$new()$deserializeObj(EntityTypeCollectionObject$`schemas`, "array[FullQualifiedName]", loadNamespace("openlattice")) + self$`template` <- ApiClient$new()$deserializeObj(EntityTypeCollectionObject$`template`, "array[CollectionTemplateType]", loadNamespace("openlattice")) + self + } + ) +) diff --git a/R/R/entity_type_property_metadata.R b/R/R/entity_type_property_metadata.R index 98e4d17..a895c3e 100644 --- a/R/R/entity_type_property_metadata.R +++ b/R/R/entity_type_property_metadata.R @@ -8,15 +8,13 @@ #' @docType class #' @title EntityTypePropertyMetadata -#' #' @description EntityTypePropertyMetadata Class -#' #' @format An \code{R6Class} generator object -#' #' @field title character [optional] #' #' @field description character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ EntityTypePropertyMetadata <- R6::R6Class( public = list( `title` = NULL, `description` = NULL, - initialize = function( - `title`=NULL, `description`=NULL, ... - ) { + initialize = function(`title`=NULL, `description`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`title`)) { stopifnot(is.character(`title`), length(`title`) == 1) @@ -59,7 +55,6 @@ EntityTypePropertyMetadata <- R6::R6Class( if (!is.null(EntityTypePropertyMetadataObject$`description`)) { self$`description` <- EntityTypePropertyMetadataObject$`description` } - self }, toJSONString = function() { jsoncontent <- c( @@ -89,4 +84,3 @@ EntityTypePropertyMetadata <- R6::R6Class( } ) ) - diff --git a/R/R/flight.R b/R/R/flight.R new file mode 100644 index 0000000..62aa2ad --- /dev/null +++ b/R/R/flight.R @@ -0,0 +1,155 @@ +# OpenLattice API +# +# OpenLattice API +# +# The version of the OpenAPI document: 0.0.1 +# Contact: support@openlattice.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title Flight +#' @description Flight Class +#' @format An \code{R6Class} generator object +#' @field name character [optional] +#' +#' @field tags list( character ) [optional] +#' +#' @field organizationId character [optional] +#' +#' @field entityDefinitions named list( \link{EntityDefinition} ) [optional] +#' +#' @field associationDefinitions named list( \link{AssociationDefinition} ) [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +Flight <- R6::R6Class( + 'Flight', + public = list( + `name` = NULL, + `tags` = NULL, + `organizationId` = NULL, + `entityDefinitions` = NULL, + `associationDefinitions` = NULL, + initialize = function(`name`=NULL, `tags`=NULL, `organizationId`=NULL, `entityDefinitions`=NULL, `associationDefinitions`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`name`)) { + stopifnot(is.character(`name`), length(`name`) == 1) + self$`name` <- `name` + } + if (!is.null(`tags`)) { + stopifnot(is.vector(`tags`)) + sapply(`tags`, function(x) stopifnot(is.character(x))) + self$`tags` <- `tags` + } + if (!is.null(`organizationId`)) { + stopifnot(is.character(`organizationId`), length(`organizationId`) == 1) + self$`organizationId` <- `organizationId` + } + if (!is.null(`entityDefinitions`)) { + stopifnot(is.vector(`entityDefinitions`)) + sapply(`entityDefinitions`, function(x) stopifnot(R6::is.R6(x))) + self$`entityDefinitions` <- `entityDefinitions` + } + if (!is.null(`associationDefinitions`)) { + stopifnot(is.vector(`associationDefinitions`)) + sapply(`associationDefinitions`, function(x) stopifnot(R6::is.R6(x))) + self$`associationDefinitions` <- `associationDefinitions` + } + }, + toJSON = function() { + FlightObject <- list() + if (!is.null(self$`name`)) { + FlightObject[['name']] <- + self$`name` + } + if (!is.null(self$`tags`)) { + FlightObject[['tags']] <- + self$`tags` + } + if (!is.null(self$`organizationId`)) { + FlightObject[['organizationId']] <- + self$`organizationId` + } + if (!is.null(self$`entityDefinitions`)) { + FlightObject[['entityDefinitions']] <- + lapply(self$`entityDefinitions`, function(x) x$toJSON()) + } + if (!is.null(self$`associationDefinitions`)) { + FlightObject[['associationDefinitions']] <- + lapply(self$`associationDefinitions`, function(x) x$toJSON()) + } + + FlightObject + }, + fromJSON = function(FlightJson) { + FlightObject <- jsonlite::fromJSON(FlightJson) + if (!is.null(FlightObject$`name`)) { + self$`name` <- FlightObject$`name` + } + if (!is.null(FlightObject$`tags`)) { + self$`tags` <- ApiClient$new()$deserializeObj(FlightObject$`tags`, "array[character]", loadNamespace("openlattice")) + } + if (!is.null(FlightObject$`organizationId`)) { + self$`organizationId` <- FlightObject$`organizationId` + } + if (!is.null(FlightObject$`entityDefinitions`)) { + self$`entityDefinitions` <- ApiClient$new()$deserializeObj(FlightObject$`entityDefinitions`, "list(EntityDefinition)", loadNamespace("openlattice")) + } + if (!is.null(FlightObject$`associationDefinitions`)) { + self$`associationDefinitions` <- ApiClient$new()$deserializeObj(FlightObject$`associationDefinitions`, "list(AssociationDefinition)", loadNamespace("openlattice")) + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`name`)) { + sprintf( + '"name": + "%s" + ', + self$`name` + )}, + if (!is.null(self$`tags`)) { + sprintf( + '"tags": + [%s] + ', + paste(unlist(lapply(self$`tags`, function(x) paste0('"', x, '"'))), collapse=",") + )}, + if (!is.null(self$`organizationId`)) { + sprintf( + '"organizationId": + "%s" + ', + self$`organizationId` + )}, + if (!is.null(self$`entityDefinitions`)) { + sprintf( + '"entityDefinitions": + %s +', + jsonlite::toJSON(lapply(self$`entityDefinitions`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) + )}, + if (!is.null(self$`associationDefinitions`)) { + sprintf( + '"associationDefinitions": + %s +', + jsonlite::toJSON(lapply(self$`associationDefinitions`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(FlightJson) { + FlightObject <- jsonlite::fromJSON(FlightJson) + self$`name` <- FlightObject$`name` + self$`tags` <- ApiClient$new()$deserializeObj(FlightObject$`tags`, "array[character]", loadNamespace("openlattice")) + self$`organizationId` <- FlightObject$`organizationId` + self$`entityDefinitions` <- ApiClient$new()$deserializeObj(FlightObject$`entityDefinitions`, "list(EntityDefinition)", loadNamespace("openlattice")) + self$`associationDefinitions` <- ApiClient$new()$deserializeObj(FlightObject$`associationDefinitions`, "list(AssociationDefinition)", loadNamespace("openlattice")) + self + } + ) +) diff --git a/R/R/flight_plan_parameters.R b/R/R/flight_plan_parameters.R new file mode 100644 index 0000000..f8faba2 --- /dev/null +++ b/R/R/flight_plan_parameters.R @@ -0,0 +1,156 @@ +# OpenLattice API +# +# OpenLattice API +# +# The version of the OpenAPI document: 0.0.1 +# Contact: support@openlattice.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title FlightPlanParameters +#' @description FlightPlanParameters Class +#' @format An \code{R6Class} generator object +#' @field sql character [optional] +#' +#' @field src named list( character ) [optional] +#' +#' @field srcPrimaryKeyColumns list( character ) [optional] +#' +#' @field path character [optional] +#' +#' @field flight \link{Flight} [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +FlightPlanParameters <- R6::R6Class( + 'FlightPlanParameters', + public = list( + `sql` = NULL, + `src` = NULL, + `srcPrimaryKeyColumns` = NULL, + `path` = NULL, + `flight` = NULL, + initialize = function(`sql`=NULL, `src`=NULL, `srcPrimaryKeyColumns`=NULL, `path`=NULL, `flight`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`sql`)) { + stopifnot(is.character(`sql`), length(`sql`) == 1) + self$`sql` <- `sql` + } + if (!is.null(`src`)) { + stopifnot(is.vector(`src`)) + sapply(`src`, function(x) stopifnot(is.character(x))) + self$`src` <- `src` + } + if (!is.null(`srcPrimaryKeyColumns`)) { + stopifnot(is.vector(`srcPrimaryKeyColumns`)) + sapply(`srcPrimaryKeyColumns`, function(x) stopifnot(is.character(x))) + self$`srcPrimaryKeyColumns` <- `srcPrimaryKeyColumns` + } + if (!is.null(`path`)) { + stopifnot(is.character(`path`), length(`path`) == 1) + self$`path` <- `path` + } + if (!is.null(`flight`)) { + stopifnot(R6::is.R6(`flight`)) + self$`flight` <- `flight` + } + }, + toJSON = function() { + FlightPlanParametersObject <- list() + if (!is.null(self$`sql`)) { + FlightPlanParametersObject[['sql']] <- + self$`sql` + } + if (!is.null(self$`src`)) { + FlightPlanParametersObject[['src']] <- + self$`src` + } + if (!is.null(self$`srcPrimaryKeyColumns`)) { + FlightPlanParametersObject[['srcPrimaryKeyColumns']] <- + self$`srcPrimaryKeyColumns` + } + if (!is.null(self$`path`)) { + FlightPlanParametersObject[['path']] <- + self$`path` + } + if (!is.null(self$`flight`)) { + FlightPlanParametersObject[['flight']] <- + self$`flight`$toJSON() + } + + FlightPlanParametersObject + }, + fromJSON = function(FlightPlanParametersJson) { + FlightPlanParametersObject <- jsonlite::fromJSON(FlightPlanParametersJson) + if (!is.null(FlightPlanParametersObject$`sql`)) { + self$`sql` <- FlightPlanParametersObject$`sql` + } + if (!is.null(FlightPlanParametersObject$`src`)) { + self$`src` <- ApiClient$new()$deserializeObj(FlightPlanParametersObject$`src`, "list(character)", loadNamespace("openlattice")) + } + if (!is.null(FlightPlanParametersObject$`srcPrimaryKeyColumns`)) { + self$`srcPrimaryKeyColumns` <- ApiClient$new()$deserializeObj(FlightPlanParametersObject$`srcPrimaryKeyColumns`, "array[character]", loadNamespace("openlattice")) + } + if (!is.null(FlightPlanParametersObject$`path`)) { + self$`path` <- FlightPlanParametersObject$`path` + } + if (!is.null(FlightPlanParametersObject$`flight`)) { + flightObject <- Flight$new() + flightObject$fromJSON(jsonlite::toJSON(FlightPlanParametersObject$flight, auto_unbox = TRUE, digits = NA)) + self$`flight` <- flightObject + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`sql`)) { + sprintf( + '"sql": + "%s" + ', + self$`sql` + )}, + if (!is.null(self$`src`)) { + sprintf( + '"src": + %s + ', + jsonlite::toJSON(lapply(self$`src`, function(x){ x }), auto_unbox = TRUE, digits=NA) + )}, + if (!is.null(self$`srcPrimaryKeyColumns`)) { + sprintf( + '"srcPrimaryKeyColumns": + [%s] + ', + paste(unlist(lapply(self$`srcPrimaryKeyColumns`, function(x) paste0('"', x, '"'))), collapse=",") + )}, + if (!is.null(self$`path`)) { + sprintf( + '"path": + "%s" + ', + self$`path` + )}, + if (!is.null(self$`flight`)) { + sprintf( + '"flight": + %s + ', + jsonlite::toJSON(self$`flight`$toJSON(), auto_unbox=TRUE, digits = NA) + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(FlightPlanParametersJson) { + FlightPlanParametersObject <- jsonlite::fromJSON(FlightPlanParametersJson) + self$`sql` <- FlightPlanParametersObject$`sql` + self$`src` <- ApiClient$new()$deserializeObj(FlightPlanParametersObject$`src`, "list(character)", loadNamespace("openlattice")) + self$`srcPrimaryKeyColumns` <- ApiClient$new()$deserializeObj(FlightPlanParametersObject$`srcPrimaryKeyColumns`, "array[character]", loadNamespace("openlattice")) + self$`path` <- FlightPlanParametersObject$`path` + self$`flight` <- Flight$new()$fromJSON(jsonlite::toJSON(FlightPlanParametersObject$flight, auto_unbox = TRUE, digits = NA)) + self + } + ) +) diff --git a/R/R/flight_plan_parameters_update.R b/R/R/flight_plan_parameters_update.R new file mode 100644 index 0000000..fdf1197 --- /dev/null +++ b/R/R/flight_plan_parameters_update.R @@ -0,0 +1,132 @@ +# OpenLattice API +# +# OpenLattice API +# +# The version of the OpenAPI document: 0.0.1 +# Contact: support@openlattice.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title FlightPlanParametersUpdate +#' @description FlightPlanParametersUpdate Class +#' @format An \code{R6Class} generator object +#' @field sql character [optional] +#' +#' @field src named list( character ) [optional] +#' +#' @field srcPrimaryKeyColumns list( character ) [optional] +#' +#' @field path character [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +FlightPlanParametersUpdate <- R6::R6Class( + 'FlightPlanParametersUpdate', + public = list( + `sql` = NULL, + `src` = NULL, + `srcPrimaryKeyColumns` = NULL, + `path` = NULL, + initialize = function(`sql`=NULL, `src`=NULL, `srcPrimaryKeyColumns`=NULL, `path`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`sql`)) { + stopifnot(is.character(`sql`), length(`sql`) == 1) + self$`sql` <- `sql` + } + if (!is.null(`src`)) { + stopifnot(is.vector(`src`)) + sapply(`src`, function(x) stopifnot(is.character(x))) + self$`src` <- `src` + } + if (!is.null(`srcPrimaryKeyColumns`)) { + stopifnot(is.vector(`srcPrimaryKeyColumns`)) + sapply(`srcPrimaryKeyColumns`, function(x) stopifnot(is.character(x))) + self$`srcPrimaryKeyColumns` <- `srcPrimaryKeyColumns` + } + if (!is.null(`path`)) { + stopifnot(is.character(`path`), length(`path`) == 1) + self$`path` <- `path` + } + }, + toJSON = function() { + FlightPlanParametersUpdateObject <- list() + if (!is.null(self$`sql`)) { + FlightPlanParametersUpdateObject[['sql']] <- + self$`sql` + } + if (!is.null(self$`src`)) { + FlightPlanParametersUpdateObject[['src']] <- + self$`src` + } + if (!is.null(self$`srcPrimaryKeyColumns`)) { + FlightPlanParametersUpdateObject[['srcPrimaryKeyColumns']] <- + self$`srcPrimaryKeyColumns` + } + if (!is.null(self$`path`)) { + FlightPlanParametersUpdateObject[['path']] <- + self$`path` + } + + FlightPlanParametersUpdateObject + }, + fromJSON = function(FlightPlanParametersUpdateJson) { + FlightPlanParametersUpdateObject <- jsonlite::fromJSON(FlightPlanParametersUpdateJson) + if (!is.null(FlightPlanParametersUpdateObject$`sql`)) { + self$`sql` <- FlightPlanParametersUpdateObject$`sql` + } + if (!is.null(FlightPlanParametersUpdateObject$`src`)) { + self$`src` <- ApiClient$new()$deserializeObj(FlightPlanParametersUpdateObject$`src`, "list(character)", loadNamespace("openlattice")) + } + if (!is.null(FlightPlanParametersUpdateObject$`srcPrimaryKeyColumns`)) { + self$`srcPrimaryKeyColumns` <- ApiClient$new()$deserializeObj(FlightPlanParametersUpdateObject$`srcPrimaryKeyColumns`, "array[character]", loadNamespace("openlattice")) + } + if (!is.null(FlightPlanParametersUpdateObject$`path`)) { + self$`path` <- FlightPlanParametersUpdateObject$`path` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`sql`)) { + sprintf( + '"sql": + "%s" + ', + self$`sql` + )}, + if (!is.null(self$`src`)) { + sprintf( + '"src": + %s + ', + jsonlite::toJSON(lapply(self$`src`, function(x){ x }), auto_unbox = TRUE, digits=NA) + )}, + if (!is.null(self$`srcPrimaryKeyColumns`)) { + sprintf( + '"srcPrimaryKeyColumns": + [%s] + ', + paste(unlist(lapply(self$`srcPrimaryKeyColumns`, function(x) paste0('"', x, '"'))), collapse=",") + )}, + if (!is.null(self$`path`)) { + sprintf( + '"path": + "%s" + ', + self$`path` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(FlightPlanParametersUpdateJson) { + FlightPlanParametersUpdateObject <- jsonlite::fromJSON(FlightPlanParametersUpdateJson) + self$`sql` <- FlightPlanParametersUpdateObject$`sql` + self$`src` <- ApiClient$new()$deserializeObj(FlightPlanParametersUpdateObject$`src`, "list(character)", loadNamespace("openlattice")) + self$`srcPrimaryKeyColumns` <- ApiClient$new()$deserializeObj(FlightPlanParametersUpdateObject$`srcPrimaryKeyColumns`, "array[character]", loadNamespace("openlattice")) + self$`path` <- FlightPlanParametersUpdateObject$`path` + self + } + ) +) diff --git a/R/R/full_qualified_name.R b/R/R/full_qualified_name.R index e18133f..c790219 100644 --- a/R/R/full_qualified_name.R +++ b/R/R/full_qualified_name.R @@ -8,15 +8,13 @@ #' @docType class #' @title FullQualifiedName -#' #' @description FullQualifiedName Class -#' #' @format An \code{R6Class} generator object -#' #' @field name character [optional] #' #' @field namespace character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ FullQualifiedName <- R6::R6Class( public = list( `name` = NULL, `namespace` = NULL, - initialize = function( - `name`=NULL, `namespace`=NULL, ... - ) { + initialize = function(`name`=NULL, `namespace`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`name`)) { stopifnot(is.character(`name`), length(`name`) == 1) @@ -59,7 +55,6 @@ FullQualifiedName <- R6::R6Class( if (!is.null(FullQualifiedNameObject$`namespace`)) { self$`namespace` <- FullQualifiedNameObject$`namespace` } - self }, toJSONString = function() { jsoncontent <- c( @@ -89,4 +84,3 @@ FullQualifiedName <- R6::R6Class( } ) ) - diff --git a/R/R/indexing_state.R b/R/R/indexing_state.R index ff18714..6f59342 100644 --- a/R/R/indexing_state.R +++ b/R/R/indexing_state.R @@ -8,12 +8,9 @@ #' @docType class #' @title IndexingState -#' #' @description IndexingState Class -#' #' @format An \code{R6Class} generator object -#' -#' @field indexing named list( array[character] ) [optional] +#' @field indexing named list( \link{array[character]} ) [optional] #' #' @field queue list( character ) [optional] #' @@ -23,6 +20,7 @@ #' #' @field count integer [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -34,13 +32,11 @@ IndexingState <- R6::R6Class( `currentEntitySet` = NULL, `queueSize` = NULL, `count` = NULL, - initialize = function( - `indexing`=NULL, `queue`=NULL, `currentEntitySet`=NULL, `queueSize`=NULL, `count`=NULL, ... - ) { + initialize = function(`indexing`=NULL, `queue`=NULL, `currentEntitySet`=NULL, `queueSize`=NULL, `count`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`indexing`)) { stopifnot(is.vector(`indexing`)) - sapply(`indexing`, function(x) stopifnot(is.character(x))) + sapply(`indexing`, function(x) stopifnot(R6::is.R6(x))) self$`indexing` <- `indexing` } if (!is.null(`queue`)) { @@ -65,7 +61,7 @@ IndexingState <- R6::R6Class( IndexingStateObject <- list() if (!is.null(self$`indexing`)) { IndexingStateObject[['indexing']] <- - self$`indexing` + lapply(self$`indexing`, function(x) x$toJSON()) } if (!is.null(self$`queue`)) { IndexingStateObject[['queue']] <- @@ -103,16 +99,15 @@ IndexingState <- R6::R6Class( if (!is.null(IndexingStateObject$`count`)) { self$`count` <- IndexingStateObject$`count` } - self }, toJSONString = function() { jsoncontent <- c( if (!is.null(self$`indexing`)) { sprintf( '"indexing": - %s - ', - jsonlite::toJSON(lapply(self$`indexing`, function(x){ x }), auto_unbox = TRUE, digits=NA) + %s +', + jsonlite::toJSON(lapply(self$`indexing`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) )}, if (!is.null(self$`queue`)) { sprintf( @@ -157,4 +152,3 @@ IndexingState <- R6::R6Class( } ) ) - diff --git a/R/R/inline_object.R b/R/R/inline_object.R index 7facac8..a2b6667 100644 --- a/R/R/inline_object.R +++ b/R/R/inline_object.R @@ -8,13 +8,11 @@ #' @docType class #' @title InlineObject -#' #' @description InlineObject Class -#' #' @format An \code{R6Class} generator object -#' #' @field additionalProperties list( \link{DataEdge} ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -22,9 +20,7 @@ InlineObject <- R6::R6Class( 'InlineObject', public = list( `additionalProperties` = NULL, - initialize = function( - `additionalProperties`=NULL, ... - ) { + initialize = function(`additionalProperties`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`additionalProperties`)) { stopifnot(is.vector(`additionalProperties`)) @@ -46,7 +42,6 @@ InlineObject <- R6::R6Class( if (!is.null(InlineObjectObject$`additionalProperties`)) { self$`additionalProperties` <- ApiClient$new()$deserializeObj(InlineObjectObject$`additionalProperties`, "array[DataEdge]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -68,4 +63,3 @@ InlineObject <- R6::R6Class( } ) ) - diff --git a/R/R/inline_response200.R b/R/R/inline_response200.R index 76b7cce..2431786 100644 --- a/R/R/inline_response200.R +++ b/R/R/inline_response200.R @@ -8,15 +8,13 @@ #' @docType class #' @title InlineResponse200 -#' #' @description InlineResponse200 Class -#' #' @format An \code{R6Class} generator object -#' #' @field user character [optional] #' #' @field credential character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ InlineResponse200 <- R6::R6Class( public = list( `user` = NULL, `credential` = NULL, - initialize = function( - `user`=NULL, `credential`=NULL, ... - ) { + initialize = function(`user`=NULL, `credential`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`user`)) { stopifnot(is.character(`user`), length(`user`) == 1) @@ -59,7 +55,6 @@ InlineResponse200 <- R6::R6Class( if (!is.null(InlineResponse200Object$`credential`)) { self$`credential` <- InlineResponse200Object$`credential` } - self }, toJSONString = function() { jsoncontent <- c( @@ -89,4 +84,3 @@ InlineResponse200 <- R6::R6Class( } ) ) - diff --git a/R/R/integration.R b/R/R/integration.R new file mode 100644 index 0000000..b4eabad --- /dev/null +++ b/R/R/integration.R @@ -0,0 +1,243 @@ +# OpenLattice API +# +# OpenLattice API +# +# The version of the OpenAPI document: 0.0.1 +# Contact: support@openlattice.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title Integration +#' @description Integration Class +#' @format An \code{R6Class} generator object +#' @field key character [optional] +#' +#' @field environment character [optional] +#' +#' @field s3Bucket character [optional] +#' +#' @field contacts list( character ) [optional] +#' +#' @field organizationId character [optional] +#' +#' @field entitySetId character [optional] +#' +#' @field maxConnections integer [optional] +#' +#' @field callback list( character ) [optional] +#' +#' @field flightPlanParameters named list( \link{FlightPlanParameters} ) [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +Integration <- R6::R6Class( + 'Integration', + public = list( + `key` = NULL, + `environment` = NULL, + `s3Bucket` = NULL, + `contacts` = NULL, + `organizationId` = NULL, + `entitySetId` = NULL, + `maxConnections` = NULL, + `callback` = NULL, + `flightPlanParameters` = NULL, + initialize = function(`key`=NULL, `environment`=NULL, `s3Bucket`=NULL, `contacts`=NULL, `organizationId`=NULL, `entitySetId`=NULL, `maxConnections`=NULL, `callback`=NULL, `flightPlanParameters`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`key`)) { + stopifnot(is.character(`key`), length(`key`) == 1) + self$`key` <- `key` + } + if (!is.null(`environment`)) { + stopifnot(is.character(`environment`), length(`environment`) == 1) + self$`environment` <- `environment` + } + if (!is.null(`s3Bucket`)) { + stopifnot(is.character(`s3Bucket`), length(`s3Bucket`) == 1) + self$`s3Bucket` <- `s3Bucket` + } + if (!is.null(`contacts`)) { + stopifnot(is.vector(`contacts`)) + sapply(`contacts`, function(x) stopifnot(is.character(x))) + self$`contacts` <- `contacts` + } + if (!is.null(`organizationId`)) { + stopifnot(is.character(`organizationId`), length(`organizationId`) == 1) + self$`organizationId` <- `organizationId` + } + if (!is.null(`entitySetId`)) { + stopifnot(is.character(`entitySetId`), length(`entitySetId`) == 1) + self$`entitySetId` <- `entitySetId` + } + if (!is.null(`maxConnections`)) { + stopifnot(is.numeric(`maxConnections`), length(`maxConnections`) == 1) + self$`maxConnections` <- `maxConnections` + } + if (!is.null(`callback`)) { + stopifnot(is.vector(`callback`)) + sapply(`callback`, function(x) stopifnot(is.character(x))) + self$`callback` <- `callback` + } + if (!is.null(`flightPlanParameters`)) { + stopifnot(is.vector(`flightPlanParameters`)) + sapply(`flightPlanParameters`, function(x) stopifnot(R6::is.R6(x))) + self$`flightPlanParameters` <- `flightPlanParameters` + } + }, + toJSON = function() { + IntegrationObject <- list() + if (!is.null(self$`key`)) { + IntegrationObject[['key']] <- + self$`key` + } + if (!is.null(self$`environment`)) { + IntegrationObject[['environment']] <- + self$`environment` + } + if (!is.null(self$`s3Bucket`)) { + IntegrationObject[['s3Bucket']] <- + self$`s3Bucket` + } + if (!is.null(self$`contacts`)) { + IntegrationObject[['contacts']] <- + self$`contacts` + } + if (!is.null(self$`organizationId`)) { + IntegrationObject[['organizationId']] <- + self$`organizationId` + } + if (!is.null(self$`entitySetId`)) { + IntegrationObject[['entitySetId']] <- + self$`entitySetId` + } + if (!is.null(self$`maxConnections`)) { + IntegrationObject[['maxConnections']] <- + self$`maxConnections` + } + if (!is.null(self$`callback`)) { + IntegrationObject[['callback']] <- + self$`callback` + } + if (!is.null(self$`flightPlanParameters`)) { + IntegrationObject[['flightPlanParameters']] <- + lapply(self$`flightPlanParameters`, function(x) x$toJSON()) + } + + IntegrationObject + }, + fromJSON = function(IntegrationJson) { + IntegrationObject <- jsonlite::fromJSON(IntegrationJson) + if (!is.null(IntegrationObject$`key`)) { + self$`key` <- IntegrationObject$`key` + } + if (!is.null(IntegrationObject$`environment`)) { + self$`environment` <- IntegrationObject$`environment` + } + if (!is.null(IntegrationObject$`s3Bucket`)) { + self$`s3Bucket` <- IntegrationObject$`s3Bucket` + } + if (!is.null(IntegrationObject$`contacts`)) { + self$`contacts` <- ApiClient$new()$deserializeObj(IntegrationObject$`contacts`, "array[character]", loadNamespace("openlattice")) + } + if (!is.null(IntegrationObject$`organizationId`)) { + self$`organizationId` <- IntegrationObject$`organizationId` + } + if (!is.null(IntegrationObject$`entitySetId`)) { + self$`entitySetId` <- IntegrationObject$`entitySetId` + } + if (!is.null(IntegrationObject$`maxConnections`)) { + self$`maxConnections` <- IntegrationObject$`maxConnections` + } + if (!is.null(IntegrationObject$`callback`)) { + self$`callback` <- ApiClient$new()$deserializeObj(IntegrationObject$`callback`, "array[character]", loadNamespace("openlattice")) + } + if (!is.null(IntegrationObject$`flightPlanParameters`)) { + self$`flightPlanParameters` <- ApiClient$new()$deserializeObj(IntegrationObject$`flightPlanParameters`, "list(FlightPlanParameters)", loadNamespace("openlattice")) + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`key`)) { + sprintf( + '"key": + "%s" + ', + self$`key` + )}, + if (!is.null(self$`environment`)) { + sprintf( + '"environment": + "%s" + ', + self$`environment` + )}, + if (!is.null(self$`s3Bucket`)) { + sprintf( + '"s3Bucket": + "%s" + ', + self$`s3Bucket` + )}, + if (!is.null(self$`contacts`)) { + sprintf( + '"contacts": + [%s] + ', + paste(unlist(lapply(self$`contacts`, function(x) paste0('"', x, '"'))), collapse=",") + )}, + if (!is.null(self$`organizationId`)) { + sprintf( + '"organizationId": + "%s" + ', + self$`organizationId` + )}, + if (!is.null(self$`entitySetId`)) { + sprintf( + '"entitySetId": + "%s" + ', + self$`entitySetId` + )}, + if (!is.null(self$`maxConnections`)) { + sprintf( + '"maxConnections": + %d + ', + self$`maxConnections` + )}, + if (!is.null(self$`callback`)) { + sprintf( + '"callback": + [%s] + ', + paste(unlist(lapply(self$`callback`, function(x) paste0('"', x, '"'))), collapse=",") + )}, + if (!is.null(self$`flightPlanParameters`)) { + sprintf( + '"flightPlanParameters": + %s +', + jsonlite::toJSON(lapply(self$`flightPlanParameters`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(IntegrationJson) { + IntegrationObject <- jsonlite::fromJSON(IntegrationJson) + self$`key` <- IntegrationObject$`key` + self$`environment` <- IntegrationObject$`environment` + self$`s3Bucket` <- IntegrationObject$`s3Bucket` + self$`contacts` <- ApiClient$new()$deserializeObj(IntegrationObject$`contacts`, "array[character]", loadNamespace("openlattice")) + self$`organizationId` <- IntegrationObject$`organizationId` + self$`entitySetId` <- IntegrationObject$`entitySetId` + self$`maxConnections` <- IntegrationObject$`maxConnections` + self$`callback` <- ApiClient$new()$deserializeObj(IntegrationObject$`callback`, "array[character]", loadNamespace("openlattice")) + self$`flightPlanParameters` <- ApiClient$new()$deserializeObj(IntegrationObject$`flightPlanParameters`, "list(FlightPlanParameters)", loadNamespace("openlattice")) + self + } + ) +) diff --git a/R/R/integration_job.R b/R/R/integration_job.R new file mode 100644 index 0000000..7968db7 --- /dev/null +++ b/R/R/integration_job.R @@ -0,0 +1,86 @@ +# OpenLattice API +# +# OpenLattice API +# +# The version of the OpenAPI document: 0.0.1 +# Contact: support@openlattice.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title IntegrationJob +#' @description IntegrationJob Class +#' @format An \code{R6Class} generator object +#' @field name character [optional] +#' +#' @field status character [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +IntegrationJob <- R6::R6Class( + 'IntegrationJob', + public = list( + `name` = NULL, + `status` = NULL, + initialize = function(`name`=NULL, `status`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`name`)) { + stopifnot(is.character(`name`), length(`name`) == 1) + self$`name` <- `name` + } + if (!is.null(`status`)) { + stopifnot(is.character(`status`), length(`status`) == 1) + self$`status` <- `status` + } + }, + toJSON = function() { + IntegrationJobObject <- list() + if (!is.null(self$`name`)) { + IntegrationJobObject[['name']] <- + self$`name` + } + if (!is.null(self$`status`)) { + IntegrationJobObject[['status']] <- + self$`status` + } + + IntegrationJobObject + }, + fromJSON = function(IntegrationJobJson) { + IntegrationJobObject <- jsonlite::fromJSON(IntegrationJobJson) + if (!is.null(IntegrationJobObject$`name`)) { + self$`name` <- IntegrationJobObject$`name` + } + if (!is.null(IntegrationJobObject$`status`)) { + self$`status` <- IntegrationJobObject$`status` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`name`)) { + sprintf( + '"name": + "%s" + ', + self$`name` + )}, + if (!is.null(self$`status`)) { + sprintf( + '"status": + "%s" + ', + self$`status` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(IntegrationJobJson) { + IntegrationJobObject <- jsonlite::fromJSON(IntegrationJobJson) + self$`name` <- IntegrationJobObject$`name` + self$`status` <- IntegrationJobObject$`status` + self + } + ) +) diff --git a/R/R/integration_results.R b/R/R/integration_results.R index 921f504..92de05b 100644 --- a/R/R/integration_results.R +++ b/R/R/integration_results.R @@ -8,11 +8,8 @@ #' @docType class #' @title IntegrationResults -#' #' @description IntegrationResults Class -#' #' @format An \code{R6Class} generator object -#' #' @field entityCount integer [optional] #' #' @field associationCount integer [optional] @@ -21,6 +18,7 @@ #' #' @field entitySetsEntityKeyMappings named list( list(character) ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -31,9 +29,7 @@ IntegrationResults <- R6::R6Class( `associationCount` = NULL, `associationsEntityKeyMappings` = NULL, `entitySetsEntityKeyMappings` = NULL, - initialize = function( - `entityCount`=NULL, `associationCount`=NULL, `associationsEntityKeyMappings`=NULL, `entitySetsEntityKeyMappings`=NULL, ... - ) { + initialize = function(`entityCount`=NULL, `associationCount`=NULL, `associationsEntityKeyMappings`=NULL, `entitySetsEntityKeyMappings`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`entityCount`)) { stopifnot(is.numeric(`entityCount`), length(`entityCount`) == 1) @@ -89,7 +85,6 @@ IntegrationResults <- R6::R6Class( if (!is.null(IntegrationResultsObject$`entitySetsEntityKeyMappings`)) { self$`entitySetsEntityKeyMappings` <- ApiClient$new()$deserializeObj(IntegrationResultsObject$`entitySetsEntityKeyMappings`, "list(list(character))", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -135,4 +130,3 @@ IntegrationResults <- R6::R6Class( } ) ) - diff --git a/R/R/integration_update.R b/R/R/integration_update.R new file mode 100644 index 0000000..d6c6a44 --- /dev/null +++ b/R/R/integration_update.R @@ -0,0 +1,199 @@ +# OpenLattice API +# +# OpenLattice API +# +# The version of the OpenAPI document: 0.0.1 +# Contact: support@openlattice.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title IntegrationUpdate +#' @description IntegrationUpdate Class +#' @format An \code{R6Class} generator object +#' @field environment character [optional] +#' +#' @field s3Bucket character [optional] +#' +#' @field contacts list( character ) [optional] +#' +#' @field organizationId character [optional] +#' +#' @field maxConnections integer [optional] +#' +#' @field callbackUrls list( character ) [optional] +#' +#' @field flightPlanParameters named list( \link{FlightPlanParametersUpdate} ) [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +IntegrationUpdate <- R6::R6Class( + 'IntegrationUpdate', + public = list( + `environment` = NULL, + `s3Bucket` = NULL, + `contacts` = NULL, + `organizationId` = NULL, + `maxConnections` = NULL, + `callbackUrls` = NULL, + `flightPlanParameters` = NULL, + initialize = function(`environment`=NULL, `s3Bucket`=NULL, `contacts`=NULL, `organizationId`=NULL, `maxConnections`=NULL, `callbackUrls`=NULL, `flightPlanParameters`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`environment`)) { + stopifnot(is.character(`environment`), length(`environment`) == 1) + self$`environment` <- `environment` + } + if (!is.null(`s3Bucket`)) { + stopifnot(is.character(`s3Bucket`), length(`s3Bucket`) == 1) + self$`s3Bucket` <- `s3Bucket` + } + if (!is.null(`contacts`)) { + stopifnot(is.vector(`contacts`)) + sapply(`contacts`, function(x) stopifnot(is.character(x))) + self$`contacts` <- `contacts` + } + if (!is.null(`organizationId`)) { + stopifnot(is.character(`organizationId`), length(`organizationId`) == 1) + self$`organizationId` <- `organizationId` + } + if (!is.null(`maxConnections`)) { + stopifnot(is.numeric(`maxConnections`), length(`maxConnections`) == 1) + self$`maxConnections` <- `maxConnections` + } + if (!is.null(`callbackUrls`)) { + stopifnot(is.vector(`callbackUrls`)) + sapply(`callbackUrls`, function(x) stopifnot(is.character(x))) + self$`callbackUrls` <- `callbackUrls` + } + if (!is.null(`flightPlanParameters`)) { + stopifnot(is.vector(`flightPlanParameters`)) + sapply(`flightPlanParameters`, function(x) stopifnot(R6::is.R6(x))) + self$`flightPlanParameters` <- `flightPlanParameters` + } + }, + toJSON = function() { + IntegrationUpdateObject <- list() + if (!is.null(self$`environment`)) { + IntegrationUpdateObject[['environment']] <- + self$`environment` + } + if (!is.null(self$`s3Bucket`)) { + IntegrationUpdateObject[['s3Bucket']] <- + self$`s3Bucket` + } + if (!is.null(self$`contacts`)) { + IntegrationUpdateObject[['contacts']] <- + self$`contacts` + } + if (!is.null(self$`organizationId`)) { + IntegrationUpdateObject[['organizationId']] <- + self$`organizationId` + } + if (!is.null(self$`maxConnections`)) { + IntegrationUpdateObject[['maxConnections']] <- + self$`maxConnections` + } + if (!is.null(self$`callbackUrls`)) { + IntegrationUpdateObject[['callbackUrls']] <- + self$`callbackUrls` + } + if (!is.null(self$`flightPlanParameters`)) { + IntegrationUpdateObject[['flightPlanParameters']] <- + lapply(self$`flightPlanParameters`, function(x) x$toJSON()) + } + + IntegrationUpdateObject + }, + fromJSON = function(IntegrationUpdateJson) { + IntegrationUpdateObject <- jsonlite::fromJSON(IntegrationUpdateJson) + if (!is.null(IntegrationUpdateObject$`environment`)) { + self$`environment` <- IntegrationUpdateObject$`environment` + } + if (!is.null(IntegrationUpdateObject$`s3Bucket`)) { + self$`s3Bucket` <- IntegrationUpdateObject$`s3Bucket` + } + if (!is.null(IntegrationUpdateObject$`contacts`)) { + self$`contacts` <- ApiClient$new()$deserializeObj(IntegrationUpdateObject$`contacts`, "array[character]", loadNamespace("openlattice")) + } + if (!is.null(IntegrationUpdateObject$`organizationId`)) { + self$`organizationId` <- IntegrationUpdateObject$`organizationId` + } + if (!is.null(IntegrationUpdateObject$`maxConnections`)) { + self$`maxConnections` <- IntegrationUpdateObject$`maxConnections` + } + if (!is.null(IntegrationUpdateObject$`callbackUrls`)) { + self$`callbackUrls` <- ApiClient$new()$deserializeObj(IntegrationUpdateObject$`callbackUrls`, "array[character]", loadNamespace("openlattice")) + } + if (!is.null(IntegrationUpdateObject$`flightPlanParameters`)) { + self$`flightPlanParameters` <- ApiClient$new()$deserializeObj(IntegrationUpdateObject$`flightPlanParameters`, "list(FlightPlanParametersUpdate)", loadNamespace("openlattice")) + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`environment`)) { + sprintf( + '"environment": + "%s" + ', + self$`environment` + )}, + if (!is.null(self$`s3Bucket`)) { + sprintf( + '"s3Bucket": + "%s" + ', + self$`s3Bucket` + )}, + if (!is.null(self$`contacts`)) { + sprintf( + '"contacts": + [%s] + ', + paste(unlist(lapply(self$`contacts`, function(x) paste0('"', x, '"'))), collapse=",") + )}, + if (!is.null(self$`organizationId`)) { + sprintf( + '"organizationId": + "%s" + ', + self$`organizationId` + )}, + if (!is.null(self$`maxConnections`)) { + sprintf( + '"maxConnections": + %d + ', + self$`maxConnections` + )}, + if (!is.null(self$`callbackUrls`)) { + sprintf( + '"callbackUrls": + [%s] + ', + paste(unlist(lapply(self$`callbackUrls`, function(x) paste0('"', x, '"'))), collapse=",") + )}, + if (!is.null(self$`flightPlanParameters`)) { + sprintf( + '"flightPlanParameters": + %s +', + jsonlite::toJSON(lapply(self$`flightPlanParameters`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(IntegrationUpdateJson) { + IntegrationUpdateObject <- jsonlite::fromJSON(IntegrationUpdateJson) + self$`environment` <- IntegrationUpdateObject$`environment` + self$`s3Bucket` <- IntegrationUpdateObject$`s3Bucket` + self$`contacts` <- ApiClient$new()$deserializeObj(IntegrationUpdateObject$`contacts`, "array[character]", loadNamespace("openlattice")) + self$`organizationId` <- IntegrationUpdateObject$`organizationId` + self$`maxConnections` <- IntegrationUpdateObject$`maxConnections` + self$`callbackUrls` <- ApiClient$new()$deserializeObj(IntegrationUpdateObject$`callbackUrls`, "array[character]", loadNamespace("openlattice")) + self$`flightPlanParameters` <- ApiClient$new()$deserializeObj(IntegrationUpdateObject$`flightPlanParameters`, "list(FlightPlanParametersUpdate)", loadNamespace("openlattice")) + self + } + ) +) diff --git a/R/R/linking_feedback.R b/R/R/linking_feedback.R index 9eafd4a..055120f 100644 --- a/R/R/linking_feedback.R +++ b/R/R/linking_feedback.R @@ -8,17 +8,15 @@ #' @docType class #' @title LinkingFeedback -#' #' @description LinkingFeedback Class -#' #' @format An \code{R6Class} generator object -#' #' @field linkingEntity \link{EntityDataKey} [optional] #' #' @field link list( \link{EntityDataKey} ) [optional] #' #' @field unlink list( \link{EntityDataKey} ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -28,9 +26,7 @@ LinkingFeedback <- R6::R6Class( `linkingEntity` = NULL, `link` = NULL, `unlink` = NULL, - initialize = function( - `linkingEntity`=NULL, `link`=NULL, `unlink`=NULL, ... - ) { + initialize = function(`linkingEntity`=NULL, `link`=NULL, `unlink`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`linkingEntity`)) { stopifnot(R6::is.R6(`linkingEntity`)) @@ -77,7 +73,6 @@ LinkingFeedback <- R6::R6Class( if (!is.null(LinkingFeedbackObject$`unlink`)) { self$`unlink` <- ApiClient$new()$deserializeObj(LinkingFeedbackObject$`unlink`, "array[EntityDataKey]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -115,4 +110,3 @@ LinkingFeedback <- R6::R6Class( } ) ) - diff --git a/R/R/materialized_view_account.R b/R/R/materialized_view_account.R index 1d95b95..36dd8d5 100644 --- a/R/R/materialized_view_account.R +++ b/R/R/materialized_view_account.R @@ -8,15 +8,13 @@ #' @docType class #' @title MaterializedViewAccount -#' #' @description MaterializedViewAccount Class -#' #' @format An \code{R6Class} generator object -#' #' @field username character [optional] #' #' @field credential character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ MaterializedViewAccount <- R6::R6Class( public = list( `username` = NULL, `credential` = NULL, - initialize = function( - `username`=NULL, `credential`=NULL, ... - ) { + initialize = function(`username`=NULL, `credential`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`username`)) { stopifnot(is.character(`username`), length(`username`) == 1) @@ -59,7 +55,6 @@ MaterializedViewAccount <- R6::R6Class( if (!is.null(MaterializedViewAccountObject$`credential`)) { self$`credential` <- MaterializedViewAccountObject$`credential` } - self }, toJSONString = function() { jsoncontent <- c( @@ -89,4 +84,3 @@ MaterializedViewAccount <- R6::R6Class( } ) ) - diff --git a/R/R/metadata_update.R b/R/R/metadata_update.R index ddbf628..9f15de5 100644 --- a/R/R/metadata_update.R +++ b/R/R/metadata_update.R @@ -8,11 +8,8 @@ #' @docType class #' @title MetadataUpdate -#' #' @description MetadataUpdate Class -#' #' @format An \code{R6Class} generator object -#' #' @field title character [optional] #' #' @field description character [optional] @@ -29,7 +26,7 @@ #' #' @field url character [optional] #' -#' @field propertyTags named list( array[character] ) [optional] +#' @field propertyTags named list( \link{array[character]} ) [optional] #' #' @field indexType character [optional] #' @@ -39,6 +36,7 @@ #' #' @field enumValues list( character ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -58,9 +56,7 @@ MetadataUpdate <- R6::R6Class( `organizationId` = NULL, `partitions` = NULL, `enumValues` = NULL, - initialize = function( - `title`=NULL, `description`=NULL, `name`=NULL, `contacts`=NULL, `type`=NULL, `pii`=NULL, `defaultShow`=NULL, `url`=NULL, `propertyTags`=NULL, `indexType`=NULL, `organizationId`=NULL, `partitions`=NULL, `enumValues`=NULL, ... - ) { + initialize = function(`title`=NULL, `description`=NULL, `name`=NULL, `contacts`=NULL, `type`=NULL, `pii`=NULL, `defaultShow`=NULL, `url`=NULL, `propertyTags`=NULL, `indexType`=NULL, `organizationId`=NULL, `partitions`=NULL, `enumValues`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`title`)) { stopifnot(is.character(`title`), length(`title`) == 1) @@ -95,7 +91,7 @@ MetadataUpdate <- R6::R6Class( } if (!is.null(`propertyTags`)) { stopifnot(is.vector(`propertyTags`)) - sapply(`propertyTags`, function(x) stopifnot(is.character(x))) + sapply(`propertyTags`, function(x) stopifnot(R6::is.R6(x))) self$`propertyTags` <- `propertyTags` } if (!is.null(`indexType`)) { @@ -153,7 +149,7 @@ MetadataUpdate <- R6::R6Class( } if (!is.null(self$`propertyTags`)) { MetadataUpdateObject[['propertyTags']] <- - self$`propertyTags` + lapply(self$`propertyTags`, function(x) x$toJSON()) } if (!is.null(self$`indexType`)) { MetadataUpdateObject[['indexType']] <- @@ -217,7 +213,6 @@ MetadataUpdate <- R6::R6Class( if (!is.null(MetadataUpdateObject$`enumValues`)) { self$`enumValues` <- ApiClient$new()$deserializeObj(MetadataUpdateObject$`enumValues`, "array[character]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -280,9 +275,9 @@ MetadataUpdate <- R6::R6Class( if (!is.null(self$`propertyTags`)) { sprintf( '"propertyTags": - %s - ', - jsonlite::toJSON(lapply(self$`propertyTags`, function(x){ x }), auto_unbox = TRUE, digits=NA) + %s +', + jsonlite::toJSON(lapply(self$`propertyTags`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) )}, if (!is.null(self$`indexType`)) { sprintf( @@ -335,4 +330,3 @@ MetadataUpdate <- R6::R6Class( } ) ) - diff --git a/R/R/neighbor_entity_details.R b/R/R/neighbor_entity_details.R index 5da577b..9667679 100644 --- a/R/R/neighbor_entity_details.R +++ b/R/R/neighbor_entity_details.R @@ -8,20 +8,18 @@ #' @docType class #' @title NeighborEntityDetails -#' #' @description NeighborEntityDetails Class -#' #' @format An \code{R6Class} generator object -#' #' @field associationEntitySet \link{EntitySet} [optional] #' -#' @field associationDetails named list( array[character] ) [optional] +#' @field associationDetails named list( \link{array[character]} ) [optional] #' #' @field neighborEntitySet \link{EntitySet} [optional] #' #' @field neighborId character [optional] #' -#' @field neighborDetails named list( array[character] ) [optional] +#' @field neighborDetails named list( \link{array[character]} ) [optional] +#' #' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON @@ -34,9 +32,7 @@ NeighborEntityDetails <- R6::R6Class( `neighborEntitySet` = NULL, `neighborId` = NULL, `neighborDetails` = NULL, - initialize = function( - `associationEntitySet`=NULL, `associationDetails`=NULL, `neighborEntitySet`=NULL, `neighborId`=NULL, `neighborDetails`=NULL, ... - ) { + initialize = function(`associationEntitySet`=NULL, `associationDetails`=NULL, `neighborEntitySet`=NULL, `neighborId`=NULL, `neighborDetails`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`associationEntitySet`)) { stopifnot(R6::is.R6(`associationEntitySet`)) @@ -44,7 +40,7 @@ NeighborEntityDetails <- R6::R6Class( } if (!is.null(`associationDetails`)) { stopifnot(is.vector(`associationDetails`)) - sapply(`associationDetails`, function(x) stopifnot(is.character(x))) + sapply(`associationDetails`, function(x) stopifnot(R6::is.R6(x))) self$`associationDetails` <- `associationDetails` } if (!is.null(`neighborEntitySet`)) { @@ -57,7 +53,7 @@ NeighborEntityDetails <- R6::R6Class( } if (!is.null(`neighborDetails`)) { stopifnot(is.vector(`neighborDetails`)) - sapply(`neighborDetails`, function(x) stopifnot(is.character(x))) + sapply(`neighborDetails`, function(x) stopifnot(R6::is.R6(x))) self$`neighborDetails` <- `neighborDetails` } }, @@ -69,7 +65,7 @@ NeighborEntityDetails <- R6::R6Class( } if (!is.null(self$`associationDetails`)) { NeighborEntityDetailsObject[['associationDetails']] <- - self$`associationDetails` + lapply(self$`associationDetails`, function(x) x$toJSON()) } if (!is.null(self$`neighborEntitySet`)) { NeighborEntityDetailsObject[['neighborEntitySet']] <- @@ -81,7 +77,7 @@ NeighborEntityDetails <- R6::R6Class( } if (!is.null(self$`neighborDetails`)) { NeighborEntityDetailsObject[['neighborDetails']] <- - self$`neighborDetails` + lapply(self$`neighborDetails`, function(x) x$toJSON()) } NeighborEntityDetailsObject @@ -107,7 +103,6 @@ NeighborEntityDetails <- R6::R6Class( if (!is.null(NeighborEntityDetailsObject$`neighborDetails`)) { self$`neighborDetails` <- ApiClient$new()$deserializeObj(NeighborEntityDetailsObject$`neighborDetails`, "list(array[character])", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -121,9 +116,9 @@ NeighborEntityDetails <- R6::R6Class( if (!is.null(self$`associationDetails`)) { sprintf( '"associationDetails": - %s - ', - jsonlite::toJSON(lapply(self$`associationDetails`, function(x){ x }), auto_unbox = TRUE, digits=NA) + %s +', + jsonlite::toJSON(lapply(self$`associationDetails`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) )}, if (!is.null(self$`neighborEntitySet`)) { sprintf( @@ -142,9 +137,9 @@ NeighborEntityDetails <- R6::R6Class( if (!is.null(self$`neighborDetails`)) { sprintf( '"neighborDetails": - %s - ', - jsonlite::toJSON(lapply(self$`neighborDetails`, function(x){ x }), auto_unbox = TRUE, digits=NA) + %s +', + jsonlite::toJSON(lapply(self$`neighborDetails`, function(x){ x$toJSON() }), auto_unbox = TRUE, digits=NA) )} ) jsoncontent <- paste(jsoncontent, collapse = ",") @@ -161,4 +156,3 @@ NeighborEntityDetails <- R6::R6Class( } ) ) - diff --git a/R/R/neighbor_entity_ids.R b/R/R/neighbor_entity_ids.R index 3fc4be3..c0bc5a9 100644 --- a/R/R/neighbor_entity_ids.R +++ b/R/R/neighbor_entity_ids.R @@ -8,17 +8,15 @@ #' @docType class #' @title NeighborEntityIds -#' #' @description NeighborEntityIds Class -#' #' @format An \code{R6Class} generator object -#' #' @field associationId character [optional] #' #' @field neighborId character [optional] #' #' @field src character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -28,9 +26,7 @@ NeighborEntityIds <- R6::R6Class( `associationId` = NULL, `neighborId` = NULL, `src` = NULL, - initialize = function( - `associationId`=NULL, `neighborId`=NULL, `src`=NULL, ... - ) { + initialize = function(`associationId`=NULL, `neighborId`=NULL, `src`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`associationId`)) { stopifnot(is.character(`associationId`), length(`associationId`) == 1) @@ -72,7 +68,6 @@ NeighborEntityIds <- R6::R6Class( if (!is.null(NeighborEntityIdsObject$`src`)) { self$`src` <- NeighborEntityIdsObject$`src` } - self }, toJSONString = function() { jsoncontent <- c( @@ -110,4 +105,3 @@ NeighborEntityIds <- R6::R6Class( } ) ) - diff --git a/R/R/neighbor_search_filter.R b/R/R/neighbor_search_filter.R index a704787..8b1325c 100644 --- a/R/R/neighbor_search_filter.R +++ b/R/R/neighbor_search_filter.R @@ -8,11 +8,8 @@ #' @docType class #' @title NeighborSearchFilter -#' #' @description NeighborSearchFilter Class -#' #' @format An \code{R6Class} generator object -#' #' @field entityKeyIds list( character ) [optional] #' #' @field src list( character ) [optional] @@ -21,6 +18,7 @@ #' #' @field edge list( character ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -31,9 +29,7 @@ NeighborSearchFilter <- R6::R6Class( `src` = NULL, `dst` = NULL, `edge` = NULL, - initialize = function( - `entityKeyIds`=NULL, `src`=NULL, `dst`=NULL, `edge`=NULL, ... - ) { + initialize = function(`entityKeyIds`=NULL, `src`=NULL, `dst`=NULL, `edge`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`entityKeyIds`)) { stopifnot(is.vector(`entityKeyIds`)) @@ -91,7 +87,6 @@ NeighborSearchFilter <- R6::R6Class( if (!is.null(NeighborSearchFilterObject$`edge`)) { self$`edge` <- ApiClient$new()$deserializeObj(NeighborSearchFilterObject$`edge`, "array[character]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -137,4 +132,3 @@ NeighborSearchFilter <- R6::R6Class( } ) ) - diff --git a/R/R/organization.R b/R/R/organization.R index a99762e..50fefb0 100644 --- a/R/R/organization.R +++ b/R/R/organization.R @@ -8,11 +8,8 @@ #' @docType class #' @title Organization -#' #' @description Organization Class -#' #' @format An \code{R6Class} generator object -#' #' @field id character [optional] #' #' @field principal \link{Principal} [optional] @@ -33,6 +30,7 @@ #' #' @field partitions list( integer ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -49,9 +47,7 @@ Organization <- R6::R6Class( `apps` = NULL, `smsEntitySetInfo` = NULL, `partitions` = NULL, - initialize = function( - `id`=NULL, `principal`=NULL, `title`=NULL, `description`=NULL, `emails`=NULL, `members`=NULL, `roles`=NULL, `apps`=NULL, `smsEntitySetInfo`=NULL, `partitions`=NULL, ... - ) { + initialize = function(`id`=NULL, `principal`=NULL, `title`=NULL, `description`=NULL, `emails`=NULL, `members`=NULL, `roles`=NULL, `apps`=NULL, `smsEntitySetInfo`=NULL, `partitions`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`id`)) { stopifnot(is.character(`id`), length(`id`) == 1) @@ -179,7 +175,6 @@ Organization <- R6::R6Class( if (!is.null(OrganizationObject$`partitions`)) { self$`partitions` <- ApiClient$new()$deserializeObj(OrganizationObject$`partitions`, "array[integer]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -273,4 +268,3 @@ Organization <- R6::R6Class( } ) ) - diff --git a/R/R/organization_external_database_column.R b/R/R/organization_external_database_column.R index 3f506fe..a56f94d 100644 --- a/R/R/organization_external_database_column.R +++ b/R/R/organization_external_database_column.R @@ -8,11 +8,8 @@ #' @docType class #' @title OrganizationExternalDatabaseColumn -#' #' @description OrganizationExternalDatabaseColumn Class -#' #' @format An \code{R6Class} generator object -#' #' @field id character [optional] #' #' @field name character [optional] @@ -31,6 +28,7 @@ #' #' @field ordinalPosition integer [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -46,9 +44,7 @@ OrganizationExternalDatabaseColumn <- R6::R6Class( `dataType` = NULL, `primaryKey` = NULL, `ordinalPosition` = NULL, - initialize = function( - `id`=NULL, `name`=NULL, `title`=NULL, `description`=NULL, `tableId`=NULL, `organizationId`=NULL, `dataType`=NULL, `primaryKey`=NULL, `ordinalPosition`=NULL, ... - ) { + initialize = function(`id`=NULL, `name`=NULL, `title`=NULL, `description`=NULL, `tableId`=NULL, `organizationId`=NULL, `dataType`=NULL, `primaryKey`=NULL, `ordinalPosition`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`id`)) { stopifnot(is.character(`id`), length(`id`) == 1) @@ -156,7 +152,6 @@ OrganizationExternalDatabaseColumn <- R6::R6Class( if (!is.null(OrganizationExternalDatabaseColumnObject$`ordinalPosition`)) { self$`ordinalPosition` <- OrganizationExternalDatabaseColumnObject$`ordinalPosition` } - self }, toJSONString = function() { jsoncontent <- c( @@ -242,4 +237,3 @@ OrganizationExternalDatabaseColumn <- R6::R6Class( } ) ) - diff --git a/R/R/organization_external_database_table.R b/R/R/organization_external_database_table.R index 72342e8..1cf4d7d 100644 --- a/R/R/organization_external_database_table.R +++ b/R/R/organization_external_database_table.R @@ -8,11 +8,8 @@ #' @docType class #' @title OrganizationExternalDatabaseTable -#' #' @description OrganizationExternalDatabaseTable Class -#' #' @format An \code{R6Class} generator object -#' #' @field id character [optional] #' #' @field name character [optional] @@ -23,6 +20,7 @@ #' #' @field organizationId character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -34,9 +32,7 @@ OrganizationExternalDatabaseTable <- R6::R6Class( `title` = NULL, `description` = NULL, `organizationId` = NULL, - initialize = function( - `id`=NULL, `name`=NULL, `title`=NULL, `description`=NULL, `organizationId`=NULL, ... - ) { + initialize = function(`id`=NULL, `name`=NULL, `title`=NULL, `description`=NULL, `organizationId`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`id`)) { stopifnot(is.character(`id`), length(`id`) == 1) @@ -101,7 +97,6 @@ OrganizationExternalDatabaseTable <- R6::R6Class( if (!is.null(OrganizationExternalDatabaseTableObject$`organizationId`)) { self$`organizationId` <- OrganizationExternalDatabaseTableObject$`organizationId` } - self }, toJSONString = function() { jsoncontent <- c( @@ -155,4 +150,3 @@ OrganizationExternalDatabaseTable <- R6::R6Class( } ) ) - diff --git a/R/R/organization_external_database_table_columns_pair.R b/R/R/organization_external_database_table_columns_pair.R index 5ea47e8..d0f2376 100644 --- a/R/R/organization_external_database_table_columns_pair.R +++ b/R/R/organization_external_database_table_columns_pair.R @@ -8,15 +8,13 @@ #' @docType class #' @title OrganizationExternalDatabaseTableColumnsPair -#' #' @description OrganizationExternalDatabaseTableColumnsPair Class -#' #' @format An \code{R6Class} generator object -#' #' @field table \link{OrganizationExternalDatabaseTable} [optional] #' #' @field columns list( \link{OrganizationExternalDatabaseColumn} ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ OrganizationExternalDatabaseTableColumnsPair <- R6::R6Class( public = list( `table` = NULL, `columns` = NULL, - initialize = function( - `table`=NULL, `columns`=NULL, ... - ) { + initialize = function(`table`=NULL, `columns`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`table`)) { stopifnot(R6::is.R6(`table`)) @@ -62,7 +58,6 @@ OrganizationExternalDatabaseTableColumnsPair <- R6::R6Class( if (!is.null(OrganizationExternalDatabaseTableColumnsPairObject$`columns`)) { self$`columns` <- ApiClient$new()$deserializeObj(OrganizationExternalDatabaseTableColumnsPairObject$`columns`, "array[OrganizationExternalDatabaseColumn]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -92,4 +87,3 @@ OrganizationExternalDatabaseTableColumnsPair <- R6::R6Class( } ) ) - diff --git a/R/R/organization_member.R b/R/R/organization_member.R index 67a3ecb..6ac7494 100644 --- a/R/R/organization_member.R +++ b/R/R/organization_member.R @@ -8,17 +8,15 @@ #' @docType class #' @title OrganizationMember -#' #' @description OrganizationMember Class -#' #' @format An \code{R6Class} generator object -#' #' @field principal \link{SecurablePrincipal} [optional] #' #' @field profile \link{Auth0userBasic} [optional] #' #' @field roles list( \link{SecurablePrincipal} ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -28,9 +26,7 @@ OrganizationMember <- R6::R6Class( `principal` = NULL, `profile` = NULL, `roles` = NULL, - initialize = function( - `principal`=NULL, `profile`=NULL, `roles`=NULL, ... - ) { + initialize = function(`principal`=NULL, `profile`=NULL, `roles`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`principal`)) { stopifnot(R6::is.R6(`principal`)) @@ -78,7 +74,6 @@ OrganizationMember <- R6::R6Class( if (!is.null(OrganizationMemberObject$`roles`)) { self$`roles` <- ApiClient$new()$deserializeObj(OrganizationMemberObject$`roles`, "array[SecurablePrincipal]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -116,4 +111,3 @@ OrganizationMember <- R6::R6Class( } ) ) - diff --git a/R/R/organizations_api.R b/R/R/organizations_api.R index 28acfe0..474c7a5 100644 --- a/R/R/organizations_api.R +++ b/R/R/organizations_api.R @@ -55,6 +55,7 @@ #' \itemize{ #' \item \emph{ @param } organization_id \link{character} #' \item \emph{ @param } request_body named list( \link{list(integer)} ) +#' \item \emph{ @returnType } named list( \link{array} ) \cr #' #' #' \item status code : 200 | Success @@ -221,6 +222,7 @@ #' #' \itemize{ #' \item \emph{ @param } organization_id \link{character} +#' \item \emph{ @returnType } named list( \link{array} ) \cr #' #' #' \item status code : 200 | Success @@ -668,7 +670,7 @@ #' #' library(openlattice) #' var.organization_id <- 'organization_id_example' # character | -#' var.request_body <- NULL # list(array[character]) | +#' var.request_body <- {'key' => array$new()} # list(array[character]) | #' #' #Get the entity sets for an organization for a certain flag #' api.instance <- OrganizationsApi$new() @@ -2156,7 +2158,7 @@ OrganizationsApi <- R6::R6Class( ' [%s] ', - paste(sapply(`request_body`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`request_body`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL @@ -2345,7 +2347,7 @@ OrganizationsApi <- R6::R6Class( ' [%s] ', - paste(sapply(`request_body`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`request_body`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL diff --git a/R/R/permissions_api.R b/R/R/permissions_api.R index e12a489..356c3e9 100644 --- a/R/R/permissions_api.R +++ b/R/R/permissions_api.R @@ -136,7 +136,7 @@ PermissionsApi <- R6::R6Class( ' [%s] ', - paste(sapply(`request_body`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + paste(sapply(`request_body`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") ) } else { body <- NULL diff --git a/R/R/principal.R b/R/R/principal.R index 837782f..4bdfe1f 100644 --- a/R/R/principal.R +++ b/R/R/principal.R @@ -8,15 +8,13 @@ #' @docType class #' @title Principal -#' #' @description Principal Class -#' #' @format An \code{R6Class} generator object -#' #' @field type character [optional] #' #' @field id character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ Principal <- R6::R6Class( public = list( `type` = NULL, `id` = NULL, - initialize = function( - `type`=NULL, `id`=NULL, ... - ) { + initialize = function(`type`=NULL, `id`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`type`)) { stopifnot(is.character(`type`), length(`type`) == 1) @@ -59,7 +55,6 @@ Principal <- R6::R6Class( if (!is.null(PrincipalObject$`id`)) { self$`id` <- PrincipalObject$`id` } - self }, toJSONString = function() { jsoncontent <- c( @@ -89,4 +84,3 @@ Principal <- R6::R6Class( } ) ) - diff --git a/R/R/principal_api.R b/R/R/principal_api.R index eee5fb2..5d799b9 100644 --- a/R/R/principal_api.R +++ b/R/R/principal_api.R @@ -79,6 +79,23 @@ #' } #' } #' +#' \strong{ search_all_users } \emph{ Get the user id for the given search. } +#' +#' +#' \itemize{ +#' \item \emph{ @param } search_query character +#' \item \emph{ @returnType } named list( \link{Auth0userBasic} ) \cr +#' +#' +#' \item status code : 200 | Success +#' +#' \item return type : list(Auth0userBasic) +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' #' \strong{ search_all_users_by_email } \emph{ Get the user id for the given email address. } #' #' @@ -96,6 +113,21 @@ #' } #' } #' +#' \strong{ sync_calling_user } \emph{ Activates a user in the OpenLattice system. This call must be made once before a user will be available for use in authorization policies. } +#' +#' +#' \itemize{ +#' +#' +#' \item status code : 200 | Success +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' #' } #' #' @@ -178,6 +210,26 @@ #' result <- api.instance$get_user(var.user_id) #' #' +#' #################### search_all_users #################### +#' +#' library(openlattice) +#' var.search_query <- 'search_query_example' # character | +#' +#' #Get the user id for the given search. +#' api.instance <- PrincipalApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$search_all_users(var.search_query) +#' +#' #' #################### search_all_users_by_email #################### #' #' library(openlattice) @@ -198,6 +250,25 @@ #' result <- api.instance$search_all_users_by_email(var.email_address) #' #' +#' #################### sync_calling_user #################### +#' +#' library(openlattice) +#' +#' #Activates a user in the OpenLattice system. This call must be made once before a user will be available for use in authorization policies. +#' api.instance <- PrincipalApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$sync_calling_user() +#' +#' #' } #' @importFrom R6 R6Class #' @importFrom base64enc base64encode @@ -414,6 +485,62 @@ PrincipalApi <- R6::R6Class( ApiResponse$new("API server error", resp) } }, + search_all_users = function(search_query, ...){ + apiResponse <- self$search_all_usersWithHttpInfo(search_query, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + search_all_usersWithHttpInfo = function(search_query, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`search_query`)) { + stop("Missing required parameter `search_query`.") + } + + urlPath <- "/datastore/principals/users/search/"{searchQuery}"" + if (!missing(`search_query`)) { + urlPath <- gsub(paste0("\\{", "searchQuery", "\\}"), URLencode(as.character(`search_query`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "list(Auth0userBasic)", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, search_all_users_by_email = function(email_address, ...){ apiResponse <- self$search_all_users_by_emailWithHttpInfo(email_address, ...) resp <- apiResponse$response @@ -469,6 +596,48 @@ PrincipalApi <- R6::R6Class( } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { ApiResponse$new("API server error", resp) } + }, + sync_calling_user = function(...){ + apiResponse <- self$sync_calling_userWithHttpInfo(...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + sync_calling_userWithHttpInfo = function(...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + urlPath <- "/datastore/principals/sync/" + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } } ) ) diff --git a/R/R/property_definition.R b/R/R/property_definition.R new file mode 100644 index 0000000..4780859 --- /dev/null +++ b/R/R/property_definition.R @@ -0,0 +1,88 @@ +# OpenLattice API +# +# OpenLattice API +# +# The version of the OpenAPI document: 0.0.1 +# Contact: support@openlattice.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title PropertyDefinition +#' @description PropertyDefinition Class +#' @format An \code{R6Class} generator object +#' @field type \link{FullQualifiedName} [optional] +#' +#' @field column character [optional] +#' +#' +#' @importFrom R6 R6Class +#' @importFrom jsonlite fromJSON toJSON +#' @export +PropertyDefinition <- R6::R6Class( + 'PropertyDefinition', + public = list( + `type` = NULL, + `column` = NULL, + initialize = function(`type`=NULL, `column`=NULL, ...){ + local.optional.var <- list(...) + if (!is.null(`type`)) { + stopifnot(R6::is.R6(`type`)) + self$`type` <- `type` + } + if (!is.null(`column`)) { + stopifnot(is.character(`column`), length(`column`) == 1) + self$`column` <- `column` + } + }, + toJSON = function() { + PropertyDefinitionObject <- list() + if (!is.null(self$`type`)) { + PropertyDefinitionObject[['type']] <- + self$`type`$toJSON() + } + if (!is.null(self$`column`)) { + PropertyDefinitionObject[['column']] <- + self$`column` + } + + PropertyDefinitionObject + }, + fromJSON = function(PropertyDefinitionJson) { + PropertyDefinitionObject <- jsonlite::fromJSON(PropertyDefinitionJson) + if (!is.null(PropertyDefinitionObject$`type`)) { + typeObject <- FullQualifiedName$new() + typeObject$fromJSON(jsonlite::toJSON(PropertyDefinitionObject$type, auto_unbox = TRUE, digits = NA)) + self$`type` <- typeObject + } + if (!is.null(PropertyDefinitionObject$`column`)) { + self$`column` <- PropertyDefinitionObject$`column` + } + }, + toJSONString = function() { + jsoncontent <- c( + if (!is.null(self$`type`)) { + sprintf( + '"type": + %s + ', + jsonlite::toJSON(self$`type`$toJSON(), auto_unbox=TRUE, digits = NA) + )}, + if (!is.null(self$`column`)) { + sprintf( + '"column": + "%s" + ', + self$`column` + )} + ) + jsoncontent <- paste(jsoncontent, collapse = ",") + paste('{', jsoncontent, '}', sep = "") + }, + fromJSONString = function(PropertyDefinitionJson) { + PropertyDefinitionObject <- jsonlite::fromJSON(PropertyDefinitionJson) + self$`type` <- FullQualifiedName$new()$fromJSON(jsonlite::toJSON(PropertyDefinitionObject$type, auto_unbox = TRUE, digits = NA)) + self$`column` <- PropertyDefinitionObject$`column` + self + } + ) +) diff --git a/R/R/property_type.R b/R/R/property_type.R index 0334f5e..70b7337 100644 --- a/R/R/property_type.R +++ b/R/R/property_type.R @@ -8,11 +8,8 @@ #' @docType class #' @title PropertyType -#' #' @description PropertyType Class -#' #' @format An \code{R6Class} generator object -#' #' @field title character [optional] #' #' @field id character [optional] @@ -35,6 +32,7 @@ #' #' @field indexType character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -52,9 +50,7 @@ PropertyType <- R6::R6Class( `analyzer` = NULL, `enumValues` = NULL, `indexType` = NULL, - initialize = function( - `title`=NULL, `id`=NULL, `type`=NULL, `description`=NULL, `schemas`=NULL, `datatype`=NULL, `pii`=NULL, `multiValued`=NULL, `analyzer`=NULL, `enumValues`=NULL, `indexType`=NULL, ... - ) { + initialize = function(`title`=NULL, `id`=NULL, `type`=NULL, `description`=NULL, `schemas`=NULL, `datatype`=NULL, `pii`=NULL, `multiValued`=NULL, `analyzer`=NULL, `enumValues`=NULL, `indexType`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`title`)) { stopifnot(is.character(`title`), length(`title`) == 1) @@ -187,7 +183,6 @@ PropertyType <- R6::R6Class( if (!is.null(PropertyTypeObject$`indexType`)) { self$`indexType` <- PropertyTypeObject$`indexType` } - self }, toJSONString = function() { jsoncontent <- c( @@ -289,4 +284,3 @@ PropertyType <- R6::R6Class( } ) ) - diff --git a/R/R/property_usage_summary.R b/R/R/property_usage_summary.R index 7482adb..8a16c8a 100644 --- a/R/R/property_usage_summary.R +++ b/R/R/property_usage_summary.R @@ -8,11 +8,8 @@ #' @docType class #' @title PropertyUsageSummary -#' #' @description PropertyUsageSummary Class -#' #' @format An \code{R6Class} generator object -#' #' @field entityTypeId character [optional] #' #' @field entitySetId character [optional] @@ -21,6 +18,7 @@ #' #' @field count integer [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -31,9 +29,7 @@ PropertyUsageSummary <- R6::R6Class( `entitySetId` = NULL, `entitySetName` = NULL, `count` = NULL, - initialize = function( - `entityTypeId`=NULL, `entitySetId`=NULL, `entitySetName`=NULL, `count`=NULL, ... - ) { + initialize = function(`entityTypeId`=NULL, `entitySetId`=NULL, `entitySetName`=NULL, `count`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`entityTypeId`)) { stopifnot(is.character(`entityTypeId`), length(`entityTypeId`) == 1) @@ -87,7 +83,6 @@ PropertyUsageSummary <- R6::R6Class( if (!is.null(PropertyUsageSummaryObject$`count`)) { self$`count` <- PropertyUsageSummaryObject$`count` } - self }, toJSONString = function() { jsoncontent <- c( @@ -133,4 +128,3 @@ PropertyUsageSummary <- R6::R6Class( } ) ) - diff --git a/R/R/role.R b/R/R/role.R index 905f457..4299eff 100644 --- a/R/R/role.R +++ b/R/R/role.R @@ -8,11 +8,8 @@ #' @docType class #' @title Role -#' #' @description Role Class -#' #' @format An \code{R6Class} generator object -#' #' @field id character [optional] #' #' @field organizationId character [optional] @@ -23,7 +20,6 @@ #' #' @field description character [optional] #' -#' @field @class character [optional] #' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON @@ -36,10 +32,7 @@ Role <- R6::R6Class( `principal` = NULL, `title` = NULL, `description` = NULL, - `@class` = NULL, - initialize = function( - `id`=NULL, `organizationId`=NULL, `principal`=NULL, `title`=NULL, `description`=NULL, `@class`=NULL, ... - ) { + initialize = function(`id`=NULL, `organizationId`=NULL, `principal`=NULL, `title`=NULL, `description`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`id`)) { stopifnot(is.character(`id`), length(`id`) == 1) @@ -61,10 +54,6 @@ Role <- R6::R6Class( stopifnot(is.character(`description`), length(`description`) == 1) self$`description` <- `description` } - if (!is.null(`@class`)) { - stopifnot(is.character(`@class`), length(`@class`) == 1) - self$`@class` <- `@class` - } }, toJSON = function() { RoleObject <- list() @@ -88,10 +77,6 @@ Role <- R6::R6Class( RoleObject[['description']] <- self$`description` } - if (!is.null(self$`@class`)) { - RoleObject[['@class']] <- - self$`@class` - } RoleObject }, @@ -114,10 +99,6 @@ Role <- R6::R6Class( if (!is.null(RoleObject$`description`)) { self$`description` <- RoleObject$`description` } - if (!is.null(RoleObject$`@class`)) { - self$`@class` <- RoleObject$`@class` - } - self }, toJSONString = function() { jsoncontent <- c( @@ -155,13 +136,6 @@ Role <- R6::R6Class( "%s" ', self$`description` - )}, - if (!is.null(self$`@class`)) { - sprintf( - '"@class": - "%s" - ', - self$`@class` )} ) jsoncontent <- paste(jsoncontent, collapse = ",") @@ -174,9 +148,7 @@ Role <- R6::R6Class( self$`principal` <- Principal$new()$fromJSON(jsonlite::toJSON(RoleObject$principal, auto_unbox = TRUE, digits = NA)) self$`title` <- RoleObject$`title` self$`description` <- RoleObject$`description` - self$`@class` <- RoleObject$`@class` self } ) ) - diff --git a/R/R/schema.R b/R/R/schema.R index f7759e1..df61ff6 100644 --- a/R/R/schema.R +++ b/R/R/schema.R @@ -8,17 +8,15 @@ #' @docType class #' @title Schema -#' #' @description Schema Class -#' #' @format An \code{R6Class} generator object -#' #' @field entityTypes list( \link{EntityType} ) [optional] #' #' @field propertyTypes list( \link{PropertyType} ) [optional] #' #' @field fqn \link{FullQualifiedName} [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -28,9 +26,7 @@ Schema <- R6::R6Class( `entityTypes` = NULL, `propertyTypes` = NULL, `fqn` = NULL, - initialize = function( - `entityTypes`=NULL, `propertyTypes`=NULL, `fqn`=NULL, ... - ) { + initialize = function(`entityTypes`=NULL, `propertyTypes`=NULL, `fqn`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`entityTypes`)) { stopifnot(is.vector(`entityTypes`)) @@ -77,7 +73,6 @@ Schema <- R6::R6Class( fqnObject$fromJSON(jsonlite::toJSON(SchemaObject$fqn, auto_unbox = TRUE, digits = NA)) self$`fqn` <- fqnObject } - self }, toJSONString = function() { jsoncontent <- c( @@ -115,4 +110,3 @@ Schema <- R6::R6Class( } ) ) - diff --git a/R/R/search.R b/R/R/search.R index fa0c828..16ecf64 100644 --- a/R/R/search.R +++ b/R/R/search.R @@ -8,11 +8,8 @@ #' @docType class #' @title Search -#' #' @description Search Class -#' #' @format An \code{R6Class} generator object -#' #' @field keyword character [optional] #' #' @field entityTypeId character [optional] @@ -23,6 +20,7 @@ #' #' @field maxHits integer [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -34,9 +32,7 @@ Search <- R6::R6Class( `propertyTypeIds` = NULL, `start` = NULL, `maxHits` = NULL, - initialize = function( - `keyword`=NULL, `entityTypeId`=NULL, `propertyTypeIds`=NULL, `start`=NULL, `maxHits`=NULL, ... - ) { + initialize = function(`keyword`=NULL, `entityTypeId`=NULL, `propertyTypeIds`=NULL, `start`=NULL, `maxHits`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`keyword`)) { stopifnot(is.character(`keyword`), length(`keyword`) == 1) @@ -102,7 +98,6 @@ Search <- R6::R6Class( if (!is.null(SearchObject$`maxHits`)) { self$`maxHits` <- SearchObject$`maxHits` } - self }, toJSONString = function() { jsoncontent <- c( @@ -156,4 +151,3 @@ Search <- R6::R6Class( } ) ) - diff --git a/R/R/search_api.R b/R/R/search_api.R index b361461..78fe4ce 100644 --- a/R/R/search_api.R +++ b/R/R/search_api.R @@ -32,6 +32,57 @@ #' } #' } #' +#' \strong{ execute_app_search } \emph{ Executes a search over all apps to find ones that match the given search term } +#' +#' +#' \itemize{ +#' \item \emph{ @param } search_term \link{SearchTerm} +#' \item \emph{ @returnType } \link{SearchResult} \cr +#' +#' +#' \item status code : 200 | A search result object, containing the total number of hits for the given query, and the hits themselves. +#' +#' \item return type : SearchResult +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ execute_app_type_search } \emph{ Executes a search over all app types to find ones that match the given search term } +#' +#' +#' \itemize{ +#' \item \emph{ @param } search_term \link{SearchTerm} +#' \item \emph{ @returnType } \link{SearchResult} \cr +#' +#' +#' \item status code : 200 | A search result object, containing the total number of hits for the given query, and the hits themselves. +#' +#' \item return type : SearchResult +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ execute_association_type_search } \emph{ Executes a search over all association types to find ones that match the given search term } +#' +#' +#' \itemize{ +#' \item \emph{ @param } search_term \link{SearchTerm} +#' \item \emph{ @returnType } \link{SearchResult} \cr +#' +#' +#' \item status code : 200 | A search result object, containing the total number of hits for the given query, and the hits themselves. +#' +#' \item return type : SearchResult +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' #' \strong{ execute_entity_neighbor_search } \emph{ Executes a search for all neighbors of an entity that are connected by an association } #' #' @@ -56,6 +107,7 @@ #' \itemize{ #' \item \emph{ @param } entity_set_id \link{character} #' \item \emph{ @param } request_body list( character ) +#' \item \emph{ @returnType } named list( \link{array} ) \cr #' #' #' \item status code : 200 | A list of objects containing information about the neighbor and association. @@ -67,6 +119,23 @@ #' } #' } #' +#' \strong{ execute_entity_set_collection_search } \emph{ Executes a search over all EntitySetCollections to find ones that match the given search term } +#' +#' +#' \itemize{ +#' \item \emph{ @param } search_term \link{SearchTerm} +#' \item \emph{ @returnType } \link{SearchResult} \cr +#' +#' +#' \item status code : 200 | A search result object, containing the total number of hits for the given query, and the hits themselves. +#' +#' \item return type : SearchResult +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' #' \strong{ execute_entity_set_data_query } \emph{ Executes a search over the data of a given entity set to find rows that match the search term } #' #' @@ -93,7 +162,41 @@ #' \item \emph{ @returnType } \link{SearchResult} \cr #' #' -#' \item status code : 200 | A list of objects containing information about the neighbor and association. +#' \item status code : 200 | A search result object, containing the total number of hits for the given query, and the hits themselves. +#' +#' \item return type : SearchResult +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ execute_entity_type_collection_search } \emph{ Executes a search over all EntityTypeCollections to find ones that match the given search term } +#' +#' +#' \itemize{ +#' \item \emph{ @param } search_term \link{SearchTerm} +#' \item \emph{ @returnType } \link{SearchResult} \cr +#' +#' +#' \item status code : 200 | A search result object, containing the total number of hits for the given query, and the hits themselves. +#' +#' \item return type : SearchResult +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ execute_entity_type_search } \emph{ Executes a search over all entity types to find ones that match the given search term } +#' +#' +#' \itemize{ +#' \item \emph{ @param } search_term \link{SearchTerm} +#' \item \emph{ @returnType } \link{SearchResult} \cr +#' +#' +#' \item status code : 200 | A search result object, containing the total number of hits for the given query, and the hits themselves. #' #' \item return type : SearchResult #' \item response headers : @@ -125,6 +228,7 @@ #' \itemize{ #' \item \emph{ @param } entity_set_id \link{character} #' \item \emph{ @param } neighbor_search_filter \link{NeighborSearchFilter} +#' \item \emph{ @returnType } named list( \link{array} ) \cr #' #' #' \item status code : 200 | A list of objects containing information about the neighbor and association. @@ -136,6 +240,57 @@ #' } #' } #' +#' \strong{ execute_fqn_property_type_search } \emph{ Executes a search over all property types to find ones that match the given name and namespace, including partial matches } +#' +#' +#' \itemize{ +#' \item \emph{ @param } search_term \link{SearchTerm} +#' \item \emph{ @returnType } \link{SearchResult} \cr +#' +#' +#' \item status code : 200 | A search result object, containing the total number of hits for the given query, and the hits themselves. +#' +#' \item return type : SearchResult +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ execute_organization_search } \emph{ Executes a search over all organizations to find ones that match the given search term } +#' +#' +#' \itemize{ +#' \item \emph{ @param } search_term \link{SearchTerm} +#' \item \emph{ @returnType } \link{SearchResult} \cr +#' +#' +#' \item status code : 200 | A search result object, containing the total number of hits for the given query, and the hits themselves. +#' +#' \item return type : SearchResult +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ execute_property_type_search } \emph{ Executes a search over all property types to find ones that match the given search term } +#' +#' +#' \itemize{ +#' \item \emph{ @param } search_term \link{SearchTerm} +#' \item \emph{ @returnType } \link{SearchResult} \cr +#' +#' +#' \item status code : 200 | A search result object, containing the total number of hits for the given query, and the hits themselves. +#' +#' \item return type : SearchResult +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' #' \strong{ get_entity_sets } \emph{ Executes a search over all existing entity sets to populate the home page. The path parameters instruct which page to return and how large the page should be. } #' #' @@ -213,6 +368,66 @@ #' result <- api.instance$execute_advanced_entity_set_data_query(var.entity_set_id, var.advanced_search) #' #' +#' #################### execute_app_search #################### +#' +#' library(openlattice) +#' var.search_term <- SearchTerm$new() # SearchTerm | +#' +#' #Executes a search over all apps to find ones that match the given search term +#' api.instance <- SearchApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$execute_app_search(var.search_term) +#' +#' +#' #################### execute_app_type_search #################### +#' +#' library(openlattice) +#' var.search_term <- SearchTerm$new() # SearchTerm | +#' +#' #Executes a search over all app types to find ones that match the given search term +#' api.instance <- SearchApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$execute_app_type_search(var.search_term) +#' +#' +#' #################### execute_association_type_search #################### +#' +#' library(openlattice) +#' var.search_term <- SearchTerm$new() # SearchTerm | +#' +#' #Executes a search over all association types to find ones that match the given search term +#' api.instance <- SearchApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$execute_association_type_search(var.search_term) +#' +#' #' #################### execute_entity_neighbor_search #################### #' #' library(openlattice) @@ -255,6 +470,26 @@ #' result <- api.instance$execute_entity_neighbor_search_bulk(var.entity_set_id, var.request_body) #' #' +#' #################### execute_entity_set_collection_search #################### +#' +#' library(openlattice) +#' var.search_term <- SearchTerm$new() # SearchTerm | +#' +#' #Executes a search over all EntitySetCollections to find ones that match the given search term +#' api.instance <- SearchApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$execute_entity_set_collection_search(var.search_term) +#' +#' #' #################### execute_entity_set_data_query #################### #' #' library(openlattice) @@ -296,6 +531,46 @@ #' result <- api.instance$execute_entity_set_keyword_query(var.search) #' #' +#' #################### execute_entity_type_collection_search #################### +#' +#' library(openlattice) +#' var.search_term <- SearchTerm$new() # SearchTerm | +#' +#' #Executes a search over all EntityTypeCollections to find ones that match the given search term +#' api.instance <- SearchApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$execute_entity_type_collection_search(var.search_term) +#' +#' +#' #################### execute_entity_type_search #################### +#' +#' library(openlattice) +#' var.search_term <- SearchTerm$new() # SearchTerm | +#' +#' #Executes a search over all entity types to find ones that match the given search term +#' api.instance <- SearchApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$execute_entity_type_search(var.search_term) +#' +#' #' #################### execute_filtered_entity_neighbor_id_search #################### #' #' library(openlattice) @@ -338,13 +613,12 @@ #' result <- api.instance$execute_filtered_entity_neighbor_search(var.entity_set_id, var.neighbor_search_filter) #' #' -#' #################### get_entity_sets #################### +#' #################### execute_fqn_property_type_search #################### #' #' library(openlattice) -#' var.start <- 56 # integer | The first result number to return -#' var.num_results <- 56 # integer | The total number of results to return +#' var.search_term <- SearchTerm$new() # SearchTerm | #' -#' #Executes a search over all existing entity sets to populate the home page. The path parameters instruct which page to return and how large the page should be. +#' #Executes a search over all property types to find ones that match the given name and namespace, including partial matches #' api.instance <- SearchApi$new() #' #' #Configure HTTP basic authorization: http_auth @@ -356,14 +630,15 @@ #' #Configure API key authorization: openlattice_auth #' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; #' -#' result <- api.instance$get_entity_sets(var.start, var.num_results) +#' result <- api.instance$execute_fqn_property_type_search(var.search_term) #' #' -#' #################### get_popular_entity_set #################### +#' #################### execute_organization_search #################### #' #' library(openlattice) +#' var.search_term <- SearchTerm$new() # SearchTerm | #' -#' #Get the most popular entity sets. +#' #Executes a search over all organizations to find ones that match the given search term #' api.instance <- SearchApi$new() #' #' #Configure HTTP basic authorization: http_auth @@ -375,15 +650,15 @@ #' #Configure API key authorization: openlattice_auth #' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; #' -#' result <- api.instance$get_popular_entity_set() +#' result <- api.instance$execute_organization_search(var.search_term) #' #' -#' #################### search_entity_set_data #################### +#' #################### execute_property_type_search #################### #' #' library(openlattice) -#' var.search_constraints <- SearchConstraints$new() # SearchConstraints | +#' var.search_term <- SearchTerm$new() # SearchTerm | #' -#' #Executes a search over the data of a given entity set to find rows that match the search term +#' #Executes a search over all property types to find ones that match the given search term #' api.instance <- SearchApi$new() #' #' #Configure HTTP basic authorization: http_auth @@ -395,27 +670,545 @@ #' #Configure API key authorization: openlattice_auth #' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; #' -#' result <- api.instance$search_entity_set_data(var.search_constraints) +#' result <- api.instance$execute_property_type_search(var.search_term) #' #' -#' } -#' @importFrom R6 R6Class -#' @importFrom base64enc base64encode -#' @export -SearchApi <- R6::R6Class( - 'SearchApi', - public = list( - apiClient = NULL, - initialize = function(apiClient){ - if (!missing(apiClient)) { - self$apiClient <- apiClient - } +#' #################### get_entity_sets #################### +#' +#' library(openlattice) +#' var.start <- 56 # integer | The first result number to return +#' var.num_results <- 56 # integer | The total number of results to return +#' +#' #Executes a search over all existing entity sets to populate the home page. The path parameters instruct which page to return and how large the page should be. +#' api.instance <- SearchApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$get_entity_sets(var.start, var.num_results) +#' +#' +#' #################### get_popular_entity_set #################### +#' +#' library(openlattice) +#' +#' #Get the most popular entity sets. +#' api.instance <- SearchApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$get_popular_entity_set() +#' +#' +#' #################### search_entity_set_data #################### +#' +#' library(openlattice) +#' var.search_constraints <- SearchConstraints$new() # SearchConstraints | +#' +#' #Executes a search over the data of a given entity set to find rows that match the search term +#' api.instance <- SearchApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$search_entity_set_data(var.search_constraints) +#' +#' +#' } +#' @importFrom R6 R6Class +#' @importFrom base64enc base64encode +#' @export +SearchApi <- R6::R6Class( + 'SearchApi', + public = list( + apiClient = NULL, + initialize = function(apiClient){ + if (!missing(apiClient)) { + self$apiClient <- apiClient + } else { self$apiClient <- ApiClient$new() } }, - execute_advanced_entity_set_data_query = function(entity_set_id, advanced_search, ...){ - apiResponse <- self$execute_advanced_entity_set_data_queryWithHttpInfo(entity_set_id, advanced_search, ...) + execute_advanced_entity_set_data_query = function(entity_set_id, advanced_search, ...){ + apiResponse <- self$execute_advanced_entity_set_data_queryWithHttpInfo(entity_set_id, advanced_search, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + execute_advanced_entity_set_data_queryWithHttpInfo = function(entity_set_id, advanced_search, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`entity_set_id`)) { + stop("Missing required parameter `entity_set_id`.") + } + + if (missing(`advanced_search`)) { + stop("Missing required parameter `advanced_search`.") + } + + if (!missing(`advanced_search`)) { + body <- sprintf( + ' + %s + ', + jsonlite::toJSON(`advanced_search`$toJSON(), auto_unbox=TRUE, digits = NA) + ) + } else { + body <- NULL + } + + urlPath <- "/datastore/search/advanced/{entitySetId}" + if (!missing(`entity_set_id`)) { + urlPath <- gsub(paste0("\\{", "entitySetId", "\\}"), URLencode(as.character(`entity_set_id`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "POST", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "DataSearchResult", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + execute_app_search = function(search_term, ...){ + apiResponse <- self$execute_app_searchWithHttpInfo(search_term, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + execute_app_searchWithHttpInfo = function(search_term, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`search_term`)) { + stop("Missing required parameter `search_term`.") + } + + if (!missing(`search_term`)) { + body <- sprintf( + ' + %s + ', + jsonlite::toJSON(`search_term`$toJSON(), auto_unbox=TRUE, digits = NA) + ) + } else { + body <- NULL + } + + urlPath <- "/datastore/search/app" + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "POST", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "SearchResult", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + execute_app_type_search = function(search_term, ...){ + apiResponse <- self$execute_app_type_searchWithHttpInfo(search_term, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + execute_app_type_searchWithHttpInfo = function(search_term, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`search_term`)) { + stop("Missing required parameter `search_term`.") + } + + if (!missing(`search_term`)) { + body <- sprintf( + ' + %s + ', + jsonlite::toJSON(`search_term`$toJSON(), auto_unbox=TRUE, digits = NA) + ) + } else { + body <- NULL + } + + urlPath <- "/datastore/search/app_types" + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "POST", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "SearchResult", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + execute_association_type_search = function(search_term, ...){ + apiResponse <- self$execute_association_type_searchWithHttpInfo(search_term, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + execute_association_type_searchWithHttpInfo = function(search_term, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`search_term`)) { + stop("Missing required parameter `search_term`.") + } + + if (!missing(`search_term`)) { + body <- sprintf( + ' + %s + ', + jsonlite::toJSON(`search_term`$toJSON(), auto_unbox=TRUE, digits = NA) + ) + } else { + body <- NULL + } + + urlPath <- "/datastore/search/association_types" + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "POST", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "SearchResult", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + execute_entity_neighbor_search = function(entity_set_id, entity_key_id, ...){ + apiResponse <- self$execute_entity_neighbor_searchWithHttpInfo(entity_set_id, entity_key_id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + execute_entity_neighbor_searchWithHttpInfo = function(entity_set_id, entity_key_id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`entity_set_id`)) { + stop("Missing required parameter `entity_set_id`.") + } + + if (missing(`entity_key_id`)) { + stop("Missing required parameter `entity_key_id`.") + } + + urlPath <- "/datastore/search/{entitySetId}/{entityKeyId}" + if (!missing(`entity_set_id`)) { + urlPath <- gsub(paste0("\\{", "entitySetId", "\\}"), URLencode(as.character(`entity_set_id`), reserved = TRUE), urlPath) + } + + if (!missing(`entity_key_id`)) { + urlPath <- gsub(paste0("\\{", "entityKeyId", "\\}"), URLencode(as.character(`entity_key_id`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "array[NeighborEntityDetails]", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + execute_entity_neighbor_search_bulk = function(entity_set_id, request_body, ...){ + apiResponse <- self$execute_entity_neighbor_search_bulkWithHttpInfo(entity_set_id, request_body, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + execute_entity_neighbor_search_bulkWithHttpInfo = function(entity_set_id, request_body, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`entity_set_id`)) { + stop("Missing required parameter `entity_set_id`.") + } + + if (missing(`request_body`)) { + stop("Missing required parameter `request_body`.") + } + + if (!missing(`request_body`)) { + body <- sprintf( + ' + [%s] +', + paste(sapply(`request_body`, function(x) jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)), collapse=",") + ) + } else { + body <- NULL + } + + urlPath <- "/datastore/search/{entitySetId}/neighbors" + if (!missing(`entity_set_id`)) { + urlPath <- gsub(paste0("\\{", "entitySetId", "\\}"), URLencode(as.character(`entity_set_id`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "POST", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "list(array[NeighborEntityDetails])", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + execute_entity_set_collection_search = function(search_term, ...){ + apiResponse <- self$execute_entity_set_collection_searchWithHttpInfo(search_term, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + execute_entity_set_collection_searchWithHttpInfo = function(search_term, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`search_term`)) { + stop("Missing required parameter `search_term`.") + } + + if (!missing(`search_term`)) { + body <- sprintf( + ' + %s + ', + jsonlite::toJSON(`search_term`$toJSON(), auto_unbox=TRUE, digits = NA) + ) + } else { + body <- NULL + } + + urlPath <- "/datastore/search/entity_sets/collections" + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "POST", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "SearchResult", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + execute_entity_set_data_query = function(entity_set_id, search_term, ...){ + apiResponse <- self$execute_entity_set_data_queryWithHttpInfo(entity_set_id, search_term, ...) resp <- apiResponse$response if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { apiResponse$content @@ -428,7 +1221,7 @@ SearchApi <- R6::R6Class( } }, - execute_advanced_entity_set_data_queryWithHttpInfo = function(entity_set_id, advanced_search, ...){ + execute_entity_set_data_queryWithHttpInfo = function(entity_set_id, search_term, ...){ args <- list(...) queryParams <- list() headerParams <- c() @@ -437,22 +1230,22 @@ SearchApi <- R6::R6Class( stop("Missing required parameter `entity_set_id`.") } - if (missing(`advanced_search`)) { - stop("Missing required parameter `advanced_search`.") + if (missing(`search_term`)) { + stop("Missing required parameter `search_term`.") } - if (!missing(`advanced_search`)) { + if (!missing(`search_term`)) { body <- sprintf( ' %s ', - jsonlite::toJSON(`advanced_search`$toJSON(), auto_unbox=TRUE, digits = NA) + jsonlite::toJSON(`search_term`$toJSON(), auto_unbox=TRUE, digits = NA) ) } else { body <- NULL } - urlPath <- "/datastore/search/advanced/{entitySetId}" + urlPath <- "/datastore/search/{entitySetId}" if (!missing(`entity_set_id`)) { urlPath <- gsub(paste0("\\{", "entitySetId", "\\}"), URLencode(as.character(`entity_set_id`), reserved = TRUE), urlPath) } @@ -485,8 +1278,8 @@ SearchApi <- R6::R6Class( ApiResponse$new("API server error", resp) } }, - execute_entity_neighbor_search = function(entity_set_id, entity_key_id, ...){ - apiResponse <- self$execute_entity_neighbor_searchWithHttpInfo(entity_set_id, entity_key_id, ...) + execute_entity_set_keyword_query = function(search, ...){ + apiResponse <- self$execute_entity_set_keyword_queryWithHttpInfo(search, ...) resp <- apiResponse$response if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { apiResponse$content @@ -499,35 +1292,97 @@ SearchApi <- R6::R6Class( } }, - execute_entity_neighbor_searchWithHttpInfo = function(entity_set_id, entity_key_id, ...){ + execute_entity_set_keyword_queryWithHttpInfo = function(search, ...){ args <- list(...) queryParams <- list() headerParams <- c() - if (missing(`entity_set_id`)) { - stop("Missing required parameter `entity_set_id`.") + if (missing(`search`)) { + stop("Missing required parameter `search`.") } - if (missing(`entity_key_id`)) { - stop("Missing required parameter `entity_key_id`.") + if (!missing(`search`)) { + body <- sprintf( + ' + %s + ', + jsonlite::toJSON(`search`$toJSON(), auto_unbox=TRUE, digits = NA) + ) + } else { + body <- NULL } - urlPath <- "/datastore/search/{entitySetId}/{entityKeyId}" - if (!missing(`entity_set_id`)) { - urlPath <- gsub(paste0("\\{", "entitySetId", "\\}"), URLencode(as.character(`entity_set_id`), reserved = TRUE), urlPath) + urlPath <- "/datastore/search" + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') } - if (!missing(`entity_key_id`)) { - urlPath <- gsub(paste0("\\{", "entityKeyId", "\\}"), URLencode(as.character(`entity_key_id`), reserved = TRUE), urlPath) + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "POST", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "SearchResult", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + execute_entity_type_collection_search = function(search_term, ...){ + apiResponse <- self$execute_entity_type_collection_searchWithHttpInfo(search_term, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + execute_entity_type_collection_searchWithHttpInfo = function(search_term, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`search_term`)) { + stop("Missing required parameter `search_term`.") + } + + if (!missing(`search_term`)) { + body <- sprintf( + ' + %s + ', + jsonlite::toJSON(`search_term`$toJSON(), auto_unbox=TRUE, digits = NA) + ) + } else { + body <- NULL } + urlPath <- "/datastore/search/entity_types/collections" # API key authentication if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') } resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), - method = "GET", + method = "POST", queryParams = queryParams, headerParams = headerParams, body = body, @@ -535,7 +1390,7 @@ SearchApi <- R6::R6Class( if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { deserializedRespObj <- tryCatch( - self$apiClient$deserialize(resp, "array[NeighborEntityDetails]", loadNamespace("openlattice")), + self$apiClient$deserialize(resp, "SearchResult", loadNamespace("openlattice")), error = function(e){ stop("Failed to deserialize response") } @@ -549,8 +1404,8 @@ SearchApi <- R6::R6Class( ApiResponse$new("API server error", resp) } }, - execute_entity_neighbor_search_bulk = function(entity_set_id, request_body, ...){ - apiResponse <- self$execute_entity_neighbor_search_bulkWithHttpInfo(entity_set_id, request_body, ...) + execute_entity_type_search = function(search_term, ...){ + apiResponse <- self$execute_entity_type_searchWithHttpInfo(search_term, ...) resp <- apiResponse$response if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { apiResponse$content @@ -563,7 +1418,70 @@ SearchApi <- R6::R6Class( } }, - execute_entity_neighbor_search_bulkWithHttpInfo = function(entity_set_id, request_body, ...){ + execute_entity_type_searchWithHttpInfo = function(search_term, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`search_term`)) { + stop("Missing required parameter `search_term`.") + } + + if (!missing(`search_term`)) { + body <- sprintf( + ' + %s + ', + jsonlite::toJSON(`search_term`$toJSON(), auto_unbox=TRUE, digits = NA) + ) + } else { + body <- NULL + } + + urlPath <- "/datastore/search/entity_types" + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "POST", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "SearchResult", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + execute_filtered_entity_neighbor_id_search = function(entity_set_id, neighbor_search_filter, ...){ + apiResponse <- self$execute_filtered_entity_neighbor_id_searchWithHttpInfo(entity_set_id, neighbor_search_filter, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + execute_filtered_entity_neighbor_id_searchWithHttpInfo = function(entity_set_id, neighbor_search_filter, ...){ args <- list(...) queryParams <- list() headerParams <- c() @@ -572,22 +1490,22 @@ SearchApi <- R6::R6Class( stop("Missing required parameter `entity_set_id`.") } - if (missing(`request_body`)) { - stop("Missing required parameter `request_body`.") + if (missing(`neighbor_search_filter`)) { + stop("Missing required parameter `neighbor_search_filter`.") } - if (!missing(`request_body`)) { + if (!missing(`neighbor_search_filter`)) { body <- sprintf( ' - [%s] -', - paste(sapply(`request_body`, function(x) { if (is.null(names(x) )) {paste0('"', x, '"')} else {jsonlite::toJSON(x$toJSON(), auto_unbox=TRUE, digits = NA)}}), collapse=",") + %s + ', + jsonlite::toJSON(`neighbor_search_filter`$toJSON(), auto_unbox=TRUE, digits = NA) ) } else { body <- NULL } - urlPath <- "/datastore/search/{entitySetId}/neighbors" + urlPath <- "/datastore/search/{entitySetId}/neighbors/advanced/ids" if (!missing(`entity_set_id`)) { urlPath <- gsub(paste0("\\{", "entitySetId", "\\}"), URLencode(as.character(`entity_set_id`), reserved = TRUE), urlPath) } @@ -606,7 +1524,7 @@ SearchApi <- R6::R6Class( if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { deserializedRespObj <- tryCatch( - self$apiClient$deserialize(resp, "list(array[NeighborEntityDetails])", loadNamespace("openlattice")), + self$apiClient$deserialize(resp, "list(list(list(array[NeighborEntityIds])))", loadNamespace("openlattice")), error = function(e){ stop("Failed to deserialize response") } @@ -620,8 +1538,8 @@ SearchApi <- R6::R6Class( ApiResponse$new("API server error", resp) } }, - execute_entity_set_data_query = function(entity_set_id, search_term, ...){ - apiResponse <- self$execute_entity_set_data_queryWithHttpInfo(entity_set_id, search_term, ...) + execute_filtered_entity_neighbor_search = function(entity_set_id, neighbor_search_filter, ...){ + apiResponse <- self$execute_filtered_entity_neighbor_searchWithHttpInfo(entity_set_id, neighbor_search_filter, ...) resp <- apiResponse$response if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { apiResponse$content @@ -634,7 +1552,7 @@ SearchApi <- R6::R6Class( } }, - execute_entity_set_data_queryWithHttpInfo = function(entity_set_id, search_term, ...){ + execute_filtered_entity_neighbor_searchWithHttpInfo = function(entity_set_id, neighbor_search_filter, ...){ args <- list(...) queryParams <- list() headerParams <- c() @@ -643,22 +1561,22 @@ SearchApi <- R6::R6Class( stop("Missing required parameter `entity_set_id`.") } - if (missing(`search_term`)) { - stop("Missing required parameter `search_term`.") + if (missing(`neighbor_search_filter`)) { + stop("Missing required parameter `neighbor_search_filter`.") } - if (!missing(`search_term`)) { + if (!missing(`neighbor_search_filter`)) { body <- sprintf( ' %s ', - jsonlite::toJSON(`search_term`$toJSON(), auto_unbox=TRUE, digits = NA) + jsonlite::toJSON(`neighbor_search_filter`$toJSON(), auto_unbox=TRUE, digits = NA) ) } else { body <- NULL } - urlPath <- "/datastore/search/{entitySetId}" + urlPath <- "/datastore/search/{entitySetId}/neighbors/advanced" if (!missing(`entity_set_id`)) { urlPath <- gsub(paste0("\\{", "entitySetId", "\\}"), URLencode(as.character(`entity_set_id`), reserved = TRUE), urlPath) } @@ -677,7 +1595,7 @@ SearchApi <- R6::R6Class( if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { deserializedRespObj <- tryCatch( - self$apiClient$deserialize(resp, "DataSearchResult", loadNamespace("openlattice")), + self$apiClient$deserialize(resp, "list(array[NeighborEntityDetails])", loadNamespace("openlattice")), error = function(e){ stop("Failed to deserialize response") } @@ -691,8 +1609,8 @@ SearchApi <- R6::R6Class( ApiResponse$new("API server error", resp) } }, - execute_entity_set_keyword_query = function(search, ...){ - apiResponse <- self$execute_entity_set_keyword_queryWithHttpInfo(search, ...) + execute_fqn_property_type_search = function(search_term, ...){ + apiResponse <- self$execute_fqn_property_type_searchWithHttpInfo(search_term, ...) resp <- apiResponse$response if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { apiResponse$content @@ -705,27 +1623,27 @@ SearchApi <- R6::R6Class( } }, - execute_entity_set_keyword_queryWithHttpInfo = function(search, ...){ + execute_fqn_property_type_searchWithHttpInfo = function(search_term, ...){ args <- list(...) queryParams <- list() headerParams <- c() - if (missing(`search`)) { - stop("Missing required parameter `search`.") + if (missing(`search_term`)) { + stop("Missing required parameter `search_term`.") } - if (!missing(`search`)) { + if (!missing(`search_term`)) { body <- sprintf( ' %s ', - jsonlite::toJSON(`search`$toJSON(), auto_unbox=TRUE, digits = NA) + jsonlite::toJSON(`search_term`$toJSON(), auto_unbox=TRUE, digits = NA) ) } else { body <- NULL } - urlPath <- "/datastore/search" + urlPath <- "/datastore/search/property_types/fqn" # API key authentication if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') @@ -754,8 +1672,8 @@ SearchApi <- R6::R6Class( ApiResponse$new("API server error", resp) } }, - execute_filtered_entity_neighbor_id_search = function(entity_set_id, neighbor_search_filter, ...){ - apiResponse <- self$execute_filtered_entity_neighbor_id_searchWithHttpInfo(entity_set_id, neighbor_search_filter, ...) + execute_organization_search = function(search_term, ...){ + apiResponse <- self$execute_organization_searchWithHttpInfo(search_term, ...) resp <- apiResponse$response if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { apiResponse$content @@ -768,35 +1686,27 @@ SearchApi <- R6::R6Class( } }, - execute_filtered_entity_neighbor_id_searchWithHttpInfo = function(entity_set_id, neighbor_search_filter, ...){ + execute_organization_searchWithHttpInfo = function(search_term, ...){ args <- list(...) queryParams <- list() headerParams <- c() - if (missing(`entity_set_id`)) { - stop("Missing required parameter `entity_set_id`.") - } - - if (missing(`neighbor_search_filter`)) { - stop("Missing required parameter `neighbor_search_filter`.") + if (missing(`search_term`)) { + stop("Missing required parameter `search_term`.") } - if (!missing(`neighbor_search_filter`)) { + if (!missing(`search_term`)) { body <- sprintf( ' %s ', - jsonlite::toJSON(`neighbor_search_filter`$toJSON(), auto_unbox=TRUE, digits = NA) + jsonlite::toJSON(`search_term`$toJSON(), auto_unbox=TRUE, digits = NA) ) } else { body <- NULL } - urlPath <- "/datastore/search/{entitySetId}/neighbors/advanced/ids" - if (!missing(`entity_set_id`)) { - urlPath <- gsub(paste0("\\{", "entitySetId", "\\}"), URLencode(as.character(`entity_set_id`), reserved = TRUE), urlPath) - } - + urlPath <- "/datastore/search/organizations" # API key authentication if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') @@ -811,7 +1721,7 @@ SearchApi <- R6::R6Class( if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { deserializedRespObj <- tryCatch( - self$apiClient$deserialize(resp, "list(list(list(array[NeighborEntityIds])))", loadNamespace("openlattice")), + self$apiClient$deserialize(resp, "SearchResult", loadNamespace("openlattice")), error = function(e){ stop("Failed to deserialize response") } @@ -825,8 +1735,8 @@ SearchApi <- R6::R6Class( ApiResponse$new("API server error", resp) } }, - execute_filtered_entity_neighbor_search = function(entity_set_id, neighbor_search_filter, ...){ - apiResponse <- self$execute_filtered_entity_neighbor_searchWithHttpInfo(entity_set_id, neighbor_search_filter, ...) + execute_property_type_search = function(search_term, ...){ + apiResponse <- self$execute_property_type_searchWithHttpInfo(search_term, ...) resp <- apiResponse$response if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { apiResponse$content @@ -839,35 +1749,27 @@ SearchApi <- R6::R6Class( } }, - execute_filtered_entity_neighbor_searchWithHttpInfo = function(entity_set_id, neighbor_search_filter, ...){ + execute_property_type_searchWithHttpInfo = function(search_term, ...){ args <- list(...) queryParams <- list() headerParams <- c() - if (missing(`entity_set_id`)) { - stop("Missing required parameter `entity_set_id`.") - } - - if (missing(`neighbor_search_filter`)) { - stop("Missing required parameter `neighbor_search_filter`.") + if (missing(`search_term`)) { + stop("Missing required parameter `search_term`.") } - if (!missing(`neighbor_search_filter`)) { + if (!missing(`search_term`)) { body <- sprintf( ' %s ', - jsonlite::toJSON(`neighbor_search_filter`$toJSON(), auto_unbox=TRUE, digits = NA) + jsonlite::toJSON(`search_term`$toJSON(), auto_unbox=TRUE, digits = NA) ) } else { body <- NULL } - urlPath <- "/datastore/search/{entitySetId}/neighbors/advanced" - if (!missing(`entity_set_id`)) { - urlPath <- gsub(paste0("\\{", "entitySetId", "\\}"), URLencode(as.character(`entity_set_id`), reserved = TRUE), urlPath) - } - + urlPath <- "/datastore/search/property_types" # API key authentication if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') @@ -882,7 +1784,7 @@ SearchApi <- R6::R6Class( if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { deserializedRespObj <- tryCatch( - self$apiClient$deserialize(resp, "list(array[NeighborEntityDetails])", loadNamespace("openlattice")), + self$apiClient$deserialize(resp, "SearchResult", loadNamespace("openlattice")), error = function(e){ stop("Failed to deserialize response") } diff --git a/R/R/search_constraints.R b/R/R/search_constraints.R index 3a9f569..fe3da96 100644 --- a/R/R/search_constraints.R +++ b/R/R/search_constraints.R @@ -8,11 +8,8 @@ #' @docType class #' @title SearchConstraints -#' #' @description SearchConstraints Class -#' #' @format An \code{R6Class} generator object -#' #' @field entitySetIds list( character ) [optional] #' #' @field start integer [optional] @@ -23,6 +20,7 @@ #' #' @field sort \link{SortDefinition} [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -34,9 +32,7 @@ SearchConstraints <- R6::R6Class( `maxHits` = NULL, `constraints` = NULL, `sort` = NULL, - initialize = function( - `entitySetIds`=NULL, `start`=NULL, `maxHits`=NULL, `constraints`=NULL, `sort`=NULL, ... - ) { + initialize = function(`entitySetIds`=NULL, `start`=NULL, `maxHits`=NULL, `constraints`=NULL, `sort`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`entitySetIds`)) { stopifnot(is.vector(`entitySetIds`)) @@ -105,7 +101,6 @@ SearchConstraints <- R6::R6Class( sortObject$fromJSON(jsonlite::toJSON(SearchConstraintsObject$sort, auto_unbox = TRUE, digits = NA)) self$`sort` <- sortObject } - self }, toJSONString = function() { jsoncontent <- c( @@ -159,4 +154,3 @@ SearchConstraints <- R6::R6Class( } ) ) - diff --git a/R/R/search_details.R b/R/R/search_details.R index 87bf0ed..fa2e3ef 100644 --- a/R/R/search_details.R +++ b/R/R/search_details.R @@ -8,17 +8,15 @@ #' @docType class #' @title SearchDetails -#' #' @description SearchDetails Class -#' #' @format An \code{R6Class} generator object -#' #' @field searchTerm character [optional] #' #' @field property character [optional] #' #' @field exact character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -28,9 +26,7 @@ SearchDetails <- R6::R6Class( `searchTerm` = NULL, `property` = NULL, `exact` = NULL, - initialize = function( - `searchTerm`=NULL, `property`=NULL, `exact`=NULL, ... - ) { + initialize = function(`searchTerm`=NULL, `property`=NULL, `exact`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`searchTerm`)) { stopifnot(is.character(`searchTerm`), length(`searchTerm`) == 1) @@ -72,7 +68,6 @@ SearchDetails <- R6::R6Class( if (!is.null(SearchDetailsObject$`exact`)) { self$`exact` <- SearchDetailsObject$`exact` } - self }, toJSONString = function() { jsoncontent <- c( @@ -110,4 +105,3 @@ SearchDetails <- R6::R6Class( } ) ) - diff --git a/R/R/search_result.R b/R/R/search_result.R index 80db8cb..bc0f5d5 100644 --- a/R/R/search_result.R +++ b/R/R/search_result.R @@ -8,15 +8,13 @@ #' @docType class #' @title SearchResult -#' #' @description SearchResult Class -#' #' @format An \code{R6Class} generator object -#' #' @field numHits integer [optional] #' #' @field hits list( \link{SearchResultHits} ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ SearchResult <- R6::R6Class( public = list( `numHits` = NULL, `hits` = NULL, - initialize = function( - `numHits`=NULL, `hits`=NULL, ... - ) { + initialize = function(`numHits`=NULL, `hits`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`numHits`)) { stopifnot(is.numeric(`numHits`), length(`numHits`) == 1) @@ -60,7 +56,6 @@ SearchResult <- R6::R6Class( if (!is.null(SearchResultObject$`hits`)) { self$`hits` <- ApiClient$new()$deserializeObj(SearchResultObject$`hits`, "array[SearchResultHits]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -90,4 +85,3 @@ SearchResult <- R6::R6Class( } ) ) - diff --git a/R/R/search_result_hits.R b/R/R/search_result_hits.R index b991161..dd16864 100644 --- a/R/R/search_result_hits.R +++ b/R/R/search_result_hits.R @@ -8,15 +8,13 @@ #' @docType class #' @title SearchResultHits -#' #' @description SearchResultHits Class -#' #' @format An \code{R6Class} generator object -#' #' @field propertyTypes list( \link{PropertyType} ) [optional] #' #' @field entitySet \link{EntitySet} [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -25,9 +23,7 @@ SearchResultHits <- R6::R6Class( public = list( `propertyTypes` = NULL, `entitySet` = NULL, - initialize = function( - `propertyTypes`=NULL, `entitySet`=NULL, ... - ) { + initialize = function(`propertyTypes`=NULL, `entitySet`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`propertyTypes`)) { stopifnot(is.vector(`propertyTypes`)) @@ -62,7 +58,6 @@ SearchResultHits <- R6::R6Class( entitySetObject$fromJSON(jsonlite::toJSON(SearchResultHitsObject$entitySet, auto_unbox = TRUE, digits = NA)) self$`entitySet` <- entitySetObject } - self }, toJSONString = function() { jsoncontent <- c( @@ -92,4 +87,3 @@ SearchResultHits <- R6::R6Class( } ) ) - diff --git a/R/R/search_term.R b/R/R/search_term.R index cede2bb..d78f8bb 100644 --- a/R/R/search_term.R +++ b/R/R/search_term.R @@ -8,11 +8,8 @@ #' @docType class #' @title SearchTerm -#' #' @description SearchTerm Class -#' #' @format An \code{R6Class} generator object -#' #' @field searchTerm character [optional] #' #' @field start integer [optional] @@ -21,6 +18,7 @@ #' #' @field fuzzy character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -31,9 +29,7 @@ SearchTerm <- R6::R6Class( `start` = NULL, `maxHits` = NULL, `fuzzy` = NULL, - initialize = function( - `searchTerm`=NULL, `start`=NULL, `maxHits`=NULL, `fuzzy`=NULL, ... - ) { + initialize = function(`searchTerm`=NULL, `start`=NULL, `maxHits`=NULL, `fuzzy`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`searchTerm`)) { stopifnot(is.character(`searchTerm`), length(`searchTerm`) == 1) @@ -86,7 +82,6 @@ SearchTerm <- R6::R6Class( if (!is.null(SearchTermObject$`fuzzy`)) { self$`fuzzy` <- SearchTermObject$`fuzzy` } - self }, toJSONString = function() { jsoncontent <- c( @@ -132,4 +127,3 @@ SearchTerm <- R6::R6Class( } ) ) - diff --git a/R/R/securable_principal.R b/R/R/securable_principal.R index 8e9aed8..3b3701c 100644 --- a/R/R/securable_principal.R +++ b/R/R/securable_principal.R @@ -8,11 +8,8 @@ #' @docType class #' @title SecurablePrincipal -#' #' @description SecurablePrincipal Class -#' #' @format An \code{R6Class} generator object -#' #' @field id character [optional] #' #' @field principal \link{Principal} [optional] @@ -21,6 +18,7 @@ #' #' @field description character [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -31,9 +29,7 @@ SecurablePrincipal <- R6::R6Class( `principal` = NULL, `title` = NULL, `description` = NULL, - initialize = function( - `id`=NULL, `principal`=NULL, `title`=NULL, `description`=NULL, ... - ) { + initialize = function(`id`=NULL, `principal`=NULL, `title`=NULL, `description`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`id`)) { stopifnot(is.character(`id`), length(`id`) == 1) @@ -89,7 +85,6 @@ SecurablePrincipal <- R6::R6Class( if (!is.null(SecurablePrincipalObject$`description`)) { self$`description` <- SecurablePrincipalObject$`description` } - self }, toJSONString = function() { jsoncontent <- c( @@ -135,4 +130,3 @@ SecurablePrincipal <- R6::R6Class( } ) ) - diff --git a/R/R/shuttle_api.R b/R/R/shuttle_api.R new file mode 100644 index 0000000..f46255c --- /dev/null +++ b/R/R/shuttle_api.R @@ -0,0 +1,793 @@ +# OpenLattice API +# +# OpenLattice API +# +# The version of the OpenAPI document: 0.0.1 +# Contact: support@openlattice.com +# Generated by: https://openapi-generator.tech + +#' @docType class +#' @title Shuttle operations +#' @description openlattice.Shuttle +#' @format An \code{R6Class} generator object +#' @field apiClient Handles the client-server communication. +#' +#' @section Methods: +#' \describe{ +#' \strong{ create_integration_definition } \emph{ Creates a new integration definition for running recurring integrations } +#' +#' +#' \itemize{ +#' \item \emph{ @param } integration_name character +#' \item \emph{ @param } integration \link{Integration} +#' +#' +#' \item status code : 200 | Success +#' +#' \item return type : character +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ delete_integration_definition } \emph{ Replaces any number of fields within an existing integration definition } +#' +#' +#' \itemize{ +#' \item \emph{ @param } integration_name character +#' +#' +#' \item status code : 200 | Success +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ delete_integration_job_status } \emph{ Deletes an integration job status from the integrationJobs map } +#' +#' +#' \itemize{ +#' \item \emph{ @param } job_id \link{character} +#' +#' +#' \item status code : 200 | Success +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ enqueue_integration } \emph{ Enqueues an integration on Shuttle Server for a given integration } +#' +#' +#' \itemize{ +#' \item \emph{ @param } integration_name character +#' \item \emph{ @param } integration_key \link{character} +#' +#' +#' \item status code : 200 | Success +#' +#' \item return type : character +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ poll_all_integrations } \emph{ Polls the statuses of all running integrations } +#' +#' +#' \itemize{ +#' \item \emph{ @returnType } named list( \link{IntegrationJob} ) \cr +#' +#' +#' \item status code : 200 | Success +#' +#' \item return type : list(IntegrationJob) +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ poll_integration } \emph{ Polls the status of an integration } +#' +#' +#' \itemize{ +#' \item \emph{ @param } job_id \link{character} +#' +#' +#' \item status code : 200 | Success +#' +#' \item return type : character +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ read_integration_definition } \emph{ Gets an existing integration definition } +#' +#' +#' \itemize{ +#' \item \emph{ @param } integration_name character +#' \item \emph{ @returnType } \link{Integration} \cr +#' +#' +#' \item status code : 200 | Success +#' +#' \item return type : Integration +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' \strong{ update_integration_definition } \emph{ Replaces any number of fields within an existing integration definition } +#' +#' +#' \itemize{ +#' \item \emph{ @param } integration_name character +#' \item \emph{ @param } integration_update \link{IntegrationUpdate} +#' +#' +#' \item status code : 200 | Success +#' +#' +#' \item response headers : +#' +#' \tabular{ll}{ +#' } +#' } +#' +#' } +#' +#' +#' @examples +#' \dontrun{ +#' #################### create_integration_definition #################### +#' +#' library(openlattice) +#' var.integration_name <- 'integration_name_example' # character | +#' var.integration <- Integration$new() # Integration | +#' +#' #Creates a new integration definition for running recurring integrations +#' api.instance <- ShuttleApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$create_integration_definition(var.integration_name, var.integration) +#' +#' +#' #################### delete_integration_definition #################### +#' +#' library(openlattice) +#' var.integration_name <- 'integration_name_example' # character | +#' +#' #Replaces any number of fields within an existing integration definition +#' api.instance <- ShuttleApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$delete_integration_definition(var.integration_name) +#' +#' +#' #################### delete_integration_job_status #################### +#' +#' library(openlattice) +#' var.job_id <- 'job_id_example' # character | the unique id of the integration job +#' +#' #Deletes an integration job status from the integrationJobs map +#' api.instance <- ShuttleApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$delete_integration_job_status(var.job_id) +#' +#' +#' #################### enqueue_integration #################### +#' +#' library(openlattice) +#' var.integration_name <- 'integration_name_example' # character | the name of the integration to be run +#' var.integration_key <- 'integration_key_example' # character | the unique id used to authenticate an integration run +#' +#' #Enqueues an integration on Shuttle Server for a given integration +#' api.instance <- ShuttleApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$enqueue_integration(var.integration_name, var.integration_key) +#' +#' +#' #################### poll_all_integrations #################### +#' +#' library(openlattice) +#' +#' #Polls the statuses of all running integrations +#' api.instance <- ShuttleApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$poll_all_integrations() +#' +#' +#' #################### poll_integration #################### +#' +#' library(openlattice) +#' var.job_id <- 'job_id_example' # character | the unique id of the integration job +#' +#' #Polls the status of an integration +#' api.instance <- ShuttleApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$poll_integration(var.job_id) +#' +#' +#' #################### read_integration_definition #################### +#' +#' library(openlattice) +#' var.integration_name <- 'integration_name_example' # character | +#' +#' #Gets an existing integration definition +#' api.instance <- ShuttleApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$read_integration_definition(var.integration_name) +#' +#' +#' #################### update_integration_definition #################### +#' +#' library(openlattice) +#' var.integration_name <- 'integration_name_example' # character | +#' var.integration_update <- IntegrationUpdate$new() # IntegrationUpdate | +#' +#' #Replaces any number of fields within an existing integration definition +#' api.instance <- ShuttleApi$new() +#' +#' #Configure HTTP basic authorization: http_auth +#' # provide your username in the user-serial format +#' api.instance$apiClient$username <- ''; +#' # provide your api key generated using the developer portal +#' api.instance$apiClient$password <- ''; +#' +#' #Configure API key authorization: openlattice_auth +#' api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +#' +#' result <- api.instance$update_integration_definition(var.integration_name, var.integration_update) +#' +#' +#' } +#' @importFrom R6 R6Class +#' @importFrom base64enc base64encode +#' @export +ShuttleApi <- R6::R6Class( + 'ShuttleApi', + public = list( + apiClient = NULL, + initialize = function(apiClient){ + if (!missing(apiClient)) { + self$apiClient <- apiClient + } + else { + self$apiClient <- ApiClient$new() + } + }, + create_integration_definition = function(integration_name, integration, ...){ + apiResponse <- self$create_integration_definitionWithHttpInfo(integration_name, integration, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + create_integration_definitionWithHttpInfo = function(integration_name, integration, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`integration_name`)) { + stop("Missing required parameter `integration_name`.") + } + + if (missing(`integration`)) { + stop("Missing required parameter `integration`.") + } + + if (!missing(`integration`)) { + body <- sprintf( + ' + %s + ', + jsonlite::toJSON(`integration`$toJSON(), auto_unbox=TRUE, digits = NA) + ) + } else { + body <- NULL + } + + urlPath <- "/shuttle/integration/definition/{integrationName}" + if (!missing(`integration_name`)) { + urlPath <- gsub(paste0("\\{", "integrationName", "\\}"), URLencode(as.character(`integration_name`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "POST", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "character", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + delete_integration_definition = function(integration_name, ...){ + apiResponse <- self$delete_integration_definitionWithHttpInfo(integration_name, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + delete_integration_definitionWithHttpInfo = function(integration_name, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`integration_name`)) { + stop("Missing required parameter `integration_name`.") + } + + urlPath <- "/shuttle/integration/definition/{integrationName}" + if (!missing(`integration_name`)) { + urlPath <- gsub(paste0("\\{", "integrationName", "\\}"), URLencode(as.character(`integration_name`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "DELETE", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + delete_integration_job_status = function(job_id, ...){ + apiResponse <- self$delete_integration_job_statusWithHttpInfo(job_id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + delete_integration_job_statusWithHttpInfo = function(job_id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`job_id`)) { + stop("Missing required parameter `job_id`.") + } + + urlPath <- "/shuttle/integration/status/{jobId}" + if (!missing(`job_id`)) { + urlPath <- gsub(paste0("\\{", "jobId", "\\}"), URLencode(as.character(`job_id`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "DELETE", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + enqueue_integration = function(integration_name, integration_key, ...){ + apiResponse <- self$enqueue_integrationWithHttpInfo(integration_name, integration_key, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + enqueue_integrationWithHttpInfo = function(integration_name, integration_key, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`integration_name`)) { + stop("Missing required parameter `integration_name`.") + } + + if (missing(`integration_key`)) { + stop("Missing required parameter `integration_key`.") + } + + urlPath <- "/shuttle/integration/{integrationName}/{integrationKey}" + if (!missing(`integration_name`)) { + urlPath <- gsub(paste0("\\{", "integrationName", "\\}"), URLencode(as.character(`integration_name`), reserved = TRUE), urlPath) + } + + if (!missing(`integration_key`)) { + urlPath <- gsub(paste0("\\{", "integrationKey", "\\}"), URLencode(as.character(`integration_key`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "character", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + poll_all_integrations = function(...){ + apiResponse <- self$poll_all_integrationsWithHttpInfo(...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + poll_all_integrationsWithHttpInfo = function(...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + urlPath <- "/shuttle/integration/status" + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "list(IntegrationJob)", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + poll_integration = function(job_id, ...){ + apiResponse <- self$poll_integrationWithHttpInfo(job_id, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + poll_integrationWithHttpInfo = function(job_id, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`job_id`)) { + stop("Missing required parameter `job_id`.") + } + + urlPath <- "/shuttle/integration/status/{jobId}" + if (!missing(`job_id`)) { + urlPath <- gsub(paste0("\\{", "jobId", "\\}"), URLencode(as.character(`job_id`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "character", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + read_integration_definition = function(integration_name, ...){ + apiResponse <- self$read_integration_definitionWithHttpInfo(integration_name, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + read_integration_definitionWithHttpInfo = function(integration_name, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`integration_name`)) { + stop("Missing required parameter `integration_name`.") + } + + urlPath <- "/shuttle/integration/definition/{integrationName}" + if (!missing(`integration_name`)) { + urlPath <- gsub(paste0("\\{", "integrationName", "\\}"), URLencode(as.character(`integration_name`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "GET", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + deserializedRespObj <- tryCatch( + self$apiClient$deserialize(resp, "Integration", loadNamespace("openlattice")), + error = function(e){ + stop("Failed to deserialize response") + } + ) + ApiResponse$new(deserializedRespObj, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + }, + update_integration_definition = function(integration_name, integration_update, ...){ + apiResponse <- self$update_integration_definitionWithHttpInfo(integration_name, integration_update, ...) + resp <- apiResponse$response + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + apiResponse$content + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + apiResponse + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + apiResponse + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + apiResponse + } + }, + + update_integration_definitionWithHttpInfo = function(integration_name, integration_update, ...){ + args <- list(...) + queryParams <- list() + headerParams <- c() + + if (missing(`integration_name`)) { + stop("Missing required parameter `integration_name`.") + } + + if (missing(`integration_update`)) { + stop("Missing required parameter `integration_update`.") + } + + if (!missing(`integration_update`)) { + body <- sprintf( + ' + %s + ', + jsonlite::toJSON(`integration_update`$toJSON(), auto_unbox=TRUE, digits = NA) + ) + } else { + body <- NULL + } + + urlPath <- "/shuttle/integration/definition/{integrationName}" + if (!missing(`integration_name`)) { + urlPath <- gsub(paste0("\\{", "integrationName", "\\}"), URLencode(as.character(`integration_name`), reserved = TRUE), urlPath) + } + + # API key authentication + if ("Authorization" %in% names(self$apiClient$apiKeys) && nchar(self$apiClient$apiKeys["Authorization"]) > 0) { + headerParams['Authorization'] <- paste(unlist(self$apiClient$apiKeys["Authorization"]), collapse='') + } + + resp <- self$apiClient$CallApi(url = paste0(self$apiClient$basePath, urlPath), + method = "PATCH", + queryParams = queryParams, + headerParams = headerParams, + body = body, + ...) + + if (httr::status_code(resp) >= 200 && httr::status_code(resp) <= 299) { + ApiResponse$new(NULL, resp) + } else if (httr::status_code(resp) >= 300 && httr::status_code(resp) <= 399) { + ApiResponse$new(paste("Server returned " , httr::status_code(resp) , " response status code."), resp) + } else if (httr::status_code(resp) >= 400 && httr::status_code(resp) <= 499) { + ApiResponse$new("API client error", resp) + } else if (httr::status_code(resp) >= 500 && httr::status_code(resp) <= 599) { + ApiResponse$new("API server error", resp) + } + } + ) +) diff --git a/R/R/sms_entity_set_information.R b/R/R/sms_entity_set_information.R index abf34f0..0a78d22 100644 --- a/R/R/sms_entity_set_information.R +++ b/R/R/sms_entity_set_information.R @@ -8,11 +8,8 @@ #' @docType class #' @title SmsEntitySetInformation -#' #' @description SmsEntitySetInformation Class -#' #' @format An \code{R6Class} generator object -#' #' @field phoneNumber character [optional] #' #' @field organizationId character [optional] @@ -21,6 +18,7 @@ #' #' @field tags list( character ) [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -31,9 +29,7 @@ SmsEntitySetInformation <- R6::R6Class( `organizationId` = NULL, `entitysetIds` = NULL, `tags` = NULL, - initialize = function( - `phoneNumber`=NULL, `organizationId`=NULL, `entitysetIds`=NULL, `tags`=NULL, ... - ) { + initialize = function(`phoneNumber`=NULL, `organizationId`=NULL, `entitysetIds`=NULL, `tags`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`phoneNumber`)) { stopifnot(is.character(`phoneNumber`), length(`phoneNumber`) == 1) @@ -89,7 +85,6 @@ SmsEntitySetInformation <- R6::R6Class( if (!is.null(SmsEntitySetInformationObject$`tags`)) { self$`tags` <- ApiClient$new()$deserializeObj(SmsEntitySetInformationObject$`tags`, "array[character]", loadNamespace("openlattice")) } - self }, toJSONString = function() { jsoncontent <- c( @@ -135,4 +130,3 @@ SmsEntitySetInformation <- R6::R6Class( } ) ) - diff --git a/R/R/sort_definition.R b/R/R/sort_definition.R index e8f59a7..acab572 100644 --- a/R/R/sort_definition.R +++ b/R/R/sort_definition.R @@ -8,14 +8,11 @@ #' @docType class #' @title SortDefinition -#' #' @description SortDefinition Class -#' #' @format An \code{R6Class} generator object -#' #' @field type character [optional] #' -#' @field isDescending character [optional] +#' @field descending character [optional] #' #' @field propertyTypeId character [optional] #' @@ -23,6 +20,7 @@ #' #' @field longitude numeric [optional] #' +#' #' @importFrom R6 R6Class #' @importFrom jsonlite fromJSON toJSON #' @export @@ -30,20 +28,18 @@ SortDefinition <- R6::R6Class( 'SortDefinition', public = list( `type` = NULL, - `isDescending` = NULL, + `descending` = NULL, `propertyTypeId` = NULL, `latitude` = NULL, `longitude` = NULL, - initialize = function( - `type`=NULL, `isDescending`=NULL, `propertyTypeId`=NULL, `latitude`=NULL, `longitude`=NULL, ... - ) { + initialize = function(`type`=NULL, `descending`=NULL, `propertyTypeId`=NULL, `latitude`=NULL, `longitude`=NULL, ...){ local.optional.var <- list(...) if (!is.null(`type`)) { stopifnot(is.character(`type`), length(`type`) == 1) self$`type` <- `type` } - if (!is.null(`isDescending`)) { - self$`isDescending` <- `isDescending` + if (!is.null(`descending`)) { + self$`descending` <- `descending` } if (!is.null(`propertyTypeId`)) { stopifnot(is.character(`propertyTypeId`), length(`propertyTypeId`) == 1) @@ -62,9 +58,9 @@ SortDefinition <- R6::R6Class( SortDefinitionObject[['type']] <- self$`type` } - if (!is.null(self$`isDescending`)) { - SortDefinitionObject[['isDescending']] <- - self$`isDescending` + if (!is.null(self$`descending`)) { + SortDefinitionObject[['descending']] <- + self$`descending` } if (!is.null(self$`propertyTypeId`)) { SortDefinitionObject[['propertyTypeId']] <- @@ -86,8 +82,8 @@ SortDefinition <- R6::R6Class( if (!is.null(SortDefinitionObject$`type`)) { self$`type` <- SortDefinitionObject$`type` } - if (!is.null(SortDefinitionObject$`isDescending`)) { - self$`isDescending` <- SortDefinitionObject$`isDescending` + if (!is.null(SortDefinitionObject$`descending`)) { + self$`descending` <- SortDefinitionObject$`descending` } if (!is.null(SortDefinitionObject$`propertyTypeId`)) { self$`propertyTypeId` <- SortDefinitionObject$`propertyTypeId` @@ -98,7 +94,6 @@ SortDefinition <- R6::R6Class( if (!is.null(SortDefinitionObject$`longitude`)) { self$`longitude` <- SortDefinitionObject$`longitude` } - self }, toJSONString = function() { jsoncontent <- c( @@ -109,12 +104,12 @@ SortDefinition <- R6::R6Class( ', self$`type` )}, - if (!is.null(self$`isDescending`)) { + if (!is.null(self$`descending`)) { sprintf( - '"isDescending": + '"descending": "%s" ', - self$`isDescending` + self$`descending` )}, if (!is.null(self$`propertyTypeId`)) { sprintf( @@ -144,7 +139,7 @@ SortDefinition <- R6::R6Class( fromJSONString = function(SortDefinitionJson) { SortDefinitionObject <- jsonlite::fromJSON(SortDefinitionJson) self$`type` <- SortDefinitionObject$`type` - self$`isDescending` <- SortDefinitionObject$`isDescending` + self$`descending` <- SortDefinitionObject$`descending` self$`propertyTypeId` <- SortDefinitionObject$`propertyTypeId` self$`latitude` <- SortDefinitionObject$`latitude` self$`longitude` <- SortDefinitionObject$`longitude` @@ -152,4 +147,3 @@ SortDefinition <- R6::R6Class( } ) ) - diff --git a/R/README.md b/R/README.md index ac62890..ea1190e 100644 --- a/R/README.md +++ b/R/README.md @@ -62,6 +62,20 @@ Class | Method | HTTP request | Description *AdminApi* | [**update_reindex**](docs/AdminApi.md#update_reindex) | **PUT** /indexer/index/reindex | Replaces job descriptions for performing a partial or full reindex of provided entity sets. *AuthorizationsApi* | [**check_authorizations**](docs/AuthorizationsApi.md#check_authorizations) | **POST** /datastore/authorizations | Check authorizations *AuthorizationsApi* | [**get_accessible_objects**](docs/AuthorizationsApi.md#get_accessible_objects) | **GET** /datastore/authorizations | Returns paged results for all authorized objects of specified objectType, that the current user has specified permission for. +*CollectionsApi* | [**add_type_to_entity_type_collection_template**](docs/CollectionsApi.md#add_type_to_entity_type_collection_template) | **PATCH** /datastore/collections/entity/type/{entityTypeCollectionId}/template | Appends type to template of the specified EntityTypeCollection +*CollectionsApi* | [**create_entity_set_collection**](docs/CollectionsApi.md#create_entity_set_collection) | **POST** /datastore/collections/entity/set | Creates a new EntitySetCollection +*CollectionsApi* | [**create_entity_type_collection**](docs/CollectionsApi.md#create_entity_type_collection) | **POST** /datastore/collections/entity/type | Creates a new EntityTypeCollection +*CollectionsApi* | [**delete_entity_set_collection**](docs/CollectionsApi.md#delete_entity_set_collection) | **DELETE** /datastore/collections/entity/set/{entitySetCollectionId} | Deletes the specified EntitySetCollection +*CollectionsApi* | [**delete_entity_type_collection**](docs/CollectionsApi.md#delete_entity_type_collection) | **DELETE** /datastore/collections/entity/type/{entityTypeCollectionId} | Deletes the specified EntityTypeCollection +*CollectionsApi* | [**get_all_entity_set_collections**](docs/CollectionsApi.md#get_all_entity_set_collections) | **GET** /datastore/collections/entity/set | Returns all EntitySetCollection objects +*CollectionsApi* | [**get_all_entity_type_collections**](docs/CollectionsApi.md#get_all_entity_type_collections) | **GET** /datastore/collections/entity/type | Returns all EntityTypeCollection objects +*CollectionsApi* | [**get_entity_set_collection**](docs/CollectionsApi.md#get_entity_set_collection) | **GET** /datastore/collections/entity/set/{entitySetCollectionId} | Returns the EntitySetCollection object for a given id +*CollectionsApi* | [**get_entity_set_collections_of_type**](docs/CollectionsApi.md#get_entity_set_collections_of_type) | **GET** /datastore/collections/entity/set/entity/type/{entitySetCollectionId} | Returns all authorized EntitySetCollections for a given EntityTypeCollection id +*CollectionsApi* | [**get_entity_type_collection**](docs/CollectionsApi.md#get_entity_type_collection) | **GET** /datastore/collections/entity/type/{entityTypeCollectionId} | Returns the EntityTypeCollection object for a given id +*CollectionsApi* | [**remove_type_from_entity_type_collection_template**](docs/CollectionsApi.md#remove_type_from_entity_type_collection_template) | **DELETE** /datastore/collections/entity/type/{entityTypeCollectionId}/template/{typeId} | Removes a key from an EntityTypeCollection template +*CollectionsApi* | [**update_entity_set_collection_metadata**](docs/CollectionsApi.md#update_entity_set_collection_metadata) | **PATCH** /datastore/collections/entity/set/{entitySetCollectionId} | Updates metadata of the specified EntitySetCollection +*CollectionsApi* | [**update_entity_set_collection_template**](docs/CollectionsApi.md#update_entity_set_collection_template) | **PATCH** /datastore/collections/entity/set/{entitySetCollectionId}/template | Updates template of the specified EntitySetCollection +*CollectionsApi* | [**update_entity_type_collection_metadata**](docs/CollectionsApi.md#update_entity_type_collection_metadata) | **PATCH** /datastore/collections/entity/type/{entityTypeCollectionId} | Updates metadata of the specified EntityTypeCollection *DataApi* | [**create_associations**](docs/DataApi.md#create_associations) | **POST** /datastore/data/association | Creates a new set of associations. *DataApi* | [**create_edges**](docs/DataApi.md#create_edges) | **PUT** /datastore/data/association | Creates a new set of associations. *DataApi* | [**create_entities**](docs/DataApi.md#create_entities) | **POST** /datastore/data/set/ | Creates a new set of entities. @@ -69,7 +83,7 @@ Class | Method | HTTP request | Description *DataApi* | [**delete_all_entities_from_entity_set**](docs/DataApi.md#delete_all_entities_from_entity_set) | **DELETE** /datastore/data/set/{entitySetId}/all | Clears the Entity matching the given Entity id and all of its neighbor Entities *DataApi* | [**delete_entities**](docs/DataApi.md#delete_entities) | **DELETE** /datastore/data/set/{entitySetId} | Deletes multiple entities from an entity set. *DataApi* | [**delete_entities_and_neighbors**](docs/DataApi.md#delete_entities_and_neighbors) | **POST** /datastore/data/set/{entitySetId}/neighbors | Deletes the entities matching the given entity ids and all of its neighbor entities provided in the filter. -*DataApi* | [**delete_entity**](docs/DataApi.md#delete_entity) | **DELETE** /datastore/data/{entitySetId}/{entityKeyId} | Deletes a single entity from an entity set. +*DataApi* | [**delete_entity**](docs/DataApi.md#delete_entity) | **DELETE** /datastore/data/set/{entitySetId}/{entityKeyId} | Deletes a single entity from an entity set. *DataApi* | [**delete_entity_properties**](docs/DataApi.md#delete_entity_properties) | **DELETE** /datastore/data/{entitySetId}/{entityKeyId}/properties | Deletes properties from an entity. *DataApi* | [**get_entity**](docs/DataApi.md#get_entity) | **GET** /datastore/data/{entitySetId}/{entityKeyId} | Loads a single entity by its entityKeyId and entitySetId *DataApi* | [**get_entity_property_values**](docs/DataApi.md#get_entity_property_values) | **GET** /datastore/data/{entitySetId}/{entityKeyId}/{propertyTypeId} | Loads property values for a single entity by its entityKeyId, entitySetId and propertyTypeId @@ -210,17 +224,36 @@ Class | Method | HTTP request | Description *PrincipalApi* | [**get_current_roles**](docs/PrincipalApi.md#get_current_roles) | **GET** /datastore/principals/roles/current/ | Get current roles. *PrincipalApi* | [**get_materialized_view_account**](docs/PrincipalApi.md#get_materialized_view_account) | **GET** /datastore/principals/db | Get the db access credentials. *PrincipalApi* | [**get_user**](docs/PrincipalApi.md#get_user) | **GET** /datastore/principals/users/{userId} | Get the user for the given id. +*PrincipalApi* | [**search_all_users**](docs/PrincipalApi.md#search_all_users) | **GET** /datastore/principals/users/search/"{searchQuery}" | Get the user id for the given search. *PrincipalApi* | [**search_all_users_by_email**](docs/PrincipalApi.md#search_all_users_by_email) | **GET** /datastore/principals/users/search/email/"{emailAddress}" | Get the user id for the given email address. +*PrincipalApi* | [**sync_calling_user**](docs/PrincipalApi.md#sync_calling_user) | **GET** /datastore/principals/sync/ | Activates a user in the OpenLattice system. This call must be made once before a user will be available for use in authorization policies. *SearchApi* | [**execute_advanced_entity_set_data_query**](docs/SearchApi.md#execute_advanced_entity_set_data_query) | **POST** /datastore/search/advanced/{entitySetId} | Executes a search over the data of a given entity set to find rows that match the search term +*SearchApi* | [**execute_app_search**](docs/SearchApi.md#execute_app_search) | **POST** /datastore/search/app | Executes a search over all apps to find ones that match the given search term +*SearchApi* | [**execute_app_type_search**](docs/SearchApi.md#execute_app_type_search) | **POST** /datastore/search/app_types | Executes a search over all app types to find ones that match the given search term +*SearchApi* | [**execute_association_type_search**](docs/SearchApi.md#execute_association_type_search) | **POST** /datastore/search/association_types | Executes a search over all association types to find ones that match the given search term *SearchApi* | [**execute_entity_neighbor_search**](docs/SearchApi.md#execute_entity_neighbor_search) | **GET** /datastore/search/{entitySetId}/{entityKeyId} | Executes a search for all neighbors of an entity that are connected by an association *SearchApi* | [**execute_entity_neighbor_search_bulk**](docs/SearchApi.md#execute_entity_neighbor_search_bulk) | **POST** /datastore/search/{entitySetId}/neighbors | Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association +*SearchApi* | [**execute_entity_set_collection_search**](docs/SearchApi.md#execute_entity_set_collection_search) | **POST** /datastore/search/entity_sets/collections | Executes a search over all EntitySetCollections to find ones that match the given search term *SearchApi* | [**execute_entity_set_data_query**](docs/SearchApi.md#execute_entity_set_data_query) | **POST** /datastore/search/{entitySetId} | Executes a search over the data of a given entity set to find rows that match the search term *SearchApi* | [**execute_entity_set_keyword_query**](docs/SearchApi.md#execute_entity_set_keyword_query) | **POST** /datastore/search | The query, entityType, and propertyTypes params are all optional, but at least one must be specified otherwise an error will be thrown. All specified params are required to be present in each entity set returned. If entityType and propertyTypes are both specified, the propertyTypes param will be ignored. +*SearchApi* | [**execute_entity_type_collection_search**](docs/SearchApi.md#execute_entity_type_collection_search) | **POST** /datastore/search/entity_types/collections | Executes a search over all EntityTypeCollections to find ones that match the given search term +*SearchApi* | [**execute_entity_type_search**](docs/SearchApi.md#execute_entity_type_search) | **POST** /datastore/search/entity_types | Executes a search over all entity types to find ones that match the given search term *SearchApi* | [**execute_filtered_entity_neighbor_id_search**](docs/SearchApi.md#execute_filtered_entity_neighbor_id_search) | **POST** /datastore/search/{entitySetId}/neighbors/advanced/ids | Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association and returns a simple version of the neighborDetails *SearchApi* | [**execute_filtered_entity_neighbor_search**](docs/SearchApi.md#execute_filtered_entity_neighbor_search) | **POST** /datastore/search/{entitySetId}/neighbors/advanced | Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association +*SearchApi* | [**execute_fqn_property_type_search**](docs/SearchApi.md#execute_fqn_property_type_search) | **POST** /datastore/search/property_types/fqn | Executes a search over all property types to find ones that match the given name and namespace, including partial matches +*SearchApi* | [**execute_organization_search**](docs/SearchApi.md#execute_organization_search) | **POST** /datastore/search/organizations | Executes a search over all organizations to find ones that match the given search term +*SearchApi* | [**execute_property_type_search**](docs/SearchApi.md#execute_property_type_search) | **POST** /datastore/search/property_types | Executes a search over all property types to find ones that match the given search term *SearchApi* | [**get_entity_sets**](docs/SearchApi.md#get_entity_sets) | **GET** /datastore/search/entity-sets/{start}/{numResults} | Executes a search over all existing entity sets to populate the home page. The path parameters instruct which page to return and how large the page should be. *SearchApi* | [**get_popular_entity_set**](docs/SearchApi.md#get_popular_entity_set) | **GET** /datastore/search/popular | Get the most popular entity sets. *SearchApi* | [**search_entity_set_data**](docs/SearchApi.md#search_entity_set_data) | **PATCH** /datastore/search | Executes a search over the data of a given entity set to find rows that match the search term +*ShuttleApi* | [**create_integration_definition**](docs/ShuttleApi.md#create_integration_definition) | **POST** /shuttle/integration/definition/{integrationName} | Creates a new integration definition for running recurring integrations +*ShuttleApi* | [**delete_integration_definition**](docs/ShuttleApi.md#delete_integration_definition) | **DELETE** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition +*ShuttleApi* | [**delete_integration_job_status**](docs/ShuttleApi.md#delete_integration_job_status) | **DELETE** /shuttle/integration/status/{jobId} | Deletes an integration job status from the integrationJobs map +*ShuttleApi* | [**enqueue_integration**](docs/ShuttleApi.md#enqueue_integration) | **GET** /shuttle/integration/{integrationName}/{integrationKey} | Enqueues an integration on Shuttle Server for a given integration +*ShuttleApi* | [**poll_all_integrations**](docs/ShuttleApi.md#poll_all_integrations) | **GET** /shuttle/integration/status | Polls the statuses of all running integrations +*ShuttleApi* | [**poll_integration**](docs/ShuttleApi.md#poll_integration) | **GET** /shuttle/integration/status/{jobId} | Polls the status of an integration +*ShuttleApi* | [**read_integration_definition**](docs/ShuttleApi.md#read_integration_definition) | **GET** /shuttle/integration/definition/{integrationName} | Gets an existing integration definition +*ShuttleApi* | [**update_integration_definition**](docs/ShuttleApi.md#update_integration_definition) | **PATCH** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition ## Documentation for Models @@ -231,11 +264,13 @@ Class | Method | HTTP request | Description - [AclData](docs/AclData.md) - [AdvancedSearch](docs/AdvancedSearch.md) - [Association](docs/Association.md) + - [AssociationDefinition](docs/AssociationDefinition.md) - [AssociationType](docs/AssociationType.md) - [Auth0userBasic](docs/Auth0userBasic.md) - [Authorization](docs/Authorization.md) - [AuthorizedObjectsSearchResult](docs/AuthorizedObjectsSearchResult.md) - [BulkDataCreation](docs/BulkDataCreation.md) + - [CollectionTemplateType](docs/CollectionTemplateType.md) - [Constraint](docs/Constraint.md) - [ConstraintGroup](docs/ConstraintGroup.md) - [DataAssociation](docs/DataAssociation.md) @@ -250,21 +285,30 @@ Class | Method | HTTP request | Description - [EdmRequest](docs/EdmRequest.md) - [Entity](docs/Entity.md) - [EntityDataKey](docs/EntityDataKey.md) + - [EntityDefinition](docs/EntityDefinition.md) - [EntityKey](docs/EntityKey.md) - [EntityKeyPair](docs/EntityKeyPair.md) - [EntityLinkingFeatures](docs/EntityLinkingFeatures.md) - [EntityLinkingFeedback](docs/EntityLinkingFeedback.md) - [EntityNeighborsFilter](docs/EntityNeighborsFilter.md) - [EntitySet](docs/EntitySet.md) + - [EntitySetCollection](docs/EntitySetCollection.md) - [EntitySetPropertyMetaData](docs/EntitySetPropertyMetaData.md) - [EntitySetSelection](docs/EntitySetSelection.md) - [EntityType](docs/EntityType.md) + - [EntityTypeCollection](docs/EntityTypeCollection.md) - [EntityTypePropertyMetadata](docs/EntityTypePropertyMetadata.md) + - [Flight](docs/Flight.md) + - [FlightPlanParameters](docs/FlightPlanParameters.md) + - [FlightPlanParametersUpdate](docs/FlightPlanParametersUpdate.md) - [FullQualifiedName](docs/FullQualifiedName.md) - [IndexingState](docs/IndexingState.md) - [InlineObject](docs/InlineObject.md) - [InlineResponse200](docs/InlineResponse200.md) + - [Integration](docs/Integration.md) + - [IntegrationJob](docs/IntegrationJob.md) - [IntegrationResults](docs/IntegrationResults.md) + - [IntegrationUpdate](docs/IntegrationUpdate.md) - [LinkingFeedback](docs/LinkingFeedback.md) - [MaterializedViewAccount](docs/MaterializedViewAccount.md) - [MetadataUpdate](docs/MetadataUpdate.md) @@ -277,6 +321,7 @@ Class | Method | HTTP request | Description - [OrganizationExternalDatabaseTableColumnsPair](docs/OrganizationExternalDatabaseTableColumnsPair.md) - [OrganizationMember](docs/OrganizationMember.md) - [Principal](docs/Principal.md) + - [PropertyDefinition](docs/PropertyDefinition.md) - [PropertyType](docs/PropertyType.md) - [PropertyUsageSummary](docs/PropertyUsageSummary.md) - [Role](docs/Role.md) diff --git a/R/docs/AssociationDefinition.md b/R/docs/AssociationDefinition.md new file mode 100644 index 0000000..3b19121 --- /dev/null +++ b/R/docs/AssociationDefinition.md @@ -0,0 +1,13 @@ +# openlattice::AssociationDefinition + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fqn** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**entitySetName** | **character** | | [optional] +**propertyDefinitions** | [**list(PropertyDefinition)**](PropertyDefinition.md) | | [optional] +**updateType** | **character** | | [optional] +**src** | **character** | | [optional] +**dst** | **character** | | [optional] + + diff --git a/R/docs/AuthorizedObjectsSearchResult.md b/R/docs/AuthorizedObjectsSearchResult.md index 4a64b16..150e321 100644 --- a/R/docs/AuthorizedObjectsSearchResult.md +++ b/R/docs/AuthorizedObjectsSearchResult.md @@ -4,6 +4,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pagingToken** | **character** | | [optional] -**authorizedObjects** | **array[array[character]]** | | [optional] +**authorizedObjects** | [**array[array[character]]**](array.md) | | [optional] diff --git a/R/docs/CollectionTemplateType.md b/R/docs/CollectionTemplateType.md new file mode 100644 index 0000000..f58af35 --- /dev/null +++ b/R/docs/CollectionTemplateType.md @@ -0,0 +1,12 @@ +# openlattice::CollectionTemplateType + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **character** | An optional UUID for the collection template type. | [optional] +**name** | **character** | The unique name of the collection template type. | [optional] +**title** | **character** | The friendly name for the collection template type. | [optional] +**description** | **character** | A description of the collection template type. | [optional] +**entityTypeId** | **character** | The id of the entity type that this collection template type wraps. | [optional] + + diff --git a/R/docs/CollectionsApi.md b/R/docs/CollectionsApi.md new file mode 100644 index 0000000..dff5aeb --- /dev/null +++ b/R/docs/CollectionsApi.md @@ -0,0 +1,661 @@ +# CollectionsApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_type_to_entity_type_collection_template**](CollectionsApi.md#add_type_to_entity_type_collection_template) | **PATCH** /datastore/collections/entity/type/{entityTypeCollectionId}/template | Appends type to template of the specified EntityTypeCollection +[**create_entity_set_collection**](CollectionsApi.md#create_entity_set_collection) | **POST** /datastore/collections/entity/set | Creates a new EntitySetCollection +[**create_entity_type_collection**](CollectionsApi.md#create_entity_type_collection) | **POST** /datastore/collections/entity/type | Creates a new EntityTypeCollection +[**delete_entity_set_collection**](CollectionsApi.md#delete_entity_set_collection) | **DELETE** /datastore/collections/entity/set/{entitySetCollectionId} | Deletes the specified EntitySetCollection +[**delete_entity_type_collection**](CollectionsApi.md#delete_entity_type_collection) | **DELETE** /datastore/collections/entity/type/{entityTypeCollectionId} | Deletes the specified EntityTypeCollection +[**get_all_entity_set_collections**](CollectionsApi.md#get_all_entity_set_collections) | **GET** /datastore/collections/entity/set | Returns all EntitySetCollection objects +[**get_all_entity_type_collections**](CollectionsApi.md#get_all_entity_type_collections) | **GET** /datastore/collections/entity/type | Returns all EntityTypeCollection objects +[**get_entity_set_collection**](CollectionsApi.md#get_entity_set_collection) | **GET** /datastore/collections/entity/set/{entitySetCollectionId} | Returns the EntitySetCollection object for a given id +[**get_entity_set_collections_of_type**](CollectionsApi.md#get_entity_set_collections_of_type) | **GET** /datastore/collections/entity/set/entity/type/{entitySetCollectionId} | Returns all authorized EntitySetCollections for a given EntityTypeCollection id +[**get_entity_type_collection**](CollectionsApi.md#get_entity_type_collection) | **GET** /datastore/collections/entity/type/{entityTypeCollectionId} | Returns the EntityTypeCollection object for a given id +[**remove_type_from_entity_type_collection_template**](CollectionsApi.md#remove_type_from_entity_type_collection_template) | **DELETE** /datastore/collections/entity/type/{entityTypeCollectionId}/template/{typeId} | Removes a key from an EntityTypeCollection template +[**update_entity_set_collection_metadata**](CollectionsApi.md#update_entity_set_collection_metadata) | **PATCH** /datastore/collections/entity/set/{entitySetCollectionId} | Updates metadata of the specified EntitySetCollection +[**update_entity_set_collection_template**](CollectionsApi.md#update_entity_set_collection_template) | **PATCH** /datastore/collections/entity/set/{entitySetCollectionId}/template | Updates template of the specified EntitySetCollection +[**update_entity_type_collection_metadata**](CollectionsApi.md#update_entity_type_collection_metadata) | **PATCH** /datastore/collections/entity/type/{entityTypeCollectionId} | Updates metadata of the specified EntityTypeCollection + + +# **add_type_to_entity_type_collection_template** +> add_type_to_entity_type_collection_template(entity_type_collection_id, collection_template_type) + +Appends type to template of the specified EntityTypeCollection + +### Example +```R +library(openlattice) + +var.entity_type_collection_id <- 'entity_type_collection_id_example' # character | +var.collection_template_type <- CollectionTemplateType$new("id_example", "name_example", "title_example", "description_example", "entityTypeId_example") # CollectionTemplateType | + +#Appends type to template of the specified EntityTypeCollection +api.instance <- CollectionsApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +api.instance$add_type_to_entity_type_collection_template(var.entity_type_collection_id, var.collection_template_type) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_collection_id** | [**character**](.md)| | + **collection_template_type** | [**CollectionTemplateType**](CollectionTemplateType.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **create_entity_set_collection** +> character create_entity_set_collection(entity_set_collection) + +Creates a new EntitySetCollection + +### Example +```R +library(openlattice) + +var.entity_set_collection <- EntitySetCollection$new("id_example", "name_example", "title_example", "description_example", "entityTypeCollectionId_example", TODO, list("contacts_example"), "organizationId_example") # EntitySetCollection | + +#Creates a new EntitySetCollection +api.instance <- CollectionsApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$create_entity_set_collection(var.entity_set_collection) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_collection** | [**EntitySetCollection**](EntitySetCollection.md)| | + +### Return type + +**character** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **create_entity_type_collection** +> character create_entity_type_collection(entity_type_collection) + +Creates a new EntityTypeCollection + +### Example +```R +library(openlattice) + +var.entity_type_collection <- EntityTypeCollection$new("id_example", FullQualifiedName$new("name_example", "namespace_example"), "title_example", "description_example", list(FullQualifiedName$new("name_example", "namespace_example")), list(CollectionTemplateType$new("id_example", "name_example", "title_example", "description_example", "entityTypeId_example"))) # EntityTypeCollection | + +#Creates a new EntityTypeCollection +api.instance <- CollectionsApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$create_entity_type_collection(var.entity_type_collection) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_collection** | [**EntityTypeCollection**](EntityTypeCollection.md)| | + +### Return type + +**character** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **delete_entity_set_collection** +> delete_entity_set_collection(entity_set_collection_id) + +Deletes the specified EntitySetCollection + +### Example +```R +library(openlattice) + +var.entity_set_collection_id <- 'entity_set_collection_id_example' # character | + +#Deletes the specified EntitySetCollection +api.instance <- CollectionsApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +api.instance$delete_entity_set_collection(var.entity_set_collection_id) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_collection_id** | [**character**](.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **delete_entity_type_collection** +> delete_entity_type_collection(entity_type_collection_id) + +Deletes the specified EntityTypeCollection + +### Example +```R +library(openlattice) + +var.entity_type_collection_id <- 'entity_type_collection_id_example' # character | + +#Deletes the specified EntityTypeCollection +api.instance <- CollectionsApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +api.instance$delete_entity_type_collection(var.entity_type_collection_id) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_collection_id** | [**character**](.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **get_all_entity_set_collections** +> array[EntitySetCollection] get_all_entity_set_collections() + +Returns all EntitySetCollection objects + +### Example +```R +library(openlattice) + + +#Returns all EntitySetCollection objects +api.instance <- CollectionsApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$get_all_entity_set_collections() +dput(result) +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**array[EntitySetCollection]**](EntitySetCollection.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **get_all_entity_type_collections** +> array[EntityTypeCollection] get_all_entity_type_collections() + +Returns all EntityTypeCollection objects + +### Example +```R +library(openlattice) + + +#Returns all EntityTypeCollection objects +api.instance <- CollectionsApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$get_all_entity_type_collections() +dput(result) +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**array[EntityTypeCollection]**](EntityTypeCollection.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **get_entity_set_collection** +> EntitySetCollection get_entity_set_collection(entity_set_collection_id) + +Returns the EntitySetCollection object for a given id + +### Example +```R +library(openlattice) + +var.entity_set_collection_id <- 'entity_set_collection_id_example' # character | + +#Returns the EntitySetCollection object for a given id +api.instance <- CollectionsApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$get_entity_set_collection(var.entity_set_collection_id) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_collection_id** | [**character**](.md)| | + +### Return type + +[**EntitySetCollection**](EntitySetCollection.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **get_entity_set_collections_of_type** +> array[EntitySetCollection] get_entity_set_collections_of_type(entity_set_collection_id) + +Returns all authorized EntitySetCollections for a given EntityTypeCollection id + +### Example +```R +library(openlattice) + +var.entity_set_collection_id <- 'entity_set_collection_id_example' # character | + +#Returns all authorized EntitySetCollections for a given EntityTypeCollection id +api.instance <- CollectionsApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$get_entity_set_collections_of_type(var.entity_set_collection_id) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_collection_id** | [**character**](.md)| | + +### Return type + +[**array[EntitySetCollection]**](EntitySetCollection.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **get_entity_type_collection** +> EntityTypeCollection get_entity_type_collection(entity_type_collection_id) + +Returns the EntityTypeCollection object for a given id + +### Example +```R +library(openlattice) + +var.entity_type_collection_id <- 'entity_type_collection_id_example' # character | + +#Returns the EntityTypeCollection object for a given id +api.instance <- CollectionsApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$get_entity_type_collection(var.entity_type_collection_id) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_collection_id** | [**character**](.md)| | + +### Return type + +[**EntityTypeCollection**](EntityTypeCollection.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **remove_type_from_entity_type_collection_template** +> remove_type_from_entity_type_collection_template(entity_type_collection_id, type_id) + +Removes a key from an EntityTypeCollection template + +### Example +```R +library(openlattice) + +var.entity_type_collection_id <- 'entity_type_collection_id_example' # character | +var.type_id <- 'type_id_example' # character | + +#Removes a key from an EntityTypeCollection template +api.instance <- CollectionsApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +api.instance$remove_type_from_entity_type_collection_template(var.entity_type_collection_id, var.type_id) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_collection_id** | [**character**](.md)| | + **type_id** | [**character**](.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **update_entity_set_collection_metadata** +> update_entity_set_collection_metadata(entity_set_collection_id, metadata_update) + +Updates metadata of the specified EntitySetCollection + +### Example +```R +library(openlattice) + +var.entity_set_collection_id <- 'entity_set_collection_id_example' # character | +var.metadata_update <- MetadataUpdate$new("title_example", "description_example", "name_example", list("contacts_example"), FullQualifiedName$new("name_example", "namespace_example"), "pii_example", "defaultShow_example", "url_example", TODO, "indexType_example", "organizationId_example", list(123), list("enumValues_example")) # MetadataUpdate | + +#Updates metadata of the specified EntitySetCollection +api.instance <- CollectionsApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +api.instance$update_entity_set_collection_metadata(var.entity_set_collection_id, var.metadata_update) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_collection_id** | [**character**](.md)| | + **metadata_update** | [**MetadataUpdate**](MetadataUpdate.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **update_entity_set_collection_template** +> update_entity_set_collection_template(entity_set_collection_id, request_body) + +Updates template of the specified EntitySetCollection + +### Example +```R +library(openlattice) + +var.entity_set_collection_id <- 'entity_set_collection_id_example' # character | +var.request_body <- TODO # list(character) | + +#Updates template of the specified EntitySetCollection +api.instance <- CollectionsApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +api.instance$update_entity_set_collection_template(var.entity_set_collection_id, var.request_body) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_collection_id** | [**character**](.md)| | + **request_body** | named list( [**list(character)**](character.md) )| | + +### Return type + +void (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **update_entity_type_collection_metadata** +> update_entity_type_collection_metadata(entity_type_collection_id, metadata_update) + +Updates metadata of the specified EntityTypeCollection + +### Example +```R +library(openlattice) + +var.entity_type_collection_id <- 'entity_type_collection_id_example' # character | +var.metadata_update <- MetadataUpdate$new("title_example", "description_example", "name_example", list("contacts_example"), FullQualifiedName$new("name_example", "namespace_example"), "pii_example", "defaultShow_example", "url_example", TODO, "indexType_example", "organizationId_example", list(123), list("enumValues_example")) # MetadataUpdate | + +#Updates metadata of the specified EntityTypeCollection +api.instance <- CollectionsApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +api.instance$update_entity_type_collection_metadata(var.entity_type_collection_id, var.metadata_update) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_collection_id** | [**character**](.md)| | + **metadata_update** | [**MetadataUpdate**](MetadataUpdate.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + diff --git a/R/docs/Constraint.md b/R/docs/Constraint.md index 522f2a5..7d7d6c8 100644 --- a/R/docs/Constraint.md +++ b/R/docs/Constraint.md @@ -12,7 +12,7 @@ Name | Type | Description | Notes **longitude** | **numeric** | | [optional] **radius** | **numeric** | | [optional] **unit** | **character** | | [optional] -**zones** | **array[array[array[numeric]]]** | | [optional] +**zones** | [**array[array[array[numeric]]]**](array.md) | | [optional] **start** | **character** | | [optional] **end** | **character** | | [optional] diff --git a/R/docs/DataApi.md b/R/docs/DataApi.md index e2b4326..9e7807a 100644 --- a/R/docs/DataApi.md +++ b/R/docs/DataApi.md @@ -11,7 +11,7 @@ Method | HTTP request | Description [**delete_all_entities_from_entity_set**](DataApi.md#delete_all_entities_from_entity_set) | **DELETE** /datastore/data/set/{entitySetId}/all | Clears the Entity matching the given Entity id and all of its neighbor Entities [**delete_entities**](DataApi.md#delete_entities) | **DELETE** /datastore/data/set/{entitySetId} | Deletes multiple entities from an entity set. [**delete_entities_and_neighbors**](DataApi.md#delete_entities_and_neighbors) | **POST** /datastore/data/set/{entitySetId}/neighbors | Deletes the entities matching the given entity ids and all of its neighbor entities provided in the filter. -[**delete_entity**](DataApi.md#delete_entity) | **DELETE** /datastore/data/{entitySetId}/{entityKeyId} | Deletes a single entity from an entity set. +[**delete_entity**](DataApi.md#delete_entity) | **DELETE** /datastore/data/set/{entitySetId}/{entityKeyId} | Deletes a single entity from an entity set. [**delete_entity_properties**](DataApi.md#delete_entity_properties) | **DELETE** /datastore/data/{entitySetId}/{entityKeyId}/properties | Deletes properties from an entity. [**get_entity**](DataApi.md#get_entity) | **GET** /datastore/data/{entitySetId}/{entityKeyId} | Loads a single entity by its entityKeyId and entitySetId [**get_entity_property_values**](DataApi.md#get_entity_property_values) | **GET** /datastore/data/{entitySetId}/{entityKeyId}/{propertyTypeId} | Loads property values for a single entity by its entityKeyId, entitySetId and propertyTypeId @@ -54,7 +54,7 @@ Name | Type | Description | Notes ### Return type -**list(array[character])** +[**list(array[character])**](array.md) ### Authorization @@ -144,7 +144,7 @@ dput(result) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **set_id** | [**character**](.md)| | - **request_body** | list( **list(array[character])** )| | + **request_body** | list( [**list(array[character])**](list.md) )| | ### Return type @@ -318,7 +318,7 @@ library(openlattice) var.entity_set_id <- 'entity_set_id_example' # character | var.type <- 'type_example' # character | -var.entity_neighbors_filter <- list(EntityNeighborsFilter$new(list("entityKeyIds_example"), list("srcEntitySetIds_example"), list("dstEntitySetIds_example"), list("associationEntitySetIds_example"))) # array[EntityNeighborsFilter] | +var.entity_neighbors_filter <- list(EntityNeighborsFilter$new(list("entityKeyIds_example"), list("src_example"), list("dst_example"), list("edge_example"))) # array[EntityNeighborsFilter] | #Deletes the entities matching the given entity ids and all of its neighbor entities provided in the filter. api.instance <- DataApi$new() @@ -489,7 +489,7 @@ Name | Type | Description | Notes ### Return type -**list(array[character])** +[**list(array[character])**](array.md) ### Authorization @@ -705,7 +705,7 @@ Gets a list of entities by UUIDs library(openlattice) var.entity_set_id <- 'entity_set_id_example' # character | -var.entity_set_selection <- EntitySetSelection$new(list("ids_example"), list("properties_example")) # EntitySetSelection | +var.entity_set_selection <- list(EntitySetSelection$new(list("ids_example"), list("properties_example"))) # array[EntitySetSelection] | #Gets a list of entities by UUIDs api.instance <- DataApi$new() @@ -723,7 +723,7 @@ dput(result) Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **entity_set_id** | [**character**](.md)| | - **entity_set_selection** | [**EntitySetSelection**](EntitySetSelection.md)| | + **entity_set_selection** | list( [**EntitySetSelection**](EntitySetSelection.md) )| | ### Return type diff --git a/R/docs/DataAssociation.md b/R/docs/DataAssociation.md index 039cf81..8e7e2f2 100644 --- a/R/docs/DataAssociation.md +++ b/R/docs/DataAssociation.md @@ -6,5 +6,9 @@ Name | Type | Description | Notes **srcEntitySetId** | **character** | the ID of the source entity set | [optional] **srcEntityIndex** | **character** | The index of an entity | [optional] **srcEntityKeyId** | **character** | An existing entityKeyId | [optional] +**dstEntitySetId** | **character** | the ID of the dst entity set | [optional] +**dstEntityIndex** | **character** | The index of an entity | [optional] +**dstEntityKeyId** | **character** | An existing entityKeyId | [optional] +**data** | [**list(array[character])**](array.md) | data | [optional] diff --git a/R/docs/DataGraph.md b/R/docs/DataGraph.md index 372cc33..085d48e 100644 --- a/R/docs/DataGraph.md +++ b/R/docs/DataGraph.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**entities** | **list(array[list(array[character])])** | | [optional] -**associations** | **list(array[DataAssociation])** | | [optional] +**entities** | [**list(array[list(array[character])])**](array.md) | | [optional] +**associations** | [**list(array[DataAssociation])**](array.md) | | [optional] diff --git a/R/docs/DataGraphIds.md b/R/docs/DataGraphIds.md index 0fe2437..d343f33 100644 --- a/R/docs/DataGraphIds.md +++ b/R/docs/DataGraphIds.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**entityKeyIds** | **list(array[character])** | | [optional] -**entitySetIds** | **list(array[character])** | | [optional] +**entityKeyIds** | [**list(array[character])**](array.md) | | [optional] +**entitySetIds** | [**list(array[character])**](array.md) | | [optional] diff --git a/R/docs/EntityDefinition.md b/R/docs/EntityDefinition.md new file mode 100644 index 0000000..33de05d --- /dev/null +++ b/R/docs/EntityDefinition.md @@ -0,0 +1,11 @@ +# openlattice::EntityDefinition + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fqn** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**entitySetName** | **character** | | [optional] +**propertyDefinitions** | [**list(PropertyDefinition)**](PropertyDefinition.md) | | [optional] +**updateType** | **character** | | [optional] + + diff --git a/R/docs/EntityNeighborsFilter.md b/R/docs/EntityNeighborsFilter.md index 9ed3461..8ba164e 100644 --- a/R/docs/EntityNeighborsFilter.md +++ b/R/docs/EntityNeighborsFilter.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **entityKeyIds** | **array[character]** | | [optional] -**srcEntitySetIds** | **array[character]** | | [optional] -**dstEntitySetIds** | **array[character]** | | [optional] -**associationEntitySetIds** | **array[character]** | | [optional] +**src** | **array[character]** | | [optional] +**dst** | **array[character]** | | [optional] +**edge** | **array[character]** | | [optional] diff --git a/R/docs/EntitySetCollection.md b/R/docs/EntitySetCollection.md new file mode 100644 index 0000000..02a5317 --- /dev/null +++ b/R/docs/EntitySetCollection.md @@ -0,0 +1,15 @@ +# openlattice::EntitySetCollection + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **character** | An optional UUID for the entity set collection. | [optional] +**name** | **character** | The unique name of the entity set collection. | [optional] +**title** | **character** | The friendly name for the entity set collection. | [optional] +**description** | **character** | A description of the entity set collection. | [optional] +**entityTypeCollectionId** | **character** | The id of the entity type collection that this entity set collection maps to. | [optional] +**template** | **list(character)** | A mapping from collection template type ids to entity set ids. | [optional] +**contacts** | **array[character]** | A set of contact methods for the owners of this entity set collection. | [optional] +**organizationId** | **character** | The id of the organization that this entity set collection belongs to. | [optional] + + diff --git a/R/docs/EntityType.md b/R/docs/EntityType.md index 839722a..2323aeb 100644 --- a/R/docs/EntityType.md +++ b/R/docs/EntityType.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **schemas** | [**array[FullQualifiedName]**](FullQualifiedName.md) | | [optional] **key** | **array[character]** | | [optional] **properties** | **array[character]** | | [optional] -**propertyTags** | **list(array[character])** | | [optional] +**propertyTags** | [**list(array[character])**](array.md) | | [optional] **basetype** | **character** | | [optional] **category** | **character** | | [optional] diff --git a/R/docs/EntityTypeCollection.md b/R/docs/EntityTypeCollection.md new file mode 100644 index 0000000..50dc9ee --- /dev/null +++ b/R/docs/EntityTypeCollection.md @@ -0,0 +1,13 @@ +# openlattice::EntityTypeCollection + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **character** | An optional UUID for the entity type collection. | [optional] +**type** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**title** | **character** | The friendly name for the entity type collection. | [optional] +**description** | **character** | A description of the entity type collection. | [optional] +**schemas** | [**array[FullQualifiedName]**](FullQualifiedName.md) | A list of schemas the entity type collection should belong to. | [optional] +**template** | [**array[CollectionTemplateType]**](CollectionTemplateType.md) | A set of CollectionTemplateType objects, which describe the entity types involved in the entity type collection and the purposes they serve | [optional] + + diff --git a/R/docs/Flight.md b/R/docs/Flight.md new file mode 100644 index 0000000..2a8e3a7 --- /dev/null +++ b/R/docs/Flight.md @@ -0,0 +1,12 @@ +# openlattice::Flight + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **character** | | [optional] +**tags** | **array[character]** | | [optional] +**organizationId** | **character** | | [optional] +**entityDefinitions** | [**list(EntityDefinition)**](EntityDefinition.md) | | [optional] +**associationDefinitions** | [**list(AssociationDefinition)**](AssociationDefinition.md) | | [optional] + + diff --git a/R/docs/FlightPlanParameters.md b/R/docs/FlightPlanParameters.md new file mode 100644 index 0000000..eebb0a7 --- /dev/null +++ b/R/docs/FlightPlanParameters.md @@ -0,0 +1,13 @@ +# openlattice::FlightPlanParameters + +Represents the parameters required to create a flight plan (i.e. a Map) +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sql** | **character** | the sql query to be used to pull cleaned data from postgres | [optional] +**src** | **list(character)** | postgres data source for pulling clean data | [optional] +**srcPrimaryKeyColumns** | **array[character]** | the columns that are primary keys in the cleaned data | [optional] +**path** | **character** | the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) | [optional] +**flight** | [**Flight**](Flight.md) | | [optional] + + diff --git a/R/docs/FlightPlanParametersUpdate.md b/R/docs/FlightPlanParametersUpdate.md new file mode 100644 index 0000000..a606c91 --- /dev/null +++ b/R/docs/FlightPlanParametersUpdate.md @@ -0,0 +1,11 @@ +# openlattice::FlightPlanParametersUpdate + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sql** | **character** | the sql query to be used to pull cleaned data from postgres | [optional] +**src** | **list(character)** | postgres data source for pulling clean data | [optional] +**srcPrimaryKeyColumns** | **array[character]** | the columns that are primary keys in the cleaned data | [optional] +**path** | **character** | the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) | [optional] + + diff --git a/R/docs/IndexingState.md b/R/docs/IndexingState.md index da0a75b..4ab9d50 100644 --- a/R/docs/IndexingState.md +++ b/R/docs/IndexingState.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**indexing** | **list(array[character])** | | [optional] +**indexing** | [**list(array[character])**](array.md) | | [optional] **queue** | **array[character]** | | [optional] **currentEntitySet** | **character** | | [optional] **queueSize** | **integer** | | [optional] diff --git a/R/docs/Integration.md b/R/docs/Integration.md new file mode 100644 index 0000000..d0aa9b1 --- /dev/null +++ b/R/docs/Integration.md @@ -0,0 +1,17 @@ +# openlattice::Integration + +Represents a data integration, including all fields required to run the integration. +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **character** | a unique ID used for authorizing a call to run an integration | [optional] +**environment** | **character** | the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) | [optional] +**s3Bucket** | **character** | the url of the s3bucket to be used | [optional] +**contacts** | **array[character]** | the set of email addresses of those responsible for the integration | [optional] +**organizationId** | **character** | the id of the organization that owns the integration | [optional] +**entitySetId** | **character** | the id of the entity set that stores the logs for this integration | [optional] +**maxConnections** | **integer** | maximum number of connections to postgres allowed for this integration | [optional] +**callback** | **array[character]** | urls to receive a POST when integration has completed | [optional] +**flightPlanParameters** | [**list(FlightPlanParameters)**](FlightPlanParameters.md) | a map from [Flight] name to [FlightPlanParameters] | [optional] + + diff --git a/R/docs/IntegrationJob.md b/R/docs/IntegrationJob.md new file mode 100644 index 0000000..b53a5f0 --- /dev/null +++ b/R/docs/IntegrationJob.md @@ -0,0 +1,9 @@ +# openlattice::IntegrationJob + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **character** | | [optional] +**status** | **character** | | [optional] + + diff --git a/R/docs/IntegrationUpdate.md b/R/docs/IntegrationUpdate.md new file mode 100644 index 0000000..3ccdd6c --- /dev/null +++ b/R/docs/IntegrationUpdate.md @@ -0,0 +1,14 @@ +# openlattice::IntegrationUpdate + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**environment** | **character** | the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) | [optional] +**s3Bucket** | **character** | the url of the s3bucket to be used | [optional] +**contacts** | **array[character]** | the set of email addresses of those responsible for the integration | [optional] +**organizationId** | **character** | the id of the organization that owns the integration | [optional] +**maxConnections** | **integer** | maximum number of connections to postgres allowed for this integration | [optional] +**callbackUrls** | **array[character]** | urls to receive a POST when integration has completed | [optional] +**flightPlanParameters** | [**list(FlightPlanParametersUpdate)**](FlightPlanParametersUpdate.md) | a map from [Flight] name to [FlightPlanParametersUpdate] | [optional] + + diff --git a/R/docs/MetadataUpdate.md b/R/docs/MetadataUpdate.md index 94abcc2..f111cff 100644 --- a/R/docs/MetadataUpdate.md +++ b/R/docs/MetadataUpdate.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **pii** | **character** | | [optional] **defaultShow** | **character** | | [optional] **url** | **character** | | [optional] -**propertyTags** | **list(array[character])** | | [optional] +**propertyTags** | [**list(array[character])**](array.md) | | [optional] **indexType** | **character** | | [optional] **organizationId** | **character** | | [optional] **partitions** | **array[integer]** | | [optional] diff --git a/R/docs/NeighborEntityDetails.md b/R/docs/NeighborEntityDetails.md index 8ee41d6..06d03a9 100644 --- a/R/docs/NeighborEntityDetails.md +++ b/R/docs/NeighborEntityDetails.md @@ -4,9 +4,9 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **associationEntitySet** | [**EntitySet**](EntitySet.md) | | [optional] -**associationDetails** | **list(array[character])** | | [optional] +**associationDetails** | [**list(array[character])**](array.md) | | [optional] **neighborEntitySet** | [**EntitySet**](EntitySet.md) | | [optional] **neighborId** | **character** | | [optional] -**neighborDetails** | **list(array[character])** | | [optional] +**neighborDetails** | [**list(array[character])**](array.md) | | [optional] diff --git a/R/docs/OrganizationsApi.md b/R/docs/OrganizationsApi.md index 4233eac..4031c44 100644 --- a/R/docs/OrganizationsApi.md +++ b/R/docs/OrganizationsApi.md @@ -161,7 +161,7 @@ Name | Type | Description | Notes ### Return type -**list(array[character])** +[**list(array[character])**](array.md) ### Authorization @@ -186,7 +186,7 @@ Creates an organization if it doesn't exist. ```R library(openlattice) -var.organization <- Organization$new("id_example", Principal$new("type_example", "id_example"), "title_example", "description_example", list("emails_example"), list(Principal$new("type_example", "id_example")), list(Role$new("id_example", "organizationId_example", Principal$new("type_example", "id_example"), "title_example", "description_example", "@class_example")), list("apps_example"), list(SmsEntitySetInformation$new("phoneNumber_example", "organizationId_example", list("entitysetIds_example"), list("tags_example"))), list(123)) # Organization | +var.organization <- Organization$new("id_example", Principal$new("type_example", "id_example"), "title_example", "description_example", list("emails_example"), list(Principal$new("type_example", "id_example")), list(Role$new("id_example", "organizationId_example", Principal$new("type_example", "id_example"), "title_example", "description_example")), list("apps_example"), list(SmsEntitySetInformation$new("phoneNumber_example", "organizationId_example", list("entitysetIds_example"), list("tags_example"))), list(123)) # Organization | #Creates an organization if it doesn't exist. api.instance <- OrganizationsApi$new() @@ -232,7 +232,7 @@ Creates role ```R library(openlattice) -var.role <- Role$new("id_example", "organizationId_example", Principal$new("type_example", "id_example"), "title_example", "description_example", "@class_example") # Role | +var.role <- Role$new("id_example", "organizationId_example", Principal$new("type_example", "id_example"), "title_example", "description_example") # Role | #Creates role api.instance <- OrganizationsApi$new() @@ -625,7 +625,7 @@ Name | Type | Description | Notes ### Return type -**list(array[character])** +[**list(array[character])**](array.md) ### Authorization diff --git a/R/docs/PrincipalApi.md b/R/docs/PrincipalApi.md index 9c2e701..4b5752c 100644 --- a/R/docs/PrincipalApi.md +++ b/R/docs/PrincipalApi.md @@ -8,7 +8,9 @@ Method | HTTP request | Description [**get_current_roles**](PrincipalApi.md#get_current_roles) | **GET** /datastore/principals/roles/current/ | Get current roles. [**get_materialized_view_account**](PrincipalApi.md#get_materialized_view_account) | **GET** /datastore/principals/db | Get the db access credentials. [**get_user**](PrincipalApi.md#get_user) | **GET** /datastore/principals/users/{userId} | Get the user for the given id. +[**search_all_users**](PrincipalApi.md#search_all_users) | **GET** /datastore/principals/users/search/"{searchQuery}" | Get the user id for the given search. [**search_all_users_by_email**](PrincipalApi.md#search_all_users_by_email) | **GET** /datastore/principals/users/search/email/"{emailAddress}" | Get the user id for the given email address. +[**sync_calling_user**](PrincipalApi.md#sync_calling_user) | **GET** /datastore/principals/sync/ | Activates a user in the OpenLattice system. This call must be made once before a user will be available for use in authorization policies. # **get_all_users** @@ -183,6 +185,52 @@ Name | Type | Description | Notes |-------------|-------------|------------------| | **200** | Success | - | +# **search_all_users** +> list(Auth0userBasic) search_all_users(search_query) + +Get the user id for the given search. + +### Example +```R +library(openlattice) + +var.search_query <- 'search_query_example' # character | + +#Get the user id for the given search. +api.instance <- PrincipalApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$search_all_users(var.search_query) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_query** | **character**| | + +### Return type + +[**list(Auth0userBasic)**](Auth0userBasic.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + # **search_all_users_by_email** > list(Auth0userBasic) search_all_users_by_email(email_address) @@ -229,3 +277,44 @@ Name | Type | Description | Notes |-------------|-------------|------------------| | **200** | Success | - | +# **sync_calling_user** +> sync_calling_user() + +Activates a user in the OpenLattice system. This call must be made once before a user will be available for use in authorization policies. + +### Example +```R +library(openlattice) + + +#Activates a user in the OpenLattice system. This call must be made once before a user will be available for use in authorization policies. +api.instance <- PrincipalApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +api.instance$sync_calling_user() +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +void (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + diff --git a/R/docs/PropertyDefinition.md b/R/docs/PropertyDefinition.md new file mode 100644 index 0000000..c21ba7d --- /dev/null +++ b/R/docs/PropertyDefinition.md @@ -0,0 +1,9 @@ +# openlattice::PropertyDefinition + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**column** | **character** | | [optional] + + diff --git a/R/docs/Role.md b/R/docs/Role.md index c1c8477..dd74e55 100644 --- a/R/docs/Role.md +++ b/R/docs/Role.md @@ -8,6 +8,5 @@ Name | Type | Description | Notes **principal** | [**Principal**](Principal.md) | | [optional] **title** | **character** | | [optional] **description** | **character** | | [optional] -**@class** | **character** | | [optional] diff --git a/R/docs/SearchApi.md b/R/docs/SearchApi.md index ded4fb8..eb66580 100644 --- a/R/docs/SearchApi.md +++ b/R/docs/SearchApi.md @@ -5,12 +5,21 @@ All URIs are relative to *https://api.openlattice.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**execute_advanced_entity_set_data_query**](SearchApi.md#execute_advanced_entity_set_data_query) | **POST** /datastore/search/advanced/{entitySetId} | Executes a search over the data of a given entity set to find rows that match the search term +[**execute_app_search**](SearchApi.md#execute_app_search) | **POST** /datastore/search/app | Executes a search over all apps to find ones that match the given search term +[**execute_app_type_search**](SearchApi.md#execute_app_type_search) | **POST** /datastore/search/app_types | Executes a search over all app types to find ones that match the given search term +[**execute_association_type_search**](SearchApi.md#execute_association_type_search) | **POST** /datastore/search/association_types | Executes a search over all association types to find ones that match the given search term [**execute_entity_neighbor_search**](SearchApi.md#execute_entity_neighbor_search) | **GET** /datastore/search/{entitySetId}/{entityKeyId} | Executes a search for all neighbors of an entity that are connected by an association [**execute_entity_neighbor_search_bulk**](SearchApi.md#execute_entity_neighbor_search_bulk) | **POST** /datastore/search/{entitySetId}/neighbors | Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association +[**execute_entity_set_collection_search**](SearchApi.md#execute_entity_set_collection_search) | **POST** /datastore/search/entity_sets/collections | Executes a search over all EntitySetCollections to find ones that match the given search term [**execute_entity_set_data_query**](SearchApi.md#execute_entity_set_data_query) | **POST** /datastore/search/{entitySetId} | Executes a search over the data of a given entity set to find rows that match the search term [**execute_entity_set_keyword_query**](SearchApi.md#execute_entity_set_keyword_query) | **POST** /datastore/search | The query, entityType, and propertyTypes params are all optional, but at least one must be specified otherwise an error will be thrown. All specified params are required to be present in each entity set returned. If entityType and propertyTypes are both specified, the propertyTypes param will be ignored. +[**execute_entity_type_collection_search**](SearchApi.md#execute_entity_type_collection_search) | **POST** /datastore/search/entity_types/collections | Executes a search over all EntityTypeCollections to find ones that match the given search term +[**execute_entity_type_search**](SearchApi.md#execute_entity_type_search) | **POST** /datastore/search/entity_types | Executes a search over all entity types to find ones that match the given search term [**execute_filtered_entity_neighbor_id_search**](SearchApi.md#execute_filtered_entity_neighbor_id_search) | **POST** /datastore/search/{entitySetId}/neighbors/advanced/ids | Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association and returns a simple version of the neighborDetails [**execute_filtered_entity_neighbor_search**](SearchApi.md#execute_filtered_entity_neighbor_search) | **POST** /datastore/search/{entitySetId}/neighbors/advanced | Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association +[**execute_fqn_property_type_search**](SearchApi.md#execute_fqn_property_type_search) | **POST** /datastore/search/property_types/fqn | Executes a search over all property types to find ones that match the given name and namespace, including partial matches +[**execute_organization_search**](SearchApi.md#execute_organization_search) | **POST** /datastore/search/organizations | Executes a search over all organizations to find ones that match the given search term +[**execute_property_type_search**](SearchApi.md#execute_property_type_search) | **POST** /datastore/search/property_types | Executes a search over all property types to find ones that match the given search term [**get_entity_sets**](SearchApi.md#get_entity_sets) | **GET** /datastore/search/entity-sets/{start}/{numResults} | Executes a search over all existing entity sets to populate the home page. The path parameters instruct which page to return and how large the page should be. [**get_popular_entity_set**](SearchApi.md#get_popular_entity_set) | **GET** /datastore/search/popular | Get the most popular entity sets. [**search_entity_set_data**](SearchApi.md#search_entity_set_data) | **PATCH** /datastore/search | Executes a search over the data of a given entity set to find rows that match the search term @@ -64,6 +73,144 @@ Name | Type | Description | Notes |-------------|-------------|------------------| | **200** | A data search result object, containing the total number of hits for the given query, and the hits themselves | - | +# **execute_app_search** +> SearchResult execute_app_search(search_term) + +Executes a search over all apps to find ones that match the given search term + +### Example +```R +library(openlattice) + +var.search_term <- SearchTerm$new("searchTerm_example", 123, 123, "fuzzy_example") # SearchTerm | + +#Executes a search over all apps to find ones that match the given search term +api.instance <- SearchApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$execute_app_search(var.search_term) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_term** | [**SearchTerm**](SearchTerm.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A search result object, containing the total number of hits for the given query, and the hits themselves. | - | + +# **execute_app_type_search** +> SearchResult execute_app_type_search(search_term) + +Executes a search over all app types to find ones that match the given search term + +### Example +```R +library(openlattice) + +var.search_term <- SearchTerm$new("searchTerm_example", 123, 123, "fuzzy_example") # SearchTerm | + +#Executes a search over all app types to find ones that match the given search term +api.instance <- SearchApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$execute_app_type_search(var.search_term) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_term** | [**SearchTerm**](SearchTerm.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A search result object, containing the total number of hits for the given query, and the hits themselves. | - | + +# **execute_association_type_search** +> SearchResult execute_association_type_search(search_term) + +Executes a search over all association types to find ones that match the given search term + +### Example +```R +library(openlattice) + +var.search_term <- SearchTerm$new("searchTerm_example", 123, 123, "fuzzy_example") # SearchTerm | + +#Executes a search over all association types to find ones that match the given search term +api.instance <- SearchApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$execute_association_type_search(var.search_term) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_term** | [**SearchTerm**](SearchTerm.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A search result object, containing the total number of hits for the given query, and the hits themselves. | - | + # **execute_entity_neighbor_search** > array[NeighborEntityDetails] execute_entity_neighbor_search(entity_set_id, entity_key_id) @@ -144,7 +291,7 @@ Name | Type | Description | Notes ### Return type -**list(array[NeighborEntityDetails])** +[**list(array[NeighborEntityDetails])**](array.md) ### Authorization @@ -160,6 +307,52 @@ Name | Type | Description | Notes |-------------|-------------|------------------| | **200** | A list of objects containing information about the neighbor and association. | - | +# **execute_entity_set_collection_search** +> SearchResult execute_entity_set_collection_search(search_term) + +Executes a search over all EntitySetCollections to find ones that match the given search term + +### Example +```R +library(openlattice) + +var.search_term <- SearchTerm$new("searchTerm_example", 123, 123, "fuzzy_example") # SearchTerm | + +#Executes a search over all EntitySetCollections to find ones that match the given search term +api.instance <- SearchApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$execute_entity_set_collection_search(var.search_term) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_term** | [**SearchTerm**](SearchTerm.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A search result object, containing the total number of hits for the given query, and the hits themselves. | - | + # **execute_entity_set_data_query** > DataSearchResult execute_entity_set_data_query(entity_set_id, search_term) @@ -252,7 +445,99 @@ Name | Type | Description | Notes ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| -| **200** | A list of objects containing information about the neighbor and association. | - | +| **200** | A search result object, containing the total number of hits for the given query, and the hits themselves. | - | + +# **execute_entity_type_collection_search** +> SearchResult execute_entity_type_collection_search(search_term) + +Executes a search over all EntityTypeCollections to find ones that match the given search term + +### Example +```R +library(openlattice) + +var.search_term <- SearchTerm$new("searchTerm_example", 123, 123, "fuzzy_example") # SearchTerm | + +#Executes a search over all EntityTypeCollections to find ones that match the given search term +api.instance <- SearchApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$execute_entity_type_collection_search(var.search_term) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_term** | [**SearchTerm**](SearchTerm.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A search result object, containing the total number of hits for the given query, and the hits themselves. | - | + +# **execute_entity_type_search** +> SearchResult execute_entity_type_search(search_term) + +Executes a search over all entity types to find ones that match the given search term + +### Example +```R +library(openlattice) + +var.search_term <- SearchTerm$new("searchTerm_example", 123, 123, "fuzzy_example") # SearchTerm | + +#Executes a search over all entity types to find ones that match the given search term +api.instance <- SearchApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$execute_entity_type_search(var.search_term) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_term** | [**SearchTerm**](SearchTerm.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A search result object, containing the total number of hits for the given query, and the hits themselves. | - | # **execute_filtered_entity_neighbor_id_search** > list(list(list(array[NeighborEntityIds]))) execute_filtered_entity_neighbor_id_search(entity_set_id, neighbor_search_filter) @@ -334,7 +619,7 @@ Name | Type | Description | Notes ### Return type -**list(array[NeighborEntityDetails])** +[**list(array[NeighborEntityDetails])**](array.md) ### Authorization @@ -350,6 +635,144 @@ Name | Type | Description | Notes |-------------|-------------|------------------| | **200** | A list of objects containing information about the neighbor and association. | - | +# **execute_fqn_property_type_search** +> SearchResult execute_fqn_property_type_search(search_term) + +Executes a search over all property types to find ones that match the given name and namespace, including partial matches + +### Example +```R +library(openlattice) + +var.search_term <- SearchTerm$new("searchTerm_example", 123, 123, "fuzzy_example") # SearchTerm | + +#Executes a search over all property types to find ones that match the given name and namespace, including partial matches +api.instance <- SearchApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$execute_fqn_property_type_search(var.search_term) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_term** | [**SearchTerm**](SearchTerm.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A search result object, containing the total number of hits for the given query, and the hits themselves. | - | + +# **execute_organization_search** +> SearchResult execute_organization_search(search_term) + +Executes a search over all organizations to find ones that match the given search term + +### Example +```R +library(openlattice) + +var.search_term <- SearchTerm$new("searchTerm_example", 123, 123, "fuzzy_example") # SearchTerm | + +#Executes a search over all organizations to find ones that match the given search term +api.instance <- SearchApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$execute_organization_search(var.search_term) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_term** | [**SearchTerm**](SearchTerm.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A search result object, containing the total number of hits for the given query, and the hits themselves. | - | + +# **execute_property_type_search** +> SearchResult execute_property_type_search(search_term) + +Executes a search over all property types to find ones that match the given search term + +### Example +```R +library(openlattice) + +var.search_term <- SearchTerm$new("searchTerm_example", 123, 123, "fuzzy_example") # SearchTerm | + +#Executes a search over all property types to find ones that match the given search term +api.instance <- SearchApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$execute_property_type_search(var.search_term) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_term** | [**SearchTerm**](SearchTerm.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | A search result object, containing the total number of hits for the given query, and the hits themselves. | - | + # **get_entity_sets** > array[SearchResult] get_entity_sets(start, num_results) @@ -449,7 +872,7 @@ Executes a search over the data of a given entity set to find rows that match th ```R library(openlattice) -var.search_constraints <- SearchConstraints$new(list("entitySetIds_example"), 123, 123, list(ConstraintGroup$new(123, list(Constraint$new("type_example", "searchTerm_example", "fuzzy_example", list(SearchDetails$new("searchTerm_example", "property_example", "exact_example")), "propertyTypeId_example", 123, 123, 123, "unit_example", list(list(list(123))), "start_example", "end_example")))), SortDefinition$new("type_example", "isDescending_example", "propertyTypeId_example", 123, 123)) # SearchConstraints | +var.search_constraints <- SearchConstraints$new(list("entitySetIds_example"), 123, 123, list(ConstraintGroup$new(123, list(Constraint$new("type_example", "searchTerm_example", "fuzzy_example", list(SearchDetails$new("searchTerm_example", "property_example", "exact_example")), "propertyTypeId_example", 123, 123, 123, "unit_example", list(list(list(123))), "start_example", "end_example")))), SortDefinition$new("type_example", "descending_example", "propertyTypeId_example", 123, 123)) # SearchConstraints | #Executes a search over the data of a given entity set to find rows that match the search term api.instance <- SearchApi$new() diff --git a/R/docs/ShuttleApi.md b/R/docs/ShuttleApi.md new file mode 100644 index 0000000..dead88b --- /dev/null +++ b/R/docs/ShuttleApi.md @@ -0,0 +1,383 @@ +# ShuttleApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_integration_definition**](ShuttleApi.md#create_integration_definition) | **POST** /shuttle/integration/definition/{integrationName} | Creates a new integration definition for running recurring integrations +[**delete_integration_definition**](ShuttleApi.md#delete_integration_definition) | **DELETE** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition +[**delete_integration_job_status**](ShuttleApi.md#delete_integration_job_status) | **DELETE** /shuttle/integration/status/{jobId} | Deletes an integration job status from the integrationJobs map +[**enqueue_integration**](ShuttleApi.md#enqueue_integration) | **GET** /shuttle/integration/{integrationName}/{integrationKey} | Enqueues an integration on Shuttle Server for a given integration +[**poll_all_integrations**](ShuttleApi.md#poll_all_integrations) | **GET** /shuttle/integration/status | Polls the statuses of all running integrations +[**poll_integration**](ShuttleApi.md#poll_integration) | **GET** /shuttle/integration/status/{jobId} | Polls the status of an integration +[**read_integration_definition**](ShuttleApi.md#read_integration_definition) | **GET** /shuttle/integration/definition/{integrationName} | Gets an existing integration definition +[**update_integration_definition**](ShuttleApi.md#update_integration_definition) | **PATCH** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition + + +# **create_integration_definition** +> character create_integration_definition(integration_name, integration) + +Creates a new integration definition for running recurring integrations + +### Example +```R +library(openlattice) + +var.integration_name <- 'integration_name_example' # character | +var.integration <- Integration$new("key_example", "environment_example", "s3Bucket_example", list("contacts_example"), "organizationId_example", "entitySetId_example", 123, list("callback_example"), TODO) # Integration | + +#Creates a new integration definition for running recurring integrations +api.instance <- ShuttleApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$create_integration_definition(var.integration_name, var.integration) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integration_name** | **character**| | + **integration** | [**Integration**](Integration.md)| | + +### Return type + +**character** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **delete_integration_definition** +> delete_integration_definition(integration_name) + +Replaces any number of fields within an existing integration definition + +### Example +```R +library(openlattice) + +var.integration_name <- 'integration_name_example' # character | + +#Replaces any number of fields within an existing integration definition +api.instance <- ShuttleApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +api.instance$delete_integration_definition(var.integration_name) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integration_name** | **character**| | + +### Return type + +void (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **delete_integration_job_status** +> delete_integration_job_status(job_id) + +Deletes an integration job status from the integrationJobs map + +### Example +```R +library(openlattice) + +var.job_id <- 'job_id_example' # character | the unique id of the integration job + +#Deletes an integration job status from the integrationJobs map +api.instance <- ShuttleApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +api.instance$delete_integration_job_status(var.job_id) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **job_id** | [**character**](.md)| the unique id of the integration job | + +### Return type + +void (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **enqueue_integration** +> character enqueue_integration(integration_name, integration_key) + +Enqueues an integration on Shuttle Server for a given integration + +### Example +```R +library(openlattice) + +var.integration_name <- 'integration_name_example' # character | the name of the integration to be run +var.integration_key <- 'integration_key_example' # character | the unique id used to authenticate an integration run + +#Enqueues an integration on Shuttle Server for a given integration +api.instance <- ShuttleApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$enqueue_integration(var.integration_name, var.integration_key) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integration_name** | **character**| the name of the integration to be run | + **integration_key** | [**character**](.md)| the unique id used to authenticate an integration run | + +### Return type + +**character** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **poll_all_integrations** +> list(IntegrationJob) poll_all_integrations() + +Polls the statuses of all running integrations + +### Example +```R +library(openlattice) + + +#Polls the statuses of all running integrations +api.instance <- ShuttleApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$poll_all_integrations() +dput(result) +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**list(IntegrationJob)**](IntegrationJob.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **poll_integration** +> character poll_integration(job_id) + +Polls the status of an integration + +### Example +```R +library(openlattice) + +var.job_id <- 'job_id_example' # character | the unique id of the integration job + +#Polls the status of an integration +api.instance <- ShuttleApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$poll_integration(var.job_id) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **job_id** | [**character**](.md)| the unique id of the integration job | + +### Return type + +**character** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **read_integration_definition** +> Integration read_integration_definition(integration_name) + +Gets an existing integration definition + +### Example +```R +library(openlattice) + +var.integration_name <- 'integration_name_example' # character | + +#Gets an existing integration definition +api.instance <- ShuttleApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +result <- api.instance$read_integration_definition(var.integration_name) +dput(result) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integration_name** | **character**| | + +### Return type + +[**Integration**](Integration.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + +# **update_integration_definition** +> update_integration_definition(integration_name, integration_update) + +Replaces any number of fields within an existing integration definition + +### Example +```R +library(openlattice) + +var.integration_name <- 'integration_name_example' # character | +var.integration_update <- IntegrationUpdate$new("environment_example", "s3Bucket_example", list("contacts_example"), "organizationId_example", 123, list("callbackUrls_example"), TODO) # IntegrationUpdate | + +#Replaces any number of fields within an existing integration definition +api.instance <- ShuttleApi$new() +# Configure HTTP basic authorization: http_auth +api.instance$apiClient$username <- 'TODO_YOUR_USERNAME'; +api.instance$apiClient$password <- 'TODO_YOUR_PASSWORD'; +# Configure API key authorization: openlattice_auth +api.instance$apiClient$apiKeys['Authorization'] <- 'TODO_YOUR_API_KEY'; +api.instance$update_integration_definition(var.integration_name, var.integration_update) +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integration_name** | **character**| | + **integration_update** | [**IntegrationUpdate**](IntegrationUpdate.md)| | + +### Return type + +void (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +| **200** | Success | - | + diff --git a/R/docs/SortDefinition.md b/R/docs/SortDefinition.md index 97b2291..14dc55d 100644 --- a/R/docs/SortDefinition.md +++ b/R/docs/SortDefinition.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **character** | | [optional] -**isDescending** | **character** | | [optional] +**descending** | **character** | | [optional] **propertyTypeId** | **character** | | [optional] **latitude** | **numeric** | | [optional] **longitude** | **numeric** | | [optional] diff --git a/R/tests/testthat/test_association_definition.R b/R/tests/testthat/test_association_definition.R new file mode 100644 index 0000000..18671dd --- /dev/null +++ b/R/tests/testthat/test_association_definition.R @@ -0,0 +1,49 @@ +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate + +context("Test AssociationDefinition") + +model.instance <- AssociationDefinition$new() + +test_that("fqn", { + # tests for the property `fqn` (FullQualifiedName) + + # uncomment below to test the property + #expect_equal(model.instance$`fqn`, "EXPECTED_RESULT") +}) + +test_that("entitySetName", { + # tests for the property `entitySetName` (character) + + # uncomment below to test the property + #expect_equal(model.instance$`entitySetName`, "EXPECTED_RESULT") +}) + +test_that("propertyDefinitions", { + # tests for the property `propertyDefinitions` (list(PropertyDefinition)) + + # uncomment below to test the property + #expect_equal(model.instance$`propertyDefinitions`, "EXPECTED_RESULT") +}) + +test_that("updateType", { + # tests for the property `updateType` (character) + + # uncomment below to test the property + #expect_equal(model.instance$`updateType`, "EXPECTED_RESULT") +}) + +test_that("src", { + # tests for the property `src` (character) + + # uncomment below to test the property + #expect_equal(model.instance$`src`, "EXPECTED_RESULT") +}) + +test_that("dst", { + # tests for the property `dst` (character) + + # uncomment below to test the property + #expect_equal(model.instance$`dst`, "EXPECTED_RESULT") +}) + diff --git a/R/tests/testthat/test_collection_template_type.R b/R/tests/testthat/test_collection_template_type.R new file mode 100644 index 0000000..97ef261 --- /dev/null +++ b/R/tests/testthat/test_collection_template_type.R @@ -0,0 +1,47 @@ +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate + +context("Test CollectionTemplateType") + +model.instance <- CollectionTemplateType$new() + +test_that("id", { + # tests for the property `id` (character) + # An optional UUID for the collection template type. + + # uncomment below to test the property + #expect_equal(model.instance$`id`, "EXPECTED_RESULT") +}) + +test_that("name", { + # tests for the property `name` (character) + # The unique name of the collection template type. + + # uncomment below to test the property + #expect_equal(model.instance$`name`, "EXPECTED_RESULT") +}) + +test_that("title", { + # tests for the property `title` (character) + # The friendly name for the collection template type. + + # uncomment below to test the property + #expect_equal(model.instance$`title`, "EXPECTED_RESULT") +}) + +test_that("description", { + # tests for the property `description` (character) + # A description of the collection template type. + + # uncomment below to test the property + #expect_equal(model.instance$`description`, "EXPECTED_RESULT") +}) + +test_that("entityTypeId", { + # tests for the property `entityTypeId` (character) + # The id of the entity type that this collection template type wraps. + + # uncomment below to test the property + #expect_equal(model.instance$`entityTypeId`, "EXPECTED_RESULT") +}) + diff --git a/R/tests/testthat/test_collections_api.R b/R/tests/testthat/test_collections_api.R new file mode 100644 index 0000000..3f3b6f1 --- /dev/null +++ b/R/tests/testthat/test_collections_api.R @@ -0,0 +1,164 @@ +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate + +context("Test CollectionsApi") + +api.instance <- CollectionsApi$new() + +test_that("add_type_to_entity_type_collection_template", { + # tests for add_type_to_entity_type_collection_template + # base path: https://api.openlattice.com + # Appends type to template of the specified EntityTypeCollection + # @param character entity_type_collection_id + # @param CollectionTemplateType collection_template_type + # @return [Void] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("create_entity_set_collection", { + # tests for create_entity_set_collection + # base path: https://api.openlattice.com + # Creates a new EntitySetCollection + # @param EntitySetCollection entity_set_collection + # @return [character] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("create_entity_type_collection", { + # tests for create_entity_type_collection + # base path: https://api.openlattice.com + # Creates a new EntityTypeCollection + # @param EntityTypeCollection entity_type_collection + # @return [character] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("delete_entity_set_collection", { + # tests for delete_entity_set_collection + # base path: https://api.openlattice.com + # Deletes the specified EntitySetCollection + # @param character entity_set_collection_id + # @return [Void] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("delete_entity_type_collection", { + # tests for delete_entity_type_collection + # base path: https://api.openlattice.com + # Deletes the specified EntityTypeCollection + # @param character entity_type_collection_id + # @return [Void] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("get_all_entity_set_collections", { + # tests for get_all_entity_set_collections + # base path: https://api.openlattice.com + # Returns all EntitySetCollection objects + # @return [array[EntitySetCollection]] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("get_all_entity_type_collections", { + # tests for get_all_entity_type_collections + # base path: https://api.openlattice.com + # Returns all EntityTypeCollection objects + # @return [array[EntityTypeCollection]] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("get_entity_set_collection", { + # tests for get_entity_set_collection + # base path: https://api.openlattice.com + # Returns the EntitySetCollection object for a given id + # @param character entity_set_collection_id + # @return [EntitySetCollection] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("get_entity_set_collections_of_type", { + # tests for get_entity_set_collections_of_type + # base path: https://api.openlattice.com + # Returns all authorized EntitySetCollections for a given EntityTypeCollection id + # @param character entity_set_collection_id + # @return [array[EntitySetCollection]] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("get_entity_type_collection", { + # tests for get_entity_type_collection + # base path: https://api.openlattice.com + # Returns the EntityTypeCollection object for a given id + # @param character entity_type_collection_id + # @return [EntityTypeCollection] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("remove_type_from_entity_type_collection_template", { + # tests for remove_type_from_entity_type_collection_template + # base path: https://api.openlattice.com + # Removes a key from an EntityTypeCollection template + # @param character entity_type_collection_id + # @param character type_id + # @return [Void] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("update_entity_set_collection_metadata", { + # tests for update_entity_set_collection_metadata + # base path: https://api.openlattice.com + # Updates metadata of the specified EntitySetCollection + # @param character entity_set_collection_id + # @param MetadataUpdate metadata_update + # @return [Void] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("update_entity_set_collection_template", { + # tests for update_entity_set_collection_template + # base path: https://api.openlattice.com + # Updates template of the specified EntitySetCollection + # @param character entity_set_collection_id + # @param list(character) request_body + # @return [Void] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("update_entity_type_collection_metadata", { + # tests for update_entity_type_collection_metadata + # base path: https://api.openlattice.com + # Updates metadata of the specified EntityTypeCollection + # @param character entity_type_collection_id + # @param MetadataUpdate metadata_update + # @return [Void] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + diff --git a/R/tests/testthat/test_data_api.R b/R/tests/testthat/test_data_api.R index f828a22..ae29147 100644 --- a/R/tests/testthat/test_data_api.R +++ b/R/tests/testthat/test_data_api.R @@ -179,7 +179,7 @@ test_that("load_selected_entity_set_data", { # base path: https://api.openlattice.com # Gets a list of entities by UUIDs # @param character entity_set_id - # @param EntitySetSelection entity_set_selection + # @param array[EntitySetSelection] entity_set_selection # @return [array[list(array[character])]] # uncomment below to test the operation diff --git a/R/tests/testthat/test_data_association.R b/R/tests/testthat/test_data_association.R index 1e2c30d..f8f0438 100644 --- a/R/tests/testthat/test_data_association.R +++ b/R/tests/testthat/test_data_association.R @@ -29,3 +29,35 @@ test_that("srcEntityKeyId", { #expect_equal(model.instance$`srcEntityKeyId`, "EXPECTED_RESULT") }) +test_that("dstEntitySetId", { + # tests for the property `dstEntitySetId` (character) + # the ID of the dst entity set + + # uncomment below to test the property + #expect_equal(model.instance$`dstEntitySetId`, "EXPECTED_RESULT") +}) + +test_that("dstEntityIndex", { + # tests for the property `dstEntityIndex` (character) + # The index of an entity + + # uncomment below to test the property + #expect_equal(model.instance$`dstEntityIndex`, "EXPECTED_RESULT") +}) + +test_that("dstEntityKeyId", { + # tests for the property `dstEntityKeyId` (character) + # An existing entityKeyId + + # uncomment below to test the property + #expect_equal(model.instance$`dstEntityKeyId`, "EXPECTED_RESULT") +}) + +test_that("data", { + # tests for the property `data` (list(array[character])) + # data + + # uncomment below to test the property + #expect_equal(model.instance$`data`, "EXPECTED_RESULT") +}) + diff --git a/R/tests/testthat/test_entity_definition.R b/R/tests/testthat/test_entity_definition.R new file mode 100644 index 0000000..ae30b33 --- /dev/null +++ b/R/tests/testthat/test_entity_definition.R @@ -0,0 +1,35 @@ +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate + +context("Test EntityDefinition") + +model.instance <- EntityDefinition$new() + +test_that("fqn", { + # tests for the property `fqn` (FullQualifiedName) + + # uncomment below to test the property + #expect_equal(model.instance$`fqn`, "EXPECTED_RESULT") +}) + +test_that("entitySetName", { + # tests for the property `entitySetName` (character) + + # uncomment below to test the property + #expect_equal(model.instance$`entitySetName`, "EXPECTED_RESULT") +}) + +test_that("propertyDefinitions", { + # tests for the property `propertyDefinitions` (list(PropertyDefinition)) + + # uncomment below to test the property + #expect_equal(model.instance$`propertyDefinitions`, "EXPECTED_RESULT") +}) + +test_that("updateType", { + # tests for the property `updateType` (character) + + # uncomment below to test the property + #expect_equal(model.instance$`updateType`, "EXPECTED_RESULT") +}) + diff --git a/R/tests/testthat/test_entity_neighbors_filter.R b/R/tests/testthat/test_entity_neighbors_filter.R index 7e1e727..4273548 100644 --- a/R/tests/testthat/test_entity_neighbors_filter.R +++ b/R/tests/testthat/test_entity_neighbors_filter.R @@ -12,24 +12,24 @@ test_that("entityKeyIds", { #expect_equal(model.instance$`entityKeyIds`, "EXPECTED_RESULT") }) -test_that("srcEntitySetIds", { - # tests for the property `srcEntitySetIds` (array[character]) +test_that("src", { + # tests for the property `src` (array[character]) # uncomment below to test the property - #expect_equal(model.instance$`srcEntitySetIds`, "EXPECTED_RESULT") + #expect_equal(model.instance$`src`, "EXPECTED_RESULT") }) -test_that("dstEntitySetIds", { - # tests for the property `dstEntitySetIds` (array[character]) +test_that("dst", { + # tests for the property `dst` (array[character]) # uncomment below to test the property - #expect_equal(model.instance$`dstEntitySetIds`, "EXPECTED_RESULT") + #expect_equal(model.instance$`dst`, "EXPECTED_RESULT") }) -test_that("associationEntitySetIds", { - # tests for the property `associationEntitySetIds` (array[character]) +test_that("edge", { + # tests for the property `edge` (array[character]) # uncomment below to test the property - #expect_equal(model.instance$`associationEntitySetIds`, "EXPECTED_RESULT") + #expect_equal(model.instance$`edge`, "EXPECTED_RESULT") }) diff --git a/R/tests/testthat/test_entity_set_collection.R b/R/tests/testthat/test_entity_set_collection.R new file mode 100644 index 0000000..07e346b --- /dev/null +++ b/R/tests/testthat/test_entity_set_collection.R @@ -0,0 +1,71 @@ +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate + +context("Test EntitySetCollection") + +model.instance <- EntitySetCollection$new() + +test_that("id", { + # tests for the property `id` (character) + # An optional UUID for the entity set collection. + + # uncomment below to test the property + #expect_equal(model.instance$`id`, "EXPECTED_RESULT") +}) + +test_that("name", { + # tests for the property `name` (character) + # The unique name of the entity set collection. + + # uncomment below to test the property + #expect_equal(model.instance$`name`, "EXPECTED_RESULT") +}) + +test_that("title", { + # tests for the property `title` (character) + # The friendly name for the entity set collection. + + # uncomment below to test the property + #expect_equal(model.instance$`title`, "EXPECTED_RESULT") +}) + +test_that("description", { + # tests for the property `description` (character) + # A description of the entity set collection. + + # uncomment below to test the property + #expect_equal(model.instance$`description`, "EXPECTED_RESULT") +}) + +test_that("entityTypeCollectionId", { + # tests for the property `entityTypeCollectionId` (character) + # The id of the entity type collection that this entity set collection maps to. + + # uncomment below to test the property + #expect_equal(model.instance$`entityTypeCollectionId`, "EXPECTED_RESULT") +}) + +test_that("template", { + # tests for the property `template` (list(character)) + # A mapping from collection template type ids to entity set ids. + + # uncomment below to test the property + #expect_equal(model.instance$`template`, "EXPECTED_RESULT") +}) + +test_that("contacts", { + # tests for the property `contacts` (array[character]) + # A set of contact methods for the owners of this entity set collection. + + # uncomment below to test the property + #expect_equal(model.instance$`contacts`, "EXPECTED_RESULT") +}) + +test_that("organizationId", { + # tests for the property `organizationId` (character) + # The id of the organization that this entity set collection belongs to. + + # uncomment below to test the property + #expect_equal(model.instance$`organizationId`, "EXPECTED_RESULT") +}) + diff --git a/R/tests/testthat/test_entity_type_collection.R b/R/tests/testthat/test_entity_type_collection.R new file mode 100644 index 0000000..b39d91f --- /dev/null +++ b/R/tests/testthat/test_entity_type_collection.R @@ -0,0 +1,54 @@ +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate + +context("Test EntityTypeCollection") + +model.instance <- EntityTypeCollection$new() + +test_that("id", { + # tests for the property `id` (character) + # An optional UUID for the entity type collection. + + # uncomment below to test the property + #expect_equal(model.instance$`id`, "EXPECTED_RESULT") +}) + +test_that("type", { + # tests for the property `type` (FullQualifiedName) + + # uncomment below to test the property + #expect_equal(model.instance$`type`, "EXPECTED_RESULT") +}) + +test_that("title", { + # tests for the property `title` (character) + # The friendly name for the entity type collection. + + # uncomment below to test the property + #expect_equal(model.instance$`title`, "EXPECTED_RESULT") +}) + +test_that("description", { + # tests for the property `description` (character) + # A description of the entity type collection. + + # uncomment below to test the property + #expect_equal(model.instance$`description`, "EXPECTED_RESULT") +}) + +test_that("schemas", { + # tests for the property `schemas` (array[FullQualifiedName]) + # A list of schemas the entity type collection should belong to. + + # uncomment below to test the property + #expect_equal(model.instance$`schemas`, "EXPECTED_RESULT") +}) + +test_that("template", { + # tests for the property `template` (array[CollectionTemplateType]) + # A set of CollectionTemplateType objects, which describe the entity types involved in the entity type collection and the purposes they serve + + # uncomment below to test the property + #expect_equal(model.instance$`template`, "EXPECTED_RESULT") +}) + diff --git a/R/tests/testthat/test_flight.R b/R/tests/testthat/test_flight.R new file mode 100644 index 0000000..40cbb42 --- /dev/null +++ b/R/tests/testthat/test_flight.R @@ -0,0 +1,42 @@ +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate + +context("Test Flight") + +model.instance <- Flight$new() + +test_that("name", { + # tests for the property `name` (character) + + # uncomment below to test the property + #expect_equal(model.instance$`name`, "EXPECTED_RESULT") +}) + +test_that("tags", { + # tests for the property `tags` (array[character]) + + # uncomment below to test the property + #expect_equal(model.instance$`tags`, "EXPECTED_RESULT") +}) + +test_that("organizationId", { + # tests for the property `organizationId` (character) + + # uncomment below to test the property + #expect_equal(model.instance$`organizationId`, "EXPECTED_RESULT") +}) + +test_that("entityDefinitions", { + # tests for the property `entityDefinitions` (list(EntityDefinition)) + + # uncomment below to test the property + #expect_equal(model.instance$`entityDefinitions`, "EXPECTED_RESULT") +}) + +test_that("associationDefinitions", { + # tests for the property `associationDefinitions` (list(AssociationDefinition)) + + # uncomment below to test the property + #expect_equal(model.instance$`associationDefinitions`, "EXPECTED_RESULT") +}) + diff --git a/R/tests/testthat/test_flight_plan_parameters.R b/R/tests/testthat/test_flight_plan_parameters.R new file mode 100644 index 0000000..e1e16c3 --- /dev/null +++ b/R/tests/testthat/test_flight_plan_parameters.R @@ -0,0 +1,46 @@ +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate + +context("Test FlightPlanParameters") + +model.instance <- FlightPlanParameters$new() + +test_that("sql", { + # tests for the property `sql` (character) + # the sql query to be used to pull cleaned data from postgres + + # uncomment below to test the property + #expect_equal(model.instance$`sql`, "EXPECTED_RESULT") +}) + +test_that("src", { + # tests for the property `src` (list(character)) + # postgres data source for pulling clean data + + # uncomment below to test the property + #expect_equal(model.instance$`src`, "EXPECTED_RESULT") +}) + +test_that("srcPrimaryKeyColumns", { + # tests for the property `srcPrimaryKeyColumns` (array[character]) + # the columns that are primary keys in the cleaned data + + # uncomment below to test the property + #expect_equal(model.instance$`srcPrimaryKeyColumns`, "EXPECTED_RESULT") +}) + +test_that("path", { + # tests for the property `path` (character) + # the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) + + # uncomment below to test the property + #expect_equal(model.instance$`path`, "EXPECTED_RESULT") +}) + +test_that("flight", { + # tests for the property `flight` (Flight) + + # uncomment below to test the property + #expect_equal(model.instance$`flight`, "EXPECTED_RESULT") +}) + diff --git a/R/tests/testthat/test_flight_plan_parameters_update.R b/R/tests/testthat/test_flight_plan_parameters_update.R new file mode 100644 index 0000000..dc94bd1 --- /dev/null +++ b/R/tests/testthat/test_flight_plan_parameters_update.R @@ -0,0 +1,39 @@ +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate + +context("Test FlightPlanParametersUpdate") + +model.instance <- FlightPlanParametersUpdate$new() + +test_that("sql", { + # tests for the property `sql` (character) + # the sql query to be used to pull cleaned data from postgres + + # uncomment below to test the property + #expect_equal(model.instance$`sql`, "EXPECTED_RESULT") +}) + +test_that("src", { + # tests for the property `src` (list(character)) + # postgres data source for pulling clean data + + # uncomment below to test the property + #expect_equal(model.instance$`src`, "EXPECTED_RESULT") +}) + +test_that("srcPrimaryKeyColumns", { + # tests for the property `srcPrimaryKeyColumns` (array[character]) + # the columns that are primary keys in the cleaned data + + # uncomment below to test the property + #expect_equal(model.instance$`srcPrimaryKeyColumns`, "EXPECTED_RESULT") +}) + +test_that("path", { + # tests for the property `path` (character) + # the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) + + # uncomment below to test the property + #expect_equal(model.instance$`path`, "EXPECTED_RESULT") +}) + diff --git a/R/tests/testthat/test_integration.R b/R/tests/testthat/test_integration.R new file mode 100644 index 0000000..afe33e6 --- /dev/null +++ b/R/tests/testthat/test_integration.R @@ -0,0 +1,79 @@ +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate + +context("Test Integration") + +model.instance <- Integration$new() + +test_that("key", { + # tests for the property `key` (character) + # a unique ID used for authorizing a call to run an integration + + # uncomment below to test the property + #expect_equal(model.instance$`key`, "EXPECTED_RESULT") +}) + +test_that("environment", { + # tests for the property `environment` (character) + # the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) + + # uncomment below to test the property + #expect_equal(model.instance$`environment`, "EXPECTED_RESULT") +}) + +test_that("s3Bucket", { + # tests for the property `s3Bucket` (character) + # the url of the s3bucket to be used + + # uncomment below to test the property + #expect_equal(model.instance$`s3Bucket`, "EXPECTED_RESULT") +}) + +test_that("contacts", { + # tests for the property `contacts` (array[character]) + # the set of email addresses of those responsible for the integration + + # uncomment below to test the property + #expect_equal(model.instance$`contacts`, "EXPECTED_RESULT") +}) + +test_that("organizationId", { + # tests for the property `organizationId` (character) + # the id of the organization that owns the integration + + # uncomment below to test the property + #expect_equal(model.instance$`organizationId`, "EXPECTED_RESULT") +}) + +test_that("entitySetId", { + # tests for the property `entitySetId` (character) + # the id of the entity set that stores the logs for this integration + + # uncomment below to test the property + #expect_equal(model.instance$`entitySetId`, "EXPECTED_RESULT") +}) + +test_that("maxConnections", { + # tests for the property `maxConnections` (integer) + # maximum number of connections to postgres allowed for this integration + + # uncomment below to test the property + #expect_equal(model.instance$`maxConnections`, "EXPECTED_RESULT") +}) + +test_that("callback", { + # tests for the property `callback` (array[character]) + # urls to receive a POST when integration has completed + + # uncomment below to test the property + #expect_equal(model.instance$`callback`, "EXPECTED_RESULT") +}) + +test_that("flightPlanParameters", { + # tests for the property `flightPlanParameters` (list(FlightPlanParameters)) + # a map from [Flight] name to [FlightPlanParameters] + + # uncomment below to test the property + #expect_equal(model.instance$`flightPlanParameters`, "EXPECTED_RESULT") +}) + diff --git a/R/tests/testthat/test_integration_job.R b/R/tests/testthat/test_integration_job.R new file mode 100644 index 0000000..8c7bcf1 --- /dev/null +++ b/R/tests/testthat/test_integration_job.R @@ -0,0 +1,21 @@ +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate + +context("Test IntegrationJob") + +model.instance <- IntegrationJob$new() + +test_that("name", { + # tests for the property `name` (character) + + # uncomment below to test the property + #expect_equal(model.instance$`name`, "EXPECTED_RESULT") +}) + +test_that("status", { + # tests for the property `status` (character) + + # uncomment below to test the property + #expect_equal(model.instance$`status`, "EXPECTED_RESULT") +}) + diff --git a/R/tests/testthat/test_integration_update.R b/R/tests/testthat/test_integration_update.R new file mode 100644 index 0000000..efc88d9 --- /dev/null +++ b/R/tests/testthat/test_integration_update.R @@ -0,0 +1,63 @@ +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate + +context("Test IntegrationUpdate") + +model.instance <- IntegrationUpdate$new() + +test_that("environment", { + # tests for the property `environment` (character) + # the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) + + # uncomment below to test the property + #expect_equal(model.instance$`environment`, "EXPECTED_RESULT") +}) + +test_that("s3Bucket", { + # tests for the property `s3Bucket` (character) + # the url of the s3bucket to be used + + # uncomment below to test the property + #expect_equal(model.instance$`s3Bucket`, "EXPECTED_RESULT") +}) + +test_that("contacts", { + # tests for the property `contacts` (array[character]) + # the set of email addresses of those responsible for the integration + + # uncomment below to test the property + #expect_equal(model.instance$`contacts`, "EXPECTED_RESULT") +}) + +test_that("organizationId", { + # tests for the property `organizationId` (character) + # the id of the organization that owns the integration + + # uncomment below to test the property + #expect_equal(model.instance$`organizationId`, "EXPECTED_RESULT") +}) + +test_that("maxConnections", { + # tests for the property `maxConnections` (integer) + # maximum number of connections to postgres allowed for this integration + + # uncomment below to test the property + #expect_equal(model.instance$`maxConnections`, "EXPECTED_RESULT") +}) + +test_that("callbackUrls", { + # tests for the property `callbackUrls` (array[character]) + # urls to receive a POST when integration has completed + + # uncomment below to test the property + #expect_equal(model.instance$`callbackUrls`, "EXPECTED_RESULT") +}) + +test_that("flightPlanParameters", { + # tests for the property `flightPlanParameters` (list(FlightPlanParametersUpdate)) + # a map from [Flight] name to [FlightPlanParametersUpdate] + + # uncomment below to test the property + #expect_equal(model.instance$`flightPlanParameters`, "EXPECTED_RESULT") +}) + diff --git a/R/tests/testthat/test_principal_api.R b/R/tests/testthat/test_principal_api.R index c2938e2..6d82b99 100644 --- a/R/tests/testthat/test_principal_api.R +++ b/R/tests/testthat/test_principal_api.R @@ -46,6 +46,17 @@ test_that("get_user", { #expect_equal(result, "EXPECTED_RESULT") }) +test_that("search_all_users", { + # tests for search_all_users + # base path: https://api.openlattice.com + # Get the user id for the given search. + # @param character search_query + # @return [list(Auth0userBasic)] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + test_that("search_all_users_by_email", { # tests for search_all_users_by_email # base path: https://api.openlattice.com @@ -57,3 +68,13 @@ test_that("search_all_users_by_email", { #expect_equal(result, "EXPECTED_RESULT") }) +test_that("sync_calling_user", { + # tests for sync_calling_user + # base path: https://api.openlattice.com + # Activates a user in the OpenLattice system. This call must be made once before a user will be available for use in authorization policies. + # @return [Void] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + diff --git a/R/tests/testthat/test_property_definition.R b/R/tests/testthat/test_property_definition.R new file mode 100644 index 0000000..61934af --- /dev/null +++ b/R/tests/testthat/test_property_definition.R @@ -0,0 +1,21 @@ +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate + +context("Test PropertyDefinition") + +model.instance <- PropertyDefinition$new() + +test_that("type", { + # tests for the property `type` (FullQualifiedName) + + # uncomment below to test the property + #expect_equal(model.instance$`type`, "EXPECTED_RESULT") +}) + +test_that("column", { + # tests for the property `column` (character) + + # uncomment below to test the property + #expect_equal(model.instance$`column`, "EXPECTED_RESULT") +}) + diff --git a/R/tests/testthat/test_role.R b/R/tests/testthat/test_role.R index c4d9a35..3981418 100644 --- a/R/tests/testthat/test_role.R +++ b/R/tests/testthat/test_role.R @@ -40,10 +40,3 @@ test_that("description", { #expect_equal(model.instance$`description`, "EXPECTED_RESULT") }) -test_that("@class", { - # tests for the property `@class` (character) - - # uncomment below to test the property - #expect_equal(model.instance$`@class`, "EXPECTED_RESULT") -}) - diff --git a/R/tests/testthat/test_search_api.R b/R/tests/testthat/test_search_api.R index 1821b1d..9cfbf92 100644 --- a/R/tests/testthat/test_search_api.R +++ b/R/tests/testthat/test_search_api.R @@ -17,6 +17,39 @@ test_that("execute_advanced_entity_set_data_query", { #expect_equal(result, "EXPECTED_RESULT") }) +test_that("execute_app_search", { + # tests for execute_app_search + # base path: https://api.openlattice.com + # Executes a search over all apps to find ones that match the given search term + # @param SearchTerm search_term + # @return [SearchResult] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("execute_app_type_search", { + # tests for execute_app_type_search + # base path: https://api.openlattice.com + # Executes a search over all app types to find ones that match the given search term + # @param SearchTerm search_term + # @return [SearchResult] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("execute_association_type_search", { + # tests for execute_association_type_search + # base path: https://api.openlattice.com + # Executes a search over all association types to find ones that match the given search term + # @param SearchTerm search_term + # @return [SearchResult] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + test_that("execute_entity_neighbor_search", { # tests for execute_entity_neighbor_search # base path: https://api.openlattice.com @@ -41,6 +74,17 @@ test_that("execute_entity_neighbor_search_bulk", { #expect_equal(result, "EXPECTED_RESULT") }) +test_that("execute_entity_set_collection_search", { + # tests for execute_entity_set_collection_search + # base path: https://api.openlattice.com + # Executes a search over all EntitySetCollections to find ones that match the given search term + # @param SearchTerm search_term + # @return [SearchResult] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + test_that("execute_entity_set_data_query", { # tests for execute_entity_set_data_query # base path: https://api.openlattice.com @@ -64,6 +108,28 @@ test_that("execute_entity_set_keyword_query", { #expect_equal(result, "EXPECTED_RESULT") }) +test_that("execute_entity_type_collection_search", { + # tests for execute_entity_type_collection_search + # base path: https://api.openlattice.com + # Executes a search over all EntityTypeCollections to find ones that match the given search term + # @param SearchTerm search_term + # @return [SearchResult] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("execute_entity_type_search", { + # tests for execute_entity_type_search + # base path: https://api.openlattice.com + # Executes a search over all entity types to find ones that match the given search term + # @param SearchTerm search_term + # @return [SearchResult] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + test_that("execute_filtered_entity_neighbor_id_search", { # tests for execute_filtered_entity_neighbor_id_search # base path: https://api.openlattice.com @@ -88,6 +154,39 @@ test_that("execute_filtered_entity_neighbor_search", { #expect_equal(result, "EXPECTED_RESULT") }) +test_that("execute_fqn_property_type_search", { + # tests for execute_fqn_property_type_search + # base path: https://api.openlattice.com + # Executes a search over all property types to find ones that match the given name and namespace, including partial matches + # @param SearchTerm search_term + # @return [SearchResult] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("execute_organization_search", { + # tests for execute_organization_search + # base path: https://api.openlattice.com + # Executes a search over all organizations to find ones that match the given search term + # @param SearchTerm search_term + # @return [SearchResult] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("execute_property_type_search", { + # tests for execute_property_type_search + # base path: https://api.openlattice.com + # Executes a search over all property types to find ones that match the given search term + # @param SearchTerm search_term + # @return [SearchResult] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + test_that("get_entity_sets", { # tests for get_entity_sets # base path: https://api.openlattice.com diff --git a/R/tests/testthat/test_shuttle_api.R b/R/tests/testthat/test_shuttle_api.R new file mode 100644 index 0000000..45d26d2 --- /dev/null +++ b/R/tests/testthat/test_shuttle_api.R @@ -0,0 +1,97 @@ +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate + +context("Test ShuttleApi") + +api.instance <- ShuttleApi$new() + +test_that("create_integration_definition", { + # tests for create_integration_definition + # base path: https://api.openlattice.com + # Creates a new integration definition for running recurring integrations + # @param character integration_name + # @param Integration integration + # @return [character] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("delete_integration_definition", { + # tests for delete_integration_definition + # base path: https://api.openlattice.com + # Replaces any number of fields within an existing integration definition + # @param character integration_name + # @return [Void] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("delete_integration_job_status", { + # tests for delete_integration_job_status + # base path: https://api.openlattice.com + # Deletes an integration job status from the integrationJobs map + # @param character job_id the unique id of the integration job + # @return [Void] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("enqueue_integration", { + # tests for enqueue_integration + # base path: https://api.openlattice.com + # Enqueues an integration on Shuttle Server for a given integration + # @param character integration_name the name of the integration to be run + # @param character integration_key the unique id used to authenticate an integration run + # @return [character] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("poll_all_integrations", { + # tests for poll_all_integrations + # base path: https://api.openlattice.com + # Polls the statuses of all running integrations + # @return [list(IntegrationJob)] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("poll_integration", { + # tests for poll_integration + # base path: https://api.openlattice.com + # Polls the status of an integration + # @param character job_id the unique id of the integration job + # @return [character] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("read_integration_definition", { + # tests for read_integration_definition + # base path: https://api.openlattice.com + # Gets an existing integration definition + # @param character integration_name + # @return [Integration] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + +test_that("update_integration_definition", { + # tests for update_integration_definition + # base path: https://api.openlattice.com + # Replaces any number of fields within an existing integration definition + # @param character integration_name + # @param IntegrationUpdate integration_update + # @return [Void] + + # uncomment below to test the operation + #expect_equal(result, "EXPECTED_RESULT") +}) + diff --git a/R/tests/testthat/test_sort_definition.R b/R/tests/testthat/test_sort_definition.R index 020775c..101cd66 100644 --- a/R/tests/testthat/test_sort_definition.R +++ b/R/tests/testthat/test_sort_definition.R @@ -12,11 +12,11 @@ test_that("type", { #expect_equal(model.instance$`type`, "EXPECTED_RESULT") }) -test_that("isDescending", { - # tests for the property `isDescending` (character) +test_that("descending", { + # tests for the property `descending` (character) # uncomment below to test the property - #expect_equal(model.instance$`isDescending`, "EXPECTED_RESULT") + #expect_equal(model.instance$`descending`, "EXPECTED_RESULT") }) test_that("propertyTypeId", { diff --git a/android/.openapi-generator/FILES b/android/.openapi-generator/FILES new file mode 100644 index 0000000..f519b17 --- /dev/null +++ b/android/.openapi-generator/FILES @@ -0,0 +1,205 @@ +.gitignore +.openapi-generator-ignore +README.md +build.gradle +docs/AccessCheck.md +docs/Ace.md +docs/Acl.md +docs/AclData.md +docs/AdminApi.md +docs/AdvancedSearch.md +docs/Association.md +docs/AssociationDefinition.md +docs/AssociationType.md +docs/Auth0userBasic.md +docs/Authorization.md +docs/AuthorizationsApi.md +docs/AuthorizedObjectsSearchResult.md +docs/BulkDataCreation.md +docs/CollectionTemplateType.md +docs/CollectionsApi.md +docs/Constraint.md +docs/ConstraintGroup.md +docs/DataApi.md +docs/DataAssociation.md +docs/DataEdge.md +docs/DataEdgeData.md +docs/DataEdgeKey.md +docs/DataGraph.md +docs/DataGraphIds.md +docs/DataIntegrationsApi.md +docs/DataSearchResult.md +docs/DatasetApi.md +docs/EDM.md +docs/EDMdiff.md +docs/EdmApi.md +docs/EdmRequest.md +docs/Entity.md +docs/EntityDataKey.md +docs/EntityDefinition.md +docs/EntityKey.md +docs/EntityKeyPair.md +docs/EntityLinkingFeatures.md +docs/EntityLinkingFeedback.md +docs/EntityNeighborsFilter.md +docs/EntitySet.md +docs/EntitySetCollection.md +docs/EntitySetPropertyMetaData.md +docs/EntitySetSelection.md +docs/EntitySetsApi.md +docs/EntityType.md +docs/EntityTypeCollection.md +docs/EntityTypePropertyMetadata.md +docs/Flight.md +docs/FlightPlanParameters.md +docs/FlightPlanParametersUpdate.md +docs/FullQualifiedName.md +docs/IndexingState.md +docs/InlineObject.md +docs/InlineResponse200.md +docs/Integration.md +docs/IntegrationJob.md +docs/IntegrationResults.md +docs/IntegrationUpdate.md +docs/LinkingApi.md +docs/LinkingFeedback.md +docs/MaterializedViewAccount.md +docs/MetadataUpdate.md +docs/NeighborEntityDetails.md +docs/NeighborEntityIds.md +docs/NeighborSearchFilter.md +docs/Organization.md +docs/OrganizationExternalDatabaseColumn.md +docs/OrganizationExternalDatabaseTable.md +docs/OrganizationExternalDatabaseTableColumnsPair.md +docs/OrganizationMember.md +docs/OrganizationsApi.md +docs/PermissionsApi.md +docs/Principal.md +docs/PrincipalApi.md +docs/PropertyDefinition.md +docs/PropertyType.md +docs/PropertyUsageSummary.md +docs/Role.md +docs/Schema.md +docs/Search.md +docs/SearchApi.md +docs/SearchConstraints.md +docs/SearchDetails.md +docs/SearchResult.md +docs/SearchResultHits.md +docs/SearchTerm.md +docs/SecurablePrincipal.md +docs/ShuttleApi.md +docs/SmsEntitySetInformation.md +docs/SortDefinition.md +git_push.sh +gradle/wrapper/gradle-wrapper.jar +gradle/wrapper/gradle-wrapper.properties +gradlew +gradlew.bat +pom.xml +src/main/AndroidManifest.xml +src/main/java/org/openapitools/client/ApiException.java +src/main/java/org/openapitools/client/ApiInvoker.java +src/main/java/org/openapitools/client/JsonUtil.java +src/main/java/org/openapitools/client/Pair.java +src/main/java/org/openapitools/client/api/AdminApi.java +src/main/java/org/openapitools/client/api/AuthorizationsApi.java +src/main/java/org/openapitools/client/api/CollectionsApi.java +src/main/java/org/openapitools/client/api/DataApi.java +src/main/java/org/openapitools/client/api/DataIntegrationsApi.java +src/main/java/org/openapitools/client/api/DatasetApi.java +src/main/java/org/openapitools/client/api/EdmApi.java +src/main/java/org/openapitools/client/api/EntitySetsApi.java +src/main/java/org/openapitools/client/api/LinkingApi.java +src/main/java/org/openapitools/client/api/OrganizationsApi.java +src/main/java/org/openapitools/client/api/PermissionsApi.java +src/main/java/org/openapitools/client/api/PrincipalApi.java +src/main/java/org/openapitools/client/api/SearchApi.java +src/main/java/org/openapitools/client/api/ShuttleApi.java +src/main/java/org/openapitools/client/auth/ApiKeyAuth.java +src/main/java/org/openapitools/client/auth/Authentication.java +src/main/java/org/openapitools/client/auth/HttpBasicAuth.java +src/main/java/org/openapitools/client/model/AccessCheck.java +src/main/java/org/openapitools/client/model/Ace.java +src/main/java/org/openapitools/client/model/Acl.java +src/main/java/org/openapitools/client/model/AclData.java +src/main/java/org/openapitools/client/model/AdvancedSearch.java +src/main/java/org/openapitools/client/model/Association.java +src/main/java/org/openapitools/client/model/AssociationDefinition.java +src/main/java/org/openapitools/client/model/AssociationType.java +src/main/java/org/openapitools/client/model/Auth0userBasic.java +src/main/java/org/openapitools/client/model/Authorization.java +src/main/java/org/openapitools/client/model/AuthorizedObjectsSearchResult.java +src/main/java/org/openapitools/client/model/BulkDataCreation.java +src/main/java/org/openapitools/client/model/CollectionTemplateType.java +src/main/java/org/openapitools/client/model/Constraint.java +src/main/java/org/openapitools/client/model/ConstraintGroup.java +src/main/java/org/openapitools/client/model/DataAssociation.java +src/main/java/org/openapitools/client/model/DataEdge.java +src/main/java/org/openapitools/client/model/DataEdgeData.java +src/main/java/org/openapitools/client/model/DataEdgeKey.java +src/main/java/org/openapitools/client/model/DataGraph.java +src/main/java/org/openapitools/client/model/DataGraphIds.java +src/main/java/org/openapitools/client/model/DataSearchResult.java +src/main/java/org/openapitools/client/model/EDM.java +src/main/java/org/openapitools/client/model/EDMdiff.java +src/main/java/org/openapitools/client/model/EdmRequest.java +src/main/java/org/openapitools/client/model/Entity.java +src/main/java/org/openapitools/client/model/EntityDataKey.java +src/main/java/org/openapitools/client/model/EntityDefinition.java +src/main/java/org/openapitools/client/model/EntityKey.java +src/main/java/org/openapitools/client/model/EntityKeyPair.java +src/main/java/org/openapitools/client/model/EntityLinkingFeatures.java +src/main/java/org/openapitools/client/model/EntityLinkingFeedback.java +src/main/java/org/openapitools/client/model/EntityNeighborsFilter.java +src/main/java/org/openapitools/client/model/EntitySet.java +src/main/java/org/openapitools/client/model/EntitySetCollection.java +src/main/java/org/openapitools/client/model/EntitySetPropertyMetaData.java +src/main/java/org/openapitools/client/model/EntitySetSelection.java +src/main/java/org/openapitools/client/model/EntityType.java +src/main/java/org/openapitools/client/model/EntityTypeCollection.java +src/main/java/org/openapitools/client/model/EntityTypePropertyMetadata.java +src/main/java/org/openapitools/client/model/Flight.java +src/main/java/org/openapitools/client/model/FlightPlanParameters.java +src/main/java/org/openapitools/client/model/FlightPlanParametersUpdate.java +src/main/java/org/openapitools/client/model/FullQualifiedName.java +src/main/java/org/openapitools/client/model/IndexingState.java +src/main/java/org/openapitools/client/model/InlineObject.java +src/main/java/org/openapitools/client/model/InlineResponse200.java +src/main/java/org/openapitools/client/model/Integration.java +src/main/java/org/openapitools/client/model/IntegrationJob.java +src/main/java/org/openapitools/client/model/IntegrationResults.java +src/main/java/org/openapitools/client/model/IntegrationUpdate.java +src/main/java/org/openapitools/client/model/LinkingFeedback.java +src/main/java/org/openapitools/client/model/MaterializedViewAccount.java +src/main/java/org/openapitools/client/model/MetadataUpdate.java +src/main/java/org/openapitools/client/model/NeighborEntityDetails.java +src/main/java/org/openapitools/client/model/NeighborEntityIds.java +src/main/java/org/openapitools/client/model/NeighborSearchFilter.java +src/main/java/org/openapitools/client/model/Organization.java +src/main/java/org/openapitools/client/model/OrganizationExternalDatabaseColumn.java +src/main/java/org/openapitools/client/model/OrganizationExternalDatabaseTable.java +src/main/java/org/openapitools/client/model/OrganizationExternalDatabaseTableColumnsPair.java +src/main/java/org/openapitools/client/model/OrganizationMember.java +src/main/java/org/openapitools/client/model/Principal.java +src/main/java/org/openapitools/client/model/PropertyDefinition.java +src/main/java/org/openapitools/client/model/PropertyType.java +src/main/java/org/openapitools/client/model/PropertyUsageSummary.java +src/main/java/org/openapitools/client/model/Role.java +src/main/java/org/openapitools/client/model/Schema.java +src/main/java/org/openapitools/client/model/Search.java +src/main/java/org/openapitools/client/model/SearchConstraints.java +src/main/java/org/openapitools/client/model/SearchDetails.java +src/main/java/org/openapitools/client/model/SearchResult.java +src/main/java/org/openapitools/client/model/SearchResultHits.java +src/main/java/org/openapitools/client/model/SearchTerm.java +src/main/java/org/openapitools/client/model/SecurablePrincipal.java +src/main/java/org/openapitools/client/model/SmsEntitySetInformation.java +src/main/java/org/openapitools/client/model/SortDefinition.java +src/main/java/org/openapitools/client/request/DeleteRequest.java +src/main/java/org/openapitools/client/request/GetRequest.java +src/main/java/org/openapitools/client/request/PatchRequest.java +src/main/java/org/openapitools/client/request/PostRequest.java +src/main/java/org/openapitools/client/request/PutRequest.java diff --git a/android/.openapi-generator/VERSION b/android/.openapi-generator/VERSION index bfbf77e..d99e716 100644 --- a/android/.openapi-generator/VERSION +++ b/android/.openapi-generator/VERSION @@ -1 +1 @@ -4.3.0-SNAPSHOT \ No newline at end of file +5.0.0-SNAPSHOT \ No newline at end of file diff --git a/android/README.md b/android/README.md index ceef34c..62b3142 100644 --- a/android/README.md +++ b/android/README.md @@ -96,7 +96,7 @@ Class | Method | HTTP request | Description *CollectionsApi* | [**getAllEntitySetCollections**](docs/CollectionsApi.md#getAllEntitySetCollections) | **GET** /datastore/collections/entity/set | Returns all EntitySetCollection objects *CollectionsApi* | [**getAllEntityTypeCollections**](docs/CollectionsApi.md#getAllEntityTypeCollections) | **GET** /datastore/collections/entity/type | Returns all EntityTypeCollection objects *CollectionsApi* | [**getEntitySetCollection**](docs/CollectionsApi.md#getEntitySetCollection) | **GET** /datastore/collections/entity/set/{entitySetCollectionId} | Returns the EntitySetCollection object for a given id -*CollectionsApi* | [**getEntitySetCollectionsOfType**](docs/CollectionsApi.md#getEntitySetCollectionsOfType) | **GET** /datastore/collections/entity/type/entity/set/{entitySetCollectionId} | Returns all authorized EntitySetCollections for a given EntityTypeCollection id +*CollectionsApi* | [**getEntitySetCollectionsOfType**](docs/CollectionsApi.md#getEntitySetCollectionsOfType) | **GET** /datastore/collections/entity/set/entity/type/{entitySetCollectionId} | Returns all authorized EntitySetCollections for a given EntityTypeCollection id *CollectionsApi* | [**getEntityTypeCollection**](docs/CollectionsApi.md#getEntityTypeCollection) | **GET** /datastore/collections/entity/type/{entityTypeCollectionId} | Returns the EntityTypeCollection object for a given id *CollectionsApi* | [**removeTypeFromEntityTypeCollectionTemplate**](docs/CollectionsApi.md#removeTypeFromEntityTypeCollectionTemplate) | **DELETE** /datastore/collections/entity/type/{entityTypeCollectionId}/template/{typeId} | Removes a key from an EntityTypeCollection template *CollectionsApi* | [**updateEntitySetCollectionMetadata**](docs/CollectionsApi.md#updateEntitySetCollectionMetadata) | **PATCH** /datastore/collections/entity/set/{entitySetCollectionId} | Updates metadata of the specified EntitySetCollection @@ -109,7 +109,7 @@ Class | Method | HTTP request | Description *DataApi* | [**deleteAllEntitiesFromEntitySet**](docs/DataApi.md#deleteAllEntitiesFromEntitySet) | **DELETE** /datastore/data/set/{entitySetId}/all | Clears the Entity matching the given Entity id and all of its neighbor Entities *DataApi* | [**deleteEntities**](docs/DataApi.md#deleteEntities) | **DELETE** /datastore/data/set/{entitySetId} | Deletes multiple entities from an entity set. *DataApi* | [**deleteEntitiesAndNeighbors**](docs/DataApi.md#deleteEntitiesAndNeighbors) | **POST** /datastore/data/set/{entitySetId}/neighbors | Deletes the entities matching the given entity ids and all of its neighbor entities provided in the filter. -*DataApi* | [**deleteEntity**](docs/DataApi.md#deleteEntity) | **DELETE** /datastore/data/{entitySetId}/{entityKeyId} | Deletes a single entity from an entity set. +*DataApi* | [**deleteEntity**](docs/DataApi.md#deleteEntity) | **DELETE** /datastore/data/set/{entitySetId}/{entityKeyId} | Deletes a single entity from an entity set. *DataApi* | [**deleteEntityProperties**](docs/DataApi.md#deleteEntityProperties) | **DELETE** /datastore/data/{entitySetId}/{entityKeyId}/properties | Deletes properties from an entity. *DataApi* | [**getEntity**](docs/DataApi.md#getEntity) | **GET** /datastore/data/{entitySetId}/{entityKeyId} | Loads a single entity by its entityKeyId and entitySetId *DataApi* | [**getEntityPropertyValues**](docs/DataApi.md#getEntityPropertyValues) | **GET** /datastore/data/{entitySetId}/{entityKeyId}/{propertyTypeId} | Loads property values for a single entity by its entityKeyId, entitySetId and propertyTypeId @@ -272,6 +272,14 @@ Class | Method | HTTP request | Description *SearchApi* | [**getEntitySets**](docs/SearchApi.md#getEntitySets) | **GET** /datastore/search/entity-sets/{start}/{numResults} | Executes a search over all existing entity sets to populate the home page. The path parameters instruct which page to return and how large the page should be. *SearchApi* | [**getPopularEntitySet**](docs/SearchApi.md#getPopularEntitySet) | **GET** /datastore/search/popular | Get the most popular entity sets. *SearchApi* | [**searchEntitySetData**](docs/SearchApi.md#searchEntitySetData) | **PATCH** /datastore/search | Executes a search over the data of a given entity set to find rows that match the search term +*ShuttleApi* | [**createIntegrationDefinition**](docs/ShuttleApi.md#createIntegrationDefinition) | **POST** /shuttle/integration/definition/{integrationName} | Creates a new integration definition for running recurring integrations +*ShuttleApi* | [**deleteIntegrationDefinition**](docs/ShuttleApi.md#deleteIntegrationDefinition) | **DELETE** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition +*ShuttleApi* | [**deleteIntegrationJobStatus**](docs/ShuttleApi.md#deleteIntegrationJobStatus) | **DELETE** /shuttle/integration/status/{jobId} | Deletes an integration job status from the integrationJobs map +*ShuttleApi* | [**enqueueIntegration**](docs/ShuttleApi.md#enqueueIntegration) | **GET** /shuttle/integration/{integrationName}/{integrationKey} | Enqueues an integration on Shuttle Server for a given integration +*ShuttleApi* | [**pollAllIntegrations**](docs/ShuttleApi.md#pollAllIntegrations) | **GET** /shuttle/integration/status | Polls the statuses of all running integrations +*ShuttleApi* | [**pollIntegration**](docs/ShuttleApi.md#pollIntegration) | **GET** /shuttle/integration/status/{jobId} | Polls the status of an integration +*ShuttleApi* | [**readIntegrationDefinition**](docs/ShuttleApi.md#readIntegrationDefinition) | **GET** /shuttle/integration/definition/{integrationName} | Gets an existing integration definition +*ShuttleApi* | [**updateIntegrationDefinition**](docs/ShuttleApi.md#updateIntegrationDefinition) | **PATCH** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition ## Documentation for Models @@ -282,6 +290,7 @@ Class | Method | HTTP request | Description - [AclData](docs/AclData.md) - [AdvancedSearch](docs/AdvancedSearch.md) - [Association](docs/Association.md) + - [AssociationDefinition](docs/AssociationDefinition.md) - [AssociationType](docs/AssociationType.md) - [Auth0userBasic](docs/Auth0userBasic.md) - [Authorization](docs/Authorization.md) @@ -302,6 +311,7 @@ Class | Method | HTTP request | Description - [EdmRequest](docs/EdmRequest.md) - [Entity](docs/Entity.md) - [EntityDataKey](docs/EntityDataKey.md) + - [EntityDefinition](docs/EntityDefinition.md) - [EntityKey](docs/EntityKey.md) - [EntityKeyPair](docs/EntityKeyPair.md) - [EntityLinkingFeatures](docs/EntityLinkingFeatures.md) @@ -314,11 +324,17 @@ Class | Method | HTTP request | Description - [EntityType](docs/EntityType.md) - [EntityTypeCollection](docs/EntityTypeCollection.md) - [EntityTypePropertyMetadata](docs/EntityTypePropertyMetadata.md) + - [Flight](docs/Flight.md) + - [FlightPlanParameters](docs/FlightPlanParameters.md) + - [FlightPlanParametersUpdate](docs/FlightPlanParametersUpdate.md) - [FullQualifiedName](docs/FullQualifiedName.md) - [IndexingState](docs/IndexingState.md) - [InlineObject](docs/InlineObject.md) - [InlineResponse200](docs/InlineResponse200.md) + - [Integration](docs/Integration.md) + - [IntegrationJob](docs/IntegrationJob.md) - [IntegrationResults](docs/IntegrationResults.md) + - [IntegrationUpdate](docs/IntegrationUpdate.md) - [LinkingFeedback](docs/LinkingFeedback.md) - [MaterializedViewAccount](docs/MaterializedViewAccount.md) - [MetadataUpdate](docs/MetadataUpdate.md) @@ -331,6 +347,7 @@ Class | Method | HTTP request | Description - [OrganizationExternalDatabaseTableColumnsPair](docs/OrganizationExternalDatabaseTableColumnsPair.md) - [OrganizationMember](docs/OrganizationMember.md) - [Principal](docs/Principal.md) + - [PropertyDefinition](docs/PropertyDefinition.md) - [PropertyType](docs/PropertyType.md) - [PropertyUsageSummary](docs/PropertyUsageSummary.md) - [Role](docs/Role.md) @@ -339,6 +356,7 @@ Class | Method | HTTP request | Description - [SearchConstraints](docs/SearchConstraints.md) - [SearchDetails](docs/SearchDetails.md) - [SearchResult](docs/SearchResult.md) + - [SearchResultHits](docs/SearchResultHits.md) - [SearchTerm](docs/SearchTerm.md) - [SecurablePrincipal](docs/SecurablePrincipal.md) - [SmsEntitySetInformation](docs/SmsEntitySetInformation.md) diff --git a/android/docs/AssociationDefinition.md b/android/docs/AssociationDefinition.md new file mode 100644 index 0000000..1f8b33e --- /dev/null +++ b/android/docs/AssociationDefinition.md @@ -0,0 +1,24 @@ + + +# AssociationDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fqn** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**entitySetName** | **String** | | [optional] +**propertyDefinitions** | [**Map<String, PropertyDefinition>**](PropertyDefinition.md) | | [optional] +**updateType** | [**UpdateTypeEnum**](#UpdateTypeEnum) | | [optional] +**src** | **String** | | [optional] +**dst** | **String** | | [optional] + + +## Enum: UpdateTypeEnum + +Name | Value +---- | ----- + + + + diff --git a/android/docs/CollectionsApi.md b/android/docs/CollectionsApi.md index 74b7a5a..3780071 100644 --- a/android/docs/CollectionsApi.md +++ b/android/docs/CollectionsApi.md @@ -12,7 +12,7 @@ Method | HTTP request | Description [**getAllEntitySetCollections**](CollectionsApi.md#getAllEntitySetCollections) | **GET** /datastore/collections/entity/set | Returns all EntitySetCollection objects [**getAllEntityTypeCollections**](CollectionsApi.md#getAllEntityTypeCollections) | **GET** /datastore/collections/entity/type | Returns all EntityTypeCollection objects [**getEntitySetCollection**](CollectionsApi.md#getEntitySetCollection) | **GET** /datastore/collections/entity/set/{entitySetCollectionId} | Returns the EntitySetCollection object for a given id -[**getEntitySetCollectionsOfType**](CollectionsApi.md#getEntitySetCollectionsOfType) | **GET** /datastore/collections/entity/type/entity/set/{entitySetCollectionId} | Returns all authorized EntitySetCollections for a given EntityTypeCollection id +[**getEntitySetCollectionsOfType**](CollectionsApi.md#getEntitySetCollectionsOfType) | **GET** /datastore/collections/entity/set/entity/type/{entitySetCollectionId} | Returns all authorized EntitySetCollections for a given EntityTypeCollection id [**getEntityTypeCollection**](CollectionsApi.md#getEntityTypeCollection) | **GET** /datastore/collections/entity/type/{entityTypeCollectionId} | Returns the EntityTypeCollection object for a given id [**removeTypeFromEntityTypeCollectionTemplate**](CollectionsApi.md#removeTypeFromEntityTypeCollectionTemplate) | **DELETE** /datastore/collections/entity/type/{entityTypeCollectionId}/template/{typeId} | Removes a key from an EntityTypeCollection template [**updateEntitySetCollectionMetadata**](CollectionsApi.md#updateEntitySetCollectionMetadata) | **PATCH** /datastore/collections/entity/set/{entitySetCollectionId} | Updates metadata of the specified EntitySetCollection @@ -23,7 +23,7 @@ Method | HTTP request | Description ## addTypeToEntityTypeCollectionTemplate -> addTypeToEntityTypeCollectionTemplate(entityTypeCollectionId, entityTypeCollection) +> addTypeToEntityTypeCollectionTemplate(entityTypeCollectionId, collectionTemplateType) Appends type to template of the specified EntityTypeCollection @@ -35,9 +35,9 @@ Appends type to template of the specified EntityTypeCollection CollectionsApi apiInstance = new CollectionsApi(); UUID entityTypeCollectionId = null; // UUID | -EntityTypeCollection entityTypeCollection = new EntityTypeCollection(); // EntityTypeCollection | +CollectionTemplateType collectionTemplateType = new CollectionTemplateType(); // CollectionTemplateType | try { - apiInstance.addTypeToEntityTypeCollectionTemplate(entityTypeCollectionId, entityTypeCollection); + apiInstance.addTypeToEntityTypeCollectionTemplate(entityTypeCollectionId, collectionTemplateType); } catch (ApiException e) { System.err.println("Exception when calling CollectionsApi#addTypeToEntityTypeCollectionTemplate"); e.printStackTrace(); @@ -50,7 +50,7 @@ try { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **entityTypeCollectionId** | [**UUID**](.md)| | [default to null] - **entityTypeCollection** | [**EntityTypeCollection**](EntityTypeCollection.md)| | + **collectionTemplateType** | [**CollectionTemplateType**](CollectionTemplateType.md)| | ### Return type diff --git a/android/docs/DataApi.md b/android/docs/DataApi.md index 381a625..7e83310 100644 --- a/android/docs/DataApi.md +++ b/android/docs/DataApi.md @@ -11,7 +11,7 @@ Method | HTTP request | Description [**deleteAllEntitiesFromEntitySet**](DataApi.md#deleteAllEntitiesFromEntitySet) | **DELETE** /datastore/data/set/{entitySetId}/all | Clears the Entity matching the given Entity id and all of its neighbor Entities [**deleteEntities**](DataApi.md#deleteEntities) | **DELETE** /datastore/data/set/{entitySetId} | Deletes multiple entities from an entity set. [**deleteEntitiesAndNeighbors**](DataApi.md#deleteEntitiesAndNeighbors) | **POST** /datastore/data/set/{entitySetId}/neighbors | Deletes the entities matching the given entity ids and all of its neighbor entities provided in the filter. -[**deleteEntity**](DataApi.md#deleteEntity) | **DELETE** /datastore/data/{entitySetId}/{entityKeyId} | Deletes a single entity from an entity set. +[**deleteEntity**](DataApi.md#deleteEntity) | **DELETE** /datastore/data/set/{entitySetId}/{entityKeyId} | Deletes a single entity from an entity set. [**deleteEntityProperties**](DataApi.md#deleteEntityProperties) | **DELETE** /datastore/data/{entitySetId}/{entityKeyId}/properties | Deletes properties from an entity. [**getEntity**](DataApi.md#getEntity) | **GET** /datastore/data/{entitySetId}/{entityKeyId} | Loads a single entity by its entityKeyId and entitySetId [**getEntityPropertyValues**](DataApi.md#getEntityPropertyValues) | **GET** /datastore/data/{entitySetId}/{entityKeyId}/{propertyTypeId} | Loads property values for a single entity by its entityKeyId, entitySetId and propertyTypeId diff --git a/android/docs/DataAssociation.md b/android/docs/DataAssociation.md index 50eca9d..becbb76 100644 --- a/android/docs/DataAssociation.md +++ b/android/docs/DataAssociation.md @@ -9,6 +9,10 @@ Name | Type | Description | Notes **srcEntitySetId** | [**UUID**](UUID.md) | the ID of the source entity set | [optional] **srcEntityIndex** | [**UUID**](UUID.md) | The index of an entity | [optional] **srcEntityKeyId** | [**UUID**](UUID.md) | An existing entityKeyId | [optional] +**dstEntitySetId** | [**UUID**](UUID.md) | the ID of the dst entity set | [optional] +**dstEntityIndex** | [**UUID**](UUID.md) | The index of an entity | [optional] +**dstEntityKeyId** | [**UUID**](UUID.md) | An existing entityKeyId | [optional] +**data** | [**Map<String, List<String>>**](List.md) | data | [optional] diff --git a/android/docs/EntityDefinition.md b/android/docs/EntityDefinition.md new file mode 100644 index 0000000..6e7898a --- /dev/null +++ b/android/docs/EntityDefinition.md @@ -0,0 +1,22 @@ + + +# EntityDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fqn** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**entitySetName** | **String** | | [optional] +**propertyDefinitions** | [**Map<String, PropertyDefinition>**](PropertyDefinition.md) | | [optional] +**updateType** | [**UpdateTypeEnum**](#UpdateTypeEnum) | | [optional] + + +## Enum: UpdateTypeEnum + +Name | Value +---- | ----- + + + + diff --git a/android/docs/Flight.md b/android/docs/Flight.md new file mode 100644 index 0000000..58f8105 --- /dev/null +++ b/android/docs/Flight.md @@ -0,0 +1,17 @@ + + +# Flight + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | | [optional] +**tags** | **List<String>** | | [optional] +**organizationId** | [**UUID**](UUID.md) | | [optional] +**entityDefinitions** | [**Map<String, EntityDefinition>**](EntityDefinition.md) | | [optional] +**associationDefinitions** | [**Map<String, AssociationDefinition>**](AssociationDefinition.md) | | [optional] + + + + diff --git a/android/docs/FlightPlanParameters.md b/android/docs/FlightPlanParameters.md new file mode 100644 index 0000000..e32cb79 --- /dev/null +++ b/android/docs/FlightPlanParameters.md @@ -0,0 +1,17 @@ + + +# FlightPlanParameters + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sql** | **String** | the sql query to be used to pull cleaned data from postgres | [optional] +**src** | **Map<String, String>** | postgres data source for pulling clean data | [optional] +**srcPrimaryKeyColumns** | **List<String>** | the columns that are primary keys in the cleaned data | [optional] +**path** | **String** | the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) | [optional] +**flight** | [**Flight**](Flight.md) | | [optional] + + + + diff --git a/android/docs/FlightPlanParametersUpdate.md b/android/docs/FlightPlanParametersUpdate.md new file mode 100644 index 0000000..fb25f71 --- /dev/null +++ b/android/docs/FlightPlanParametersUpdate.md @@ -0,0 +1,16 @@ + + +# FlightPlanParametersUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sql** | **String** | the sql query to be used to pull cleaned data from postgres | [optional] +**src** | **Map<String, String>** | postgres data source for pulling clean data | [optional] +**srcPrimaryKeyColumns** | **List<String>** | the columns that are primary keys in the cleaned data | [optional] +**path** | **String** | the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) | [optional] + + + + diff --git a/android/docs/Integration.md b/android/docs/Integration.md new file mode 100644 index 0000000..209f91d --- /dev/null +++ b/android/docs/Integration.md @@ -0,0 +1,27 @@ + + +# Integration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | [**UUID**](UUID.md) | a unique ID used for authorizing a call to run an integration | [optional] +**environment** | [**EnvironmentEnum**](#EnvironmentEnum) | the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) | [optional] +**s3Bucket** | **String** | the url of the s3bucket to be used | [optional] +**contacts** | **List<String>** | the set of email addresses of those responsible for the integration | [optional] +**organizationId** | [**UUID**](UUID.md) | the id of the organization that owns the integration | [optional] +**entitySetId** | [**UUID**](UUID.md) | the id of the entity set that stores the logs for this integration | [optional] +**maxConnections** | **Integer** | maximum number of connections to postgres allowed for this integration | [optional] +**callback** | **List<String>** | urls to receive a POST when integration has completed | [optional] +**flightPlanParameters** | [**Map<String, FlightPlanParameters>**](FlightPlanParameters.md) | a map from [Flight] name to [FlightPlanParameters] | [optional] + + +## Enum: EnvironmentEnum + +Name | Value +---- | ----- + + + + diff --git a/android/docs/IntegrationJob.md b/android/docs/IntegrationJob.md new file mode 100644 index 0000000..31ab498 --- /dev/null +++ b/android/docs/IntegrationJob.md @@ -0,0 +1,20 @@ + + +# IntegrationJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | | [optional] +**status** | [**StatusEnum**](#StatusEnum) | | [optional] + + +## Enum: StatusEnum + +Name | Value +---- | ----- + + + + diff --git a/android/docs/IntegrationUpdate.md b/android/docs/IntegrationUpdate.md new file mode 100644 index 0000000..0de3547 --- /dev/null +++ b/android/docs/IntegrationUpdate.md @@ -0,0 +1,25 @@ + + +# IntegrationUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**environment** | [**EnvironmentEnum**](#EnvironmentEnum) | the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) | [optional] +**s3Bucket** | **String** | the url of the s3bucket to be used | [optional] +**contacts** | **List<String>** | the set of email addresses of those responsible for the integration | [optional] +**organizationId** | [**UUID**](UUID.md) | the id of the organization that owns the integration | [optional] +**maxConnections** | **Integer** | maximum number of connections to postgres allowed for this integration | [optional] +**callbackUrls** | **List<String>** | urls to receive a POST when integration has completed | [optional] +**flightPlanParameters** | [**Map<String, FlightPlanParametersUpdate>**](FlightPlanParametersUpdate.md) | a map from [Flight] name to [FlightPlanParametersUpdate] | [optional] + + +## Enum: EnvironmentEnum + +Name | Value +---- | ----- + + + + diff --git a/android/docs/PropertyDefinition.md b/android/docs/PropertyDefinition.md new file mode 100644 index 0000000..e54a167 --- /dev/null +++ b/android/docs/PropertyDefinition.md @@ -0,0 +1,14 @@ + + +# PropertyDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**column** | **String** | | [optional] + + + + diff --git a/android/docs/Role.md b/android/docs/Role.md index 9e3f7d4..730bd85 100644 --- a/android/docs/Role.md +++ b/android/docs/Role.md @@ -11,13 +11,6 @@ Name | Type | Description | Notes **principal** | [**Principal**](Principal.md) | | [optional] **title** | **String** | | [optional] **description** | **String** | | [optional] -**_class** | [**_classEnum**](#_classEnum) | | [optional] - - -## Enum: _classEnum - -Name | Value ----- | ----- diff --git a/android/docs/SearchResult.md b/android/docs/SearchResult.md index c047b84..009da4b 100644 --- a/android/docs/SearchResult.md +++ b/android/docs/SearchResult.md @@ -7,7 +7,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **numHits** | **Integer** | | [optional] -**hits** | **Map<String, String>** | | [optional] +**hits** | [**List<SearchResultHits>**](SearchResultHits.md) | | [optional] diff --git a/android/docs/SearchResultHits.md b/android/docs/SearchResultHits.md new file mode 100644 index 0000000..8c4bcf3 --- /dev/null +++ b/android/docs/SearchResultHits.md @@ -0,0 +1,14 @@ + + +# SearchResultHits + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**propertyTypes** | [**List<PropertyType>**](PropertyType.md) | | [optional] +**entitySet** | [**EntitySet**](EntitySet.md) | | [optional] + + + + diff --git a/android/docs/ShuttleApi.md b/android/docs/ShuttleApi.md new file mode 100644 index 0000000..15a7a3a --- /dev/null +++ b/android/docs/ShuttleApi.md @@ -0,0 +1,367 @@ +# ShuttleApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createIntegrationDefinition**](ShuttleApi.md#createIntegrationDefinition) | **POST** /shuttle/integration/definition/{integrationName} | Creates a new integration definition for running recurring integrations +[**deleteIntegrationDefinition**](ShuttleApi.md#deleteIntegrationDefinition) | **DELETE** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition +[**deleteIntegrationJobStatus**](ShuttleApi.md#deleteIntegrationJobStatus) | **DELETE** /shuttle/integration/status/{jobId} | Deletes an integration job status from the integrationJobs map +[**enqueueIntegration**](ShuttleApi.md#enqueueIntegration) | **GET** /shuttle/integration/{integrationName}/{integrationKey} | Enqueues an integration on Shuttle Server for a given integration +[**pollAllIntegrations**](ShuttleApi.md#pollAllIntegrations) | **GET** /shuttle/integration/status | Polls the statuses of all running integrations +[**pollIntegration**](ShuttleApi.md#pollIntegration) | **GET** /shuttle/integration/status/{jobId} | Polls the status of an integration +[**readIntegrationDefinition**](ShuttleApi.md#readIntegrationDefinition) | **GET** /shuttle/integration/definition/{integrationName} | Gets an existing integration definition +[**updateIntegrationDefinition**](ShuttleApi.md#updateIntegrationDefinition) | **PATCH** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition + + + +## createIntegrationDefinition + +> UUID createIntegrationDefinition(integrationName, integration) + +Creates a new integration definition for running recurring integrations + +### Example + +```java +// Import classes: +//import org.openapitools.client.api.ShuttleApi; + +ShuttleApi apiInstance = new ShuttleApi(); +String integrationName = null; // String | +Integration integration = new Integration(); // Integration | +try { + UUID result = apiInstance.createIntegrationDefinition(integrationName, integration); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling ShuttleApi#createIntegrationDefinition"); + e.printStackTrace(); +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integrationName** | **String**| | [default to null] + **integration** | [**Integration**](Integration.md)| | + +### Return type + +[**UUID**](UUID.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## deleteIntegrationDefinition + +> deleteIntegrationDefinition(integrationName) + +Replaces any number of fields within an existing integration definition + +### Example + +```java +// Import classes: +//import org.openapitools.client.api.ShuttleApi; + +ShuttleApi apiInstance = new ShuttleApi(); +String integrationName = null; // String | +try { + apiInstance.deleteIntegrationDefinition(integrationName); +} catch (ApiException e) { + System.err.println("Exception when calling ShuttleApi#deleteIntegrationDefinition"); + e.printStackTrace(); +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integrationName** | **String**| | [default to null] + +### Return type + +null (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteIntegrationJobStatus + +> deleteIntegrationJobStatus(jobId) + +Deletes an integration job status from the integrationJobs map + +### Example + +```java +// Import classes: +//import org.openapitools.client.api.ShuttleApi; + +ShuttleApi apiInstance = new ShuttleApi(); +UUID jobId = null; // UUID | the unique id of the integration job +try { + apiInstance.deleteIntegrationJobStatus(jobId); +} catch (ApiException e) { + System.err.println("Exception when calling ShuttleApi#deleteIntegrationJobStatus"); + e.printStackTrace(); +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **jobId** | [**UUID**](.md)| the unique id of the integration job | [default to null] + +### Return type + +null (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## enqueueIntegration + +> UUID enqueueIntegration(integrationName, integrationKey) + +Enqueues an integration on Shuttle Server for a given integration + +### Example + +```java +// Import classes: +//import org.openapitools.client.api.ShuttleApi; + +ShuttleApi apiInstance = new ShuttleApi(); +String integrationName = null; // String | the name of the integration to be run +UUID integrationKey = null; // UUID | the unique id used to authenticate an integration run +try { + UUID result = apiInstance.enqueueIntegration(integrationName, integrationKey); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling ShuttleApi#enqueueIntegration"); + e.printStackTrace(); +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integrationName** | **String**| the name of the integration to be run | [default to null] + **integrationKey** | [**UUID**](.md)| the unique id used to authenticate an integration run | [default to null] + +### Return type + +[**UUID**](UUID.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## pollAllIntegrations + +> Map<String, IntegrationJob> pollAllIntegrations() + +Polls the statuses of all running integrations + +### Example + +```java +// Import classes: +//import org.openapitools.client.api.ShuttleApi; + +ShuttleApi apiInstance = new ShuttleApi(); +try { + Map result = apiInstance.pollAllIntegrations(); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling ShuttleApi#pollAllIntegrations"); + e.printStackTrace(); +} +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Map<String, IntegrationJob>**](IntegrationJob.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## pollIntegration + +> String pollIntegration(jobId) + +Polls the status of an integration + +### Example + +```java +// Import classes: +//import org.openapitools.client.api.ShuttleApi; + +ShuttleApi apiInstance = new ShuttleApi(); +UUID jobId = null; // UUID | the unique id of the integration job +try { + String result = apiInstance.pollIntegration(jobId); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling ShuttleApi#pollIntegration"); + e.printStackTrace(); +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **jobId** | [**UUID**](.md)| the unique id of the integration job | [default to null] + +### Return type + +**String** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## readIntegrationDefinition + +> Integration readIntegrationDefinition(integrationName) + +Gets an existing integration definition + +### Example + +```java +// Import classes: +//import org.openapitools.client.api.ShuttleApi; + +ShuttleApi apiInstance = new ShuttleApi(); +String integrationName = null; // String | +try { + Integration result = apiInstance.readIntegrationDefinition(integrationName); + System.out.println(result); +} catch (ApiException e) { + System.err.println("Exception when calling ShuttleApi#readIntegrationDefinition"); + e.printStackTrace(); +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integrationName** | **String**| | [default to null] + +### Return type + +[**Integration**](Integration.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## updateIntegrationDefinition + +> updateIntegrationDefinition(integrationName, integrationUpdate) + +Replaces any number of fields within an existing integration definition + +### Example + +```java +// Import classes: +//import org.openapitools.client.api.ShuttleApi; + +ShuttleApi apiInstance = new ShuttleApi(); +String integrationName = null; // String | +IntegrationUpdate integrationUpdate = new IntegrationUpdate(); // IntegrationUpdate | +try { + apiInstance.updateIntegrationDefinition(integrationName, integrationUpdate); +} catch (ApiException e) { + System.err.println("Exception when calling ShuttleApi#updateIntegrationDefinition"); + e.printStackTrace(); +} +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integrationName** | **String**| | [default to null] + **integrationUpdate** | [**IntegrationUpdate**](IntegrationUpdate.md)| | + +### Return type + +null (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + diff --git a/android/gradle/wrapper/gradle-wrapper.jar b/android/gradle/wrapper/gradle-wrapper.jar index 87b738c..43943eb 100644 Binary files a/android/gradle/wrapper/gradle-wrapper.jar and b/android/gradle/wrapper/gradle-wrapper.jar differ diff --git a/android/src/main/java/org/openapitools/client/JsonUtil.java b/android/src/main/java/org/openapitools/client/JsonUtil.java index 8da920c..8a9a946 100644 --- a/android/src/main/java/org/openapitools/client/JsonUtil.java +++ b/android/src/main/java/org/openapitools/client/JsonUtil.java @@ -81,6 +81,10 @@ public static Type getListTypeForDeserialization(Class cls) { return new TypeToken>(){}.getType(); } + if ("AssociationDefinition".equalsIgnoreCase(className)) { + return new TypeToken>(){}.getType(); + } + if ("AssociationType".equalsIgnoreCase(className)) { return new TypeToken>(){}.getType(); } @@ -161,6 +165,10 @@ public static Type getListTypeForDeserialization(Class cls) { return new TypeToken>(){}.getType(); } + if ("EntityDefinition".equalsIgnoreCase(className)) { + return new TypeToken>(){}.getType(); + } + if ("EntityKey".equalsIgnoreCase(className)) { return new TypeToken>(){}.getType(); } @@ -209,6 +217,18 @@ public static Type getListTypeForDeserialization(Class cls) { return new TypeToken>(){}.getType(); } + if ("Flight".equalsIgnoreCase(className)) { + return new TypeToken>(){}.getType(); + } + + if ("FlightPlanParameters".equalsIgnoreCase(className)) { + return new TypeToken>(){}.getType(); + } + + if ("FlightPlanParametersUpdate".equalsIgnoreCase(className)) { + return new TypeToken>(){}.getType(); + } + if ("FullQualifiedName".equalsIgnoreCase(className)) { return new TypeToken>(){}.getType(); } @@ -225,10 +245,22 @@ public static Type getListTypeForDeserialization(Class cls) { return new TypeToken>(){}.getType(); } + if ("Integration".equalsIgnoreCase(className)) { + return new TypeToken>(){}.getType(); + } + + if ("IntegrationJob".equalsIgnoreCase(className)) { + return new TypeToken>(){}.getType(); + } + if ("IntegrationResults".equalsIgnoreCase(className)) { return new TypeToken>(){}.getType(); } + if ("IntegrationUpdate".equalsIgnoreCase(className)) { + return new TypeToken>(){}.getType(); + } + if ("LinkingFeedback".equalsIgnoreCase(className)) { return new TypeToken>(){}.getType(); } @@ -277,6 +309,10 @@ public static Type getListTypeForDeserialization(Class cls) { return new TypeToken>(){}.getType(); } + if ("PropertyDefinition".equalsIgnoreCase(className)) { + return new TypeToken>(){}.getType(); + } + if ("PropertyType".equalsIgnoreCase(className)) { return new TypeToken>(){}.getType(); } @@ -309,6 +345,10 @@ public static Type getListTypeForDeserialization(Class cls) { return new TypeToken>(){}.getType(); } + if ("SearchResultHits".equalsIgnoreCase(className)) { + return new TypeToken>(){}.getType(); + } + if ("SearchTerm".equalsIgnoreCase(className)) { return new TypeToken>(){}.getType(); } @@ -355,6 +395,10 @@ public static Type getTypeForDeserialization(Class cls) { return new TypeToken(){}.getType(); } + if ("AssociationDefinition".equalsIgnoreCase(className)) { + return new TypeToken(){}.getType(); + } + if ("AssociationType".equalsIgnoreCase(className)) { return new TypeToken(){}.getType(); } @@ -435,6 +479,10 @@ public static Type getTypeForDeserialization(Class cls) { return new TypeToken(){}.getType(); } + if ("EntityDefinition".equalsIgnoreCase(className)) { + return new TypeToken(){}.getType(); + } + if ("EntityKey".equalsIgnoreCase(className)) { return new TypeToken(){}.getType(); } @@ -483,6 +531,18 @@ public static Type getTypeForDeserialization(Class cls) { return new TypeToken(){}.getType(); } + if ("Flight".equalsIgnoreCase(className)) { + return new TypeToken(){}.getType(); + } + + if ("FlightPlanParameters".equalsIgnoreCase(className)) { + return new TypeToken(){}.getType(); + } + + if ("FlightPlanParametersUpdate".equalsIgnoreCase(className)) { + return new TypeToken(){}.getType(); + } + if ("FullQualifiedName".equalsIgnoreCase(className)) { return new TypeToken(){}.getType(); } @@ -499,10 +559,22 @@ public static Type getTypeForDeserialization(Class cls) { return new TypeToken(){}.getType(); } + if ("Integration".equalsIgnoreCase(className)) { + return new TypeToken(){}.getType(); + } + + if ("IntegrationJob".equalsIgnoreCase(className)) { + return new TypeToken(){}.getType(); + } + if ("IntegrationResults".equalsIgnoreCase(className)) { return new TypeToken(){}.getType(); } + if ("IntegrationUpdate".equalsIgnoreCase(className)) { + return new TypeToken(){}.getType(); + } + if ("LinkingFeedback".equalsIgnoreCase(className)) { return new TypeToken(){}.getType(); } @@ -551,6 +623,10 @@ public static Type getTypeForDeserialization(Class cls) { return new TypeToken(){}.getType(); } + if ("PropertyDefinition".equalsIgnoreCase(className)) { + return new TypeToken(){}.getType(); + } + if ("PropertyType".equalsIgnoreCase(className)) { return new TypeToken(){}.getType(); } @@ -583,6 +659,10 @@ public static Type getTypeForDeserialization(Class cls) { return new TypeToken(){}.getType(); } + if ("SearchResultHits".equalsIgnoreCase(className)) { + return new TypeToken(){}.getType(); + } + if ("SearchTerm".equalsIgnoreCase(className)) { return new TypeToken(){}.getType(); } diff --git a/android/src/main/java/org/openapitools/client/api/CollectionsApi.java b/android/src/main/java/org/openapitools/client/api/CollectionsApi.java index 76aae24..982de57 100644 --- a/android/src/main/java/org/openapitools/client/api/CollectionsApi.java +++ b/android/src/main/java/org/openapitools/client/api/CollectionsApi.java @@ -23,6 +23,7 @@ import com.android.volley.Response; import com.android.volley.VolleyError; +import org.openapitools.client.model.CollectionTemplateType; import org.openapitools.client.model.EntitySetCollection; import org.openapitools.client.model.EntityTypeCollection; import java.util.Map; @@ -63,20 +64,20 @@ public String getBasePath() { * Appends type to template of the specified EntityTypeCollection * * @param entityTypeCollectionId - * @param entityTypeCollection + * @param collectionTemplateType * @return void */ - public void addTypeToEntityTypeCollectionTemplate (UUID entityTypeCollectionId, EntityTypeCollection entityTypeCollection) throws TimeoutException, ExecutionException, InterruptedException, ApiException { - Object postBody = entityTypeCollection; + public void addTypeToEntityTypeCollectionTemplate (UUID entityTypeCollectionId, CollectionTemplateType collectionTemplateType) throws TimeoutException, ExecutionException, InterruptedException, ApiException { + Object postBody = collectionTemplateType; // verify the required parameter 'entityTypeCollectionId' is set if (entityTypeCollectionId == null) { VolleyError error = new VolleyError("Missing the required parameter 'entityTypeCollectionId' when calling addTypeToEntityTypeCollectionTemplate", new ApiException(400, "Missing the required parameter 'entityTypeCollectionId' when calling addTypeToEntityTypeCollectionTemplate")); } - // verify the required parameter 'entityTypeCollection' is set - if (entityTypeCollection == null) { - VolleyError error = new VolleyError("Missing the required parameter 'entityTypeCollection' when calling addTypeToEntityTypeCollectionTemplate", - new ApiException(400, "Missing the required parameter 'entityTypeCollection' when calling addTypeToEntityTypeCollectionTemplate")); + // verify the required parameter 'collectionTemplateType' is set + if (collectionTemplateType == null) { + VolleyError error = new VolleyError("Missing the required parameter 'collectionTemplateType' when calling addTypeToEntityTypeCollectionTemplate", + new ApiException(400, "Missing the required parameter 'collectionTemplateType' when calling addTypeToEntityTypeCollectionTemplate")); } // create path and map variables @@ -131,20 +132,20 @@ public void addTypeToEntityTypeCollectionTemplate (UUID entityTypeCollectionId, /** * Appends type to template of the specified EntityTypeCollection * - * @param entityTypeCollectionId * @param entityTypeCollection + * @param entityTypeCollectionId * @param collectionTemplateType */ - public void addTypeToEntityTypeCollectionTemplate (UUID entityTypeCollectionId, EntityTypeCollection entityTypeCollection, final Response.Listener responseListener, final Response.ErrorListener errorListener) { - Object postBody = entityTypeCollection; + public void addTypeToEntityTypeCollectionTemplate (UUID entityTypeCollectionId, CollectionTemplateType collectionTemplateType, final Response.Listener responseListener, final Response.ErrorListener errorListener) { + Object postBody = collectionTemplateType; // verify the required parameter 'entityTypeCollectionId' is set if (entityTypeCollectionId == null) { VolleyError error = new VolleyError("Missing the required parameter 'entityTypeCollectionId' when calling addTypeToEntityTypeCollectionTemplate", new ApiException(400, "Missing the required parameter 'entityTypeCollectionId' when calling addTypeToEntityTypeCollectionTemplate")); } - // verify the required parameter 'entityTypeCollection' is set - if (entityTypeCollection == null) { - VolleyError error = new VolleyError("Missing the required parameter 'entityTypeCollection' when calling addTypeToEntityTypeCollectionTemplate", - new ApiException(400, "Missing the required parameter 'entityTypeCollection' when calling addTypeToEntityTypeCollectionTemplate")); + // verify the required parameter 'collectionTemplateType' is set + if (collectionTemplateType == null) { + VolleyError error = new VolleyError("Missing the required parameter 'collectionTemplateType' when calling addTypeToEntityTypeCollectionTemplate", + new ApiException(400, "Missing the required parameter 'collectionTemplateType' when calling addTypeToEntityTypeCollectionTemplate")); } // create path and map variables @@ -1070,7 +1071,7 @@ public List getEntitySetCollectionsOfType (UUID entitySetCo } // create path and map variables - String path = "/datastore/collections/entity/type/entity/set/{entitySetCollectionId}".replaceAll("\\{" + "entitySetCollectionId" + "\\}", apiInvoker.escapeString(entitySetCollectionId.toString())); + String path = "/datastore/collections/entity/set/entity/type/{entitySetCollectionId}".replaceAll("\\{" + "entitySetCollectionId" + "\\}", apiInvoker.escapeString(entitySetCollectionId.toString())); // query params List queryParams = new ArrayList(); @@ -1132,7 +1133,7 @@ public void getEntitySetCollectionsOfType (UUID entitySetCollectionId, final Res } // create path and map variables - String path = "/datastore/collections/entity/type/entity/set/{entitySetCollectionId}".replaceAll("\\{format\\}","json").replaceAll("\\{" + "entitySetCollectionId" + "\\}", apiInvoker.escapeString(entitySetCollectionId.toString())); + String path = "/datastore/collections/entity/set/entity/type/{entitySetCollectionId}".replaceAll("\\{format\\}","json").replaceAll("\\{" + "entitySetCollectionId" + "\\}", apiInvoker.escapeString(entitySetCollectionId.toString())); // query params List queryParams = new ArrayList(); diff --git a/android/src/main/java/org/openapitools/client/api/DataApi.java b/android/src/main/java/org/openapitools/client/api/DataApi.java index 48d1ada..4bac22d 100644 --- a/android/src/main/java/org/openapitools/client/api/DataApi.java +++ b/android/src/main/java/org/openapitools/client/api/DataApi.java @@ -1056,7 +1056,7 @@ public void deleteEntity (UUID entitySetId, UUID entityKeyId, String type) throw } // create path and map variables - String path = "/datastore/data/{entitySetId}/{entityKeyId}".replaceAll("\\{" + "entitySetId" + "\\}", apiInvoker.escapeString(entitySetId.toString())).replaceAll("\\{" + "entityKeyId" + "\\}", apiInvoker.escapeString(entityKeyId.toString())); + String path = "/datastore/data/set/{entitySetId}/{entityKeyId}".replaceAll("\\{" + "entitySetId" + "\\}", apiInvoker.escapeString(entitySetId.toString())).replaceAll("\\{" + "entityKeyId" + "\\}", apiInvoker.escapeString(entityKeyId.toString())); // query params List queryParams = new ArrayList(); @@ -1129,7 +1129,7 @@ public void deleteEntity (UUID entitySetId, UUID entityKeyId, String type, final } // create path and map variables - String path = "/datastore/data/{entitySetId}/{entityKeyId}".replaceAll("\\{format\\}","json").replaceAll("\\{" + "entitySetId" + "\\}", apiInvoker.escapeString(entitySetId.toString())).replaceAll("\\{" + "entityKeyId" + "\\}", apiInvoker.escapeString(entityKeyId.toString())); + String path = "/datastore/data/set/{entitySetId}/{entityKeyId}".replaceAll("\\{format\\}","json").replaceAll("\\{" + "entitySetId" + "\\}", apiInvoker.escapeString(entitySetId.toString())).replaceAll("\\{" + "entityKeyId" + "\\}", apiInvoker.escapeString(entityKeyId.toString())); // query params List queryParams = new ArrayList(); diff --git a/android/src/main/java/org/openapitools/client/api/ShuttleApi.java b/android/src/main/java/org/openapitools/client/api/ShuttleApi.java new file mode 100644 index 0000000..d24a82c --- /dev/null +++ b/android/src/main/java/org/openapitools/client/api/ShuttleApi.java @@ -0,0 +1,1089 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.api; + +import org.openapitools.client.ApiInvoker; +import org.openapitools.client.ApiException; +import org.openapitools.client.Pair; + +import org.openapitools.client.model.*; + +import java.util.*; + +import com.android.volley.Response; +import com.android.volley.VolleyError; + +import org.openapitools.client.model.Integration; +import org.openapitools.client.model.IntegrationJob; +import org.openapitools.client.model.IntegrationUpdate; +import java.util.UUID; + +import org.apache.http.HttpEntity; +import org.apache.http.entity.mime.MultipartEntityBuilder; + +import java.util.ArrayList; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.TimeoutException; + +public class ShuttleApi { + String basePath = "https://api.openlattice.com"; + ApiInvoker apiInvoker = ApiInvoker.getInstance(); + + public void addHeader(String key, String value) { + getInvoker().addDefaultHeader(key, value); + } + + public ApiInvoker getInvoker() { + return apiInvoker; + } + + public void setBasePath(String basePath) { + this.basePath = basePath; + } + + public String getBasePath() { + return basePath; + } + + /** + * Creates a new integration definition for running recurring integrations + * + * @param integrationName + * @param integration + * @return UUID + */ + public UUID createIntegrationDefinition (String integrationName, Integration integration) throws TimeoutException, ExecutionException, InterruptedException, ApiException { + Object postBody = integration; + // verify the required parameter 'integrationName' is set + if (integrationName == null) { + VolleyError error = new VolleyError("Missing the required parameter 'integrationName' when calling createIntegrationDefinition", + new ApiException(400, "Missing the required parameter 'integrationName' when calling createIntegrationDefinition")); + } + // verify the required parameter 'integration' is set + if (integration == null) { + VolleyError error = new VolleyError("Missing the required parameter 'integration' when calling createIntegrationDefinition", + new ApiException(400, "Missing the required parameter 'integration' when calling createIntegrationDefinition")); + } + + // create path and map variables + String path = "/shuttle/integration/definition/{integrationName}".replaceAll("\\{" + "integrationName" + "\\}", apiInvoker.escapeString(integrationName.toString())); + + // query params + List queryParams = new ArrayList(); + // header params + Map headerParams = new HashMap(); + // form params + Map formParams = new HashMap(); + String[] contentTypes = { + "application/json" + }; + String contentType = contentTypes.length > 0 ? contentTypes[0] : "application/json"; + + if (contentType.startsWith("multipart/form-data")) { + // file uploading + MultipartEntityBuilder localVarBuilder = MultipartEntityBuilder.create(); + HttpEntity httpEntity = localVarBuilder.build(); + postBody = httpEntity; + } else { + // normal form params + } + + String[] authNames = new String[] { "http_auth", "openlattice_auth" }; + + try { + String localVarResponse = apiInvoker.invokeAPI (basePath, path, "POST", queryParams, postBody, headerParams, formParams, contentType, authNames); + if (localVarResponse != null) { + return (UUID) ApiInvoker.deserialize(localVarResponse, "", UUID.class); + } else { + return null; + } + } catch (ApiException ex) { + throw ex; + } catch (InterruptedException ex) { + throw ex; + } catch (ExecutionException ex) { + if (ex.getCause() instanceof VolleyError) { + VolleyError volleyError = (VolleyError)ex.getCause(); + if (volleyError.networkResponse != null) { + throw new ApiException(volleyError.networkResponse.statusCode, volleyError.getMessage()); + } + } + throw ex; + } catch (TimeoutException ex) { + throw ex; + } + } + + /** + * Creates a new integration definition for running recurring integrations + * + * @param integrationName * @param integration + */ + public void createIntegrationDefinition (String integrationName, Integration integration, final Response.Listener responseListener, final Response.ErrorListener errorListener) { + Object postBody = integration; + + // verify the required parameter 'integrationName' is set + if (integrationName == null) { + VolleyError error = new VolleyError("Missing the required parameter 'integrationName' when calling createIntegrationDefinition", + new ApiException(400, "Missing the required parameter 'integrationName' when calling createIntegrationDefinition")); + } + // verify the required parameter 'integration' is set + if (integration == null) { + VolleyError error = new VolleyError("Missing the required parameter 'integration' when calling createIntegrationDefinition", + new ApiException(400, "Missing the required parameter 'integration' when calling createIntegrationDefinition")); + } + + // create path and map variables + String path = "/shuttle/integration/definition/{integrationName}".replaceAll("\\{format\\}","json").replaceAll("\\{" + "integrationName" + "\\}", apiInvoker.escapeString(integrationName.toString())); + + // query params + List queryParams = new ArrayList(); + // header params + Map headerParams = new HashMap(); + // form params + Map formParams = new HashMap(); + + + + String[] contentTypes = { + "application/json" + }; + String contentType = contentTypes.length > 0 ? contentTypes[0] : "application/json"; + + if (contentType.startsWith("multipart/form-data")) { + // file uploading + MultipartEntityBuilder localVarBuilder = MultipartEntityBuilder.create(); + + + HttpEntity httpEntity = localVarBuilder.build(); + postBody = httpEntity; + } else { + // normal form params + } + + String[] authNames = new String[] { "http_auth", "openlattice_auth" }; + + try { + apiInvoker.invokeAPI(basePath, path, "POST", queryParams, postBody, headerParams, formParams, contentType, authNames, + new Response.Listener() { + @Override + public void onResponse(String localVarResponse) { + try { + responseListener.onResponse((UUID) ApiInvoker.deserialize(localVarResponse, "", UUID.class)); + } catch (ApiException exception) { + errorListener.onErrorResponse(new VolleyError(exception)); + } + } + }, new Response.ErrorListener() { + @Override + public void onErrorResponse(VolleyError error) { + errorListener.onErrorResponse(error); + } + }); + } catch (ApiException ex) { + errorListener.onErrorResponse(new VolleyError(ex)); + } + } + /** + * Replaces any number of fields within an existing integration definition + * + * @param integrationName + * @return void + */ + public void deleteIntegrationDefinition (String integrationName) throws TimeoutException, ExecutionException, InterruptedException, ApiException { + Object postBody = null; + // verify the required parameter 'integrationName' is set + if (integrationName == null) { + VolleyError error = new VolleyError("Missing the required parameter 'integrationName' when calling deleteIntegrationDefinition", + new ApiException(400, "Missing the required parameter 'integrationName' when calling deleteIntegrationDefinition")); + } + + // create path and map variables + String path = "/shuttle/integration/definition/{integrationName}".replaceAll("\\{" + "integrationName" + "\\}", apiInvoker.escapeString(integrationName.toString())); + + // query params + List queryParams = new ArrayList(); + // header params + Map headerParams = new HashMap(); + // form params + Map formParams = new HashMap(); + String[] contentTypes = { + }; + String contentType = contentTypes.length > 0 ? contentTypes[0] : "application/json"; + + if (contentType.startsWith("multipart/form-data")) { + // file uploading + MultipartEntityBuilder localVarBuilder = MultipartEntityBuilder.create(); + HttpEntity httpEntity = localVarBuilder.build(); + postBody = httpEntity; + } else { + // normal form params + } + + String[] authNames = new String[] { "http_auth", "openlattice_auth" }; + + try { + String localVarResponse = apiInvoker.invokeAPI (basePath, path, "DELETE", queryParams, postBody, headerParams, formParams, contentType, authNames); + if (localVarResponse != null) { + return ; + } else { + return ; + } + } catch (ApiException ex) { + throw ex; + } catch (InterruptedException ex) { + throw ex; + } catch (ExecutionException ex) { + if (ex.getCause() instanceof VolleyError) { + VolleyError volleyError = (VolleyError)ex.getCause(); + if (volleyError.networkResponse != null) { + throw new ApiException(volleyError.networkResponse.statusCode, volleyError.getMessage()); + } + } + throw ex; + } catch (TimeoutException ex) { + throw ex; + } + } + + /** + * Replaces any number of fields within an existing integration definition + * + * @param integrationName + */ + public void deleteIntegrationDefinition (String integrationName, final Response.Listener responseListener, final Response.ErrorListener errorListener) { + Object postBody = null; + + // verify the required parameter 'integrationName' is set + if (integrationName == null) { + VolleyError error = new VolleyError("Missing the required parameter 'integrationName' when calling deleteIntegrationDefinition", + new ApiException(400, "Missing the required parameter 'integrationName' when calling deleteIntegrationDefinition")); + } + + // create path and map variables + String path = "/shuttle/integration/definition/{integrationName}".replaceAll("\\{format\\}","json").replaceAll("\\{" + "integrationName" + "\\}", apiInvoker.escapeString(integrationName.toString())); + + // query params + List queryParams = new ArrayList(); + // header params + Map headerParams = new HashMap(); + // form params + Map formParams = new HashMap(); + + + + String[] contentTypes = { + + }; + String contentType = contentTypes.length > 0 ? contentTypes[0] : "application/json"; + + if (contentType.startsWith("multipart/form-data")) { + // file uploading + MultipartEntityBuilder localVarBuilder = MultipartEntityBuilder.create(); + + + HttpEntity httpEntity = localVarBuilder.build(); + postBody = httpEntity; + } else { + // normal form params + } + + String[] authNames = new String[] { "http_auth", "openlattice_auth" }; + + try { + apiInvoker.invokeAPI(basePath, path, "DELETE", queryParams, postBody, headerParams, formParams, contentType, authNames, + new Response.Listener() { + @Override + public void onResponse(String localVarResponse) { + responseListener.onResponse(localVarResponse); + } + }, new Response.ErrorListener() { + @Override + public void onErrorResponse(VolleyError error) { + errorListener.onErrorResponse(error); + } + }); + } catch (ApiException ex) { + errorListener.onErrorResponse(new VolleyError(ex)); + } + } + /** + * Deletes an integration job status from the integrationJobs map + * + * @param jobId the unique id of the integration job + * @return void + */ + public void deleteIntegrationJobStatus (UUID jobId) throws TimeoutException, ExecutionException, InterruptedException, ApiException { + Object postBody = null; + // verify the required parameter 'jobId' is set + if (jobId == null) { + VolleyError error = new VolleyError("Missing the required parameter 'jobId' when calling deleteIntegrationJobStatus", + new ApiException(400, "Missing the required parameter 'jobId' when calling deleteIntegrationJobStatus")); + } + + // create path and map variables + String path = "/shuttle/integration/status/{jobId}".replaceAll("\\{" + "jobId" + "\\}", apiInvoker.escapeString(jobId.toString())); + + // query params + List queryParams = new ArrayList(); + // header params + Map headerParams = new HashMap(); + // form params + Map formParams = new HashMap(); + String[] contentTypes = { + }; + String contentType = contentTypes.length > 0 ? contentTypes[0] : "application/json"; + + if (contentType.startsWith("multipart/form-data")) { + // file uploading + MultipartEntityBuilder localVarBuilder = MultipartEntityBuilder.create(); + HttpEntity httpEntity = localVarBuilder.build(); + postBody = httpEntity; + } else { + // normal form params + } + + String[] authNames = new String[] { "http_auth", "openlattice_auth" }; + + try { + String localVarResponse = apiInvoker.invokeAPI (basePath, path, "DELETE", queryParams, postBody, headerParams, formParams, contentType, authNames); + if (localVarResponse != null) { + return ; + } else { + return ; + } + } catch (ApiException ex) { + throw ex; + } catch (InterruptedException ex) { + throw ex; + } catch (ExecutionException ex) { + if (ex.getCause() instanceof VolleyError) { + VolleyError volleyError = (VolleyError)ex.getCause(); + if (volleyError.networkResponse != null) { + throw new ApiException(volleyError.networkResponse.statusCode, volleyError.getMessage()); + } + } + throw ex; + } catch (TimeoutException ex) { + throw ex; + } + } + + /** + * Deletes an integration job status from the integrationJobs map + * + * @param jobId the unique id of the integration job + */ + public void deleteIntegrationJobStatus (UUID jobId, final Response.Listener responseListener, final Response.ErrorListener errorListener) { + Object postBody = null; + + // verify the required parameter 'jobId' is set + if (jobId == null) { + VolleyError error = new VolleyError("Missing the required parameter 'jobId' when calling deleteIntegrationJobStatus", + new ApiException(400, "Missing the required parameter 'jobId' when calling deleteIntegrationJobStatus")); + } + + // create path and map variables + String path = "/shuttle/integration/status/{jobId}".replaceAll("\\{format\\}","json").replaceAll("\\{" + "jobId" + "\\}", apiInvoker.escapeString(jobId.toString())); + + // query params + List queryParams = new ArrayList(); + // header params + Map headerParams = new HashMap(); + // form params + Map formParams = new HashMap(); + + + + String[] contentTypes = { + + }; + String contentType = contentTypes.length > 0 ? contentTypes[0] : "application/json"; + + if (contentType.startsWith("multipart/form-data")) { + // file uploading + MultipartEntityBuilder localVarBuilder = MultipartEntityBuilder.create(); + + + HttpEntity httpEntity = localVarBuilder.build(); + postBody = httpEntity; + } else { + // normal form params + } + + String[] authNames = new String[] { "http_auth", "openlattice_auth" }; + + try { + apiInvoker.invokeAPI(basePath, path, "DELETE", queryParams, postBody, headerParams, formParams, contentType, authNames, + new Response.Listener() { + @Override + public void onResponse(String localVarResponse) { + responseListener.onResponse(localVarResponse); + } + }, new Response.ErrorListener() { + @Override + public void onErrorResponse(VolleyError error) { + errorListener.onErrorResponse(error); + } + }); + } catch (ApiException ex) { + errorListener.onErrorResponse(new VolleyError(ex)); + } + } + /** + * Enqueues an integration on Shuttle Server for a given integration + * + * @param integrationName the name of the integration to be run + * @param integrationKey the unique id used to authenticate an integration run + * @return UUID + */ + public UUID enqueueIntegration (String integrationName, UUID integrationKey) throws TimeoutException, ExecutionException, InterruptedException, ApiException { + Object postBody = null; + // verify the required parameter 'integrationName' is set + if (integrationName == null) { + VolleyError error = new VolleyError("Missing the required parameter 'integrationName' when calling enqueueIntegration", + new ApiException(400, "Missing the required parameter 'integrationName' when calling enqueueIntegration")); + } + // verify the required parameter 'integrationKey' is set + if (integrationKey == null) { + VolleyError error = new VolleyError("Missing the required parameter 'integrationKey' when calling enqueueIntegration", + new ApiException(400, "Missing the required parameter 'integrationKey' when calling enqueueIntegration")); + } + + // create path and map variables + String path = "/shuttle/integration/{integrationName}/{integrationKey}".replaceAll("\\{" + "integrationName" + "\\}", apiInvoker.escapeString(integrationName.toString())).replaceAll("\\{" + "integrationKey" + "\\}", apiInvoker.escapeString(integrationKey.toString())); + + // query params + List queryParams = new ArrayList(); + // header params + Map headerParams = new HashMap(); + // form params + Map formParams = new HashMap(); + String[] contentTypes = { + }; + String contentType = contentTypes.length > 0 ? contentTypes[0] : "application/json"; + + if (contentType.startsWith("multipart/form-data")) { + // file uploading + MultipartEntityBuilder localVarBuilder = MultipartEntityBuilder.create(); + HttpEntity httpEntity = localVarBuilder.build(); + postBody = httpEntity; + } else { + // normal form params + } + + String[] authNames = new String[] { "http_auth", "openlattice_auth" }; + + try { + String localVarResponse = apiInvoker.invokeAPI (basePath, path, "GET", queryParams, postBody, headerParams, formParams, contentType, authNames); + if (localVarResponse != null) { + return (UUID) ApiInvoker.deserialize(localVarResponse, "", UUID.class); + } else { + return null; + } + } catch (ApiException ex) { + throw ex; + } catch (InterruptedException ex) { + throw ex; + } catch (ExecutionException ex) { + if (ex.getCause() instanceof VolleyError) { + VolleyError volleyError = (VolleyError)ex.getCause(); + if (volleyError.networkResponse != null) { + throw new ApiException(volleyError.networkResponse.statusCode, volleyError.getMessage()); + } + } + throw ex; + } catch (TimeoutException ex) { + throw ex; + } + } + + /** + * Enqueues an integration on Shuttle Server for a given integration + * + * @param integrationName the name of the integration to be run * @param integrationKey the unique id used to authenticate an integration run + */ + public void enqueueIntegration (String integrationName, UUID integrationKey, final Response.Listener responseListener, final Response.ErrorListener errorListener) { + Object postBody = null; + + // verify the required parameter 'integrationName' is set + if (integrationName == null) { + VolleyError error = new VolleyError("Missing the required parameter 'integrationName' when calling enqueueIntegration", + new ApiException(400, "Missing the required parameter 'integrationName' when calling enqueueIntegration")); + } + // verify the required parameter 'integrationKey' is set + if (integrationKey == null) { + VolleyError error = new VolleyError("Missing the required parameter 'integrationKey' when calling enqueueIntegration", + new ApiException(400, "Missing the required parameter 'integrationKey' when calling enqueueIntegration")); + } + + // create path and map variables + String path = "/shuttle/integration/{integrationName}/{integrationKey}".replaceAll("\\{format\\}","json").replaceAll("\\{" + "integrationName" + "\\}", apiInvoker.escapeString(integrationName.toString())).replaceAll("\\{" + "integrationKey" + "\\}", apiInvoker.escapeString(integrationKey.toString())); + + // query params + List queryParams = new ArrayList(); + // header params + Map headerParams = new HashMap(); + // form params + Map formParams = new HashMap(); + + + + String[] contentTypes = { + + }; + String contentType = contentTypes.length > 0 ? contentTypes[0] : "application/json"; + + if (contentType.startsWith("multipart/form-data")) { + // file uploading + MultipartEntityBuilder localVarBuilder = MultipartEntityBuilder.create(); + + + HttpEntity httpEntity = localVarBuilder.build(); + postBody = httpEntity; + } else { + // normal form params + } + + String[] authNames = new String[] { "http_auth", "openlattice_auth" }; + + try { + apiInvoker.invokeAPI(basePath, path, "GET", queryParams, postBody, headerParams, formParams, contentType, authNames, + new Response.Listener() { + @Override + public void onResponse(String localVarResponse) { + try { + responseListener.onResponse((UUID) ApiInvoker.deserialize(localVarResponse, "", UUID.class)); + } catch (ApiException exception) { + errorListener.onErrorResponse(new VolleyError(exception)); + } + } + }, new Response.ErrorListener() { + @Override + public void onErrorResponse(VolleyError error) { + errorListener.onErrorResponse(error); + } + }); + } catch (ApiException ex) { + errorListener.onErrorResponse(new VolleyError(ex)); + } + } + /** + * Polls the statuses of all running integrations + * + * @return Map + */ + public Map pollAllIntegrations () throws TimeoutException, ExecutionException, InterruptedException, ApiException { + Object postBody = null; + + // create path and map variables + String path = "/shuttle/integration/status"; + + // query params + List queryParams = new ArrayList(); + // header params + Map headerParams = new HashMap(); + // form params + Map formParams = new HashMap(); + String[] contentTypes = { + }; + String contentType = contentTypes.length > 0 ? contentTypes[0] : "application/json"; + + if (contentType.startsWith("multipart/form-data")) { + // file uploading + MultipartEntityBuilder localVarBuilder = MultipartEntityBuilder.create(); + HttpEntity httpEntity = localVarBuilder.build(); + postBody = httpEntity; + } else { + // normal form params + } + + String[] authNames = new String[] { "http_auth", "openlattice_auth" }; + + try { + String localVarResponse = apiInvoker.invokeAPI (basePath, path, "GET", queryParams, postBody, headerParams, formParams, contentType, authNames); + if (localVarResponse != null) { + return (Map) ApiInvoker.deserialize(localVarResponse, "map", IntegrationJob.class); + } else { + return null; + } + } catch (ApiException ex) { + throw ex; + } catch (InterruptedException ex) { + throw ex; + } catch (ExecutionException ex) { + if (ex.getCause() instanceof VolleyError) { + VolleyError volleyError = (VolleyError)ex.getCause(); + if (volleyError.networkResponse != null) { + throw new ApiException(volleyError.networkResponse.statusCode, volleyError.getMessage()); + } + } + throw ex; + } catch (TimeoutException ex) { + throw ex; + } + } + + /** + * Polls the statuses of all running integrations + * + + */ + public void pollAllIntegrations (final Response.Listener> responseListener, final Response.ErrorListener errorListener) { + Object postBody = null; + + + // create path and map variables + String path = "/shuttle/integration/status".replaceAll("\\{format\\}","json"); + + // query params + List queryParams = new ArrayList(); + // header params + Map headerParams = new HashMap(); + // form params + Map formParams = new HashMap(); + + + + String[] contentTypes = { + + }; + String contentType = contentTypes.length > 0 ? contentTypes[0] : "application/json"; + + if (contentType.startsWith("multipart/form-data")) { + // file uploading + MultipartEntityBuilder localVarBuilder = MultipartEntityBuilder.create(); + + + HttpEntity httpEntity = localVarBuilder.build(); + postBody = httpEntity; + } else { + // normal form params + } + + String[] authNames = new String[] { "http_auth", "openlattice_auth" }; + + try { + apiInvoker.invokeAPI(basePath, path, "GET", queryParams, postBody, headerParams, formParams, contentType, authNames, + new Response.Listener() { + @Override + public void onResponse(String localVarResponse) { + try { + responseListener.onResponse((Map) ApiInvoker.deserialize(localVarResponse, "map", IntegrationJob.class)); + } catch (ApiException exception) { + errorListener.onErrorResponse(new VolleyError(exception)); + } + } + }, new Response.ErrorListener() { + @Override + public void onErrorResponse(VolleyError error) { + errorListener.onErrorResponse(error); + } + }); + } catch (ApiException ex) { + errorListener.onErrorResponse(new VolleyError(ex)); + } + } + /** + * Polls the status of an integration + * + * @param jobId the unique id of the integration job + * @return String + */ + public String pollIntegration (UUID jobId) throws TimeoutException, ExecutionException, InterruptedException, ApiException { + Object postBody = null; + // verify the required parameter 'jobId' is set + if (jobId == null) { + VolleyError error = new VolleyError("Missing the required parameter 'jobId' when calling pollIntegration", + new ApiException(400, "Missing the required parameter 'jobId' when calling pollIntegration")); + } + + // create path and map variables + String path = "/shuttle/integration/status/{jobId}".replaceAll("\\{" + "jobId" + "\\}", apiInvoker.escapeString(jobId.toString())); + + // query params + List queryParams = new ArrayList(); + // header params + Map headerParams = new HashMap(); + // form params + Map formParams = new HashMap(); + String[] contentTypes = { + }; + String contentType = contentTypes.length > 0 ? contentTypes[0] : "application/json"; + + if (contentType.startsWith("multipart/form-data")) { + // file uploading + MultipartEntityBuilder localVarBuilder = MultipartEntityBuilder.create(); + HttpEntity httpEntity = localVarBuilder.build(); + postBody = httpEntity; + } else { + // normal form params + } + + String[] authNames = new String[] { "http_auth", "openlattice_auth" }; + + try { + String localVarResponse = apiInvoker.invokeAPI (basePath, path, "GET", queryParams, postBody, headerParams, formParams, contentType, authNames); + if (localVarResponse != null) { + return (String) ApiInvoker.deserialize(localVarResponse, "", String.class); + } else { + return null; + } + } catch (ApiException ex) { + throw ex; + } catch (InterruptedException ex) { + throw ex; + } catch (ExecutionException ex) { + if (ex.getCause() instanceof VolleyError) { + VolleyError volleyError = (VolleyError)ex.getCause(); + if (volleyError.networkResponse != null) { + throw new ApiException(volleyError.networkResponse.statusCode, volleyError.getMessage()); + } + } + throw ex; + } catch (TimeoutException ex) { + throw ex; + } + } + + /** + * Polls the status of an integration + * + * @param jobId the unique id of the integration job + */ + public void pollIntegration (UUID jobId, final Response.Listener responseListener, final Response.ErrorListener errorListener) { + Object postBody = null; + + // verify the required parameter 'jobId' is set + if (jobId == null) { + VolleyError error = new VolleyError("Missing the required parameter 'jobId' when calling pollIntegration", + new ApiException(400, "Missing the required parameter 'jobId' when calling pollIntegration")); + } + + // create path and map variables + String path = "/shuttle/integration/status/{jobId}".replaceAll("\\{format\\}","json").replaceAll("\\{" + "jobId" + "\\}", apiInvoker.escapeString(jobId.toString())); + + // query params + List queryParams = new ArrayList(); + // header params + Map headerParams = new HashMap(); + // form params + Map formParams = new HashMap(); + + + + String[] contentTypes = { + + }; + String contentType = contentTypes.length > 0 ? contentTypes[0] : "application/json"; + + if (contentType.startsWith("multipart/form-data")) { + // file uploading + MultipartEntityBuilder localVarBuilder = MultipartEntityBuilder.create(); + + + HttpEntity httpEntity = localVarBuilder.build(); + postBody = httpEntity; + } else { + // normal form params + } + + String[] authNames = new String[] { "http_auth", "openlattice_auth" }; + + try { + apiInvoker.invokeAPI(basePath, path, "GET", queryParams, postBody, headerParams, formParams, contentType, authNames, + new Response.Listener() { + @Override + public void onResponse(String localVarResponse) { + try { + responseListener.onResponse((String) ApiInvoker.deserialize(localVarResponse, "", String.class)); + } catch (ApiException exception) { + errorListener.onErrorResponse(new VolleyError(exception)); + } + } + }, new Response.ErrorListener() { + @Override + public void onErrorResponse(VolleyError error) { + errorListener.onErrorResponse(error); + } + }); + } catch (ApiException ex) { + errorListener.onErrorResponse(new VolleyError(ex)); + } + } + /** + * Gets an existing integration definition + * + * @param integrationName + * @return Integration + */ + public Integration readIntegrationDefinition (String integrationName) throws TimeoutException, ExecutionException, InterruptedException, ApiException { + Object postBody = null; + // verify the required parameter 'integrationName' is set + if (integrationName == null) { + VolleyError error = new VolleyError("Missing the required parameter 'integrationName' when calling readIntegrationDefinition", + new ApiException(400, "Missing the required parameter 'integrationName' when calling readIntegrationDefinition")); + } + + // create path and map variables + String path = "/shuttle/integration/definition/{integrationName}".replaceAll("\\{" + "integrationName" + "\\}", apiInvoker.escapeString(integrationName.toString())); + + // query params + List queryParams = new ArrayList(); + // header params + Map headerParams = new HashMap(); + // form params + Map formParams = new HashMap(); + String[] contentTypes = { + }; + String contentType = contentTypes.length > 0 ? contentTypes[0] : "application/json"; + + if (contentType.startsWith("multipart/form-data")) { + // file uploading + MultipartEntityBuilder localVarBuilder = MultipartEntityBuilder.create(); + HttpEntity httpEntity = localVarBuilder.build(); + postBody = httpEntity; + } else { + // normal form params + } + + String[] authNames = new String[] { "http_auth", "openlattice_auth" }; + + try { + String localVarResponse = apiInvoker.invokeAPI (basePath, path, "GET", queryParams, postBody, headerParams, formParams, contentType, authNames); + if (localVarResponse != null) { + return (Integration) ApiInvoker.deserialize(localVarResponse, "", Integration.class); + } else { + return null; + } + } catch (ApiException ex) { + throw ex; + } catch (InterruptedException ex) { + throw ex; + } catch (ExecutionException ex) { + if (ex.getCause() instanceof VolleyError) { + VolleyError volleyError = (VolleyError)ex.getCause(); + if (volleyError.networkResponse != null) { + throw new ApiException(volleyError.networkResponse.statusCode, volleyError.getMessage()); + } + } + throw ex; + } catch (TimeoutException ex) { + throw ex; + } + } + + /** + * Gets an existing integration definition + * + * @param integrationName + */ + public void readIntegrationDefinition (String integrationName, final Response.Listener responseListener, final Response.ErrorListener errorListener) { + Object postBody = null; + + // verify the required parameter 'integrationName' is set + if (integrationName == null) { + VolleyError error = new VolleyError("Missing the required parameter 'integrationName' when calling readIntegrationDefinition", + new ApiException(400, "Missing the required parameter 'integrationName' when calling readIntegrationDefinition")); + } + + // create path and map variables + String path = "/shuttle/integration/definition/{integrationName}".replaceAll("\\{format\\}","json").replaceAll("\\{" + "integrationName" + "\\}", apiInvoker.escapeString(integrationName.toString())); + + // query params + List queryParams = new ArrayList(); + // header params + Map headerParams = new HashMap(); + // form params + Map formParams = new HashMap(); + + + + String[] contentTypes = { + + }; + String contentType = contentTypes.length > 0 ? contentTypes[0] : "application/json"; + + if (contentType.startsWith("multipart/form-data")) { + // file uploading + MultipartEntityBuilder localVarBuilder = MultipartEntityBuilder.create(); + + + HttpEntity httpEntity = localVarBuilder.build(); + postBody = httpEntity; + } else { + // normal form params + } + + String[] authNames = new String[] { "http_auth", "openlattice_auth" }; + + try { + apiInvoker.invokeAPI(basePath, path, "GET", queryParams, postBody, headerParams, formParams, contentType, authNames, + new Response.Listener() { + @Override + public void onResponse(String localVarResponse) { + try { + responseListener.onResponse((Integration) ApiInvoker.deserialize(localVarResponse, "", Integration.class)); + } catch (ApiException exception) { + errorListener.onErrorResponse(new VolleyError(exception)); + } + } + }, new Response.ErrorListener() { + @Override + public void onErrorResponse(VolleyError error) { + errorListener.onErrorResponse(error); + } + }); + } catch (ApiException ex) { + errorListener.onErrorResponse(new VolleyError(ex)); + } + } + /** + * Replaces any number of fields within an existing integration definition + * + * @param integrationName + * @param integrationUpdate + * @return void + */ + public void updateIntegrationDefinition (String integrationName, IntegrationUpdate integrationUpdate) throws TimeoutException, ExecutionException, InterruptedException, ApiException { + Object postBody = integrationUpdate; + // verify the required parameter 'integrationName' is set + if (integrationName == null) { + VolleyError error = new VolleyError("Missing the required parameter 'integrationName' when calling updateIntegrationDefinition", + new ApiException(400, "Missing the required parameter 'integrationName' when calling updateIntegrationDefinition")); + } + // verify the required parameter 'integrationUpdate' is set + if (integrationUpdate == null) { + VolleyError error = new VolleyError("Missing the required parameter 'integrationUpdate' when calling updateIntegrationDefinition", + new ApiException(400, "Missing the required parameter 'integrationUpdate' when calling updateIntegrationDefinition")); + } + + // create path and map variables + String path = "/shuttle/integration/definition/{integrationName}".replaceAll("\\{" + "integrationName" + "\\}", apiInvoker.escapeString(integrationName.toString())); + + // query params + List queryParams = new ArrayList(); + // header params + Map headerParams = new HashMap(); + // form params + Map formParams = new HashMap(); + String[] contentTypes = { + "application/json" + }; + String contentType = contentTypes.length > 0 ? contentTypes[0] : "application/json"; + + if (contentType.startsWith("multipart/form-data")) { + // file uploading + MultipartEntityBuilder localVarBuilder = MultipartEntityBuilder.create(); + HttpEntity httpEntity = localVarBuilder.build(); + postBody = httpEntity; + } else { + // normal form params + } + + String[] authNames = new String[] { "http_auth", "openlattice_auth" }; + + try { + String localVarResponse = apiInvoker.invokeAPI (basePath, path, "PATCH", queryParams, postBody, headerParams, formParams, contentType, authNames); + if (localVarResponse != null) { + return ; + } else { + return ; + } + } catch (ApiException ex) { + throw ex; + } catch (InterruptedException ex) { + throw ex; + } catch (ExecutionException ex) { + if (ex.getCause() instanceof VolleyError) { + VolleyError volleyError = (VolleyError)ex.getCause(); + if (volleyError.networkResponse != null) { + throw new ApiException(volleyError.networkResponse.statusCode, volleyError.getMessage()); + } + } + throw ex; + } catch (TimeoutException ex) { + throw ex; + } + } + + /** + * Replaces any number of fields within an existing integration definition + * + * @param integrationName * @param integrationUpdate + */ + public void updateIntegrationDefinition (String integrationName, IntegrationUpdate integrationUpdate, final Response.Listener responseListener, final Response.ErrorListener errorListener) { + Object postBody = integrationUpdate; + + // verify the required parameter 'integrationName' is set + if (integrationName == null) { + VolleyError error = new VolleyError("Missing the required parameter 'integrationName' when calling updateIntegrationDefinition", + new ApiException(400, "Missing the required parameter 'integrationName' when calling updateIntegrationDefinition")); + } + // verify the required parameter 'integrationUpdate' is set + if (integrationUpdate == null) { + VolleyError error = new VolleyError("Missing the required parameter 'integrationUpdate' when calling updateIntegrationDefinition", + new ApiException(400, "Missing the required parameter 'integrationUpdate' when calling updateIntegrationDefinition")); + } + + // create path and map variables + String path = "/shuttle/integration/definition/{integrationName}".replaceAll("\\{format\\}","json").replaceAll("\\{" + "integrationName" + "\\}", apiInvoker.escapeString(integrationName.toString())); + + // query params + List queryParams = new ArrayList(); + // header params + Map headerParams = new HashMap(); + // form params + Map formParams = new HashMap(); + + + + String[] contentTypes = { + "application/json" + }; + String contentType = contentTypes.length > 0 ? contentTypes[0] : "application/json"; + + if (contentType.startsWith("multipart/form-data")) { + // file uploading + MultipartEntityBuilder localVarBuilder = MultipartEntityBuilder.create(); + + + HttpEntity httpEntity = localVarBuilder.build(); + postBody = httpEntity; + } else { + // normal form params + } + + String[] authNames = new String[] { "http_auth", "openlattice_auth" }; + + try { + apiInvoker.invokeAPI(basePath, path, "PATCH", queryParams, postBody, headerParams, formParams, contentType, authNames, + new Response.Listener() { + @Override + public void onResponse(String localVarResponse) { + responseListener.onResponse(localVarResponse); + } + }, new Response.ErrorListener() { + @Override + public void onErrorResponse(VolleyError error) { + errorListener.onErrorResponse(error); + } + }); + } catch (ApiException ex) { + errorListener.onErrorResponse(new VolleyError(ex)); + } + } +} diff --git a/android/src/main/java/org/openapitools/client/model/AssociationDefinition.java b/android/src/main/java/org/openapitools/client/model/AssociationDefinition.java new file mode 100644 index 0000000..07d8ae4 --- /dev/null +++ b/android/src/main/java/org/openapitools/client/model/AssociationDefinition.java @@ -0,0 +1,145 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.model; + +import java.util.*; +import java.util.Map; +import org.openapitools.client.model.FullQualifiedName; +import org.openapitools.client.model.PropertyDefinition; +import io.swagger.annotations.*; +import com.google.gson.annotations.SerializedName; + +@ApiModel(description = "") +public class AssociationDefinition { + + @SerializedName("fqn") + private FullQualifiedName fqn = null; + @SerializedName("entitySetName") + private String entitySetName = null; + @SerializedName("propertyDefinitions") + private Map propertyDefinitions = null; + public enum UpdateTypeEnum { + Replace, PartialReplace, Merge, + }; + @SerializedName("updateType") + private UpdateTypeEnum updateType = null; + @SerializedName("src") + private String src = null; + @SerializedName("dst") + private String dst = null; + + /** + **/ + @ApiModelProperty(value = "") + public FullQualifiedName getFqn() { + return fqn; + } + public void setFqn(FullQualifiedName fqn) { + this.fqn = fqn; + } + + /** + **/ + @ApiModelProperty(value = "") + public String getEntitySetName() { + return entitySetName; + } + public void setEntitySetName(String entitySetName) { + this.entitySetName = entitySetName; + } + + /** + **/ + @ApiModelProperty(value = "") + public Map getPropertyDefinitions() { + return propertyDefinitions; + } + public void setPropertyDefinitions(Map propertyDefinitions) { + this.propertyDefinitions = propertyDefinitions; + } + + /** + **/ + @ApiModelProperty(value = "") + public UpdateTypeEnum getUpdateType() { + return updateType; + } + public void setUpdateType(UpdateTypeEnum updateType) { + this.updateType = updateType; + } + + /** + **/ + @ApiModelProperty(value = "") + public String getSrc() { + return src; + } + public void setSrc(String src) { + this.src = src; + } + + /** + **/ + @ApiModelProperty(value = "") + public String getDst() { + return dst; + } + public void setDst(String dst) { + this.dst = dst; + } + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + AssociationDefinition associationDefinition = (AssociationDefinition) o; + return (this.fqn == null ? associationDefinition.fqn == null : this.fqn.equals(associationDefinition.fqn)) && + (this.entitySetName == null ? associationDefinition.entitySetName == null : this.entitySetName.equals(associationDefinition.entitySetName)) && + (this.propertyDefinitions == null ? associationDefinition.propertyDefinitions == null : this.propertyDefinitions.equals(associationDefinition.propertyDefinitions)) && + (this.updateType == null ? associationDefinition.updateType == null : this.updateType.equals(associationDefinition.updateType)) && + (this.src == null ? associationDefinition.src == null : this.src.equals(associationDefinition.src)) && + (this.dst == null ? associationDefinition.dst == null : this.dst.equals(associationDefinition.dst)); + } + + @Override + public int hashCode() { + int result = 17; + result = 31 * result + (this.fqn == null ? 0: this.fqn.hashCode()); + result = 31 * result + (this.entitySetName == null ? 0: this.entitySetName.hashCode()); + result = 31 * result + (this.propertyDefinitions == null ? 0: this.propertyDefinitions.hashCode()); + result = 31 * result + (this.updateType == null ? 0: this.updateType.hashCode()); + result = 31 * result + (this.src == null ? 0: this.src.hashCode()); + result = 31 * result + (this.dst == null ? 0: this.dst.hashCode()); + return result; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class AssociationDefinition {\n"); + + sb.append(" fqn: ").append(fqn).append("\n"); + sb.append(" entitySetName: ").append(entitySetName).append("\n"); + sb.append(" propertyDefinitions: ").append(propertyDefinitions).append("\n"); + sb.append(" updateType: ").append(updateType).append("\n"); + sb.append(" src: ").append(src).append("\n"); + sb.append(" dst: ").append(dst).append("\n"); + sb.append("}\n"); + return sb.toString(); + } +} diff --git a/android/src/main/java/org/openapitools/client/model/DataAssociation.java b/android/src/main/java/org/openapitools/client/model/DataAssociation.java index 8291950..181dfe3 100644 --- a/android/src/main/java/org/openapitools/client/model/DataAssociation.java +++ b/android/src/main/java/org/openapitools/client/model/DataAssociation.java @@ -12,6 +12,8 @@ package org.openapitools.client.model; +import java.util.*; +import java.util.Map; import java.util.UUID; import io.swagger.annotations.*; import com.google.gson.annotations.SerializedName; @@ -25,6 +27,14 @@ public class DataAssociation { private UUID srcEntityIndex = null; @SerializedName("srcEntityKeyId") private UUID srcEntityKeyId = null; + @SerializedName("dstEntitySetId") + private UUID dstEntitySetId = null; + @SerializedName("dstEntityIndex") + private UUID dstEntityIndex = null; + @SerializedName("dstEntityKeyId") + private UUID dstEntityKeyId = null; + @SerializedName("data") + private Map> data = null; /** * the ID of the source entity set @@ -59,6 +69,50 @@ public void setSrcEntityKeyId(UUID srcEntityKeyId) { this.srcEntityKeyId = srcEntityKeyId; } + /** + * the ID of the dst entity set + **/ + @ApiModelProperty(value = "the ID of the dst entity set") + public UUID getDstEntitySetId() { + return dstEntitySetId; + } + public void setDstEntitySetId(UUID dstEntitySetId) { + this.dstEntitySetId = dstEntitySetId; + } + + /** + * The index of an entity + **/ + @ApiModelProperty(value = "The index of an entity") + public UUID getDstEntityIndex() { + return dstEntityIndex; + } + public void setDstEntityIndex(UUID dstEntityIndex) { + this.dstEntityIndex = dstEntityIndex; + } + + /** + * An existing entityKeyId + **/ + @ApiModelProperty(value = "An existing entityKeyId") + public UUID getDstEntityKeyId() { + return dstEntityKeyId; + } + public void setDstEntityKeyId(UUID dstEntityKeyId) { + this.dstEntityKeyId = dstEntityKeyId; + } + + /** + * data + **/ + @ApiModelProperty(value = "data") + public Map> getData() { + return data; + } + public void setData(Map> data) { + this.data = data; + } + @Override public boolean equals(Object o) { @@ -71,7 +125,11 @@ public boolean equals(Object o) { DataAssociation dataAssociation = (DataAssociation) o; return (this.srcEntitySetId == null ? dataAssociation.srcEntitySetId == null : this.srcEntitySetId.equals(dataAssociation.srcEntitySetId)) && (this.srcEntityIndex == null ? dataAssociation.srcEntityIndex == null : this.srcEntityIndex.equals(dataAssociation.srcEntityIndex)) && - (this.srcEntityKeyId == null ? dataAssociation.srcEntityKeyId == null : this.srcEntityKeyId.equals(dataAssociation.srcEntityKeyId)); + (this.srcEntityKeyId == null ? dataAssociation.srcEntityKeyId == null : this.srcEntityKeyId.equals(dataAssociation.srcEntityKeyId)) && + (this.dstEntitySetId == null ? dataAssociation.dstEntitySetId == null : this.dstEntitySetId.equals(dataAssociation.dstEntitySetId)) && + (this.dstEntityIndex == null ? dataAssociation.dstEntityIndex == null : this.dstEntityIndex.equals(dataAssociation.dstEntityIndex)) && + (this.dstEntityKeyId == null ? dataAssociation.dstEntityKeyId == null : this.dstEntityKeyId.equals(dataAssociation.dstEntityKeyId)) && + (this.data == null ? dataAssociation.data == null : this.data.equals(dataAssociation.data)); } @Override @@ -80,6 +138,10 @@ public int hashCode() { result = 31 * result + (this.srcEntitySetId == null ? 0: this.srcEntitySetId.hashCode()); result = 31 * result + (this.srcEntityIndex == null ? 0: this.srcEntityIndex.hashCode()); result = 31 * result + (this.srcEntityKeyId == null ? 0: this.srcEntityKeyId.hashCode()); + result = 31 * result + (this.dstEntitySetId == null ? 0: this.dstEntitySetId.hashCode()); + result = 31 * result + (this.dstEntityIndex == null ? 0: this.dstEntityIndex.hashCode()); + result = 31 * result + (this.dstEntityKeyId == null ? 0: this.dstEntityKeyId.hashCode()); + result = 31 * result + (this.data == null ? 0: this.data.hashCode()); return result; } @@ -91,6 +153,10 @@ public String toString() { sb.append(" srcEntitySetId: ").append(srcEntitySetId).append("\n"); sb.append(" srcEntityIndex: ").append(srcEntityIndex).append("\n"); sb.append(" srcEntityKeyId: ").append(srcEntityKeyId).append("\n"); + sb.append(" dstEntitySetId: ").append(dstEntitySetId).append("\n"); + sb.append(" dstEntityIndex: ").append(dstEntityIndex).append("\n"); + sb.append(" dstEntityKeyId: ").append(dstEntityKeyId).append("\n"); + sb.append(" data: ").append(data).append("\n"); sb.append("}\n"); return sb.toString(); } diff --git a/android/src/main/java/org/openapitools/client/model/EntityDefinition.java b/android/src/main/java/org/openapitools/client/model/EntityDefinition.java new file mode 100644 index 0000000..1b41150 --- /dev/null +++ b/android/src/main/java/org/openapitools/client/model/EntityDefinition.java @@ -0,0 +1,115 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.model; + +import java.util.*; +import java.util.Map; +import org.openapitools.client.model.FullQualifiedName; +import org.openapitools.client.model.PropertyDefinition; +import io.swagger.annotations.*; +import com.google.gson.annotations.SerializedName; + +@ApiModel(description = "") +public class EntityDefinition { + + @SerializedName("fqn") + private FullQualifiedName fqn = null; + @SerializedName("entitySetName") + private String entitySetName = null; + @SerializedName("propertyDefinitions") + private Map propertyDefinitions = null; + public enum UpdateTypeEnum { + Replace, PartialReplace, Merge, + }; + @SerializedName("updateType") + private UpdateTypeEnum updateType = null; + + /** + **/ + @ApiModelProperty(value = "") + public FullQualifiedName getFqn() { + return fqn; + } + public void setFqn(FullQualifiedName fqn) { + this.fqn = fqn; + } + + /** + **/ + @ApiModelProperty(value = "") + public String getEntitySetName() { + return entitySetName; + } + public void setEntitySetName(String entitySetName) { + this.entitySetName = entitySetName; + } + + /** + **/ + @ApiModelProperty(value = "") + public Map getPropertyDefinitions() { + return propertyDefinitions; + } + public void setPropertyDefinitions(Map propertyDefinitions) { + this.propertyDefinitions = propertyDefinitions; + } + + /** + **/ + @ApiModelProperty(value = "") + public UpdateTypeEnum getUpdateType() { + return updateType; + } + public void setUpdateType(UpdateTypeEnum updateType) { + this.updateType = updateType; + } + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + EntityDefinition entityDefinition = (EntityDefinition) o; + return (this.fqn == null ? entityDefinition.fqn == null : this.fqn.equals(entityDefinition.fqn)) && + (this.entitySetName == null ? entityDefinition.entitySetName == null : this.entitySetName.equals(entityDefinition.entitySetName)) && + (this.propertyDefinitions == null ? entityDefinition.propertyDefinitions == null : this.propertyDefinitions.equals(entityDefinition.propertyDefinitions)) && + (this.updateType == null ? entityDefinition.updateType == null : this.updateType.equals(entityDefinition.updateType)); + } + + @Override + public int hashCode() { + int result = 17; + result = 31 * result + (this.fqn == null ? 0: this.fqn.hashCode()); + result = 31 * result + (this.entitySetName == null ? 0: this.entitySetName.hashCode()); + result = 31 * result + (this.propertyDefinitions == null ? 0: this.propertyDefinitions.hashCode()); + result = 31 * result + (this.updateType == null ? 0: this.updateType.hashCode()); + return result; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class EntityDefinition {\n"); + + sb.append(" fqn: ").append(fqn).append("\n"); + sb.append(" entitySetName: ").append(entitySetName).append("\n"); + sb.append(" propertyDefinitions: ").append(propertyDefinitions).append("\n"); + sb.append(" updateType: ").append(updateType).append("\n"); + sb.append("}\n"); + return sb.toString(); + } +} diff --git a/android/src/main/java/org/openapitools/client/model/Flight.java b/android/src/main/java/org/openapitools/client/model/Flight.java new file mode 100644 index 0000000..5854c0b --- /dev/null +++ b/android/src/main/java/org/openapitools/client/model/Flight.java @@ -0,0 +1,128 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.model; + +import java.util.*; +import java.util.Map; +import java.util.UUID; +import org.openapitools.client.model.AssociationDefinition; +import org.openapitools.client.model.EntityDefinition; +import io.swagger.annotations.*; +import com.google.gson.annotations.SerializedName; + +@ApiModel(description = "") +public class Flight { + + @SerializedName("name") + private String name = null; + @SerializedName("tags") + private List tags = null; + @SerializedName("organizationId") + private UUID organizationId = null; + @SerializedName("entityDefinitions") + private Map entityDefinitions = null; + @SerializedName("associationDefinitions") + private Map associationDefinitions = null; + + /** + **/ + @ApiModelProperty(value = "") + public String getName() { + return name; + } + public void setName(String name) { + this.name = name; + } + + /** + **/ + @ApiModelProperty(value = "") + public List getTags() { + return tags; + } + public void setTags(List tags) { + this.tags = tags; + } + + /** + **/ + @ApiModelProperty(value = "") + public UUID getOrganizationId() { + return organizationId; + } + public void setOrganizationId(UUID organizationId) { + this.organizationId = organizationId; + } + + /** + **/ + @ApiModelProperty(value = "") + public Map getEntityDefinitions() { + return entityDefinitions; + } + public void setEntityDefinitions(Map entityDefinitions) { + this.entityDefinitions = entityDefinitions; + } + + /** + **/ + @ApiModelProperty(value = "") + public Map getAssociationDefinitions() { + return associationDefinitions; + } + public void setAssociationDefinitions(Map associationDefinitions) { + this.associationDefinitions = associationDefinitions; + } + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Flight flight = (Flight) o; + return (this.name == null ? flight.name == null : this.name.equals(flight.name)) && + (this.tags == null ? flight.tags == null : this.tags.equals(flight.tags)) && + (this.organizationId == null ? flight.organizationId == null : this.organizationId.equals(flight.organizationId)) && + (this.entityDefinitions == null ? flight.entityDefinitions == null : this.entityDefinitions.equals(flight.entityDefinitions)) && + (this.associationDefinitions == null ? flight.associationDefinitions == null : this.associationDefinitions.equals(flight.associationDefinitions)); + } + + @Override + public int hashCode() { + int result = 17; + result = 31 * result + (this.name == null ? 0: this.name.hashCode()); + result = 31 * result + (this.tags == null ? 0: this.tags.hashCode()); + result = 31 * result + (this.organizationId == null ? 0: this.organizationId.hashCode()); + result = 31 * result + (this.entityDefinitions == null ? 0: this.entityDefinitions.hashCode()); + result = 31 * result + (this.associationDefinitions == null ? 0: this.associationDefinitions.hashCode()); + return result; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Flight {\n"); + + sb.append(" name: ").append(name).append("\n"); + sb.append(" tags: ").append(tags).append("\n"); + sb.append(" organizationId: ").append(organizationId).append("\n"); + sb.append(" entityDefinitions: ").append(entityDefinitions).append("\n"); + sb.append(" associationDefinitions: ").append(associationDefinitions).append("\n"); + sb.append("}\n"); + return sb.toString(); + } +} diff --git a/android/src/main/java/org/openapitools/client/model/FlightPlanParameters.java b/android/src/main/java/org/openapitools/client/model/FlightPlanParameters.java new file mode 100644 index 0000000..7d8f92b --- /dev/null +++ b/android/src/main/java/org/openapitools/client/model/FlightPlanParameters.java @@ -0,0 +1,133 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.model; + +import java.util.*; +import java.util.Map; +import org.openapitools.client.model.Flight; +import io.swagger.annotations.*; +import com.google.gson.annotations.SerializedName; + +/** + * Represents the parameters required to create a flight plan (i.e. a Map<Flight, Payload>) + **/ +@ApiModel(description = "Represents the parameters required to create a flight plan (i.e. a Map)") +public class FlightPlanParameters { + + @SerializedName("sql") + private String sql = null; + @SerializedName("src") + private Map src = null; + @SerializedName("srcPrimaryKeyColumns") + private List srcPrimaryKeyColumns = null; + @SerializedName("path") + private String path = null; + @SerializedName("flight") + private Flight flight = null; + + /** + * the sql query to be used to pull cleaned data from postgres + **/ + @ApiModelProperty(value = "the sql query to be used to pull cleaned data from postgres") + public String getSql() { + return sql; + } + public void setSql(String sql) { + this.sql = sql; + } + + /** + * postgres data source for pulling clean data + **/ + @ApiModelProperty(value = "postgres data source for pulling clean data") + public Map getSrc() { + return src; + } + public void setSrc(Map src) { + this.src = src; + } + + /** + * the columns that are primary keys in the cleaned data + **/ + @ApiModelProperty(value = "the columns that are primary keys in the cleaned data") + public List getSrcPrimaryKeyColumns() { + return srcPrimaryKeyColumns; + } + public void setSrcPrimaryKeyColumns(List srcPrimaryKeyColumns) { + this.srcPrimaryKeyColumns = srcPrimaryKeyColumns; + } + + /** + * the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) + **/ + @ApiModelProperty(value = "the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml)") + public String getPath() { + return path; + } + public void setPath(String path) { + this.path = path; + } + + /** + **/ + @ApiModelProperty(value = "") + public Flight getFlight() { + return flight; + } + public void setFlight(Flight flight) { + this.flight = flight; + } + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FlightPlanParameters flightPlanParameters = (FlightPlanParameters) o; + return (this.sql == null ? flightPlanParameters.sql == null : this.sql.equals(flightPlanParameters.sql)) && + (this.src == null ? flightPlanParameters.src == null : this.src.equals(flightPlanParameters.src)) && + (this.srcPrimaryKeyColumns == null ? flightPlanParameters.srcPrimaryKeyColumns == null : this.srcPrimaryKeyColumns.equals(flightPlanParameters.srcPrimaryKeyColumns)) && + (this.path == null ? flightPlanParameters.path == null : this.path.equals(flightPlanParameters.path)) && + (this.flight == null ? flightPlanParameters.flight == null : this.flight.equals(flightPlanParameters.flight)); + } + + @Override + public int hashCode() { + int result = 17; + result = 31 * result + (this.sql == null ? 0: this.sql.hashCode()); + result = 31 * result + (this.src == null ? 0: this.src.hashCode()); + result = 31 * result + (this.srcPrimaryKeyColumns == null ? 0: this.srcPrimaryKeyColumns.hashCode()); + result = 31 * result + (this.path == null ? 0: this.path.hashCode()); + result = 31 * result + (this.flight == null ? 0: this.flight.hashCode()); + return result; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FlightPlanParameters {\n"); + + sb.append(" sql: ").append(sql).append("\n"); + sb.append(" src: ").append(src).append("\n"); + sb.append(" srcPrimaryKeyColumns: ").append(srcPrimaryKeyColumns).append("\n"); + sb.append(" path: ").append(path).append("\n"); + sb.append(" flight: ").append(flight).append("\n"); + sb.append("}\n"); + return sb.toString(); + } +} diff --git a/android/src/main/java/org/openapitools/client/model/FlightPlanParametersUpdate.java b/android/src/main/java/org/openapitools/client/model/FlightPlanParametersUpdate.java new file mode 100644 index 0000000..f8555f1 --- /dev/null +++ b/android/src/main/java/org/openapitools/client/model/FlightPlanParametersUpdate.java @@ -0,0 +1,114 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.model; + +import java.util.*; +import java.util.Map; +import io.swagger.annotations.*; +import com.google.gson.annotations.SerializedName; + +@ApiModel(description = "") +public class FlightPlanParametersUpdate { + + @SerializedName("sql") + private String sql = null; + @SerializedName("src") + private Map src = null; + @SerializedName("srcPrimaryKeyColumns") + private List srcPrimaryKeyColumns = null; + @SerializedName("path") + private String path = null; + + /** + * the sql query to be used to pull cleaned data from postgres + **/ + @ApiModelProperty(value = "the sql query to be used to pull cleaned data from postgres") + public String getSql() { + return sql; + } + public void setSql(String sql) { + this.sql = sql; + } + + /** + * postgres data source for pulling clean data + **/ + @ApiModelProperty(value = "postgres data source for pulling clean data") + public Map getSrc() { + return src; + } + public void setSrc(Map src) { + this.src = src; + } + + /** + * the columns that are primary keys in the cleaned data + **/ + @ApiModelProperty(value = "the columns that are primary keys in the cleaned data") + public List getSrcPrimaryKeyColumns() { + return srcPrimaryKeyColumns; + } + public void setSrcPrimaryKeyColumns(List srcPrimaryKeyColumns) { + this.srcPrimaryKeyColumns = srcPrimaryKeyColumns; + } + + /** + * the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) + **/ + @ApiModelProperty(value = "the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml)") + public String getPath() { + return path; + } + public void setPath(String path) { + this.path = path; + } + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + FlightPlanParametersUpdate flightPlanParametersUpdate = (FlightPlanParametersUpdate) o; + return (this.sql == null ? flightPlanParametersUpdate.sql == null : this.sql.equals(flightPlanParametersUpdate.sql)) && + (this.src == null ? flightPlanParametersUpdate.src == null : this.src.equals(flightPlanParametersUpdate.src)) && + (this.srcPrimaryKeyColumns == null ? flightPlanParametersUpdate.srcPrimaryKeyColumns == null : this.srcPrimaryKeyColumns.equals(flightPlanParametersUpdate.srcPrimaryKeyColumns)) && + (this.path == null ? flightPlanParametersUpdate.path == null : this.path.equals(flightPlanParametersUpdate.path)); + } + + @Override + public int hashCode() { + int result = 17; + result = 31 * result + (this.sql == null ? 0: this.sql.hashCode()); + result = 31 * result + (this.src == null ? 0: this.src.hashCode()); + result = 31 * result + (this.srcPrimaryKeyColumns == null ? 0: this.srcPrimaryKeyColumns.hashCode()); + result = 31 * result + (this.path == null ? 0: this.path.hashCode()); + return result; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class FlightPlanParametersUpdate {\n"); + + sb.append(" sql: ").append(sql).append("\n"); + sb.append(" src: ").append(src).append("\n"); + sb.append(" srcPrimaryKeyColumns: ").append(srcPrimaryKeyColumns).append("\n"); + sb.append(" path: ").append(path).append("\n"); + sb.append("}\n"); + return sb.toString(); + } +} diff --git a/android/src/main/java/org/openapitools/client/model/Integration.java b/android/src/main/java/org/openapitools/client/model/Integration.java new file mode 100644 index 0000000..9b74942 --- /dev/null +++ b/android/src/main/java/org/openapitools/client/model/Integration.java @@ -0,0 +1,202 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.model; + +import java.util.*; +import java.util.Map; +import java.util.UUID; +import org.openapitools.client.model.FlightPlanParameters; +import io.swagger.annotations.*; +import com.google.gson.annotations.SerializedName; + +/** + * Represents a data integration, including all fields required to run the integration. + **/ +@ApiModel(description = "Represents a data integration, including all fields required to run the integration.") +public class Integration { + + @SerializedName("key") + private UUID key = null; + public enum EnvironmentEnum { + PROD_INTEGRATION, STAGING_INTEGRATION, LOCAL, + }; + @SerializedName("environment") + private EnvironmentEnum environment = null; + @SerializedName("s3Bucket") + private String s3Bucket = null; + @SerializedName("contacts") + private List contacts = null; + @SerializedName("organizationId") + private UUID organizationId = null; + @SerializedName("entitySetId") + private UUID entitySetId = null; + @SerializedName("maxConnections") + private Integer maxConnections = null; + @SerializedName("callback") + private List callback = null; + @SerializedName("flightPlanParameters") + private Map flightPlanParameters = null; + + /** + * a unique ID used for authorizing a call to run an integration + **/ + @ApiModelProperty(value = "a unique ID used for authorizing a call to run an integration") + public UUID getKey() { + return key; + } + public void setKey(UUID key) { + this.key = key; + } + + /** + * the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) + **/ + @ApiModelProperty(value = "the retrofit environment (e.g. PROD_INTEGRATION, LOCAL)") + public EnvironmentEnum getEnvironment() { + return environment; + } + public void setEnvironment(EnvironmentEnum environment) { + this.environment = environment; + } + + /** + * the url of the s3bucket to be used + **/ + @ApiModelProperty(value = "the url of the s3bucket to be used") + public String getS3Bucket() { + return s3Bucket; + } + public void setS3Bucket(String s3Bucket) { + this.s3Bucket = s3Bucket; + } + + /** + * the set of email addresses of those responsible for the integration + **/ + @ApiModelProperty(value = "the set of email addresses of those responsible for the integration") + public List getContacts() { + return contacts; + } + public void setContacts(List contacts) { + this.contacts = contacts; + } + + /** + * the id of the organization that owns the integration + **/ + @ApiModelProperty(value = "the id of the organization that owns the integration") + public UUID getOrganizationId() { + return organizationId; + } + public void setOrganizationId(UUID organizationId) { + this.organizationId = organizationId; + } + + /** + * the id of the entity set that stores the logs for this integration + **/ + @ApiModelProperty(value = "the id of the entity set that stores the logs for this integration") + public UUID getEntitySetId() { + return entitySetId; + } + public void setEntitySetId(UUID entitySetId) { + this.entitySetId = entitySetId; + } + + /** + * maximum number of connections to postgres allowed for this integration + **/ + @ApiModelProperty(value = "maximum number of connections to postgres allowed for this integration") + public Integer getMaxConnections() { + return maxConnections; + } + public void setMaxConnections(Integer maxConnections) { + this.maxConnections = maxConnections; + } + + /** + * urls to receive a POST when integration has completed + **/ + @ApiModelProperty(value = "urls to receive a POST when integration has completed") + public List getCallback() { + return callback; + } + public void setCallback(List callback) { + this.callback = callback; + } + + /** + * a map from [Flight] name to [FlightPlanParameters] + **/ + @ApiModelProperty(value = "a map from [Flight] name to [FlightPlanParameters]") + public Map getFlightPlanParameters() { + return flightPlanParameters; + } + public void setFlightPlanParameters(Map flightPlanParameters) { + this.flightPlanParameters = flightPlanParameters; + } + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + Integration integration = (Integration) o; + return (this.key == null ? integration.key == null : this.key.equals(integration.key)) && + (this.environment == null ? integration.environment == null : this.environment.equals(integration.environment)) && + (this.s3Bucket == null ? integration.s3Bucket == null : this.s3Bucket.equals(integration.s3Bucket)) && + (this.contacts == null ? integration.contacts == null : this.contacts.equals(integration.contacts)) && + (this.organizationId == null ? integration.organizationId == null : this.organizationId.equals(integration.organizationId)) && + (this.entitySetId == null ? integration.entitySetId == null : this.entitySetId.equals(integration.entitySetId)) && + (this.maxConnections == null ? integration.maxConnections == null : this.maxConnections.equals(integration.maxConnections)) && + (this.callback == null ? integration.callback == null : this.callback.equals(integration.callback)) && + (this.flightPlanParameters == null ? integration.flightPlanParameters == null : this.flightPlanParameters.equals(integration.flightPlanParameters)); + } + + @Override + public int hashCode() { + int result = 17; + result = 31 * result + (this.key == null ? 0: this.key.hashCode()); + result = 31 * result + (this.environment == null ? 0: this.environment.hashCode()); + result = 31 * result + (this.s3Bucket == null ? 0: this.s3Bucket.hashCode()); + result = 31 * result + (this.contacts == null ? 0: this.contacts.hashCode()); + result = 31 * result + (this.organizationId == null ? 0: this.organizationId.hashCode()); + result = 31 * result + (this.entitySetId == null ? 0: this.entitySetId.hashCode()); + result = 31 * result + (this.maxConnections == null ? 0: this.maxConnections.hashCode()); + result = 31 * result + (this.callback == null ? 0: this.callback.hashCode()); + result = 31 * result + (this.flightPlanParameters == null ? 0: this.flightPlanParameters.hashCode()); + return result; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class Integration {\n"); + + sb.append(" key: ").append(key).append("\n"); + sb.append(" environment: ").append(environment).append("\n"); + sb.append(" s3Bucket: ").append(s3Bucket).append("\n"); + sb.append(" contacts: ").append(contacts).append("\n"); + sb.append(" organizationId: ").append(organizationId).append("\n"); + sb.append(" entitySetId: ").append(entitySetId).append("\n"); + sb.append(" maxConnections: ").append(maxConnections).append("\n"); + sb.append(" callback: ").append(callback).append("\n"); + sb.append(" flightPlanParameters: ").append(flightPlanParameters).append("\n"); + sb.append("}\n"); + return sb.toString(); + } +} diff --git a/android/src/main/java/org/openapitools/client/model/IntegrationJob.java b/android/src/main/java/org/openapitools/client/model/IntegrationJob.java new file mode 100644 index 0000000..1541c12 --- /dev/null +++ b/android/src/main/java/org/openapitools/client/model/IntegrationJob.java @@ -0,0 +1,81 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.model; + +import io.swagger.annotations.*; +import com.google.gson.annotations.SerializedName; + +@ApiModel(description = "") +public class IntegrationJob { + + @SerializedName("name") + private String name = null; + public enum StatusEnum { + IN_PROGRESS, SUCCEEDED, FAILED, QUEUED, FAILED_TO_START, + }; + @SerializedName("status") + private StatusEnum status = null; + + /** + **/ + @ApiModelProperty(value = "") + public String getName() { + return name; + } + public void setName(String name) { + this.name = name; + } + + /** + **/ + @ApiModelProperty(value = "") + public StatusEnum getStatus() { + return status; + } + public void setStatus(StatusEnum status) { + this.status = status; + } + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + IntegrationJob integrationJob = (IntegrationJob) o; + return (this.name == null ? integrationJob.name == null : this.name.equals(integrationJob.name)) && + (this.status == null ? integrationJob.status == null : this.status.equals(integrationJob.status)); + } + + @Override + public int hashCode() { + int result = 17; + result = 31 * result + (this.name == null ? 0: this.name.hashCode()); + result = 31 * result + (this.status == null ? 0: this.status.hashCode()); + return result; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class IntegrationJob {\n"); + + sb.append(" name: ").append(name).append("\n"); + sb.append(" status: ").append(status).append("\n"); + sb.append("}\n"); + return sb.toString(); + } +} diff --git a/android/src/main/java/org/openapitools/client/model/IntegrationUpdate.java b/android/src/main/java/org/openapitools/client/model/IntegrationUpdate.java new file mode 100644 index 0000000..2e33ee6 --- /dev/null +++ b/android/src/main/java/org/openapitools/client/model/IntegrationUpdate.java @@ -0,0 +1,167 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.model; + +import java.util.*; +import java.util.Map; +import java.util.UUID; +import org.openapitools.client.model.FlightPlanParametersUpdate; +import io.swagger.annotations.*; +import com.google.gson.annotations.SerializedName; + +@ApiModel(description = "") +public class IntegrationUpdate { + + public enum EnvironmentEnum { + PROD_INTEGRATION, STAGING_INTEGRATION, LOCAL, + }; + @SerializedName("environment") + private EnvironmentEnum environment = null; + @SerializedName("s3Bucket") + private String s3Bucket = null; + @SerializedName("contacts") + private List contacts = null; + @SerializedName("organizationId") + private UUID organizationId = null; + @SerializedName("maxConnections") + private Integer maxConnections = null; + @SerializedName("callbackUrls") + private List callbackUrls = null; + @SerializedName("flightPlanParameters") + private Map flightPlanParameters = null; + + /** + * the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) + **/ + @ApiModelProperty(value = "the retrofit environment (e.g. PROD_INTEGRATION, LOCAL)") + public EnvironmentEnum getEnvironment() { + return environment; + } + public void setEnvironment(EnvironmentEnum environment) { + this.environment = environment; + } + + /** + * the url of the s3bucket to be used + **/ + @ApiModelProperty(value = "the url of the s3bucket to be used") + public String getS3Bucket() { + return s3Bucket; + } + public void setS3Bucket(String s3Bucket) { + this.s3Bucket = s3Bucket; + } + + /** + * the set of email addresses of those responsible for the integration + **/ + @ApiModelProperty(value = "the set of email addresses of those responsible for the integration") + public List getContacts() { + return contacts; + } + public void setContacts(List contacts) { + this.contacts = contacts; + } + + /** + * the id of the organization that owns the integration + **/ + @ApiModelProperty(value = "the id of the organization that owns the integration") + public UUID getOrganizationId() { + return organizationId; + } + public void setOrganizationId(UUID organizationId) { + this.organizationId = organizationId; + } + + /** + * maximum number of connections to postgres allowed for this integration + **/ + @ApiModelProperty(value = "maximum number of connections to postgres allowed for this integration") + public Integer getMaxConnections() { + return maxConnections; + } + public void setMaxConnections(Integer maxConnections) { + this.maxConnections = maxConnections; + } + + /** + * urls to receive a POST when integration has completed + **/ + @ApiModelProperty(value = "urls to receive a POST when integration has completed") + public List getCallbackUrls() { + return callbackUrls; + } + public void setCallbackUrls(List callbackUrls) { + this.callbackUrls = callbackUrls; + } + + /** + * a map from [Flight] name to [FlightPlanParametersUpdate] + **/ + @ApiModelProperty(value = "a map from [Flight] name to [FlightPlanParametersUpdate]") + public Map getFlightPlanParameters() { + return flightPlanParameters; + } + public void setFlightPlanParameters(Map flightPlanParameters) { + this.flightPlanParameters = flightPlanParameters; + } + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + IntegrationUpdate integrationUpdate = (IntegrationUpdate) o; + return (this.environment == null ? integrationUpdate.environment == null : this.environment.equals(integrationUpdate.environment)) && + (this.s3Bucket == null ? integrationUpdate.s3Bucket == null : this.s3Bucket.equals(integrationUpdate.s3Bucket)) && + (this.contacts == null ? integrationUpdate.contacts == null : this.contacts.equals(integrationUpdate.contacts)) && + (this.organizationId == null ? integrationUpdate.organizationId == null : this.organizationId.equals(integrationUpdate.organizationId)) && + (this.maxConnections == null ? integrationUpdate.maxConnections == null : this.maxConnections.equals(integrationUpdate.maxConnections)) && + (this.callbackUrls == null ? integrationUpdate.callbackUrls == null : this.callbackUrls.equals(integrationUpdate.callbackUrls)) && + (this.flightPlanParameters == null ? integrationUpdate.flightPlanParameters == null : this.flightPlanParameters.equals(integrationUpdate.flightPlanParameters)); + } + + @Override + public int hashCode() { + int result = 17; + result = 31 * result + (this.environment == null ? 0: this.environment.hashCode()); + result = 31 * result + (this.s3Bucket == null ? 0: this.s3Bucket.hashCode()); + result = 31 * result + (this.contacts == null ? 0: this.contacts.hashCode()); + result = 31 * result + (this.organizationId == null ? 0: this.organizationId.hashCode()); + result = 31 * result + (this.maxConnections == null ? 0: this.maxConnections.hashCode()); + result = 31 * result + (this.callbackUrls == null ? 0: this.callbackUrls.hashCode()); + result = 31 * result + (this.flightPlanParameters == null ? 0: this.flightPlanParameters.hashCode()); + return result; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class IntegrationUpdate {\n"); + + sb.append(" environment: ").append(environment).append("\n"); + sb.append(" s3Bucket: ").append(s3Bucket).append("\n"); + sb.append(" contacts: ").append(contacts).append("\n"); + sb.append(" organizationId: ").append(organizationId).append("\n"); + sb.append(" maxConnections: ").append(maxConnections).append("\n"); + sb.append(" callbackUrls: ").append(callbackUrls).append("\n"); + sb.append(" flightPlanParameters: ").append(flightPlanParameters).append("\n"); + sb.append("}\n"); + return sb.toString(); + } +} diff --git a/android/src/main/java/org/openapitools/client/model/PropertyDefinition.java b/android/src/main/java/org/openapitools/client/model/PropertyDefinition.java new file mode 100644 index 0000000..1a19edc --- /dev/null +++ b/android/src/main/java/org/openapitools/client/model/PropertyDefinition.java @@ -0,0 +1,79 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.model; + +import org.openapitools.client.model.FullQualifiedName; +import io.swagger.annotations.*; +import com.google.gson.annotations.SerializedName; + +@ApiModel(description = "") +public class PropertyDefinition { + + @SerializedName("type") + private FullQualifiedName type = null; + @SerializedName("column") + private String column = null; + + /** + **/ + @ApiModelProperty(value = "") + public FullQualifiedName getType() { + return type; + } + public void setType(FullQualifiedName type) { + this.type = type; + } + + /** + **/ + @ApiModelProperty(value = "") + public String getColumn() { + return column; + } + public void setColumn(String column) { + this.column = column; + } + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + PropertyDefinition propertyDefinition = (PropertyDefinition) o; + return (this.type == null ? propertyDefinition.type == null : this.type.equals(propertyDefinition.type)) && + (this.column == null ? propertyDefinition.column == null : this.column.equals(propertyDefinition.column)); + } + + @Override + public int hashCode() { + int result = 17; + result = 31 * result + (this.type == null ? 0: this.type.hashCode()); + result = 31 * result + (this.column == null ? 0: this.column.hashCode()); + return result; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class PropertyDefinition {\n"); + + sb.append(" type: ").append(type).append("\n"); + sb.append(" column: ").append(column).append("\n"); + sb.append("}\n"); + return sb.toString(); + } +} diff --git a/android/src/main/java/org/openapitools/client/model/Role.java b/android/src/main/java/org/openapitools/client/model/Role.java index fb43d58..22ca79e 100644 --- a/android/src/main/java/org/openapitools/client/model/Role.java +++ b/android/src/main/java/org/openapitools/client/model/Role.java @@ -30,11 +30,6 @@ public class Role { private String title = null; @SerializedName("description") private String description = null; - public enum _classEnum { - com.openlattice.organization.roles.Role, - }; - @SerializedName("@class") - private _classEnum _class = null; /** **/ @@ -86,16 +81,6 @@ public void setDescription(String description) { this.description = description; } - /** - **/ - @ApiModelProperty(value = "") - public _classEnum getClass() { - return _class; - } - public void setClass(_classEnum _class) { - this._class = _class; - } - @Override public boolean equals(Object o) { @@ -110,8 +95,7 @@ public boolean equals(Object o) { (this.organizationId == null ? role.organizationId == null : this.organizationId.equals(role.organizationId)) && (this.principal == null ? role.principal == null : this.principal.equals(role.principal)) && (this.title == null ? role.title == null : this.title.equals(role.title)) && - (this.description == null ? role.description == null : this.description.equals(role.description)) && - (this._class == null ? role._class == null : this._class.equals(role._class)); + (this.description == null ? role.description == null : this.description.equals(role.description)); } @Override @@ -122,7 +106,6 @@ public int hashCode() { result = 31 * result + (this.principal == null ? 0: this.principal.hashCode()); result = 31 * result + (this.title == null ? 0: this.title.hashCode()); result = 31 * result + (this.description == null ? 0: this.description.hashCode()); - result = 31 * result + (this._class == null ? 0: this._class.hashCode()); return result; } @@ -136,7 +119,6 @@ public String toString() { sb.append(" principal: ").append(principal).append("\n"); sb.append(" title: ").append(title).append("\n"); sb.append(" description: ").append(description).append("\n"); - sb.append(" _class: ").append(_class).append("\n"); sb.append("}\n"); return sb.toString(); } diff --git a/android/src/main/java/org/openapitools/client/model/SearchResult.java b/android/src/main/java/org/openapitools/client/model/SearchResult.java index b857281..6af5619 100644 --- a/android/src/main/java/org/openapitools/client/model/SearchResult.java +++ b/android/src/main/java/org/openapitools/client/model/SearchResult.java @@ -13,20 +13,17 @@ package org.openapitools.client.model; import java.util.*; -import java.util.Map; +import org.openapitools.client.model.SearchResultHits; import io.swagger.annotations.*; import com.google.gson.annotations.SerializedName; -/** - * A search result object, containing the total number of hits for the given query, and the hits themselves. - **/ -@ApiModel(description = "A search result object, containing the total number of hits for the given query, and the hits themselves.") +@ApiModel(description = "") public class SearchResult { @SerializedName("numHits") private Integer numHits = null; @SerializedName("hits") - private Map hits = null; + private List hits = null; /** **/ @@ -41,10 +38,10 @@ public void setNumHits(Integer numHits) { /** **/ @ApiModelProperty(value = "") - public Map getHits() { + public List getHits() { return hits; } - public void setHits(Map hits) { + public void setHits(List hits) { this.hits = hits; } diff --git a/android/src/main/java/org/openapitools/client/model/SearchResultHits.java b/android/src/main/java/org/openapitools/client/model/SearchResultHits.java new file mode 100644 index 0000000..4dd34a6 --- /dev/null +++ b/android/src/main/java/org/openapitools/client/model/SearchResultHits.java @@ -0,0 +1,81 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + */ + +package org.openapitools.client.model; + +import java.util.*; +import org.openapitools.client.model.EntitySet; +import org.openapitools.client.model.PropertyType; +import io.swagger.annotations.*; +import com.google.gson.annotations.SerializedName; + +@ApiModel(description = "") +public class SearchResultHits { + + @SerializedName("propertyTypes") + private List propertyTypes = null; + @SerializedName("entitySet") + private EntitySet entitySet = null; + + /** + **/ + @ApiModelProperty(value = "") + public List getPropertyTypes() { + return propertyTypes; + } + public void setPropertyTypes(List propertyTypes) { + this.propertyTypes = propertyTypes; + } + + /** + **/ + @ApiModelProperty(value = "") + public EntitySet getEntitySet() { + return entitySet; + } + public void setEntitySet(EntitySet entitySet) { + this.entitySet = entitySet; + } + + + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SearchResultHits searchResultHits = (SearchResultHits) o; + return (this.propertyTypes == null ? searchResultHits.propertyTypes == null : this.propertyTypes.equals(searchResultHits.propertyTypes)) && + (this.entitySet == null ? searchResultHits.entitySet == null : this.entitySet.equals(searchResultHits.entitySet)); + } + + @Override + public int hashCode() { + int result = 17; + result = 31 * result + (this.propertyTypes == null ? 0: this.propertyTypes.hashCode()); + result = 31 * result + (this.entitySet == null ? 0: this.entitySet.hashCode()); + return result; + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SearchResultHits {\n"); + + sb.append(" propertyTypes: ").append(propertyTypes).append("\n"); + sb.append(" entitySet: ").append(entitySet).append("\n"); + sb.append("}\n"); + return sb.toString(); + } +} diff --git a/go/.openapi-generator/FILES b/go/.openapi-generator/FILES new file mode 100644 index 0000000..69f8774 --- /dev/null +++ b/go/.openapi-generator/FILES @@ -0,0 +1,193 @@ +.gitignore +.openapi-generator-ignore +.travis.yml +README.md +api/openapi.yaml +api_admin.go +api_authorizations.go +api_collections.go +api_data.go +api_data_integrations.go +api_dataset.go +api_edm.go +api_entity_sets.go +api_linking.go +api_organizations.go +api_permissions.go +api_principal.go +api_search.go +api_shuttle.go +client.go +configuration.go +docs/AccessCheck.md +docs/Ace.md +docs/Acl.md +docs/AclData.md +docs/AdminApi.md +docs/AdvancedSearch.md +docs/Association.md +docs/AssociationDefinition.md +docs/AssociationType.md +docs/Auth0userBasic.md +docs/Authorization.md +docs/AuthorizationsApi.md +docs/AuthorizedObjectsSearchResult.md +docs/BulkDataCreation.md +docs/CollectionTemplateType.md +docs/CollectionsApi.md +docs/Constraint.md +docs/ConstraintGroup.md +docs/DataApi.md +docs/DataAssociation.md +docs/DataEdge.md +docs/DataEdgeData.md +docs/DataEdgeKey.md +docs/DataGraph.md +docs/DataGraphIds.md +docs/DataIntegrationsApi.md +docs/DataSearchResult.md +docs/DatasetApi.md +docs/EdMdiff.md +docs/Edm.md +docs/EdmApi.md +docs/EdmRequest.md +docs/Entity.md +docs/EntityDataKey.md +docs/EntityDefinition.md +docs/EntityKey.md +docs/EntityKeyPair.md +docs/EntityLinkingFeatures.md +docs/EntityLinkingFeedback.md +docs/EntityNeighborsFilter.md +docs/EntitySet.md +docs/EntitySetCollection.md +docs/EntitySetPropertyMetaData.md +docs/EntitySetSelection.md +docs/EntitySetsApi.md +docs/EntityType.md +docs/EntityTypeCollection.md +docs/EntityTypePropertyMetadata.md +docs/Flight.md +docs/FlightPlanParameters.md +docs/FlightPlanParametersUpdate.md +docs/FullQualifiedName.md +docs/IndexingState.md +docs/InlineObject.md +docs/InlineResponse200.md +docs/Integration.md +docs/IntegrationJob.md +docs/IntegrationResults.md +docs/IntegrationUpdate.md +docs/LinkingApi.md +docs/LinkingFeedback.md +docs/MaterializedViewAccount.md +docs/MetadataUpdate.md +docs/NeighborEntityDetails.md +docs/NeighborEntityIds.md +docs/NeighborSearchFilter.md +docs/Organization.md +docs/OrganizationExternalDatabaseColumn.md +docs/OrganizationExternalDatabaseTable.md +docs/OrganizationExternalDatabaseTableColumnsPair.md +docs/OrganizationMember.md +docs/OrganizationsApi.md +docs/PermissionsApi.md +docs/Principal.md +docs/PrincipalApi.md +docs/PropertyDefinition.md +docs/PropertyType.md +docs/PropertyUsageSummary.md +docs/Role.md +docs/Schema.md +docs/Search.md +docs/SearchApi.md +docs/SearchConstraints.md +docs/SearchDetails.md +docs/SearchResult.md +docs/SearchResultHits.md +docs/SearchTerm.md +docs/SecurablePrincipal.md +docs/ShuttleApi.md +docs/SmsEntitySetInformation.md +docs/SortDefinition.md +git_push.sh +go.mod +go.sum +model_access_check.go +model_ace.go +model_acl.go +model_acl_data.go +model_advanced_search.go +model_association.go +model_association_definition.go +model_association_type.go +model_auth0user_basic.go +model_authorization.go +model_authorized_objects_search_result.go +model_bulk_data_creation.go +model_collection_template_type.go +model_constraint.go +model_constraint_group.go +model_data_association.go +model_data_edge.go +model_data_edge_data.go +model_data_edge_key.go +model_data_graph.go +model_data_graph_ids.go +model_data_search_result.go +model_ed_mdiff.go +model_edm.go +model_edm_request.go +model_entity.go +model_entity_data_key.go +model_entity_definition.go +model_entity_key.go +model_entity_key_pair.go +model_entity_linking_features.go +model_entity_linking_feedback.go +model_entity_neighbors_filter.go +model_entity_set.go +model_entity_set_collection.go +model_entity_set_property_meta_data.go +model_entity_set_selection.go +model_entity_type.go +model_entity_type_collection.go +model_entity_type_property_metadata.go +model_flight.go +model_flight_plan_parameters.go +model_flight_plan_parameters_update.go +model_full_qualified_name.go +model_indexing_state.go +model_inline_object.go +model_inline_response_200.go +model_integration.go +model_integration_job.go +model_integration_results.go +model_integration_update.go +model_linking_feedback.go +model_materialized_view_account.go +model_metadata_update.go +model_neighbor_entity_details.go +model_neighbor_entity_ids.go +model_neighbor_search_filter.go +model_organization.go +model_organization_external_database_column.go +model_organization_external_database_table.go +model_organization_external_database_table_columns_pair.go +model_organization_member.go +model_principal.go +model_property_definition.go +model_property_type.go +model_property_usage_summary.go +model_role.go +model_schema.go +model_search.go +model_search_constraints.go +model_search_details.go +model_search_result.go +model_search_result_hits.go +model_search_term.go +model_securable_principal.go +model_sms_entity_set_information.go +model_sort_definition.go +response.go diff --git a/go/.openapi-generator/VERSION b/go/.openapi-generator/VERSION index bfbf77e..d99e716 100644 --- a/go/.openapi-generator/VERSION +++ b/go/.openapi-generator/VERSION @@ -1 +1 @@ -4.3.0-SNAPSHOT \ No newline at end of file +5.0.0-SNAPSHOT \ No newline at end of file diff --git a/go/README.md b/go/README.md index 09e47ee..d9dc760 100644 --- a/go/README.md +++ b/go/README.md @@ -46,7 +46,7 @@ Class | Method | HTTP request | Description *CollectionsApi* | [**GetAllEntitySetCollections**](docs/CollectionsApi.md#getallentitysetcollections) | **Get** /datastore/collections/entity/set | Returns all EntitySetCollection objects *CollectionsApi* | [**GetAllEntityTypeCollections**](docs/CollectionsApi.md#getallentitytypecollections) | **Get** /datastore/collections/entity/type | Returns all EntityTypeCollection objects *CollectionsApi* | [**GetEntitySetCollection**](docs/CollectionsApi.md#getentitysetcollection) | **Get** /datastore/collections/entity/set/{entitySetCollectionId} | Returns the EntitySetCollection object for a given id -*CollectionsApi* | [**GetEntitySetCollectionsOfType**](docs/CollectionsApi.md#getentitysetcollectionsoftype) | **Get** /datastore/collections/entity/type/entity/set/{entitySetCollectionId} | Returns all authorized EntitySetCollections for a given EntityTypeCollection id +*CollectionsApi* | [**GetEntitySetCollectionsOfType**](docs/CollectionsApi.md#getentitysetcollectionsoftype) | **Get** /datastore/collections/entity/set/entity/type/{entitySetCollectionId} | Returns all authorized EntitySetCollections for a given EntityTypeCollection id *CollectionsApi* | [**GetEntityTypeCollection**](docs/CollectionsApi.md#getentitytypecollection) | **Get** /datastore/collections/entity/type/{entityTypeCollectionId} | Returns the EntityTypeCollection object for a given id *CollectionsApi* | [**RemoveTypeFromEntityTypeCollectionTemplate**](docs/CollectionsApi.md#removetypefromentitytypecollectiontemplate) | **Delete** /datastore/collections/entity/type/{entityTypeCollectionId}/template/{typeId} | Removes a key from an EntityTypeCollection template *CollectionsApi* | [**UpdateEntitySetCollectionMetadata**](docs/CollectionsApi.md#updateentitysetcollectionmetadata) | **Patch** /datastore/collections/entity/set/{entitySetCollectionId} | Updates metadata of the specified EntitySetCollection @@ -59,7 +59,7 @@ Class | Method | HTTP request | Description *DataApi* | [**DeleteAllEntitiesFromEntitySet**](docs/DataApi.md#deleteallentitiesfromentityset) | **Delete** /datastore/data/set/{entitySetId}/all | Clears the Entity matching the given Entity id and all of its neighbor Entities *DataApi* | [**DeleteEntities**](docs/DataApi.md#deleteentities) | **Delete** /datastore/data/set/{entitySetId} | Deletes multiple entities from an entity set. *DataApi* | [**DeleteEntitiesAndNeighbors**](docs/DataApi.md#deleteentitiesandneighbors) | **Post** /datastore/data/set/{entitySetId}/neighbors | Deletes the entities matching the given entity ids and all of its neighbor entities provided in the filter. -*DataApi* | [**DeleteEntity**](docs/DataApi.md#deleteentity) | **Delete** /datastore/data/{entitySetId}/{entityKeyId} | Deletes a single entity from an entity set. +*DataApi* | [**DeleteEntity**](docs/DataApi.md#deleteentity) | **Delete** /datastore/data/set/{entitySetId}/{entityKeyId} | Deletes a single entity from an entity set. *DataApi* | [**DeleteEntityProperties**](docs/DataApi.md#deleteentityproperties) | **Delete** /datastore/data/{entitySetId}/{entityKeyId}/properties | Deletes properties from an entity. *DataApi* | [**GetEntity**](docs/DataApi.md#getentity) | **Get** /datastore/data/{entitySetId}/{entityKeyId} | Loads a single entity by its entityKeyId and entitySetId *DataApi* | [**GetEntityPropertyValues**](docs/DataApi.md#getentitypropertyvalues) | **Get** /datastore/data/{entitySetId}/{entityKeyId}/{propertyTypeId} | Loads property values for a single entity by its entityKeyId, entitySetId and propertyTypeId @@ -222,6 +222,14 @@ Class | Method | HTTP request | Description *SearchApi* | [**GetEntitySets**](docs/SearchApi.md#getentitysets) | **Get** /datastore/search/entity-sets/{start}/{numResults} | Executes a search over all existing entity sets to populate the home page. The path parameters instruct which page to return and how large the page should be. *SearchApi* | [**GetPopularEntitySet**](docs/SearchApi.md#getpopularentityset) | **Get** /datastore/search/popular | Get the most popular entity sets. *SearchApi* | [**SearchEntitySetData**](docs/SearchApi.md#searchentitysetdata) | **Patch** /datastore/search | Executes a search over the data of a given entity set to find rows that match the search term +*ShuttleApi* | [**CreateIntegrationDefinition**](docs/ShuttleApi.md#createintegrationdefinition) | **Post** /shuttle/integration/definition/{integrationName} | Creates a new integration definition for running recurring integrations +*ShuttleApi* | [**DeleteIntegrationDefinition**](docs/ShuttleApi.md#deleteintegrationdefinition) | **Delete** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition +*ShuttleApi* | [**DeleteIntegrationJobStatus**](docs/ShuttleApi.md#deleteintegrationjobstatus) | **Delete** /shuttle/integration/status/{jobId} | Deletes an integration job status from the integrationJobs map +*ShuttleApi* | [**EnqueueIntegration**](docs/ShuttleApi.md#enqueueintegration) | **Get** /shuttle/integration/{integrationName}/{integrationKey} | Enqueues an integration on Shuttle Server for a given integration +*ShuttleApi* | [**PollAllIntegrations**](docs/ShuttleApi.md#pollallintegrations) | **Get** /shuttle/integration/status | Polls the statuses of all running integrations +*ShuttleApi* | [**PollIntegration**](docs/ShuttleApi.md#pollintegration) | **Get** /shuttle/integration/status/{jobId} | Polls the status of an integration +*ShuttleApi* | [**ReadIntegrationDefinition**](docs/ShuttleApi.md#readintegrationdefinition) | **Get** /shuttle/integration/definition/{integrationName} | Gets an existing integration definition +*ShuttleApi* | [**UpdateIntegrationDefinition**](docs/ShuttleApi.md#updateintegrationdefinition) | **Patch** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition ## Documentation For Models @@ -232,6 +240,7 @@ Class | Method | HTTP request | Description - [AclData](docs/AclData.md) - [AdvancedSearch](docs/AdvancedSearch.md) - [Association](docs/Association.md) + - [AssociationDefinition](docs/AssociationDefinition.md) - [AssociationType](docs/AssociationType.md) - [Auth0userBasic](docs/Auth0userBasic.md) - [Authorization](docs/Authorization.md) @@ -252,6 +261,7 @@ Class | Method | HTTP request | Description - [EdmRequest](docs/EdmRequest.md) - [Entity](docs/Entity.md) - [EntityDataKey](docs/EntityDataKey.md) + - [EntityDefinition](docs/EntityDefinition.md) - [EntityKey](docs/EntityKey.md) - [EntityKeyPair](docs/EntityKeyPair.md) - [EntityLinkingFeatures](docs/EntityLinkingFeatures.md) @@ -264,11 +274,17 @@ Class | Method | HTTP request | Description - [EntityType](docs/EntityType.md) - [EntityTypeCollection](docs/EntityTypeCollection.md) - [EntityTypePropertyMetadata](docs/EntityTypePropertyMetadata.md) + - [Flight](docs/Flight.md) + - [FlightPlanParameters](docs/FlightPlanParameters.md) + - [FlightPlanParametersUpdate](docs/FlightPlanParametersUpdate.md) - [FullQualifiedName](docs/FullQualifiedName.md) - [IndexingState](docs/IndexingState.md) - [InlineObject](docs/InlineObject.md) - [InlineResponse200](docs/InlineResponse200.md) + - [Integration](docs/Integration.md) + - [IntegrationJob](docs/IntegrationJob.md) - [IntegrationResults](docs/IntegrationResults.md) + - [IntegrationUpdate](docs/IntegrationUpdate.md) - [LinkingFeedback](docs/LinkingFeedback.md) - [MaterializedViewAccount](docs/MaterializedViewAccount.md) - [MetadataUpdate](docs/MetadataUpdate.md) @@ -281,6 +297,7 @@ Class | Method | HTTP request | Description - [OrganizationExternalDatabaseTableColumnsPair](docs/OrganizationExternalDatabaseTableColumnsPair.md) - [OrganizationMember](docs/OrganizationMember.md) - [Principal](docs/Principal.md) + - [PropertyDefinition](docs/PropertyDefinition.md) - [PropertyType](docs/PropertyType.md) - [PropertyUsageSummary](docs/PropertyUsageSummary.md) - [Role](docs/Role.md) @@ -289,6 +306,7 @@ Class | Method | HTTP request | Description - [SearchConstraints](docs/SearchConstraints.md) - [SearchDetails](docs/SearchDetails.md) - [SearchResult](docs/SearchResult.md) + - [SearchResultHits](docs/SearchResultHits.md) - [SearchTerm](docs/SearchTerm.md) - [SecurablePrincipal](docs/SecurablePrincipal.md) - [SmsEntitySetInformation](docs/SmsEntitySetInformation.md) diff --git a/go/api/openapi.yaml b/go/api/openapi.yaml index 63d8e2c..866676a 100644 --- a/go/api/openapi.yaml +++ b/go/api/openapi.yaml @@ -2526,8 +2526,8 @@ paths: tags: - data /datastore/data/{entitySetId}/{entityKeyId}: - delete: - operationId: deleteEntity + get: + operationId: getEntity parameters: - explode: false in: path @@ -2545,27 +2545,26 @@ paths: format: uuid type: string style: simple - - explode: true - in: query - name: type - required: true - schema: - enum: - - Soft - - Hard - type: string - style: form responses: "200": - description: Success + content: + application/json: + schema: + additionalProperties: + items: + type: string + type: array + type: object + description: An entity details object, with property type FQNs as keys. security: - openlattice_auth: [] - http_auth: [] - summary: Deletes a single entity from an entity set. + summary: Loads a single entity by its entityKeyId and entitySetId tags: - data - get: - operationId: getEntity + /datastore/data/set/{entitySetId}/{entityKeyId}: + delete: + operationId: deleteEntity parameters: - explode: false in: path @@ -2583,21 +2582,23 @@ paths: format: uuid type: string style: simple + - explode: true + in: query + name: type + required: true + schema: + enum: + - Soft + - Hard + type: string + style: form responses: "200": - content: - application/json: - schema: - additionalProperties: - items: - type: string - type: array - type: object - description: An entity details object, with property type FQNs as keys. + description: Success security: - openlattice_auth: [] - http_auth: [] - summary: Loads a single entity by its entityKeyId and entitySetId + summary: Deletes a single entity from an entity set. tags: - data /datastore/data/{entitySetId}/{entityKeyId}/{propertyTypeId}: @@ -4767,7 +4768,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EntityTypeCollection' + $ref: '#/components/schemas/CollectionTemplateType' required: true responses: "200": @@ -4908,7 +4909,7 @@ paths: summary: Updates template of the specified EntitySetCollection tags: - collections - /datastore/collections/entity/type/entity/set/{entitySetCollectionId}: + /datastore/collections/entity/set/entity/type/{entitySetCollectionId}: get: operationId: getEntitySetCollectionsOfType parameters: @@ -4936,6 +4937,210 @@ paths: id tags: - collections + /shuttle/integration/definition/{integrationName}: + delete: + operationId: deleteIntegrationDefinition + parameters: + - explode: false + in: path + name: integrationName + required: true + schema: + type: string + style: simple + responses: + "200": + description: Success + security: + - openlattice_auth: [] + - http_auth: [] + summary: Replaces any number of fields within an existing integration definition + tags: + - shuttle + get: + operationId: readIntegrationDefinition + parameters: + - explode: false + in: path + name: integrationName + required: true + schema: + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Integration' + description: Success + security: + - openlattice_auth: [] + - http_auth: [] + summary: Gets an existing integration definition + tags: + - shuttle + patch: + operationId: updateIntegrationDefinition + parameters: + - explode: false + in: path + name: integrationName + required: true + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IntegrationUpdate' + required: true + responses: + "200": + description: Success + security: + - openlattice_auth: [] + - http_auth: [] + summary: Replaces any number of fields within an existing integration definition + tags: + - shuttle + post: + operationId: createIntegrationDefinition + parameters: + - explode: false + in: path + name: integrationName + required: true + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Integration' + required: true + responses: + "200": + content: + application/json: + schema: + format: uuid + type: string + description: Success + security: + - openlattice_auth: [] + - http_auth: [] + summary: Creates a new integration definition for running recurring integrations + tags: + - shuttle + /shuttle/integration/{integrationName}/{integrationKey}: + get: + operationId: enqueueIntegration + parameters: + - description: the name of the integration to be run + explode: false + in: path + name: integrationName + required: true + schema: + type: string + style: simple + - description: the unique id used to authenticate an integration run + explode: false + in: path + name: integrationKey + required: true + schema: + format: uuid + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + format: uuid + type: string + description: Success + security: + - openlattice_auth: [] + - http_auth: [] + summary: Enqueues an integration on Shuttle Server for a given integration + tags: + - shuttle + /shuttle/integration/status/{jobId}: + delete: + operationId: deleteIntegrationJobStatus + parameters: + - description: the unique id of the integration job + explode: false + in: path + name: jobId + required: true + schema: + format: uuid + type: string + style: simple + responses: + "200": + description: Success + security: + - openlattice_auth: [] + - http_auth: [] + summary: Deletes an integration job status from the integrationJobs map + tags: + - shuttle + get: + operationId: pollIntegration + parameters: + - description: the unique id of the integration job + explode: false + in: path + name: jobId + required: true + schema: + format: uuid + type: string + style: simple + responses: + "200": + content: + application/json: + schema: + enum: + - IN_PROGRESS + - SUCCEEDED + - FAILED + - QUEUED + - FAILED_TO_START + type: string + description: Success + security: + - openlattice_auth: [] + - http_auth: [] + summary: Polls the status of an integration + tags: + - shuttle + /shuttle/integration/status: + get: + operationId: pollAllIntegrations + responses: + "200": + content: + application/json: + schema: + additionalProperties: + $ref: '#/components/schemas/IntegrationJob' + type: object + description: Success + security: + - openlattice_auth: [] + - http_auth: [] + summary: Polls the statuses of all running integrations + tags: + - shuttle components: requestBodies: inline_object: @@ -6350,57 +6555,163 @@ components: type: string type: array type: object - DataSearchResult: + SearchResult: example: numHits: 0 hits: - - key: - - hits - - hits - - key: - - hits - - hits - properties: - numHits: - type: integer - hits: - items: - additionalProperties: - items: - type: string - type: array - type: object - type: array - type: object - AdvancedSearch: - example: - start: 0 - searchFields: - - searchTerm: searchTerm - property: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - exact: true - - searchTerm: searchTerm - property: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - exact: true - maxHits: 6 - properties: - searchFields: - items: - $ref: '#/components/schemas/SearchDetails' - type: array - start: - type: integer - maxHits: - type: integer - type: object - BulkDataCreation: - example: - associations: - - dst: - entityId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - entitySetId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - src: - entityId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + - propertyTypes: + - pii: true + indexType: BTREE + datatype: Binary + analyzer: NONE + schemas: + - name: name + namespace: namespace + - name: name + namespace: namespace + description: description + id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + title: title + type: + name: name + namespace: namespace + multiValued: true + enumValues: + - enumValues + - enumValues + - pii: true + indexType: BTREE + datatype: Binary + analyzer: NONE + schemas: + - name: name + namespace: namespace + - name: name + namespace: namespace + description: description + id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + title: title + type: + name: name + namespace: namespace + multiValued: true + enumValues: + - enumValues + - enumValues + entitySet: + entityTypeId: 963b597b-b28d-4f59-b2e6-4d443499e464 + id: 843b597b-b28d-4f59-b2e6-4d443499e323 + name: NameOfMyEntitySet + title: This is the title of the entitySet + contacts: + - support@openlattice.com + description: This is a more elaborate description of the entity set. + - propertyTypes: + - pii: true + indexType: BTREE + datatype: Binary + analyzer: NONE + schemas: + - name: name + namespace: namespace + - name: name + namespace: namespace + description: description + id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + title: title + type: + name: name + namespace: namespace + multiValued: true + enumValues: + - enumValues + - enumValues + - pii: true + indexType: BTREE + datatype: Binary + analyzer: NONE + schemas: + - name: name + namespace: namespace + - name: name + namespace: namespace + description: description + id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + title: title + type: + name: name + namespace: namespace + multiValued: true + enumValues: + - enumValues + - enumValues + entitySet: + entityTypeId: 963b597b-b28d-4f59-b2e6-4d443499e464 + id: 843b597b-b28d-4f59-b2e6-4d443499e323 + name: NameOfMyEntitySet + title: This is the title of the entitySet + contacts: + - support@openlattice.com + description: This is a more elaborate description of the entity set. + properties: + numHits: + type: integer + hits: + items: + $ref: '#/components/schemas/SearchResult_hits' + type: array + type: object + DataSearchResult: + example: + numHits: 0 + hits: + - key: + - hits + - hits + - key: + - hits + - hits + properties: + numHits: + type: integer + hits: + items: + additionalProperties: + items: + type: string + type: array + type: object + type: array + type: object + AdvancedSearch: + example: + start: 0 + searchFields: + - searchTerm: searchTerm + property: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + exact: true + - searchTerm: searchTerm + property: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + exact: true + maxHits: 6 + properties: + searchFields: + items: + $ref: '#/components/schemas/SearchDetails' + type: array + start: + type: integer + maxHits: + type: integer + type: object + BulkDataCreation: + example: + associations: + - dst: + entityId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + entitySetId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + src: + entityId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 entitySetId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 details: key: details @@ -6685,11 +6996,25 @@ components: example: associations: key: - - srcEntityIndex: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + - data: + key: + - data + - data + srcEntityIndex: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 srcEntityKeyId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + dstEntitySetId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + dstEntityIndex: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + dstEntityKeyId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 srcEntitySetId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 - - srcEntityIndex: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + - data: + key: + - data + - data + srcEntityIndex: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 srcEntityKeyId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + dstEntitySetId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + dstEntityIndex: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + dstEntityKeyId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 srcEntitySetId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 entities: key: @@ -6719,8 +7044,15 @@ components: type: object DataAssociation: example: + data: + key: + - data + - data srcEntityIndex: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 srcEntityKeyId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + dstEntitySetId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + dstEntityIndex: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + dstEntityKeyId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 srcEntitySetId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 properties: srcEntitySetId: @@ -6735,6 +7067,25 @@ components: description: An existing entityKeyId format: uuid type: string + dstEntitySetId: + description: the ID of the dst entity set + format: uuid + type: string + dstEntityIndex: + description: The index of an entity + format: uuid + type: string + dstEntityKeyId: + description: An existing entityKeyId + format: uuid + type: string + data: + additionalProperties: + items: + type: string + type: array + description: data + type: object type: object DataGraphIds: example: @@ -6768,7 +7119,6 @@ components: principal: id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: type - '@class': com.openlattice.organization.roles.Role description: description id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 title: title @@ -6785,10 +7135,6 @@ components: type: string description: type: string - '@class': - enum: - - com.openlattice.organization.roles.Role - type: string type: object Organization: example: @@ -6811,7 +7157,6 @@ components: principal: id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: type - '@class': com.openlattice.organization.roles.Role description: description id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 title: title @@ -6819,7 +7164,6 @@ components: principal: id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 type: type - '@class': com.openlattice.organization.roles.Role description: description id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 title: title @@ -7424,21 +7768,6 @@ components: maxHits: type: integer type: object - SearchResult: - description: A search result object, containing the total number of hits for - the given query, and the hits themselves. - example: - numHits: 0 - hits: - key: hits - properties: - numHits: - type: integer - hits: - additionalProperties: - type: string - type: object - type: object OrganizationExternalDatabaseTable: example: organizationId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 @@ -7709,6 +8038,399 @@ components: count: type: integer type: object + Integration: + description: Represents a data integration, including all fields required to + run the integration. + example: + organizationId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + environment: PROD_INTEGRATION + callback: + - callback + - callback + key: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + s3Bucket: s3Bucket + contacts: + - contacts + - contacts + entitySetId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + maxConnections: 0 + flightPlanParameters: + key: + path: path + flight: + organizationId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + name: name + associationDefinitions: + key: + propertyDefinitions: + key: + column: column + type: + name: name + namespace: namespace + fqn: + name: name + namespace: namespace + dst: dst + src: src + entitySetName: entitySetName + updateType: Replace + tags: + - tags + - tags + entityDefinitions: + key: + propertyDefinitions: + key: + column: column + type: + name: name + namespace: namespace + fqn: + name: name + namespace: namespace + entitySetName: entitySetName + updateType: Replace + src: + key: src + srcPrimaryKeyColumns: + - srcPrimaryKeyColumns + - srcPrimaryKeyColumns + sql: sql + properties: + key: + description: a unique ID used for authorizing a call to run an integration + format: uuid + type: string + environment: + description: the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) + enum: + - PROD_INTEGRATION + - STAGING_INTEGRATION + - LOCAL + type: string + s3Bucket: + description: the url of the s3bucket to be used + type: string + contacts: + description: the set of email addresses of those responsible for the integration + items: + type: string + type: array + organizationId: + description: the id of the organization that owns the integration + format: uuid + type: string + entitySetId: + description: the id of the entity set that stores the logs for this integration + format: uuid + type: string + maxConnections: + description: maximum number of connections to postgres allowed for this + integration + type: integer + callback: + description: urls to receive a POST when integration has completed + items: + type: string + type: array + flightPlanParameters: + additionalProperties: + $ref: '#/components/schemas/FlightPlanParameters' + description: a map from [Flight] name to [FlightPlanParameters] + type: object + type: object + FlightPlanParameters: + description: Represents the parameters required to create a flight plan (i.e. + a Map) + example: + path: path + flight: + organizationId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + name: name + associationDefinitions: + key: + propertyDefinitions: + key: + column: column + type: + name: name + namespace: namespace + fqn: + name: name + namespace: namespace + dst: dst + src: src + entitySetName: entitySetName + updateType: Replace + tags: + - tags + - tags + entityDefinitions: + key: + propertyDefinitions: + key: + column: column + type: + name: name + namespace: namespace + fqn: + name: name + namespace: namespace + entitySetName: entitySetName + updateType: Replace + src: + key: src + srcPrimaryKeyColumns: + - srcPrimaryKeyColumns + - srcPrimaryKeyColumns + sql: sql + properties: + sql: + description: the sql query to be used to pull cleaned data from postgres + type: string + src: + additionalProperties: + type: string + description: postgres data source for pulling clean data + type: object + srcPrimaryKeyColumns: + description: the columns that are primary keys in the cleaned data + items: + type: string + type: array + path: + description: the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) + type: string + flight: + $ref: '#/components/schemas/Flight' + type: object + FlightPlanParametersUpdate: + example: + path: path + src: + key: src + srcPrimaryKeyColumns: + - srcPrimaryKeyColumns + - srcPrimaryKeyColumns + sql: sql + properties: + sql: + description: the sql query to be used to pull cleaned data from postgres + type: string + src: + additionalProperties: + type: string + description: postgres data source for pulling clean data + type: object + srcPrimaryKeyColumns: + description: the columns that are primary keys in the cleaned data + items: + type: string + type: array + path: + description: the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) + type: string + type: object + Flight: + example: + organizationId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + name: name + associationDefinitions: + key: + propertyDefinitions: + key: + column: column + type: + name: name + namespace: namespace + fqn: + name: name + namespace: namespace + dst: dst + src: src + entitySetName: entitySetName + updateType: Replace + tags: + - tags + - tags + entityDefinitions: + key: + propertyDefinitions: + key: + column: column + type: + name: name + namespace: namespace + fqn: + name: name + namespace: namespace + entitySetName: entitySetName + updateType: Replace + properties: + name: + type: string + tags: + items: + type: string + type: array + organizationId: + format: uuid + type: string + entityDefinitions: + additionalProperties: + $ref: '#/components/schemas/EntityDefinition' + type: object + associationDefinitions: + additionalProperties: + $ref: '#/components/schemas/AssociationDefinition' + type: object + type: object + PropertyDefinition: + example: + column: column + type: + name: name + namespace: namespace + properties: + type: + $ref: '#/components/schemas/FullQualifiedName' + column: + type: string + type: object + EntityDefinition: + example: + propertyDefinitions: + key: + column: column + type: + name: name + namespace: namespace + fqn: + name: name + namespace: namespace + entitySetName: entitySetName + updateType: Replace + properties: + fqn: + $ref: '#/components/schemas/FullQualifiedName' + entitySetName: + type: string + propertyDefinitions: + additionalProperties: + $ref: '#/components/schemas/PropertyDefinition' + type: object + updateType: + enum: + - Replace + - PartialReplace + - Merge + type: string + type: object + AssociationDefinition: + example: + propertyDefinitions: + key: + column: column + type: + name: name + namespace: namespace + fqn: + name: name + namespace: namespace + dst: dst + src: src + entitySetName: entitySetName + updateType: Replace + properties: + fqn: + $ref: '#/components/schemas/FullQualifiedName' + entitySetName: + type: string + propertyDefinitions: + additionalProperties: + $ref: '#/components/schemas/PropertyDefinition' + type: object + updateType: + enum: + - Replace + - PartialReplace + - Merge + type: string + src: + type: string + dst: + type: string + type: object + IntegrationJob: + properties: + name: + type: string + status: + enum: + - IN_PROGRESS + - SUCCEEDED + - FAILED + - QUEUED + - FAILED_TO_START + type: string + type: object + IntegrationUpdate: + example: + organizationId: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + environment: PROD_INTEGRATION + callbackUrls: + - callbackUrls + - callbackUrls + s3Bucket: s3Bucket + contacts: + - contacts + - contacts + maxConnections: 0 + flightPlanParameters: + key: + path: path + src: + key: src + srcPrimaryKeyColumns: + - srcPrimaryKeyColumns + - srcPrimaryKeyColumns + sql: sql + properties: + environment: + description: the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) + enum: + - PROD_INTEGRATION + - STAGING_INTEGRATION + - LOCAL + type: string + s3Bucket: + description: the url of the s3bucket to be used + type: string + contacts: + description: the set of email addresses of those responsible for the integration + items: + type: string + type: array + organizationId: + description: the id of the organization that owns the integration + format: uuid + type: string + maxConnections: + description: maximum number of connections to postgres allowed for this + integration + type: integer + callbackUrls: + description: urls to receive a POST when integration has completed + items: + type: string + type: array + flightPlanParameters: + additionalProperties: + $ref: '#/components/schemas/FlightPlanParametersUpdate' + description: a map from [Flight] name to [FlightPlanParametersUpdate] + type: object + type: object CollectionTemplateType: example: name: name @@ -7856,6 +8578,62 @@ components: type: string credential: type: string + SearchResult_hits: + example: + propertyTypes: + - pii: true + indexType: BTREE + datatype: Binary + analyzer: NONE + schemas: + - name: name + namespace: namespace + - name: name + namespace: namespace + description: description + id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + title: title + type: + name: name + namespace: namespace + multiValued: true + enumValues: + - enumValues + - enumValues + - pii: true + indexType: BTREE + datatype: Binary + analyzer: NONE + schemas: + - name: name + namespace: namespace + - name: name + namespace: namespace + description: description + id: 046b6c7f-0b8a-43b9-b35d-6489e6daee91 + title: title + type: + name: name + namespace: namespace + multiValued: true + enumValues: + - enumValues + - enumValues + entitySet: + entityTypeId: 963b597b-b28d-4f59-b2e6-4d443499e464 + id: 843b597b-b28d-4f59-b2e6-4d443499e323 + name: NameOfMyEntitySet + title: This is the title of the entitySet + contacts: + - support@openlattice.com + description: This is a more elaborate description of the entity set. + properties: + propertyTypes: + items: + $ref: '#/components/schemas/PropertyType' + type: array + entitySet: + $ref: '#/components/schemas/EntitySet' DataEdge_data: properties: additionalProperties: diff --git a/go/api_admin.go b/go/api_admin.go index 0c6f96c..8d39700 100644 --- a/go/api_admin.go +++ b/go/api_admin.go @@ -96,15 +96,6 @@ func (a *AdminApiService) ClearIndexingQueue(ctx _context.Context) (int32, *_net body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -191,15 +182,6 @@ func (a *AdminApiService) GetIndexingState(ctx _context.Context) (IndexingState, body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v IndexingState - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -289,15 +271,6 @@ func (a *AdminApiService) Reindex(ctx _context.Context, requestBody map[string][ body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v IndexingState - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -387,15 +360,6 @@ func (a *AdminApiService) UpdateReindex(ctx _context.Context, requestBody map[st body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v IndexingState - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } diff --git a/go/api_authorizations.go b/go/api_authorizations.go index 959c4df..9442515 100644 --- a/go/api_authorizations.go +++ b/go/api_authorizations.go @@ -100,15 +100,6 @@ func (a *AuthorizationsApiService) CheckAuthorizations(ctx _context.Context, acc body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []Authorization - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -215,15 +206,6 @@ func (a *AuthorizationsApiService) GetAccessibleObjects(ctx _context.Context, lo body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v AuthorizedObjectsSearchResult - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } diff --git a/go/api_collections.go b/go/api_collections.go index 85a0b97..ffe1297 100644 --- a/go/api_collections.go +++ b/go/api_collections.go @@ -30,9 +30,9 @@ type CollectionsApiService service AddTypeToEntityTypeCollectionTemplate Appends type to template of the specified EntityTypeCollection * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). * @param entityTypeCollectionId - * @param entityTypeCollection + * @param collectionTemplateType */ -func (a *CollectionsApiService) AddTypeToEntityTypeCollectionTemplate(ctx _context.Context, entityTypeCollectionId string, entityTypeCollection EntityTypeCollection) (*_nethttp.Response, error) { +func (a *CollectionsApiService) AddTypeToEntityTypeCollectionTemplate(ctx _context.Context, entityTypeCollectionId string, collectionTemplateType CollectionTemplateType) (*_nethttp.Response, error) { var ( localVarHTTPMethod = _nethttp.MethodPatch localVarPostBody interface{} @@ -43,7 +43,7 @@ func (a *CollectionsApiService) AddTypeToEntityTypeCollectionTemplate(ctx _conte // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/collections/entity/type/{entityTypeCollectionId}/template" - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeCollectionId"+"}", _neturl.QueryEscape(parameterToString(entityTypeCollectionId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeCollectionId"+"}", _neturl.PathEscape(parameterToString(entityTypeCollectionId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -67,7 +67,7 @@ func (a *CollectionsApiService) AddTypeToEntityTypeCollectionTemplate(ctx _conte localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept } // body params - localVarPostBody = &entityTypeCollection + localVarPostBody = &collectionTemplateType if ctx != nil { // API Key Authentication if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok { @@ -181,15 +181,6 @@ func (a *CollectionsApiService) CreateEntitySetCollection(ctx _context.Context, body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -279,15 +270,6 @@ func (a *CollectionsApiService) CreateEntityTypeCollection(ctx _context.Context, body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -319,7 +301,7 @@ func (a *CollectionsApiService) DeleteEntitySetCollection(ctx _context.Context, // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/collections/entity/set/{entitySetCollectionId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetCollectionId"+"}", _neturl.QueryEscape(parameterToString(entitySetCollectionId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetCollectionId"+"}", _neturl.PathEscape(parameterToString(entitySetCollectionId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -397,7 +379,7 @@ func (a *CollectionsApiService) DeleteEntityTypeCollection(ctx _context.Context, // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/collections/entity/type/{entityTypeCollectionId}" - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeCollectionId"+"}", _neturl.QueryEscape(parameterToString(entityTypeCollectionId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeCollectionId"+"}", _neturl.PathEscape(parameterToString(entityTypeCollectionId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -530,15 +512,6 @@ func (a *CollectionsApiService) GetAllEntitySetCollections(ctx _context.Context) body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []EntitySetCollection - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -625,15 +598,6 @@ func (a *CollectionsApiService) GetAllEntityTypeCollections(ctx _context.Context body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []EntityTypeCollection - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -667,7 +631,7 @@ func (a *CollectionsApiService) GetEntitySetCollection(ctx _context.Context, ent // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/collections/entity/set/{entitySetCollectionId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetCollectionId"+"}", _neturl.QueryEscape(parameterToString(entitySetCollectionId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetCollectionId"+"}", _neturl.PathEscape(parameterToString(entitySetCollectionId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -723,15 +687,6 @@ func (a *CollectionsApiService) GetEntitySetCollection(ctx _context.Context, ent body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v EntitySetCollection - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -764,8 +719,8 @@ func (a *CollectionsApiService) GetEntitySetCollectionsOfType(ctx _context.Conte ) // create path and map variables - localVarPath := a.client.cfg.BasePath + "/datastore/collections/entity/type/entity/set/{entitySetCollectionId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetCollectionId"+"}", _neturl.QueryEscape(parameterToString(entitySetCollectionId, "")) , -1) + localVarPath := a.client.cfg.BasePath + "/datastore/collections/entity/set/entity/type/{entitySetCollectionId}" + localVarPath = strings.Replace(localVarPath, "{"+"entitySetCollectionId"+"}", _neturl.PathEscape(parameterToString(entitySetCollectionId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -821,15 +776,6 @@ func (a *CollectionsApiService) GetEntitySetCollectionsOfType(ctx _context.Conte body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []EntitySetCollection - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -863,7 +809,7 @@ func (a *CollectionsApiService) GetEntityTypeCollection(ctx _context.Context, en // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/collections/entity/type/{entityTypeCollectionId}" - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeCollectionId"+"}", _neturl.QueryEscape(parameterToString(entityTypeCollectionId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeCollectionId"+"}", _neturl.PathEscape(parameterToString(entityTypeCollectionId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -919,15 +865,6 @@ func (a *CollectionsApiService) GetEntityTypeCollection(ctx _context.Context, en body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v EntityTypeCollection - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -960,9 +897,9 @@ func (a *CollectionsApiService) RemoveTypeFromEntityTypeCollectionTemplate(ctx _ // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/collections/entity/type/{entityTypeCollectionId}/template/{typeId}" - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeCollectionId"+"}", _neturl.QueryEscape(parameterToString(entityTypeCollectionId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeCollectionId"+"}", _neturl.PathEscape(parameterToString(entityTypeCollectionId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"typeId"+"}", _neturl.QueryEscape(parameterToString(typeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"typeId"+"}", _neturl.PathEscape(parameterToString(typeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1041,7 +978,7 @@ func (a *CollectionsApiService) UpdateEntitySetCollectionMetadata(ctx _context.C // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/collections/entity/set/{entitySetCollectionId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetCollectionId"+"}", _neturl.QueryEscape(parameterToString(entitySetCollectionId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetCollectionId"+"}", _neturl.PathEscape(parameterToString(entitySetCollectionId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1122,7 +1059,7 @@ func (a *CollectionsApiService) UpdateEntitySetCollectionTemplate(ctx _context.C // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/collections/entity/set/{entitySetCollectionId}/template" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetCollectionId"+"}", _neturl.QueryEscape(parameterToString(entitySetCollectionId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetCollectionId"+"}", _neturl.PathEscape(parameterToString(entitySetCollectionId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1203,7 +1140,7 @@ func (a *CollectionsApiService) UpdateEntityTypeCollectionMetadata(ctx _context. // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/collections/entity/type/{entityTypeCollectionId}" - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeCollectionId"+"}", _neturl.QueryEscape(parameterToString(entityTypeCollectionId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeCollectionId"+"}", _neturl.PathEscape(parameterToString(entityTypeCollectionId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} diff --git a/go/api_data.go b/go/api_data.go index d5f2133..fa4721a 100644 --- a/go/api_data.go +++ b/go/api_data.go @@ -100,15 +100,6 @@ func (a *DataApiService) CreateAssociations(ctx _context.Context, inlineObject I body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string][]string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -198,15 +189,6 @@ func (a *DataApiService) CreateEdges(ctx _context.Context, dataEdgeKey []DataEdg body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -298,15 +280,6 @@ func (a *DataApiService) CreateEntities(ctx _context.Context, setId string, requ body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -396,15 +369,6 @@ func (a *DataApiService) CreateEntityAndAssociationData(ctx _context.Context, da body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v DataGraphIds - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -437,7 +401,7 @@ func (a *DataApiService) DeleteAllEntitiesFromEntitySet(ctx _context.Context, en // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/data/set/{entitySetId}/all" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -520,7 +484,7 @@ func (a *DataApiService) DeleteEntities(ctx _context.Context, entitySetId string // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/data/set/{entitySetId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -579,15 +543,6 @@ func (a *DataApiService) DeleteEntities(ctx _context.Context, entitySetId string body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -623,7 +578,7 @@ func (a *DataApiService) DeleteEntitiesAndNeighbors(ctx _context.Context, entity // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/data/set/{entitySetId}/neighbors" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -682,15 +637,6 @@ func (a *DataApiService) DeleteEntitiesAndNeighbors(ctx _context.Context, entity body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -723,10 +669,10 @@ func (a *DataApiService) DeleteEntity(ctx _context.Context, entitySetId string, ) // create path and map variables - localVarPath := a.client.cfg.BasePath + "/datastore/data/{entitySetId}/{entityKeyId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath := a.client.cfg.BasePath + "/datastore/data/set/{entitySetId}/{entityKeyId}" + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"entityKeyId"+"}", _neturl.QueryEscape(parameterToString(entityKeyId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityKeyId"+"}", _neturl.PathEscape(parameterToString(entityKeyId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -808,9 +754,9 @@ func (a *DataApiService) DeleteEntityProperties(ctx _context.Context, entitySetI // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/data/{entitySetId}/{entityKeyId}/properties" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"entityKeyId"+"}", _neturl.QueryEscape(parameterToString(entityKeyId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityKeyId"+"}", _neturl.PathEscape(parameterToString(entityKeyId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -894,9 +840,9 @@ func (a *DataApiService) GetEntity(ctx _context.Context, entitySetId string, ent // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/data/{entitySetId}/{entityKeyId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"entityKeyId"+"}", _neturl.QueryEscape(parameterToString(entityKeyId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityKeyId"+"}", _neturl.PathEscape(parameterToString(entityKeyId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -952,15 +898,6 @@ func (a *DataApiService) GetEntity(ctx _context.Context, entitySetId string, ent body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string][]string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -996,11 +933,11 @@ func (a *DataApiService) GetEntityPropertyValues(ctx _context.Context, entitySet // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/data/{entitySetId}/{entityKeyId}/{propertyTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"entityKeyId"+"}", _neturl.QueryEscape(parameterToString(entityKeyId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityKeyId"+"}", _neturl.PathEscape(parameterToString(entityKeyId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.QueryEscape(parameterToString(propertyTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.PathEscape(parameterToString(propertyTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1056,15 +993,6 @@ func (a *DataApiService) GetEntityPropertyValues(ctx _context.Context, entitySet body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1098,7 +1026,7 @@ func (a *DataApiService) GetEntitySetSize(ctx _context.Context, entitySetId stri // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/data/{entitySetId}/count" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1154,15 +1082,6 @@ func (a *DataApiService) GetEntitySetSize(ctx _context.Context, entitySetId stri body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1196,7 +1115,7 @@ func (a *DataApiService) LoadEntitySetData(ctx _context.Context, entitySetId str // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/data/set/{entitySetId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1252,15 +1171,6 @@ func (a *DataApiService) LoadEntitySetData(ctx _context.Context, entitySetId str body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []map[string][]string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1295,7 +1205,7 @@ func (a *DataApiService) LoadLinkedEntitySetBreakdown(ctx _context.Context, link // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/data/set/{linkedEntitySetId}/detailed" - localVarPath = strings.Replace(localVarPath, "{"+"linkedEntitySetId"+"}", _neturl.QueryEscape(parameterToString(linkedEntitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"linkedEntitySetId"+"}", _neturl.PathEscape(parameterToString(linkedEntitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1353,15 +1263,6 @@ func (a *DataApiService) LoadLinkedEntitySetBreakdown(ctx _context.Context, link body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string]map[string]map[string]map[string][]string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1396,7 +1297,7 @@ func (a *DataApiService) LoadSelectedEntitySetData(ctx _context.Context, entityS // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/data/set/{entitySetId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1454,15 +1355,6 @@ func (a *DataApiService) LoadSelectedEntitySetData(ctx _context.Context, entityS body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []map[string][]string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1554,15 +1446,6 @@ func (a *DataApiService) ReplaceAssociationData(ctx _context.Context, partial bo body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1597,7 +1480,7 @@ func (a *DataApiService) ReplaceEntityProperties(ctx _context.Context, entitySet // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/data/set/{entitySetId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1655,15 +1538,6 @@ func (a *DataApiService) ReplaceEntityProperties(ctx _context.Context, entitySet body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1699,7 +1573,7 @@ func (a *DataApiService) UpdateEntitiesInEntitySet(ctx _context.Context, entityS // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/data/set/{entitySetId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1758,15 +1632,6 @@ func (a *DataApiService) UpdateEntitiesInEntitySet(ctx _context.Context, entityS body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } diff --git a/go/api_data_integrations.go b/go/api_data_integrations.go index 316cd6a..8cfd70f 100644 --- a/go/api_data_integrations.go +++ b/go/api_data_integrations.go @@ -99,15 +99,6 @@ func (a *DataIntegrationsApiService) GetEntityKeyIds(ctx _context.Context, entit body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -199,15 +190,6 @@ func (a *DataIntegrationsApiService) IntegrateEntityAndAssociationData(ctx _cont body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v IntegrationResults - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } diff --git a/go/api_dataset.go b/go/api_dataset.go index f439374..34536e6 100644 --- a/go/api_dataset.go +++ b/go/api_dataset.go @@ -44,11 +44,11 @@ func (a *DatasetApiService) DeleteExternalDatabaseColumn(ctx _context.Context, o // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organization-database/{organizationId}/{tableName}/{columnName}/external-database-column" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"tableName"+"}", _neturl.QueryEscape(parameterToString(tableName, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"tableName"+"}", _neturl.PathEscape(parameterToString(tableName, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"columnName"+"}", _neturl.QueryEscape(parameterToString(columnName, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"columnName"+"}", _neturl.PathEscape(parameterToString(columnName, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -127,9 +127,9 @@ func (a *DatasetApiService) DeleteExternalDatabaseColumns(ctx _context.Context, // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organization-database/{organizationId}/{tableName}/external-database-column" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"tableName"+"}", _neturl.QueryEscape(parameterToString(tableName, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"tableName"+"}", _neturl.PathEscape(parameterToString(tableName, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -208,9 +208,9 @@ func (a *DatasetApiService) DeleteExternalDatabaseTable(ctx _context.Context, or // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organization-database/{organizationId}/{tableName}/external-database-table" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"tableName"+"}", _neturl.QueryEscape(parameterToString(tableName, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"tableName"+"}", _neturl.PathEscape(parameterToString(tableName, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -289,7 +289,7 @@ func (a *DatasetApiService) DeleteExternalDatabaseTables(ctx _context.Context, o // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organization-database/{organizationId}/external-database-table" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -372,9 +372,9 @@ func (a *DatasetApiService) GetAuthorizedExternalDbTablesWithColumnMetadata(ctx // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organization-database/{organizationId}/{permission}/external-database-table/external-database-column/authorized" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"permission"+"}", _neturl.QueryEscape(parameterToString(permission, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"permission"+"}", _neturl.PathEscape(parameterToString(permission, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -430,15 +430,6 @@ func (a *DatasetApiService) GetAuthorizedExternalDbTablesWithColumnMetadata(ctx body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []OrganizationExternalDatabaseTableColumnsPair - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -474,11 +465,11 @@ func (a *DatasetApiService) GetExternalDatabaseColumn(ctx _context.Context, orga // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organization-database/{organizationId}/{tableName}/{columnName}/external-database-column" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"tableName"+"}", _neturl.QueryEscape(parameterToString(tableName, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"tableName"+"}", _neturl.PathEscape(parameterToString(tableName, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"columnName"+"}", _neturl.QueryEscape(parameterToString(columnName, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"columnName"+"}", _neturl.PathEscape(parameterToString(columnName, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -534,15 +525,6 @@ func (a *DatasetApiService) GetExternalDatabaseColumn(ctx _context.Context, orga body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v OrganizationExternalDatabaseColumn - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -577,9 +559,9 @@ func (a *DatasetApiService) GetExternalDatabaseTable(ctx _context.Context, organ // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organization-database/{organizationId}/{tableName}/external-database-table" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"tableName"+"}", _neturl.QueryEscape(parameterToString(tableName, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"tableName"+"}", _neturl.PathEscape(parameterToString(tableName, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -635,15 +617,6 @@ func (a *DatasetApiService) GetExternalDatabaseTable(ctx _context.Context, organ body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v OrganizationExternalDatabaseTable - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -678,9 +651,9 @@ func (a *DatasetApiService) GetExternalDatabaseTableWithColumnMetadata(ctx _cont // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organization-database/{organizationId}/{tableId}/external-database-table/external-database-column" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"tableId"+"}", _neturl.QueryEscape(parameterToString(tableId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"tableId"+"}", _neturl.PathEscape(parameterToString(tableId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -736,15 +709,6 @@ func (a *DatasetApiService) GetExternalDatabaseTableWithColumnMetadata(ctx _cont body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v OrganizationExternalDatabaseTableColumnsPair - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -778,7 +742,7 @@ func (a *DatasetApiService) GetExternalDatabaseTables(ctx _context.Context, orga // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organization-database/{organizationId}/external-database-table" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -834,15 +798,6 @@ func (a *DatasetApiService) GetExternalDatabaseTables(ctx _context.Context, orga body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []OrganizationExternalDatabaseTable - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -876,7 +831,7 @@ func (a *DatasetApiService) GetExternalDatabaseTablesWithColumnMetadata(ctx _con // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organization-database/{organizationId}/external-database-table/external-database-column" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -932,15 +887,6 @@ func (a *DatasetApiService) GetExternalDatabaseTablesWithColumnMetadata(ctx _con body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []OrganizationExternalDatabaseTableColumnsPair - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -975,11 +921,11 @@ func (a *DatasetApiService) UpdateExternalDatabaseColumn(ctx _context.Context, o // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organization-database/{organizationId}/{tableName}/{columnName}/external-database-column" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"tableName"+"}", _neturl.QueryEscape(parameterToString(tableName, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"tableName"+"}", _neturl.PathEscape(parameterToString(tableName, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"columnName"+"}", _neturl.QueryEscape(parameterToString(columnName, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"columnName"+"}", _neturl.PathEscape(parameterToString(columnName, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1061,9 +1007,9 @@ func (a *DatasetApiService) UpdateExternalDatabaseTable(ctx _context.Context, or // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organization-database/{organizationId}/{tableName}/external-database-table" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"tableName"+"}", _neturl.QueryEscape(parameterToString(tableName, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"tableName"+"}", _neturl.PathEscape(parameterToString(tableName, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} diff --git a/go/api_edm.go b/go/api_edm.go index 4e5d542..e355b3e 100644 --- a/go/api_edm.go +++ b/go/api_edm.go @@ -44,9 +44,9 @@ func (a *EdmApiService) AddDstEntityTypeToAssociationType(ctx _context.Context, // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/association/type/{associationTypeId}/dst/{entityTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"associationTypeId"+"}", _neturl.QueryEscape(parameterToString(associationTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"associationTypeId"+"}", _neturl.PathEscape(parameterToString(associationTypeId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.QueryEscape(parameterToString(entityTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.PathEscape(parameterToString(entityTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -133,7 +133,7 @@ func (a *EdmApiService) AddEntitySetsToLinkingEntitySet(ctx _context.Context, li // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/linking/{linkingEntitySetId}" - localVarPath = strings.Replace(localVarPath, "{"+"linkingEntitySetId"+"}", _neturl.QueryEscape(parameterToString(linkingEntitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"linkingEntitySetId"+"}", _neturl.PathEscape(parameterToString(linkingEntitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -198,15 +198,6 @@ func (a *EdmApiService) AddEntitySetsToLinkingEntitySet(ctx _context.Context, li body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -241,7 +232,7 @@ func (a *EdmApiService) AddEntitySetsToLinkingEntitySets(ctx _context.Context, l // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/linking/" - localVarPath = strings.Replace(localVarPath, "{"+"linkingEntitySetId"+"}", _neturl.QueryEscape(parameterToString(linkingEntitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"linkingEntitySetId"+"}", _neturl.PathEscape(parameterToString(linkingEntitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -299,15 +290,6 @@ func (a *EdmApiService) AddEntitySetsToLinkingEntitySets(ctx _context.Context, l body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -340,9 +322,9 @@ func (a *EdmApiService) AddPrimaryKeyToEntityType(ctx _context.Context, entityTy // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/entity/type/key/{entityTypeId}/{propertyTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.QueryEscape(parameterToString(entityTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.PathEscape(parameterToString(entityTypeId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.QueryEscape(parameterToString(propertyTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.PathEscape(parameterToString(propertyTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -421,9 +403,9 @@ func (a *EdmApiService) AddPropertyTypeToEntityType(ctx _context.Context, entity // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/entity/type/{entityTypeId}/{propertyTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.QueryEscape(parameterToString(entityTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.PathEscape(parameterToString(entityTypeId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.QueryEscape(parameterToString(propertyTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.PathEscape(parameterToString(propertyTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -502,9 +484,9 @@ func (a *EdmApiService) AddSrcEntityTypeToAssociationType(ctx _context.Context, // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/association/type/{associationTypeId}/src/{entityTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"associationTypeId"+"}", _neturl.QueryEscape(parameterToString(associationTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"associationTypeId"+"}", _neturl.PathEscape(parameterToString(associationTypeId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.QueryEscape(parameterToString(entityTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.PathEscape(parameterToString(entityTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -649,9 +631,9 @@ func (a *EdmApiService) CreateEmptySchema(ctx _context.Context, namespace string // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/schema/{namespace}/{name}" - localVarPath = strings.Replace(localVarPath, "{"+"namespace"+"}", _neturl.QueryEscape(parameterToString(namespace, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"namespace"+"}", _neturl.PathEscape(parameterToString(namespace, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"name"+"}", _neturl.QueryEscape(parameterToString(name, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"name"+"}", _neturl.PathEscape(parameterToString(name, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1029,7 +1011,7 @@ func (a *EdmApiService) DeleteAssociationType(ctx _context.Context, associationT // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/association/type/{associationTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"associationTypeId"+"}", _neturl.QueryEscape(parameterToString(associationTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"associationTypeId"+"}", _neturl.PathEscape(parameterToString(associationTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1095,7 +1077,7 @@ func (a *EdmApiService) DeleteEntitySet(ctx _context.Context, entitySetId string // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/all/{entitySetId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1173,7 +1155,7 @@ func (a *EdmApiService) DeleteEntityType(ctx _context.Context, entityTypeId stri // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/entity/type/{entityTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.QueryEscape(parameterToString(entityTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.PathEscape(parameterToString(entityTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1239,7 +1221,7 @@ func (a *EdmApiService) DeletePropertyType(ctx _context.Context, propertyTypeId // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/property/type/{propertyTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.QueryEscape(parameterToString(propertyTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.PathEscape(parameterToString(propertyTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1317,7 +1299,7 @@ func (a *EdmApiService) ForceDeletePropertyType(ctx _context.Context, propertyTy // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/property/type/{propertyTypeId}/force" - localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.QueryEscape(parameterToString(propertyTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.PathEscape(parameterToString(propertyTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1396,9 +1378,9 @@ func (a *EdmApiService) ForceRemovePropertyTypeFromEntityType(ctx _context.Conte // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/entity/type/{entityTypeId}/{propertyTypeId}/force" - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.QueryEscape(parameterToString(entityTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.PathEscape(parameterToString(entityTypeId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.QueryEscape(parameterToString(propertyTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.PathEscape(parameterToString(propertyTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1531,15 +1513,6 @@ func (a *EdmApiService) GetAllAssociationEntityTypes(ctx _context.Context) ([]As body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []AssociationType - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1573,7 +1546,7 @@ func (a *EdmApiService) GetAllAvailableAssociationTypes(ctx _context.Context, as // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/association/type/{associationTypeId}/available" - localVarPath = strings.Replace(localVarPath, "{"+"associationTypeId"+"}", _neturl.QueryEscape(parameterToString(associationTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"associationTypeId"+"}", _neturl.PathEscape(parameterToString(associationTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1629,15 +1602,6 @@ func (a *EdmApiService) GetAllAvailableAssociationTypes(ctx _context.Context, as body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []AssociationType - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1671,7 +1635,7 @@ func (a *EdmApiService) GetAllEntitySetPropertyMetadata(ctx _context.Context, en // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/all/{entitySetId}/metadata" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1727,15 +1691,6 @@ func (a *EdmApiService) GetAllEntitySetPropertyMetadata(ctx _context.Context, en body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string]EntitySetPropertyMetaData - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1822,15 +1777,6 @@ func (a *EdmApiService) GetAllEntitySets(ctx _context.Context) ([]EntitySet, *_n body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []EntitySet - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1864,7 +1810,7 @@ func (a *EdmApiService) GetAllEntityTypePropertyMetadata(ctx _context.Context, e // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/entity/type/{entityTypeId}/property/type" - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.QueryEscape(parameterToString(entityTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.PathEscape(parameterToString(entityTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1920,15 +1866,6 @@ func (a *EdmApiService) GetAllEntityTypePropertyMetadata(ctx _context.Context, e body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string]EntityTypePropertyMetadata - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -2015,15 +1952,6 @@ func (a *EdmApiService) GetAllEntityTypes(ctx _context.Context) ([]EntityType, * body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []EntityType - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -2110,15 +2038,6 @@ func (a *EdmApiService) GetAllPropertyTypes(ctx _context.Context) ([]PropertyTyp body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []PropertyType - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -2152,7 +2071,7 @@ func (a *EdmApiService) GetAllPropertyTypesInNamespace(ctx _context.Context, nam // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/property/type/namespace/{namespace}" - localVarPath = strings.Replace(localVarPath, "{"+"namespace"+"}", _neturl.QueryEscape(parameterToString(namespace, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"namespace"+"}", _neturl.PathEscape(parameterToString(namespace, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -2208,15 +2127,6 @@ func (a *EdmApiService) GetAllPropertyTypesInNamespace(ctx _context.Context, nam body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []PropertyType - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -2303,15 +2213,6 @@ func (a *EdmApiService) GetAllPropertyUsageSummaries(ctx _context.Context) (map[ body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string]PropertyUsageSummary - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -2345,7 +2246,7 @@ func (a *EdmApiService) GetAssociationType(ctx _context.Context, associationType // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/association/type/{associationTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"associationTypeId"+"}", _neturl.QueryEscape(parameterToString(associationTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"associationTypeId"+"}", _neturl.PathEscape(parameterToString(associationTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -2401,15 +2302,6 @@ func (a *EdmApiService) GetAssociationType(ctx _context.Context, associationType body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v AssociationType - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -2443,7 +2335,7 @@ func (a *EdmApiService) GetAssociationTypeDetails(ctx _context.Context, associat // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/association/type/{associationTypeId}/detailed" - localVarPath = strings.Replace(localVarPath, "{"+"associationTypeId"+"}", _neturl.QueryEscape(parameterToString(associationTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"associationTypeId"+"}", _neturl.PathEscape(parameterToString(associationTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -2499,15 +2391,6 @@ func (a *EdmApiService) GetAssociationTypeDetails(ctx _context.Context, associat body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v AssociationType - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -2582,15 +2465,6 @@ func (a *EdmApiService) GetEntityDataModel(ctx _context.Context) (Edm, *_nethttp body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v Edm - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -2680,15 +2554,6 @@ func (a *EdmApiService) GetEntityDataModelDiff(ctx _context.Context, edMdiff EdM body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v EdMdiff - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -2722,7 +2587,7 @@ func (a *EdmApiService) GetEntitySet(ctx _context.Context, entitySetId string) ( // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/all/{entitySetId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -2778,15 +2643,6 @@ func (a *EdmApiService) GetEntitySet(ctx _context.Context, entitySetId string) ( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v EntitySet - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -2820,7 +2676,7 @@ func (a *EdmApiService) GetEntitySetId(ctx _context.Context, entitySetName strin // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/ids/{entitySetName}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetName"+"}", _neturl.QueryEscape(parameterToString(entitySetName, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetName"+"}", _neturl.PathEscape(parameterToString(entitySetName, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -2876,15 +2732,6 @@ func (a *EdmApiService) GetEntitySetId(ctx _context.Context, entitySetName strin body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -2987,15 +2834,6 @@ func (a *EdmApiService) GetEntitySetIds(ctx _context.Context, localVarOptionals body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string]string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -3030,9 +2868,9 @@ func (a *EdmApiService) GetEntitySetPropertyMetadata(ctx _context.Context, entit // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/all/{entitySetId}/properties/{propertyTypeId}/" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.QueryEscape(parameterToString(propertyTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.PathEscape(parameterToString(propertyTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -3088,15 +2926,6 @@ func (a *EdmApiService) GetEntitySetPropertyMetadata(ctx _context.Context, entit body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v EntitySetPropertyMetaData - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -3130,7 +2959,7 @@ func (a *EdmApiService) GetEntityType(ctx _context.Context, entityTypeId string) // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/entity/type/{entityTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.QueryEscape(parameterToString(entityTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.PathEscape(parameterToString(entityTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -3174,15 +3003,6 @@ func (a *EdmApiService) GetEntityType(ctx _context.Context, entityTypeId string) body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v EntityType - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -3214,7 +3034,7 @@ func (a *EdmApiService) GetEntityTypeHierarchy(ctx _context.Context, entityTypeI // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/entity/type/{entityTypeId}/hierarchy" - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.QueryEscape(parameterToString(entityTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.PathEscape(parameterToString(entityTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -3295,9 +3115,9 @@ func (a *EdmApiService) GetEntityTypeId(ctx _context.Context, namespace string, // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/ids/entity/type/{namespace}/{name}" - localVarPath = strings.Replace(localVarPath, "{"+"namespace"+"}", _neturl.QueryEscape(parameterToString(namespace, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"namespace"+"}", _neturl.PathEscape(parameterToString(namespace, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"name"+"}", _neturl.QueryEscape(parameterToString(name, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"name"+"}", _neturl.PathEscape(parameterToString(name, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -3353,15 +3173,6 @@ func (a *EdmApiService) GetEntityTypeId(ctx _context.Context, namespace string, body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -3396,9 +3207,9 @@ func (a *EdmApiService) GetEntityTypePropertyMetadata(ctx _context.Context, enti // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/entity/type/{entityTypeId}/property/type/{propertyTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.QueryEscape(parameterToString(entityTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.PathEscape(parameterToString(entityTypeId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.QueryEscape(parameterToString(propertyTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.PathEscape(parameterToString(propertyTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -3454,15 +3265,6 @@ func (a *EdmApiService) GetEntityTypePropertyMetadata(ctx _context.Context, enti body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v EntityTypePropertyMetadata - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -3565,15 +3367,6 @@ func (a *EdmApiService) GetPropertyMetadataForEntitySets(ctx _context.Context, l body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string]map[string]EntitySetPropertyMetaData - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -3607,7 +3400,7 @@ func (a *EdmApiService) GetPropertyType(ctx _context.Context, propertyTypeId str // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/property/type/{propertyTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.QueryEscape(parameterToString(propertyTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.PathEscape(parameterToString(propertyTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -3663,15 +3456,6 @@ func (a *EdmApiService) GetPropertyType(ctx _context.Context, propertyTypeId str body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v PropertyType - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -3706,9 +3490,9 @@ func (a *EdmApiService) GetPropertyTypeId(ctx _context.Context, namespace string // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/ids/property/type/{namespace}/{name}" - localVarPath = strings.Replace(localVarPath, "{"+"namespace"+"}", _neturl.QueryEscape(parameterToString(namespace, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"namespace"+"}", _neturl.PathEscape(parameterToString(namespace, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"name"+"}", _neturl.QueryEscape(parameterToString(name, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"name"+"}", _neturl.PathEscape(parameterToString(name, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -3764,15 +3548,6 @@ func (a *EdmApiService) GetPropertyTypeId(ctx _context.Context, namespace string body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -3806,7 +3581,7 @@ func (a *EdmApiService) GetPropertyTypesForEntitySet(ctx _context.Context, entit // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/all/{entitySetId}/properties" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -3862,15 +3637,6 @@ func (a *EdmApiService) GetPropertyTypesForEntitySet(ctx _context.Context, entit body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string]PropertyType - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -3904,7 +3670,7 @@ func (a *EdmApiService) GetPropertyUsageSummary(ctx _context.Context, propertyTy // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/summary/{propertyTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.QueryEscape(parameterToString(propertyTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.PathEscape(parameterToString(propertyTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -3960,15 +3726,6 @@ func (a *EdmApiService) GetPropertyUsageSummary(ctx _context.Context, propertyTy body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []PropertyUsageSummary - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -4010,9 +3767,9 @@ func (a *EdmApiService) GetSchemaContents(ctx _context.Context, namespace string // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/schema/{namespace}/{name}" - localVarPath = strings.Replace(localVarPath, "{"+"namespace"+"}", _neturl.QueryEscape(parameterToString(namespace, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"namespace"+"}", _neturl.PathEscape(parameterToString(namespace, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"name"+"}", _neturl.QueryEscape(parameterToString(name, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"name"+"}", _neturl.PathEscape(parameterToString(name, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -4071,15 +3828,6 @@ func (a *EdmApiService) GetSchemaContents(ctx _context.Context, namespace string body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v Schema - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -4166,15 +3914,6 @@ func (a *EdmApiService) GetSchemas(ctx _context.Context) ([]Schema, *_nethttp.Re body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []Schema - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -4208,7 +3947,7 @@ func (a *EdmApiService) GetSchemasInNamespace(ctx _context.Context, namespace st // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/schema/{namespace}" - localVarPath = strings.Replace(localVarPath, "{"+"namespace"+"}", _neturl.QueryEscape(parameterToString(namespace, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"namespace"+"}", _neturl.PathEscape(parameterToString(namespace, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -4264,15 +4003,6 @@ func (a *EdmApiService) GetSchemasInNamespace(ctx _context.Context, namespace st body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []Schema - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -4305,9 +4035,9 @@ func (a *EdmApiService) RemoveDstEntityTypeFromAssociationType(ctx _context.Cont // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/association/type/{associationTypeId}/dst/{entityTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"associationTypeId"+"}", _neturl.QueryEscape(parameterToString(associationTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"associationTypeId"+"}", _neturl.PathEscape(parameterToString(associationTypeId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.QueryEscape(parameterToString(entityTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.PathEscape(parameterToString(entityTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -4394,7 +4124,7 @@ func (a *EdmApiService) RemoveEntitySetsFromLinkingEntitySet(ctx _context.Contex // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/linking/{linkingEntitySetId}" - localVarPath = strings.Replace(localVarPath, "{"+"linkingEntitySetId"+"}", _neturl.QueryEscape(parameterToString(linkingEntitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"linkingEntitySetId"+"}", _neturl.PathEscape(parameterToString(linkingEntitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -4459,15 +4189,6 @@ func (a *EdmApiService) RemoveEntitySetsFromLinkingEntitySet(ctx _context.Contex body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -4502,7 +4223,7 @@ func (a *EdmApiService) RemoveEntitySetsFromLinkingEntitySets(ctx _context.Conte // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/linking/" - localVarPath = strings.Replace(localVarPath, "{"+"linkingEntitySetId"+"}", _neturl.QueryEscape(parameterToString(linkingEntitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"linkingEntitySetId"+"}", _neturl.PathEscape(parameterToString(linkingEntitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -4560,15 +4281,6 @@ func (a *EdmApiService) RemoveEntitySetsFromLinkingEntitySets(ctx _context.Conte body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -4601,9 +4313,9 @@ func (a *EdmApiService) RemovePrimaryKeyFromEntityType(ctx _context.Context, ent // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/entity/type/key/{entityTypeId}/{propertyTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.QueryEscape(parameterToString(entityTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.PathEscape(parameterToString(entityTypeId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.QueryEscape(parameterToString(propertyTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.PathEscape(parameterToString(propertyTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -4682,9 +4394,9 @@ func (a *EdmApiService) RemovePropertyTypeFromEntityType(ctx _context.Context, e // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/entity/type/{entityTypeId}/{propertyTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.QueryEscape(parameterToString(entityTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.PathEscape(parameterToString(entityTypeId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.QueryEscape(parameterToString(propertyTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.PathEscape(parameterToString(propertyTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -4763,9 +4475,9 @@ func (a *EdmApiService) RemoveSrcEntityTypeFromAssociationType(ctx _context.Cont // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/association/type/{associationTypeId}/src/{entityTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"associationTypeId"+"}", _neturl.QueryEscape(parameterToString(associationTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"associationTypeId"+"}", _neturl.PathEscape(parameterToString(associationTypeId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.QueryEscape(parameterToString(entityTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.PathEscape(parameterToString(entityTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -4844,9 +4556,9 @@ func (a *EdmApiService) ReorderPropertyTypesInEntityType(ctx _context.Context, e // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/entity/type/{entityTypeId}/property/type" - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.QueryEscape(parameterToString(entityTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.PathEscape(parameterToString(entityTypeId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeIds"+"}", _neturl.QueryEscape(parameterToString(propertyTypeIds, "csv")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeIds"+"}", _neturl.PathEscape(parameterToString(propertyTypeIds, "csv")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -5005,7 +4717,7 @@ func (a *EdmApiService) UpdateEntitySetMetaData(ctx _context.Context, entitySetI // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/all/{entitySetId}/metadata/" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -5063,15 +4775,6 @@ func (a *EdmApiService) UpdateEntitySetMetaData(ctx _context.Context, entitySetI body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -5105,9 +4808,9 @@ func (a *EdmApiService) UpdateEntitySetPropertyMetadata(ctx _context.Context, en // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/all/{entitySetId}/properties/{propertyTypeId}/" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.QueryEscape(parameterToString(propertyTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.PathEscape(parameterToString(propertyTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -5188,7 +4891,7 @@ func (a *EdmApiService) UpdateEntityTypeMetaData(ctx _context.Context, entityTyp // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/entity/type/{entityTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.QueryEscape(parameterToString(entityTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.PathEscape(parameterToString(entityTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -5269,9 +4972,9 @@ func (a *EdmApiService) UpdateEntityTypePropertyMetadata(ctx _context.Context, e // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/entity/type/{entityTypeId}/property/type/{propertyTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.QueryEscape(parameterToString(entityTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityTypeId"+"}", _neturl.PathEscape(parameterToString(entityTypeId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.QueryEscape(parameterToString(propertyTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.PathEscape(parameterToString(propertyTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -5350,7 +5053,7 @@ func (a *EdmApiService) UpdatePropertyTypeMetaData(ctx _context.Context, propert // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/property/type/{propertyTypeId}" - localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.QueryEscape(parameterToString(propertyTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.PathEscape(parameterToString(propertyTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -5432,9 +5135,9 @@ func (a *EdmApiService) UpdateSchema(ctx _context.Context, namespace string, nam // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/edm/schema/{namespace}/{name}" - localVarPath = strings.Replace(localVarPath, "{"+"namespace"+"}", _neturl.QueryEscape(parameterToString(namespace, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"namespace"+"}", _neturl.PathEscape(parameterToString(namespace, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"name"+"}", _neturl.QueryEscape(parameterToString(name, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"name"+"}", _neturl.PathEscape(parameterToString(name, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} diff --git a/go/api_entity_sets.go b/go/api_entity_sets.go index ce478ee..269c9f0 100644 --- a/go/api_entity_sets.go +++ b/go/api_entity_sets.go @@ -52,7 +52,7 @@ func (a *EntitySetsApiService) AddEntitySetsToLinkingEntitySet(ctx _context.Cont // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/linking/{linkingEntitySetId}" - localVarPath = strings.Replace(localVarPath, "{"+"linkingEntitySetId"+"}", _neturl.QueryEscape(parameterToString(linkingEntitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"linkingEntitySetId"+"}", _neturl.PathEscape(parameterToString(linkingEntitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -117,15 +117,6 @@ func (a *EntitySetsApiService) AddEntitySetsToLinkingEntitySet(ctx _context.Cont body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -160,7 +151,7 @@ func (a *EntitySetsApiService) AddEntitySetsToLinkingEntitySets(ctx _context.Con // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/linking/" - localVarPath = strings.Replace(localVarPath, "{"+"linkingEntitySetId"+"}", _neturl.QueryEscape(parameterToString(linkingEntitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"linkingEntitySetId"+"}", _neturl.PathEscape(parameterToString(linkingEntitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -218,15 +209,6 @@ func (a *EntitySetsApiService) AddEntitySetsToLinkingEntitySets(ctx _context.Con body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -336,7 +318,7 @@ func (a *EntitySetsApiService) DeleteEntitySet(ctx _context.Context, entitySetId // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/all/{entitySetId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -416,7 +398,7 @@ func (a *EntitySetsApiService) GetAllEntitySetPropertyMetadata(ctx _context.Cont // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/all/{entitySetId}/metadata" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -472,15 +454,6 @@ func (a *EntitySetsApiService) GetAllEntitySetPropertyMetadata(ctx _context.Cont body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string]EntitySetPropertyMetaData - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -567,15 +540,6 @@ func (a *EntitySetsApiService) GetAllEntitySets(ctx _context.Context) ([]EntityS body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []EntitySet - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -609,7 +573,7 @@ func (a *EntitySetsApiService) GetEntitySet(ctx _context.Context, entitySetId st // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/all/{entitySetId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -665,15 +629,6 @@ func (a *EntitySetsApiService) GetEntitySet(ctx _context.Context, entitySetId st body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v EntitySet - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -707,7 +662,7 @@ func (a *EntitySetsApiService) GetEntitySetId(ctx _context.Context, entitySetNam // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/ids/{entitySetName}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetName"+"}", _neturl.QueryEscape(parameterToString(entitySetName, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetName"+"}", _neturl.PathEscape(parameterToString(entitySetName, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -763,15 +718,6 @@ func (a *EntitySetsApiService) GetEntitySetId(ctx _context.Context, entitySetNam body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -874,15 +820,6 @@ func (a *EntitySetsApiService) GetEntitySetIds(ctx _context.Context, localVarOpt body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string]string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -917,9 +854,9 @@ func (a *EntitySetsApiService) GetEntitySetPropertyMetadata(ctx _context.Context // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/all/{entitySetId}/properties/{propertyTypeId}/" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.QueryEscape(parameterToString(propertyTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.PathEscape(parameterToString(propertyTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -975,15 +912,6 @@ func (a *EntitySetsApiService) GetEntitySetPropertyMetadata(ctx _context.Context body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v EntitySetPropertyMetaData - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1086,15 +1014,6 @@ func (a *EntitySetsApiService) GetPropertyMetadataForEntitySets(ctx _context.Con body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string]map[string]EntitySetPropertyMetaData - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1128,7 +1047,7 @@ func (a *EntitySetsApiService) GetPropertyTypesForEntitySet(ctx _context.Context // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/all/{entitySetId}/properties" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1184,15 +1103,6 @@ func (a *EntitySetsApiService) GetPropertyTypesForEntitySet(ctx _context.Context body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string]PropertyType - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1233,7 +1143,7 @@ func (a *EntitySetsApiService) RemoveEntitySetsFromLinkingEntitySet(ctx _context // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/linking/{linkingEntitySetId}" - localVarPath = strings.Replace(localVarPath, "{"+"linkingEntitySetId"+"}", _neturl.QueryEscape(parameterToString(linkingEntitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"linkingEntitySetId"+"}", _neturl.PathEscape(parameterToString(linkingEntitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1298,15 +1208,6 @@ func (a *EntitySetsApiService) RemoveEntitySetsFromLinkingEntitySet(ctx _context body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1341,7 +1242,7 @@ func (a *EntitySetsApiService) RemoveEntitySetsFromLinkingEntitySets(ctx _contex // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/linking/" - localVarPath = strings.Replace(localVarPath, "{"+"linkingEntitySetId"+"}", _neturl.QueryEscape(parameterToString(linkingEntitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"linkingEntitySetId"+"}", _neturl.PathEscape(parameterToString(linkingEntitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1399,15 +1300,6 @@ func (a *EntitySetsApiService) RemoveEntitySetsFromLinkingEntitySets(ctx _contex body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1442,7 +1334,7 @@ func (a *EntitySetsApiService) UpdateEntitySetMetaData(ctx _context.Context, ent // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/all/{entitySetId}/metadata/" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1500,15 +1392,6 @@ func (a *EntitySetsApiService) UpdateEntitySetMetaData(ctx _context.Context, ent body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1542,9 +1425,9 @@ func (a *EntitySetsApiService) UpdateEntitySetPropertyMetadata(ctx _context.Cont // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/entity-sets/all/{entitySetId}/properties/{propertyTypeId}/" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.QueryEscape(parameterToString(propertyTypeId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"propertyTypeId"+"}", _neturl.PathEscape(parameterToString(propertyTypeId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} diff --git a/go/api_linking.go b/go/api_linking.go index 197f030..689c0d4 100644 --- a/go/api_linking.go +++ b/go/api_linking.go @@ -99,15 +99,6 @@ func (a *LinkingApiService) AddLinkingFeedback(ctx _context.Context, linkingFeed body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -197,15 +188,6 @@ func (a *LinkingApiService) DeleteLinkingFeedback(ctx _context.Context, entityKe body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v int32 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -292,15 +274,6 @@ func (a *LinkingApiService) GetAllLinkingFeedback(ctx _context.Context) ([]Entit body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []EntityLinkingFeedback - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -387,15 +360,6 @@ func (a *LinkingApiService) GetAllLinkingFeedbackWithFeatures(ctx _context.Conte body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []EntityLinkingFeatures - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -485,15 +449,6 @@ func (a *LinkingApiService) GetLinkingFeedbackWithFeatures(ctx _context.Context, body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v EntityLinkingFeatures - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -585,15 +540,6 @@ func (a *LinkingApiService) GetLinkingFeedbacksOnEntity(ctx _context.Context, fe body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []EntityLinkingFeedback - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } diff --git a/go/api_organizations.go b/go/api_organizations.go index 32a23ca..7343203 100644 --- a/go/api_organizations.go +++ b/go/api_organizations.go @@ -43,9 +43,9 @@ func (a *OrganizationsApiService) AddMember(ctx _context.Context, organizationId // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/principals/members/{userId}" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", _neturl.QueryEscape(parameterToString(userId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", _neturl.PathEscape(parameterToString(userId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -125,11 +125,11 @@ func (a *OrganizationsApiService) AddRoleToUser(ctx _context.Context, organizati // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/principals/roles/{roleId}/members/{userId}" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"roleId"+"}", _neturl.QueryEscape(parameterToString(roleId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"roleId"+"}", _neturl.PathEscape(parameterToString(roleId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", _neturl.QueryEscape(parameterToString(userId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", _neturl.PathEscape(parameterToString(userId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -210,7 +210,7 @@ func (a *OrganizationsApiService) AssembleEntitySets(ctx _context.Context, organ // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/entity-sets/assemble" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -268,15 +268,6 @@ func (a *OrganizationsApiService) AssembleEntitySets(ctx _context.Context, organ body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string][]string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -366,15 +357,6 @@ func (a *OrganizationsApiService) CreateOrganizationIfNotExists(ctx _context.Con body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -464,15 +446,6 @@ func (a *OrganizationsApiService) CreateRole(ctx _context.Context, role Role) (s body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -505,9 +478,9 @@ func (a *OrganizationsApiService) DeleteRole(ctx _context.Context, organizationI // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/principals/roles/{roleId}" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"roleId"+"}", _neturl.QueryEscape(parameterToString(roleId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"roleId"+"}", _neturl.PathEscape(parameterToString(roleId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -585,7 +558,7 @@ func (a *OrganizationsApiService) DestroyOrganization(ctx _context.Context, orga // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -666,9 +639,9 @@ func (a *OrganizationsApiService) GetAllUsersOfRole(ctx _context.Context, organi // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/principals/roles/{roleId}/members/" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"roleId"+"}", _neturl.QueryEscape(parameterToString(roleId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"roleId"+"}", _neturl.PathEscape(parameterToString(roleId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -724,15 +697,6 @@ func (a *OrganizationsApiService) GetAllUsersOfRole(ctx _context.Context, organi body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []Auth0userBasic - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -766,7 +730,7 @@ func (a *OrganizationsApiService) GetAutoApprovedEmailDomains(ctx _context.Conte // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/email-domains" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -822,15 +786,6 @@ func (a *OrganizationsApiService) GetAutoApprovedEmailDomains(ctx _context.Conte body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -865,7 +820,7 @@ func (a *OrganizationsApiService) GetFlaggedOrganizationEntitySets(ctx _context. // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/entity-sets" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -923,15 +878,6 @@ func (a *OrganizationsApiService) GetFlaggedOrganizationEntitySets(ctx _context. body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []map[string][]string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -965,7 +911,7 @@ func (a *OrganizationsApiService) GetMembers(ctx _context.Context, organizationI // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/principals/members" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1021,15 +967,6 @@ func (a *OrganizationsApiService) GetMembers(ctx _context.Context, organizationI body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []OrganizationMember - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1063,7 +1000,7 @@ func (a *OrganizationsApiService) GetOrganization(ctx _context.Context, organiza // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1119,15 +1056,6 @@ func (a *OrganizationsApiService) GetOrganization(ctx _context.Context, organiza body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v Organization - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1161,7 +1089,7 @@ func (a *OrganizationsApiService) GetOrganizationEntitySets(ctx _context.Context // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/entity-sets" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1217,15 +1145,6 @@ func (a *OrganizationsApiService) GetOrganizationEntitySets(ctx _context.Context body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string][]string - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1259,7 +1178,7 @@ func (a *OrganizationsApiService) GetOrganizationIntegrationAccount(ctx _context // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/integration" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1315,15 +1234,6 @@ func (a *OrganizationsApiService) GetOrganizationIntegrationAccount(ctx _context body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v InlineResponse200 - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1410,15 +1320,6 @@ func (a *OrganizationsApiService) GetOrganizations(ctx _context.Context) ([]Orga body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []Organization - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1453,9 +1354,9 @@ func (a *OrganizationsApiService) GetRole(ctx _context.Context, organizationId s // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/principals/roles/{roleId}" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"roleId"+"}", _neturl.QueryEscape(parameterToString(roleId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"roleId"+"}", _neturl.PathEscape(parameterToString(roleId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1511,15 +1412,6 @@ func (a *OrganizationsApiService) GetRole(ctx _context.Context, organizationId s body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v Role - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1553,7 +1445,7 @@ func (a *OrganizationsApiService) GetRoles(ctx _context.Context, organizationId // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/principals/roles" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1609,15 +1501,6 @@ func (a *OrganizationsApiService) GetRoles(ctx _context.Context, organizationId body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []Role - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1650,9 +1533,9 @@ func (a *OrganizationsApiService) RefreshDataChanges(ctx _context.Context, organ // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/{entitySetId}/refresh" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1731,7 +1614,7 @@ func (a *OrganizationsApiService) RemoveAutoApprovedEmailDomains(ctx _context.Co // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/email-domains" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1812,9 +1695,9 @@ func (a *OrganizationsApiService) RemoveMember(ctx _context.Context, organizatio // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/principals/members/{userId}" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", _neturl.QueryEscape(parameterToString(userId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", _neturl.PathEscape(parameterToString(userId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1894,11 +1777,11 @@ func (a *OrganizationsApiService) RemoveRoleFromUser(ctx _context.Context, organ // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/principals/roles/{roleId}/members/{userId}" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"roleId"+"}", _neturl.QueryEscape(parameterToString(roleId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"roleId"+"}", _neturl.PathEscape(parameterToString(roleId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", _neturl.QueryEscape(parameterToString(userId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", _neturl.PathEscape(parameterToString(userId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1977,7 +1860,7 @@ func (a *OrganizationsApiService) SetAutoApprovedEmailDomain(ctx _context.Contex // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/email-domains" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -2058,9 +1941,9 @@ func (a *OrganizationsApiService) SynchronizeEdmChanges(ctx _context.Context, or // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/{entitySetId}/synchronize" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -2139,7 +2022,7 @@ func (a *OrganizationsApiService) UpdateDescription(ctx _context.Context, organi // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/description" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -2221,9 +2104,9 @@ func (a *OrganizationsApiService) UpdateRoleDescription(ctx _context.Context, or // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/principals/roles/{roleId}/description" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"roleId"+"}", _neturl.QueryEscape(parameterToString(roleId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"roleId"+"}", _neturl.PathEscape(parameterToString(roleId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -2305,9 +2188,9 @@ func (a *OrganizationsApiService) UpdateRoleTitle(ctx _context.Context, organiza // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/principals/roles/{roleId}/title" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"roleId"+"}", _neturl.QueryEscape(parameterToString(roleId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"roleId"+"}", _neturl.PathEscape(parameterToString(roleId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -2388,7 +2271,7 @@ func (a *OrganizationsApiService) UpdateTitle(ctx _context.Context, organization // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/organizations/{organizationId}/title" - localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.QueryEscape(parameterToString(organizationId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"organizationId"+"}", _neturl.PathEscape(parameterToString(organizationId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} diff --git a/go/api_permissions.go b/go/api_permissions.go index 483faa1..a8d2c75 100644 --- a/go/api_permissions.go +++ b/go/api_permissions.go @@ -99,15 +99,6 @@ func (a *PermissionsApiService) GetAcl(ctx _context.Context, requestBody []strin body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v Acl - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } diff --git a/go/api_principal.go b/go/api_principal.go index e5c936c..d340293 100644 --- a/go/api_principal.go +++ b/go/api_principal.go @@ -97,15 +97,6 @@ func (a *PrincipalApiService) GetAllUsers(ctx _context.Context) (map[string]Auth body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string]Auth0userBasic - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -192,15 +183,6 @@ func (a *PrincipalApiService) GetCurrentRoles(ctx _context.Context) ([]Securable body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []SecurablePrincipal - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -287,15 +269,6 @@ func (a *PrincipalApiService) GetMaterializedViewAccount(ctx _context.Context) ( body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v MaterializedViewAccount - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -329,7 +302,7 @@ func (a *PrincipalApiService) GetUser(ctx _context.Context, userId string) (Auth // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/principals/users/{userId}" - localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", _neturl.QueryEscape(parameterToString(userId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"userId"+"}", _neturl.PathEscape(parameterToString(userId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -385,15 +358,6 @@ func (a *PrincipalApiService) GetUser(ctx _context.Context, userId string) (Auth body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v Auth0userBasic - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -427,7 +391,7 @@ func (a *PrincipalApiService) SearchAllUsers(ctx _context.Context, searchQuery s // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/principals/users/search/"{searchQuery}"" - localVarPath = strings.Replace(localVarPath, "{"+"searchQuery"+"}", _neturl.QueryEscape(parameterToString(searchQuery, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"searchQuery"+"}", _neturl.PathEscape(parameterToString(searchQuery, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -483,15 +447,6 @@ func (a *PrincipalApiService) SearchAllUsers(ctx _context.Context, searchQuery s body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string]Auth0userBasic - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -525,7 +480,7 @@ func (a *PrincipalApiService) SearchAllUsersByEmail(ctx _context.Context, emailA // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/principals/users/search/email/"{emailAddress}"" - localVarPath = strings.Replace(localVarPath, "{"+"emailAddress"+"}", _neturl.QueryEscape(parameterToString(emailAddress, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"emailAddress"+"}", _neturl.PathEscape(parameterToString(emailAddress, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -581,15 +536,6 @@ func (a *PrincipalApiService) SearchAllUsersByEmail(ctx _context.Context, emailA body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string]Auth0userBasic - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } diff --git a/go/api_search.go b/go/api_search.go index f17507c..bd344d2 100644 --- a/go/api_search.go +++ b/go/api_search.go @@ -45,7 +45,7 @@ func (a *SearchApiService) ExecuteAdvancedEntitySetDataQuery(ctx _context.Contex // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/search/advanced/{entitySetId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -103,15 +103,6 @@ func (a *SearchApiService) ExecuteAdvancedEntitySetDataQuery(ctx _context.Contex body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v DataSearchResult - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -201,15 +192,6 @@ func (a *SearchApiService) ExecuteAppSearch(ctx _context.Context, searchTerm Sea body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v SearchResult - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -299,15 +281,6 @@ func (a *SearchApiService) ExecuteAppTypeSearch(ctx _context.Context, searchTerm body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v SearchResult - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -397,15 +370,6 @@ func (a *SearchApiService) ExecuteAssociationTypeSearch(ctx _context.Context, se body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v SearchResult - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -440,9 +404,9 @@ func (a *SearchApiService) ExecuteEntityNeighborSearch(ctx _context.Context, ent // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/search/{entitySetId}/{entityKeyId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"entityKeyId"+"}", _neturl.QueryEscape(parameterToString(entityKeyId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entityKeyId"+"}", _neturl.PathEscape(parameterToString(entityKeyId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -498,15 +462,6 @@ func (a *SearchApiService) ExecuteEntityNeighborSearch(ctx _context.Context, ent body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []NeighborEntityDetails - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -541,7 +496,7 @@ func (a *SearchApiService) ExecuteEntityNeighborSearchBulk(ctx _context.Context, // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/search/{entitySetId}/neighbors" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -599,15 +554,6 @@ func (a *SearchApiService) ExecuteEntityNeighborSearchBulk(ctx _context.Context, body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string][]NeighborEntityDetails - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -697,15 +643,6 @@ func (a *SearchApiService) ExecuteEntitySetCollectionSearch(ctx _context.Context body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v SearchResult - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -740,7 +677,7 @@ func (a *SearchApiService) ExecuteEntitySetDataQuery(ctx _context.Context, entit // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/search/{entitySetId}" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -798,15 +735,6 @@ func (a *SearchApiService) ExecuteEntitySetDataQuery(ctx _context.Context, entit body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v DataSearchResult - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -896,15 +824,6 @@ func (a *SearchApiService) ExecuteEntitySetKeywordQuery(ctx _context.Context, se body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v SearchResult - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -994,15 +913,6 @@ func (a *SearchApiService) ExecuteEntityTypeCollectionSearch(ctx _context.Contex body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v SearchResult - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1092,15 +1002,6 @@ func (a *SearchApiService) ExecuteEntityTypeSearch(ctx _context.Context, searchT body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v SearchResult - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1190,15 +1091,6 @@ func (a *SearchApiService) ExecuteFQNPropertyTypeSearch(ctx _context.Context, se body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v SearchResult - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1233,7 +1125,7 @@ func (a *SearchApiService) ExecuteFilteredEntityNeighborIdSearch(ctx _context.Co // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/search/{entitySetId}/neighbors/advanced/ids" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1291,15 +1183,6 @@ func (a *SearchApiService) ExecuteFilteredEntityNeighborIdSearch(ctx _context.Co body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string]map[string]map[string][]NeighborEntityIds - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1334,7 +1217,7 @@ func (a *SearchApiService) ExecuteFilteredEntityNeighborSearch(ctx _context.Cont // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/search/{entitySetId}/neighbors/advanced" - localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.QueryEscape(parameterToString(entitySetId, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"entitySetId"+"}", _neturl.PathEscape(parameterToString(entitySetId, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1392,15 +1275,6 @@ func (a *SearchApiService) ExecuteFilteredEntityNeighborSearch(ctx _context.Cont body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v map[string][]NeighborEntityDetails - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1490,15 +1364,6 @@ func (a *SearchApiService) ExecuteOrganizationSearch(ctx _context.Context, searc body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v SearchResult - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1588,15 +1453,6 @@ func (a *SearchApiService) ExecutePropertyTypeSearch(ctx _context.Context, searc body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v SearchResult - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1631,9 +1487,9 @@ func (a *SearchApiService) GetEntitySets(ctx _context.Context, start int32, numR // create path and map variables localVarPath := a.client.cfg.BasePath + "/datastore/search/entity-sets/{start}/{numResults}" - localVarPath = strings.Replace(localVarPath, "{"+"start"+"}", _neturl.QueryEscape(parameterToString(start, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"start"+"}", _neturl.PathEscape(parameterToString(start, "")) , -1) - localVarPath = strings.Replace(localVarPath, "{"+"numResults"+"}", _neturl.QueryEscape(parameterToString(numResults, "")) , -1) + localVarPath = strings.Replace(localVarPath, "{"+"numResults"+"}", _neturl.PathEscape(parameterToString(numResults, "")) , -1) localVarHeaderParams := make(map[string]string) localVarQueryParams := _neturl.Values{} @@ -1689,15 +1545,6 @@ func (a *SearchApiService) GetEntitySets(ctx _context.Context, start int32, numR body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []SearchResult - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1784,15 +1631,6 @@ func (a *SearchApiService) GetPopularEntitySet(ctx _context.Context) ([]EntitySe body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v []EntitySet - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } @@ -1882,15 +1720,6 @@ func (a *SearchApiService) SearchEntitySetData(ctx _context.Context, searchConst body: localVarBody, error: localVarHTTPResponse.Status, } - if localVarHTTPResponse.StatusCode == 200 { - var v DataSearchResult - err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) - if err != nil { - newErr.error = err.Error() - return localVarReturnValue, localVarHTTPResponse, newErr - } - newErr.model = v - } return localVarReturnValue, localVarHTTPResponse, newErr } diff --git a/go/api_shuttle.go b/go/api_shuttle.go new file mode 100644 index 0000000..6b71df6 --- /dev/null +++ b/go/api_shuttle.go @@ -0,0 +1,712 @@ +/* + * OpenLattice API + * + * OpenLattice API + * + * API version: 0.0.1 + * Contact: support@openlattice.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package openlattice + +import ( + _context "context" + _ioutil "io/ioutil" + _nethttp "net/http" + _neturl "net/url" + "strings" +) + +// Linger please +var ( + _ _context.Context +) + +// ShuttleApiService ShuttleApi service +type ShuttleApiService service + +/* +CreateIntegrationDefinition Creates a new integration definition for running recurring integrations + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param integrationName + * @param integration +@return string +*/ +func (a *ShuttleApiService) CreateIntegrationDefinition(ctx _context.Context, integrationName string, integration Integration) (string, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPost + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue string + ) + + // create path and map variables + localVarPath := a.client.cfg.BasePath + "/shuttle/integration/definition/{integrationName}" + localVarPath = strings.Replace(localVarPath, "{"+"integrationName"+"}", _neturl.PathEscape(parameterToString(integrationName, "")) , -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = &integration + if ctx != nil { + // API Key Authentication + if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + r, err := a.client.prepareRequest(ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(r) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +/* +DeleteIntegrationDefinition Replaces any number of fields within an existing integration definition + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param integrationName +*/ +func (a *ShuttleApiService) DeleteIntegrationDefinition(ctx _context.Context, integrationName string) (*_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodDelete + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + ) + + // create path and map variables + localVarPath := a.client.cfg.BasePath + "/shuttle/integration/definition/{integrationName}" + localVarPath = strings.Replace(localVarPath, "{"+"integrationName"+"}", _neturl.PathEscape(parameterToString(integrationName, "")) , -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if ctx != nil { + // API Key Authentication + if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + r, err := a.client.prepareRequest(ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(r) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +/* +DeleteIntegrationJobStatus Deletes an integration job status from the integrationJobs map + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param jobId the unique id of the integration job +*/ +func (a *ShuttleApiService) DeleteIntegrationJobStatus(ctx _context.Context, jobId string) (*_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodDelete + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + ) + + // create path and map variables + localVarPath := a.client.cfg.BasePath + "/shuttle/integration/status/{jobId}" + localVarPath = strings.Replace(localVarPath, "{"+"jobId"+"}", _neturl.PathEscape(parameterToString(jobId, "")) , -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if ctx != nil { + // API Key Authentication + if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + r, err := a.client.prepareRequest(ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(r) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} + +/* +EnqueueIntegration Enqueues an integration on Shuttle Server for a given integration + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param integrationName the name of the integration to be run + * @param integrationKey the unique id used to authenticate an integration run +@return string +*/ +func (a *ShuttleApiService) EnqueueIntegration(ctx _context.Context, integrationName string, integrationKey string) (string, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue string + ) + + // create path and map variables + localVarPath := a.client.cfg.BasePath + "/shuttle/integration/{integrationName}/{integrationKey}" + localVarPath = strings.Replace(localVarPath, "{"+"integrationName"+"}", _neturl.PathEscape(parameterToString(integrationName, "")) , -1) + + localVarPath = strings.Replace(localVarPath, "{"+"integrationKey"+"}", _neturl.PathEscape(parameterToString(integrationKey, "")) , -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if ctx != nil { + // API Key Authentication + if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + r, err := a.client.prepareRequest(ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(r) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +/* +PollAllIntegrations Polls the statuses of all running integrations + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). +@return map[string]IntegrationJob +*/ +func (a *ShuttleApiService) PollAllIntegrations(ctx _context.Context) (map[string]IntegrationJob, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue map[string]IntegrationJob + ) + + // create path and map variables + localVarPath := a.client.cfg.BasePath + "/shuttle/integration/status" + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if ctx != nil { + // API Key Authentication + if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + r, err := a.client.prepareRequest(ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(r) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +/* +PollIntegration Polls the status of an integration + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param jobId the unique id of the integration job +@return string +*/ +func (a *ShuttleApiService) PollIntegration(ctx _context.Context, jobId string) (string, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue string + ) + + // create path and map variables + localVarPath := a.client.cfg.BasePath + "/shuttle/integration/status/{jobId}" + localVarPath = strings.Replace(localVarPath, "{"+"jobId"+"}", _neturl.PathEscape(parameterToString(jobId, "")) , -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if ctx != nil { + // API Key Authentication + if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + r, err := a.client.prepareRequest(ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(r) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +/* +ReadIntegrationDefinition Gets an existing integration definition + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param integrationName +@return Integration +*/ +func (a *ShuttleApiService) ReadIntegrationDefinition(ctx _context.Context, integrationName string) (Integration, *_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodGet + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + localVarReturnValue Integration + ) + + // create path and map variables + localVarPath := a.client.cfg.BasePath + "/shuttle/integration/definition/{integrationName}" + localVarPath = strings.Replace(localVarPath, "{"+"integrationName"+"}", _neturl.PathEscape(parameterToString(integrationName, "")) , -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{"application/json"} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + if ctx != nil { + // API Key Authentication + if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + r, err := a.client.prepareRequest(ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return localVarReturnValue, nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(r) + if err != nil || localVarHTTPResponse == nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarReturnValue, localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type")) + if err != nil { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: err.Error(), + } + return localVarReturnValue, localVarHTTPResponse, newErr + } + + return localVarReturnValue, localVarHTTPResponse, nil +} + +/* +UpdateIntegrationDefinition Replaces any number of fields within an existing integration definition + * @param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). + * @param integrationName + * @param integrationUpdate +*/ +func (a *ShuttleApiService) UpdateIntegrationDefinition(ctx _context.Context, integrationName string, integrationUpdate IntegrationUpdate) (*_nethttp.Response, error) { + var ( + localVarHTTPMethod = _nethttp.MethodPatch + localVarPostBody interface{} + localVarFormFileName string + localVarFileName string + localVarFileBytes []byte + ) + + // create path and map variables + localVarPath := a.client.cfg.BasePath + "/shuttle/integration/definition/{integrationName}" + localVarPath = strings.Replace(localVarPath, "{"+"integrationName"+"}", _neturl.PathEscape(parameterToString(integrationName, "")) , -1) + + localVarHeaderParams := make(map[string]string) + localVarQueryParams := _neturl.Values{} + localVarFormParams := _neturl.Values{} + + // to determine the Content-Type header + localVarHTTPContentTypes := []string{"application/json"} + + // set Content-Type header + localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes) + if localVarHTTPContentType != "" { + localVarHeaderParams["Content-Type"] = localVarHTTPContentType + } + + // to determine the Accept header + localVarHTTPHeaderAccepts := []string{} + + // set Accept header + localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts) + if localVarHTTPHeaderAccept != "" { + localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept + } + // body params + localVarPostBody = &integrationUpdate + if ctx != nil { + // API Key Authentication + if auth, ok := ctx.Value(ContextAPIKey).(APIKey); ok { + var key string + if auth.Prefix != "" { + key = auth.Prefix + " " + auth.Key + } else { + key = auth.Key + } + localVarHeaderParams["Authorization"] = key + } + } + r, err := a.client.prepareRequest(ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, localVarFormFileName, localVarFileName, localVarFileBytes) + if err != nil { + return nil, err + } + + localVarHTTPResponse, err := a.client.callAPI(r) + if err != nil || localVarHTTPResponse == nil { + return localVarHTTPResponse, err + } + + localVarBody, err := _ioutil.ReadAll(localVarHTTPResponse.Body) + localVarHTTPResponse.Body.Close() + if err != nil { + return localVarHTTPResponse, err + } + + if localVarHTTPResponse.StatusCode >= 300 { + newErr := GenericOpenAPIError{ + body: localVarBody, + error: localVarHTTPResponse.Status, + } + return localVarHTTPResponse, newErr + } + + return localVarHTTPResponse, nil +} diff --git a/go/client.go b/go/client.go index a7c5f09..9549378 100644 --- a/go/client.go +++ b/go/client.go @@ -18,6 +18,7 @@ import ( "errors" "fmt" "io" + "io/ioutil" "log" "mime/multipart" "net/http" @@ -73,6 +74,8 @@ type APIClient struct { PrincipalApi *PrincipalApiService SearchApi *SearchApiService + + ShuttleApi *ShuttleApiService } type service struct { @@ -104,6 +107,7 @@ func NewAPIClient(cfg *Configuration) *APIClient { c.PermissionsApi = (*PermissionsApiService)(&c.common) c.PrincipalApi = (*PrincipalApiService)(&c.common) c.SearchApi = (*SearchApiService)(&c.common) + c.ShuttleApi = (*ShuttleApiService)(&c.common) return c } @@ -403,6 +407,15 @@ func (c *APIClient) decode(v interface{}, b []byte, contentType string) (err err *s = string(b) return nil } + if f, ok := v.(**os.File); ok { + *f, err = ioutil.TempFile("", "HttpClientFile") + if err != nil { + return + } + _, err = (*f).Write(b) + _, err = (*f).Seek(0, io.SeekStart) + return + } if xmlCheck.MatchString(contentType) { if err = xml.Unmarshal(b, v); err != nil { return err diff --git a/go/docs/AssociationDefinition.md b/go/docs/AssociationDefinition.md new file mode 100644 index 0000000..1ebde95 --- /dev/null +++ b/go/docs/AssociationDefinition.md @@ -0,0 +1,16 @@ +# AssociationDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Fqn** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**EntitySetName** | **string** | | [optional] +**PropertyDefinitions** | [**map[string]PropertyDefinition**](PropertyDefinition.md) | | [optional] +**UpdateType** | **string** | | [optional] +**Src** | **string** | | [optional] +**Dst** | **string** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/go/docs/CollectionsApi.md b/go/docs/CollectionsApi.md index 5cc1620..414c117 100644 --- a/go/docs/CollectionsApi.md +++ b/go/docs/CollectionsApi.md @@ -12,7 +12,7 @@ Method | HTTP request | Description [**GetAllEntitySetCollections**](CollectionsApi.md#GetAllEntitySetCollections) | **Get** /datastore/collections/entity/set | Returns all EntitySetCollection objects [**GetAllEntityTypeCollections**](CollectionsApi.md#GetAllEntityTypeCollections) | **Get** /datastore/collections/entity/type | Returns all EntityTypeCollection objects [**GetEntitySetCollection**](CollectionsApi.md#GetEntitySetCollection) | **Get** /datastore/collections/entity/set/{entitySetCollectionId} | Returns the EntitySetCollection object for a given id -[**GetEntitySetCollectionsOfType**](CollectionsApi.md#GetEntitySetCollectionsOfType) | **Get** /datastore/collections/entity/type/entity/set/{entitySetCollectionId} | Returns all authorized EntitySetCollections for a given EntityTypeCollection id +[**GetEntitySetCollectionsOfType**](CollectionsApi.md#GetEntitySetCollectionsOfType) | **Get** /datastore/collections/entity/set/entity/type/{entitySetCollectionId} | Returns all authorized EntitySetCollections for a given EntityTypeCollection id [**GetEntityTypeCollection**](CollectionsApi.md#GetEntityTypeCollection) | **Get** /datastore/collections/entity/type/{entityTypeCollectionId} | Returns the EntityTypeCollection object for a given id [**RemoveTypeFromEntityTypeCollectionTemplate**](CollectionsApi.md#RemoveTypeFromEntityTypeCollectionTemplate) | **Delete** /datastore/collections/entity/type/{entityTypeCollectionId}/template/{typeId} | Removes a key from an EntityTypeCollection template [**UpdateEntitySetCollectionMetadata**](CollectionsApi.md#UpdateEntitySetCollectionMetadata) | **Patch** /datastore/collections/entity/set/{entitySetCollectionId} | Updates metadata of the specified EntitySetCollection @@ -23,7 +23,7 @@ Method | HTTP request | Description ## AddTypeToEntityTypeCollectionTemplate -> AddTypeToEntityTypeCollectionTemplate(ctx, entityTypeCollectionId, entityTypeCollection) +> AddTypeToEntityTypeCollectionTemplate(ctx, entityTypeCollectionId, collectionTemplateType) Appends type to template of the specified EntityTypeCollection @@ -34,7 +34,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. **entityTypeCollectionId** | [**string**](.md)| | -**entityTypeCollection** | [**EntityTypeCollection**](EntityTypeCollection.md)| | +**collectionTemplateType** | [**CollectionTemplateType**](CollectionTemplateType.md)| | ### Return type diff --git a/go/docs/DataApi.md b/go/docs/DataApi.md index ebc9182..4c3bdd9 100644 --- a/go/docs/DataApi.md +++ b/go/docs/DataApi.md @@ -11,7 +11,7 @@ Method | HTTP request | Description [**DeleteAllEntitiesFromEntitySet**](DataApi.md#DeleteAllEntitiesFromEntitySet) | **Delete** /datastore/data/set/{entitySetId}/all | Clears the Entity matching the given Entity id and all of its neighbor Entities [**DeleteEntities**](DataApi.md#DeleteEntities) | **Delete** /datastore/data/set/{entitySetId} | Deletes multiple entities from an entity set. [**DeleteEntitiesAndNeighbors**](DataApi.md#DeleteEntitiesAndNeighbors) | **Post** /datastore/data/set/{entitySetId}/neighbors | Deletes the entities matching the given entity ids and all of its neighbor entities provided in the filter. -[**DeleteEntity**](DataApi.md#DeleteEntity) | **Delete** /datastore/data/{entitySetId}/{entityKeyId} | Deletes a single entity from an entity set. +[**DeleteEntity**](DataApi.md#DeleteEntity) | **Delete** /datastore/data/set/{entitySetId}/{entityKeyId} | Deletes a single entity from an entity set. [**DeleteEntityProperties**](DataApi.md#DeleteEntityProperties) | **Delete** /datastore/data/{entitySetId}/{entityKeyId}/properties | Deletes properties from an entity. [**GetEntity**](DataApi.md#GetEntity) | **Get** /datastore/data/{entitySetId}/{entityKeyId} | Loads a single entity by its entityKeyId and entitySetId [**GetEntityPropertyValues**](DataApi.md#GetEntityPropertyValues) | **Get** /datastore/data/{entitySetId}/{entityKeyId}/{propertyTypeId} | Loads property values for a single entity by its entityKeyId, entitySetId and propertyTypeId diff --git a/go/docs/DataAssociation.md b/go/docs/DataAssociation.md index 78c8f40..b94ef76 100644 --- a/go/docs/DataAssociation.md +++ b/go/docs/DataAssociation.md @@ -7,6 +7,10 @@ Name | Type | Description | Notes **SrcEntitySetId** | **string** | the ID of the source entity set | [optional] **SrcEntityIndex** | **string** | The index of an entity | [optional] **SrcEntityKeyId** | **string** | An existing entityKeyId | [optional] +**DstEntitySetId** | **string** | the ID of the dst entity set | [optional] +**DstEntityIndex** | **string** | The index of an entity | [optional] +**DstEntityKeyId** | **string** | An existing entityKeyId | [optional] +**Data** | [**map[string][]string**](array.md) | data | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/go/docs/DataEdgeData.md b/go/docs/DataEdgeData.md index f3d946f..86cc843 100644 --- a/go/docs/DataEdgeData.md +++ b/go/docs/DataEdgeData.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AdditionalProperties** | **[]string** | | [optional] +**AdditionalPropertiesField** | **[]string** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/go/docs/EntityDefinition.md b/go/docs/EntityDefinition.md new file mode 100644 index 0000000..d571531 --- /dev/null +++ b/go/docs/EntityDefinition.md @@ -0,0 +1,14 @@ +# EntityDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Fqn** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**EntitySetName** | **string** | | [optional] +**PropertyDefinitions** | [**map[string]PropertyDefinition**](PropertyDefinition.md) | | [optional] +**UpdateType** | **string** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/go/docs/Flight.md b/go/docs/Flight.md new file mode 100644 index 0000000..ca62e5e --- /dev/null +++ b/go/docs/Flight.md @@ -0,0 +1,15 @@ +# Flight + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | | [optional] +**Tags** | **[]string** | | [optional] +**OrganizationId** | **string** | | [optional] +**EntityDefinitions** | [**map[string]EntityDefinition**](EntityDefinition.md) | | [optional] +**AssociationDefinitions** | [**map[string]AssociationDefinition**](AssociationDefinition.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/go/docs/FlightPlanParameters.md b/go/docs/FlightPlanParameters.md new file mode 100644 index 0000000..d7c6895 --- /dev/null +++ b/go/docs/FlightPlanParameters.md @@ -0,0 +1,15 @@ +# FlightPlanParameters + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Sql** | **string** | the sql query to be used to pull cleaned data from postgres | [optional] +**Src** | **map[string]string** | postgres data source for pulling clean data | [optional] +**SrcPrimaryKeyColumns** | **[]string** | the columns that are primary keys in the cleaned data | [optional] +**Path** | **string** | the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) | [optional] +**Flight** | [**Flight**](Flight.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/go/docs/FlightPlanParametersUpdate.md b/go/docs/FlightPlanParametersUpdate.md new file mode 100644 index 0000000..a8b5dba --- /dev/null +++ b/go/docs/FlightPlanParametersUpdate.md @@ -0,0 +1,14 @@ +# FlightPlanParametersUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Sql** | **string** | the sql query to be used to pull cleaned data from postgres | [optional] +**Src** | **map[string]string** | postgres data source for pulling clean data | [optional] +**SrcPrimaryKeyColumns** | **[]string** | the columns that are primary keys in the cleaned data | [optional] +**Path** | **string** | the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/go/docs/InlineObject.md b/go/docs/InlineObject.md index 24f8e83..70ff18a 100644 --- a/go/docs/InlineObject.md +++ b/go/docs/InlineObject.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**AdditionalProperties** | [**[]DataEdge**](DataEdge.md) | | [optional] +**AdditionalPropertiesField** | [**[]DataEdge**](DataEdge.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/go/docs/Integration.md b/go/docs/Integration.md new file mode 100644 index 0000000..9d04321 --- /dev/null +++ b/go/docs/Integration.md @@ -0,0 +1,19 @@ +# Integration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Key** | **string** | a unique ID used for authorizing a call to run an integration | [optional] +**Environment** | **string** | the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) | [optional] +**S3Bucket** | **string** | the url of the s3bucket to be used | [optional] +**Contacts** | **[]string** | the set of email addresses of those responsible for the integration | [optional] +**OrganizationId** | **string** | the id of the organization that owns the integration | [optional] +**EntitySetId** | **string** | the id of the entity set that stores the logs for this integration | [optional] +**MaxConnections** | **int32** | maximum number of connections to postgres allowed for this integration | [optional] +**Callback** | **[]string** | urls to receive a POST when integration has completed | [optional] +**FlightPlanParameters** | [**map[string]FlightPlanParameters**](FlightPlanParameters.md) | a map from [Flight] name to [FlightPlanParameters] | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/go/docs/IntegrationJob.md b/go/docs/IntegrationJob.md new file mode 100644 index 0000000..ce2f0d5 --- /dev/null +++ b/go/docs/IntegrationJob.md @@ -0,0 +1,12 @@ +# IntegrationJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Name** | **string** | | [optional] +**Status** | **string** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/go/docs/IntegrationUpdate.md b/go/docs/IntegrationUpdate.md new file mode 100644 index 0000000..8152d28 --- /dev/null +++ b/go/docs/IntegrationUpdate.md @@ -0,0 +1,17 @@ +# IntegrationUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Environment** | **string** | the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) | [optional] +**S3Bucket** | **string** | the url of the s3bucket to be used | [optional] +**Contacts** | **[]string** | the set of email addresses of those responsible for the integration | [optional] +**OrganizationId** | **string** | the id of the organization that owns the integration | [optional] +**MaxConnections** | **int32** | maximum number of connections to postgres allowed for this integration | [optional] +**CallbackUrls** | **[]string** | urls to receive a POST when integration has completed | [optional] +**FlightPlanParameters** | [**map[string]FlightPlanParametersUpdate**](FlightPlanParametersUpdate.md) | a map from [Flight] name to [FlightPlanParametersUpdate] | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/go/docs/PropertyDefinition.md b/go/docs/PropertyDefinition.md new file mode 100644 index 0000000..79911f6 --- /dev/null +++ b/go/docs/PropertyDefinition.md @@ -0,0 +1,12 @@ +# PropertyDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**Type** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**Column** | **string** | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/go/docs/Role.md b/go/docs/Role.md index ed8b28e..75c43ae 100644 --- a/go/docs/Role.md +++ b/go/docs/Role.md @@ -9,7 +9,6 @@ Name | Type | Description | Notes **Principal** | [**Principal**](Principal.md) | | [optional] **Title** | **string** | | [optional] **Description** | **string** | | [optional] -**Class** | **string** | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/go/docs/SearchResult.md b/go/docs/SearchResult.md index 3739249..2c93b31 100644 --- a/go/docs/SearchResult.md +++ b/go/docs/SearchResult.md @@ -5,7 +5,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **NumHits** | **int32** | | [optional] -**Hits** | **map[string]string** | | [optional] +**Hits** | [**[]SearchResultHits**](SearchResult_hits.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/go/docs/SearchResultHits.md b/go/docs/SearchResultHits.md new file mode 100644 index 0000000..a3ebeeb --- /dev/null +++ b/go/docs/SearchResultHits.md @@ -0,0 +1,12 @@ +# SearchResultHits + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**PropertyTypes** | [**[]PropertyType**](PropertyType.md) | | [optional] +**EntitySet** | [**EntitySet**](EntitySet.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/go/docs/ShuttleApi.md b/go/docs/ShuttleApi.md new file mode 100644 index 0000000..6fed349 --- /dev/null +++ b/go/docs/ShuttleApi.md @@ -0,0 +1,271 @@ +# \ShuttleApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**CreateIntegrationDefinition**](ShuttleApi.md#CreateIntegrationDefinition) | **Post** /shuttle/integration/definition/{integrationName} | Creates a new integration definition for running recurring integrations +[**DeleteIntegrationDefinition**](ShuttleApi.md#DeleteIntegrationDefinition) | **Delete** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition +[**DeleteIntegrationJobStatus**](ShuttleApi.md#DeleteIntegrationJobStatus) | **Delete** /shuttle/integration/status/{jobId} | Deletes an integration job status from the integrationJobs map +[**EnqueueIntegration**](ShuttleApi.md#EnqueueIntegration) | **Get** /shuttle/integration/{integrationName}/{integrationKey} | Enqueues an integration on Shuttle Server for a given integration +[**PollAllIntegrations**](ShuttleApi.md#PollAllIntegrations) | **Get** /shuttle/integration/status | Polls the statuses of all running integrations +[**PollIntegration**](ShuttleApi.md#PollIntegration) | **Get** /shuttle/integration/status/{jobId} | Polls the status of an integration +[**ReadIntegrationDefinition**](ShuttleApi.md#ReadIntegrationDefinition) | **Get** /shuttle/integration/definition/{integrationName} | Gets an existing integration definition +[**UpdateIntegrationDefinition**](ShuttleApi.md#UpdateIntegrationDefinition) | **Patch** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition + + + +## CreateIntegrationDefinition + +> string CreateIntegrationDefinition(ctx, integrationName, integration) + +Creates a new integration definition for running recurring integrations + +### Required Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**integrationName** | **string**| | +**integration** | [**Integration**](Integration.md)| | + +### Return type + +**string** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteIntegrationDefinition + +> DeleteIntegrationDefinition(ctx, integrationName) + +Replaces any number of fields within an existing integration definition + +### Required Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**integrationName** | **string**| | + +### Return type + + (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteIntegrationJobStatus + +> DeleteIntegrationJobStatus(ctx, jobId) + +Deletes an integration job status from the integrationJobs map + +### Required Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**jobId** | [**string**](.md)| the unique id of the integration job | + +### Return type + + (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## EnqueueIntegration + +> string EnqueueIntegration(ctx, integrationName, integrationKey) + +Enqueues an integration on Shuttle Server for a given integration + +### Required Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**integrationName** | **string**| the name of the integration to be run | +**integrationKey** | [**string**](.md)| the unique id used to authenticate an integration run | + +### Return type + +**string** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## PollAllIntegrations + +> map[string]IntegrationJob PollAllIntegrations(ctx, ) + +Polls the statuses of all running integrations + +### Required Parameters + +This endpoint does not need any parameter. + +### Return type + +[**map[string]IntegrationJob**](IntegrationJob.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## PollIntegration + +> string PollIntegration(ctx, jobId) + +Polls the status of an integration + +### Required Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**jobId** | [**string**](.md)| the unique id of the integration job | + +### Return type + +**string** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## ReadIntegrationDefinition + +> Integration ReadIntegrationDefinition(ctx, integrationName) + +Gets an existing integration definition + +### Required Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**integrationName** | **string**| | + +### Return type + +[**Integration**](Integration.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateIntegrationDefinition + +> UpdateIntegrationDefinition(ctx, integrationName, integrationUpdate) + +Replaces any number of fields within an existing integration definition + +### Required Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**integrationName** | **string**| | +**integrationUpdate** | [**IntegrationUpdate**](IntegrationUpdate.md)| | + +### Return type + + (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + diff --git a/go/model_association_definition.go b/go/model_association_definition.go new file mode 100644 index 0000000..ffb3a8c --- /dev/null +++ b/go/model_association_definition.go @@ -0,0 +1,20 @@ +/* + * OpenLattice API + * + * OpenLattice API + * + * API version: 0.0.1 + * Contact: support@openlattice.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package openlattice +// AssociationDefinition struct for AssociationDefinition +type AssociationDefinition struct { + Fqn FullQualifiedName `json:"fqn,omitempty"` + EntitySetName string `json:"entitySetName,omitempty"` + PropertyDefinitions map[string]PropertyDefinition `json:"propertyDefinitions,omitempty"` + UpdateType string `json:"updateType,omitempty"` + Src string `json:"src,omitempty"` + Dst string `json:"dst,omitempty"` +} diff --git a/go/model_data_association.go b/go/model_data_association.go index ba0148d..7347f4c 100644 --- a/go/model_data_association.go +++ b/go/model_data_association.go @@ -17,4 +17,12 @@ type DataAssociation struct { SrcEntityIndex string `json:"srcEntityIndex,omitempty"` // An existing entityKeyId SrcEntityKeyId string `json:"srcEntityKeyId,omitempty"` + // the ID of the dst entity set + DstEntitySetId string `json:"dstEntitySetId,omitempty"` + // The index of an entity + DstEntityIndex string `json:"dstEntityIndex,omitempty"` + // An existing entityKeyId + DstEntityKeyId string `json:"dstEntityKeyId,omitempty"` + // data + Data map[string][]string `json:"data,omitempty"` } diff --git a/go/model_data_edge_data.go b/go/model_data_edge_data.go index 545dce6..135d1e6 100644 --- a/go/model_data_edge_data.go +++ b/go/model_data_edge_data.go @@ -11,5 +11,5 @@ package openlattice // DataEdgeData struct for DataEdgeData type DataEdgeData struct { - AdditionalProperties []string `json:"additionalProperties,omitempty"` + AdditionalPropertiesField []string `json:"additionalProperties,omitempty"` } diff --git a/go/model_entity_definition.go b/go/model_entity_definition.go new file mode 100644 index 0000000..1076d77 --- /dev/null +++ b/go/model_entity_definition.go @@ -0,0 +1,18 @@ +/* + * OpenLattice API + * + * OpenLattice API + * + * API version: 0.0.1 + * Contact: support@openlattice.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package openlattice +// EntityDefinition struct for EntityDefinition +type EntityDefinition struct { + Fqn FullQualifiedName `json:"fqn,omitempty"` + EntitySetName string `json:"entitySetName,omitempty"` + PropertyDefinitions map[string]PropertyDefinition `json:"propertyDefinitions,omitempty"` + UpdateType string `json:"updateType,omitempty"` +} diff --git a/go/model_flight.go b/go/model_flight.go new file mode 100644 index 0000000..296eff9 --- /dev/null +++ b/go/model_flight.go @@ -0,0 +1,19 @@ +/* + * OpenLattice API + * + * OpenLattice API + * + * API version: 0.0.1 + * Contact: support@openlattice.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package openlattice +// Flight struct for Flight +type Flight struct { + Name string `json:"name,omitempty"` + Tags []string `json:"tags,omitempty"` + OrganizationId string `json:"organizationId,omitempty"` + EntityDefinitions map[string]EntityDefinition `json:"entityDefinitions,omitempty"` + AssociationDefinitions map[string]AssociationDefinition `json:"associationDefinitions,omitempty"` +} diff --git a/go/model_flight_plan_parameters.go b/go/model_flight_plan_parameters.go new file mode 100644 index 0000000..ef0489a --- /dev/null +++ b/go/model_flight_plan_parameters.go @@ -0,0 +1,23 @@ +/* + * OpenLattice API + * + * OpenLattice API + * + * API version: 0.0.1 + * Contact: support@openlattice.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package openlattice +// FlightPlanParameters Represents the parameters required to create a flight plan (i.e. a Map) +type FlightPlanParameters struct { + // the sql query to be used to pull cleaned data from postgres + Sql string `json:"sql,omitempty"` + // postgres data source for pulling clean data + Src map[string]string `json:"src,omitempty"` + // the columns that are primary keys in the cleaned data + SrcPrimaryKeyColumns []string `json:"srcPrimaryKeyColumns,omitempty"` + // the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) + Path string `json:"path,omitempty"` + Flight Flight `json:"flight,omitempty"` +} diff --git a/go/model_flight_plan_parameters_update.go b/go/model_flight_plan_parameters_update.go new file mode 100644 index 0000000..7e9275f --- /dev/null +++ b/go/model_flight_plan_parameters_update.go @@ -0,0 +1,22 @@ +/* + * OpenLattice API + * + * OpenLattice API + * + * API version: 0.0.1 + * Contact: support@openlattice.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package openlattice +// FlightPlanParametersUpdate struct for FlightPlanParametersUpdate +type FlightPlanParametersUpdate struct { + // the sql query to be used to pull cleaned data from postgres + Sql string `json:"sql,omitempty"` + // postgres data source for pulling clean data + Src map[string]string `json:"src,omitempty"` + // the columns that are primary keys in the cleaned data + SrcPrimaryKeyColumns []string `json:"srcPrimaryKeyColumns,omitempty"` + // the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) + Path string `json:"path,omitempty"` +} diff --git a/go/model_inline_object.go b/go/model_inline_object.go index c546792..37d3097 100644 --- a/go/model_inline_object.go +++ b/go/model_inline_object.go @@ -11,5 +11,5 @@ package openlattice // InlineObject Set of associations to create. Keys are association entity set ids and values for each keys are the data to be created. AssociationEntityId's are not generated based on the key. type InlineObject struct { - AdditionalProperties []DataEdge `json:"additionalProperties,omitempty"` + AdditionalPropertiesField []DataEdge `json:"additionalProperties,omitempty"` } diff --git a/go/model_integration.go b/go/model_integration.go new file mode 100644 index 0000000..16984f3 --- /dev/null +++ b/go/model_integration.go @@ -0,0 +1,32 @@ +/* + * OpenLattice API + * + * OpenLattice API + * + * API version: 0.0.1 + * Contact: support@openlattice.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package openlattice +// Integration Represents a data integration, including all fields required to run the integration. +type Integration struct { + // a unique ID used for authorizing a call to run an integration + Key string `json:"key,omitempty"` + // the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) + Environment string `json:"environment,omitempty"` + // the url of the s3bucket to be used + S3Bucket string `json:"s3Bucket,omitempty"` + // the set of email addresses of those responsible for the integration + Contacts []string `json:"contacts,omitempty"` + // the id of the organization that owns the integration + OrganizationId string `json:"organizationId,omitempty"` + // the id of the entity set that stores the logs for this integration + EntitySetId string `json:"entitySetId,omitempty"` + // maximum number of connections to postgres allowed for this integration + MaxConnections int32 `json:"maxConnections,omitempty"` + // urls to receive a POST when integration has completed + Callback []string `json:"callback,omitempty"` + // a map from [Flight] name to [FlightPlanParameters] + FlightPlanParameters map[string]FlightPlanParameters `json:"flightPlanParameters,omitempty"` +} diff --git a/go/model_integration_job.go b/go/model_integration_job.go new file mode 100644 index 0000000..a2a740c --- /dev/null +++ b/go/model_integration_job.go @@ -0,0 +1,16 @@ +/* + * OpenLattice API + * + * OpenLattice API + * + * API version: 0.0.1 + * Contact: support@openlattice.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package openlattice +// IntegrationJob struct for IntegrationJob +type IntegrationJob struct { + Name string `json:"name,omitempty"` + Status string `json:"status,omitempty"` +} diff --git a/go/model_integration_update.go b/go/model_integration_update.go new file mode 100644 index 0000000..07e8b06 --- /dev/null +++ b/go/model_integration_update.go @@ -0,0 +1,28 @@ +/* + * OpenLattice API + * + * OpenLattice API + * + * API version: 0.0.1 + * Contact: support@openlattice.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package openlattice +// IntegrationUpdate struct for IntegrationUpdate +type IntegrationUpdate struct { + // the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) + Environment string `json:"environment,omitempty"` + // the url of the s3bucket to be used + S3Bucket string `json:"s3Bucket,omitempty"` + // the set of email addresses of those responsible for the integration + Contacts []string `json:"contacts,omitempty"` + // the id of the organization that owns the integration + OrganizationId string `json:"organizationId,omitempty"` + // maximum number of connections to postgres allowed for this integration + MaxConnections int32 `json:"maxConnections,omitempty"` + // urls to receive a POST when integration has completed + CallbackUrls []string `json:"callbackUrls,omitempty"` + // a map from [Flight] name to [FlightPlanParametersUpdate] + FlightPlanParameters map[string]FlightPlanParametersUpdate `json:"flightPlanParameters,omitempty"` +} diff --git a/go/model_property_definition.go b/go/model_property_definition.go new file mode 100644 index 0000000..a09ad2f --- /dev/null +++ b/go/model_property_definition.go @@ -0,0 +1,16 @@ +/* + * OpenLattice API + * + * OpenLattice API + * + * API version: 0.0.1 + * Contact: support@openlattice.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package openlattice +// PropertyDefinition struct for PropertyDefinition +type PropertyDefinition struct { + Type FullQualifiedName `json:"type,omitempty"` + Column string `json:"column,omitempty"` +} diff --git a/go/model_role.go b/go/model_role.go index d53207b..2958a3f 100644 --- a/go/model_role.go +++ b/go/model_role.go @@ -16,5 +16,4 @@ type Role struct { Principal Principal `json:"principal,omitempty"` Title string `json:"title,omitempty"` Description string `json:"description,omitempty"` - Class string `json:"@class,omitempty"` } diff --git a/go/model_search_result.go b/go/model_search_result.go index 82ace69..4f7d781 100644 --- a/go/model_search_result.go +++ b/go/model_search_result.go @@ -9,8 +9,8 @@ */ package openlattice -// SearchResult A search result object, containing the total number of hits for the given query, and the hits themselves. +// SearchResult struct for SearchResult type SearchResult struct { NumHits int32 `json:"numHits,omitempty"` - Hits map[string]string `json:"hits,omitempty"` + Hits []SearchResultHits `json:"hits,omitempty"` } diff --git a/go/model_search_result_hits.go b/go/model_search_result_hits.go new file mode 100644 index 0000000..8d6e544 --- /dev/null +++ b/go/model_search_result_hits.go @@ -0,0 +1,16 @@ +/* + * OpenLattice API + * + * OpenLattice API + * + * API version: 0.0.1 + * Contact: support@openlattice.com + * Generated by: OpenAPI Generator (https://openapi-generator.tech) + */ + +package openlattice +// SearchResultHits struct for SearchResultHits +type SearchResultHits struct { + PropertyTypes []PropertyType `json:"propertyTypes,omitempty"` + EntitySet EntitySet `json:"entitySet,omitempty"` +} diff --git a/javascript/.openapi-generator/FILES b/javascript/.openapi-generator/FILES new file mode 100644 index 0000000..1f061f2 --- /dev/null +++ b/javascript/.openapi-generator/FILES @@ -0,0 +1,282 @@ +.babelrc +.openapi-generator-ignore +.travis.yml +README.md +docs/AccessCheck.md +docs/Ace.md +docs/Acl.md +docs/AclData.md +docs/AdminApi.md +docs/AdvancedSearch.md +docs/Association.md +docs/AssociationDefinition.md +docs/AssociationType.md +docs/Auth0userBasic.md +docs/Authorization.md +docs/AuthorizationsApi.md +docs/AuthorizedObjectsSearchResult.md +docs/BulkDataCreation.md +docs/CollectionTemplateType.md +docs/CollectionsApi.md +docs/Constraint.md +docs/ConstraintGroup.md +docs/DataApi.md +docs/DataAssociation.md +docs/DataEdge.md +docs/DataEdgeData.md +docs/DataEdgeKey.md +docs/DataGraph.md +docs/DataGraphIds.md +docs/DataIntegrationsApi.md +docs/DataSearchResult.md +docs/DatasetApi.md +docs/EDM.md +docs/EDMdiff.md +docs/EdmApi.md +docs/EdmRequest.md +docs/Entity.md +docs/EntityDataKey.md +docs/EntityDefinition.md +docs/EntityKey.md +docs/EntityKeyPair.md +docs/EntityLinkingFeatures.md +docs/EntityLinkingFeedback.md +docs/EntityNeighborsFilter.md +docs/EntitySet.md +docs/EntitySetCollection.md +docs/EntitySetPropertyMetaData.md +docs/EntitySetSelection.md +docs/EntitySetsApi.md +docs/EntityType.md +docs/EntityTypeCollection.md +docs/EntityTypePropertyMetadata.md +docs/Flight.md +docs/FlightPlanParameters.md +docs/FlightPlanParametersUpdate.md +docs/FullQualifiedName.md +docs/IndexingState.md +docs/InlineObject.md +docs/InlineResponse200.md +docs/Integration.md +docs/IntegrationJob.md +docs/IntegrationResults.md +docs/IntegrationUpdate.md +docs/LinkingApi.md +docs/LinkingFeedback.md +docs/MaterializedViewAccount.md +docs/MetadataUpdate.md +docs/NeighborEntityDetails.md +docs/NeighborEntityIds.md +docs/NeighborSearchFilter.md +docs/Organization.md +docs/OrganizationExternalDatabaseColumn.md +docs/OrganizationExternalDatabaseTable.md +docs/OrganizationExternalDatabaseTableColumnsPair.md +docs/OrganizationMember.md +docs/OrganizationsApi.md +docs/PermissionsApi.md +docs/Principal.md +docs/PrincipalApi.md +docs/PropertyDefinition.md +docs/PropertyType.md +docs/PropertyUsageSummary.md +docs/Role.md +docs/Schema.md +docs/Search.md +docs/SearchApi.md +docs/SearchConstraints.md +docs/SearchDetails.md +docs/SearchResult.md +docs/SearchResultHits.md +docs/SearchTerm.md +docs/SecurablePrincipal.md +docs/ShuttleApi.md +docs/SmsEntitySetInformation.md +docs/SortDefinition.md +git_push.sh +mocha.opts +package.json +src/ApiClient.js +src/api/AdminApi.js +src/api/AuthorizationsApi.js +src/api/CollectionsApi.js +src/api/DataApi.js +src/api/DataIntegrationsApi.js +src/api/DatasetApi.js +src/api/EdmApi.js +src/api/EntitySetsApi.js +src/api/LinkingApi.js +src/api/OrganizationsApi.js +src/api/PermissionsApi.js +src/api/PrincipalApi.js +src/api/SearchApi.js +src/api/ShuttleApi.js +src/index.js +src/model/AccessCheck.js +src/model/Ace.js +src/model/Acl.js +src/model/AclData.js +src/model/AdvancedSearch.js +src/model/Association.js +src/model/AssociationDefinition.js +src/model/AssociationType.js +src/model/Auth0userBasic.js +src/model/Authorization.js +src/model/AuthorizedObjectsSearchResult.js +src/model/BulkDataCreation.js +src/model/CollectionTemplateType.js +src/model/Constraint.js +src/model/ConstraintGroup.js +src/model/DataAssociation.js +src/model/DataEdge.js +src/model/DataEdgeData.js +src/model/DataEdgeKey.js +src/model/DataGraph.js +src/model/DataGraphIds.js +src/model/DataSearchResult.js +src/model/EDM.js +src/model/EDMdiff.js +src/model/EdmRequest.js +src/model/Entity.js +src/model/EntityDataKey.js +src/model/EntityDefinition.js +src/model/EntityKey.js +src/model/EntityKeyPair.js +src/model/EntityLinkingFeatures.js +src/model/EntityLinkingFeedback.js +src/model/EntityNeighborsFilter.js +src/model/EntitySet.js +src/model/EntitySetCollection.js +src/model/EntitySetPropertyMetaData.js +src/model/EntitySetSelection.js +src/model/EntityType.js +src/model/EntityTypeCollection.js +src/model/EntityTypePropertyMetadata.js +src/model/Flight.js +src/model/FlightPlanParameters.js +src/model/FlightPlanParametersUpdate.js +src/model/FullQualifiedName.js +src/model/IndexingState.js +src/model/InlineObject.js +src/model/InlineResponse200.js +src/model/Integration.js +src/model/IntegrationJob.js +src/model/IntegrationResults.js +src/model/IntegrationUpdate.js +src/model/LinkingFeedback.js +src/model/MaterializedViewAccount.js +src/model/MetadataUpdate.js +src/model/NeighborEntityDetails.js +src/model/NeighborEntityIds.js +src/model/NeighborSearchFilter.js +src/model/Organization.js +src/model/OrganizationExternalDatabaseColumn.js +src/model/OrganizationExternalDatabaseTable.js +src/model/OrganizationExternalDatabaseTableColumnsPair.js +src/model/OrganizationMember.js +src/model/Principal.js +src/model/PropertyDefinition.js +src/model/PropertyType.js +src/model/PropertyUsageSummary.js +src/model/Role.js +src/model/Schema.js +src/model/Search.js +src/model/SearchConstraints.js +src/model/SearchDetails.js +src/model/SearchResult.js +src/model/SearchResultHits.js +src/model/SearchTerm.js +src/model/SecurablePrincipal.js +src/model/SmsEntitySetInformation.js +src/model/SortDefinition.js +test/api/AdminApi.spec.js +test/api/AuthorizationsApi.spec.js +test/api/CollectionsApi.spec.js +test/api/DataApi.spec.js +test/api/DataIntegrationsApi.spec.js +test/api/DatasetApi.spec.js +test/api/EdmApi.spec.js +test/api/EntitySetsApi.spec.js +test/api/LinkingApi.spec.js +test/api/OrganizationsApi.spec.js +test/api/PermissionsApi.spec.js +test/api/PrincipalApi.spec.js +test/api/SearchApi.spec.js +test/api/ShuttleApi.spec.js +test/model/AccessCheck.spec.js +test/model/Ace.spec.js +test/model/Acl.spec.js +test/model/AclData.spec.js +test/model/AdvancedSearch.spec.js +test/model/Association.spec.js +test/model/AssociationDefinition.spec.js +test/model/AssociationType.spec.js +test/model/Auth0userBasic.spec.js +test/model/Authorization.spec.js +test/model/AuthorizedObjectsSearchResult.spec.js +test/model/BulkDataCreation.spec.js +test/model/CollectionTemplateType.spec.js +test/model/Constraint.spec.js +test/model/ConstraintGroup.spec.js +test/model/DataAssociation.spec.js +test/model/DataEdge.spec.js +test/model/DataEdgeData.spec.js +test/model/DataEdgeKey.spec.js +test/model/DataGraph.spec.js +test/model/DataGraphIds.spec.js +test/model/DataSearchResult.spec.js +test/model/EDM.spec.js +test/model/EDMdiff.spec.js +test/model/EdmRequest.spec.js +test/model/Entity.spec.js +test/model/EntityDataKey.spec.js +test/model/EntityDefinition.spec.js +test/model/EntityKey.spec.js +test/model/EntityKeyPair.spec.js +test/model/EntityLinkingFeatures.spec.js +test/model/EntityLinkingFeedback.spec.js +test/model/EntityNeighborsFilter.spec.js +test/model/EntitySet.spec.js +test/model/EntitySetCollection.spec.js +test/model/EntitySetPropertyMetaData.spec.js +test/model/EntitySetSelection.spec.js +test/model/EntityType.spec.js +test/model/EntityTypeCollection.spec.js +test/model/EntityTypePropertyMetadata.spec.js +test/model/Flight.spec.js +test/model/FlightPlanParameters.spec.js +test/model/FlightPlanParametersUpdate.spec.js +test/model/FullQualifiedName.spec.js +test/model/IndexingState.spec.js +test/model/InlineObject.spec.js +test/model/InlineResponse200.spec.js +test/model/Integration.spec.js +test/model/IntegrationJob.spec.js +test/model/IntegrationResults.spec.js +test/model/IntegrationUpdate.spec.js +test/model/LinkingFeedback.spec.js +test/model/MaterializedViewAccount.spec.js +test/model/MetadataUpdate.spec.js +test/model/NeighborEntityDetails.spec.js +test/model/NeighborEntityIds.spec.js +test/model/NeighborSearchFilter.spec.js +test/model/Organization.spec.js +test/model/OrganizationExternalDatabaseColumn.spec.js +test/model/OrganizationExternalDatabaseTable.spec.js +test/model/OrganizationExternalDatabaseTableColumnsPair.spec.js +test/model/OrganizationMember.spec.js +test/model/Principal.spec.js +test/model/PropertyDefinition.spec.js +test/model/PropertyType.spec.js +test/model/PropertyUsageSummary.spec.js +test/model/Role.spec.js +test/model/Schema.spec.js +test/model/Search.spec.js +test/model/SearchConstraints.spec.js +test/model/SearchDetails.spec.js +test/model/SearchResult.spec.js +test/model/SearchResultHits.spec.js +test/model/SearchTerm.spec.js +test/model/SecurablePrincipal.spec.js +test/model/SmsEntitySetInformation.spec.js +test/model/SortDefinition.spec.js diff --git a/javascript/.openapi-generator/VERSION b/javascript/.openapi-generator/VERSION index bfbf77e..d99e716 100644 --- a/javascript/.openapi-generator/VERSION +++ b/javascript/.openapi-generator/VERSION @@ -1 +1 @@ -4.3.0-SNAPSHOT \ No newline at end of file +5.0.0-SNAPSHOT \ No newline at end of file diff --git a/javascript/README.md b/javascript/README.md index aa25cc0..95e8e7e 100644 --- a/javascript/README.md +++ b/javascript/README.md @@ -142,7 +142,7 @@ Class | Method | HTTP request | Description *OpenLatticeApi.CollectionsApi* | [**getAllEntitySetCollections**](docs/CollectionsApi.md#getAllEntitySetCollections) | **GET** /datastore/collections/entity/set | Returns all EntitySetCollection objects *OpenLatticeApi.CollectionsApi* | [**getAllEntityTypeCollections**](docs/CollectionsApi.md#getAllEntityTypeCollections) | **GET** /datastore/collections/entity/type | Returns all EntityTypeCollection objects *OpenLatticeApi.CollectionsApi* | [**getEntitySetCollection**](docs/CollectionsApi.md#getEntitySetCollection) | **GET** /datastore/collections/entity/set/{entitySetCollectionId} | Returns the EntitySetCollection object for a given id -*OpenLatticeApi.CollectionsApi* | [**getEntitySetCollectionsOfType**](docs/CollectionsApi.md#getEntitySetCollectionsOfType) | **GET** /datastore/collections/entity/type/entity/set/{entitySetCollectionId} | Returns all authorized EntitySetCollections for a given EntityTypeCollection id +*OpenLatticeApi.CollectionsApi* | [**getEntitySetCollectionsOfType**](docs/CollectionsApi.md#getEntitySetCollectionsOfType) | **GET** /datastore/collections/entity/set/entity/type/{entitySetCollectionId} | Returns all authorized EntitySetCollections for a given EntityTypeCollection id *OpenLatticeApi.CollectionsApi* | [**getEntityTypeCollection**](docs/CollectionsApi.md#getEntityTypeCollection) | **GET** /datastore/collections/entity/type/{entityTypeCollectionId} | Returns the EntityTypeCollection object for a given id *OpenLatticeApi.CollectionsApi* | [**removeTypeFromEntityTypeCollectionTemplate**](docs/CollectionsApi.md#removeTypeFromEntityTypeCollectionTemplate) | **DELETE** /datastore/collections/entity/type/{entityTypeCollectionId}/template/{typeId} | Removes a key from an EntityTypeCollection template *OpenLatticeApi.CollectionsApi* | [**updateEntitySetCollectionMetadata**](docs/CollectionsApi.md#updateEntitySetCollectionMetadata) | **PATCH** /datastore/collections/entity/set/{entitySetCollectionId} | Updates metadata of the specified EntitySetCollection @@ -155,7 +155,7 @@ Class | Method | HTTP request | Description *OpenLatticeApi.DataApi* | [**deleteAllEntitiesFromEntitySet**](docs/DataApi.md#deleteAllEntitiesFromEntitySet) | **DELETE** /datastore/data/set/{entitySetId}/all | Clears the Entity matching the given Entity id and all of its neighbor Entities *OpenLatticeApi.DataApi* | [**deleteEntities**](docs/DataApi.md#deleteEntities) | **DELETE** /datastore/data/set/{entitySetId} | Deletes multiple entities from an entity set. *OpenLatticeApi.DataApi* | [**deleteEntitiesAndNeighbors**](docs/DataApi.md#deleteEntitiesAndNeighbors) | **POST** /datastore/data/set/{entitySetId}/neighbors | Deletes the entities matching the given entity ids and all of its neighbor entities provided in the filter. -*OpenLatticeApi.DataApi* | [**deleteEntity**](docs/DataApi.md#deleteEntity) | **DELETE** /datastore/data/{entitySetId}/{entityKeyId} | Deletes a single entity from an entity set. +*OpenLatticeApi.DataApi* | [**deleteEntity**](docs/DataApi.md#deleteEntity) | **DELETE** /datastore/data/set/{entitySetId}/{entityKeyId} | Deletes a single entity from an entity set. *OpenLatticeApi.DataApi* | [**deleteEntityProperties**](docs/DataApi.md#deleteEntityProperties) | **DELETE** /datastore/data/{entitySetId}/{entityKeyId}/properties | Deletes properties from an entity. *OpenLatticeApi.DataApi* | [**getEntity**](docs/DataApi.md#getEntity) | **GET** /datastore/data/{entitySetId}/{entityKeyId} | Loads a single entity by its entityKeyId and entitySetId *OpenLatticeApi.DataApi* | [**getEntityPropertyValues**](docs/DataApi.md#getEntityPropertyValues) | **GET** /datastore/data/{entitySetId}/{entityKeyId}/{propertyTypeId} | Loads property values for a single entity by its entityKeyId, entitySetId and propertyTypeId @@ -318,6 +318,14 @@ Class | Method | HTTP request | Description *OpenLatticeApi.SearchApi* | [**getEntitySets**](docs/SearchApi.md#getEntitySets) | **GET** /datastore/search/entity-sets/{start}/{numResults} | Executes a search over all existing entity sets to populate the home page. The path parameters instruct which page to return and how large the page should be. *OpenLatticeApi.SearchApi* | [**getPopularEntitySet**](docs/SearchApi.md#getPopularEntitySet) | **GET** /datastore/search/popular | Get the most popular entity sets. *OpenLatticeApi.SearchApi* | [**searchEntitySetData**](docs/SearchApi.md#searchEntitySetData) | **PATCH** /datastore/search | Executes a search over the data of a given entity set to find rows that match the search term +*OpenLatticeApi.ShuttleApi* | [**createIntegrationDefinition**](docs/ShuttleApi.md#createIntegrationDefinition) | **POST** /shuttle/integration/definition/{integrationName} | Creates a new integration definition for running recurring integrations +*OpenLatticeApi.ShuttleApi* | [**deleteIntegrationDefinition**](docs/ShuttleApi.md#deleteIntegrationDefinition) | **DELETE** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition +*OpenLatticeApi.ShuttleApi* | [**deleteIntegrationJobStatus**](docs/ShuttleApi.md#deleteIntegrationJobStatus) | **DELETE** /shuttle/integration/status/{jobId} | Deletes an integration job status from the integrationJobs map +*OpenLatticeApi.ShuttleApi* | [**enqueueIntegration**](docs/ShuttleApi.md#enqueueIntegration) | **GET** /shuttle/integration/{integrationName}/{integrationKey} | Enqueues an integration on Shuttle Server for a given integration +*OpenLatticeApi.ShuttleApi* | [**pollAllIntegrations**](docs/ShuttleApi.md#pollAllIntegrations) | **GET** /shuttle/integration/status | Polls the statuses of all running integrations +*OpenLatticeApi.ShuttleApi* | [**pollIntegration**](docs/ShuttleApi.md#pollIntegration) | **GET** /shuttle/integration/status/{jobId} | Polls the status of an integration +*OpenLatticeApi.ShuttleApi* | [**readIntegrationDefinition**](docs/ShuttleApi.md#readIntegrationDefinition) | **GET** /shuttle/integration/definition/{integrationName} | Gets an existing integration definition +*OpenLatticeApi.ShuttleApi* | [**updateIntegrationDefinition**](docs/ShuttleApi.md#updateIntegrationDefinition) | **PATCH** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition ## Documentation for Models @@ -328,6 +336,7 @@ Class | Method | HTTP request | Description - [OpenLatticeApi.AclData](docs/AclData.md) - [OpenLatticeApi.AdvancedSearch](docs/AdvancedSearch.md) - [OpenLatticeApi.Association](docs/Association.md) + - [OpenLatticeApi.AssociationDefinition](docs/AssociationDefinition.md) - [OpenLatticeApi.AssociationType](docs/AssociationType.md) - [OpenLatticeApi.Auth0userBasic](docs/Auth0userBasic.md) - [OpenLatticeApi.Authorization](docs/Authorization.md) @@ -348,6 +357,7 @@ Class | Method | HTTP request | Description - [OpenLatticeApi.EdmRequest](docs/EdmRequest.md) - [OpenLatticeApi.Entity](docs/Entity.md) - [OpenLatticeApi.EntityDataKey](docs/EntityDataKey.md) + - [OpenLatticeApi.EntityDefinition](docs/EntityDefinition.md) - [OpenLatticeApi.EntityKey](docs/EntityKey.md) - [OpenLatticeApi.EntityKeyPair](docs/EntityKeyPair.md) - [OpenLatticeApi.EntityLinkingFeatures](docs/EntityLinkingFeatures.md) @@ -360,11 +370,17 @@ Class | Method | HTTP request | Description - [OpenLatticeApi.EntityType](docs/EntityType.md) - [OpenLatticeApi.EntityTypeCollection](docs/EntityTypeCollection.md) - [OpenLatticeApi.EntityTypePropertyMetadata](docs/EntityTypePropertyMetadata.md) + - [OpenLatticeApi.Flight](docs/Flight.md) + - [OpenLatticeApi.FlightPlanParameters](docs/FlightPlanParameters.md) + - [OpenLatticeApi.FlightPlanParametersUpdate](docs/FlightPlanParametersUpdate.md) - [OpenLatticeApi.FullQualifiedName](docs/FullQualifiedName.md) - [OpenLatticeApi.IndexingState](docs/IndexingState.md) - [OpenLatticeApi.InlineObject](docs/InlineObject.md) - [OpenLatticeApi.InlineResponse200](docs/InlineResponse200.md) + - [OpenLatticeApi.Integration](docs/Integration.md) + - [OpenLatticeApi.IntegrationJob](docs/IntegrationJob.md) - [OpenLatticeApi.IntegrationResults](docs/IntegrationResults.md) + - [OpenLatticeApi.IntegrationUpdate](docs/IntegrationUpdate.md) - [OpenLatticeApi.LinkingFeedback](docs/LinkingFeedback.md) - [OpenLatticeApi.MaterializedViewAccount](docs/MaterializedViewAccount.md) - [OpenLatticeApi.MetadataUpdate](docs/MetadataUpdate.md) @@ -377,6 +393,7 @@ Class | Method | HTTP request | Description - [OpenLatticeApi.OrganizationExternalDatabaseTableColumnsPair](docs/OrganizationExternalDatabaseTableColumnsPair.md) - [OpenLatticeApi.OrganizationMember](docs/OrganizationMember.md) - [OpenLatticeApi.Principal](docs/Principal.md) + - [OpenLatticeApi.PropertyDefinition](docs/PropertyDefinition.md) - [OpenLatticeApi.PropertyType](docs/PropertyType.md) - [OpenLatticeApi.PropertyUsageSummary](docs/PropertyUsageSummary.md) - [OpenLatticeApi.Role](docs/Role.md) @@ -385,6 +402,7 @@ Class | Method | HTTP request | Description - [OpenLatticeApi.SearchConstraints](docs/SearchConstraints.md) - [OpenLatticeApi.SearchDetails](docs/SearchDetails.md) - [OpenLatticeApi.SearchResult](docs/SearchResult.md) + - [OpenLatticeApi.SearchResultHits](docs/SearchResultHits.md) - [OpenLatticeApi.SearchTerm](docs/SearchTerm.md) - [OpenLatticeApi.SecurablePrincipal](docs/SecurablePrincipal.md) - [OpenLatticeApi.SmsEntitySetInformation](docs/SmsEntitySetInformation.md) diff --git a/javascript/docs/AssociationDefinition.md b/javascript/docs/AssociationDefinition.md new file mode 100644 index 0000000..0a01fa4 --- /dev/null +++ b/javascript/docs/AssociationDefinition.md @@ -0,0 +1,27 @@ +# OpenLatticeApi.AssociationDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fqn** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**entitySetName** | **String** | | [optional] +**propertyDefinitions** | [**{String: PropertyDefinition}**](PropertyDefinition.md) | | [optional] +**updateType** | **String** | | [optional] +**src** | **String** | | [optional] +**dst** | **String** | | [optional] + + + +## Enum: UpdateTypeEnum + + +* `Replace` (value: `"Replace"`) + +* `PartialReplace` (value: `"PartialReplace"`) + +* `Merge` (value: `"Merge"`) + + + + diff --git a/javascript/docs/CollectionsApi.md b/javascript/docs/CollectionsApi.md index b891e38..74c92df 100644 --- a/javascript/docs/CollectionsApi.md +++ b/javascript/docs/CollectionsApi.md @@ -12,7 +12,7 @@ Method | HTTP request | Description [**getAllEntitySetCollections**](CollectionsApi.md#getAllEntitySetCollections) | **GET** /datastore/collections/entity/set | Returns all EntitySetCollection objects [**getAllEntityTypeCollections**](CollectionsApi.md#getAllEntityTypeCollections) | **GET** /datastore/collections/entity/type | Returns all EntityTypeCollection objects [**getEntitySetCollection**](CollectionsApi.md#getEntitySetCollection) | **GET** /datastore/collections/entity/set/{entitySetCollectionId} | Returns the EntitySetCollection object for a given id -[**getEntitySetCollectionsOfType**](CollectionsApi.md#getEntitySetCollectionsOfType) | **GET** /datastore/collections/entity/type/entity/set/{entitySetCollectionId} | Returns all authorized EntitySetCollections for a given EntityTypeCollection id +[**getEntitySetCollectionsOfType**](CollectionsApi.md#getEntitySetCollectionsOfType) | **GET** /datastore/collections/entity/set/entity/type/{entitySetCollectionId} | Returns all authorized EntitySetCollections for a given EntityTypeCollection id [**getEntityTypeCollection**](CollectionsApi.md#getEntityTypeCollection) | **GET** /datastore/collections/entity/type/{entityTypeCollectionId} | Returns the EntityTypeCollection object for a given id [**removeTypeFromEntityTypeCollectionTemplate**](CollectionsApi.md#removeTypeFromEntityTypeCollectionTemplate) | **DELETE** /datastore/collections/entity/type/{entityTypeCollectionId}/template/{typeId} | Removes a key from an EntityTypeCollection template [**updateEntitySetCollectionMetadata**](CollectionsApi.md#updateEntitySetCollectionMetadata) | **PATCH** /datastore/collections/entity/set/{entitySetCollectionId} | Updates metadata of the specified EntitySetCollection @@ -23,7 +23,7 @@ Method | HTTP request | Description ## addTypeToEntityTypeCollectionTemplate -> addTypeToEntityTypeCollectionTemplate(entityTypeCollectionId, entityTypeCollection) +> addTypeToEntityTypeCollectionTemplate(entityTypeCollectionId, collectionTemplateType) Appends type to template of the specified EntityTypeCollection @@ -43,8 +43,8 @@ openlattice_auth.apiKey = 'YOUR API KEY'; let apiInstance = new OpenLatticeApi.CollectionsApi(); let entityTypeCollectionId = null; // String | -let entityTypeCollection = new OpenLatticeApi.EntityTypeCollection(); // EntityTypeCollection | -apiInstance.addTypeToEntityTypeCollectionTemplate(entityTypeCollectionId, entityTypeCollection, (error, data, response) => { +let collectionTemplateType = new OpenLatticeApi.CollectionTemplateType(); // CollectionTemplateType | +apiInstance.addTypeToEntityTypeCollectionTemplate(entityTypeCollectionId, collectionTemplateType, (error, data, response) => { if (error) { console.error(error); } else { @@ -59,7 +59,7 @@ apiInstance.addTypeToEntityTypeCollectionTemplate(entityTypeCollectionId, entity Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **entityTypeCollectionId** | [**String**](.md)| | - **entityTypeCollection** | [**EntityTypeCollection**](EntityTypeCollection.md)| | + **collectionTemplateType** | [**CollectionTemplateType**](CollectionTemplateType.md)| | ### Return type diff --git a/javascript/docs/DataApi.md b/javascript/docs/DataApi.md index 5dc2314..2c17dd1 100644 --- a/javascript/docs/DataApi.md +++ b/javascript/docs/DataApi.md @@ -11,7 +11,7 @@ Method | HTTP request | Description [**deleteAllEntitiesFromEntitySet**](DataApi.md#deleteAllEntitiesFromEntitySet) | **DELETE** /datastore/data/set/{entitySetId}/all | Clears the Entity matching the given Entity id and all of its neighbor Entities [**deleteEntities**](DataApi.md#deleteEntities) | **DELETE** /datastore/data/set/{entitySetId} | Deletes multiple entities from an entity set. [**deleteEntitiesAndNeighbors**](DataApi.md#deleteEntitiesAndNeighbors) | **POST** /datastore/data/set/{entitySetId}/neighbors | Deletes the entities matching the given entity ids and all of its neighbor entities provided in the filter. -[**deleteEntity**](DataApi.md#deleteEntity) | **DELETE** /datastore/data/{entitySetId}/{entityKeyId} | Deletes a single entity from an entity set. +[**deleteEntity**](DataApi.md#deleteEntity) | **DELETE** /datastore/data/set/{entitySetId}/{entityKeyId} | Deletes a single entity from an entity set. [**deleteEntityProperties**](DataApi.md#deleteEntityProperties) | **DELETE** /datastore/data/{entitySetId}/{entityKeyId}/properties | Deletes properties from an entity. [**getEntity**](DataApi.md#getEntity) | **GET** /datastore/data/{entitySetId}/{entityKeyId} | Loads a single entity by its entityKeyId and entitySetId [**getEntityPropertyValues**](DataApi.md#getEntityPropertyValues) | **GET** /datastore/data/{entitySetId}/{entityKeyId}/{propertyTypeId} | Loads property values for a single entity by its entityKeyId, entitySetId and propertyTypeId diff --git a/javascript/docs/DataAssociation.md b/javascript/docs/DataAssociation.md index a61a04b..d443c17 100644 --- a/javascript/docs/DataAssociation.md +++ b/javascript/docs/DataAssociation.md @@ -7,5 +7,9 @@ Name | Type | Description | Notes **srcEntitySetId** | **String** | the ID of the source entity set | [optional] **srcEntityIndex** | **String** | The index of an entity | [optional] **srcEntityKeyId** | **String** | An existing entityKeyId | [optional] +**dstEntitySetId** | **String** | the ID of the dst entity set | [optional] +**dstEntityIndex** | **String** | The index of an entity | [optional] +**dstEntityKeyId** | **String** | An existing entityKeyId | [optional] +**data** | **{String: [String]}** | data | [optional] diff --git a/javascript/docs/EntityDefinition.md b/javascript/docs/EntityDefinition.md new file mode 100644 index 0000000..28f525a --- /dev/null +++ b/javascript/docs/EntityDefinition.md @@ -0,0 +1,25 @@ +# OpenLatticeApi.EntityDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fqn** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**entitySetName** | **String** | | [optional] +**propertyDefinitions** | [**{String: PropertyDefinition}**](PropertyDefinition.md) | | [optional] +**updateType** | **String** | | [optional] + + + +## Enum: UpdateTypeEnum + + +* `Replace` (value: `"Replace"`) + +* `PartialReplace` (value: `"PartialReplace"`) + +* `Merge` (value: `"Merge"`) + + + + diff --git a/javascript/docs/Flight.md b/javascript/docs/Flight.md new file mode 100644 index 0000000..747e9b7 --- /dev/null +++ b/javascript/docs/Flight.md @@ -0,0 +1,13 @@ +# OpenLatticeApi.Flight + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | | [optional] +**tags** | **[String]** | | [optional] +**organizationId** | **String** | | [optional] +**entityDefinitions** | [**{String: EntityDefinition}**](EntityDefinition.md) | | [optional] +**associationDefinitions** | [**{String: AssociationDefinition}**](AssociationDefinition.md) | | [optional] + + diff --git a/javascript/docs/FlightPlanParameters.md b/javascript/docs/FlightPlanParameters.md new file mode 100644 index 0000000..57d5a28 --- /dev/null +++ b/javascript/docs/FlightPlanParameters.md @@ -0,0 +1,13 @@ +# OpenLatticeApi.FlightPlanParameters + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sql** | **String** | the sql query to be used to pull cleaned data from postgres | [optional] +**src** | **{String: String}** | postgres data source for pulling clean data | [optional] +**srcPrimaryKeyColumns** | **[String]** | the columns that are primary keys in the cleaned data | [optional] +**path** | **String** | the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) | [optional] +**flight** | [**Flight**](Flight.md) | | [optional] + + diff --git a/javascript/docs/FlightPlanParametersUpdate.md b/javascript/docs/FlightPlanParametersUpdate.md new file mode 100644 index 0000000..99d4ae3 --- /dev/null +++ b/javascript/docs/FlightPlanParametersUpdate.md @@ -0,0 +1,12 @@ +# OpenLatticeApi.FlightPlanParametersUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sql** | **String** | the sql query to be used to pull cleaned data from postgres | [optional] +**src** | **{String: String}** | postgres data source for pulling clean data | [optional] +**srcPrimaryKeyColumns** | **[String]** | the columns that are primary keys in the cleaned data | [optional] +**path** | **String** | the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) | [optional] + + diff --git a/javascript/docs/Integration.md b/javascript/docs/Integration.md new file mode 100644 index 0000000..eba7e36 --- /dev/null +++ b/javascript/docs/Integration.md @@ -0,0 +1,30 @@ +# OpenLatticeApi.Integration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **String** | a unique ID used for authorizing a call to run an integration | [optional] +**environment** | **String** | the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) | [optional] +**s3Bucket** | **String** | the url of the s3bucket to be used | [optional] +**contacts** | **[String]** | the set of email addresses of those responsible for the integration | [optional] +**organizationId** | **String** | the id of the organization that owns the integration | [optional] +**entitySetId** | **String** | the id of the entity set that stores the logs for this integration | [optional] +**maxConnections** | **Number** | maximum number of connections to postgres allowed for this integration | [optional] +**callback** | **[String]** | urls to receive a POST when integration has completed | [optional] +**flightPlanParameters** | [**{String: FlightPlanParameters}**](FlightPlanParameters.md) | a map from [Flight] name to [FlightPlanParameters] | [optional] + + + +## Enum: EnvironmentEnum + + +* `PROD_INTEGRATION` (value: `"PROD_INTEGRATION"`) + +* `STAGING_INTEGRATION` (value: `"STAGING_INTEGRATION"`) + +* `LOCAL` (value: `"LOCAL"`) + + + + diff --git a/javascript/docs/IntegrationJob.md b/javascript/docs/IntegrationJob.md new file mode 100644 index 0000000..e7c5d40 --- /dev/null +++ b/javascript/docs/IntegrationJob.md @@ -0,0 +1,27 @@ +# OpenLatticeApi.IntegrationJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | | [optional] +**status** | **String** | | [optional] + + + +## Enum: StatusEnum + + +* `IN_PROGRESS` (value: `"IN_PROGRESS"`) + +* `SUCCEEDED` (value: `"SUCCEEDED"`) + +* `FAILED` (value: `"FAILED"`) + +* `QUEUED` (value: `"QUEUED"`) + +* `FAILED_TO_START` (value: `"FAILED_TO_START"`) + + + + diff --git a/javascript/docs/IntegrationUpdate.md b/javascript/docs/IntegrationUpdate.md new file mode 100644 index 0000000..0b99c8e --- /dev/null +++ b/javascript/docs/IntegrationUpdate.md @@ -0,0 +1,28 @@ +# OpenLatticeApi.IntegrationUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**environment** | **String** | the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) | [optional] +**s3Bucket** | **String** | the url of the s3bucket to be used | [optional] +**contacts** | **[String]** | the set of email addresses of those responsible for the integration | [optional] +**organizationId** | **String** | the id of the organization that owns the integration | [optional] +**maxConnections** | **Number** | maximum number of connections to postgres allowed for this integration | [optional] +**callbackUrls** | **[String]** | urls to receive a POST when integration has completed | [optional] +**flightPlanParameters** | [**{String: FlightPlanParametersUpdate}**](FlightPlanParametersUpdate.md) | a map from [Flight] name to [FlightPlanParametersUpdate] | [optional] + + + +## Enum: EnvironmentEnum + + +* `PROD_INTEGRATION` (value: `"PROD_INTEGRATION"`) + +* `STAGING_INTEGRATION` (value: `"STAGING_INTEGRATION"`) + +* `LOCAL` (value: `"LOCAL"`) + + + + diff --git a/javascript/docs/PropertyDefinition.md b/javascript/docs/PropertyDefinition.md new file mode 100644 index 0000000..eceae4d --- /dev/null +++ b/javascript/docs/PropertyDefinition.md @@ -0,0 +1,10 @@ +# OpenLatticeApi.PropertyDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**column** | **String** | | [optional] + + diff --git a/javascript/docs/Role.md b/javascript/docs/Role.md index d8d1b20..be6d3c4 100644 --- a/javascript/docs/Role.md +++ b/javascript/docs/Role.md @@ -9,15 +9,5 @@ Name | Type | Description | Notes **principal** | [**Principal**](Principal.md) | | [optional] **title** | **String** | | [optional] **description** | **String** | | [optional] -**_class** | **String** | | [optional] - - - -## Enum: ClassEnum - - -* `com.openlattice.organization.roles.Role` (value: `"com.openlattice.organization.roles.Role"`) - - diff --git a/javascript/docs/SearchResult.md b/javascript/docs/SearchResult.md index 30bfe02..016e22c 100644 --- a/javascript/docs/SearchResult.md +++ b/javascript/docs/SearchResult.md @@ -5,6 +5,6 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **numHits** | **Number** | | [optional] -**hits** | **{String: String}** | | [optional] +**hits** | [**[SearchResultHits]**](SearchResultHits.md) | | [optional] diff --git a/javascript/docs/SearchResultHits.md b/javascript/docs/SearchResultHits.md new file mode 100644 index 0000000..0f348a0 --- /dev/null +++ b/javascript/docs/SearchResultHits.md @@ -0,0 +1,10 @@ +# OpenLatticeApi.SearchResultHits + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**propertyTypes** | [**[PropertyType]**](PropertyType.md) | | [optional] +**entitySet** | [**EntitySet**](EntitySet.md) | | [optional] + + diff --git a/javascript/docs/ShuttleApi.md b/javascript/docs/ShuttleApi.md new file mode 100644 index 0000000..1151c5b --- /dev/null +++ b/javascript/docs/ShuttleApi.md @@ -0,0 +1,434 @@ +# OpenLatticeApi.ShuttleApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createIntegrationDefinition**](ShuttleApi.md#createIntegrationDefinition) | **POST** /shuttle/integration/definition/{integrationName} | Creates a new integration definition for running recurring integrations +[**deleteIntegrationDefinition**](ShuttleApi.md#deleteIntegrationDefinition) | **DELETE** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition +[**deleteIntegrationJobStatus**](ShuttleApi.md#deleteIntegrationJobStatus) | **DELETE** /shuttle/integration/status/{jobId} | Deletes an integration job status from the integrationJobs map +[**enqueueIntegration**](ShuttleApi.md#enqueueIntegration) | **GET** /shuttle/integration/{integrationName}/{integrationKey} | Enqueues an integration on Shuttle Server for a given integration +[**pollAllIntegrations**](ShuttleApi.md#pollAllIntegrations) | **GET** /shuttle/integration/status | Polls the statuses of all running integrations +[**pollIntegration**](ShuttleApi.md#pollIntegration) | **GET** /shuttle/integration/status/{jobId} | Polls the status of an integration +[**readIntegrationDefinition**](ShuttleApi.md#readIntegrationDefinition) | **GET** /shuttle/integration/definition/{integrationName} | Gets an existing integration definition +[**updateIntegrationDefinition**](ShuttleApi.md#updateIntegrationDefinition) | **PATCH** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition + + + +## createIntegrationDefinition + +> String createIntegrationDefinition(integrationName, integration) + +Creates a new integration definition for running recurring integrations + +### Example + +```javascript +import OpenLatticeApi from 'open_lattice_api'; +let defaultClient = OpenLatticeApi.ApiClient.instance; +// Configure Bearer (JWT) access token for authorization: http_auth +let http_auth = defaultClient.authentications['http_auth']; +http_auth.accessToken = "YOUR ACCESS TOKEN" +// Configure API key authorization: openlattice_auth +let openlattice_auth = defaultClient.authentications['openlattice_auth']; +openlattice_auth.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//openlattice_auth.apiKeyPrefix = 'Token'; + +let apiInstance = new OpenLatticeApi.ShuttleApi(); +let integrationName = "integrationName_example"; // String | +let integration = new OpenLatticeApi.Integration(); // Integration | +apiInstance.createIntegrationDefinition(integrationName, integration, (error, data, response) => { + if (error) { + console.error(error); + } else { + console.log('API called successfully. Returned data: ' + data); + } +}); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integrationName** | **String**| | + **integration** | [**Integration**](Integration.md)| | + +### Return type + +**String** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## deleteIntegrationDefinition + +> deleteIntegrationDefinition(integrationName) + +Replaces any number of fields within an existing integration definition + +### Example + +```javascript +import OpenLatticeApi from 'open_lattice_api'; +let defaultClient = OpenLatticeApi.ApiClient.instance; +// Configure Bearer (JWT) access token for authorization: http_auth +let http_auth = defaultClient.authentications['http_auth']; +http_auth.accessToken = "YOUR ACCESS TOKEN" +// Configure API key authorization: openlattice_auth +let openlattice_auth = defaultClient.authentications['openlattice_auth']; +openlattice_auth.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//openlattice_auth.apiKeyPrefix = 'Token'; + +let apiInstance = new OpenLatticeApi.ShuttleApi(); +let integrationName = "integrationName_example"; // String | +apiInstance.deleteIntegrationDefinition(integrationName, (error, data, response) => { + if (error) { + console.error(error); + } else { + console.log('API called successfully.'); + } +}); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integrationName** | **String**| | + +### Return type + +null (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteIntegrationJobStatus + +> deleteIntegrationJobStatus(jobId) + +Deletes an integration job status from the integrationJobs map + +### Example + +```javascript +import OpenLatticeApi from 'open_lattice_api'; +let defaultClient = OpenLatticeApi.ApiClient.instance; +// Configure Bearer (JWT) access token for authorization: http_auth +let http_auth = defaultClient.authentications['http_auth']; +http_auth.accessToken = "YOUR ACCESS TOKEN" +// Configure API key authorization: openlattice_auth +let openlattice_auth = defaultClient.authentications['openlattice_auth']; +openlattice_auth.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//openlattice_auth.apiKeyPrefix = 'Token'; + +let apiInstance = new OpenLatticeApi.ShuttleApi(); +let jobId = null; // String | the unique id of the integration job +apiInstance.deleteIntegrationJobStatus(jobId, (error, data, response) => { + if (error) { + console.error(error); + } else { + console.log('API called successfully.'); + } +}); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **jobId** | [**String**](.md)| the unique id of the integration job | + +### Return type + +null (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## enqueueIntegration + +> String enqueueIntegration(integrationName, integrationKey) + +Enqueues an integration on Shuttle Server for a given integration + +### Example + +```javascript +import OpenLatticeApi from 'open_lattice_api'; +let defaultClient = OpenLatticeApi.ApiClient.instance; +// Configure Bearer (JWT) access token for authorization: http_auth +let http_auth = defaultClient.authentications['http_auth']; +http_auth.accessToken = "YOUR ACCESS TOKEN" +// Configure API key authorization: openlattice_auth +let openlattice_auth = defaultClient.authentications['openlattice_auth']; +openlattice_auth.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//openlattice_auth.apiKeyPrefix = 'Token'; + +let apiInstance = new OpenLatticeApi.ShuttleApi(); +let integrationName = "integrationName_example"; // String | the name of the integration to be run +let integrationKey = null; // String | the unique id used to authenticate an integration run +apiInstance.enqueueIntegration(integrationName, integrationKey, (error, data, response) => { + if (error) { + console.error(error); + } else { + console.log('API called successfully. Returned data: ' + data); + } +}); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integrationName** | **String**| the name of the integration to be run | + **integrationKey** | [**String**](.md)| the unique id used to authenticate an integration run | + +### Return type + +**String** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## pollAllIntegrations + +> {String: IntegrationJob} pollAllIntegrations() + +Polls the statuses of all running integrations + +### Example + +```javascript +import OpenLatticeApi from 'open_lattice_api'; +let defaultClient = OpenLatticeApi.ApiClient.instance; +// Configure Bearer (JWT) access token for authorization: http_auth +let http_auth = defaultClient.authentications['http_auth']; +http_auth.accessToken = "YOUR ACCESS TOKEN" +// Configure API key authorization: openlattice_auth +let openlattice_auth = defaultClient.authentications['openlattice_auth']; +openlattice_auth.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//openlattice_auth.apiKeyPrefix = 'Token'; + +let apiInstance = new OpenLatticeApi.ShuttleApi(); +apiInstance.pollAllIntegrations((error, data, response) => { + if (error) { + console.error(error); + } else { + console.log('API called successfully. Returned data: ' + data); + } +}); +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**{String: IntegrationJob}**](IntegrationJob.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## pollIntegration + +> String pollIntegration(jobId) + +Polls the status of an integration + +### Example + +```javascript +import OpenLatticeApi from 'open_lattice_api'; +let defaultClient = OpenLatticeApi.ApiClient.instance; +// Configure Bearer (JWT) access token for authorization: http_auth +let http_auth = defaultClient.authentications['http_auth']; +http_auth.accessToken = "YOUR ACCESS TOKEN" +// Configure API key authorization: openlattice_auth +let openlattice_auth = defaultClient.authentications['openlattice_auth']; +openlattice_auth.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//openlattice_auth.apiKeyPrefix = 'Token'; + +let apiInstance = new OpenLatticeApi.ShuttleApi(); +let jobId = null; // String | the unique id of the integration job +apiInstance.pollIntegration(jobId, (error, data, response) => { + if (error) { + console.error(error); + } else { + console.log('API called successfully. Returned data: ' + data); + } +}); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **jobId** | [**String**](.md)| the unique id of the integration job | + +### Return type + +**String** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## readIntegrationDefinition + +> Integration readIntegrationDefinition(integrationName) + +Gets an existing integration definition + +### Example + +```javascript +import OpenLatticeApi from 'open_lattice_api'; +let defaultClient = OpenLatticeApi.ApiClient.instance; +// Configure Bearer (JWT) access token for authorization: http_auth +let http_auth = defaultClient.authentications['http_auth']; +http_auth.accessToken = "YOUR ACCESS TOKEN" +// Configure API key authorization: openlattice_auth +let openlattice_auth = defaultClient.authentications['openlattice_auth']; +openlattice_auth.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//openlattice_auth.apiKeyPrefix = 'Token'; + +let apiInstance = new OpenLatticeApi.ShuttleApi(); +let integrationName = "integrationName_example"; // String | +apiInstance.readIntegrationDefinition(integrationName, (error, data, response) => { + if (error) { + console.error(error); + } else { + console.log('API called successfully. Returned data: ' + data); + } +}); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integrationName** | **String**| | + +### Return type + +[**Integration**](Integration.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## updateIntegrationDefinition + +> updateIntegrationDefinition(integrationName, integrationUpdate) + +Replaces any number of fields within an existing integration definition + +### Example + +```javascript +import OpenLatticeApi from 'open_lattice_api'; +let defaultClient = OpenLatticeApi.ApiClient.instance; +// Configure Bearer (JWT) access token for authorization: http_auth +let http_auth = defaultClient.authentications['http_auth']; +http_auth.accessToken = "YOUR ACCESS TOKEN" +// Configure API key authorization: openlattice_auth +let openlattice_auth = defaultClient.authentications['openlattice_auth']; +openlattice_auth.apiKey = 'YOUR API KEY'; +// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) +//openlattice_auth.apiKeyPrefix = 'Token'; + +let apiInstance = new OpenLatticeApi.ShuttleApi(); +let integrationName = "integrationName_example"; // String | +let integrationUpdate = new OpenLatticeApi.IntegrationUpdate(); // IntegrationUpdate | +apiInstance.updateIntegrationDefinition(integrationName, integrationUpdate, (error, data, response) => { + if (error) { + console.error(error); + } else { + console.log('API called successfully.'); + } +}); +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integrationName** | **String**| | + **integrationUpdate** | [**IntegrationUpdate**](IntegrationUpdate.md)| | + +### Return type + +null (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + diff --git a/javascript/src/api/CollectionsApi.js b/javascript/src/api/CollectionsApi.js index 343ba82..db40fdd 100644 --- a/javascript/src/api/CollectionsApi.js +++ b/javascript/src/api/CollectionsApi.js @@ -13,6 +13,7 @@ import ApiClient from "../ApiClient"; +import CollectionTemplateType from '../model/CollectionTemplateType'; import EntitySetCollection from '../model/EntitySetCollection'; import EntityTypeCollection from '../model/EntityTypeCollection'; import MetadataUpdate from '../model/MetadataUpdate'; @@ -47,18 +48,18 @@ export default class CollectionsApi { /** * Appends type to template of the specified EntityTypeCollection * @param {String} entityTypeCollectionId - * @param {module:model/EntityTypeCollection} entityTypeCollection + * @param {module:model/CollectionTemplateType} collectionTemplateType * @param {module:api/CollectionsApi~addTypeToEntityTypeCollectionTemplateCallback} callback The callback function, accepting three arguments: error, data, response */ - addTypeToEntityTypeCollectionTemplate(entityTypeCollectionId, entityTypeCollection, callback) { - let postBody = entityTypeCollection; + addTypeToEntityTypeCollectionTemplate(entityTypeCollectionId, collectionTemplateType, callback) { + let postBody = collectionTemplateType; // verify the required parameter 'entityTypeCollectionId' is set if (entityTypeCollectionId === undefined || entityTypeCollectionId === null) { throw new Error("Missing the required parameter 'entityTypeCollectionId' when calling addTypeToEntityTypeCollectionTemplate"); } - // verify the required parameter 'entityTypeCollection' is set - if (entityTypeCollection === undefined || entityTypeCollection === null) { - throw new Error("Missing the required parameter 'entityTypeCollection' when calling addTypeToEntityTypeCollectionTemplate"); + // verify the required parameter 'collectionTemplateType' is set + if (collectionTemplateType === undefined || collectionTemplateType === null) { + throw new Error("Missing the required parameter 'collectionTemplateType' when calling addTypeToEntityTypeCollectionTemplate"); } let pathParams = { @@ -396,7 +397,7 @@ export default class CollectionsApi { let accepts = ['application/json']; let returnType = [EntitySetCollection]; return this.apiClient.callApi( - '/datastore/collections/entity/type/entity/set/{entitySetCollectionId}', 'GET', + '/datastore/collections/entity/set/entity/type/{entitySetCollectionId}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback ); diff --git a/javascript/src/api/DataApi.js b/javascript/src/api/DataApi.js index 6c0478e..57eee6e 100644 --- a/javascript/src/api/DataApi.js +++ b/javascript/src/api/DataApi.js @@ -410,7 +410,7 @@ export default class DataApi { let accepts = []; let returnType = null; return this.apiClient.callApi( - '/datastore/data/{entitySetId}/{entityKeyId}', 'DELETE', + '/datastore/data/set/{entitySetId}/{entityKeyId}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback ); diff --git a/javascript/src/api/ShuttleApi.js b/javascript/src/api/ShuttleApi.js new file mode 100644 index 0000000..3660eb2 --- /dev/null +++ b/javascript/src/api/ShuttleApi.js @@ -0,0 +1,383 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + + +import ApiClient from "../ApiClient"; +import Integration from '../model/Integration'; +import IntegrationJob from '../model/IntegrationJob'; +import IntegrationUpdate from '../model/IntegrationUpdate'; + +/** +* Shuttle service. +* @module api/ShuttleApi +* @version 0.0.1 +*/ +export default class ShuttleApi { + + /** + * Constructs a new ShuttleApi. + * @alias module:api/ShuttleApi + * @class + * @param {module:ApiClient} [apiClient] Optional API client implementation to use, + * default to {@link module:ApiClient#instance} if unspecified. + */ + constructor(apiClient) { + this.apiClient = apiClient || ApiClient.instance; + } + + + /** + * Callback function to receive the result of the createIntegrationDefinition operation. + * @callback module:api/ShuttleApi~createIntegrationDefinitionCallback + * @param {String} error Error message, if any. + * @param {String} data The data returned by the service call. + * @param {String} response The complete HTTP response. + */ + + /** + * Creates a new integration definition for running recurring integrations + * @param {String} integrationName + * @param {module:model/Integration} integration + * @param {module:api/ShuttleApi~createIntegrationDefinitionCallback} callback The callback function, accepting three arguments: error, data, response + * data is of type: {@link String} + */ + createIntegrationDefinition(integrationName, integration, callback) { + let postBody = integration; + // verify the required parameter 'integrationName' is set + if (integrationName === undefined || integrationName === null) { + throw new Error("Missing the required parameter 'integrationName' when calling createIntegrationDefinition"); + } + // verify the required parameter 'integration' is set + if (integration === undefined || integration === null) { + throw new Error("Missing the required parameter 'integration' when calling createIntegrationDefinition"); + } + + let pathParams = { + 'integrationName': integrationName + }; + let queryParams = { + }; + let headerParams = { + }; + let formParams = { + }; + + let authNames = ['http_auth', 'openlattice_auth']; + let contentTypes = ['application/json']; + let accepts = ['application/json']; + let returnType = 'String'; + return this.apiClient.callApi( + '/shuttle/integration/definition/{integrationName}', 'POST', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null, callback + ); + } + + /** + * Callback function to receive the result of the deleteIntegrationDefinition operation. + * @callback module:api/ShuttleApi~deleteIntegrationDefinitionCallback + * @param {String} error Error message, if any. + * @param data This operation does not return a value. + * @param {String} response The complete HTTP response. + */ + + /** + * Replaces any number of fields within an existing integration definition + * @param {String} integrationName + * @param {module:api/ShuttleApi~deleteIntegrationDefinitionCallback} callback The callback function, accepting three arguments: error, data, response + */ + deleteIntegrationDefinition(integrationName, callback) { + let postBody = null; + // verify the required parameter 'integrationName' is set + if (integrationName === undefined || integrationName === null) { + throw new Error("Missing the required parameter 'integrationName' when calling deleteIntegrationDefinition"); + } + + let pathParams = { + 'integrationName': integrationName + }; + let queryParams = { + }; + let headerParams = { + }; + let formParams = { + }; + + let authNames = ['http_auth', 'openlattice_auth']; + let contentTypes = []; + let accepts = []; + let returnType = null; + return this.apiClient.callApi( + '/shuttle/integration/definition/{integrationName}', 'DELETE', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null, callback + ); + } + + /** + * Callback function to receive the result of the deleteIntegrationJobStatus operation. + * @callback module:api/ShuttleApi~deleteIntegrationJobStatusCallback + * @param {String} error Error message, if any. + * @param data This operation does not return a value. + * @param {String} response The complete HTTP response. + */ + + /** + * Deletes an integration job status from the integrationJobs map + * @param {String} jobId the unique id of the integration job + * @param {module:api/ShuttleApi~deleteIntegrationJobStatusCallback} callback The callback function, accepting three arguments: error, data, response + */ + deleteIntegrationJobStatus(jobId, callback) { + let postBody = null; + // verify the required parameter 'jobId' is set + if (jobId === undefined || jobId === null) { + throw new Error("Missing the required parameter 'jobId' when calling deleteIntegrationJobStatus"); + } + + let pathParams = { + 'jobId': jobId + }; + let queryParams = { + }; + let headerParams = { + }; + let formParams = { + }; + + let authNames = ['http_auth', 'openlattice_auth']; + let contentTypes = []; + let accepts = []; + let returnType = null; + return this.apiClient.callApi( + '/shuttle/integration/status/{jobId}', 'DELETE', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null, callback + ); + } + + /** + * Callback function to receive the result of the enqueueIntegration operation. + * @callback module:api/ShuttleApi~enqueueIntegrationCallback + * @param {String} error Error message, if any. + * @param {String} data The data returned by the service call. + * @param {String} response The complete HTTP response. + */ + + /** + * Enqueues an integration on Shuttle Server for a given integration + * @param {String} integrationName the name of the integration to be run + * @param {String} integrationKey the unique id used to authenticate an integration run + * @param {module:api/ShuttleApi~enqueueIntegrationCallback} callback The callback function, accepting three arguments: error, data, response + * data is of type: {@link String} + */ + enqueueIntegration(integrationName, integrationKey, callback) { + let postBody = null; + // verify the required parameter 'integrationName' is set + if (integrationName === undefined || integrationName === null) { + throw new Error("Missing the required parameter 'integrationName' when calling enqueueIntegration"); + } + // verify the required parameter 'integrationKey' is set + if (integrationKey === undefined || integrationKey === null) { + throw new Error("Missing the required parameter 'integrationKey' when calling enqueueIntegration"); + } + + let pathParams = { + 'integrationName': integrationName, + 'integrationKey': integrationKey + }; + let queryParams = { + }; + let headerParams = { + }; + let formParams = { + }; + + let authNames = ['http_auth', 'openlattice_auth']; + let contentTypes = []; + let accepts = ['application/json']; + let returnType = 'String'; + return this.apiClient.callApi( + '/shuttle/integration/{integrationName}/{integrationKey}', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null, callback + ); + } + + /** + * Callback function to receive the result of the pollAllIntegrations operation. + * @callback module:api/ShuttleApi~pollAllIntegrationsCallback + * @param {String} error Error message, if any. + * @param {Object.} data The data returned by the service call. + * @param {String} response The complete HTTP response. + */ + + /** + * Polls the statuses of all running integrations + * @param {module:api/ShuttleApi~pollAllIntegrationsCallback} callback The callback function, accepting three arguments: error, data, response + * data is of type: {@link Object.} + */ + pollAllIntegrations(callback) { + let postBody = null; + + let pathParams = { + }; + let queryParams = { + }; + let headerParams = { + }; + let formParams = { + }; + + let authNames = ['http_auth', 'openlattice_auth']; + let contentTypes = []; + let accepts = ['application/json']; + let returnType = {'String': IntegrationJob}; + return this.apiClient.callApi( + '/shuttle/integration/status', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null, callback + ); + } + + /** + * Callback function to receive the result of the pollIntegration operation. + * @callback module:api/ShuttleApi~pollIntegrationCallback + * @param {String} error Error message, if any. + * @param {String} data The data returned by the service call. + * @param {String} response The complete HTTP response. + */ + + /** + * Polls the status of an integration + * @param {String} jobId the unique id of the integration job + * @param {module:api/ShuttleApi~pollIntegrationCallback} callback The callback function, accepting three arguments: error, data, response + * data is of type: {@link String} + */ + pollIntegration(jobId, callback) { + let postBody = null; + // verify the required parameter 'jobId' is set + if (jobId === undefined || jobId === null) { + throw new Error("Missing the required parameter 'jobId' when calling pollIntegration"); + } + + let pathParams = { + 'jobId': jobId + }; + let queryParams = { + }; + let headerParams = { + }; + let formParams = { + }; + + let authNames = ['http_auth', 'openlattice_auth']; + let contentTypes = []; + let accepts = ['application/json']; + let returnType = 'String'; + return this.apiClient.callApi( + '/shuttle/integration/status/{jobId}', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null, callback + ); + } + + /** + * Callback function to receive the result of the readIntegrationDefinition operation. + * @callback module:api/ShuttleApi~readIntegrationDefinitionCallback + * @param {String} error Error message, if any. + * @param {module:model/Integration} data The data returned by the service call. + * @param {String} response The complete HTTP response. + */ + + /** + * Gets an existing integration definition + * @param {String} integrationName + * @param {module:api/ShuttleApi~readIntegrationDefinitionCallback} callback The callback function, accepting three arguments: error, data, response + * data is of type: {@link module:model/Integration} + */ + readIntegrationDefinition(integrationName, callback) { + let postBody = null; + // verify the required parameter 'integrationName' is set + if (integrationName === undefined || integrationName === null) { + throw new Error("Missing the required parameter 'integrationName' when calling readIntegrationDefinition"); + } + + let pathParams = { + 'integrationName': integrationName + }; + let queryParams = { + }; + let headerParams = { + }; + let formParams = { + }; + + let authNames = ['http_auth', 'openlattice_auth']; + let contentTypes = []; + let accepts = ['application/json']; + let returnType = Integration; + return this.apiClient.callApi( + '/shuttle/integration/definition/{integrationName}', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null, callback + ); + } + + /** + * Callback function to receive the result of the updateIntegrationDefinition operation. + * @callback module:api/ShuttleApi~updateIntegrationDefinitionCallback + * @param {String} error Error message, if any. + * @param data This operation does not return a value. + * @param {String} response The complete HTTP response. + */ + + /** + * Replaces any number of fields within an existing integration definition + * @param {String} integrationName + * @param {module:model/IntegrationUpdate} integrationUpdate + * @param {module:api/ShuttleApi~updateIntegrationDefinitionCallback} callback The callback function, accepting three arguments: error, data, response + */ + updateIntegrationDefinition(integrationName, integrationUpdate, callback) { + let postBody = integrationUpdate; + // verify the required parameter 'integrationName' is set + if (integrationName === undefined || integrationName === null) { + throw new Error("Missing the required parameter 'integrationName' when calling updateIntegrationDefinition"); + } + // verify the required parameter 'integrationUpdate' is set + if (integrationUpdate === undefined || integrationUpdate === null) { + throw new Error("Missing the required parameter 'integrationUpdate' when calling updateIntegrationDefinition"); + } + + let pathParams = { + 'integrationName': integrationName + }; + let queryParams = { + }; + let headerParams = { + }; + let formParams = { + }; + + let authNames = ['http_auth', 'openlattice_auth']; + let contentTypes = ['application/json']; + let accepts = []; + let returnType = null; + return this.apiClient.callApi( + '/shuttle/integration/definition/{integrationName}', 'PATCH', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType, null, callback + ); + } + + +} diff --git a/javascript/src/index.js b/javascript/src/index.js index 54d1f6e..6447950 100644 --- a/javascript/src/index.js +++ b/javascript/src/index.js @@ -19,6 +19,7 @@ import Acl from './model/Acl'; import AclData from './model/AclData'; import AdvancedSearch from './model/AdvancedSearch'; import Association from './model/Association'; +import AssociationDefinition from './model/AssociationDefinition'; import AssociationType from './model/AssociationType'; import Auth0userBasic from './model/Auth0userBasic'; import Authorization from './model/Authorization'; @@ -39,6 +40,7 @@ import EDMdiff from './model/EDMdiff'; import EdmRequest from './model/EdmRequest'; import Entity from './model/Entity'; import EntityDataKey from './model/EntityDataKey'; +import EntityDefinition from './model/EntityDefinition'; import EntityKey from './model/EntityKey'; import EntityKeyPair from './model/EntityKeyPair'; import EntityLinkingFeatures from './model/EntityLinkingFeatures'; @@ -51,11 +53,17 @@ import EntitySetSelection from './model/EntitySetSelection'; import EntityType from './model/EntityType'; import EntityTypeCollection from './model/EntityTypeCollection'; import EntityTypePropertyMetadata from './model/EntityTypePropertyMetadata'; +import Flight from './model/Flight'; +import FlightPlanParameters from './model/FlightPlanParameters'; +import FlightPlanParametersUpdate from './model/FlightPlanParametersUpdate'; import FullQualifiedName from './model/FullQualifiedName'; import IndexingState from './model/IndexingState'; import InlineObject from './model/InlineObject'; import InlineResponse200 from './model/InlineResponse200'; +import Integration from './model/Integration'; +import IntegrationJob from './model/IntegrationJob'; import IntegrationResults from './model/IntegrationResults'; +import IntegrationUpdate from './model/IntegrationUpdate'; import LinkingFeedback from './model/LinkingFeedback'; import MaterializedViewAccount from './model/MaterializedViewAccount'; import MetadataUpdate from './model/MetadataUpdate'; @@ -68,6 +76,7 @@ import OrganizationExternalDatabaseTable from './model/OrganizationExternalDatab import OrganizationExternalDatabaseTableColumnsPair from './model/OrganizationExternalDatabaseTableColumnsPair'; import OrganizationMember from './model/OrganizationMember'; import Principal from './model/Principal'; +import PropertyDefinition from './model/PropertyDefinition'; import PropertyType from './model/PropertyType'; import PropertyUsageSummary from './model/PropertyUsageSummary'; import Role from './model/Role'; @@ -76,6 +85,7 @@ import Search from './model/Search'; import SearchConstraints from './model/SearchConstraints'; import SearchDetails from './model/SearchDetails'; import SearchResult from './model/SearchResult'; +import SearchResultHits from './model/SearchResultHits'; import SearchTerm from './model/SearchTerm'; import SecurablePrincipal from './model/SecurablePrincipal'; import SmsEntitySetInformation from './model/SmsEntitySetInformation'; @@ -93,6 +103,7 @@ import OrganizationsApi from './api/OrganizationsApi'; import PermissionsApi from './api/PermissionsApi'; import PrincipalApi from './api/PrincipalApi'; import SearchApi from './api/SearchApi'; +import ShuttleApi from './api/ShuttleApi'; /** @@ -169,6 +180,12 @@ export { */ Association, + /** + * The AssociationDefinition model constructor. + * @property {module:model/AssociationDefinition} + */ + AssociationDefinition, + /** * The AssociationType model constructor. * @property {module:model/AssociationType} @@ -289,6 +306,12 @@ export { */ EntityDataKey, + /** + * The EntityDefinition model constructor. + * @property {module:model/EntityDefinition} + */ + EntityDefinition, + /** * The EntityKey model constructor. * @property {module:model/EntityKey} @@ -361,6 +384,24 @@ export { */ EntityTypePropertyMetadata, + /** + * The Flight model constructor. + * @property {module:model/Flight} + */ + Flight, + + /** + * The FlightPlanParameters model constructor. + * @property {module:model/FlightPlanParameters} + */ + FlightPlanParameters, + + /** + * The FlightPlanParametersUpdate model constructor. + * @property {module:model/FlightPlanParametersUpdate} + */ + FlightPlanParametersUpdate, + /** * The FullQualifiedName model constructor. * @property {module:model/FullQualifiedName} @@ -385,12 +426,30 @@ export { */ InlineResponse200, + /** + * The Integration model constructor. + * @property {module:model/Integration} + */ + Integration, + + /** + * The IntegrationJob model constructor. + * @property {module:model/IntegrationJob} + */ + IntegrationJob, + /** * The IntegrationResults model constructor. * @property {module:model/IntegrationResults} */ IntegrationResults, + /** + * The IntegrationUpdate model constructor. + * @property {module:model/IntegrationUpdate} + */ + IntegrationUpdate, + /** * The LinkingFeedback model constructor. * @property {module:model/LinkingFeedback} @@ -463,6 +522,12 @@ export { */ Principal, + /** + * The PropertyDefinition model constructor. + * @property {module:model/PropertyDefinition} + */ + PropertyDefinition, + /** * The PropertyType model constructor. * @property {module:model/PropertyType} @@ -511,6 +576,12 @@ export { */ SearchResult, + /** + * The SearchResultHits model constructor. + * @property {module:model/SearchResultHits} + */ + SearchResultHits, + /** * The SearchTerm model constructor. * @property {module:model/SearchTerm} @@ -611,5 +682,11 @@ export { * The SearchApi service constructor. * @property {module:api/SearchApi} */ - SearchApi + SearchApi, + + /** + * The ShuttleApi service constructor. + * @property {module:api/ShuttleApi} + */ + ShuttleApi }; diff --git a/javascript/src/model/AssociationDefinition.js b/javascript/src/model/AssociationDefinition.js new file mode 100644 index 0000000..3abb68f --- /dev/null +++ b/javascript/src/model/AssociationDefinition.js @@ -0,0 +1,140 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import FullQualifiedName from './FullQualifiedName'; +import PropertyDefinition from './PropertyDefinition'; + +/** + * The AssociationDefinition model module. + * @module model/AssociationDefinition + * @version 0.0.1 + */ +class AssociationDefinition { + /** + * Constructs a new AssociationDefinition. + * @alias module:model/AssociationDefinition + */ + constructor() { + + AssociationDefinition.initialize(this); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj) { + } + + /** + * Constructs a AssociationDefinition from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/AssociationDefinition} obj Optional instance to populate. + * @return {module:model/AssociationDefinition} The populated AssociationDefinition instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new AssociationDefinition(); + + if (data.hasOwnProperty('fqn')) { + obj['fqn'] = FullQualifiedName.constructFromObject(data['fqn']); + } + if (data.hasOwnProperty('entitySetName')) { + obj['entitySetName'] = ApiClient.convertToType(data['entitySetName'], 'String'); + } + if (data.hasOwnProperty('propertyDefinitions')) { + obj['propertyDefinitions'] = ApiClient.convertToType(data['propertyDefinitions'], {'String': PropertyDefinition}); + } + if (data.hasOwnProperty('updateType')) { + obj['updateType'] = ApiClient.convertToType(data['updateType'], 'String'); + } + if (data.hasOwnProperty('src')) { + obj['src'] = ApiClient.convertToType(data['src'], 'String'); + } + if (data.hasOwnProperty('dst')) { + obj['dst'] = ApiClient.convertToType(data['dst'], 'String'); + } + } + return obj; + } + + +} + +/** + * @member {module:model/FullQualifiedName} fqn + */ +AssociationDefinition.prototype['fqn'] = undefined; + +/** + * @member {String} entitySetName + */ +AssociationDefinition.prototype['entitySetName'] = undefined; + +/** + * @member {Object.} propertyDefinitions + */ +AssociationDefinition.prototype['propertyDefinitions'] = undefined; + +/** + * @member {module:model/AssociationDefinition.UpdateTypeEnum} updateType + */ +AssociationDefinition.prototype['updateType'] = undefined; + +/** + * @member {String} src + */ +AssociationDefinition.prototype['src'] = undefined; + +/** + * @member {String} dst + */ +AssociationDefinition.prototype['dst'] = undefined; + + + + + +/** + * Allowed values for the updateType property. + * @enum {String} + * @readonly + */ +AssociationDefinition['UpdateTypeEnum'] = { + + /** + * value: "Replace" + * @const + */ + "Replace": "Replace", + + /** + * value: "PartialReplace" + * @const + */ + "PartialReplace": "PartialReplace", + + /** + * value: "Merge" + * @const + */ + "Merge": "Merge" +}; + + + +export default AssociationDefinition; + diff --git a/javascript/src/model/DataAssociation.js b/javascript/src/model/DataAssociation.js index 86aff51..7a4fde7 100644 --- a/javascript/src/model/DataAssociation.js +++ b/javascript/src/model/DataAssociation.js @@ -56,6 +56,18 @@ class DataAssociation { if (data.hasOwnProperty('srcEntityKeyId')) { obj['srcEntityKeyId'] = ApiClient.convertToType(data['srcEntityKeyId'], 'String'); } + if (data.hasOwnProperty('dstEntitySetId')) { + obj['dstEntitySetId'] = ApiClient.convertToType(data['dstEntitySetId'], 'String'); + } + if (data.hasOwnProperty('dstEntityIndex')) { + obj['dstEntityIndex'] = ApiClient.convertToType(data['dstEntityIndex'], 'String'); + } + if (data.hasOwnProperty('dstEntityKeyId')) { + obj['dstEntityKeyId'] = ApiClient.convertToType(data['dstEntityKeyId'], 'String'); + } + if (data.hasOwnProperty('data')) { + obj['data'] = ApiClient.convertToType(data['data'], {'String': ['String']}); + } } return obj; } @@ -81,6 +93,30 @@ DataAssociation.prototype['srcEntityIndex'] = undefined; */ DataAssociation.prototype['srcEntityKeyId'] = undefined; +/** + * the ID of the dst entity set + * @member {String} dstEntitySetId + */ +DataAssociation.prototype['dstEntitySetId'] = undefined; + +/** + * The index of an entity + * @member {String} dstEntityIndex + */ +DataAssociation.prototype['dstEntityIndex'] = undefined; + +/** + * An existing entityKeyId + * @member {String} dstEntityKeyId + */ +DataAssociation.prototype['dstEntityKeyId'] = undefined; + +/** + * data + * @member {Object.>} data + */ +DataAssociation.prototype['data'] = undefined; + diff --git a/javascript/src/model/EntityDefinition.js b/javascript/src/model/EntityDefinition.js new file mode 100644 index 0000000..f7ec8ca --- /dev/null +++ b/javascript/src/model/EntityDefinition.js @@ -0,0 +1,124 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import FullQualifiedName from './FullQualifiedName'; +import PropertyDefinition from './PropertyDefinition'; + +/** + * The EntityDefinition model module. + * @module model/EntityDefinition + * @version 0.0.1 + */ +class EntityDefinition { + /** + * Constructs a new EntityDefinition. + * @alias module:model/EntityDefinition + */ + constructor() { + + EntityDefinition.initialize(this); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj) { + } + + /** + * Constructs a EntityDefinition from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/EntityDefinition} obj Optional instance to populate. + * @return {module:model/EntityDefinition} The populated EntityDefinition instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new EntityDefinition(); + + if (data.hasOwnProperty('fqn')) { + obj['fqn'] = FullQualifiedName.constructFromObject(data['fqn']); + } + if (data.hasOwnProperty('entitySetName')) { + obj['entitySetName'] = ApiClient.convertToType(data['entitySetName'], 'String'); + } + if (data.hasOwnProperty('propertyDefinitions')) { + obj['propertyDefinitions'] = ApiClient.convertToType(data['propertyDefinitions'], {'String': PropertyDefinition}); + } + if (data.hasOwnProperty('updateType')) { + obj['updateType'] = ApiClient.convertToType(data['updateType'], 'String'); + } + } + return obj; + } + + +} + +/** + * @member {module:model/FullQualifiedName} fqn + */ +EntityDefinition.prototype['fqn'] = undefined; + +/** + * @member {String} entitySetName + */ +EntityDefinition.prototype['entitySetName'] = undefined; + +/** + * @member {Object.} propertyDefinitions + */ +EntityDefinition.prototype['propertyDefinitions'] = undefined; + +/** + * @member {module:model/EntityDefinition.UpdateTypeEnum} updateType + */ +EntityDefinition.prototype['updateType'] = undefined; + + + + + +/** + * Allowed values for the updateType property. + * @enum {String} + * @readonly + */ +EntityDefinition['UpdateTypeEnum'] = { + + /** + * value: "Replace" + * @const + */ + "Replace": "Replace", + + /** + * value: "PartialReplace" + * @const + */ + "PartialReplace": "PartialReplace", + + /** + * value: "Merge" + * @const + */ + "Merge": "Merge" +}; + + + +export default EntityDefinition; + diff --git a/javascript/src/model/Flight.js b/javascript/src/model/Flight.js new file mode 100644 index 0000000..8615922 --- /dev/null +++ b/javascript/src/model/Flight.js @@ -0,0 +1,105 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import AssociationDefinition from './AssociationDefinition'; +import EntityDefinition from './EntityDefinition'; + +/** + * The Flight model module. + * @module model/Flight + * @version 0.0.1 + */ +class Flight { + /** + * Constructs a new Flight. + * @alias module:model/Flight + */ + constructor() { + + Flight.initialize(this); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj) { + } + + /** + * Constructs a Flight from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/Flight} obj Optional instance to populate. + * @return {module:model/Flight} The populated Flight instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new Flight(); + + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + if (data.hasOwnProperty('tags')) { + obj['tags'] = ApiClient.convertToType(data['tags'], ['String']); + } + if (data.hasOwnProperty('organizationId')) { + obj['organizationId'] = ApiClient.convertToType(data['organizationId'], 'String'); + } + if (data.hasOwnProperty('entityDefinitions')) { + obj['entityDefinitions'] = ApiClient.convertToType(data['entityDefinitions'], {'String': EntityDefinition}); + } + if (data.hasOwnProperty('associationDefinitions')) { + obj['associationDefinitions'] = ApiClient.convertToType(data['associationDefinitions'], {'String': AssociationDefinition}); + } + } + return obj; + } + + +} + +/** + * @member {String} name + */ +Flight.prototype['name'] = undefined; + +/** + * @member {Array.} tags + */ +Flight.prototype['tags'] = undefined; + +/** + * @member {String} organizationId + */ +Flight.prototype['organizationId'] = undefined; + +/** + * @member {Object.} entityDefinitions + */ +Flight.prototype['entityDefinitions'] = undefined; + +/** + * @member {Object.} associationDefinitions + */ +Flight.prototype['associationDefinitions'] = undefined; + + + + + + +export default Flight; + diff --git a/javascript/src/model/FlightPlanParameters.js b/javascript/src/model/FlightPlanParameters.js new file mode 100644 index 0000000..cf0ebb7 --- /dev/null +++ b/javascript/src/model/FlightPlanParameters.js @@ -0,0 +1,109 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import Flight from './Flight'; + +/** + * The FlightPlanParameters model module. + * @module model/FlightPlanParameters + * @version 0.0.1 + */ +class FlightPlanParameters { + /** + * Constructs a new FlightPlanParameters. + * Represents the parameters required to create a flight plan (i.e. a Map<Flight, Payload>) + * @alias module:model/FlightPlanParameters + */ + constructor() { + + FlightPlanParameters.initialize(this); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj) { + } + + /** + * Constructs a FlightPlanParameters from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/FlightPlanParameters} obj Optional instance to populate. + * @return {module:model/FlightPlanParameters} The populated FlightPlanParameters instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new FlightPlanParameters(); + + if (data.hasOwnProperty('sql')) { + obj['sql'] = ApiClient.convertToType(data['sql'], 'String'); + } + if (data.hasOwnProperty('src')) { + obj['src'] = ApiClient.convertToType(data['src'], {'String': 'String'}); + } + if (data.hasOwnProperty('srcPrimaryKeyColumns')) { + obj['srcPrimaryKeyColumns'] = ApiClient.convertToType(data['srcPrimaryKeyColumns'], ['String']); + } + if (data.hasOwnProperty('path')) { + obj['path'] = ApiClient.convertToType(data['path'], 'String'); + } + if (data.hasOwnProperty('flight')) { + obj['flight'] = Flight.constructFromObject(data['flight']); + } + } + return obj; + } + + +} + +/** + * the sql query to be used to pull cleaned data from postgres + * @member {String} sql + */ +FlightPlanParameters.prototype['sql'] = undefined; + +/** + * postgres data source for pulling clean data + * @member {Object.} src + */ +FlightPlanParameters.prototype['src'] = undefined; + +/** + * the columns that are primary keys in the cleaned data + * @member {Array.} srcPrimaryKeyColumns + */ +FlightPlanParameters.prototype['srcPrimaryKeyColumns'] = undefined; + +/** + * the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) + * @member {String} path + */ +FlightPlanParameters.prototype['path'] = undefined; + +/** + * @member {module:model/Flight} flight + */ +FlightPlanParameters.prototype['flight'] = undefined; + + + + + + +export default FlightPlanParameters; + diff --git a/javascript/src/model/FlightPlanParametersUpdate.js b/javascript/src/model/FlightPlanParametersUpdate.js new file mode 100644 index 0000000..404187c --- /dev/null +++ b/javascript/src/model/FlightPlanParametersUpdate.js @@ -0,0 +1,99 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The FlightPlanParametersUpdate model module. + * @module model/FlightPlanParametersUpdate + * @version 0.0.1 + */ +class FlightPlanParametersUpdate { + /** + * Constructs a new FlightPlanParametersUpdate. + * @alias module:model/FlightPlanParametersUpdate + */ + constructor() { + + FlightPlanParametersUpdate.initialize(this); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj) { + } + + /** + * Constructs a FlightPlanParametersUpdate from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/FlightPlanParametersUpdate} obj Optional instance to populate. + * @return {module:model/FlightPlanParametersUpdate} The populated FlightPlanParametersUpdate instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new FlightPlanParametersUpdate(); + + if (data.hasOwnProperty('sql')) { + obj['sql'] = ApiClient.convertToType(data['sql'], 'String'); + } + if (data.hasOwnProperty('src')) { + obj['src'] = ApiClient.convertToType(data['src'], {'String': 'String'}); + } + if (data.hasOwnProperty('srcPrimaryKeyColumns')) { + obj['srcPrimaryKeyColumns'] = ApiClient.convertToType(data['srcPrimaryKeyColumns'], ['String']); + } + if (data.hasOwnProperty('path')) { + obj['path'] = ApiClient.convertToType(data['path'], 'String'); + } + } + return obj; + } + + +} + +/** + * the sql query to be used to pull cleaned data from postgres + * @member {String} sql + */ +FlightPlanParametersUpdate.prototype['sql'] = undefined; + +/** + * postgres data source for pulling clean data + * @member {Object.} src + */ +FlightPlanParametersUpdate.prototype['src'] = undefined; + +/** + * the columns that are primary keys in the cleaned data + * @member {Array.} srcPrimaryKeyColumns + */ +FlightPlanParametersUpdate.prototype['srcPrimaryKeyColumns'] = undefined; + +/** + * the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) + * @member {String} path + */ +FlightPlanParametersUpdate.prototype['path'] = undefined; + + + + + + +export default FlightPlanParametersUpdate; + diff --git a/javascript/src/model/Integration.js b/javascript/src/model/Integration.js new file mode 100644 index 0000000..94dd38e --- /dev/null +++ b/javascript/src/model/Integration.js @@ -0,0 +1,173 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import FlightPlanParameters from './FlightPlanParameters'; + +/** + * The Integration model module. + * @module model/Integration + * @version 0.0.1 + */ +class Integration { + /** + * Constructs a new Integration. + * Represents a data integration, including all fields required to run the integration. + * @alias module:model/Integration + */ + constructor() { + + Integration.initialize(this); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj) { + } + + /** + * Constructs a Integration from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/Integration} obj Optional instance to populate. + * @return {module:model/Integration} The populated Integration instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new Integration(); + + if (data.hasOwnProperty('key')) { + obj['key'] = ApiClient.convertToType(data['key'], 'String'); + } + if (data.hasOwnProperty('environment')) { + obj['environment'] = ApiClient.convertToType(data['environment'], 'String'); + } + if (data.hasOwnProperty('s3Bucket')) { + obj['s3Bucket'] = ApiClient.convertToType(data['s3Bucket'], 'String'); + } + if (data.hasOwnProperty('contacts')) { + obj['contacts'] = ApiClient.convertToType(data['contacts'], ['String']); + } + if (data.hasOwnProperty('organizationId')) { + obj['organizationId'] = ApiClient.convertToType(data['organizationId'], 'String'); + } + if (data.hasOwnProperty('entitySetId')) { + obj['entitySetId'] = ApiClient.convertToType(data['entitySetId'], 'String'); + } + if (data.hasOwnProperty('maxConnections')) { + obj['maxConnections'] = ApiClient.convertToType(data['maxConnections'], 'Number'); + } + if (data.hasOwnProperty('callback')) { + obj['callback'] = ApiClient.convertToType(data['callback'], ['String']); + } + if (data.hasOwnProperty('flightPlanParameters')) { + obj['flightPlanParameters'] = ApiClient.convertToType(data['flightPlanParameters'], {'String': FlightPlanParameters}); + } + } + return obj; + } + + +} + +/** + * a unique ID used for authorizing a call to run an integration + * @member {String} key + */ +Integration.prototype['key'] = undefined; + +/** + * the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) + * @member {module:model/Integration.EnvironmentEnum} environment + */ +Integration.prototype['environment'] = undefined; + +/** + * the url of the s3bucket to be used + * @member {String} s3Bucket + */ +Integration.prototype['s3Bucket'] = undefined; + +/** + * the set of email addresses of those responsible for the integration + * @member {Array.} contacts + */ +Integration.prototype['contacts'] = undefined; + +/** + * the id of the organization that owns the integration + * @member {String} organizationId + */ +Integration.prototype['organizationId'] = undefined; + +/** + * the id of the entity set that stores the logs for this integration + * @member {String} entitySetId + */ +Integration.prototype['entitySetId'] = undefined; + +/** + * maximum number of connections to postgres allowed for this integration + * @member {Number} maxConnections + */ +Integration.prototype['maxConnections'] = undefined; + +/** + * urls to receive a POST when integration has completed + * @member {Array.} callback + */ +Integration.prototype['callback'] = undefined; + +/** + * a map from [Flight] name to [FlightPlanParameters] + * @member {Object.} flightPlanParameters + */ +Integration.prototype['flightPlanParameters'] = undefined; + + + + + +/** + * Allowed values for the environment property. + * @enum {String} + * @readonly + */ +Integration['EnvironmentEnum'] = { + + /** + * value: "PROD_INTEGRATION" + * @const + */ + "PROD_INTEGRATION": "PROD_INTEGRATION", + + /** + * value: "STAGING_INTEGRATION" + * @const + */ + "STAGING_INTEGRATION": "STAGING_INTEGRATION", + + /** + * value: "LOCAL" + * @const + */ + "LOCAL": "LOCAL" +}; + + + +export default Integration; + diff --git a/javascript/src/model/IntegrationJob.js b/javascript/src/model/IntegrationJob.js new file mode 100644 index 0000000..bc7cc1f --- /dev/null +++ b/javascript/src/model/IntegrationJob.js @@ -0,0 +1,118 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; + +/** + * The IntegrationJob model module. + * @module model/IntegrationJob + * @version 0.0.1 + */ +class IntegrationJob { + /** + * Constructs a new IntegrationJob. + * @alias module:model/IntegrationJob + */ + constructor() { + + IntegrationJob.initialize(this); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj) { + } + + /** + * Constructs a IntegrationJob from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/IntegrationJob} obj Optional instance to populate. + * @return {module:model/IntegrationJob} The populated IntegrationJob instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new IntegrationJob(); + + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + if (data.hasOwnProperty('status')) { + obj['status'] = ApiClient.convertToType(data['status'], 'String'); + } + } + return obj; + } + + +} + +/** + * @member {String} name + */ +IntegrationJob.prototype['name'] = undefined; + +/** + * @member {module:model/IntegrationJob.StatusEnum} status + */ +IntegrationJob.prototype['status'] = undefined; + + + + + +/** + * Allowed values for the status property. + * @enum {String} + * @readonly + */ +IntegrationJob['StatusEnum'] = { + + /** + * value: "IN_PROGRESS" + * @const + */ + "IN_PROGRESS": "IN_PROGRESS", + + /** + * value: "SUCCEEDED" + * @const + */ + "SUCCEEDED": "SUCCEEDED", + + /** + * value: "FAILED" + * @const + */ + "FAILED": "FAILED", + + /** + * value: "QUEUED" + * @const + */ + "QUEUED": "QUEUED", + + /** + * value: "FAILED_TO_START" + * @const + */ + "FAILED_TO_START": "FAILED_TO_START" +}; + + + +export default IntegrationJob; + diff --git a/javascript/src/model/IntegrationUpdate.js b/javascript/src/model/IntegrationUpdate.js new file mode 100644 index 0000000..a2e7c33 --- /dev/null +++ b/javascript/src/model/IntegrationUpdate.js @@ -0,0 +1,154 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import FlightPlanParametersUpdate from './FlightPlanParametersUpdate'; + +/** + * The IntegrationUpdate model module. + * @module model/IntegrationUpdate + * @version 0.0.1 + */ +class IntegrationUpdate { + /** + * Constructs a new IntegrationUpdate. + * @alias module:model/IntegrationUpdate + */ + constructor() { + + IntegrationUpdate.initialize(this); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj) { + } + + /** + * Constructs a IntegrationUpdate from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/IntegrationUpdate} obj Optional instance to populate. + * @return {module:model/IntegrationUpdate} The populated IntegrationUpdate instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new IntegrationUpdate(); + + if (data.hasOwnProperty('environment')) { + obj['environment'] = ApiClient.convertToType(data['environment'], 'String'); + } + if (data.hasOwnProperty('s3Bucket')) { + obj['s3Bucket'] = ApiClient.convertToType(data['s3Bucket'], 'String'); + } + if (data.hasOwnProperty('contacts')) { + obj['contacts'] = ApiClient.convertToType(data['contacts'], ['String']); + } + if (data.hasOwnProperty('organizationId')) { + obj['organizationId'] = ApiClient.convertToType(data['organizationId'], 'String'); + } + if (data.hasOwnProperty('maxConnections')) { + obj['maxConnections'] = ApiClient.convertToType(data['maxConnections'], 'Number'); + } + if (data.hasOwnProperty('callbackUrls')) { + obj['callbackUrls'] = ApiClient.convertToType(data['callbackUrls'], ['String']); + } + if (data.hasOwnProperty('flightPlanParameters')) { + obj['flightPlanParameters'] = ApiClient.convertToType(data['flightPlanParameters'], {'String': FlightPlanParametersUpdate}); + } + } + return obj; + } + + +} + +/** + * the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) + * @member {module:model/IntegrationUpdate.EnvironmentEnum} environment + */ +IntegrationUpdate.prototype['environment'] = undefined; + +/** + * the url of the s3bucket to be used + * @member {String} s3Bucket + */ +IntegrationUpdate.prototype['s3Bucket'] = undefined; + +/** + * the set of email addresses of those responsible for the integration + * @member {Array.} contacts + */ +IntegrationUpdate.prototype['contacts'] = undefined; + +/** + * the id of the organization that owns the integration + * @member {String} organizationId + */ +IntegrationUpdate.prototype['organizationId'] = undefined; + +/** + * maximum number of connections to postgres allowed for this integration + * @member {Number} maxConnections + */ +IntegrationUpdate.prototype['maxConnections'] = undefined; + +/** + * urls to receive a POST when integration has completed + * @member {Array.} callbackUrls + */ +IntegrationUpdate.prototype['callbackUrls'] = undefined; + +/** + * a map from [Flight] name to [FlightPlanParametersUpdate] + * @member {Object.} flightPlanParameters + */ +IntegrationUpdate.prototype['flightPlanParameters'] = undefined; + + + + + +/** + * Allowed values for the environment property. + * @enum {String} + * @readonly + */ +IntegrationUpdate['EnvironmentEnum'] = { + + /** + * value: "PROD_INTEGRATION" + * @const + */ + "PROD_INTEGRATION": "PROD_INTEGRATION", + + /** + * value: "STAGING_INTEGRATION" + * @const + */ + "STAGING_INTEGRATION": "STAGING_INTEGRATION", + + /** + * value: "LOCAL" + * @const + */ + "LOCAL": "LOCAL" +}; + + + +export default IntegrationUpdate; + diff --git a/javascript/src/model/PropertyDefinition.js b/javascript/src/model/PropertyDefinition.js new file mode 100644 index 0000000..1ea7890 --- /dev/null +++ b/javascript/src/model/PropertyDefinition.js @@ -0,0 +1,80 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import FullQualifiedName from './FullQualifiedName'; + +/** + * The PropertyDefinition model module. + * @module model/PropertyDefinition + * @version 0.0.1 + */ +class PropertyDefinition { + /** + * Constructs a new PropertyDefinition. + * @alias module:model/PropertyDefinition + */ + constructor() { + + PropertyDefinition.initialize(this); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj) { + } + + /** + * Constructs a PropertyDefinition from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/PropertyDefinition} obj Optional instance to populate. + * @return {module:model/PropertyDefinition} The populated PropertyDefinition instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new PropertyDefinition(); + + if (data.hasOwnProperty('type')) { + obj['type'] = FullQualifiedName.constructFromObject(data['type']); + } + if (data.hasOwnProperty('column')) { + obj['column'] = ApiClient.convertToType(data['column'], 'String'); + } + } + return obj; + } + + +} + +/** + * @member {module:model/FullQualifiedName} type + */ +PropertyDefinition.prototype['type'] = undefined; + +/** + * @member {String} column + */ +PropertyDefinition.prototype['column'] = undefined; + + + + + + +export default PropertyDefinition; + diff --git a/javascript/src/model/Role.js b/javascript/src/model/Role.js index acab1e4..5de75fc 100644 --- a/javascript/src/model/Role.js +++ b/javascript/src/model/Role.js @@ -63,9 +63,6 @@ class Role { if (data.hasOwnProperty('description')) { obj['description'] = ApiClient.convertToType(data['description'], 'String'); } - if (data.hasOwnProperty('@class')) { - obj['@class'] = ApiClient.convertToType(data['@class'], 'String'); - } } return obj; } @@ -98,28 +95,8 @@ Role.prototype['title'] = undefined; */ Role.prototype['description'] = undefined; -/** - * @member {module:model/Role.ClassEnum} @class - */ -Role.prototype['@class'] = undefined; - - - -/** - * Allowed values for the @class property. - * @enum {String} - * @readonly - */ -Role['ClassEnum'] = { - - /** - * value: "com.openlattice.organization.roles.Role" - * @const - */ - "com.openlattice.organization.roles.Role": "com.openlattice.organization.roles.Role" -}; diff --git a/javascript/src/model/SearchResult.js b/javascript/src/model/SearchResult.js index f8ec246..12b61cf 100644 --- a/javascript/src/model/SearchResult.js +++ b/javascript/src/model/SearchResult.js @@ -12,6 +12,7 @@ */ import ApiClient from '../ApiClient'; +import SearchResultHits from './SearchResultHits'; /** * The SearchResult model module. @@ -21,7 +22,6 @@ import ApiClient from '../ApiClient'; class SearchResult { /** * Constructs a new SearchResult. - * A search result object, containing the total number of hits for the given query, and the hits themselves. * @alias module:model/SearchResult */ constructor() { @@ -52,7 +52,7 @@ class SearchResult { obj['numHits'] = ApiClient.convertToType(data['numHits'], 'Number'); } if (data.hasOwnProperty('hits')) { - obj['hits'] = ApiClient.convertToType(data['hits'], {'String': 'String'}); + obj['hits'] = ApiClient.convertToType(data['hits'], [SearchResultHits]); } } return obj; @@ -67,7 +67,7 @@ class SearchResult { SearchResult.prototype['numHits'] = undefined; /** - * @member {Object.} hits + * @member {Array.} hits */ SearchResult.prototype['hits'] = undefined; diff --git a/javascript/src/model/SearchResultHits.js b/javascript/src/model/SearchResultHits.js new file mode 100644 index 0000000..c115b29 --- /dev/null +++ b/javascript/src/model/SearchResultHits.js @@ -0,0 +1,81 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +import ApiClient from '../ApiClient'; +import EntitySet from './EntitySet'; +import PropertyType from './PropertyType'; + +/** + * The SearchResultHits model module. + * @module model/SearchResultHits + * @version 0.0.1 + */ +class SearchResultHits { + /** + * Constructs a new SearchResultHits. + * @alias module:model/SearchResultHits + */ + constructor() { + + SearchResultHits.initialize(this); + } + + /** + * Initializes the fields of this object. + * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins). + * Only for internal use. + */ + static initialize(obj) { + } + + /** + * Constructs a SearchResultHits from a plain JavaScript object, optionally creating a new instance. + * Copies all relevant properties from data to obj if supplied or a new instance if not. + * @param {Object} data The plain JavaScript object bearing properties of interest. + * @param {module:model/SearchResultHits} obj Optional instance to populate. + * @return {module:model/SearchResultHits} The populated SearchResultHits instance. + */ + static constructFromObject(data, obj) { + if (data) { + obj = obj || new SearchResultHits(); + + if (data.hasOwnProperty('propertyTypes')) { + obj['propertyTypes'] = ApiClient.convertToType(data['propertyTypes'], [PropertyType]); + } + if (data.hasOwnProperty('entitySet')) { + obj['entitySet'] = EntitySet.constructFromObject(data['entitySet']); + } + } + return obj; + } + + +} + +/** + * @member {Array.} propertyTypes + */ +SearchResultHits.prototype['propertyTypes'] = undefined; + +/** + * @member {module:model/EntitySet} entitySet + */ +SearchResultHits.prototype['entitySet'] = undefined; + + + + + + +export default SearchResultHits; + diff --git a/javascript/test/api/ShuttleApi.spec.js b/javascript/test/api/ShuttleApi.spec.js new file mode 100644 index 0000000..0de2077 --- /dev/null +++ b/javascript/test/api/ShuttleApi.spec.js @@ -0,0 +1,133 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.OpenLatticeApi); + } +}(this, function(expect, OpenLatticeApi) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new OpenLatticeApi.ShuttleApi(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('ShuttleApi', function() { + describe('createIntegrationDefinition', function() { + it('should call createIntegrationDefinition successfully', function(done) { + //uncomment below and update the code to test createIntegrationDefinition + //instance.createIntegrationDefinition(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('deleteIntegrationDefinition', function() { + it('should call deleteIntegrationDefinition successfully', function(done) { + //uncomment below and update the code to test deleteIntegrationDefinition + //instance.deleteIntegrationDefinition(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('deleteIntegrationJobStatus', function() { + it('should call deleteIntegrationJobStatus successfully', function(done) { + //uncomment below and update the code to test deleteIntegrationJobStatus + //instance.deleteIntegrationJobStatus(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('enqueueIntegration', function() { + it('should call enqueueIntegration successfully', function(done) { + //uncomment below and update the code to test enqueueIntegration + //instance.enqueueIntegration(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('pollAllIntegrations', function() { + it('should call pollAllIntegrations successfully', function(done) { + //uncomment below and update the code to test pollAllIntegrations + //instance.pollAllIntegrations(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('pollIntegration', function() { + it('should call pollIntegration successfully', function(done) { + //uncomment below and update the code to test pollIntegration + //instance.pollIntegration(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('readIntegrationDefinition', function() { + it('should call readIntegrationDefinition successfully', function(done) { + //uncomment below and update the code to test readIntegrationDefinition + //instance.readIntegrationDefinition(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('updateIntegrationDefinition', function() { + it('should call updateIntegrationDefinition successfully', function(done) { + //uncomment below and update the code to test updateIntegrationDefinition + //instance.updateIntegrationDefinition(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + }); + +})); diff --git a/javascript/test/model/AssociationDefinition.spec.js b/javascript/test/model/AssociationDefinition.spec.js new file mode 100644 index 0000000..ecb3bea --- /dev/null +++ b/javascript/test/model/AssociationDefinition.spec.js @@ -0,0 +1,95 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.OpenLatticeApi); + } +}(this, function(expect, OpenLatticeApi) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new OpenLatticeApi.AssociationDefinition(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('AssociationDefinition', function() { + it('should create an instance of AssociationDefinition', function() { + // uncomment below and update the code to test AssociationDefinition + //var instane = new OpenLatticeApi.AssociationDefinition(); + //expect(instance).to.be.a(OpenLatticeApi.AssociationDefinition); + }); + + it('should have the property fqn (base name: "fqn")', function() { + // uncomment below and update the code to test the property fqn + //var instane = new OpenLatticeApi.AssociationDefinition(); + //expect(instance).to.be(); + }); + + it('should have the property entitySetName (base name: "entitySetName")', function() { + // uncomment below and update the code to test the property entitySetName + //var instane = new OpenLatticeApi.AssociationDefinition(); + //expect(instance).to.be(); + }); + + it('should have the property propertyDefinitions (base name: "propertyDefinitions")', function() { + // uncomment below and update the code to test the property propertyDefinitions + //var instane = new OpenLatticeApi.AssociationDefinition(); + //expect(instance).to.be(); + }); + + it('should have the property updateType (base name: "updateType")', function() { + // uncomment below and update the code to test the property updateType + //var instane = new OpenLatticeApi.AssociationDefinition(); + //expect(instance).to.be(); + }); + + it('should have the property src (base name: "src")', function() { + // uncomment below and update the code to test the property src + //var instane = new OpenLatticeApi.AssociationDefinition(); + //expect(instance).to.be(); + }); + + it('should have the property dst (base name: "dst")', function() { + // uncomment below and update the code to test the property dst + //var instane = new OpenLatticeApi.AssociationDefinition(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/javascript/test/model/DataAssociation.spec.js b/javascript/test/model/DataAssociation.spec.js index 7cee5c9..364a59e 100644 --- a/javascript/test/model/DataAssociation.spec.js +++ b/javascript/test/model/DataAssociation.spec.js @@ -72,6 +72,30 @@ //expect(instance).to.be(); }); + it('should have the property dstEntitySetId (base name: "dstEntitySetId")', function() { + // uncomment below and update the code to test the property dstEntitySetId + //var instane = new OpenLatticeApi.DataAssociation(); + //expect(instance).to.be(); + }); + + it('should have the property dstEntityIndex (base name: "dstEntityIndex")', function() { + // uncomment below and update the code to test the property dstEntityIndex + //var instane = new OpenLatticeApi.DataAssociation(); + //expect(instance).to.be(); + }); + + it('should have the property dstEntityKeyId (base name: "dstEntityKeyId")', function() { + // uncomment below and update the code to test the property dstEntityKeyId + //var instane = new OpenLatticeApi.DataAssociation(); + //expect(instance).to.be(); + }); + + it('should have the property data (base name: "data")', function() { + // uncomment below and update the code to test the property data + //var instane = new OpenLatticeApi.DataAssociation(); + //expect(instance).to.be(); + }); + }); })); diff --git a/javascript/test/model/EntityDefinition.spec.js b/javascript/test/model/EntityDefinition.spec.js new file mode 100644 index 0000000..15cbdd2 --- /dev/null +++ b/javascript/test/model/EntityDefinition.spec.js @@ -0,0 +1,83 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.OpenLatticeApi); + } +}(this, function(expect, OpenLatticeApi) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new OpenLatticeApi.EntityDefinition(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('EntityDefinition', function() { + it('should create an instance of EntityDefinition', function() { + // uncomment below and update the code to test EntityDefinition + //var instane = new OpenLatticeApi.EntityDefinition(); + //expect(instance).to.be.a(OpenLatticeApi.EntityDefinition); + }); + + it('should have the property fqn (base name: "fqn")', function() { + // uncomment below and update the code to test the property fqn + //var instane = new OpenLatticeApi.EntityDefinition(); + //expect(instance).to.be(); + }); + + it('should have the property entitySetName (base name: "entitySetName")', function() { + // uncomment below and update the code to test the property entitySetName + //var instane = new OpenLatticeApi.EntityDefinition(); + //expect(instance).to.be(); + }); + + it('should have the property propertyDefinitions (base name: "propertyDefinitions")', function() { + // uncomment below and update the code to test the property propertyDefinitions + //var instane = new OpenLatticeApi.EntityDefinition(); + //expect(instance).to.be(); + }); + + it('should have the property updateType (base name: "updateType")', function() { + // uncomment below and update the code to test the property updateType + //var instane = new OpenLatticeApi.EntityDefinition(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/javascript/test/model/Flight.spec.js b/javascript/test/model/Flight.spec.js new file mode 100644 index 0000000..743fa46 --- /dev/null +++ b/javascript/test/model/Flight.spec.js @@ -0,0 +1,89 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.OpenLatticeApi); + } +}(this, function(expect, OpenLatticeApi) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new OpenLatticeApi.Flight(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('Flight', function() { + it('should create an instance of Flight', function() { + // uncomment below and update the code to test Flight + //var instane = new OpenLatticeApi.Flight(); + //expect(instance).to.be.a(OpenLatticeApi.Flight); + }); + + it('should have the property name (base name: "name")', function() { + // uncomment below and update the code to test the property name + //var instane = new OpenLatticeApi.Flight(); + //expect(instance).to.be(); + }); + + it('should have the property tags (base name: "tags")', function() { + // uncomment below and update the code to test the property tags + //var instane = new OpenLatticeApi.Flight(); + //expect(instance).to.be(); + }); + + it('should have the property organizationId (base name: "organizationId")', function() { + // uncomment below and update the code to test the property organizationId + //var instane = new OpenLatticeApi.Flight(); + //expect(instance).to.be(); + }); + + it('should have the property entityDefinitions (base name: "entityDefinitions")', function() { + // uncomment below and update the code to test the property entityDefinitions + //var instane = new OpenLatticeApi.Flight(); + //expect(instance).to.be(); + }); + + it('should have the property associationDefinitions (base name: "associationDefinitions")', function() { + // uncomment below and update the code to test the property associationDefinitions + //var instane = new OpenLatticeApi.Flight(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/javascript/test/model/FlightPlanParameters.spec.js b/javascript/test/model/FlightPlanParameters.spec.js new file mode 100644 index 0000000..2860d46 --- /dev/null +++ b/javascript/test/model/FlightPlanParameters.spec.js @@ -0,0 +1,89 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.OpenLatticeApi); + } +}(this, function(expect, OpenLatticeApi) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new OpenLatticeApi.FlightPlanParameters(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('FlightPlanParameters', function() { + it('should create an instance of FlightPlanParameters', function() { + // uncomment below and update the code to test FlightPlanParameters + //var instane = new OpenLatticeApi.FlightPlanParameters(); + //expect(instance).to.be.a(OpenLatticeApi.FlightPlanParameters); + }); + + it('should have the property sql (base name: "sql")', function() { + // uncomment below and update the code to test the property sql + //var instane = new OpenLatticeApi.FlightPlanParameters(); + //expect(instance).to.be(); + }); + + it('should have the property src (base name: "src")', function() { + // uncomment below and update the code to test the property src + //var instane = new OpenLatticeApi.FlightPlanParameters(); + //expect(instance).to.be(); + }); + + it('should have the property srcPrimaryKeyColumns (base name: "srcPrimaryKeyColumns")', function() { + // uncomment below and update the code to test the property srcPrimaryKeyColumns + //var instane = new OpenLatticeApi.FlightPlanParameters(); + //expect(instance).to.be(); + }); + + it('should have the property path (base name: "path")', function() { + // uncomment below and update the code to test the property path + //var instane = new OpenLatticeApi.FlightPlanParameters(); + //expect(instance).to.be(); + }); + + it('should have the property flight (base name: "flight")', function() { + // uncomment below and update the code to test the property flight + //var instane = new OpenLatticeApi.FlightPlanParameters(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/javascript/test/model/FlightPlanParametersUpdate.spec.js b/javascript/test/model/FlightPlanParametersUpdate.spec.js new file mode 100644 index 0000000..24859c7 --- /dev/null +++ b/javascript/test/model/FlightPlanParametersUpdate.spec.js @@ -0,0 +1,83 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.OpenLatticeApi); + } +}(this, function(expect, OpenLatticeApi) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new OpenLatticeApi.FlightPlanParametersUpdate(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('FlightPlanParametersUpdate', function() { + it('should create an instance of FlightPlanParametersUpdate', function() { + // uncomment below and update the code to test FlightPlanParametersUpdate + //var instane = new OpenLatticeApi.FlightPlanParametersUpdate(); + //expect(instance).to.be.a(OpenLatticeApi.FlightPlanParametersUpdate); + }); + + it('should have the property sql (base name: "sql")', function() { + // uncomment below and update the code to test the property sql + //var instane = new OpenLatticeApi.FlightPlanParametersUpdate(); + //expect(instance).to.be(); + }); + + it('should have the property src (base name: "src")', function() { + // uncomment below and update the code to test the property src + //var instane = new OpenLatticeApi.FlightPlanParametersUpdate(); + //expect(instance).to.be(); + }); + + it('should have the property srcPrimaryKeyColumns (base name: "srcPrimaryKeyColumns")', function() { + // uncomment below and update the code to test the property srcPrimaryKeyColumns + //var instane = new OpenLatticeApi.FlightPlanParametersUpdate(); + //expect(instance).to.be(); + }); + + it('should have the property path (base name: "path")', function() { + // uncomment below and update the code to test the property path + //var instane = new OpenLatticeApi.FlightPlanParametersUpdate(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/javascript/test/model/Integration.spec.js b/javascript/test/model/Integration.spec.js new file mode 100644 index 0000000..53b49aa --- /dev/null +++ b/javascript/test/model/Integration.spec.js @@ -0,0 +1,113 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.OpenLatticeApi); + } +}(this, function(expect, OpenLatticeApi) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new OpenLatticeApi.Integration(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('Integration', function() { + it('should create an instance of Integration', function() { + // uncomment below and update the code to test Integration + //var instane = new OpenLatticeApi.Integration(); + //expect(instance).to.be.a(OpenLatticeApi.Integration); + }); + + it('should have the property key (base name: "key")', function() { + // uncomment below and update the code to test the property key + //var instane = new OpenLatticeApi.Integration(); + //expect(instance).to.be(); + }); + + it('should have the property environment (base name: "environment")', function() { + // uncomment below and update the code to test the property environment + //var instane = new OpenLatticeApi.Integration(); + //expect(instance).to.be(); + }); + + it('should have the property s3Bucket (base name: "s3Bucket")', function() { + // uncomment below and update the code to test the property s3Bucket + //var instane = new OpenLatticeApi.Integration(); + //expect(instance).to.be(); + }); + + it('should have the property contacts (base name: "contacts")', function() { + // uncomment below and update the code to test the property contacts + //var instane = new OpenLatticeApi.Integration(); + //expect(instance).to.be(); + }); + + it('should have the property organizationId (base name: "organizationId")', function() { + // uncomment below and update the code to test the property organizationId + //var instane = new OpenLatticeApi.Integration(); + //expect(instance).to.be(); + }); + + it('should have the property entitySetId (base name: "entitySetId")', function() { + // uncomment below and update the code to test the property entitySetId + //var instane = new OpenLatticeApi.Integration(); + //expect(instance).to.be(); + }); + + it('should have the property maxConnections (base name: "maxConnections")', function() { + // uncomment below and update the code to test the property maxConnections + //var instane = new OpenLatticeApi.Integration(); + //expect(instance).to.be(); + }); + + it('should have the property callback (base name: "callback")', function() { + // uncomment below and update the code to test the property callback + //var instane = new OpenLatticeApi.Integration(); + //expect(instance).to.be(); + }); + + it('should have the property flightPlanParameters (base name: "flightPlanParameters")', function() { + // uncomment below and update the code to test the property flightPlanParameters + //var instane = new OpenLatticeApi.Integration(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/javascript/test/model/IntegrationJob.spec.js b/javascript/test/model/IntegrationJob.spec.js new file mode 100644 index 0000000..f013e8c --- /dev/null +++ b/javascript/test/model/IntegrationJob.spec.js @@ -0,0 +1,71 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.OpenLatticeApi); + } +}(this, function(expect, OpenLatticeApi) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new OpenLatticeApi.IntegrationJob(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('IntegrationJob', function() { + it('should create an instance of IntegrationJob', function() { + // uncomment below and update the code to test IntegrationJob + //var instane = new OpenLatticeApi.IntegrationJob(); + //expect(instance).to.be.a(OpenLatticeApi.IntegrationJob); + }); + + it('should have the property name (base name: "name")', function() { + // uncomment below and update the code to test the property name + //var instane = new OpenLatticeApi.IntegrationJob(); + //expect(instance).to.be(); + }); + + it('should have the property status (base name: "status")', function() { + // uncomment below and update the code to test the property status + //var instane = new OpenLatticeApi.IntegrationJob(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/javascript/test/model/IntegrationUpdate.spec.js b/javascript/test/model/IntegrationUpdate.spec.js new file mode 100644 index 0000000..ff7c212 --- /dev/null +++ b/javascript/test/model/IntegrationUpdate.spec.js @@ -0,0 +1,101 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.OpenLatticeApi); + } +}(this, function(expect, OpenLatticeApi) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new OpenLatticeApi.IntegrationUpdate(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('IntegrationUpdate', function() { + it('should create an instance of IntegrationUpdate', function() { + // uncomment below and update the code to test IntegrationUpdate + //var instane = new OpenLatticeApi.IntegrationUpdate(); + //expect(instance).to.be.a(OpenLatticeApi.IntegrationUpdate); + }); + + it('should have the property environment (base name: "environment")', function() { + // uncomment below and update the code to test the property environment + //var instane = new OpenLatticeApi.IntegrationUpdate(); + //expect(instance).to.be(); + }); + + it('should have the property s3Bucket (base name: "s3Bucket")', function() { + // uncomment below and update the code to test the property s3Bucket + //var instane = new OpenLatticeApi.IntegrationUpdate(); + //expect(instance).to.be(); + }); + + it('should have the property contacts (base name: "contacts")', function() { + // uncomment below and update the code to test the property contacts + //var instane = new OpenLatticeApi.IntegrationUpdate(); + //expect(instance).to.be(); + }); + + it('should have the property organizationId (base name: "organizationId")', function() { + // uncomment below and update the code to test the property organizationId + //var instane = new OpenLatticeApi.IntegrationUpdate(); + //expect(instance).to.be(); + }); + + it('should have the property maxConnections (base name: "maxConnections")', function() { + // uncomment below and update the code to test the property maxConnections + //var instane = new OpenLatticeApi.IntegrationUpdate(); + //expect(instance).to.be(); + }); + + it('should have the property callbackUrls (base name: "callbackUrls")', function() { + // uncomment below and update the code to test the property callbackUrls + //var instane = new OpenLatticeApi.IntegrationUpdate(); + //expect(instance).to.be(); + }); + + it('should have the property flightPlanParameters (base name: "flightPlanParameters")', function() { + // uncomment below and update the code to test the property flightPlanParameters + //var instane = new OpenLatticeApi.IntegrationUpdate(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/javascript/test/model/PropertyDefinition.spec.js b/javascript/test/model/PropertyDefinition.spec.js new file mode 100644 index 0000000..15e14e2 --- /dev/null +++ b/javascript/test/model/PropertyDefinition.spec.js @@ -0,0 +1,71 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.OpenLatticeApi); + } +}(this, function(expect, OpenLatticeApi) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new OpenLatticeApi.PropertyDefinition(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('PropertyDefinition', function() { + it('should create an instance of PropertyDefinition', function() { + // uncomment below and update the code to test PropertyDefinition + //var instane = new OpenLatticeApi.PropertyDefinition(); + //expect(instance).to.be.a(OpenLatticeApi.PropertyDefinition); + }); + + it('should have the property type (base name: "type")', function() { + // uncomment below and update the code to test the property type + //var instane = new OpenLatticeApi.PropertyDefinition(); + //expect(instance).to.be(); + }); + + it('should have the property column (base name: "column")', function() { + // uncomment below and update the code to test the property column + //var instane = new OpenLatticeApi.PropertyDefinition(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/javascript/test/model/Role.spec.js b/javascript/test/model/Role.spec.js index 1ee2fe9..5af9972 100644 --- a/javascript/test/model/Role.spec.js +++ b/javascript/test/model/Role.spec.js @@ -84,12 +84,6 @@ //expect(instance).to.be(); }); - it('should have the property _class (base name: "@class")', function() { - // uncomment below and update the code to test the property _class - //var instane = new OpenLatticeApi.Role(); - //expect(instance).to.be(); - }); - }); })); diff --git a/javascript/test/model/SearchResultHits.spec.js b/javascript/test/model/SearchResultHits.spec.js new file mode 100644 index 0000000..1b70b0f --- /dev/null +++ b/javascript/test/model/SearchResultHits.spec.js @@ -0,0 +1,71 @@ +/** + * OpenLattice API + * OpenLattice API + * + * The version of the OpenAPI document: 0.0.1 + * Contact: support@openlattice.com + * + * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). + * https://openapi-generator.tech + * Do not edit the class manually. + * + */ + +(function(root, factory) { + if (typeof define === 'function' && define.amd) { + // AMD. + define(['expect.js', process.cwd()+'/src/index'], factory); + } else if (typeof module === 'object' && module.exports) { + // CommonJS-like environments that support module.exports, like Node. + factory(require('expect.js'), require(process.cwd()+'/src/index')); + } else { + // Browser globals (root is window) + factory(root.expect, root.OpenLatticeApi); + } +}(this, function(expect, OpenLatticeApi) { + 'use strict'; + + var instance; + + beforeEach(function() { + instance = new OpenLatticeApi.SearchResultHits(); + }); + + var getProperty = function(object, getter, property) { + // Use getter method if present; otherwise, get the property directly. + if (typeof object[getter] === 'function') + return object[getter](); + else + return object[property]; + } + + var setProperty = function(object, setter, property, value) { + // Use setter method if present; otherwise, set the property directly. + if (typeof object[setter] === 'function') + object[setter](value); + else + object[property] = value; + } + + describe('SearchResultHits', function() { + it('should create an instance of SearchResultHits', function() { + // uncomment below and update the code to test SearchResultHits + //var instane = new OpenLatticeApi.SearchResultHits(); + //expect(instance).to.be.a(OpenLatticeApi.SearchResultHits); + }); + + it('should have the property propertyTypes (base name: "propertyTypes")', function() { + // uncomment below and update the code to test the property propertyTypes + //var instane = new OpenLatticeApi.SearchResultHits(); + //expect(instance).to.be(); + }); + + it('should have the property entitySet (base name: "entitySet")', function() { + // uncomment below and update the code to test the property entitySet + //var instane = new OpenLatticeApi.SearchResultHits(); + //expect(instance).to.be(); + }); + + }); + +})); diff --git a/python/.openapi-generator/FILES b/python/.openapi-generator/FILES index 1529bab..c1ea80b 100644 --- a/python/.openapi-generator/FILES +++ b/python/.openapi-generator/FILES @@ -88,6 +88,7 @@ docs/SearchApi.md docs/SearchConstraints.md docs/SearchDetails.md docs/SearchResult.md +docs/SearchResultHits.md docs/SearchTerm.md docs/SecurablePrincipal.md docs/ShuttleApi.md @@ -186,6 +187,7 @@ openlattice/models/search.py openlattice/models/search_constraints.py openlattice/models/search_details.py openlattice/models/search_result.py +openlattice/models/search_result_hits.py openlattice/models/search_term.py openlattice/models/securable_principal.py openlattice/models/sms_entity_set_information.py @@ -281,6 +283,7 @@ test/test_search_api.py test/test_search_constraints.py test/test_search_details.py test/test_search_result.py +test/test_search_result_hits.py test/test_search_term.py test/test_securable_principal.py test/test_shuttle_api.py diff --git a/python/README.md b/python/README.md index 227ca56..96287d9 100644 --- a/python/README.md +++ b/python/README.md @@ -373,6 +373,7 @@ Class | Method | HTTP request | Description - [SearchConstraints](docs/SearchConstraints.md) - [SearchDetails](docs/SearchDetails.md) - [SearchResult](docs/SearchResult.md) + - [SearchResultHits](docs/SearchResultHits.md) - [SearchTerm](docs/SearchTerm.md) - [SecurablePrincipal](docs/SecurablePrincipal.md) - [SmsEntitySetInformation](docs/SmsEntitySetInformation.md) diff --git a/python/docs/Integration.md b/python/docs/Integration.md index 37b08de..5c7bef4 100644 --- a/python/docs/Integration.md +++ b/python/docs/Integration.md @@ -5,7 +5,7 @@ Represents a data integration, including all fields required to run the integrat Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **key** | **str** | a unique ID used for authorizing a call to run an integration | [optional] -**environment** | **str** | the retrofit environment (e.g. production, local) | [optional] +**environment** | **str** | the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) | [optional] **s3_bucket** | **str** | the url of the s3bucket to be used | [optional] **contacts** | **list[str]** | the set of email addresses of those responsible for the integration | [optional] **organization_id** | **str** | the id of the organization that owns the integration | [optional] diff --git a/python/docs/IntegrationUpdate.md b/python/docs/IntegrationUpdate.md index 9d5c7ed..335c71d 100644 --- a/python/docs/IntegrationUpdate.md +++ b/python/docs/IntegrationUpdate.md @@ -3,7 +3,7 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**environment** | **str** | the retrofit environment (e.g. production, local) | [optional] +**environment** | **str** | the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) | [optional] **s3_bucket** | **str** | the url of the s3bucket to be used | [optional] **contacts** | **list[str]** | the set of email addresses of those responsible for the integration | [optional] **organization_id** | **str** | the id of the organization that owns the integration | [optional] diff --git a/python/docs/SearchResult.md b/python/docs/SearchResult.md index a5acec4..98e5bbf 100644 --- a/python/docs/SearchResult.md +++ b/python/docs/SearchResult.md @@ -1,11 +1,10 @@ # SearchResult -A search result object, containing the total number of hits for the given query, and the hits themselves. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **num_hits** | **int** | | [optional] -**hits** | **dict(str, str)** | | [optional] +**hits** | [**list[SearchResultHits]**](SearchResultHits.md) | | [optional] [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/python/docs/SearchResultHits.md b/python/docs/SearchResultHits.md new file mode 100644 index 0000000..dccc863 --- /dev/null +++ b/python/docs/SearchResultHits.md @@ -0,0 +1,11 @@ +# SearchResultHits + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**property_types** | [**list[PropertyType]**](PropertyType.md) | | [optional] +**entity_set** | [**EntitySet**](EntitySet.md) | | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/python/openlattice/__init__.py b/python/openlattice/__init__.py index f2e53c3..0d3f7dd 100644 --- a/python/openlattice/__init__.py +++ b/python/openlattice/__init__.py @@ -115,6 +115,7 @@ from openlattice.models.search_constraints import SearchConstraints from openlattice.models.search_details import SearchDetails from openlattice.models.search_result import SearchResult +from openlattice.models.search_result_hits import SearchResultHits from openlattice.models.search_term import SearchTerm from openlattice.models.securable_principal import SecurablePrincipal from openlattice.models.sms_entity_set_information import SmsEntitySetInformation diff --git a/python/openlattice/models/__init__.py b/python/openlattice/models/__init__.py index 482a81a..c9dfbfb 100644 --- a/python/openlattice/models/__init__.py +++ b/python/openlattice/models/__init__.py @@ -87,6 +87,7 @@ from openlattice.models.search_constraints import SearchConstraints from openlattice.models.search_details import SearchDetails from openlattice.models.search_result import SearchResult +from openlattice.models.search_result_hits import SearchResultHits from openlattice.models.search_term import SearchTerm from openlattice.models.securable_principal import SecurablePrincipal from openlattice.models.sms_entity_set_information import SmsEntitySetInformation diff --git a/python/openlattice/models/integration.py b/python/openlattice/models/integration.py index 6a52b80..a6d0df9 100644 --- a/python/openlattice/models/integration.py +++ b/python/openlattice/models/integration.py @@ -120,7 +120,7 @@ def key(self, key): def environment(self): """Gets the environment of this Integration. # noqa: E501 - the retrofit environment (e.g. production, local) # noqa: E501 + the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) # noqa: E501 :return: The environment of this Integration. # noqa: E501 :rtype: str @@ -131,7 +131,7 @@ def environment(self): def environment(self, environment): """Sets the environment of this Integration. - the retrofit environment (e.g. production, local) # noqa: E501 + the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) # noqa: E501 :param environment: The environment of this Integration. # noqa: E501 :type environment: str diff --git a/python/openlattice/models/integration_update.py b/python/openlattice/models/integration_update.py index 8cefe3c..6713eb5 100644 --- a/python/openlattice/models/integration_update.py +++ b/python/openlattice/models/integration_update.py @@ -87,7 +87,7 @@ def __init__(self, environment=None, s3_bucket=None, contacts=None, organization def environment(self): """Gets the environment of this IntegrationUpdate. # noqa: E501 - the retrofit environment (e.g. production, local) # noqa: E501 + the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) # noqa: E501 :return: The environment of this IntegrationUpdate. # noqa: E501 :rtype: str @@ -98,7 +98,7 @@ def environment(self): def environment(self, environment): """Sets the environment of this IntegrationUpdate. - the retrofit environment (e.g. production, local) # noqa: E501 + the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) # noqa: E501 :param environment: The environment of this IntegrationUpdate. # noqa: E501 :type environment: str diff --git a/python/openlattice/models/search_result.py b/python/openlattice/models/search_result.py index 1250d7f..84abdbe 100644 --- a/python/openlattice/models/search_result.py +++ b/python/openlattice/models/search_result.py @@ -35,7 +35,7 @@ class SearchResult(object): """ openapi_types = { 'num_hits': 'int', - 'hits': 'dict(str, str)' + 'hits': 'list[SearchResultHits]' } attribute_map = { @@ -85,7 +85,7 @@ def hits(self): :return: The hits of this SearchResult. # noqa: E501 - :rtype: dict(str, str) + :rtype: list[SearchResultHits] """ return self._hits @@ -95,7 +95,7 @@ def hits(self, hits): :param hits: The hits of this SearchResult. # noqa: E501 - :type hits: dict(str, str) + :type hits: list[SearchResultHits] """ self._hits = hits diff --git a/python/openlattice/models/search_result_hits.py b/python/openlattice/models/search_result_hits.py new file mode 100644 index 0000000..2cda809 --- /dev/null +++ b/python/openlattice/models/search_result_hits.py @@ -0,0 +1,147 @@ +# coding: utf-8 + +""" + OpenLattice API + + OpenLattice API # noqa: E501 + + The version of the OpenAPI document: 0.0.1 + Contact: support@openlattice.com + Generated by: https://openapi-generator.tech +""" + + +import pprint +import re # noqa: F401 + +import six + +from openlattice.configuration import Configuration + + +class SearchResultHits(object): + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech + + Do not edit the class manually. + """ + + """ + Attributes: + openapi_types (dict): The key is attribute name + and the value is attribute type. + attribute_map (dict): The key is attribute name + and the value is json key in definition. + """ + openapi_types = { + 'property_types': 'list[PropertyType]', + 'entity_set': 'EntitySet' + } + + attribute_map = { + 'property_types': 'propertyTypes', + 'entity_set': 'entitySet' + } + + def __init__(self, property_types=None, entity_set=None, local_vars_configuration=None): # noqa: E501 + """SearchResultHits - a model defined in OpenAPI""" # noqa: E501 + if local_vars_configuration is None: + local_vars_configuration = Configuration() + self.local_vars_configuration = local_vars_configuration + + self._property_types = None + self._entity_set = None + self.discriminator = None + + if property_types is not None: + self.property_types = property_types + if entity_set is not None: + self.entity_set = entity_set + + @property + def property_types(self): + """Gets the property_types of this SearchResultHits. # noqa: E501 + + + :return: The property_types of this SearchResultHits. # noqa: E501 + :rtype: list[PropertyType] + """ + return self._property_types + + @property_types.setter + def property_types(self, property_types): + """Sets the property_types of this SearchResultHits. + + + :param property_types: The property_types of this SearchResultHits. # noqa: E501 + :type property_types: list[PropertyType] + """ + + self._property_types = property_types + + @property + def entity_set(self): + """Gets the entity_set of this SearchResultHits. # noqa: E501 + + + :return: The entity_set of this SearchResultHits. # noqa: E501 + :rtype: EntitySet + """ + return self._entity_set + + @entity_set.setter + def entity_set(self, entity_set): + """Sets the entity_set of this SearchResultHits. + + + :param entity_set: The entity_set of this SearchResultHits. # noqa: E501 + :type entity_set: EntitySet + """ + + self._entity_set = entity_set + + def to_dict(self): + """Returns the model properties as a dict""" + result = {} + + for attr, _ in six.iteritems(self.openapi_types): + value = getattr(self, attr) + if isinstance(value, list): + result[attr] = list(map( + lambda x: x.to_dict() if hasattr(x, "to_dict") else x, + value + )) + elif hasattr(value, "to_dict"): + result[attr] = value.to_dict() + elif isinstance(value, dict): + result[attr] = dict(map( + lambda item: (item[0], item[1].to_dict()) + if hasattr(item[1], "to_dict") else item, + value.items() + )) + else: + result[attr] = value + + return result + + def to_str(self): + """Returns the string representation of the model""" + return pprint.pformat(self.to_dict()) + + def __repr__(self): + """For `print` and `pprint`""" + return self.to_str() + + def __eq__(self, other): + """Returns true if both objects are equal""" + if not isinstance(other, SearchResultHits): + return False + + return self.to_dict() == other.to_dict() + + def __ne__(self, other): + """Returns true if both objects are not equal""" + if not isinstance(other, SearchResultHits): + return True + + return self.to_dict() != other.to_dict() diff --git a/python/test/test_search_result.py b/python/test/test_search_result.py index c28eb60..bd86f67 100644 --- a/python/test/test_search_result.py +++ b/python/test/test_search_result.py @@ -38,9 +38,32 @@ def make_instance(self, include_optional): if include_optional : return SearchResult( num_hits = 56, - hits = { - 'key' : '0' - } + hits = [ + openlattice.models.search_result_hits.SearchResult_hits( + property_types = [ + openlattice.models.property_type.PropertyType( + title = '0', + id = '0', + type = openlattice.models.full_qualified_name.FullQualifiedName( + name = '0', + namespace = '0', ), + description = '0', + schemas = [ + openlattice.models.full_qualified_name.FullQualifiedName( + name = '0', + namespace = '0', ) + ], + datatype = 'Binary', + pii = True, + multi_valued = True, + analyzer = 'NONE', + enum_values = [ + '0' + ], + index_type = 'BTREE', ) + ], + entity_set = {"entityTypeId":"963b597b-b28d-4f59-b2e6-4d443499e464","id":"843b597b-b28d-4f59-b2e6-4d443499e323","name":"NameOfMyEntitySet","title":"This is the title of the entitySet","contacts":["support@openlattice.com"],"description":"This is a more elaborate description of the entity set."}, ) + ] ) else : return SearchResult( diff --git a/python/test/test_search_result_hits.py b/python/test/test_search_result_hits.py new file mode 100644 index 0000000..517de36 --- /dev/null +++ b/python/test/test_search_result_hits.py @@ -0,0 +1,75 @@ +# coding: utf-8 + +""" + OpenLattice API + + OpenLattice API # noqa: E501 + + The version of the OpenAPI document: 0.0.1 + Contact: support@openlattice.com + Generated by: https://openapi-generator.tech +""" + + +from __future__ import absolute_import + +import unittest +import datetime + +import openlattice +from openlattice.models.search_result_hits import SearchResultHits # noqa: E501 +from openlattice.rest import ApiException + +class TestSearchResultHits(unittest.TestCase): + """SearchResultHits unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional): + """Test SearchResultHits + include_option is a boolean, when False only required + params are included, when True both required and + optional params are included """ + # model = openlattice.models.search_result_hits.SearchResultHits() # noqa: E501 + if include_optional : + return SearchResultHits( + property_types = [ + openlattice.models.property_type.PropertyType( + title = '0', + id = '0', + type = openlattice.models.full_qualified_name.FullQualifiedName( + name = '0', + namespace = '0', ), + description = '0', + schemas = [ + openlattice.models.full_qualified_name.FullQualifiedName( + name = '0', + namespace = '0', ) + ], + datatype = 'Binary', + pii = True, + multi_valued = True, + analyzer = 'NONE', + enum_values = [ + '0' + ], + index_type = 'BTREE', ) + ], + entity_set = {"entityTypeId":"963b597b-b28d-4f59-b2e6-4d443499e464","id":"843b597b-b28d-4f59-b2e6-4d443499e323","name":"NameOfMyEntitySet","title":"This is the title of the entitySet","contacts":["support@openlattice.com"],"description":"This is a more elaborate description of the entity set."} + ) + else : + return SearchResultHits( + ) + + def testSearchResultHits(self): + """Test SearchResultHits""" + inst_req_only = self.make_instance(include_optional=False) + inst_req_and_optional = self.make_instance(include_optional=True) + + +if __name__ == '__main__': + unittest.main() diff --git a/ruby/.gitignore b/ruby/.gitignore new file mode 100644 index 0000000..05a17cb --- /dev/null +++ b/ruby/.gitignore @@ -0,0 +1,39 @@ +# Generated by: https://openapi-generator.tech +# + +*.gem +*.rbc +/.config +/coverage/ +/InstalledFiles +/pkg/ +/spec/reports/ +/spec/examples.txt +/test/tmp/ +/test/version_tmp/ +/tmp/ + +## Specific to RubyMotion: +.dat* +.repl_history +build/ + +## Documentation cache and generated files: +/.yardoc/ +/_yardoc/ +/doc/ +/rdoc/ + +## Environment normalization: +/.bundle/ +/vendor/bundle +/lib/bundler/man/ + +# for a library or gem, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# Gemfile.lock +# .ruby-version +# .ruby-gemset + +# unless supporting rvm < 1.11.0 or doing something fancy, ignore this: +.rvmrc diff --git a/ruby/.openapi-generator-ignore b/ruby/.openapi-generator-ignore new file mode 100644 index 0000000..7484ee5 --- /dev/null +++ b/ruby/.openapi-generator-ignore @@ -0,0 +1,23 @@ +# OpenAPI Generator Ignore +# Generated by openapi-generator https://github.com/openapitools/openapi-generator + +# Use this file to prevent files from being overwritten by the generator. +# The patterns follow closely to .gitignore or .dockerignore. + +# As an example, the C# client generator defines ApiClient.cs. +# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: +#ApiClient.cs + +# You can match any string of characters against a directory, file or extension with a single asterisk (*): +#foo/*/qux +# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux + +# You can recursively match patterns against a directory, file or extension with a double asterisk (**): +#foo/**/qux +# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux + +# You can also negate patterns with an exclamation (!). +# For example, you can ignore all files in a docs folder with the file extension .md: +#docs/*.md +# Then explicitly reverse the ignore rule for a single file: +#!docs/README.md diff --git a/ruby/.openapi-generator/FILES b/ruby/.openapi-generator/FILES new file mode 100644 index 0000000..f43868b --- /dev/null +++ b/ruby/.openapi-generator/FILES @@ -0,0 +1,292 @@ +.gitignore +.openapi-generator-ignore +.rspec +.rubocop.yml +.travis.yml +Gemfile +README.md +Rakefile +docs/AccessCheck.md +docs/Ace.md +docs/Acl.md +docs/AclData.md +docs/AdminApi.md +docs/AdvancedSearch.md +docs/Association.md +docs/AssociationDefinition.md +docs/AssociationType.md +docs/Auth0userBasic.md +docs/Authorization.md +docs/AuthorizationsApi.md +docs/AuthorizedObjectsSearchResult.md +docs/BulkDataCreation.md +docs/CollectionTemplateType.md +docs/CollectionsApi.md +docs/Constraint.md +docs/ConstraintGroup.md +docs/DataApi.md +docs/DataAssociation.md +docs/DataEdge.md +docs/DataEdgeData.md +docs/DataEdgeKey.md +docs/DataGraph.md +docs/DataGraphIds.md +docs/DataIntegrationsApi.md +docs/DataSearchResult.md +docs/DatasetApi.md +docs/EDM.md +docs/EDMdiff.md +docs/EdmApi.md +docs/EdmRequest.md +docs/Entity.md +docs/EntityDataKey.md +docs/EntityDefinition.md +docs/EntityKey.md +docs/EntityKeyPair.md +docs/EntityLinkingFeatures.md +docs/EntityLinkingFeedback.md +docs/EntityNeighborsFilter.md +docs/EntitySet.md +docs/EntitySetCollection.md +docs/EntitySetPropertyMetaData.md +docs/EntitySetSelection.md +docs/EntitySetsApi.md +docs/EntityType.md +docs/EntityTypeCollection.md +docs/EntityTypePropertyMetadata.md +docs/Flight.md +docs/FlightPlanParameters.md +docs/FlightPlanParametersUpdate.md +docs/FullQualifiedName.md +docs/IndexingState.md +docs/InlineObject.md +docs/InlineResponse200.md +docs/Integration.md +docs/IntegrationJob.md +docs/IntegrationResults.md +docs/IntegrationUpdate.md +docs/LinkingApi.md +docs/LinkingFeedback.md +docs/MaterializedViewAccount.md +docs/MetadataUpdate.md +docs/NeighborEntityDetails.md +docs/NeighborEntityIds.md +docs/NeighborSearchFilter.md +docs/Organization.md +docs/OrganizationExternalDatabaseColumn.md +docs/OrganizationExternalDatabaseTable.md +docs/OrganizationExternalDatabaseTableColumnsPair.md +docs/OrganizationMember.md +docs/OrganizationsApi.md +docs/PermissionsApi.md +docs/Principal.md +docs/PrincipalApi.md +docs/PropertyDefinition.md +docs/PropertyType.md +docs/PropertyUsageSummary.md +docs/Role.md +docs/Schema.md +docs/Search.md +docs/SearchApi.md +docs/SearchConstraints.md +docs/SearchDetails.md +docs/SearchResult.md +docs/SearchResultHits.md +docs/SearchTerm.md +docs/SecurablePrincipal.md +docs/ShuttleApi.md +docs/SmsEntitySetInformation.md +docs/SortDefinition.md +git_push.sh +lib/openapi_client.rb +lib/openapi_client/api/admin_api.rb +lib/openapi_client/api/authorizations_api.rb +lib/openapi_client/api/collections_api.rb +lib/openapi_client/api/data_api.rb +lib/openapi_client/api/data_integrations_api.rb +lib/openapi_client/api/dataset_api.rb +lib/openapi_client/api/edm_api.rb +lib/openapi_client/api/entity_sets_api.rb +lib/openapi_client/api/linking_api.rb +lib/openapi_client/api/organizations_api.rb +lib/openapi_client/api/permissions_api.rb +lib/openapi_client/api/principal_api.rb +lib/openapi_client/api/search_api.rb +lib/openapi_client/api/shuttle_api.rb +lib/openapi_client/api_client.rb +lib/openapi_client/api_error.rb +lib/openapi_client/configuration.rb +lib/openapi_client/configuration.rb +lib/openapi_client/models/access_check.rb +lib/openapi_client/models/ace.rb +lib/openapi_client/models/acl.rb +lib/openapi_client/models/acl_data.rb +lib/openapi_client/models/advanced_search.rb +lib/openapi_client/models/association.rb +lib/openapi_client/models/association_definition.rb +lib/openapi_client/models/association_type.rb +lib/openapi_client/models/auth0user_basic.rb +lib/openapi_client/models/authorization.rb +lib/openapi_client/models/authorized_objects_search_result.rb +lib/openapi_client/models/bulk_data_creation.rb +lib/openapi_client/models/collection_template_type.rb +lib/openapi_client/models/constraint.rb +lib/openapi_client/models/constraint_group.rb +lib/openapi_client/models/data_association.rb +lib/openapi_client/models/data_edge.rb +lib/openapi_client/models/data_edge_data.rb +lib/openapi_client/models/data_edge_key.rb +lib/openapi_client/models/data_graph.rb +lib/openapi_client/models/data_graph_ids.rb +lib/openapi_client/models/data_search_result.rb +lib/openapi_client/models/ed_mdiff.rb +lib/openapi_client/models/edm.rb +lib/openapi_client/models/edm_request.rb +lib/openapi_client/models/entity.rb +lib/openapi_client/models/entity_data_key.rb +lib/openapi_client/models/entity_definition.rb +lib/openapi_client/models/entity_key.rb +lib/openapi_client/models/entity_key_pair.rb +lib/openapi_client/models/entity_linking_features.rb +lib/openapi_client/models/entity_linking_feedback.rb +lib/openapi_client/models/entity_neighbors_filter.rb +lib/openapi_client/models/entity_set.rb +lib/openapi_client/models/entity_set_collection.rb +lib/openapi_client/models/entity_set_property_meta_data.rb +lib/openapi_client/models/entity_set_selection.rb +lib/openapi_client/models/entity_type.rb +lib/openapi_client/models/entity_type_collection.rb +lib/openapi_client/models/entity_type_property_metadata.rb +lib/openapi_client/models/flight.rb +lib/openapi_client/models/flight_plan_parameters.rb +lib/openapi_client/models/flight_plan_parameters_update.rb +lib/openapi_client/models/full_qualified_name.rb +lib/openapi_client/models/indexing_state.rb +lib/openapi_client/models/inline_object.rb +lib/openapi_client/models/inline_response200.rb +lib/openapi_client/models/integration.rb +lib/openapi_client/models/integration_job.rb +lib/openapi_client/models/integration_results.rb +lib/openapi_client/models/integration_update.rb +lib/openapi_client/models/linking_feedback.rb +lib/openapi_client/models/materialized_view_account.rb +lib/openapi_client/models/metadata_update.rb +lib/openapi_client/models/neighbor_entity_details.rb +lib/openapi_client/models/neighbor_entity_ids.rb +lib/openapi_client/models/neighbor_search_filter.rb +lib/openapi_client/models/organization.rb +lib/openapi_client/models/organization_external_database_column.rb +lib/openapi_client/models/organization_external_database_table.rb +lib/openapi_client/models/organization_external_database_table_columns_pair.rb +lib/openapi_client/models/organization_member.rb +lib/openapi_client/models/principal.rb +lib/openapi_client/models/property_definition.rb +lib/openapi_client/models/property_type.rb +lib/openapi_client/models/property_usage_summary.rb +lib/openapi_client/models/role.rb +lib/openapi_client/models/schema.rb +lib/openapi_client/models/search.rb +lib/openapi_client/models/search_constraints.rb +lib/openapi_client/models/search_details.rb +lib/openapi_client/models/search_result.rb +lib/openapi_client/models/search_result_hits.rb +lib/openapi_client/models/search_term.rb +lib/openapi_client/models/securable_principal.rb +lib/openapi_client/models/sms_entity_set_information.rb +lib/openapi_client/models/sort_definition.rb +lib/openapi_client/version.rb +openapi_client.gemspec +spec/api/admin_api_spec.rb +spec/api/authorizations_api_spec.rb +spec/api/collections_api_spec.rb +spec/api/data_api_spec.rb +spec/api/data_integrations_api_spec.rb +spec/api/dataset_api_spec.rb +spec/api/edm_api_spec.rb +spec/api/entity_sets_api_spec.rb +spec/api/linking_api_spec.rb +spec/api/organizations_api_spec.rb +spec/api/permissions_api_spec.rb +spec/api/principal_api_spec.rb +spec/api/search_api_spec.rb +spec/api/shuttle_api_spec.rb +spec/api_client_spec.rb +spec/configuration_spec.rb +spec/models/access_check_spec.rb +spec/models/ace_spec.rb +spec/models/acl_data_spec.rb +spec/models/acl_spec.rb +spec/models/advanced_search_spec.rb +spec/models/association_definition_spec.rb +spec/models/association_spec.rb +spec/models/association_type_spec.rb +spec/models/auth0user_basic_spec.rb +spec/models/authorization_spec.rb +spec/models/authorized_objects_search_result_spec.rb +spec/models/bulk_data_creation_spec.rb +spec/models/collection_template_type_spec.rb +spec/models/constraint_group_spec.rb +spec/models/constraint_spec.rb +spec/models/data_association_spec.rb +spec/models/data_edge_data_spec.rb +spec/models/data_edge_key_spec.rb +spec/models/data_edge_spec.rb +spec/models/data_graph_ids_spec.rb +spec/models/data_graph_spec.rb +spec/models/data_search_result_spec.rb +spec/models/ed_mdiff_spec.rb +spec/models/edm_request_spec.rb +spec/models/edm_spec.rb +spec/models/entity_data_key_spec.rb +spec/models/entity_definition_spec.rb +spec/models/entity_key_pair_spec.rb +spec/models/entity_key_spec.rb +spec/models/entity_linking_features_spec.rb +spec/models/entity_linking_feedback_spec.rb +spec/models/entity_neighbors_filter_spec.rb +spec/models/entity_set_collection_spec.rb +spec/models/entity_set_property_meta_data_spec.rb +spec/models/entity_set_selection_spec.rb +spec/models/entity_set_spec.rb +spec/models/entity_spec.rb +spec/models/entity_type_collection_spec.rb +spec/models/entity_type_property_metadata_spec.rb +spec/models/entity_type_spec.rb +spec/models/flight_plan_parameters_spec.rb +spec/models/flight_plan_parameters_update_spec.rb +spec/models/flight_spec.rb +spec/models/full_qualified_name_spec.rb +spec/models/indexing_state_spec.rb +spec/models/inline_object_spec.rb +spec/models/inline_response200_spec.rb +spec/models/integration_job_spec.rb +spec/models/integration_results_spec.rb +spec/models/integration_spec.rb +spec/models/integration_update_spec.rb +spec/models/linking_feedback_spec.rb +spec/models/materialized_view_account_spec.rb +spec/models/metadata_update_spec.rb +spec/models/neighbor_entity_details_spec.rb +spec/models/neighbor_entity_ids_spec.rb +spec/models/neighbor_search_filter_spec.rb +spec/models/organization_external_database_column_spec.rb +spec/models/organization_external_database_table_columns_pair_spec.rb +spec/models/organization_external_database_table_spec.rb +spec/models/organization_member_spec.rb +spec/models/organization_spec.rb +spec/models/principal_spec.rb +spec/models/property_definition_spec.rb +spec/models/property_type_spec.rb +spec/models/property_usage_summary_spec.rb +spec/models/role_spec.rb +spec/models/schema_spec.rb +spec/models/search_constraints_spec.rb +spec/models/search_details_spec.rb +spec/models/search_result_hits_spec.rb +spec/models/search_result_spec.rb +spec/models/search_spec.rb +spec/models/search_term_spec.rb +spec/models/securable_principal_spec.rb +spec/models/sms_entity_set_information_spec.rb +spec/models/sort_definition_spec.rb +spec/spec_helper.rb diff --git a/ruby/.openapi-generator/VERSION b/ruby/.openapi-generator/VERSION new file mode 100644 index 0000000..d99e716 --- /dev/null +++ b/ruby/.openapi-generator/VERSION @@ -0,0 +1 @@ +5.0.0-SNAPSHOT \ No newline at end of file diff --git a/ruby/.rspec b/ruby/.rspec new file mode 100644 index 0000000..83e16f8 --- /dev/null +++ b/ruby/.rspec @@ -0,0 +1,2 @@ +--color +--require spec_helper diff --git a/ruby/.rubocop.yml b/ruby/.rubocop.yml new file mode 100644 index 0000000..d32b2b1 --- /dev/null +++ b/ruby/.rubocop.yml @@ -0,0 +1,148 @@ +# This file is based on https://github.com/rails/rails/blob/master/.rubocop.yml (MIT license) +# Automatically generated by OpenAPI Generator (https://openapi-generator.tech) +AllCops: + TargetRubyVersion: 2.4 + # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop + # to ignore them, so only the ones explicitly set in this file are enabled. + DisabledByDefault: true + Exclude: + - '**/templates/**/*' + - '**/vendor/**/*' + - 'actionpack/lib/action_dispatch/journey/parser.rb' + +# Prefer &&/|| over and/or. +Style/AndOr: + Enabled: true + +# Align `when` with `case`. +Layout/CaseIndentation: + Enabled: true + +# Align comments with method definitions. +Layout/CommentIndentation: + Enabled: true + +Layout/ElseAlignment: + Enabled: true + +Layout/EmptyLineAfterMagicComment: + Enabled: true + +# In a regular class definition, no empty lines around the body. +Layout/EmptyLinesAroundClassBody: + Enabled: true + +# In a regular method definition, no empty lines around the body. +Layout/EmptyLinesAroundMethodBody: + Enabled: true + +# In a regular module definition, no empty lines around the body. +Layout/EmptyLinesAroundModuleBody: + Enabled: true + +Layout/FirstArgumentIndentation: + Enabled: true + +# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }. +Style/HashSyntax: + Enabled: false + +# Method definitions after `private` or `protected` isolated calls need one +# extra level of indentation. +Layout/IndentationConsistency: + Enabled: true + EnforcedStyle: indented_internal_methods + +# Two spaces, no tabs (for indentation). +Layout/IndentationWidth: + Enabled: true + +Layout/LeadingCommentSpace: + Enabled: true + +Layout/SpaceAfterColon: + Enabled: true + +Layout/SpaceAfterComma: + Enabled: true + +Layout/SpaceAroundEqualsInParameterDefault: + Enabled: true + +Layout/SpaceAroundKeyword: + Enabled: true + +Layout/SpaceAroundOperators: + Enabled: true + +Layout/SpaceBeforeComma: + Enabled: true + +Layout/SpaceBeforeFirstArg: + Enabled: true + +Style/DefWithParentheses: + Enabled: true + +# Defining a method with parameters needs parentheses. +Style/MethodDefParentheses: + Enabled: true + +Style/FrozenStringLiteralComment: + Enabled: false + EnforcedStyle: always + +# Use `foo {}` not `foo{}`. +Layout/SpaceBeforeBlockBraces: + Enabled: true + +# Use `foo { bar }` not `foo {bar}`. +Layout/SpaceInsideBlockBraces: + Enabled: true + +# Use `{ a: 1 }` not `{a:1}`. +Layout/SpaceInsideHashLiteralBraces: + Enabled: true + +Layout/SpaceInsideParens: + Enabled: true + +# Check quotes usage according to lint rule below. +#Style/StringLiterals: +# Enabled: true +# EnforcedStyle: single_quotes + +# Detect hard tabs, no hard tabs. +Layout/IndentationStyle: + Enabled: true + +# Blank lines should not have any spaces. +Layout/TrailingEmptyLines: + Enabled: true + +# No trailing whitespace. +Layout/TrailingWhitespace: + Enabled: false + +# Use quotes for string literals when they are enough. +Style/RedundantPercentQ: + Enabled: true + +# Align `end` with the matching keyword or starting expression except for +# assignments, where it should be aligned with the LHS. +Layout/EndAlignment: + Enabled: true + EnforcedStyleAlignWith: variable + AutoCorrect: true + +# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg. +Lint/RequireParentheses: + Enabled: true + +Style/RedundantReturn: + Enabled: true + AllowMultipleReturnValues: true + +Style/Semicolon: + Enabled: true + AllowAsExpressionSeparator: true diff --git a/ruby/.travis.yml b/ruby/.travis.yml new file mode 100644 index 0000000..219f99f --- /dev/null +++ b/ruby/.travis.yml @@ -0,0 +1,11 @@ +language: ruby +cache: bundler +rvm: + - 2.3 + - 2.4 + - 2.5 +script: + - bundle install --path vendor/bundle + - bundle exec rspec + - gem build openapi_client.gemspec + - gem install ./openapi_client-1.0.0.gem diff --git a/ruby/Gemfile b/ruby/Gemfile new file mode 100644 index 0000000..c2e3127 --- /dev/null +++ b/ruby/Gemfile @@ -0,0 +1,9 @@ +source 'https://rubygems.org' + +gemspec + +group :development, :test do + gem 'rake', '~> 13.0.1' + gem 'pry-byebug' + gem 'rubocop', '~> 0.66.0' +end diff --git a/ruby/README.md b/ruby/README.md new file mode 100644 index 0000000..6ccd187 --- /dev/null +++ b/ruby/README.md @@ -0,0 +1,382 @@ +# openapi_client + +OpenapiClient - the Ruby gem for the OpenLattice API + +OpenLattice API + +This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: + +- API version: 0.0.1 +- Package version: 1.0.0 +- Build package: org.openapitools.codegen.languages.RubyClientCodegen + +## Installation + +### Build a gem + +To build the Ruby code into a gem: + +```shell +gem build openapi_client.gemspec +``` + +Then either install the gem locally: + +```shell +gem install ./openapi_client-1.0.0.gem +``` + +(for development, run `gem install --dev ./openapi_client-1.0.0.gem` to install the development dependencies) + +or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/). + +Finally add this to the Gemfile: + + gem 'openapi_client', '~> 1.0.0' + +### Install from Git + +If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile: + + gem 'openapi_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git' + +### Include the Ruby code directly + +Include the Ruby code directly using `-I` as follows: + +```shell +ruby -Ilib script.rb +``` + +## Getting Started + +Please follow the [installation](#installation) procedure and then run the following code: + +```ruby +# Load the gem +require 'openapi_client' + +# Setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::AdminApi.new + +begin + #Clears all the data currently being indexed in the queue. + result = api_instance.clear_indexing_queue + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling AdminApi->clear_indexing_queue: #{e}" +end + +``` + +## Documentation for API Endpoints + +All URIs are relative to *https://api.openlattice.com* + +Class | Method | HTTP request | Description +------------ | ------------- | ------------- | ------------- +*OpenapiClient::AdminApi* | [**clear_indexing_queue**](docs/AdminApi.md#clear_indexing_queue) | **DELETE** /indexer/index/reindex | Clears all the data currently being indexed in the queue. +*OpenapiClient::AdminApi* | [**get_indexing_state**](docs/AdminApi.md#get_indexing_state) | **GET** /indexer/index/reindex | Retrieve the current state of reindexing jobs +*OpenapiClient::AdminApi* | [**reindex**](docs/AdminApi.md#reindex) | **POST** /indexer/index/reindex | Merge job descriptions for performing a partial or full reindex of provided entity sets. +*OpenapiClient::AdminApi* | [**update_reindex**](docs/AdminApi.md#update_reindex) | **PUT** /indexer/index/reindex | Replaces job descriptions for performing a partial or full reindex of provided entity sets. +*OpenapiClient::AuthorizationsApi* | [**check_authorizations**](docs/AuthorizationsApi.md#check_authorizations) | **POST** /datastore/authorizations | Check authorizations +*OpenapiClient::AuthorizationsApi* | [**get_accessible_objects**](docs/AuthorizationsApi.md#get_accessible_objects) | **GET** /datastore/authorizations | Returns paged results for all authorized objects of specified objectType, that the current user has specified permission for. +*OpenapiClient::CollectionsApi* | [**add_type_to_entity_type_collection_template**](docs/CollectionsApi.md#add_type_to_entity_type_collection_template) | **PATCH** /datastore/collections/entity/type/{entityTypeCollectionId}/template | Appends type to template of the specified EntityTypeCollection +*OpenapiClient::CollectionsApi* | [**create_entity_set_collection**](docs/CollectionsApi.md#create_entity_set_collection) | **POST** /datastore/collections/entity/set | Creates a new EntitySetCollection +*OpenapiClient::CollectionsApi* | [**create_entity_type_collection**](docs/CollectionsApi.md#create_entity_type_collection) | **POST** /datastore/collections/entity/type | Creates a new EntityTypeCollection +*OpenapiClient::CollectionsApi* | [**delete_entity_set_collection**](docs/CollectionsApi.md#delete_entity_set_collection) | **DELETE** /datastore/collections/entity/set/{entitySetCollectionId} | Deletes the specified EntitySetCollection +*OpenapiClient::CollectionsApi* | [**delete_entity_type_collection**](docs/CollectionsApi.md#delete_entity_type_collection) | **DELETE** /datastore/collections/entity/type/{entityTypeCollectionId} | Deletes the specified EntityTypeCollection +*OpenapiClient::CollectionsApi* | [**get_all_entity_set_collections**](docs/CollectionsApi.md#get_all_entity_set_collections) | **GET** /datastore/collections/entity/set | Returns all EntitySetCollection objects +*OpenapiClient::CollectionsApi* | [**get_all_entity_type_collections**](docs/CollectionsApi.md#get_all_entity_type_collections) | **GET** /datastore/collections/entity/type | Returns all EntityTypeCollection objects +*OpenapiClient::CollectionsApi* | [**get_entity_set_collection**](docs/CollectionsApi.md#get_entity_set_collection) | **GET** /datastore/collections/entity/set/{entitySetCollectionId} | Returns the EntitySetCollection object for a given id +*OpenapiClient::CollectionsApi* | [**get_entity_set_collections_of_type**](docs/CollectionsApi.md#get_entity_set_collections_of_type) | **GET** /datastore/collections/entity/set/entity/type/{entitySetCollectionId} | Returns all authorized EntitySetCollections for a given EntityTypeCollection id +*OpenapiClient::CollectionsApi* | [**get_entity_type_collection**](docs/CollectionsApi.md#get_entity_type_collection) | **GET** /datastore/collections/entity/type/{entityTypeCollectionId} | Returns the EntityTypeCollection object for a given id +*OpenapiClient::CollectionsApi* | [**remove_type_from_entity_type_collection_template**](docs/CollectionsApi.md#remove_type_from_entity_type_collection_template) | **DELETE** /datastore/collections/entity/type/{entityTypeCollectionId}/template/{typeId} | Removes a key from an EntityTypeCollection template +*OpenapiClient::CollectionsApi* | [**update_entity_set_collection_metadata**](docs/CollectionsApi.md#update_entity_set_collection_metadata) | **PATCH** /datastore/collections/entity/set/{entitySetCollectionId} | Updates metadata of the specified EntitySetCollection +*OpenapiClient::CollectionsApi* | [**update_entity_set_collection_template**](docs/CollectionsApi.md#update_entity_set_collection_template) | **PATCH** /datastore/collections/entity/set/{entitySetCollectionId}/template | Updates template of the specified EntitySetCollection +*OpenapiClient::CollectionsApi* | [**update_entity_type_collection_metadata**](docs/CollectionsApi.md#update_entity_type_collection_metadata) | **PATCH** /datastore/collections/entity/type/{entityTypeCollectionId} | Updates metadata of the specified EntityTypeCollection +*OpenapiClient::DataApi* | [**create_associations**](docs/DataApi.md#create_associations) | **POST** /datastore/data/association | Creates a new set of associations. +*OpenapiClient::DataApi* | [**create_edges**](docs/DataApi.md#create_edges) | **PUT** /datastore/data/association | Creates a new set of associations. +*OpenapiClient::DataApi* | [**create_entities**](docs/DataApi.md#create_entities) | **POST** /datastore/data/set/ | Creates a new set of entities. +*OpenapiClient::DataApi* | [**create_entity_and_association_data**](docs/DataApi.md#create_entity_and_association_data) | **POST** /datastore/data | Creates entities and assocations +*OpenapiClient::DataApi* | [**delete_all_entities_from_entity_set**](docs/DataApi.md#delete_all_entities_from_entity_set) | **DELETE** /datastore/data/set/{entitySetId}/all | Clears the Entity matching the given Entity id and all of its neighbor Entities +*OpenapiClient::DataApi* | [**delete_entities**](docs/DataApi.md#delete_entities) | **DELETE** /datastore/data/set/{entitySetId} | Deletes multiple entities from an entity set. +*OpenapiClient::DataApi* | [**delete_entities_and_neighbors**](docs/DataApi.md#delete_entities_and_neighbors) | **POST** /datastore/data/set/{entitySetId}/neighbors | Deletes the entities matching the given entity ids and all of its neighbor entities provided in the filter. +*OpenapiClient::DataApi* | [**delete_entity**](docs/DataApi.md#delete_entity) | **DELETE** /datastore/data/set/{entitySetId}/{entityKeyId} | Deletes a single entity from an entity set. +*OpenapiClient::DataApi* | [**delete_entity_properties**](docs/DataApi.md#delete_entity_properties) | **DELETE** /datastore/data/{entitySetId}/{entityKeyId}/properties | Deletes properties from an entity. +*OpenapiClient::DataApi* | [**get_entity**](docs/DataApi.md#get_entity) | **GET** /datastore/data/{entitySetId}/{entityKeyId} | Loads a single entity by its entityKeyId and entitySetId +*OpenapiClient::DataApi* | [**get_entity_property_values**](docs/DataApi.md#get_entity_property_values) | **GET** /datastore/data/{entitySetId}/{entityKeyId}/{propertyTypeId} | Loads property values for a single entity by its entityKeyId, entitySetId and propertyTypeId +*OpenapiClient::DataApi* | [**get_entity_set_size**](docs/DataApi.md#get_entity_set_size) | **GET** /datastore/data/{entitySetId}/count | Gets the number of entities in an entity set. +*OpenapiClient::DataApi* | [**load_entity_set_data**](docs/DataApi.md#load_entity_set_data) | **GET** /datastore/data/set/{entitySetId} | Gets an iterable containing the entity data, using property type FQNs as key +*OpenapiClient::DataApi* | [**load_linked_entity_set_breakdown**](docs/DataApi.md#load_linked_entity_set_breakdown) | **POST** /datastore/data/set/{linkedEntitySetId}/detailed | Loads a linked entity set breakdown with the selected linked entities and properties. +*OpenapiClient::DataApi* | [**load_selected_entity_set_data**](docs/DataApi.md#load_selected_entity_set_data) | **POST** /datastore/data/set/{entitySetId} | Gets a list of entities by UUIDs +*OpenapiClient::DataApi* | [**replace_association_data**](docs/DataApi.md#replace_association_data) | **PATCH** /datastore/data/association | Replaces Association Data +*OpenapiClient::DataApi* | [**replace_entity_properties**](docs/DataApi.md#replace_entity_properties) | **PATCH** /datastore/data/set/{entitySetId} | Replaces Entity Properties +*OpenapiClient::DataApi* | [**update_entities_in_entity_set**](docs/DataApi.md#update_entities_in_entity_set) | **PUT** /datastore/data/set/{entitySetId} | Perform one of the following bulk update operations on entities (type = Merge) adds new properties without affecting existing data, (type = PartialReplace) replaces all values for supplied property types, but does not not affect other property types for an entity, (type = Replace) replaces all entity data with the supplied properties. +*OpenapiClient::DataIntegrationsApi* | [**get_entity_key_ids**](docs/DataIntegrationsApi.md#get_entity_key_ids) | **POST** /datastore/integration/entityKeyIds | Get entity key IDs +*OpenapiClient::DataIntegrationsApi* | [**integrate_entity_and_association_data**](docs/DataIntegrationsApi.md#integrate_entity_and_association_data) | **POST** /datastore/integration | Integrate entity and association data +*OpenapiClient::DatasetApi* | [**delete_external_database_column**](docs/DatasetApi.md#delete_external_database_column) | **DELETE** /datastore/organization-database/{organizationId}/{tableName}/{columnName}/external-database-column | Deletes an OrganizationExternalDatabaseColumn object, which represents an organization's column in an external database. This deletes both the object and the column in the database. It is a hard delete. +*OpenapiClient::DatasetApi* | [**delete_external_database_columns**](docs/DatasetApi.md#delete_external_database_columns) | **DELETE** /datastore/organization-database/{organizationId}/{tableName}/external-database-column | Deletes multiple OrganizationExternalDatabaseColumn objects and the columns they represent within an organization's table in an external database. It is a hard delete +*OpenapiClient::DatasetApi* | [**delete_external_database_table**](docs/DatasetApi.md#delete_external_database_table) | **DELETE** /datastore/organization-database/{organizationId}/{tableName}/external-database-table | Deletes an OrganizationExternalDatabaseTable object, which represents an organization's table in an external database. This deletes both the object and the table in the database. It is a hard delete. +*OpenapiClient::DatasetApi* | [**delete_external_database_tables**](docs/DatasetApi.md#delete_external_database_tables) | **DELETE** /datastore/organization-database/{organizationId}/external-database-table | Deletes multiple OrganizationExternalDatabaseTable objects and the tables they represent in the database. It is a hard delete. +*OpenapiClient::DatasetApi* | [**get_authorized_external_db_tables_with_column_metadata**](docs/DatasetApi.md#get_authorized_external_db_tables_with_column_metadata) | **GET** /datastore/organization-database/{organizationId}/{permission}/external-database-table/external-database-column/authorized | Gets a map of all OrganizationExternalDatabaseTable objects to OrganizationExternalDatabase columns that are contained within each table. +*OpenapiClient::DatasetApi* | [**get_external_database_column**](docs/DatasetApi.md#get_external_database_column) | **GET** /datastore/organization-database/{organizationId}/{tableName}/{columnName}/external-database-column | Gets an OrganizationExternalDatabaseColumn object, which represents a column within an organization's table in an external database. +*OpenapiClient::DatasetApi* | [**get_external_database_table**](docs/DatasetApi.md#get_external_database_table) | **GET** /datastore/organization-database/{organizationId}/{tableName}/external-database-table | Gets an OrganizationExternalDatabaseTable object, which represents an organization's table in an external database. +*OpenapiClient::DatasetApi* | [**get_external_database_table_with_column_metadata**](docs/DatasetApi.md#get_external_database_table_with_column_metadata) | **GET** /datastore/organization-database/{organizationId}/{tableId}/external-database-table/external-database-column | Gets an object containing an OrganizationExternalDatabaseTable object and its OrganizationExternalDatabase columns for an organization +*OpenapiClient::DatasetApi* | [**get_external_database_tables**](docs/DatasetApi.md#get_external_database_tables) | **GET** /datastore/organization-database/{organizationId}/external-database-table | Gets all OrganizationExternalDatabaseTable objects for an organization +*OpenapiClient::DatasetApi* | [**get_external_database_tables_with_column_metadata**](docs/DatasetApi.md#get_external_database_tables_with_column_metadata) | **GET** /datastore/organization-database/{organizationId}/external-database-table/external-database-column | Gets a map of all OrganizationExternalDatabaseTable objects to OrganizationExternalDatabase columns that are contained within each table. +*OpenapiClient::DatasetApi* | [**update_external_database_column**](docs/DatasetApi.md#update_external_database_column) | **PATCH** /datastore/organization-database/{organizationId}/{tableName}/{columnName}/external-database-column | Updates an OrganizationExternalDatabaseTableColumn object's fields that are included within the given metadata. +*OpenapiClient::DatasetApi* | [**update_external_database_table**](docs/DatasetApi.md#update_external_database_table) | **PATCH** /datastore/organization-database/{organizationId}/{tableName}/external-database-table | Updates an OrganizationExternalDatabaseTable object's fields that are included within the given metadata. +*OpenapiClient::EdmApi* | [**add_dst_entity_type_to_association_type**](docs/EdmApi.md#add_dst_entity_type_to_association_type) | **PUT** /datastore/edm/association/type/{associationTypeId}/dst/{entityTypeId} | Update the AssociationType dst entity types for the given AssociationType UUID by adding the given EntityType UUID. +*OpenapiClient::EdmApi* | [**add_entity_sets_to_linking_entity_set**](docs/EdmApi.md#add_entity_sets_to_linking_entity_set) | **POST** /datastore/entity-sets/linking/{linkingEntitySetId} | Adds the entity sets as linked entity sets to the linking entity set +*OpenapiClient::EdmApi* | [**add_entity_sets_to_linking_entity_sets**](docs/EdmApi.md#add_entity_sets_to_linking_entity_sets) | **PUT** /datastore/entity-sets/linking/ | Adds the entity sets as linked entity sets to the linking entity sets +*OpenapiClient::EdmApi* | [**add_primary_key_to_entity_type**](docs/EdmApi.md#add_primary_key_to_entity_type) | **PUT** /datastore/edm/entity/type/key/{entityTypeId}/{propertyTypeId} | Adds a primary key with a given ID to an entity type with a given ID. +*OpenapiClient::EdmApi* | [**add_property_type_to_entity_type**](docs/EdmApi.md#add_property_type_to_entity_type) | **PUT** /datastore/edm/entity/type/{entityTypeId}/{propertyTypeId} | Updates the EntityType definition for the given EntityType UUID by adding the given PropertyType UUID. +*OpenapiClient::EdmApi* | [**add_src_entity_type_to_association_type**](docs/EdmApi.md#add_src_entity_type_to_association_type) | **PUT** /datastore/edm/association/type/{associationTypeId}/src/{entityTypeId} | Update the AssociationType src entity types for the given AssociationType UUID by adding the given EntityType UUID. +*OpenapiClient::EdmApi* | [**create_association_type**](docs/EdmApi.md#create_association_type) | **POST** /datastore/edm/association/type/ | Creates a new AssociationType definition, if it doesn't exist. +*OpenapiClient::EdmApi* | [**create_empty_schema**](docs/EdmApi.md#create_empty_schema) | **PUT** /datastore/edm/schema/{namespace}/{name} | Creates an empty schema, if it doesn't exist. If schema exists then no action is taken. +*OpenapiClient::EdmApi* | [**create_entity_sets**](docs/EdmApi.md#create_entity_sets) | **POST** /datastore/entity-sets | Creates new EntitySet definitions if they don't exist. +*OpenapiClient::EdmApi* | [**create_entity_type**](docs/EdmApi.md#create_entity_type) | **POST** /datastore/edm/entity/type/ | Creates a new EntityType definition, if it doesn't exist. +*OpenapiClient::EdmApi* | [**create_property_type**](docs/EdmApi.md#create_property_type) | **POST** /datastore/edm/property/type/ | Creates a new PropertyType definition, if it doesn\"t exist. +*OpenapiClient::EdmApi* | [**create_schema_if_not_exists**](docs/EdmApi.md#create_schema_if_not_exists) | **POST** /datastore/edm/schema | Creates an empty schema, if it doesn't exist. If schema exists then no action is taken. +*OpenapiClient::EdmApi* | [**delete_association_type**](docs/EdmApi.md#delete_association_type) | **DELETE** /datastore/edm/association/type/{associationTypeId} | Deletes the AssociationType definition for the given AssociationType UUID. +*OpenapiClient::EdmApi* | [**delete_entity_set**](docs/EdmApi.md#delete_entity_set) | **DELETE** /datastore/entity-sets/all/{entitySetId} | Deletes the EntitySet definition for the given EntitySet UUID. +*OpenapiClient::EdmApi* | [**delete_entity_type**](docs/EdmApi.md#delete_entity_type) | **DELETE** /datastore/edm/entity/type/{entityTypeId} | Deletes the EntityType definition for the given EntityType UUID. +*OpenapiClient::EdmApi* | [**delete_property_type**](docs/EdmApi.md#delete_property_type) | **DELETE** /datastore/edm/property/type/{propertyTypeId} | Deletes the PropertyType definition for the given PropertyType UUID. +*OpenapiClient::EdmApi* | [**force_delete_property_type**](docs/EdmApi.md#force_delete_property_type) | **DELETE** /datastore/edm/property/type/{propertyTypeId}/force | Deletes the PropertyType definition for the given PropertyType UUID regardless of whether or not there is data associated with it. +*OpenapiClient::EdmApi* | [**force_remove_property_type_from_entity_type**](docs/EdmApi.md#force_remove_property_type_from_entity_type) | **DELETE** /datastore/edm/entity/type/{entityTypeId}/{propertyTypeId}/force | Updates the EntityType definition for the given EntityType UUID by removing the given PropertyType UUID, regardless of whether or not there is data associated with the entity type. +*OpenapiClient::EdmApi* | [**get_all_association_entity_types**](docs/EdmApi.md#get_all_association_entity_types) | **GET** /datastore/edm/association/type/ | Gets all association EntityType definitions. +*OpenapiClient::EdmApi* | [**get_all_available_association_types**](docs/EdmApi.md#get_all_available_association_types) | **GET** /datastore/edm/association/type/{associationTypeId}/available | Get all available associations for the given AssociationType UUID. +*OpenapiClient::EdmApi* | [**get_all_entity_set_property_metadata**](docs/EdmApi.md#get_all_entity_set_property_metadata) | **GET** /datastore/entity-sets/all/{entitySetId}/metadata | Get all entity set property metadata. +*OpenapiClient::EdmApi* | [**get_all_entity_sets**](docs/EdmApi.md#get_all_entity_sets) | **GET** /datastore/entity-sets | Get all EntitySet definitions. +*OpenapiClient::EdmApi* | [**get_all_entity_type_property_metadata**](docs/EdmApi.md#get_all_entity_type_property_metadata) | **GET** /datastore/edm/entity/type/{entityTypeId}/property/type | Get all EntityType propertyType metadata +*OpenapiClient::EdmApi* | [**get_all_entity_types**](docs/EdmApi.md#get_all_entity_types) | **GET** /datastore/edm/entity/type/ | Gets all EntityType definitions. +*OpenapiClient::EdmApi* | [**get_all_property_types**](docs/EdmApi.md#get_all_property_types) | **GET** /datastore/edm/property/type/ | Gets all PropertyType definitions. +*OpenapiClient::EdmApi* | [**get_all_property_types_in_namespace**](docs/EdmApi.md#get_all_property_types_in_namespace) | **GET** /datastore/edm/property/type/namespace/{namespace} | Gets all PropertyType definitions under the given namespace. +*OpenapiClient::EdmApi* | [**get_all_property_usage_summaries**](docs/EdmApi.md#get_all_property_usage_summaries) | **GET** /datastore/edm/summary | Get Property Usage Summary for all properties. +*OpenapiClient::EdmApi* | [**get_association_type**](docs/EdmApi.md#get_association_type) | **GET** /datastore/edm/association/type/{associationTypeId} | Get the AssociationType definition for the given AssociationType UUID. +*OpenapiClient::EdmApi* | [**get_association_type_details**](docs/EdmApi.md#get_association_type_details) | **GET** /datastore/edm/association/type/{associationTypeId}/detailed | Get details about the AssociationType for the given AssociationType UUID. +*OpenapiClient::EdmApi* | [**get_entity_data_model**](docs/EdmApi.md#get_entity_data_model) | **GET** /datastore/edm/ | Gets the entity data model, including namespaces, schemas, entity types, association types, and property types. +*OpenapiClient::EdmApi* | [**get_entity_data_model_diff**](docs/EdmApi.md#get_entity_data_model_diff) | **POST** /datastore/edm/diff/ | Gets the changes between the existing entity data model and the entity data model passed in, including schemas, association types, entity types, and property types. +*OpenapiClient::EdmApi* | [**get_entity_set**](docs/EdmApi.md#get_entity_set) | **GET** /datastore/entity-sets/all/{entitySetId} | Get the EntitySet definition for the given EntitySet UUID. +*OpenapiClient::EdmApi* | [**get_entity_set_id**](docs/EdmApi.md#get_entity_set_id) | **GET** /datastore/entity-sets/ids/{entitySetName} | Gets the EntitySet UUID for the given EntitySet name. +*OpenapiClient::EdmApi* | [**get_entity_set_ids**](docs/EdmApi.md#get_entity_set_ids) | **POST** /datastore/entity-sets/ids/ | Get IDs for entity sets given their names. +*OpenapiClient::EdmApi* | [**get_entity_set_property_metadata**](docs/EdmApi.md#get_entity_set_property_metadata) | **GET** /datastore/entity-sets/all/{entitySetId}/properties/{propertyTypeId}/ | Get specified property type metadata for an entity set. +*OpenapiClient::EdmApi* | [**get_entity_type**](docs/EdmApi.md#get_entity_type) | **GET** /datastore/edm/entity/type/{entityTypeId} | Gets the EntityType definition for the given EntityType UUID. +*OpenapiClient::EdmApi* | [**get_entity_type_hierarchy**](docs/EdmApi.md#get_entity_type_hierarchy) | **PATCH** /datastore/edm/entity/type/{entityTypeId}/hierarchy | Get the EntityType hierarchy for the given EntityType UUID. +*OpenapiClient::EdmApi* | [**get_entity_type_id**](docs/EdmApi.md#get_entity_type_id) | **GET** /datastore/edm/ids/entity/type/{namespace}/{name} | Gets the EntityType UUID for the given EntityType FQN. +*OpenapiClient::EdmApi* | [**get_entity_type_property_metadata**](docs/EdmApi.md#get_entity_type_property_metadata) | **GET** /datastore/edm/entity/type/{entityTypeId}/property/type/{propertyTypeId} | Get EntityType propertyType metadata +*OpenapiClient::EdmApi* | [**get_property_metadata_for_entity_sets**](docs/EdmApi.md#get_property_metadata_for_entity_sets) | **POST** /datastore/entity-sets/all/metadata | Get property metadata for entity sets. +*OpenapiClient::EdmApi* | [**get_property_type**](docs/EdmApi.md#get_property_type) | **GET** /datastore/edm/property/type/{propertyTypeId} | Gets the PropertyType definition for the given PropertyType UUID. +*OpenapiClient::EdmApi* | [**get_property_type_id**](docs/EdmApi.md#get_property_type_id) | **GET** /datastore/edm/ids/property/type/{namespace}/{name} | Gets the PropertyType UUID for the given PropertyType FQN. +*OpenapiClient::EdmApi* | [**get_property_types_for_entity_set**](docs/EdmApi.md#get_property_types_for_entity_set) | **GET** /datastore/entity-sets/all/{entitySetId}/properties | Get all Property Types for entity set +*OpenapiClient::EdmApi* | [**get_property_usage_summary**](docs/EdmApi.md#get_property_usage_summary) | **GET** /datastore/edm/summary/{propertyTypeId} | Get Property Usage Summary for property with given ID. +*OpenapiClient::EdmApi* | [**get_schema_contents**](docs/EdmApi.md#get_schema_contents) | **GET** /datastore/edm/schema/{namespace}/{name} | Gets the schema contents for a corresponding namespace and name. +*OpenapiClient::EdmApi* | [**get_schemas**](docs/EdmApi.md#get_schemas) | **GET** /datastore/edm/schema | Gets all schemas. +*OpenapiClient::EdmApi* | [**get_schemas_in_namespace**](docs/EdmApi.md#get_schemas_in_namespace) | **GET** /datastore/edm/schema/{namespace} | Gets all schemas associated with a given namespace and accessible by the caller. +*OpenapiClient::EdmApi* | [**remove_dst_entity_type_from_association_type**](docs/EdmApi.md#remove_dst_entity_type_from_association_type) | **DELETE** /datastore/edm/association/type/{associationTypeId}/dst/{entityTypeId} | Updates the AssociationType dst entity types for the given AssociationType UUID by removing the given EntityType UUID. +*OpenapiClient::EdmApi* | [**remove_entity_sets_from_linking_entity_set**](docs/EdmApi.md#remove_entity_sets_from_linking_entity_set) | **DELETE** /datastore/entity-sets/linking/{linkingEntitySetId} | Removes/unlinks the linked entity sets from the linking entity set +*OpenapiClient::EdmApi* | [**remove_entity_sets_from_linking_entity_sets**](docs/EdmApi.md#remove_entity_sets_from_linking_entity_sets) | **DELETE** /datastore/entity-sets/linking/ | Removes/unlinks the linked entity sets from the linking entity set +*OpenapiClient::EdmApi* | [**remove_primary_key_from_entity_type**](docs/EdmApi.md#remove_primary_key_from_entity_type) | **DELETE** /datastore/edm/entity/type/key/{entityTypeId}/{propertyTypeId} | Removes a primary key with a given ID from an entity type with a given ID. +*OpenapiClient::EdmApi* | [**remove_property_type_from_entity_type**](docs/EdmApi.md#remove_property_type_from_entity_type) | **DELETE** /datastore/edm/entity/type/{entityTypeId}/{propertyTypeId} | Updates the EntityType definition for the given EntityType UUID by removing the given PropertyType UUID. +*OpenapiClient::EdmApi* | [**remove_src_entity_type_from_association_type**](docs/EdmApi.md#remove_src_entity_type_from_association_type) | **DELETE** /datastore/edm/association/type/{associationTypeId}/src/{entityTypeId} | Updates the AssociationType src entity types for the given AssociationType UUID by removing the given EntityType UUID. +*OpenapiClient::EdmApi* | [**reorder_property_types_in_entity_type**](docs/EdmApi.md#reorder_property_types_in_entity_type) | **PATCH** /datastore/edm/entity/type/{entityTypeId}/property/type | Updates the EntityType definition for the given EntityType UUID by reordering its properties as specified by the provided list. +*OpenapiClient::EdmApi* | [**update_entity_data_model**](docs/EdmApi.md#update_entity_data_model) | **PATCH** /datastore/edm/ | Updates the entity data model, including schemas, entity types, association types, and property types. +*OpenapiClient::EdmApi* | [**update_entity_set_meta_data**](docs/EdmApi.md#update_entity_set_meta_data) | **PATCH** /datastore/entity-sets/all/{entitySetId}/metadata/ | Updates the EntitySet definition for the given EntitySet UUID with the given metadata. +*OpenapiClient::EdmApi* | [**update_entity_set_property_metadata**](docs/EdmApi.md#update_entity_set_property_metadata) | **POST** /datastore/entity-sets/all/{entitySetId}/properties/{propertyTypeId}/ | Updates the property type metadata for the given entity set. +*OpenapiClient::EdmApi* | [**update_entity_type_meta_data**](docs/EdmApi.md#update_entity_type_meta_data) | **PATCH** /datastore/edm/entity/type/{entityTypeId} | Updates the EntityType definition for the given EntityType UUID with the given metadata. +*OpenapiClient::EdmApi* | [**update_entity_type_property_metadata**](docs/EdmApi.md#update_entity_type_property_metadata) | **POST** /datastore/edm/entity/type/{entityTypeId}/property/type/{propertyTypeId} | Update EntityType Property metadata +*OpenapiClient::EdmApi* | [**update_property_type_meta_data**](docs/EdmApi.md#update_property_type_meta_data) | **PATCH** /datastore/edm/property/type/{propertyTypeId} | Updates the PropertyType definition for the given PropertyType UUID with the given metadata. +*OpenapiClient::EdmApi* | [**update_schema**](docs/EdmApi.md#update_schema) | **PATCH** /datastore/edm/schema/{namespace}/{name} | Edits the schema contents for a corresponding namespace and name. +*OpenapiClient::EntitySetsApi* | [**add_entity_sets_to_linking_entity_set**](docs/EntitySetsApi.md#add_entity_sets_to_linking_entity_set) | **POST** /datastore/entity-sets/linking/{linkingEntitySetId} | Adds the entity sets as linked entity sets to the linking entity set +*OpenapiClient::EntitySetsApi* | [**add_entity_sets_to_linking_entity_sets**](docs/EntitySetsApi.md#add_entity_sets_to_linking_entity_sets) | **PUT** /datastore/entity-sets/linking/ | Adds the entity sets as linked entity sets to the linking entity sets +*OpenapiClient::EntitySetsApi* | [**create_entity_sets**](docs/EntitySetsApi.md#create_entity_sets) | **POST** /datastore/entity-sets | Creates new EntitySet definitions if they don't exist. +*OpenapiClient::EntitySetsApi* | [**delete_entity_set**](docs/EntitySetsApi.md#delete_entity_set) | **DELETE** /datastore/entity-sets/all/{entitySetId} | Deletes the EntitySet definition for the given EntitySet UUID. +*OpenapiClient::EntitySetsApi* | [**get_all_entity_set_property_metadata**](docs/EntitySetsApi.md#get_all_entity_set_property_metadata) | **GET** /datastore/entity-sets/all/{entitySetId}/metadata | Get all entity set property metadata. +*OpenapiClient::EntitySetsApi* | [**get_all_entity_sets**](docs/EntitySetsApi.md#get_all_entity_sets) | **GET** /datastore/entity-sets | Get all EntitySet definitions. +*OpenapiClient::EntitySetsApi* | [**get_entity_set**](docs/EntitySetsApi.md#get_entity_set) | **GET** /datastore/entity-sets/all/{entitySetId} | Get the EntitySet definition for the given EntitySet UUID. +*OpenapiClient::EntitySetsApi* | [**get_entity_set_id**](docs/EntitySetsApi.md#get_entity_set_id) | **GET** /datastore/entity-sets/ids/{entitySetName} | Gets the EntitySet UUID for the given EntitySet name. +*OpenapiClient::EntitySetsApi* | [**get_entity_set_ids**](docs/EntitySetsApi.md#get_entity_set_ids) | **POST** /datastore/entity-sets/ids/ | Get IDs for entity sets given their names. +*OpenapiClient::EntitySetsApi* | [**get_entity_set_property_metadata**](docs/EntitySetsApi.md#get_entity_set_property_metadata) | **GET** /datastore/entity-sets/all/{entitySetId}/properties/{propertyTypeId}/ | Get specified property type metadata for an entity set. +*OpenapiClient::EntitySetsApi* | [**get_property_metadata_for_entity_sets**](docs/EntitySetsApi.md#get_property_metadata_for_entity_sets) | **POST** /datastore/entity-sets/all/metadata | Get property metadata for entity sets. +*OpenapiClient::EntitySetsApi* | [**get_property_types_for_entity_set**](docs/EntitySetsApi.md#get_property_types_for_entity_set) | **GET** /datastore/entity-sets/all/{entitySetId}/properties | Get all Property Types for entity set +*OpenapiClient::EntitySetsApi* | [**remove_entity_sets_from_linking_entity_set**](docs/EntitySetsApi.md#remove_entity_sets_from_linking_entity_set) | **DELETE** /datastore/entity-sets/linking/{linkingEntitySetId} | Removes/unlinks the linked entity sets from the linking entity set +*OpenapiClient::EntitySetsApi* | [**remove_entity_sets_from_linking_entity_sets**](docs/EntitySetsApi.md#remove_entity_sets_from_linking_entity_sets) | **DELETE** /datastore/entity-sets/linking/ | Removes/unlinks the linked entity sets from the linking entity set +*OpenapiClient::EntitySetsApi* | [**update_entity_set_meta_data**](docs/EntitySetsApi.md#update_entity_set_meta_data) | **PATCH** /datastore/entity-sets/all/{entitySetId}/metadata/ | Updates the EntitySet definition for the given EntitySet UUID with the given metadata. +*OpenapiClient::EntitySetsApi* | [**update_entity_set_property_metadata**](docs/EntitySetsApi.md#update_entity_set_property_metadata) | **POST** /datastore/entity-sets/all/{entitySetId}/properties/{propertyTypeId}/ | Updates the property type metadata for the given entity set. +*OpenapiClient::LinkingApi* | [**add_linking_feedback**](docs/LinkingApi.md#add_linking_feedback) | **PUT** /linker/linkingfeedback | Submits feedbacks for a given linking entity set and linking id in a batch format. +*OpenapiClient::LinkingApi* | [**delete_linking_feedback**](docs/LinkingApi.md#delete_linking_feedback) | **DELETE** /linker/linkingfeedback | Deletes linking feedback +*OpenapiClient::LinkingApi* | [**get_all_linking_feedback**](docs/LinkingApi.md#get_all_linking_feedback) | **GET** /linker/linkingfeedback/all | Returns all feedback submitted +*OpenapiClient::LinkingApi* | [**get_all_linking_feedback_with_features**](docs/LinkingApi.md#get_all_linking_feedback_with_features) | **GET** /linker/linkingfeedback/features/all | Returns all feedback submitted walong with the features of pairwise entities +*OpenapiClient::LinkingApi* | [**get_linking_feedback_with_features**](docs/LinkingApi.md#get_linking_feedback_with_features) | **POST** /linker/linkingfeedback/features | Returns the feedback on the given entity pair along with their features +*OpenapiClient::LinkingApi* | [**get_linking_feedbacks_on_entity**](docs/LinkingApi.md#get_linking_feedbacks_on_entity) | **POST** /linker/linkingfeedback/entity | Returns positive/negative/all linking feedbacks on the given entity. +*OpenapiClient::OrganizationsApi* | [**add_member**](docs/OrganizationsApi.md#add_member) | **PUT** /datastore/organizations/{organizationId}/principals/members/{userId} | Add member to an organization +*OpenapiClient::OrganizationsApi* | [**add_role_to_user**](docs/OrganizationsApi.md#add_role_to_user) | **PUT** /datastore/organizations/{organizationId}/principals/roles/{roleId}/members/{userId} | Add a role to a user +*OpenapiClient::OrganizationsApi* | [**assemble_entity_sets**](docs/OrganizationsApi.md#assemble_entity_sets) | **POST** /datastore/organizations/{organizationId}/entity-sets/assemble | Materializes entity sets into the organization database. +*OpenapiClient::OrganizationsApi* | [**create_organization_if_not_exists**](docs/OrganizationsApi.md#create_organization_if_not_exists) | **POST** /datastore/organizations | Creates an organization if it doesn't exist. +*OpenapiClient::OrganizationsApi* | [**create_role**](docs/OrganizationsApi.md#create_role) | **POST** /datastore/organizations/roles | Creates role +*OpenapiClient::OrganizationsApi* | [**delete_role**](docs/OrganizationsApi.md#delete_role) | **DELETE** /datastore/organizations/{organizationId}/principals/roles/{roleId} | Remove role for an organization +*OpenapiClient::OrganizationsApi* | [**destroy_organization**](docs/OrganizationsApi.md#destroy_organization) | **DELETE** /datastore/organizations/{organizationId} | Remove an organization from the organizationId +*OpenapiClient::OrganizationsApi* | [**get_all_users_of_role**](docs/OrganizationsApi.md#get_all_users_of_role) | **GET** /datastore/organizations/{organizationId}/principals/roles/{roleId}/members/ | Get members of a role for an organization from a roleId +*OpenapiClient::OrganizationsApi* | [**get_auto_approved_email_domains**](docs/OrganizationsApi.md#get_auto_approved_email_domains) | **GET** /datastore/organizations/{organizationId}/email-domains | Get auto-approved email domains +*OpenapiClient::OrganizationsApi* | [**get_flagged_organization_entity_sets**](docs/OrganizationsApi.md#get_flagged_organization_entity_sets) | **POST** /datastore/organizations/{organizationId}/entity-sets | Get the entity sets for an organization for a certain flag +*OpenapiClient::OrganizationsApi* | [**get_members**](docs/OrganizationsApi.md#get_members) | **GET** /datastore/organizations/{organizationId}/principals/members | Get members of a certain organization +*OpenapiClient::OrganizationsApi* | [**get_organization**](docs/OrganizationsApi.md#get_organization) | **GET** /datastore/organizations/{organizationId} | Get an organization from the organizationId +*OpenapiClient::OrganizationsApi* | [**get_organization_entity_sets**](docs/OrganizationsApi.md#get_organization_entity_sets) | **GET** /datastore/organizations/{organizationId}/entity-sets | Get the entity sets for an organization for a certain filter +*OpenapiClient::OrganizationsApi* | [**get_organization_integration_account**](docs/OrganizationsApi.md#get_organization_integration_account) | **GET** /datastore/organizations/{organizationId}/integration | Get the integrations account for an organization from the organizationId +*OpenapiClient::OrganizationsApi* | [**get_organizations**](docs/OrganizationsApi.md#get_organizations) | **GET** /datastore/organizations | Get all organizations +*OpenapiClient::OrganizationsApi* | [**get_role**](docs/OrganizationsApi.md#get_role) | **GET** /datastore/organizations/{organizationId}/principals/roles/{roleId} | Get role for an organization from a roleId +*OpenapiClient::OrganizationsApi* | [**get_roles**](docs/OrganizationsApi.md#get_roles) | **GET** /datastore/organizations/{organizationId}/principals/roles | Get roles for an organization +*OpenapiClient::OrganizationsApi* | [**refresh_data_changes**](docs/OrganizationsApi.md#refresh_data_changes) | **POST** /datastore/organizations/{organizationId}/{entitySetId}/refresh | Refreshes the requested materialized entity set with data changes in the organization. +*OpenapiClient::OrganizationsApi* | [**remove_auto_approved_email_domains**](docs/OrganizationsApi.md#remove_auto_approved_email_domains) | **DELETE** /datastore/organizations/{organizationId}/email-domains | Remove auto-approved email domains +*OpenapiClient::OrganizationsApi* | [**remove_member**](docs/OrganizationsApi.md#remove_member) | **DELETE** /datastore/organizations/{organizationId}/principals/members/{userId} | Remove member from an organization +*OpenapiClient::OrganizationsApi* | [**remove_role_from_user**](docs/OrganizationsApi.md#remove_role_from_user) | **DELETE** /datastore/organizations/{organizationId}/principals/roles/{roleId}/members/{userId} | Remove a role from a user +*OpenapiClient::OrganizationsApi* | [**set_auto_approved_email_domain**](docs/OrganizationsApi.md#set_auto_approved_email_domain) | **PUT** /datastore/organizations/{organizationId}/email-domains | Set auto-approved email domains +*OpenapiClient::OrganizationsApi* | [**synchronize_edm_changes**](docs/OrganizationsApi.md#synchronize_edm_changes) | **POST** /datastore/organizations/{organizationId}/{entitySetId}/synchronize | Synchronizes EDM changes to the requested materialized entity set in the organization. +*OpenapiClient::OrganizationsApi* | [**update_description**](docs/OrganizationsApi.md#update_description) | **PUT** /datastore/organizations/{organizationId}/description | Update the organization description +*OpenapiClient::OrganizationsApi* | [**update_role_description**](docs/OrganizationsApi.md#update_role_description) | **POST** /datastore/organizations/{organizationId}/principals/roles/{roleId}/description | Update role description for an organization from a roleId +*OpenapiClient::OrganizationsApi* | [**update_role_title**](docs/OrganizationsApi.md#update_role_title) | **PUT** /datastore/organizations/{organizationId}/principals/roles/{roleId}/title | Update role title for an organization from a roleId +*OpenapiClient::OrganizationsApi* | [**update_title**](docs/OrganizationsApi.md#update_title) | **PUT** /datastore/organizations/{organizationId}/title | Update the organization title +*OpenapiClient::PermissionsApi* | [**get_acl**](docs/PermissionsApi.md#get_acl) | **POST** /datastore/permissions | Get the ACL for the given ACL Key, only if the user is the owner of the ACL Key. +*OpenapiClient::PermissionsApi* | [**update_acl**](docs/PermissionsApi.md#update_acl) | **PATCH** /datastore/permissions | Updates the ACL for a particular ACL Key, only if the user is the owner of the ACL Key. +*OpenapiClient::PrincipalApi* | [**get_all_users**](docs/PrincipalApi.md#get_all_users) | **GET** /datastore/principals/users/ | Get all users. +*OpenapiClient::PrincipalApi* | [**get_current_roles**](docs/PrincipalApi.md#get_current_roles) | **GET** /datastore/principals/roles/current/ | Get current roles. +*OpenapiClient::PrincipalApi* | [**get_materialized_view_account**](docs/PrincipalApi.md#get_materialized_view_account) | **GET** /datastore/principals/db | Get the db access credentials. +*OpenapiClient::PrincipalApi* | [**get_user**](docs/PrincipalApi.md#get_user) | **GET** /datastore/principals/users/{userId} | Get the user for the given id. +*OpenapiClient::PrincipalApi* | [**search_all_users**](docs/PrincipalApi.md#search_all_users) | **GET** /datastore/principals/users/search/"{searchQuery}" | Get the user id for the given search. +*OpenapiClient::PrincipalApi* | [**search_all_users_by_email**](docs/PrincipalApi.md#search_all_users_by_email) | **GET** /datastore/principals/users/search/email/"{emailAddress}" | Get the user id for the given email address. +*OpenapiClient::PrincipalApi* | [**sync_calling_user**](docs/PrincipalApi.md#sync_calling_user) | **GET** /datastore/principals/sync/ | Activates a user in the OpenLattice system. This call must be made once before a user will be available for use in authorization policies. +*OpenapiClient::SearchApi* | [**execute_advanced_entity_set_data_query**](docs/SearchApi.md#execute_advanced_entity_set_data_query) | **POST** /datastore/search/advanced/{entitySetId} | Executes a search over the data of a given entity set to find rows that match the search term +*OpenapiClient::SearchApi* | [**execute_app_search**](docs/SearchApi.md#execute_app_search) | **POST** /datastore/search/app | Executes a search over all apps to find ones that match the given search term +*OpenapiClient::SearchApi* | [**execute_app_type_search**](docs/SearchApi.md#execute_app_type_search) | **POST** /datastore/search/app_types | Executes a search over all app types to find ones that match the given search term +*OpenapiClient::SearchApi* | [**execute_association_type_search**](docs/SearchApi.md#execute_association_type_search) | **POST** /datastore/search/association_types | Executes a search over all association types to find ones that match the given search term +*OpenapiClient::SearchApi* | [**execute_entity_neighbor_search**](docs/SearchApi.md#execute_entity_neighbor_search) | **GET** /datastore/search/{entitySetId}/{entityKeyId} | Executes a search for all neighbors of an entity that are connected by an association +*OpenapiClient::SearchApi* | [**execute_entity_neighbor_search_bulk**](docs/SearchApi.md#execute_entity_neighbor_search_bulk) | **POST** /datastore/search/{entitySetId}/neighbors | Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association +*OpenapiClient::SearchApi* | [**execute_entity_set_collection_search**](docs/SearchApi.md#execute_entity_set_collection_search) | **POST** /datastore/search/entity_sets/collections | Executes a search over all EntitySetCollections to find ones that match the given search term +*OpenapiClient::SearchApi* | [**execute_entity_set_data_query**](docs/SearchApi.md#execute_entity_set_data_query) | **POST** /datastore/search/{entitySetId} | Executes a search over the data of a given entity set to find rows that match the search term +*OpenapiClient::SearchApi* | [**execute_entity_set_keyword_query**](docs/SearchApi.md#execute_entity_set_keyword_query) | **POST** /datastore/search | The query, entityType, and propertyTypes params are all optional, but at least one must be specified otherwise an error will be thrown. All specified params are required to be present in each entity set returned. If entityType and propertyTypes are both specified, the propertyTypes param will be ignored. +*OpenapiClient::SearchApi* | [**execute_entity_type_collection_search**](docs/SearchApi.md#execute_entity_type_collection_search) | **POST** /datastore/search/entity_types/collections | Executes a search over all EntityTypeCollections to find ones that match the given search term +*OpenapiClient::SearchApi* | [**execute_entity_type_search**](docs/SearchApi.md#execute_entity_type_search) | **POST** /datastore/search/entity_types | Executes a search over all entity types to find ones that match the given search term +*OpenapiClient::SearchApi* | [**execute_filtered_entity_neighbor_id_search**](docs/SearchApi.md#execute_filtered_entity_neighbor_id_search) | **POST** /datastore/search/{entitySetId}/neighbors/advanced/ids | Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association and returns a simple version of the neighborDetails +*OpenapiClient::SearchApi* | [**execute_filtered_entity_neighbor_search**](docs/SearchApi.md#execute_filtered_entity_neighbor_search) | **POST** /datastore/search/{entitySetId}/neighbors/advanced | Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association +*OpenapiClient::SearchApi* | [**execute_fqn_property_type_search**](docs/SearchApi.md#execute_fqn_property_type_search) | **POST** /datastore/search/property_types/fqn | Executes a search over all property types to find ones that match the given name and namespace, including partial matches +*OpenapiClient::SearchApi* | [**execute_organization_search**](docs/SearchApi.md#execute_organization_search) | **POST** /datastore/search/organizations | Executes a search over all organizations to find ones that match the given search term +*OpenapiClient::SearchApi* | [**execute_property_type_search**](docs/SearchApi.md#execute_property_type_search) | **POST** /datastore/search/property_types | Executes a search over all property types to find ones that match the given search term +*OpenapiClient::SearchApi* | [**get_entity_sets**](docs/SearchApi.md#get_entity_sets) | **GET** /datastore/search/entity-sets/{start}/{numResults} | Executes a search over all existing entity sets to populate the home page. The path parameters instruct which page to return and how large the page should be. +*OpenapiClient::SearchApi* | [**get_popular_entity_set**](docs/SearchApi.md#get_popular_entity_set) | **GET** /datastore/search/popular | Get the most popular entity sets. +*OpenapiClient::SearchApi* | [**search_entity_set_data**](docs/SearchApi.md#search_entity_set_data) | **PATCH** /datastore/search | Executes a search over the data of a given entity set to find rows that match the search term +*OpenapiClient::ShuttleApi* | [**create_integration_definition**](docs/ShuttleApi.md#create_integration_definition) | **POST** /shuttle/integration/definition/{integrationName} | Creates a new integration definition for running recurring integrations +*OpenapiClient::ShuttleApi* | [**delete_integration_definition**](docs/ShuttleApi.md#delete_integration_definition) | **DELETE** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition +*OpenapiClient::ShuttleApi* | [**delete_integration_job_status**](docs/ShuttleApi.md#delete_integration_job_status) | **DELETE** /shuttle/integration/status/{jobId} | Deletes an integration job status from the integrationJobs map +*OpenapiClient::ShuttleApi* | [**enqueue_integration**](docs/ShuttleApi.md#enqueue_integration) | **GET** /shuttle/integration/{integrationName}/{integrationKey} | Enqueues an integration on Shuttle Server for a given integration +*OpenapiClient::ShuttleApi* | [**poll_all_integrations**](docs/ShuttleApi.md#poll_all_integrations) | **GET** /shuttle/integration/status | Polls the statuses of all running integrations +*OpenapiClient::ShuttleApi* | [**poll_integration**](docs/ShuttleApi.md#poll_integration) | **GET** /shuttle/integration/status/{jobId} | Polls the status of an integration +*OpenapiClient::ShuttleApi* | [**read_integration_definition**](docs/ShuttleApi.md#read_integration_definition) | **GET** /shuttle/integration/definition/{integrationName} | Gets an existing integration definition +*OpenapiClient::ShuttleApi* | [**update_integration_definition**](docs/ShuttleApi.md#update_integration_definition) | **PATCH** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition + + +## Documentation for Models + + - [OpenapiClient::AccessCheck](docs/AccessCheck.md) + - [OpenapiClient::Ace](docs/Ace.md) + - [OpenapiClient::Acl](docs/Acl.md) + - [OpenapiClient::AclData](docs/AclData.md) + - [OpenapiClient::AdvancedSearch](docs/AdvancedSearch.md) + - [OpenapiClient::Association](docs/Association.md) + - [OpenapiClient::AssociationDefinition](docs/AssociationDefinition.md) + - [OpenapiClient::AssociationType](docs/AssociationType.md) + - [OpenapiClient::Auth0userBasic](docs/Auth0userBasic.md) + - [OpenapiClient::Authorization](docs/Authorization.md) + - [OpenapiClient::AuthorizedObjectsSearchResult](docs/AuthorizedObjectsSearchResult.md) + - [OpenapiClient::BulkDataCreation](docs/BulkDataCreation.md) + - [OpenapiClient::CollectionTemplateType](docs/CollectionTemplateType.md) + - [OpenapiClient::Constraint](docs/Constraint.md) + - [OpenapiClient::ConstraintGroup](docs/ConstraintGroup.md) + - [OpenapiClient::DataAssociation](docs/DataAssociation.md) + - [OpenapiClient::DataEdge](docs/DataEdge.md) + - [OpenapiClient::DataEdgeData](docs/DataEdgeData.md) + - [OpenapiClient::DataEdgeKey](docs/DataEdgeKey.md) + - [OpenapiClient::DataGraph](docs/DataGraph.md) + - [OpenapiClient::DataGraphIds](docs/DataGraphIds.md) + - [OpenapiClient::DataSearchResult](docs/DataSearchResult.md) + - [OpenapiClient::EDM](docs/EDM.md) + - [OpenapiClient::EDMdiff](docs/EDMdiff.md) + - [OpenapiClient::EdmRequest](docs/EdmRequest.md) + - [OpenapiClient::Entity](docs/Entity.md) + - [OpenapiClient::EntityDataKey](docs/EntityDataKey.md) + - [OpenapiClient::EntityDefinition](docs/EntityDefinition.md) + - [OpenapiClient::EntityKey](docs/EntityKey.md) + - [OpenapiClient::EntityKeyPair](docs/EntityKeyPair.md) + - [OpenapiClient::EntityLinkingFeatures](docs/EntityLinkingFeatures.md) + - [OpenapiClient::EntityLinkingFeedback](docs/EntityLinkingFeedback.md) + - [OpenapiClient::EntityNeighborsFilter](docs/EntityNeighborsFilter.md) + - [OpenapiClient::EntitySet](docs/EntitySet.md) + - [OpenapiClient::EntitySetCollection](docs/EntitySetCollection.md) + - [OpenapiClient::EntitySetPropertyMetaData](docs/EntitySetPropertyMetaData.md) + - [OpenapiClient::EntitySetSelection](docs/EntitySetSelection.md) + - [OpenapiClient::EntityType](docs/EntityType.md) + - [OpenapiClient::EntityTypeCollection](docs/EntityTypeCollection.md) + - [OpenapiClient::EntityTypePropertyMetadata](docs/EntityTypePropertyMetadata.md) + - [OpenapiClient::Flight](docs/Flight.md) + - [OpenapiClient::FlightPlanParameters](docs/FlightPlanParameters.md) + - [OpenapiClient::FlightPlanParametersUpdate](docs/FlightPlanParametersUpdate.md) + - [OpenapiClient::FullQualifiedName](docs/FullQualifiedName.md) + - [OpenapiClient::IndexingState](docs/IndexingState.md) + - [OpenapiClient::InlineObject](docs/InlineObject.md) + - [OpenapiClient::InlineResponse200](docs/InlineResponse200.md) + - [OpenapiClient::Integration](docs/Integration.md) + - [OpenapiClient::IntegrationJob](docs/IntegrationJob.md) + - [OpenapiClient::IntegrationResults](docs/IntegrationResults.md) + - [OpenapiClient::IntegrationUpdate](docs/IntegrationUpdate.md) + - [OpenapiClient::LinkingFeedback](docs/LinkingFeedback.md) + - [OpenapiClient::MaterializedViewAccount](docs/MaterializedViewAccount.md) + - [OpenapiClient::MetadataUpdate](docs/MetadataUpdate.md) + - [OpenapiClient::NeighborEntityDetails](docs/NeighborEntityDetails.md) + - [OpenapiClient::NeighborEntityIds](docs/NeighborEntityIds.md) + - [OpenapiClient::NeighborSearchFilter](docs/NeighborSearchFilter.md) + - [OpenapiClient::Organization](docs/Organization.md) + - [OpenapiClient::OrganizationExternalDatabaseColumn](docs/OrganizationExternalDatabaseColumn.md) + - [OpenapiClient::OrganizationExternalDatabaseTable](docs/OrganizationExternalDatabaseTable.md) + - [OpenapiClient::OrganizationExternalDatabaseTableColumnsPair](docs/OrganizationExternalDatabaseTableColumnsPair.md) + - [OpenapiClient::OrganizationMember](docs/OrganizationMember.md) + - [OpenapiClient::Principal](docs/Principal.md) + - [OpenapiClient::PropertyDefinition](docs/PropertyDefinition.md) + - [OpenapiClient::PropertyType](docs/PropertyType.md) + - [OpenapiClient::PropertyUsageSummary](docs/PropertyUsageSummary.md) + - [OpenapiClient::Role](docs/Role.md) + - [OpenapiClient::Schema](docs/Schema.md) + - [OpenapiClient::Search](docs/Search.md) + - [OpenapiClient::SearchConstraints](docs/SearchConstraints.md) + - [OpenapiClient::SearchDetails](docs/SearchDetails.md) + - [OpenapiClient::SearchResult](docs/SearchResult.md) + - [OpenapiClient::SearchResultHits](docs/SearchResultHits.md) + - [OpenapiClient::SearchTerm](docs/SearchTerm.md) + - [OpenapiClient::SecurablePrincipal](docs/SecurablePrincipal.md) + - [OpenapiClient::SmsEntitySetInformation](docs/SmsEntitySetInformation.md) + - [OpenapiClient::SortDefinition](docs/SortDefinition.md) + + +## Documentation for Authorization + + +### http_auth + +- **Type**: Bearer authentication (JWT) + +### openlattice_auth + + +- **Type**: API key +- **API key parameter name**: Authorization +- **Location**: HTTP header + diff --git a/ruby/Rakefile b/ruby/Rakefile new file mode 100644 index 0000000..c72ca30 --- /dev/null +++ b/ruby/Rakefile @@ -0,0 +1,10 @@ +require "bundler/gem_tasks" + +begin + require 'rspec/core/rake_task' + + RSpec::Core::RakeTask.new(:spec) + task default: :spec +rescue LoadError + # no rspec available +end diff --git a/ruby/docs/AccessCheck.md b/ruby/docs/AccessCheck.md new file mode 100644 index 0000000..fa409af --- /dev/null +++ b/ruby/docs/AccessCheck.md @@ -0,0 +1,19 @@ +# OpenapiClient::AccessCheck + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**acl_key** | **Array<String>** | | [optional] +**permissions** | **Array<String>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::AccessCheck.new(acl_key: null, + permissions: null) +``` + + diff --git a/ruby/docs/Ace.md b/ruby/docs/Ace.md new file mode 100644 index 0000000..ef3258d --- /dev/null +++ b/ruby/docs/Ace.md @@ -0,0 +1,19 @@ +# OpenapiClient::Ace + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**principal** | [**Principal**](Principal.md) | | [optional] +**permissions** | **Array<String>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::Ace.new(principal: null, + permissions: null) +``` + + diff --git a/ruby/docs/Acl.md b/ruby/docs/Acl.md new file mode 100644 index 0000000..4e4eaa4 --- /dev/null +++ b/ruby/docs/Acl.md @@ -0,0 +1,19 @@ +# OpenapiClient::Acl + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**acl_key** | **Array<String>** | | [optional] +**aces** | [**Array<Ace>**](Ace.md) | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::Acl.new(acl_key: null, + aces: null) +``` + + diff --git a/ruby/docs/AclData.md b/ruby/docs/AclData.md new file mode 100644 index 0000000..25a8297 --- /dev/null +++ b/ruby/docs/AclData.md @@ -0,0 +1,19 @@ +# OpenapiClient::AclData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action** | **String** | | [optional] +**acl** | [**Acl**](Acl.md) | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::AclData.new(action: null, + acl: null) +``` + + diff --git a/ruby/docs/AdminApi.md b/ruby/docs/AdminApi.md new file mode 100644 index 0000000..11ae336 --- /dev/null +++ b/ruby/docs/AdminApi.md @@ -0,0 +1,224 @@ +# OpenapiClient::AdminApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**clear_indexing_queue**](AdminApi.md#clear_indexing_queue) | **DELETE** /indexer/index/reindex | Clears all the data currently being indexed in the queue. +[**get_indexing_state**](AdminApi.md#get_indexing_state) | **GET** /indexer/index/reindex | Retrieve the current state of reindexing jobs +[**reindex**](AdminApi.md#reindex) | **POST** /indexer/index/reindex | Merge job descriptions for performing a partial or full reindex of provided entity sets. +[**update_reindex**](AdminApi.md#update_reindex) | **PUT** /indexer/index/reindex | Replaces job descriptions for performing a partial or full reindex of provided entity sets. + + + +## clear_indexing_queue + +> Integer clear_indexing_queue + +Clears all the data currently being indexed in the queue. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::AdminApi.new + +begin + #Clears all the data currently being indexed in the queue. + result = api_instance.clear_indexing_queue + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling AdminApi->clear_indexing_queue: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_indexing_state + +> IndexingState get_indexing_state + +Retrieve the current state of reindexing jobs + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::AdminApi.new + +begin + #Retrieve the current state of reindexing jobs + result = api_instance.get_indexing_state + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling AdminApi->get_indexing_state: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**IndexingState**](IndexingState.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## reindex + +> IndexingState reindex(request_body) + +Merge job descriptions for performing a partial or full reindex of provided entity sets. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::AdminApi.new +request_body = nil # Hash> | A map of entity set ids to entity key ids that determines what will be reindexed. If no entity key ids are provided then all entities in an entity set are reindexed. If no entity set ids are provided then all entity sets are scheduled for reindexing. + +begin + #Merge job descriptions for performing a partial or full reindex of provided entity sets. + result = api_instance.reindex(request_body) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling AdminApi->reindex: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **request_body** | [**Hash<String, Array<String>>**](Array.md)| A map of entity set ids to entity key ids that determines what will be reindexed. If no entity key ids are provided then all entities in an entity set are reindexed. If no entity set ids are provided then all entity sets are scheduled for reindexing. | + +### Return type + +[**IndexingState**](IndexingState.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## update_reindex + +> IndexingState update_reindex(request_body) + +Replaces job descriptions for performing a partial or full reindex of provided entity sets. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::AdminApi.new +request_body = nil # Hash> | A map of entity set ids to entity key ids that determines what will be reindexed. If no entity key ids are provided then all entities in an entity set are reindexed. If no entity set ids are provided then all entity sets are scheduled for reindexing. + +begin + #Replaces job descriptions for performing a partial or full reindex of provided entity sets. + result = api_instance.update_reindex(request_body) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling AdminApi->update_reindex: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **request_body** | [**Hash<String, Array<String>>**](Array.md)| A map of entity set ids to entity key ids that determines what will be reindexed. If no entity key ids are provided then all entities in an entity set are reindexed. If no entity set ids are provided then all entity sets are scheduled for reindexing. | + +### Return type + +[**IndexingState**](IndexingState.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + diff --git a/ruby/docs/AdvancedSearch.md b/ruby/docs/AdvancedSearch.md new file mode 100644 index 0000000..d3b53a7 --- /dev/null +++ b/ruby/docs/AdvancedSearch.md @@ -0,0 +1,21 @@ +# OpenapiClient::AdvancedSearch + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**search_fields** | [**Array<SearchDetails>**](SearchDetails.md) | | [optional] +**start** | **Integer** | | [optional] +**max_hits** | **Integer** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::AdvancedSearch.new(search_fields: null, + start: null, + max_hits: null) +``` + + diff --git a/ruby/docs/Association.md b/ruby/docs/Association.md new file mode 100644 index 0000000..ad99026 --- /dev/null +++ b/ruby/docs/Association.md @@ -0,0 +1,23 @@ +# OpenapiClient::Association + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | [**EntityKey**](EntityKey.md) | | [optional] +**src** | [**EntityKey**](EntityKey.md) | | [optional] +**dst** | [**EntityKey**](EntityKey.md) | | [optional] +**details** | **Hash<String, String>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::Association.new(key: null, + src: null, + dst: null, + details: null) +``` + + diff --git a/ruby/docs/AssociationDefinition.md b/ruby/docs/AssociationDefinition.md new file mode 100644 index 0000000..1f6ceae --- /dev/null +++ b/ruby/docs/AssociationDefinition.md @@ -0,0 +1,27 @@ +# OpenapiClient::AssociationDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fqn** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**entity_set_name** | **String** | | [optional] +**property_definitions** | [**Hash<String, PropertyDefinition>**](PropertyDefinition.md) | | [optional] +**update_type** | **String** | | [optional] +**src** | **String** | | [optional] +**dst** | **String** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::AssociationDefinition.new(fqn: null, + entity_set_name: null, + property_definitions: null, + update_type: null, + src: null, + dst: null) +``` + + diff --git a/ruby/docs/AssociationType.md b/ruby/docs/AssociationType.md new file mode 100644 index 0000000..2acc1e0 --- /dev/null +++ b/ruby/docs/AssociationType.md @@ -0,0 +1,23 @@ +# OpenapiClient::AssociationType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_type** | [**EntityType**](EntityType.md) | | [optional] +**src** | **Array<String>** | | [optional] +**dst** | **Array<String>** | | [optional] +**bidirectional** | **Boolean** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::AssociationType.new(entity_type: null, + src: null, + dst: null, + bidirectional: null) +``` + + diff --git a/ruby/docs/Auth0userBasic.md b/ruby/docs/Auth0userBasic.md new file mode 100644 index 0000000..02eff94 --- /dev/null +++ b/ruby/docs/Auth0userBasic.md @@ -0,0 +1,27 @@ +# OpenapiClient::Auth0userBasic + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user_id** | **String** | | [optional] +**email** | **String** | | [optional] +**nickname** | **String** | | [optional] +**username** | **String** | | [optional] +**roles** | **Array<String>** | | [optional] +**com_openlattice_organization** | **Array<String>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::Auth0userBasic.new(user_id: null, + email: null, + nickname: null, + username: null, + roles: null, + com_openlattice_organization: null) +``` + + diff --git a/ruby/docs/Authorization.md b/ruby/docs/Authorization.md new file mode 100644 index 0000000..c2bc1cf --- /dev/null +++ b/ruby/docs/Authorization.md @@ -0,0 +1,19 @@ +# OpenapiClient::Authorization + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**acl_key** | **Array<String>** | | [optional] +**permissions** | **Hash<String, Boolean>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::Authorization.new(acl_key: null, + permissions: null) +``` + + diff --git a/ruby/docs/AuthorizationsApi.md b/ruby/docs/AuthorizationsApi.md new file mode 100644 index 0000000..d957738 --- /dev/null +++ b/ruby/docs/AuthorizationsApi.md @@ -0,0 +1,126 @@ +# OpenapiClient::AuthorizationsApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**check_authorizations**](AuthorizationsApi.md#check_authorizations) | **POST** /datastore/authorizations | Check authorizations +[**get_accessible_objects**](AuthorizationsApi.md#get_accessible_objects) | **GET** /datastore/authorizations | Returns paged results for all authorized objects of specified objectType, that the current user has specified permission for. + + + +## check_authorizations + +> Array<Authorization> check_authorizations(access_check) + +Check authorizations + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::AuthorizationsApi.new +access_check = OpenapiClient::AccessCheck.new # AccessCheck | + +begin + #Check authorizations + result = api_instance.check_authorizations(access_check) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling AuthorizationsApi->check_authorizations: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **access_check** | [**AccessCheck**](AccessCheck.md)| | + +### Return type + +[**Array<Authorization>**](Authorization.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## get_accessible_objects + +> AuthorizedObjectsSearchResult get_accessible_objects(opts) + +Returns paged results for all authorized objects of specified objectType, that the current user has specified permission for. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::AuthorizationsApi.new +opts = { + object_type: 'object_type_example', # String | + permission: 'permission_example', # String | + paging_token: 'paging_token_example' # String | +} + +begin + #Returns paged results for all authorized objects of specified objectType, that the current user has specified permission for. + result = api_instance.get_accessible_objects(opts) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling AuthorizationsApi->get_accessible_objects: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **object_type** | **String**| | [optional] + **permission** | **String**| | [optional] + **paging_token** | **String**| | [optional] + +### Return type + +[**AuthorizedObjectsSearchResult**](AuthorizedObjectsSearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + diff --git a/ruby/docs/AuthorizedObjectsSearchResult.md b/ruby/docs/AuthorizedObjectsSearchResult.md new file mode 100644 index 0000000..b6039a7 --- /dev/null +++ b/ruby/docs/AuthorizedObjectsSearchResult.md @@ -0,0 +1,19 @@ +# OpenapiClient::AuthorizedObjectsSearchResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**paging_token** | **String** | | [optional] +**authorized_objects** | **Array<Array<String>>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::AuthorizedObjectsSearchResult.new(paging_token: null, + authorized_objects: null) +``` + + diff --git a/ruby/docs/BulkDataCreation.md b/ruby/docs/BulkDataCreation.md new file mode 100644 index 0000000..abf020d --- /dev/null +++ b/ruby/docs/BulkDataCreation.md @@ -0,0 +1,19 @@ +# OpenapiClient::BulkDataCreation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entities** | [**Array<Entity>**](Entity.md) | | [optional] +**associations** | [**Array<Association>**](Association.md) | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::BulkDataCreation.new(entities: null, + associations: null) +``` + + diff --git a/ruby/docs/CollectionTemplateType.md b/ruby/docs/CollectionTemplateType.md new file mode 100644 index 0000000..af1d5c4 --- /dev/null +++ b/ruby/docs/CollectionTemplateType.md @@ -0,0 +1,25 @@ +# OpenapiClient::CollectionTemplateType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | An optional UUID for the collection template type. | [optional] +**name** | **String** | The unique name of the collection template type. | [optional] +**title** | **String** | The friendly name for the collection template type. | [optional] +**description** | **String** | A description of the collection template type. | [optional] +**entity_type_id** | **String** | The id of the entity type that this collection template type wraps. | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::CollectionTemplateType.new(id: null, + name: null, + title: null, + description: null, + entity_type_id: null) +``` + + diff --git a/ruby/docs/CollectionsApi.md b/ruby/docs/CollectionsApi.md new file mode 100644 index 0000000..a1bed7c --- /dev/null +++ b/ruby/docs/CollectionsApi.md @@ -0,0 +1,787 @@ +# OpenapiClient::CollectionsApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_type_to_entity_type_collection_template**](CollectionsApi.md#add_type_to_entity_type_collection_template) | **PATCH** /datastore/collections/entity/type/{entityTypeCollectionId}/template | Appends type to template of the specified EntityTypeCollection +[**create_entity_set_collection**](CollectionsApi.md#create_entity_set_collection) | **POST** /datastore/collections/entity/set | Creates a new EntitySetCollection +[**create_entity_type_collection**](CollectionsApi.md#create_entity_type_collection) | **POST** /datastore/collections/entity/type | Creates a new EntityTypeCollection +[**delete_entity_set_collection**](CollectionsApi.md#delete_entity_set_collection) | **DELETE** /datastore/collections/entity/set/{entitySetCollectionId} | Deletes the specified EntitySetCollection +[**delete_entity_type_collection**](CollectionsApi.md#delete_entity_type_collection) | **DELETE** /datastore/collections/entity/type/{entityTypeCollectionId} | Deletes the specified EntityTypeCollection +[**get_all_entity_set_collections**](CollectionsApi.md#get_all_entity_set_collections) | **GET** /datastore/collections/entity/set | Returns all EntitySetCollection objects +[**get_all_entity_type_collections**](CollectionsApi.md#get_all_entity_type_collections) | **GET** /datastore/collections/entity/type | Returns all EntityTypeCollection objects +[**get_entity_set_collection**](CollectionsApi.md#get_entity_set_collection) | **GET** /datastore/collections/entity/set/{entitySetCollectionId} | Returns the EntitySetCollection object for a given id +[**get_entity_set_collections_of_type**](CollectionsApi.md#get_entity_set_collections_of_type) | **GET** /datastore/collections/entity/set/entity/type/{entitySetCollectionId} | Returns all authorized EntitySetCollections for a given EntityTypeCollection id +[**get_entity_type_collection**](CollectionsApi.md#get_entity_type_collection) | **GET** /datastore/collections/entity/type/{entityTypeCollectionId} | Returns the EntityTypeCollection object for a given id +[**remove_type_from_entity_type_collection_template**](CollectionsApi.md#remove_type_from_entity_type_collection_template) | **DELETE** /datastore/collections/entity/type/{entityTypeCollectionId}/template/{typeId} | Removes a key from an EntityTypeCollection template +[**update_entity_set_collection_metadata**](CollectionsApi.md#update_entity_set_collection_metadata) | **PATCH** /datastore/collections/entity/set/{entitySetCollectionId} | Updates metadata of the specified EntitySetCollection +[**update_entity_set_collection_template**](CollectionsApi.md#update_entity_set_collection_template) | **PATCH** /datastore/collections/entity/set/{entitySetCollectionId}/template | Updates template of the specified EntitySetCollection +[**update_entity_type_collection_metadata**](CollectionsApi.md#update_entity_type_collection_metadata) | **PATCH** /datastore/collections/entity/type/{entityTypeCollectionId} | Updates metadata of the specified EntityTypeCollection + + + +## add_type_to_entity_type_collection_template + +> add_type_to_entity_type_collection_template(entity_type_collection_id, collection_template_type) + +Appends type to template of the specified EntityTypeCollection + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::CollectionsApi.new +entity_type_collection_id = 'entity_type_collection_id_example' # String | +collection_template_type = OpenapiClient::CollectionTemplateType.new # CollectionTemplateType | + +begin + #Appends type to template of the specified EntityTypeCollection + api_instance.add_type_to_entity_type_collection_template(entity_type_collection_id, collection_template_type) +rescue OpenapiClient::ApiError => e + puts "Exception when calling CollectionsApi->add_type_to_entity_type_collection_template: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_collection_id** | [**String**](.md)| | + **collection_template_type** | [**CollectionTemplateType**](CollectionTemplateType.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## create_entity_set_collection + +> String create_entity_set_collection(entity_set_collection) + +Creates a new EntitySetCollection + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::CollectionsApi.new +entity_set_collection = OpenapiClient::EntitySetCollection.new # EntitySetCollection | + +begin + #Creates a new EntitySetCollection + result = api_instance.create_entity_set_collection(entity_set_collection) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling CollectionsApi->create_entity_set_collection: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_collection** | [**EntitySetCollection**](EntitySetCollection.md)| | + +### Return type + +**String** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## create_entity_type_collection + +> String create_entity_type_collection(entity_type_collection) + +Creates a new EntityTypeCollection + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::CollectionsApi.new +entity_type_collection = OpenapiClient::EntityTypeCollection.new # EntityTypeCollection | + +begin + #Creates a new EntityTypeCollection + result = api_instance.create_entity_type_collection(entity_type_collection) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling CollectionsApi->create_entity_type_collection: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_collection** | [**EntityTypeCollection**](EntityTypeCollection.md)| | + +### Return type + +**String** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## delete_entity_set_collection + +> delete_entity_set_collection(entity_set_collection_id) + +Deletes the specified EntitySetCollection + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::CollectionsApi.new +entity_set_collection_id = 'entity_set_collection_id_example' # String | + +begin + #Deletes the specified EntitySetCollection + api_instance.delete_entity_set_collection(entity_set_collection_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling CollectionsApi->delete_entity_set_collection: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_collection_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## delete_entity_type_collection + +> delete_entity_type_collection(entity_type_collection_id) + +Deletes the specified EntityTypeCollection + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::CollectionsApi.new +entity_type_collection_id = 'entity_type_collection_id_example' # String | + +begin + #Deletes the specified EntityTypeCollection + api_instance.delete_entity_type_collection(entity_type_collection_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling CollectionsApi->delete_entity_type_collection: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_collection_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## get_all_entity_set_collections + +> Array<EntitySetCollection> get_all_entity_set_collections + +Returns all EntitySetCollection objects + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::CollectionsApi.new + +begin + #Returns all EntitySetCollection objects + result = api_instance.get_all_entity_set_collections + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling CollectionsApi->get_all_entity_set_collections: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Array<EntitySetCollection>**](EntitySetCollection.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_all_entity_type_collections + +> Array<EntityTypeCollection> get_all_entity_type_collections + +Returns all EntityTypeCollection objects + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::CollectionsApi.new + +begin + #Returns all EntityTypeCollection objects + result = api_instance.get_all_entity_type_collections + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling CollectionsApi->get_all_entity_type_collections: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Array<EntityTypeCollection>**](EntityTypeCollection.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_entity_set_collection + +> EntitySetCollection get_entity_set_collection(entity_set_collection_id) + +Returns the EntitySetCollection object for a given id + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::CollectionsApi.new +entity_set_collection_id = 'entity_set_collection_id_example' # String | + +begin + #Returns the EntitySetCollection object for a given id + result = api_instance.get_entity_set_collection(entity_set_collection_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling CollectionsApi->get_entity_set_collection: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_collection_id** | [**String**](.md)| | + +### Return type + +[**EntitySetCollection**](EntitySetCollection.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_entity_set_collections_of_type + +> Array<EntitySetCollection> get_entity_set_collections_of_type(entity_set_collection_id) + +Returns all authorized EntitySetCollections for a given EntityTypeCollection id + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::CollectionsApi.new +entity_set_collection_id = 'entity_set_collection_id_example' # String | + +begin + #Returns all authorized EntitySetCollections for a given EntityTypeCollection id + result = api_instance.get_entity_set_collections_of_type(entity_set_collection_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling CollectionsApi->get_entity_set_collections_of_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_collection_id** | [**String**](.md)| | + +### Return type + +[**Array<EntitySetCollection>**](EntitySetCollection.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_entity_type_collection + +> EntityTypeCollection get_entity_type_collection(entity_type_collection_id) + +Returns the EntityTypeCollection object for a given id + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::CollectionsApi.new +entity_type_collection_id = 'entity_type_collection_id_example' # String | + +begin + #Returns the EntityTypeCollection object for a given id + result = api_instance.get_entity_type_collection(entity_type_collection_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling CollectionsApi->get_entity_type_collection: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_collection_id** | [**String**](.md)| | + +### Return type + +[**EntityTypeCollection**](EntityTypeCollection.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## remove_type_from_entity_type_collection_template + +> remove_type_from_entity_type_collection_template(entity_type_collection_id, type_id) + +Removes a key from an EntityTypeCollection template + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::CollectionsApi.new +entity_type_collection_id = 'entity_type_collection_id_example' # String | +type_id = 'type_id_example' # String | + +begin + #Removes a key from an EntityTypeCollection template + api_instance.remove_type_from_entity_type_collection_template(entity_type_collection_id, type_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling CollectionsApi->remove_type_from_entity_type_collection_template: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_collection_id** | [**String**](.md)| | + **type_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## update_entity_set_collection_metadata + +> update_entity_set_collection_metadata(entity_set_collection_id, metadata_update) + +Updates metadata of the specified EntitySetCollection + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::CollectionsApi.new +entity_set_collection_id = 'entity_set_collection_id_example' # String | +metadata_update = OpenapiClient::MetadataUpdate.new # MetadataUpdate | + +begin + #Updates metadata of the specified EntitySetCollection + api_instance.update_entity_set_collection_metadata(entity_set_collection_id, metadata_update) +rescue OpenapiClient::ApiError => e + puts "Exception when calling CollectionsApi->update_entity_set_collection_metadata: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_collection_id** | [**String**](.md)| | + **metadata_update** | [**MetadataUpdate**](MetadataUpdate.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## update_entity_set_collection_template + +> update_entity_set_collection_template(entity_set_collection_id, request_body) + +Updates template of the specified EntitySetCollection + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::CollectionsApi.new +entity_set_collection_id = 'entity_set_collection_id_example' # String | +request_body = {'key' => 'request_body_example'} # Hash | + +begin + #Updates template of the specified EntitySetCollection + api_instance.update_entity_set_collection_template(entity_set_collection_id, request_body) +rescue OpenapiClient::ApiError => e + puts "Exception when calling CollectionsApi->update_entity_set_collection_template: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_collection_id** | [**String**](.md)| | + **request_body** | [**Hash<String, String>**](String.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## update_entity_type_collection_metadata + +> update_entity_type_collection_metadata(entity_type_collection_id, metadata_update) + +Updates metadata of the specified EntityTypeCollection + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::CollectionsApi.new +entity_type_collection_id = 'entity_type_collection_id_example' # String | +metadata_update = OpenapiClient::MetadataUpdate.new # MetadataUpdate | + +begin + #Updates metadata of the specified EntityTypeCollection + api_instance.update_entity_type_collection_metadata(entity_type_collection_id, metadata_update) +rescue OpenapiClient::ApiError => e + puts "Exception when calling CollectionsApi->update_entity_type_collection_metadata: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_collection_id** | [**String**](.md)| | + **metadata_update** | [**MetadataUpdate**](MetadataUpdate.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + diff --git a/ruby/docs/Constraint.md b/ruby/docs/Constraint.md new file mode 100644 index 0000000..50cd584 --- /dev/null +++ b/ruby/docs/Constraint.md @@ -0,0 +1,39 @@ +# OpenapiClient::Constraint + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **String** | | [optional] +**search_term** | **String** | | [optional] +**fuzzy** | **Boolean** | | [optional] +**search_fields** | [**Array<SearchDetails>**](SearchDetails.md) | | [optional] +**property_type_id** | **String** | | [optional] +**latitude** | **Float** | | [optional] +**longitude** | **Float** | | [optional] +**radius** | **Float** | | [optional] +**unit** | **String** | | [optional] +**zones** | **Array<Array<Array<Float>>>** | | [optional] +**start** | **DateTime** | | [optional] +**_end** | **DateTime** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::Constraint.new(type: null, + search_term: null, + fuzzy: null, + search_fields: null, + property_type_id: null, + latitude: null, + longitude: null, + radius: null, + unit: null, + zones: null, + start: null, + _end: null) +``` + + diff --git a/ruby/docs/ConstraintGroup.md b/ruby/docs/ConstraintGroup.md new file mode 100644 index 0000000..ccf7ea8 --- /dev/null +++ b/ruby/docs/ConstraintGroup.md @@ -0,0 +1,19 @@ +# OpenapiClient::ConstraintGroup + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**min** | **Integer** | | [optional] +**constraints** | [**Array<Constraint>**](Constraint.md) | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::ConstraintGroup.new(min: null, + constraints: null) +``` + + diff --git a/ruby/docs/DataApi.md b/ruby/docs/DataApi.md new file mode 100644 index 0000000..78126be --- /dev/null +++ b/ruby/docs/DataApi.md @@ -0,0 +1,1053 @@ +# OpenapiClient::DataApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_associations**](DataApi.md#create_associations) | **POST** /datastore/data/association | Creates a new set of associations. +[**create_edges**](DataApi.md#create_edges) | **PUT** /datastore/data/association | Creates a new set of associations. +[**create_entities**](DataApi.md#create_entities) | **POST** /datastore/data/set/ | Creates a new set of entities. +[**create_entity_and_association_data**](DataApi.md#create_entity_and_association_data) | **POST** /datastore/data | Creates entities and assocations +[**delete_all_entities_from_entity_set**](DataApi.md#delete_all_entities_from_entity_set) | **DELETE** /datastore/data/set/{entitySetId}/all | Clears the Entity matching the given Entity id and all of its neighbor Entities +[**delete_entities**](DataApi.md#delete_entities) | **DELETE** /datastore/data/set/{entitySetId} | Deletes multiple entities from an entity set. +[**delete_entities_and_neighbors**](DataApi.md#delete_entities_and_neighbors) | **POST** /datastore/data/set/{entitySetId}/neighbors | Deletes the entities matching the given entity ids and all of its neighbor entities provided in the filter. +[**delete_entity**](DataApi.md#delete_entity) | **DELETE** /datastore/data/set/{entitySetId}/{entityKeyId} | Deletes a single entity from an entity set. +[**delete_entity_properties**](DataApi.md#delete_entity_properties) | **DELETE** /datastore/data/{entitySetId}/{entityKeyId}/properties | Deletes properties from an entity. +[**get_entity**](DataApi.md#get_entity) | **GET** /datastore/data/{entitySetId}/{entityKeyId} | Loads a single entity by its entityKeyId and entitySetId +[**get_entity_property_values**](DataApi.md#get_entity_property_values) | **GET** /datastore/data/{entitySetId}/{entityKeyId}/{propertyTypeId} | Loads property values for a single entity by its entityKeyId, entitySetId and propertyTypeId +[**get_entity_set_size**](DataApi.md#get_entity_set_size) | **GET** /datastore/data/{entitySetId}/count | Gets the number of entities in an entity set. +[**load_entity_set_data**](DataApi.md#load_entity_set_data) | **GET** /datastore/data/set/{entitySetId} | Gets an iterable containing the entity data, using property type FQNs as key +[**load_linked_entity_set_breakdown**](DataApi.md#load_linked_entity_set_breakdown) | **POST** /datastore/data/set/{linkedEntitySetId}/detailed | Loads a linked entity set breakdown with the selected linked entities and properties. +[**load_selected_entity_set_data**](DataApi.md#load_selected_entity_set_data) | **POST** /datastore/data/set/{entitySetId} | Gets a list of entities by UUIDs +[**replace_association_data**](DataApi.md#replace_association_data) | **PATCH** /datastore/data/association | Replaces Association Data +[**replace_entity_properties**](DataApi.md#replace_entity_properties) | **PATCH** /datastore/data/set/{entitySetId} | Replaces Entity Properties +[**update_entities_in_entity_set**](DataApi.md#update_entities_in_entity_set) | **PUT** /datastore/data/set/{entitySetId} | Perform one of the following bulk update operations on entities (type = Merge) adds new properties without affecting existing data, (type = PartialReplace) replaces all values for supplied property types, but does not not affect other property types for an entity, (type = Replace) replaces all entity data with the supplied properties. + + + +## create_associations + +> Hash<String, Array<String>> create_associations(inline_object) + +Creates a new set of associations. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataApi.new +inline_object = OpenapiClient::InlineObject.new # InlineObject | + +begin + #Creates a new set of associations. + result = api_instance.create_associations(inline_object) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataApi->create_associations: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **inline_object** | [**InlineObject**](InlineObject.md)| | + +### Return type + +**Hash<String, Array<String>>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## create_edges + +> Integer create_edges(data_edge_key) + +Creates a new set of associations. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataApi.new +data_edge_key = [OpenapiClient::DataEdgeKey.new] # Array | + +begin + #Creates a new set of associations. + result = api_instance.create_edges(data_edge_key) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataApi->create_edges: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **data_edge_key** | [**Array<DataEdgeKey>**](DataEdgeKey.md)| | + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## create_entities + +> Array<String> create_entities(set_id, request_body) + +Creates a new set of entities. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataApi.new +set_id = 'set_id_example' # String | +request_body = nil # Array>> | + +begin + #Creates a new set of entities. + result = api_instance.create_entities(set_id, request_body) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataApi->create_entities: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **set_id** | [**String**](.md)| | + **request_body** | [**Array<Hash<String, Array<String>>>**](Hash.md)| | + +### Return type + +**Array<String>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## create_entity_and_association_data + +> DataGraphIds create_entity_and_association_data(data_graph) + +Creates entities and assocations + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataApi.new +data_graph = OpenapiClient::DataGraph.new # DataGraph | + +begin + #Creates entities and assocations + result = api_instance.create_entity_and_association_data(data_graph) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataApi->create_entity_and_association_data: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **data_graph** | [**DataGraph**](DataGraph.md)| | + +### Return type + +[**DataGraphIds**](DataGraphIds.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## delete_all_entities_from_entity_set + +> delete_all_entities_from_entity_set(entity_set_id, type) + +Clears the Entity matching the given Entity id and all of its neighbor Entities + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataApi.new +entity_set_id = 'entity_set_id_example' # String | +type = 'type_example' # String | + +begin + #Clears the Entity matching the given Entity id and all of its neighbor Entities + api_instance.delete_all_entities_from_entity_set(entity_set_id, type) +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataApi->delete_all_entities_from_entity_set: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **type** | **String**| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## delete_entities + +> Integer delete_entities(entity_set_id, type, request_body) + +Deletes multiple entities from an entity set. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataApi.new +entity_set_id = 'entity_set_id_example' # String | +type = 'type_example' # String | +request_body = ['request_body_example'] # Array | + +begin + #Deletes multiple entities from an entity set. + result = api_instance.delete_entities(entity_set_id, type, request_body) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataApi->delete_entities: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **type** | **String**| | + **request_body** | [**Array<String>**](String.md)| | + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## delete_entities_and_neighbors + +> Integer delete_entities_and_neighbors(entity_set_id, type, entity_neighbors_filter) + +Deletes the entities matching the given entity ids and all of its neighbor entities provided in the filter. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataApi.new +entity_set_id = 'entity_set_id_example' # String | +type = 'type_example' # String | +entity_neighbors_filter = [OpenapiClient::EntityNeighborsFilter.new] # Array | + +begin + #Deletes the entities matching the given entity ids and all of its neighbor entities provided in the filter. + result = api_instance.delete_entities_and_neighbors(entity_set_id, type, entity_neighbors_filter) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataApi->delete_entities_and_neighbors: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **type** | **String**| | + **entity_neighbors_filter** | [**Array<EntityNeighborsFilter>**](EntityNeighborsFilter.md)| | + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## delete_entity + +> delete_entity(entity_set_id, entity_key_id, type) + +Deletes a single entity from an entity set. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataApi.new +entity_set_id = 'entity_set_id_example' # String | +entity_key_id = 'entity_key_id_example' # String | +type = 'type_example' # String | + +begin + #Deletes a single entity from an entity set. + api_instance.delete_entity(entity_set_id, entity_key_id, type) +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataApi->delete_entity: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **entity_key_id** | [**String**](.md)| | + **type** | **String**| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## delete_entity_properties + +> delete_entity_properties(entity_set_id, entity_key_id, type, request_body) + +Deletes properties from an entity. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataApi.new +entity_set_id = 'entity_set_id_example' # String | +entity_key_id = 'entity_key_id_example' # String | +type = 'type_example' # String | +request_body = ['request_body_example'] # Array | + +begin + #Deletes properties from an entity. + api_instance.delete_entity_properties(entity_set_id, entity_key_id, type, request_body) +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataApi->delete_entity_properties: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **entity_key_id** | [**String**](.md)| | + **type** | **String**| | + **request_body** | [**Array<String>**](String.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## get_entity + +> Hash<String, Array<String>> get_entity(entity_set_id, entity_key_id) + +Loads a single entity by its entityKeyId and entitySetId + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataApi.new +entity_set_id = 'entity_set_id_example' # String | +entity_key_id = 'entity_key_id_example' # String | + +begin + #Loads a single entity by its entityKeyId and entitySetId + result = api_instance.get_entity(entity_set_id, entity_key_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataApi->get_entity: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **entity_key_id** | [**String**](.md)| | + +### Return type + +**Hash<String, Array<String>>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_entity_property_values + +> Array<String> get_entity_property_values(entity_set_id, entity_key_id, property_type_id) + +Loads property values for a single entity by its entityKeyId, entitySetId and propertyTypeId + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataApi.new +entity_set_id = 'entity_set_id_example' # String | +entity_key_id = 'entity_key_id_example' # String | +property_type_id = 'property_type_id_example' # String | + +begin + #Loads property values for a single entity by its entityKeyId, entitySetId and propertyTypeId + result = api_instance.get_entity_property_values(entity_set_id, entity_key_id, property_type_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataApi->get_entity_property_values: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **entity_key_id** | [**String**](.md)| | + **property_type_id** | [**String**](.md)| | + +### Return type + +**Array<String>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_entity_set_size + +> Integer get_entity_set_size(entity_set_id) + +Gets the number of entities in an entity set. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataApi.new +entity_set_id = 'entity_set_id_example' # String | + +begin + #Gets the number of entities in an entity set. + result = api_instance.get_entity_set_size(entity_set_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataApi->get_entity_set_size: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## load_entity_set_data + +> Array<Hash<String, Array<String>>> load_entity_set_data(entity_set_id) + +Gets an iterable containing the entity data, using property type FQNs as key + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataApi.new +entity_set_id = 'entity_set_id_example' # String | + +begin + #Gets an iterable containing the entity data, using property type FQNs as key + result = api_instance.load_entity_set_data(entity_set_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataApi->load_entity_set_data: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + +### Return type + +**Array<Hash<String, Array<String>>>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## load_linked_entity_set_breakdown + +> Hash<String, Hash<String, Hash<String, Hash<String, Array<String>>>>> load_linked_entity_set_breakdown(linked_entity_set_id, entity_set_selection) + +Loads a linked entity set breakdown with the selected linked entities and properties. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataApi.new +linked_entity_set_id = 'linked_entity_set_id_example' # String | +entity_set_selection = [OpenapiClient::EntitySetSelection.new] # Array | + +begin + #Loads a linked entity set breakdown with the selected linked entities and properties. + result = api_instance.load_linked_entity_set_breakdown(linked_entity_set_id, entity_set_selection) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataApi->load_linked_entity_set_breakdown: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **linked_entity_set_id** | [**String**](.md)| | + **entity_set_selection** | [**Array<EntitySetSelection>**](EntitySetSelection.md)| | + +### Return type + +**Hash<String, Hash<String, Hash<String, Hash<String, Array<String>>>>>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## load_selected_entity_set_data + +> Array<Hash<String, Array<String>>> load_selected_entity_set_data(entity_set_id, entity_set_selection) + +Gets a list of entities by UUIDs + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataApi.new +entity_set_id = 'entity_set_id_example' # String | +entity_set_selection = [OpenapiClient::EntitySetSelection.new] # Array | + +begin + #Gets a list of entities by UUIDs + result = api_instance.load_selected_entity_set_data(entity_set_id, entity_set_selection) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataApi->load_selected_entity_set_data: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **entity_set_selection** | [**Array<EntitySetSelection>**](EntitySetSelection.md)| | + +### Return type + +**Array<Hash<String, Array<String>>>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## replace_association_data + +> Integer replace_association_data(partial, request_body) + +Replaces Association Data + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataApi.new +partial = true # Boolean | +request_body = nil # Hash> | + +begin + #Replaces Association Data + result = api_instance.replace_association_data(partial, request_body) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataApi->replace_association_data: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **partial** | **Boolean**| | + **request_body** | [**Hash<String, Hash<String, DataEdge>>**](Hash.md)| | + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## replace_entity_properties + +> Integer replace_entity_properties(entity_set_id, request_body) + +Replaces Entity Properties + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataApi.new +entity_set_id = 'entity_set_id_example' # String | +request_body = nil # Hash>>> | + +begin + #Replaces Entity Properties + result = api_instance.replace_entity_properties(entity_set_id, request_body) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataApi->replace_entity_properties: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **request_body** | [**Hash<String, Hash<String, Array<Hash<String, String>>>>**](Hash.md)| | + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## update_entities_in_entity_set + +> Integer update_entities_in_entity_set(entity_set_id, type, request_body) + +Perform one of the following bulk update operations on entities (type = Merge) adds new properties without affecting existing data, (type = PartialReplace) replaces all values for supplied property types, but does not not affect other property types for an entity, (type = Replace) replaces all entity data with the supplied properties. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataApi.new +entity_set_id = 'entity_set_id_example' # String | +type = 'type_example' # String | +request_body = nil # Hash>> | + +begin + #Perform one of the following bulk update operations on entities (type = Merge) adds new properties without affecting existing data, (type = PartialReplace) replaces all values for supplied property types, but does not not affect other property types for an entity, (type = Replace) replaces all entity data with the supplied properties. + result = api_instance.update_entities_in_entity_set(entity_set_id, type, request_body) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataApi->update_entities_in_entity_set: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **type** | **String**| | + **request_body** | [**Hash<String, Hash<String, Array<String>>>**](Hash.md)| | + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + diff --git a/ruby/docs/DataAssociation.md b/ruby/docs/DataAssociation.md new file mode 100644 index 0000000..65f64ca --- /dev/null +++ b/ruby/docs/DataAssociation.md @@ -0,0 +1,29 @@ +# OpenapiClient::DataAssociation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**src_entity_set_id** | **String** | the ID of the source entity set | [optional] +**src_entity_index** | **String** | The index of an entity | [optional] +**src_entity_key_id** | **String** | An existing entityKeyId | [optional] +**dst_entity_set_id** | **String** | the ID of the dst entity set | [optional] +**dst_entity_index** | **String** | The index of an entity | [optional] +**dst_entity_key_id** | **String** | An existing entityKeyId | [optional] +**data** | **Hash<String, Array<String>>** | data | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::DataAssociation.new(src_entity_set_id: null, + src_entity_index: null, + src_entity_key_id: null, + dst_entity_set_id: null, + dst_entity_index: null, + dst_entity_key_id: null, + data: null) +``` + + diff --git a/ruby/docs/DataEdge.md b/ruby/docs/DataEdge.md new file mode 100644 index 0000000..effd3ea --- /dev/null +++ b/ruby/docs/DataEdge.md @@ -0,0 +1,21 @@ +# OpenapiClient::DataEdge + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**src** | [**EntityDataKey**](EntityDataKey.md) | | [optional] +**dst** | [**EntityDataKey**](EntityDataKey.md) | | [optional] +**data** | [**DataEdgeData**](DataEdgeData.md) | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::DataEdge.new(src: null, + dst: null, + data: null) +``` + + diff --git a/ruby/docs/DataEdgeData.md b/ruby/docs/DataEdgeData.md new file mode 100644 index 0000000..a213b45 --- /dev/null +++ b/ruby/docs/DataEdgeData.md @@ -0,0 +1,17 @@ +# OpenapiClient::DataEdgeData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**additional_properties** | **Array<String>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::DataEdgeData.new(additional_properties: null) +``` + + diff --git a/ruby/docs/DataEdgeKey.md b/ruby/docs/DataEdgeKey.md new file mode 100644 index 0000000..be2c778 --- /dev/null +++ b/ruby/docs/DataEdgeKey.md @@ -0,0 +1,21 @@ +# OpenapiClient::DataEdgeKey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**src** | [**EntityDataKey**](EntityDataKey.md) | | [optional] +**dst** | [**EntityDataKey**](EntityDataKey.md) | | [optional] +**edge** | [**EntityDataKey**](EntityDataKey.md) | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::DataEdgeKey.new(src: null, + dst: null, + edge: null) +``` + + diff --git a/ruby/docs/DataGraph.md b/ruby/docs/DataGraph.md new file mode 100644 index 0000000..ee2ea7c --- /dev/null +++ b/ruby/docs/DataGraph.md @@ -0,0 +1,19 @@ +# OpenapiClient::DataGraph + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entities** | **Hash<String, Array<Hash<String, Array<String>>>>** | | [optional] +**associations** | **Hash<String, Array<DataAssociation>>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::DataGraph.new(entities: null, + associations: null) +``` + + diff --git a/ruby/docs/DataGraphIds.md b/ruby/docs/DataGraphIds.md new file mode 100644 index 0000000..9baf89c --- /dev/null +++ b/ruby/docs/DataGraphIds.md @@ -0,0 +1,19 @@ +# OpenapiClient::DataGraphIds + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_key_ids** | **Hash<String, Array<String>>** | | [optional] +**entity_set_ids** | **Hash<String, Array<String>>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::DataGraphIds.new(entity_key_ids: null, + entity_set_ids: null) +``` + + diff --git a/ruby/docs/DataIntegrationsApi.md b/ruby/docs/DataIntegrationsApi.md new file mode 100644 index 0000000..44ad56f --- /dev/null +++ b/ruby/docs/DataIntegrationsApi.md @@ -0,0 +1,122 @@ +# OpenapiClient::DataIntegrationsApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_entity_key_ids**](DataIntegrationsApi.md#get_entity_key_ids) | **POST** /datastore/integration/entityKeyIds | Get entity key IDs +[**integrate_entity_and_association_data**](DataIntegrationsApi.md#integrate_entity_and_association_data) | **POST** /datastore/integration | Integrate entity and association data + + + +## get_entity_key_ids + +> Array<String> get_entity_key_ids(entity_key) + +Get entity key IDs + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataIntegrationsApi.new +entity_key = [OpenapiClient::EntityKey.new] # Array | + +begin + #Get entity key IDs + result = api_instance.get_entity_key_ids(entity_key) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataIntegrationsApi->get_entity_key_ids: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_key** | [**Array<EntityKey>**](EntityKey.md)| | + +### Return type + +**Array<String>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## integrate_entity_and_association_data + +> IntegrationResults integrate_entity_and_association_data(detailed_results, bulk_data_creation) + +Integrate entity and association data + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DataIntegrationsApi.new +detailed_results = true # Boolean | +bulk_data_creation = OpenapiClient::BulkDataCreation.new # BulkDataCreation | + +begin + #Integrate entity and association data + result = api_instance.integrate_entity_and_association_data(detailed_results, bulk_data_creation) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DataIntegrationsApi->integrate_entity_and_association_data: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **detailed_results** | **Boolean**| | + **bulk_data_creation** | [**BulkDataCreation**](BulkDataCreation.md)| | + +### Return type + +[**IntegrationResults**](IntegrationResults.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + diff --git a/ruby/docs/DataSearchResult.md b/ruby/docs/DataSearchResult.md new file mode 100644 index 0000000..185b404 --- /dev/null +++ b/ruby/docs/DataSearchResult.md @@ -0,0 +1,19 @@ +# OpenapiClient::DataSearchResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**num_hits** | **Integer** | | [optional] +**hits** | **Array<Hash<String, Array<String>>>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::DataSearchResult.new(num_hits: null, + hits: null) +``` + + diff --git a/ruby/docs/DatasetApi.md b/ruby/docs/DatasetApi.md new file mode 100644 index 0000000..99eb47a --- /dev/null +++ b/ruby/docs/DatasetApi.md @@ -0,0 +1,704 @@ +# OpenapiClient::DatasetApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**delete_external_database_column**](DatasetApi.md#delete_external_database_column) | **DELETE** /datastore/organization-database/{organizationId}/{tableName}/{columnName}/external-database-column | Deletes an OrganizationExternalDatabaseColumn object, which represents an organization's column in an external database. This deletes both the object and the column in the database. It is a hard delete. +[**delete_external_database_columns**](DatasetApi.md#delete_external_database_columns) | **DELETE** /datastore/organization-database/{organizationId}/{tableName}/external-database-column | Deletes multiple OrganizationExternalDatabaseColumn objects and the columns they represent within an organization's table in an external database. It is a hard delete +[**delete_external_database_table**](DatasetApi.md#delete_external_database_table) | **DELETE** /datastore/organization-database/{organizationId}/{tableName}/external-database-table | Deletes an OrganizationExternalDatabaseTable object, which represents an organization's table in an external database. This deletes both the object and the table in the database. It is a hard delete. +[**delete_external_database_tables**](DatasetApi.md#delete_external_database_tables) | **DELETE** /datastore/organization-database/{organizationId}/external-database-table | Deletes multiple OrganizationExternalDatabaseTable objects and the tables they represent in the database. It is a hard delete. +[**get_authorized_external_db_tables_with_column_metadata**](DatasetApi.md#get_authorized_external_db_tables_with_column_metadata) | **GET** /datastore/organization-database/{organizationId}/{permission}/external-database-table/external-database-column/authorized | Gets a map of all OrganizationExternalDatabaseTable objects to OrganizationExternalDatabase columns that are contained within each table. +[**get_external_database_column**](DatasetApi.md#get_external_database_column) | **GET** /datastore/organization-database/{organizationId}/{tableName}/{columnName}/external-database-column | Gets an OrganizationExternalDatabaseColumn object, which represents a column within an organization's table in an external database. +[**get_external_database_table**](DatasetApi.md#get_external_database_table) | **GET** /datastore/organization-database/{organizationId}/{tableName}/external-database-table | Gets an OrganizationExternalDatabaseTable object, which represents an organization's table in an external database. +[**get_external_database_table_with_column_metadata**](DatasetApi.md#get_external_database_table_with_column_metadata) | **GET** /datastore/organization-database/{organizationId}/{tableId}/external-database-table/external-database-column | Gets an object containing an OrganizationExternalDatabaseTable object and its OrganizationExternalDatabase columns for an organization +[**get_external_database_tables**](DatasetApi.md#get_external_database_tables) | **GET** /datastore/organization-database/{organizationId}/external-database-table | Gets all OrganizationExternalDatabaseTable objects for an organization +[**get_external_database_tables_with_column_metadata**](DatasetApi.md#get_external_database_tables_with_column_metadata) | **GET** /datastore/organization-database/{organizationId}/external-database-table/external-database-column | Gets a map of all OrganizationExternalDatabaseTable objects to OrganizationExternalDatabase columns that are contained within each table. +[**update_external_database_column**](DatasetApi.md#update_external_database_column) | **PATCH** /datastore/organization-database/{organizationId}/{tableName}/{columnName}/external-database-column | Updates an OrganizationExternalDatabaseTableColumn object's fields that are included within the given metadata. +[**update_external_database_table**](DatasetApi.md#update_external_database_table) | **PATCH** /datastore/organization-database/{organizationId}/{tableName}/external-database-table | Updates an OrganizationExternalDatabaseTable object's fields that are included within the given metadata. + + + +## delete_external_database_column + +> delete_external_database_column(organization_id, table_name, column_name) + +Deletes an OrganizationExternalDatabaseColumn object, which represents an organization's column in an external database. This deletes both the object and the column in the database. It is a hard delete. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DatasetApi.new +organization_id = 'organization_id_example' # String | +table_name = 'table_name_example' # String | +column_name = 'column_name_example' # String | + +begin + #Deletes an OrganizationExternalDatabaseColumn object, which represents an organization's column in an external database. This deletes both the object and the column in the database. It is a hard delete. + api_instance.delete_external_database_column(organization_id, table_name, column_name) +rescue OpenapiClient::ApiError => e + puts "Exception when calling DatasetApi->delete_external_database_column: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **table_name** | **String**| | + **column_name** | **String**| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## delete_external_database_columns + +> delete_external_database_columns(organization_id, table_name) + +Deletes multiple OrganizationExternalDatabaseColumn objects and the columns they represent within an organization's table in an external database. It is a hard delete + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DatasetApi.new +organization_id = 'organization_id_example' # String | +table_name = 'table_name_example' # String | + +begin + #Deletes multiple OrganizationExternalDatabaseColumn objects and the columns they represent within an organization's table in an external database. It is a hard delete + api_instance.delete_external_database_columns(organization_id, table_name) +rescue OpenapiClient::ApiError => e + puts "Exception when calling DatasetApi->delete_external_database_columns: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **table_name** | **String**| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## delete_external_database_table + +> delete_external_database_table(organization_id, table_name) + +Deletes an OrganizationExternalDatabaseTable object, which represents an organization's table in an external database. This deletes both the object and the table in the database. It is a hard delete. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DatasetApi.new +organization_id = 'organization_id_example' # String | +table_name = 'table_name_example' # String | + +begin + #Deletes an OrganizationExternalDatabaseTable object, which represents an organization's table in an external database. This deletes both the object and the table in the database. It is a hard delete. + api_instance.delete_external_database_table(organization_id, table_name) +rescue OpenapiClient::ApiError => e + puts "Exception when calling DatasetApi->delete_external_database_table: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **table_name** | **String**| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## delete_external_database_tables + +> delete_external_database_tables(organization_id, request_body) + +Deletes multiple OrganizationExternalDatabaseTable objects and the tables they represent in the database. It is a hard delete. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DatasetApi.new +organization_id = 'organization_id_example' # String | +request_body = ['request_body_example'] # Array | + +begin + #Deletes multiple OrganizationExternalDatabaseTable objects and the tables they represent in the database. It is a hard delete. + api_instance.delete_external_database_tables(organization_id, request_body) +rescue OpenapiClient::ApiError => e + puts "Exception when calling DatasetApi->delete_external_database_tables: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **request_body** | [**Array<String>**](String.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## get_authorized_external_db_tables_with_column_metadata + +> Array<OrganizationExternalDatabaseTableColumnsPair> get_authorized_external_db_tables_with_column_metadata(organization_id, permission) + +Gets a map of all OrganizationExternalDatabaseTable objects to OrganizationExternalDatabase columns that are contained within each table. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DatasetApi.new +organization_id = 'organization_id_example' # String | +permission = 'permission_example' # String | + +begin + #Gets a map of all OrganizationExternalDatabaseTable objects to OrganizationExternalDatabase columns that are contained within each table. + result = api_instance.get_authorized_external_db_tables_with_column_metadata(organization_id, permission) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DatasetApi->get_authorized_external_db_tables_with_column_metadata: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **permission** | **String**| | + +### Return type + +[**Array<OrganizationExternalDatabaseTableColumnsPair>**](OrganizationExternalDatabaseTableColumnsPair.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_external_database_column + +> OrganizationExternalDatabaseColumn get_external_database_column(organization_id, table_name, column_name) + +Gets an OrganizationExternalDatabaseColumn object, which represents a column within an organization's table in an external database. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DatasetApi.new +organization_id = 'organization_id_example' # String | +table_name = 'table_name_example' # String | +column_name = 'column_name_example' # String | + +begin + #Gets an OrganizationExternalDatabaseColumn object, which represents a column within an organization's table in an external database. + result = api_instance.get_external_database_column(organization_id, table_name, column_name) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DatasetApi->get_external_database_column: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **table_name** | **String**| | + **column_name** | **String**| | + +### Return type + +[**OrganizationExternalDatabaseColumn**](OrganizationExternalDatabaseColumn.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_external_database_table + +> OrganizationExternalDatabaseTable get_external_database_table(organization_id, table_name) + +Gets an OrganizationExternalDatabaseTable object, which represents an organization's table in an external database. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DatasetApi.new +organization_id = 'organization_id_example' # String | +table_name = 'table_name_example' # String | + +begin + #Gets an OrganizationExternalDatabaseTable object, which represents an organization's table in an external database. + result = api_instance.get_external_database_table(organization_id, table_name) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DatasetApi->get_external_database_table: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **table_name** | **String**| | + +### Return type + +[**OrganizationExternalDatabaseTable**](OrganizationExternalDatabaseTable.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_external_database_table_with_column_metadata + +> OrganizationExternalDatabaseTableColumnsPair get_external_database_table_with_column_metadata(organization_id, table_id) + +Gets an object containing an OrganizationExternalDatabaseTable object and its OrganizationExternalDatabase columns for an organization + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DatasetApi.new +organization_id = 'organization_id_example' # String | +table_id = 'table_id_example' # String | + +begin + #Gets an object containing an OrganizationExternalDatabaseTable object and its OrganizationExternalDatabase columns for an organization + result = api_instance.get_external_database_table_with_column_metadata(organization_id, table_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DatasetApi->get_external_database_table_with_column_metadata: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **table_id** | [**String**](.md)| | + +### Return type + +[**OrganizationExternalDatabaseTableColumnsPair**](OrganizationExternalDatabaseTableColumnsPair.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_external_database_tables + +> Array<OrganizationExternalDatabaseTable> get_external_database_tables(organization_id) + +Gets all OrganizationExternalDatabaseTable objects for an organization + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DatasetApi.new +organization_id = 'organization_id_example' # String | + +begin + #Gets all OrganizationExternalDatabaseTable objects for an organization + result = api_instance.get_external_database_tables(organization_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DatasetApi->get_external_database_tables: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + +### Return type + +[**Array<OrganizationExternalDatabaseTable>**](OrganizationExternalDatabaseTable.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_external_database_tables_with_column_metadata + +> Array<OrganizationExternalDatabaseTableColumnsPair> get_external_database_tables_with_column_metadata(organization_id) + +Gets a map of all OrganizationExternalDatabaseTable objects to OrganizationExternalDatabase columns that are contained within each table. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DatasetApi.new +organization_id = 'organization_id_example' # String | + +begin + #Gets a map of all OrganizationExternalDatabaseTable objects to OrganizationExternalDatabase columns that are contained within each table. + result = api_instance.get_external_database_tables_with_column_metadata(organization_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling DatasetApi->get_external_database_tables_with_column_metadata: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + +### Return type + +[**Array<OrganizationExternalDatabaseTableColumnsPair>**](OrganizationExternalDatabaseTableColumnsPair.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## update_external_database_column + +> update_external_database_column(organization_id, table_name, column_name, metadata_update) + +Updates an OrganizationExternalDatabaseTableColumn object's fields that are included within the given metadata. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DatasetApi.new +organization_id = 'organization_id_example' # String | +table_name = 'table_name_example' # String | +column_name = 'column_name_example' # String | +metadata_update = OpenapiClient::MetadataUpdate.new # MetadataUpdate | + +begin + #Updates an OrganizationExternalDatabaseTableColumn object's fields that are included within the given metadata. + api_instance.update_external_database_column(organization_id, table_name, column_name, metadata_update) +rescue OpenapiClient::ApiError => e + puts "Exception when calling DatasetApi->update_external_database_column: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **table_name** | **String**| | + **column_name** | **String**| | + **metadata_update** | [**MetadataUpdate**](MetadataUpdate.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## update_external_database_table + +> update_external_database_table(organization_id, table_name, metadata_update) + +Updates an OrganizationExternalDatabaseTable object's fields that are included within the given metadata. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::DatasetApi.new +organization_id = 'organization_id_example' # String | +table_name = 'table_name_example' # String | +metadata_update = OpenapiClient::MetadataUpdate.new # MetadataUpdate | + +begin + #Updates an OrganizationExternalDatabaseTable object's fields that are included within the given metadata. + api_instance.update_external_database_table(organization_id, table_name, metadata_update) +rescue OpenapiClient::ApiError => e + puts "Exception when calling DatasetApi->update_external_database_table: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **table_name** | **String**| | + **metadata_update** | [**MetadataUpdate**](MetadataUpdate.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + diff --git a/ruby/docs/EDM.md b/ruby/docs/EDM.md new file mode 100644 index 0000000..7f57bd9 --- /dev/null +++ b/ruby/docs/EDM.md @@ -0,0 +1,25 @@ +# OpenapiClient::EDM + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**namespaces** | **Array<String>** | | [optional] +**schemas** | [**Array<Schema>**](Schema.md) | | [optional] +**property_types** | [**Array<PropertyType>**](PropertyType.md) | | [optional] +**entity_types** | [**Array<EntityType>**](EntityType.md) | | [optional] +**association_types** | [**Array<AssociationType>**](AssociationType.md) | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::EDM.new(namespaces: null, + schemas: null, + property_types: null, + entity_types: null, + association_types: null) +``` + + diff --git a/ruby/docs/EDMdiff.md b/ruby/docs/EDMdiff.md new file mode 100644 index 0000000..72b6ae3 --- /dev/null +++ b/ruby/docs/EDMdiff.md @@ -0,0 +1,19 @@ +# OpenapiClient::EDMdiff + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**conflicts** | [**EDM**](EDM.md) | | [optional] +**diff** | [**EDM**](EDM.md) | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::EDMdiff.new(conflicts: null, + diff: null) +``` + + diff --git a/ruby/docs/EdmApi.md b/ruby/docs/EdmApi.md new file mode 100644 index 0000000..f434de8 --- /dev/null +++ b/ruby/docs/EdmApi.md @@ -0,0 +1,3376 @@ +# OpenapiClient::EdmApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_dst_entity_type_to_association_type**](EdmApi.md#add_dst_entity_type_to_association_type) | **PUT** /datastore/edm/association/type/{associationTypeId}/dst/{entityTypeId} | Update the AssociationType dst entity types for the given AssociationType UUID by adding the given EntityType UUID. +[**add_entity_sets_to_linking_entity_set**](EdmApi.md#add_entity_sets_to_linking_entity_set) | **POST** /datastore/entity-sets/linking/{linkingEntitySetId} | Adds the entity sets as linked entity sets to the linking entity set +[**add_entity_sets_to_linking_entity_sets**](EdmApi.md#add_entity_sets_to_linking_entity_sets) | **PUT** /datastore/entity-sets/linking/ | Adds the entity sets as linked entity sets to the linking entity sets +[**add_primary_key_to_entity_type**](EdmApi.md#add_primary_key_to_entity_type) | **PUT** /datastore/edm/entity/type/key/{entityTypeId}/{propertyTypeId} | Adds a primary key with a given ID to an entity type with a given ID. +[**add_property_type_to_entity_type**](EdmApi.md#add_property_type_to_entity_type) | **PUT** /datastore/edm/entity/type/{entityTypeId}/{propertyTypeId} | Updates the EntityType definition for the given EntityType UUID by adding the given PropertyType UUID. +[**add_src_entity_type_to_association_type**](EdmApi.md#add_src_entity_type_to_association_type) | **PUT** /datastore/edm/association/type/{associationTypeId}/src/{entityTypeId} | Update the AssociationType src entity types for the given AssociationType UUID by adding the given EntityType UUID. +[**create_association_type**](EdmApi.md#create_association_type) | **POST** /datastore/edm/association/type/ | Creates a new AssociationType definition, if it doesn't exist. +[**create_empty_schema**](EdmApi.md#create_empty_schema) | **PUT** /datastore/edm/schema/{namespace}/{name} | Creates an empty schema, if it doesn't exist. If schema exists then no action is taken. +[**create_entity_sets**](EdmApi.md#create_entity_sets) | **POST** /datastore/entity-sets | Creates new EntitySet definitions if they don't exist. +[**create_entity_type**](EdmApi.md#create_entity_type) | **POST** /datastore/edm/entity/type/ | Creates a new EntityType definition, if it doesn't exist. +[**create_property_type**](EdmApi.md#create_property_type) | **POST** /datastore/edm/property/type/ | Creates a new PropertyType definition, if it doesn\"t exist. +[**create_schema_if_not_exists**](EdmApi.md#create_schema_if_not_exists) | **POST** /datastore/edm/schema | Creates an empty schema, if it doesn't exist. If schema exists then no action is taken. +[**delete_association_type**](EdmApi.md#delete_association_type) | **DELETE** /datastore/edm/association/type/{associationTypeId} | Deletes the AssociationType definition for the given AssociationType UUID. +[**delete_entity_set**](EdmApi.md#delete_entity_set) | **DELETE** /datastore/entity-sets/all/{entitySetId} | Deletes the EntitySet definition for the given EntitySet UUID. +[**delete_entity_type**](EdmApi.md#delete_entity_type) | **DELETE** /datastore/edm/entity/type/{entityTypeId} | Deletes the EntityType definition for the given EntityType UUID. +[**delete_property_type**](EdmApi.md#delete_property_type) | **DELETE** /datastore/edm/property/type/{propertyTypeId} | Deletes the PropertyType definition for the given PropertyType UUID. +[**force_delete_property_type**](EdmApi.md#force_delete_property_type) | **DELETE** /datastore/edm/property/type/{propertyTypeId}/force | Deletes the PropertyType definition for the given PropertyType UUID regardless of whether or not there is data associated with it. +[**force_remove_property_type_from_entity_type**](EdmApi.md#force_remove_property_type_from_entity_type) | **DELETE** /datastore/edm/entity/type/{entityTypeId}/{propertyTypeId}/force | Updates the EntityType definition for the given EntityType UUID by removing the given PropertyType UUID, regardless of whether or not there is data associated with the entity type. +[**get_all_association_entity_types**](EdmApi.md#get_all_association_entity_types) | **GET** /datastore/edm/association/type/ | Gets all association EntityType definitions. +[**get_all_available_association_types**](EdmApi.md#get_all_available_association_types) | **GET** /datastore/edm/association/type/{associationTypeId}/available | Get all available associations for the given AssociationType UUID. +[**get_all_entity_set_property_metadata**](EdmApi.md#get_all_entity_set_property_metadata) | **GET** /datastore/entity-sets/all/{entitySetId}/metadata | Get all entity set property metadata. +[**get_all_entity_sets**](EdmApi.md#get_all_entity_sets) | **GET** /datastore/entity-sets | Get all EntitySet definitions. +[**get_all_entity_type_property_metadata**](EdmApi.md#get_all_entity_type_property_metadata) | **GET** /datastore/edm/entity/type/{entityTypeId}/property/type | Get all EntityType propertyType metadata +[**get_all_entity_types**](EdmApi.md#get_all_entity_types) | **GET** /datastore/edm/entity/type/ | Gets all EntityType definitions. +[**get_all_property_types**](EdmApi.md#get_all_property_types) | **GET** /datastore/edm/property/type/ | Gets all PropertyType definitions. +[**get_all_property_types_in_namespace**](EdmApi.md#get_all_property_types_in_namespace) | **GET** /datastore/edm/property/type/namespace/{namespace} | Gets all PropertyType definitions under the given namespace. +[**get_all_property_usage_summaries**](EdmApi.md#get_all_property_usage_summaries) | **GET** /datastore/edm/summary | Get Property Usage Summary for all properties. +[**get_association_type**](EdmApi.md#get_association_type) | **GET** /datastore/edm/association/type/{associationTypeId} | Get the AssociationType definition for the given AssociationType UUID. +[**get_association_type_details**](EdmApi.md#get_association_type_details) | **GET** /datastore/edm/association/type/{associationTypeId}/detailed | Get details about the AssociationType for the given AssociationType UUID. +[**get_entity_data_model**](EdmApi.md#get_entity_data_model) | **GET** /datastore/edm/ | Gets the entity data model, including namespaces, schemas, entity types, association types, and property types. +[**get_entity_data_model_diff**](EdmApi.md#get_entity_data_model_diff) | **POST** /datastore/edm/diff/ | Gets the changes between the existing entity data model and the entity data model passed in, including schemas, association types, entity types, and property types. +[**get_entity_set**](EdmApi.md#get_entity_set) | **GET** /datastore/entity-sets/all/{entitySetId} | Get the EntitySet definition for the given EntitySet UUID. +[**get_entity_set_id**](EdmApi.md#get_entity_set_id) | **GET** /datastore/entity-sets/ids/{entitySetName} | Gets the EntitySet UUID for the given EntitySet name. +[**get_entity_set_ids**](EdmApi.md#get_entity_set_ids) | **POST** /datastore/entity-sets/ids/ | Get IDs for entity sets given their names. +[**get_entity_set_property_metadata**](EdmApi.md#get_entity_set_property_metadata) | **GET** /datastore/entity-sets/all/{entitySetId}/properties/{propertyTypeId}/ | Get specified property type metadata for an entity set. +[**get_entity_type**](EdmApi.md#get_entity_type) | **GET** /datastore/edm/entity/type/{entityTypeId} | Gets the EntityType definition for the given EntityType UUID. +[**get_entity_type_hierarchy**](EdmApi.md#get_entity_type_hierarchy) | **PATCH** /datastore/edm/entity/type/{entityTypeId}/hierarchy | Get the EntityType hierarchy for the given EntityType UUID. +[**get_entity_type_id**](EdmApi.md#get_entity_type_id) | **GET** /datastore/edm/ids/entity/type/{namespace}/{name} | Gets the EntityType UUID for the given EntityType FQN. +[**get_entity_type_property_metadata**](EdmApi.md#get_entity_type_property_metadata) | **GET** /datastore/edm/entity/type/{entityTypeId}/property/type/{propertyTypeId} | Get EntityType propertyType metadata +[**get_property_metadata_for_entity_sets**](EdmApi.md#get_property_metadata_for_entity_sets) | **POST** /datastore/entity-sets/all/metadata | Get property metadata for entity sets. +[**get_property_type**](EdmApi.md#get_property_type) | **GET** /datastore/edm/property/type/{propertyTypeId} | Gets the PropertyType definition for the given PropertyType UUID. +[**get_property_type_id**](EdmApi.md#get_property_type_id) | **GET** /datastore/edm/ids/property/type/{namespace}/{name} | Gets the PropertyType UUID for the given PropertyType FQN. +[**get_property_types_for_entity_set**](EdmApi.md#get_property_types_for_entity_set) | **GET** /datastore/entity-sets/all/{entitySetId}/properties | Get all Property Types for entity set +[**get_property_usage_summary**](EdmApi.md#get_property_usage_summary) | **GET** /datastore/edm/summary/{propertyTypeId} | Get Property Usage Summary for property with given ID. +[**get_schema_contents**](EdmApi.md#get_schema_contents) | **GET** /datastore/edm/schema/{namespace}/{name} | Gets the schema contents for a corresponding namespace and name. +[**get_schemas**](EdmApi.md#get_schemas) | **GET** /datastore/edm/schema | Gets all schemas. +[**get_schemas_in_namespace**](EdmApi.md#get_schemas_in_namespace) | **GET** /datastore/edm/schema/{namespace} | Gets all schemas associated with a given namespace and accessible by the caller. +[**remove_dst_entity_type_from_association_type**](EdmApi.md#remove_dst_entity_type_from_association_type) | **DELETE** /datastore/edm/association/type/{associationTypeId}/dst/{entityTypeId} | Updates the AssociationType dst entity types for the given AssociationType UUID by removing the given EntityType UUID. +[**remove_entity_sets_from_linking_entity_set**](EdmApi.md#remove_entity_sets_from_linking_entity_set) | **DELETE** /datastore/entity-sets/linking/{linkingEntitySetId} | Removes/unlinks the linked entity sets from the linking entity set +[**remove_entity_sets_from_linking_entity_sets**](EdmApi.md#remove_entity_sets_from_linking_entity_sets) | **DELETE** /datastore/entity-sets/linking/ | Removes/unlinks the linked entity sets from the linking entity set +[**remove_primary_key_from_entity_type**](EdmApi.md#remove_primary_key_from_entity_type) | **DELETE** /datastore/edm/entity/type/key/{entityTypeId}/{propertyTypeId} | Removes a primary key with a given ID from an entity type with a given ID. +[**remove_property_type_from_entity_type**](EdmApi.md#remove_property_type_from_entity_type) | **DELETE** /datastore/edm/entity/type/{entityTypeId}/{propertyTypeId} | Updates the EntityType definition for the given EntityType UUID by removing the given PropertyType UUID. +[**remove_src_entity_type_from_association_type**](EdmApi.md#remove_src_entity_type_from_association_type) | **DELETE** /datastore/edm/association/type/{associationTypeId}/src/{entityTypeId} | Updates the AssociationType src entity types for the given AssociationType UUID by removing the given EntityType UUID. +[**reorder_property_types_in_entity_type**](EdmApi.md#reorder_property_types_in_entity_type) | **PATCH** /datastore/edm/entity/type/{entityTypeId}/property/type | Updates the EntityType definition for the given EntityType UUID by reordering its properties as specified by the provided list. +[**update_entity_data_model**](EdmApi.md#update_entity_data_model) | **PATCH** /datastore/edm/ | Updates the entity data model, including schemas, entity types, association types, and property types. +[**update_entity_set_meta_data**](EdmApi.md#update_entity_set_meta_data) | **PATCH** /datastore/entity-sets/all/{entitySetId}/metadata/ | Updates the EntitySet definition for the given EntitySet UUID with the given metadata. +[**update_entity_set_property_metadata**](EdmApi.md#update_entity_set_property_metadata) | **POST** /datastore/entity-sets/all/{entitySetId}/properties/{propertyTypeId}/ | Updates the property type metadata for the given entity set. +[**update_entity_type_meta_data**](EdmApi.md#update_entity_type_meta_data) | **PATCH** /datastore/edm/entity/type/{entityTypeId} | Updates the EntityType definition for the given EntityType UUID with the given metadata. +[**update_entity_type_property_metadata**](EdmApi.md#update_entity_type_property_metadata) | **POST** /datastore/edm/entity/type/{entityTypeId}/property/type/{propertyTypeId} | Update EntityType Property metadata +[**update_property_type_meta_data**](EdmApi.md#update_property_type_meta_data) | **PATCH** /datastore/edm/property/type/{propertyTypeId} | Updates the PropertyType definition for the given PropertyType UUID with the given metadata. +[**update_schema**](EdmApi.md#update_schema) | **PATCH** /datastore/edm/schema/{namespace}/{name} | Edits the schema contents for a corresponding namespace and name. + + + +## add_dst_entity_type_to_association_type + +> add_dst_entity_type_to_association_type(association_type_id, entity_type_id) + +Update the AssociationType dst entity types for the given AssociationType UUID by adding the given EntityType UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +association_type_id = 'association_type_id_example' # String | +entity_type_id = 'entity_type_id_example' # String | + +begin + #Update the AssociationType dst entity types for the given AssociationType UUID by adding the given EntityType UUID. + api_instance.add_dst_entity_type_to_association_type(association_type_id, entity_type_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->add_dst_entity_type_to_association_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **association_type_id** | [**String**](.md)| | + **entity_type_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## add_entity_sets_to_linking_entity_set + +> Integer add_entity_sets_to_linking_entity_set(linking_entity_set_id, opts) + +Adds the entity sets as linked entity sets to the linking entity set + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +linking_entity_set_id = 'linking_entity_set_id_example' # String | +opts = { + request_body: ['request_body_example'] # Array | +} + +begin + #Adds the entity sets as linked entity sets to the linking entity set + result = api_instance.add_entity_sets_to_linking_entity_set(linking_entity_set_id, opts) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->add_entity_sets_to_linking_entity_set: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **linking_entity_set_id** | [**String**](.md)| | + **request_body** | [**Array<String>**](String.md)| | [optional] + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## add_entity_sets_to_linking_entity_sets + +> Integer add_entity_sets_to_linking_entity_sets(linking_entity_set_id, request_body) + +Adds the entity sets as linked entity sets to the linking entity sets + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +linking_entity_set_id = 'linking_entity_set_id_example' # String | +request_body = nil # Hash> | + +begin + #Adds the entity sets as linked entity sets to the linking entity sets + result = api_instance.add_entity_sets_to_linking_entity_sets(linking_entity_set_id, request_body) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->add_entity_sets_to_linking_entity_sets: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **linking_entity_set_id** | **String**| | + **request_body** | [**Hash<String, Array<String>>**](Array.md)| | + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## add_primary_key_to_entity_type + +> add_primary_key_to_entity_type(entity_type_id, property_type_id) + +Adds a primary key with a given ID to an entity type with a given ID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_type_id = 'entity_type_id_example' # String | +property_type_id = 'property_type_id_example' # String | + +begin + #Adds a primary key with a given ID to an entity type with a given ID. + api_instance.add_primary_key_to_entity_type(entity_type_id, property_type_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->add_primary_key_to_entity_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_id** | [**String**](.md)| | + **property_type_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## add_property_type_to_entity_type + +> add_property_type_to_entity_type(entity_type_id, property_type_id) + +Updates the EntityType definition for the given EntityType UUID by adding the given PropertyType UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_type_id = 'entity_type_id_example' # String | +property_type_id = 'property_type_id_example' # String | + +begin + #Updates the EntityType definition for the given EntityType UUID by adding the given PropertyType UUID. + api_instance.add_property_type_to_entity_type(entity_type_id, property_type_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->add_property_type_to_entity_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_id** | [**String**](.md)| | + **property_type_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## add_src_entity_type_to_association_type + +> add_src_entity_type_to_association_type(association_type_id, entity_type_id) + +Update the AssociationType src entity types for the given AssociationType UUID by adding the given EntityType UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +association_type_id = 'association_type_id_example' # String | +entity_type_id = 'entity_type_id_example' # String | + +begin + #Update the AssociationType src entity types for the given AssociationType UUID by adding the given EntityType UUID. + api_instance.add_src_entity_type_to_association_type(association_type_id, entity_type_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->add_src_entity_type_to_association_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **association_type_id** | [**String**](.md)| | + **entity_type_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## create_association_type + +> create_association_type(association_type) + +Creates a new AssociationType definition, if it doesn't exist. + +### Example + +```ruby +# load the gem +require 'openapi_client' + +api_instance = OpenapiClient::EdmApi.new +association_type = [OpenapiClient::AssociationType.new] # Array | + +begin + #Creates a new AssociationType definition, if it doesn't exist. + api_instance.create_association_type(association_type) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->create_association_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **association_type** | [**Array<AssociationType>**](AssociationType.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## create_empty_schema + +> create_empty_schema(namespace, name) + +Creates an empty schema, if it doesn't exist. If schema exists then no action is taken. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +namespace = 'namespace_example' # String | +name = 'name_example' # String | + +begin + #Creates an empty schema, if it doesn't exist. If schema exists then no action is taken. + api_instance.create_empty_schema(namespace, name) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->create_empty_schema: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | **String**| | + **name** | **String**| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## create_entity_sets + +> create_entity_sets(entity_set) + +Creates new EntitySet definitions if they don't exist. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_set = [OpenapiClient::EntitySet.new] # Array | + +begin + #Creates new EntitySet definitions if they don't exist. + api_instance.create_entity_sets(entity_set) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->create_entity_sets: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set** | [**Array<EntitySet>**](EntitySet.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## create_entity_type + +> create_entity_type(entity_type) + +Creates a new EntityType definition, if it doesn't exist. + +### Example + +```ruby +# load the gem +require 'openapi_client' + +api_instance = OpenapiClient::EdmApi.new +entity_type = OpenapiClient::EntityType.new # EntityType | + +begin + #Creates a new EntityType definition, if it doesn't exist. + api_instance.create_entity_type(entity_type) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->create_entity_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type** | [**EntityType**](EntityType.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## create_property_type + +> create_property_type(property_type) + +Creates a new PropertyType definition, if it doesn\"t exist. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +property_type = OpenapiClient::PropertyType.new # PropertyType | + +begin + #Creates a new PropertyType definition, if it doesn\"t exist. + api_instance.create_property_type(property_type) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->create_property_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **property_type** | [**PropertyType**](PropertyType.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## create_schema_if_not_exists + +> create_schema_if_not_exists(schema) + +Creates an empty schema, if it doesn't exist. If schema exists then no action is taken. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +schema = OpenapiClient::Schema.new # Schema | + +begin + #Creates an empty schema, if it doesn't exist. If schema exists then no action is taken. + api_instance.create_schema_if_not_exists(schema) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->create_schema_if_not_exists: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **schema** | [**Schema**](Schema.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## delete_association_type + +> delete_association_type(association_type_id) + +Deletes the AssociationType definition for the given AssociationType UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' + +api_instance = OpenapiClient::EdmApi.new +association_type_id = 'association_type_id_example' # String | + +begin + #Deletes the AssociationType definition for the given AssociationType UUID. + api_instance.delete_association_type(association_type_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->delete_association_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **association_type_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## delete_entity_set + +> delete_entity_set(entity_set_id) + +Deletes the EntitySet definition for the given EntitySet UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_set_id = 'entity_set_id_example' # String | + +begin + #Deletes the EntitySet definition for the given EntitySet UUID. + api_instance.delete_entity_set(entity_set_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->delete_entity_set: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## delete_entity_type + +> delete_entity_type(entity_type_id) + +Deletes the EntityType definition for the given EntityType UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' + +api_instance = OpenapiClient::EdmApi.new +entity_type_id = 'entity_type_id_example' # String | + +begin + #Deletes the EntityType definition for the given EntityType UUID. + api_instance.delete_entity_type(entity_type_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->delete_entity_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## delete_property_type + +> delete_property_type(property_type_id) + +Deletes the PropertyType definition for the given PropertyType UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +property_type_id = 'property_type_id_example' # String | + +begin + #Deletes the PropertyType definition for the given PropertyType UUID. + api_instance.delete_property_type(property_type_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->delete_property_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **property_type_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## force_delete_property_type + +> force_delete_property_type(property_type_id) + +Deletes the PropertyType definition for the given PropertyType UUID regardless of whether or not there is data associated with it. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +property_type_id = 'property_type_id_example' # String | + +begin + #Deletes the PropertyType definition for the given PropertyType UUID regardless of whether or not there is data associated with it. + api_instance.force_delete_property_type(property_type_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->force_delete_property_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **property_type_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## force_remove_property_type_from_entity_type + +> force_remove_property_type_from_entity_type(entity_type_id, property_type_id) + +Updates the EntityType definition for the given EntityType UUID by removing the given PropertyType UUID, regardless of whether or not there is data associated with the entity type. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_type_id = 'entity_type_id_example' # String | +property_type_id = 'property_type_id_example' # String | + +begin + #Updates the EntityType definition for the given EntityType UUID by removing the given PropertyType UUID, regardless of whether or not there is data associated with the entity type. + api_instance.force_remove_property_type_from_entity_type(entity_type_id, property_type_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->force_remove_property_type_from_entity_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_id** | [**String**](.md)| | + **property_type_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## get_all_association_entity_types + +> Array<AssociationType> get_all_association_entity_types + +Gets all association EntityType definitions. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new + +begin + #Gets all association EntityType definitions. + result = api_instance.get_all_association_entity_types + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_all_association_entity_types: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Array<AssociationType>**](AssociationType.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_all_available_association_types + +> Array<AssociationType> get_all_available_association_types(association_type_id) + +Get all available associations for the given AssociationType UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +association_type_id = 'association_type_id_example' # String | + +begin + #Get all available associations for the given AssociationType UUID. + result = api_instance.get_all_available_association_types(association_type_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_all_available_association_types: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **association_type_id** | [**String**](.md)| | + +### Return type + +[**Array<AssociationType>**](AssociationType.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_all_entity_set_property_metadata + +> Hash<String, EntitySetPropertyMetaData> get_all_entity_set_property_metadata(entity_set_id) + +Get all entity set property metadata. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_set_id = 'entity_set_id_example' # String | + +begin + #Get all entity set property metadata. + result = api_instance.get_all_entity_set_property_metadata(entity_set_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_all_entity_set_property_metadata: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + +### Return type + +[**Hash<String, EntitySetPropertyMetaData>**](EntitySetPropertyMetaData.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_all_entity_sets + +> Array<EntitySet> get_all_entity_sets + +Get all EntitySet definitions. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new + +begin + #Get all EntitySet definitions. + result = api_instance.get_all_entity_sets + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_all_entity_sets: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Array<EntitySet>**](EntitySet.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_all_entity_type_property_metadata + +> Hash<String, EntityTypePropertyMetadata> get_all_entity_type_property_metadata(entity_type_id) + +Get all EntityType propertyType metadata + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_type_id = 'entity_type_id_example' # String | + +begin + #Get all EntityType propertyType metadata + result = api_instance.get_all_entity_type_property_metadata(entity_type_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_all_entity_type_property_metadata: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_id** | [**String**](.md)| | + +### Return type + +[**Hash<String, EntityTypePropertyMetadata>**](EntityTypePropertyMetadata.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_all_entity_types + +> Array<EntityType> get_all_entity_types + +Gets all EntityType definitions. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new + +begin + #Gets all EntityType definitions. + result = api_instance.get_all_entity_types + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_all_entity_types: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Array<EntityType>**](EntityType.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_all_property_types + +> Array<PropertyType> get_all_property_types + +Gets all PropertyType definitions. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new + +begin + #Gets all PropertyType definitions. + result = api_instance.get_all_property_types + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_all_property_types: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Array<PropertyType>**](PropertyType.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_all_property_types_in_namespace + +> Array<PropertyType> get_all_property_types_in_namespace(namespace) + +Gets all PropertyType definitions under the given namespace. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +namespace = 'namespace_example' # String | + +begin + #Gets all PropertyType definitions under the given namespace. + result = api_instance.get_all_property_types_in_namespace(namespace) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_all_property_types_in_namespace: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | **String**| | + +### Return type + +[**Array<PropertyType>**](PropertyType.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_all_property_usage_summaries + +> Hash<String, PropertyUsageSummary> get_all_property_usage_summaries + +Get Property Usage Summary for all properties. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new + +begin + #Get Property Usage Summary for all properties. + result = api_instance.get_all_property_usage_summaries + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_all_property_usage_summaries: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Hash<String, PropertyUsageSummary>**](PropertyUsageSummary.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_association_type + +> AssociationType get_association_type(association_type_id) + +Get the AssociationType definition for the given AssociationType UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +association_type_id = 'association_type_id_example' # String | + +begin + #Get the AssociationType definition for the given AssociationType UUID. + result = api_instance.get_association_type(association_type_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_association_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **association_type_id** | [**String**](.md)| | + +### Return type + +[**AssociationType**](AssociationType.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_association_type_details + +> AssociationType get_association_type_details(association_type_id) + +Get details about the AssociationType for the given AssociationType UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +association_type_id = 'association_type_id_example' # String | + +begin + #Get details about the AssociationType for the given AssociationType UUID. + result = api_instance.get_association_type_details(association_type_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_association_type_details: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **association_type_id** | [**String**](.md)| | + +### Return type + +[**AssociationType**](AssociationType.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_entity_data_model + +> EDM get_entity_data_model + +Gets the entity data model, including namespaces, schemas, entity types, association types, and property types. + +### Example + +```ruby +# load the gem +require 'openapi_client' + +api_instance = OpenapiClient::EdmApi.new + +begin + #Gets the entity data model, including namespaces, schemas, entity types, association types, and property types. + result = api_instance.get_entity_data_model + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_entity_data_model: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**EDM**](EDM.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_entity_data_model_diff + +> EDMdiff get_entity_data_model_diff(ed_mdiff) + +Gets the changes between the existing entity data model and the entity data model passed in, including schemas, association types, entity types, and property types. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +ed_mdiff = OpenapiClient::EDMdiff.new # EDMdiff | + +begin + #Gets the changes between the existing entity data model and the entity data model passed in, including schemas, association types, entity types, and property types. + result = api_instance.get_entity_data_model_diff(ed_mdiff) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_entity_data_model_diff: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ed_mdiff** | [**EDMdiff**](EDMdiff.md)| | + +### Return type + +[**EDMdiff**](EDMdiff.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## get_entity_set + +> EntitySet get_entity_set(entity_set_id) + +Get the EntitySet definition for the given EntitySet UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_set_id = 'entity_set_id_example' # String | + +begin + #Get the EntitySet definition for the given EntitySet UUID. + result = api_instance.get_entity_set(entity_set_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_entity_set: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + +### Return type + +[**EntitySet**](EntitySet.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_entity_set_id + +> String get_entity_set_id(entity_set_name) + +Gets the EntitySet UUID for the given EntitySet name. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_set_name = 'entity_set_name_example' # String | + +begin + #Gets the EntitySet UUID for the given EntitySet name. + result = api_instance.get_entity_set_id(entity_set_name) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_entity_set_id: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_name** | **String**| | + +### Return type + +**String** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_entity_set_ids + +> Hash<String, String> get_entity_set_ids(opts) + +Get IDs for entity sets given their names. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +opts = { + request_body: ['request_body_example'] # Array | +} + +begin + #Get IDs for entity sets given their names. + result = api_instance.get_entity_set_ids(opts) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_entity_set_ids: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **request_body** | [**Array<String>**](String.md)| | [optional] + +### Return type + +**Hash<String, String>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## get_entity_set_property_metadata + +> EntitySetPropertyMetaData get_entity_set_property_metadata(entity_set_id, property_type_id) + +Get specified property type metadata for an entity set. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_set_id = 'entity_set_id_example' # String | +property_type_id = 'property_type_id_example' # String | + +begin + #Get specified property type metadata for an entity set. + result = api_instance.get_entity_set_property_metadata(entity_set_id, property_type_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_entity_set_property_metadata: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **property_type_id** | [**String**](.md)| | + +### Return type + +[**EntitySetPropertyMetaData**](EntitySetPropertyMetaData.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_entity_type + +> EntityType get_entity_type(entity_type_id) + +Gets the EntityType definition for the given EntityType UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' + +api_instance = OpenapiClient::EdmApi.new +entity_type_id = 'entity_type_id_example' # String | + +begin + #Gets the EntityType definition for the given EntityType UUID. + result = api_instance.get_entity_type(entity_type_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_entity_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_id** | [**String**](.md)| | + +### Return type + +[**EntityType**](EntityType.md) + +### Authorization + +No authorization required + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_entity_type_hierarchy + +> get_entity_type_hierarchy(entity_type_id) + +Get the EntityType hierarchy for the given EntityType UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_type_id = 'entity_type_id_example' # String | + +begin + #Get the EntityType hierarchy for the given EntityType UUID. + api_instance.get_entity_type_hierarchy(entity_type_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_entity_type_hierarchy: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## get_entity_type_id + +> String get_entity_type_id(namespace, name) + +Gets the EntityType UUID for the given EntityType FQN. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +namespace = 'openlattice' # String | +name = 'myentitytype' # String | + +begin + #Gets the EntityType UUID for the given EntityType FQN. + result = api_instance.get_entity_type_id(namespace, name) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_entity_type_id: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | **String**| | + **name** | **String**| | + +### Return type + +**String** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_entity_type_property_metadata + +> EntityTypePropertyMetadata get_entity_type_property_metadata(entity_type_id, property_type_id) + +Get EntityType propertyType metadata + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_type_id = 'entity_type_id_example' # String | +property_type_id = 'property_type_id_example' # String | + +begin + #Get EntityType propertyType metadata + result = api_instance.get_entity_type_property_metadata(entity_type_id, property_type_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_entity_type_property_metadata: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_id** | [**String**](.md)| | + **property_type_id** | [**String**](.md)| | + +### Return type + +[**EntityTypePropertyMetadata**](EntityTypePropertyMetadata.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_property_metadata_for_entity_sets + +> Hash<String, Hash<String, EntitySetPropertyMetaData>> get_property_metadata_for_entity_sets(opts) + +Get property metadata for entity sets. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +opts = { + request_body: ['request_body_example'] # Array | +} + +begin + #Get property metadata for entity sets. + result = api_instance.get_property_metadata_for_entity_sets(opts) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_property_metadata_for_entity_sets: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **request_body** | [**Array<String>**](String.md)| | [optional] + +### Return type + +**Hash<String, Hash<String, EntitySetPropertyMetaData>>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## get_property_type + +> PropertyType get_property_type(property_type_id) + +Gets the PropertyType definition for the given PropertyType UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +property_type_id = 'property_type_id_example' # String | + +begin + #Gets the PropertyType definition for the given PropertyType UUID. + result = api_instance.get_property_type(property_type_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_property_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **property_type_id** | [**String**](.md)| | + +### Return type + +[**PropertyType**](PropertyType.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_property_type_id + +> String get_property_type_id(namespace, name) + +Gets the PropertyType UUID for the given PropertyType FQN. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +namespace = 'namespace_example' # String | +name = 'name_example' # String | + +begin + #Gets the PropertyType UUID for the given PropertyType FQN. + result = api_instance.get_property_type_id(namespace, name) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_property_type_id: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | **String**| | + **name** | **String**| | + +### Return type + +**String** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_property_types_for_entity_set + +> Hash<String, PropertyType> get_property_types_for_entity_set(entity_set_id) + +Get all Property Types for entity set + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_set_id = 'entity_set_id_example' # String | + +begin + #Get all Property Types for entity set + result = api_instance.get_property_types_for_entity_set(entity_set_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_property_types_for_entity_set: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + +### Return type + +[**Hash<String, PropertyType>**](PropertyType.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_property_usage_summary + +> Array<PropertyUsageSummary> get_property_usage_summary(property_type_id) + +Get Property Usage Summary for property with given ID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +property_type_id = 'property_type_id_example' # String | + +begin + #Get Property Usage Summary for property with given ID. + result = api_instance.get_property_usage_summary(property_type_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_property_usage_summary: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **property_type_id** | [**String**](.md)| | + +### Return type + +[**Array<PropertyUsageSummary>**](PropertyUsageSummary.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_schema_contents + +> Schema get_schema_contents(namespace, name, opts) + +Gets the schema contents for a corresponding namespace and name. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +namespace = 'namespace_example' # String | +name = 'name_example' # String | +opts = { + file_type: 'yaml' # String | +} + +begin + #Gets the schema contents for a corresponding namespace and name. + result = api_instance.get_schema_contents(namespace, name, opts) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_schema_contents: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | **String**| | + **name** | **String**| | + **file_type** | **String**| | [optional] [default to 'yaml'] + +### Return type + +[**Schema**](Schema.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_schemas + +> Array<Schema> get_schemas + +Gets all schemas. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new + +begin + #Gets all schemas. + result = api_instance.get_schemas + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_schemas: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Array<Schema>**](Schema.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_schemas_in_namespace + +> Array<Schema> get_schemas_in_namespace(namespace) + +Gets all schemas associated with a given namespace and accessible by the caller. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +namespace = 'namespace_example' # String | + +begin + #Gets all schemas associated with a given namespace and accessible by the caller. + result = api_instance.get_schemas_in_namespace(namespace) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->get_schemas_in_namespace: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | **String**| | + +### Return type + +[**Array<Schema>**](Schema.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## remove_dst_entity_type_from_association_type + +> remove_dst_entity_type_from_association_type(association_type_id, entity_type_id) + +Updates the AssociationType dst entity types for the given AssociationType UUID by removing the given EntityType UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +association_type_id = 'association_type_id_example' # String | +entity_type_id = 'entity_type_id_example' # String | + +begin + #Updates the AssociationType dst entity types for the given AssociationType UUID by removing the given EntityType UUID. + api_instance.remove_dst_entity_type_from_association_type(association_type_id, entity_type_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->remove_dst_entity_type_from_association_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **association_type_id** | [**String**](.md)| | + **entity_type_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## remove_entity_sets_from_linking_entity_set + +> Integer remove_entity_sets_from_linking_entity_set(linking_entity_set_id, opts) + +Removes/unlinks the linked entity sets from the linking entity set + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +linking_entity_set_id = 'linking_entity_set_id_example' # String | +opts = { + request_body: ['request_body_example'] # Array | +} + +begin + #Removes/unlinks the linked entity sets from the linking entity set + result = api_instance.remove_entity_sets_from_linking_entity_set(linking_entity_set_id, opts) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->remove_entity_sets_from_linking_entity_set: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **linking_entity_set_id** | **String**| | + **request_body** | [**Array<String>**](String.md)| | [optional] + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## remove_entity_sets_from_linking_entity_sets + +> Integer remove_entity_sets_from_linking_entity_sets(linking_entity_set_id, request_body) + +Removes/unlinks the linked entity sets from the linking entity set + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +linking_entity_set_id = 'linking_entity_set_id_example' # String | +request_body = nil # Hash> | + +begin + #Removes/unlinks the linked entity sets from the linking entity set + result = api_instance.remove_entity_sets_from_linking_entity_sets(linking_entity_set_id, request_body) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->remove_entity_sets_from_linking_entity_sets: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **linking_entity_set_id** | [**String**](.md)| | + **request_body** | [**Hash<String, Array<String>>**](Array.md)| | + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## remove_primary_key_from_entity_type + +> remove_primary_key_from_entity_type(entity_type_id, property_type_id) + +Removes a primary key with a given ID from an entity type with a given ID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_type_id = 'entity_type_id_example' # String | +property_type_id = 'property_type_id_example' # String | + +begin + #Removes a primary key with a given ID from an entity type with a given ID. + api_instance.remove_primary_key_from_entity_type(entity_type_id, property_type_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->remove_primary_key_from_entity_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_id** | [**String**](.md)| | + **property_type_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## remove_property_type_from_entity_type + +> remove_property_type_from_entity_type(entity_type_id, property_type_id) + +Updates the EntityType definition for the given EntityType UUID by removing the given PropertyType UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_type_id = 'entity_type_id_example' # String | +property_type_id = 'property_type_id_example' # String | + +begin + #Updates the EntityType definition for the given EntityType UUID by removing the given PropertyType UUID. + api_instance.remove_property_type_from_entity_type(entity_type_id, property_type_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->remove_property_type_from_entity_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_id** | [**String**](.md)| | + **property_type_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## remove_src_entity_type_from_association_type + +> remove_src_entity_type_from_association_type(association_type_id, entity_type_id) + +Updates the AssociationType src entity types for the given AssociationType UUID by removing the given EntityType UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +association_type_id = 'association_type_id_example' # String | +entity_type_id = 'entity_type_id_example' # String | + +begin + #Updates the AssociationType src entity types for the given AssociationType UUID by removing the given EntityType UUID. + api_instance.remove_src_entity_type_from_association_type(association_type_id, entity_type_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->remove_src_entity_type_from_association_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **association_type_id** | [**String**](.md)| | + **entity_type_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## reorder_property_types_in_entity_type + +> reorder_property_types_in_entity_type(entity_type_id, property_type_ids) + +Updates the EntityType definition for the given EntityType UUID by reordering its properties as specified by the provided list. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_type_id = 'entity_type_id_example' # String | +property_type_ids = ['property_type_ids_example'] # Array | + +begin + #Updates the EntityType definition for the given EntityType UUID by reordering its properties as specified by the provided list. + api_instance.reorder_property_types_in_entity_type(entity_type_id, property_type_ids) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->reorder_property_types_in_entity_type: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_id** | [**String**](.md)| | + **property_type_ids** | [**Array<String>**](String.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## update_entity_data_model + +> update_entity_data_model(edm) + +Updates the entity data model, including schemas, entity types, association types, and property types. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +edm = OpenapiClient::EDM.new # EDM | + +begin + #Updates the entity data model, including schemas, entity types, association types, and property types. + api_instance.update_entity_data_model(edm) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->update_entity_data_model: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **edm** | [**EDM**](EDM.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## update_entity_set_meta_data + +> Integer update_entity_set_meta_data(entity_set_id, metadata_update) + +Updates the EntitySet definition for the given EntitySet UUID with the given metadata. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_set_id = 'entity_set_id_example' # String | +metadata_update = OpenapiClient::MetadataUpdate.new # MetadataUpdate | + +begin + #Updates the EntitySet definition for the given EntitySet UUID with the given metadata. + result = api_instance.update_entity_set_meta_data(entity_set_id, metadata_update) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->update_entity_set_meta_data: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **metadata_update** | [**MetadataUpdate**](MetadataUpdate.md)| | + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## update_entity_set_property_metadata + +> update_entity_set_property_metadata(entity_set_id, property_type_id, metadata_update) + +Updates the property type metadata for the given entity set. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_set_id = 'entity_set_id_example' # String | +property_type_id = 'property_type_id_example' # String | +metadata_update = OpenapiClient::MetadataUpdate.new # MetadataUpdate | + +begin + #Updates the property type metadata for the given entity set. + api_instance.update_entity_set_property_metadata(entity_set_id, property_type_id, metadata_update) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->update_entity_set_property_metadata: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **property_type_id** | [**String**](.md)| | + **metadata_update** | [**MetadataUpdate**](MetadataUpdate.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## update_entity_type_meta_data + +> update_entity_type_meta_data(entity_type_id, metadata_update) + +Updates the EntityType definition for the given EntityType UUID with the given metadata. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_type_id = 'entity_type_id_example' # String | +metadata_update = OpenapiClient::MetadataUpdate.new # MetadataUpdate | + +begin + #Updates the EntityType definition for the given EntityType UUID with the given metadata. + api_instance.update_entity_type_meta_data(entity_type_id, metadata_update) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->update_entity_type_meta_data: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_id** | [**String**](.md)| | + **metadata_update** | [**MetadataUpdate**](MetadataUpdate.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## update_entity_type_property_metadata + +> update_entity_type_property_metadata(entity_type_id, property_type_id) + +Update EntityType Property metadata + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +entity_type_id = 'entity_type_id_example' # String | +property_type_id = 'property_type_id_example' # String | + +begin + #Update EntityType Property metadata + api_instance.update_entity_type_property_metadata(entity_type_id, property_type_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->update_entity_type_property_metadata: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_type_id** | [**String**](.md)| | + **property_type_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## update_property_type_meta_data + +> update_property_type_meta_data(property_type_id, metadata_update) + +Updates the PropertyType definition for the given PropertyType UUID with the given metadata. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +property_type_id = 'property_type_id_example' # String | +metadata_update = OpenapiClient::MetadataUpdate.new # MetadataUpdate | + +begin + #Updates the PropertyType definition for the given PropertyType UUID with the given metadata. + api_instance.update_property_type_meta_data(property_type_id, metadata_update) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->update_property_type_meta_data: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **property_type_id** | [**String**](.md)| | + **metadata_update** | [**MetadataUpdate**](MetadataUpdate.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## update_schema + +> update_schema(namespace, name, edm_request) + +Edits the schema contents for a corresponding namespace and name. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EdmApi.new +namespace = 'namespace_example' # String | +name = 'name_example' # String | +edm_request = OpenapiClient::EdmRequest.new # EdmRequest | + +begin + #Edits the schema contents for a corresponding namespace and name. + api_instance.update_schema(namespace, name, edm_request) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EdmApi->update_schema: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **namespace** | **String**| | + **name** | **String**| | + **edm_request** | [**EdmRequest**](EdmRequest.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + diff --git a/ruby/docs/EdmRequest.md b/ruby/docs/EdmRequest.md new file mode 100644 index 0000000..77b7559 --- /dev/null +++ b/ruby/docs/EdmRequest.md @@ -0,0 +1,21 @@ +# OpenapiClient::EdmRequest + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**action** | **String** | | [optional] +**property_types** | **Array<String>** | | [optional] +**entity_types** | **Array<String>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::EdmRequest.new(action: null, + property_types: null, + entity_types: null) +``` + + diff --git a/ruby/docs/Entity.md b/ruby/docs/Entity.md new file mode 100644 index 0000000..23d4995 --- /dev/null +++ b/ruby/docs/Entity.md @@ -0,0 +1,19 @@ +# OpenapiClient::Entity + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | [**EntityKey**](EntityKey.md) | | [optional] +**details** | **Hash<String, String>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::Entity.new(key: null, + details: null) +``` + + diff --git a/ruby/docs/EntityDataKey.md b/ruby/docs/EntityDataKey.md new file mode 100644 index 0000000..7b7083c --- /dev/null +++ b/ruby/docs/EntityDataKey.md @@ -0,0 +1,19 @@ +# OpenapiClient::EntityDataKey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_set_id** | **String** | | [optional] +**entity_key_id** | **String** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::EntityDataKey.new(entity_set_id: null, + entity_key_id: null) +``` + + diff --git a/ruby/docs/EntityDefinition.md b/ruby/docs/EntityDefinition.md new file mode 100644 index 0000000..61463c6 --- /dev/null +++ b/ruby/docs/EntityDefinition.md @@ -0,0 +1,23 @@ +# OpenapiClient::EntityDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fqn** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**entity_set_name** | **String** | | [optional] +**property_definitions** | [**Hash<String, PropertyDefinition>**](PropertyDefinition.md) | | [optional] +**update_type** | **String** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::EntityDefinition.new(fqn: null, + entity_set_name: null, + property_definitions: null, + update_type: null) +``` + + diff --git a/ruby/docs/EntityKey.md b/ruby/docs/EntityKey.md new file mode 100644 index 0000000..787722e --- /dev/null +++ b/ruby/docs/EntityKey.md @@ -0,0 +1,19 @@ +# OpenapiClient::EntityKey + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_set_id** | **String** | | [optional] +**entity_id** | **String** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::EntityKey.new(entity_set_id: null, + entity_id: null) +``` + + diff --git a/ruby/docs/EntityKeyPair.md b/ruby/docs/EntityKeyPair.md new file mode 100644 index 0000000..d85b1da --- /dev/null +++ b/ruby/docs/EntityKeyPair.md @@ -0,0 +1,19 @@ +# OpenapiClient::EntityKeyPair + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**first** | **String** | | [optional] +**second** | **String** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::EntityKeyPair.new(first: null, + second: null) +``` + + diff --git a/ruby/docs/EntityLinkingFeatures.md b/ruby/docs/EntityLinkingFeatures.md new file mode 100644 index 0000000..5083a50 --- /dev/null +++ b/ruby/docs/EntityLinkingFeatures.md @@ -0,0 +1,19 @@ +# OpenapiClient::EntityLinkingFeatures + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_linking_feedback** | [**EntityLinkingFeedback**](EntityLinkingFeedback.md) | | [optional] +**features** | **Hash<String, Float>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::EntityLinkingFeatures.new(entity_linking_feedback: null, + features: null) +``` + + diff --git a/ruby/docs/EntityLinkingFeedback.md b/ruby/docs/EntityLinkingFeedback.md new file mode 100644 index 0000000..dbe0609 --- /dev/null +++ b/ruby/docs/EntityLinkingFeedback.md @@ -0,0 +1,19 @@ +# OpenapiClient::EntityLinkingFeedback + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_key_pair** | [**EntityKeyPair**](EntityKeyPair.md) | | [optional] +**linked** | **Boolean** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::EntityLinkingFeedback.new(entity_key_pair: null, + linked: null) +``` + + diff --git a/ruby/docs/EntityNeighborsFilter.md b/ruby/docs/EntityNeighborsFilter.md new file mode 100644 index 0000000..127536a --- /dev/null +++ b/ruby/docs/EntityNeighborsFilter.md @@ -0,0 +1,23 @@ +# OpenapiClient::EntityNeighborsFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_key_ids** | **Array<String>** | | [optional] +**src** | **Array<String>** | | [optional] +**dst** | **Array<String>** | | [optional] +**edge** | **Array<String>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::EntityNeighborsFilter.new(entity_key_ids: null, + src: null, + dst: null, + edge: null) +``` + + diff --git a/ruby/docs/EntitySet.md b/ruby/docs/EntitySet.md new file mode 100644 index 0000000..9745fa7 --- /dev/null +++ b/ruby/docs/EntitySet.md @@ -0,0 +1,37 @@ +# OpenapiClient::EntitySet + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**entity_type_id** | **String** | | [optional] +**name** | **String** | | [optional] +**title** | **String** | | [optional] +**description** | **String** | | [optional] +**contacts** | **Array<String>** | | [optional] +**linking** | **Boolean** | | [optional] +**linked_entity_sets** | **Array<String>** | | [optional] +**organization_id** | **String** | | [optional] +**flags** | **Array<String>** | | [optional] +**partitions** | **Array<Integer>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::EntitySet.new(id: null, + entity_type_id: null, + name: null, + title: null, + description: null, + contacts: null, + linking: null, + linked_entity_sets: null, + organization_id: null, + flags: null, + partitions: null) +``` + + diff --git a/ruby/docs/EntitySetCollection.md b/ruby/docs/EntitySetCollection.md new file mode 100644 index 0000000..743666e --- /dev/null +++ b/ruby/docs/EntitySetCollection.md @@ -0,0 +1,31 @@ +# OpenapiClient::EntitySetCollection + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | An optional UUID for the entity set collection. | [optional] +**name** | **String** | The unique name of the entity set collection. | [optional] +**title** | **String** | The friendly name for the entity set collection. | [optional] +**description** | **String** | A description of the entity set collection. | [optional] +**entity_type_collection_id** | **String** | The id of the entity type collection that this entity set collection maps to. | [optional] +**template** | **Hash<String, String>** | A mapping from collection template type ids to entity set ids. | [optional] +**contacts** | **Array<String>** | A set of contact methods for the owners of this entity set collection. | [optional] +**organization_id** | **String** | The id of the organization that this entity set collection belongs to. | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::EntitySetCollection.new(id: null, + name: null, + title: null, + description: null, + entity_type_collection_id: null, + template: null, + contacts: null, + organization_id: null) +``` + + diff --git a/ruby/docs/EntitySetPropertyMetaData.md b/ruby/docs/EntitySetPropertyMetaData.md new file mode 100644 index 0000000..b34e83a --- /dev/null +++ b/ruby/docs/EntitySetPropertyMetaData.md @@ -0,0 +1,23 @@ +# OpenapiClient::EntitySetPropertyMetaData + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**title** | **String** | | [optional] +**description** | **String** | | [optional] +**property_tags** | **Array<String>** | | [optional] +**default_show** | **Boolean** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::EntitySetPropertyMetaData.new(title: null, + description: null, + property_tags: null, + default_show: null) +``` + + diff --git a/ruby/docs/EntitySetSelection.md b/ruby/docs/EntitySetSelection.md new file mode 100644 index 0000000..b243cac --- /dev/null +++ b/ruby/docs/EntitySetSelection.md @@ -0,0 +1,19 @@ +# OpenapiClient::EntitySetSelection + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**ids** | **Array<String>** | | [optional] +**properties** | **Array<String>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::EntitySetSelection.new(ids: null, + properties: null) +``` + + diff --git a/ruby/docs/EntitySetsApi.md b/ruby/docs/EntitySetsApi.md new file mode 100644 index 0000000..2525670 --- /dev/null +++ b/ruby/docs/EntitySetsApi.md @@ -0,0 +1,921 @@ +# OpenapiClient::EntitySetsApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_entity_sets_to_linking_entity_set**](EntitySetsApi.md#add_entity_sets_to_linking_entity_set) | **POST** /datastore/entity-sets/linking/{linkingEntitySetId} | Adds the entity sets as linked entity sets to the linking entity set +[**add_entity_sets_to_linking_entity_sets**](EntitySetsApi.md#add_entity_sets_to_linking_entity_sets) | **PUT** /datastore/entity-sets/linking/ | Adds the entity sets as linked entity sets to the linking entity sets +[**create_entity_sets**](EntitySetsApi.md#create_entity_sets) | **POST** /datastore/entity-sets | Creates new EntitySet definitions if they don't exist. +[**delete_entity_set**](EntitySetsApi.md#delete_entity_set) | **DELETE** /datastore/entity-sets/all/{entitySetId} | Deletes the EntitySet definition for the given EntitySet UUID. +[**get_all_entity_set_property_metadata**](EntitySetsApi.md#get_all_entity_set_property_metadata) | **GET** /datastore/entity-sets/all/{entitySetId}/metadata | Get all entity set property metadata. +[**get_all_entity_sets**](EntitySetsApi.md#get_all_entity_sets) | **GET** /datastore/entity-sets | Get all EntitySet definitions. +[**get_entity_set**](EntitySetsApi.md#get_entity_set) | **GET** /datastore/entity-sets/all/{entitySetId} | Get the EntitySet definition for the given EntitySet UUID. +[**get_entity_set_id**](EntitySetsApi.md#get_entity_set_id) | **GET** /datastore/entity-sets/ids/{entitySetName} | Gets the EntitySet UUID for the given EntitySet name. +[**get_entity_set_ids**](EntitySetsApi.md#get_entity_set_ids) | **POST** /datastore/entity-sets/ids/ | Get IDs for entity sets given their names. +[**get_entity_set_property_metadata**](EntitySetsApi.md#get_entity_set_property_metadata) | **GET** /datastore/entity-sets/all/{entitySetId}/properties/{propertyTypeId}/ | Get specified property type metadata for an entity set. +[**get_property_metadata_for_entity_sets**](EntitySetsApi.md#get_property_metadata_for_entity_sets) | **POST** /datastore/entity-sets/all/metadata | Get property metadata for entity sets. +[**get_property_types_for_entity_set**](EntitySetsApi.md#get_property_types_for_entity_set) | **GET** /datastore/entity-sets/all/{entitySetId}/properties | Get all Property Types for entity set +[**remove_entity_sets_from_linking_entity_set**](EntitySetsApi.md#remove_entity_sets_from_linking_entity_set) | **DELETE** /datastore/entity-sets/linking/{linkingEntitySetId} | Removes/unlinks the linked entity sets from the linking entity set +[**remove_entity_sets_from_linking_entity_sets**](EntitySetsApi.md#remove_entity_sets_from_linking_entity_sets) | **DELETE** /datastore/entity-sets/linking/ | Removes/unlinks the linked entity sets from the linking entity set +[**update_entity_set_meta_data**](EntitySetsApi.md#update_entity_set_meta_data) | **PATCH** /datastore/entity-sets/all/{entitySetId}/metadata/ | Updates the EntitySet definition for the given EntitySet UUID with the given metadata. +[**update_entity_set_property_metadata**](EntitySetsApi.md#update_entity_set_property_metadata) | **POST** /datastore/entity-sets/all/{entitySetId}/properties/{propertyTypeId}/ | Updates the property type metadata for the given entity set. + + + +## add_entity_sets_to_linking_entity_set + +> Integer add_entity_sets_to_linking_entity_set(linking_entity_set_id, opts) + +Adds the entity sets as linked entity sets to the linking entity set + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EntitySetsApi.new +linking_entity_set_id = 'linking_entity_set_id_example' # String | +opts = { + request_body: ['request_body_example'] # Array | +} + +begin + #Adds the entity sets as linked entity sets to the linking entity set + result = api_instance.add_entity_sets_to_linking_entity_set(linking_entity_set_id, opts) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EntitySetsApi->add_entity_sets_to_linking_entity_set: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **linking_entity_set_id** | [**String**](.md)| | + **request_body** | [**Array<String>**](String.md)| | [optional] + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## add_entity_sets_to_linking_entity_sets + +> Integer add_entity_sets_to_linking_entity_sets(linking_entity_set_id, request_body) + +Adds the entity sets as linked entity sets to the linking entity sets + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EntitySetsApi.new +linking_entity_set_id = 'linking_entity_set_id_example' # String | +request_body = nil # Hash> | + +begin + #Adds the entity sets as linked entity sets to the linking entity sets + result = api_instance.add_entity_sets_to_linking_entity_sets(linking_entity_set_id, request_body) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EntitySetsApi->add_entity_sets_to_linking_entity_sets: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **linking_entity_set_id** | **String**| | + **request_body** | [**Hash<String, Array<String>>**](Array.md)| | + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## create_entity_sets + +> create_entity_sets(entity_set) + +Creates new EntitySet definitions if they don't exist. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EntitySetsApi.new +entity_set = [OpenapiClient::EntitySet.new] # Array | + +begin + #Creates new EntitySet definitions if they don't exist. + api_instance.create_entity_sets(entity_set) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EntitySetsApi->create_entity_sets: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set** | [**Array<EntitySet>**](EntitySet.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## delete_entity_set + +> delete_entity_set(entity_set_id) + +Deletes the EntitySet definition for the given EntitySet UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EntitySetsApi.new +entity_set_id = 'entity_set_id_example' # String | + +begin + #Deletes the EntitySet definition for the given EntitySet UUID. + api_instance.delete_entity_set(entity_set_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EntitySetsApi->delete_entity_set: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## get_all_entity_set_property_metadata + +> Hash<String, EntitySetPropertyMetaData> get_all_entity_set_property_metadata(entity_set_id) + +Get all entity set property metadata. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EntitySetsApi.new +entity_set_id = 'entity_set_id_example' # String | + +begin + #Get all entity set property metadata. + result = api_instance.get_all_entity_set_property_metadata(entity_set_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EntitySetsApi->get_all_entity_set_property_metadata: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + +### Return type + +[**Hash<String, EntitySetPropertyMetaData>**](EntitySetPropertyMetaData.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_all_entity_sets + +> Array<EntitySet> get_all_entity_sets + +Get all EntitySet definitions. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EntitySetsApi.new + +begin + #Get all EntitySet definitions. + result = api_instance.get_all_entity_sets + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EntitySetsApi->get_all_entity_sets: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Array<EntitySet>**](EntitySet.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_entity_set + +> EntitySet get_entity_set(entity_set_id) + +Get the EntitySet definition for the given EntitySet UUID. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EntitySetsApi.new +entity_set_id = 'entity_set_id_example' # String | + +begin + #Get the EntitySet definition for the given EntitySet UUID. + result = api_instance.get_entity_set(entity_set_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EntitySetsApi->get_entity_set: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + +### Return type + +[**EntitySet**](EntitySet.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_entity_set_id + +> String get_entity_set_id(entity_set_name) + +Gets the EntitySet UUID for the given EntitySet name. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EntitySetsApi.new +entity_set_name = 'entity_set_name_example' # String | + +begin + #Gets the EntitySet UUID for the given EntitySet name. + result = api_instance.get_entity_set_id(entity_set_name) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EntitySetsApi->get_entity_set_id: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_name** | **String**| | + +### Return type + +**String** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_entity_set_ids + +> Hash<String, String> get_entity_set_ids(opts) + +Get IDs for entity sets given their names. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EntitySetsApi.new +opts = { + request_body: ['request_body_example'] # Array | +} + +begin + #Get IDs for entity sets given their names. + result = api_instance.get_entity_set_ids(opts) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EntitySetsApi->get_entity_set_ids: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **request_body** | [**Array<String>**](String.md)| | [optional] + +### Return type + +**Hash<String, String>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## get_entity_set_property_metadata + +> EntitySetPropertyMetaData get_entity_set_property_metadata(entity_set_id, property_type_id) + +Get specified property type metadata for an entity set. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EntitySetsApi.new +entity_set_id = 'entity_set_id_example' # String | +property_type_id = 'property_type_id_example' # String | + +begin + #Get specified property type metadata for an entity set. + result = api_instance.get_entity_set_property_metadata(entity_set_id, property_type_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EntitySetsApi->get_entity_set_property_metadata: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **property_type_id** | [**String**](.md)| | + +### Return type + +[**EntitySetPropertyMetaData**](EntitySetPropertyMetaData.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_property_metadata_for_entity_sets + +> Hash<String, Hash<String, EntitySetPropertyMetaData>> get_property_metadata_for_entity_sets(opts) + +Get property metadata for entity sets. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EntitySetsApi.new +opts = { + request_body: ['request_body_example'] # Array | +} + +begin + #Get property metadata for entity sets. + result = api_instance.get_property_metadata_for_entity_sets(opts) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EntitySetsApi->get_property_metadata_for_entity_sets: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **request_body** | [**Array<String>**](String.md)| | [optional] + +### Return type + +**Hash<String, Hash<String, EntitySetPropertyMetaData>>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## get_property_types_for_entity_set + +> Hash<String, PropertyType> get_property_types_for_entity_set(entity_set_id) + +Get all Property Types for entity set + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EntitySetsApi.new +entity_set_id = 'entity_set_id_example' # String | + +begin + #Get all Property Types for entity set + result = api_instance.get_property_types_for_entity_set(entity_set_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EntitySetsApi->get_property_types_for_entity_set: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + +### Return type + +[**Hash<String, PropertyType>**](PropertyType.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## remove_entity_sets_from_linking_entity_set + +> Integer remove_entity_sets_from_linking_entity_set(linking_entity_set_id, opts) + +Removes/unlinks the linked entity sets from the linking entity set + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EntitySetsApi.new +linking_entity_set_id = 'linking_entity_set_id_example' # String | +opts = { + request_body: ['request_body_example'] # Array | +} + +begin + #Removes/unlinks the linked entity sets from the linking entity set + result = api_instance.remove_entity_sets_from_linking_entity_set(linking_entity_set_id, opts) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EntitySetsApi->remove_entity_sets_from_linking_entity_set: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **linking_entity_set_id** | **String**| | + **request_body** | [**Array<String>**](String.md)| | [optional] + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## remove_entity_sets_from_linking_entity_sets + +> Integer remove_entity_sets_from_linking_entity_sets(linking_entity_set_id, request_body) + +Removes/unlinks the linked entity sets from the linking entity set + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EntitySetsApi.new +linking_entity_set_id = 'linking_entity_set_id_example' # String | +request_body = nil # Hash> | + +begin + #Removes/unlinks the linked entity sets from the linking entity set + result = api_instance.remove_entity_sets_from_linking_entity_sets(linking_entity_set_id, request_body) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EntitySetsApi->remove_entity_sets_from_linking_entity_sets: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **linking_entity_set_id** | [**String**](.md)| | + **request_body** | [**Hash<String, Array<String>>**](Array.md)| | + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## update_entity_set_meta_data + +> Integer update_entity_set_meta_data(entity_set_id, metadata_update) + +Updates the EntitySet definition for the given EntitySet UUID with the given metadata. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EntitySetsApi.new +entity_set_id = 'entity_set_id_example' # String | +metadata_update = OpenapiClient::MetadataUpdate.new # MetadataUpdate | + +begin + #Updates the EntitySet definition for the given EntitySet UUID with the given metadata. + result = api_instance.update_entity_set_meta_data(entity_set_id, metadata_update) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling EntitySetsApi->update_entity_set_meta_data: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **metadata_update** | [**MetadataUpdate**](MetadataUpdate.md)| | + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## update_entity_set_property_metadata + +> update_entity_set_property_metadata(entity_set_id, property_type_id, metadata_update) + +Updates the property type metadata for the given entity set. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::EntitySetsApi.new +entity_set_id = 'entity_set_id_example' # String | +property_type_id = 'property_type_id_example' # String | +metadata_update = OpenapiClient::MetadataUpdate.new # MetadataUpdate | + +begin + #Updates the property type metadata for the given entity set. + api_instance.update_entity_set_property_metadata(entity_set_id, property_type_id, metadata_update) +rescue OpenapiClient::ApiError => e + puts "Exception when calling EntitySetsApi->update_entity_set_property_metadata: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **property_type_id** | [**String**](.md)| | + **metadata_update** | [**MetadataUpdate**](MetadataUpdate.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + diff --git a/ruby/docs/EntityType.md b/ruby/docs/EntityType.md new file mode 100644 index 0000000..70152db --- /dev/null +++ b/ruby/docs/EntityType.md @@ -0,0 +1,35 @@ +# OpenapiClient::EntityType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**title** | **String** | | [optional] +**description** | **String** | | [optional] +**id** | **String** | | [optional] +**type** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**schemas** | [**Array<FullQualifiedName>**](FullQualifiedName.md) | | [optional] +**key** | **Array<String>** | | [optional] +**properties** | **Array<String>** | | [optional] +**property_tags** | **Hash<String, Array<String>>** | | [optional] +**basetype** | **String** | | [optional] +**category** | **String** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::EntityType.new(title: null, + description: null, + id: null, + type: null, + schemas: null, + key: null, + properties: null, + property_tags: null, + basetype: null, + category: null) +``` + + diff --git a/ruby/docs/EntityTypeCollection.md b/ruby/docs/EntityTypeCollection.md new file mode 100644 index 0000000..5761eb1 --- /dev/null +++ b/ruby/docs/EntityTypeCollection.md @@ -0,0 +1,27 @@ +# OpenapiClient::EntityTypeCollection + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | An optional UUID for the entity type collection. | [optional] +**type** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**title** | **String** | The friendly name for the entity type collection. | [optional] +**description** | **String** | A description of the entity type collection. | [optional] +**schemas** | [**Array<FullQualifiedName>**](FullQualifiedName.md) | A list of schemas the entity type collection should belong to. | [optional] +**template** | [**Array<CollectionTemplateType>**](CollectionTemplateType.md) | A set of CollectionTemplateType objects, which describe the entity types involved in the entity type collection and the purposes they serve | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::EntityTypeCollection.new(id: null, + type: null, + title: null, + description: null, + schemas: null, + template: null) +``` + + diff --git a/ruby/docs/EntityTypePropertyMetadata.md b/ruby/docs/EntityTypePropertyMetadata.md new file mode 100644 index 0000000..597a6e6 --- /dev/null +++ b/ruby/docs/EntityTypePropertyMetadata.md @@ -0,0 +1,19 @@ +# OpenapiClient::EntityTypePropertyMetadata + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**title** | **String** | | [optional] +**description** | **String** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::EntityTypePropertyMetadata.new(title: null, + description: null) +``` + + diff --git a/ruby/docs/Flight.md b/ruby/docs/Flight.md new file mode 100644 index 0000000..baf1cdb --- /dev/null +++ b/ruby/docs/Flight.md @@ -0,0 +1,25 @@ +# OpenapiClient::Flight + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | | [optional] +**tags** | **Array<String>** | | [optional] +**organization_id** | **String** | | [optional] +**entity_definitions** | [**Hash<String, EntityDefinition>**](EntityDefinition.md) | | [optional] +**association_definitions** | [**Hash<String, AssociationDefinition>**](AssociationDefinition.md) | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::Flight.new(name: null, + tags: null, + organization_id: null, + entity_definitions: null, + association_definitions: null) +``` + + diff --git a/ruby/docs/FlightPlanParameters.md b/ruby/docs/FlightPlanParameters.md new file mode 100644 index 0000000..5eeff05 --- /dev/null +++ b/ruby/docs/FlightPlanParameters.md @@ -0,0 +1,25 @@ +# OpenapiClient::FlightPlanParameters + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sql** | **String** | the sql query to be used to pull cleaned data from postgres | [optional] +**src** | **Hash<String, String>** | postgres data source for pulling clean data | [optional] +**src_primary_key_columns** | **Array<String>** | the columns that are primary keys in the cleaned data | [optional] +**path** | **String** | the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) | [optional] +**flight** | [**Flight**](Flight.md) | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::FlightPlanParameters.new(sql: null, + src: null, + src_primary_key_columns: null, + path: null, + flight: null) +``` + + diff --git a/ruby/docs/FlightPlanParametersUpdate.md b/ruby/docs/FlightPlanParametersUpdate.md new file mode 100644 index 0000000..b753450 --- /dev/null +++ b/ruby/docs/FlightPlanParametersUpdate.md @@ -0,0 +1,23 @@ +# OpenapiClient::FlightPlanParametersUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**sql** | **String** | the sql query to be used to pull cleaned data from postgres | [optional] +**src** | **Hash<String, String>** | postgres data source for pulling clean data | [optional] +**src_primary_key_columns** | **Array<String>** | the columns that are primary keys in the cleaned data | [optional] +**path** | **String** | the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::FlightPlanParametersUpdate.new(sql: null, + src: null, + src_primary_key_columns: null, + path: null) +``` + + diff --git a/ruby/docs/FullQualifiedName.md b/ruby/docs/FullQualifiedName.md new file mode 100644 index 0000000..ea6cb83 --- /dev/null +++ b/ruby/docs/FullQualifiedName.md @@ -0,0 +1,19 @@ +# OpenapiClient::FullQualifiedName + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | | [optional] +**namespace** | **String** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::FullQualifiedName.new(name: null, + namespace: null) +``` + + diff --git a/ruby/docs/IndexingState.md b/ruby/docs/IndexingState.md new file mode 100644 index 0000000..31658e0 --- /dev/null +++ b/ruby/docs/IndexingState.md @@ -0,0 +1,25 @@ +# OpenapiClient::IndexingState + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**indexing** | **Hash<String, Array<String>>** | | [optional] +**queue** | **Array<String>** | | [optional] +**current_entity_set** | **String** | | [optional] +**queue_size** | **Integer** | | [optional] +**count** | **Integer** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::IndexingState.new(indexing: null, + queue: null, + current_entity_set: null, + queue_size: null, + count: null) +``` + + diff --git a/ruby/docs/InlineObject.md b/ruby/docs/InlineObject.md new file mode 100644 index 0000000..469a60e --- /dev/null +++ b/ruby/docs/InlineObject.md @@ -0,0 +1,17 @@ +# OpenapiClient::InlineObject + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**additional_properties** | [**Array<DataEdge>**](DataEdge.md) | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::InlineObject.new(additional_properties: null) +``` + + diff --git a/ruby/docs/InlineResponse200.md b/ruby/docs/InlineResponse200.md new file mode 100644 index 0000000..a9b4374 --- /dev/null +++ b/ruby/docs/InlineResponse200.md @@ -0,0 +1,19 @@ +# OpenapiClient::InlineResponse200 + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**user** | **String** | | [optional] +**credential** | **String** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::InlineResponse200.new(user: null, + credential: null) +``` + + diff --git a/ruby/docs/Integration.md b/ruby/docs/Integration.md new file mode 100644 index 0000000..55c6c78 --- /dev/null +++ b/ruby/docs/Integration.md @@ -0,0 +1,33 @@ +# OpenapiClient::Integration + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**key** | **String** | a unique ID used for authorizing a call to run an integration | [optional] +**environment** | **String** | the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) | [optional] +**s3_bucket** | **String** | the url of the s3bucket to be used | [optional] +**contacts** | **Array<String>** | the set of email addresses of those responsible for the integration | [optional] +**organization_id** | **String** | the id of the organization that owns the integration | [optional] +**entity_set_id** | **String** | the id of the entity set that stores the logs for this integration | [optional] +**max_connections** | **Integer** | maximum number of connections to postgres allowed for this integration | [optional] +**callback** | **Array<String>** | urls to receive a POST when integration has completed | [optional] +**flight_plan_parameters** | [**Hash<String, FlightPlanParameters>**](FlightPlanParameters.md) | a map from [Flight] name to [FlightPlanParameters] | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::Integration.new(key: null, + environment: null, + s3_bucket: null, + contacts: null, + organization_id: null, + entity_set_id: null, + max_connections: null, + callback: null, + flight_plan_parameters: null) +``` + + diff --git a/ruby/docs/IntegrationJob.md b/ruby/docs/IntegrationJob.md new file mode 100644 index 0000000..1a49334 --- /dev/null +++ b/ruby/docs/IntegrationJob.md @@ -0,0 +1,19 @@ +# OpenapiClient::IntegrationJob + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **String** | | [optional] +**status** | **String** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::IntegrationJob.new(name: null, + status: null) +``` + + diff --git a/ruby/docs/IntegrationResults.md b/ruby/docs/IntegrationResults.md new file mode 100644 index 0000000..40f797e --- /dev/null +++ b/ruby/docs/IntegrationResults.md @@ -0,0 +1,23 @@ +# OpenapiClient::IntegrationResults + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_count** | **Integer** | | [optional] +**association_count** | **Integer** | | [optional] +**associations_entity_key_mappings** | **Hash<String, Hash<String, String>>** | | [optional] +**entity_sets_entity_key_mappings** | **Hash<String, Hash<String, String>>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::IntegrationResults.new(entity_count: null, + association_count: null, + associations_entity_key_mappings: null, + entity_sets_entity_key_mappings: null) +``` + + diff --git a/ruby/docs/IntegrationUpdate.md b/ruby/docs/IntegrationUpdate.md new file mode 100644 index 0000000..de85780 --- /dev/null +++ b/ruby/docs/IntegrationUpdate.md @@ -0,0 +1,29 @@ +# OpenapiClient::IntegrationUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**environment** | **String** | the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) | [optional] +**s3_bucket** | **String** | the url of the s3bucket to be used | [optional] +**contacts** | **Array<String>** | the set of email addresses of those responsible for the integration | [optional] +**organization_id** | **String** | the id of the organization that owns the integration | [optional] +**max_connections** | **Integer** | maximum number of connections to postgres allowed for this integration | [optional] +**callback_urls** | **Array<String>** | urls to receive a POST when integration has completed | [optional] +**flight_plan_parameters** | [**Hash<String, FlightPlanParametersUpdate>**](FlightPlanParametersUpdate.md) | a map from [Flight] name to [FlightPlanParametersUpdate] | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::IntegrationUpdate.new(environment: null, + s3_bucket: null, + contacts: null, + organization_id: null, + max_connections: null, + callback_urls: null, + flight_plan_parameters: null) +``` + + diff --git a/ruby/docs/LinkingApi.md b/ruby/docs/LinkingApi.md new file mode 100644 index 0000000..fdee8d9 --- /dev/null +++ b/ruby/docs/LinkingApi.md @@ -0,0 +1,335 @@ +# OpenapiClient::LinkingApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_linking_feedback**](LinkingApi.md#add_linking_feedback) | **PUT** /linker/linkingfeedback | Submits feedbacks for a given linking entity set and linking id in a batch format. +[**delete_linking_feedback**](LinkingApi.md#delete_linking_feedback) | **DELETE** /linker/linkingfeedback | Deletes linking feedback +[**get_all_linking_feedback**](LinkingApi.md#get_all_linking_feedback) | **GET** /linker/linkingfeedback/all | Returns all feedback submitted +[**get_all_linking_feedback_with_features**](LinkingApi.md#get_all_linking_feedback_with_features) | **GET** /linker/linkingfeedback/features/all | Returns all feedback submitted walong with the features of pairwise entities +[**get_linking_feedback_with_features**](LinkingApi.md#get_linking_feedback_with_features) | **POST** /linker/linkingfeedback/features | Returns the feedback on the given entity pair along with their features +[**get_linking_feedbacks_on_entity**](LinkingApi.md#get_linking_feedbacks_on_entity) | **POST** /linker/linkingfeedback/entity | Returns positive/negative/all linking feedbacks on the given entity. + + + +## add_linking_feedback + +> Integer add_linking_feedback(linking_feedback) + +Submits feedbacks for a given linking entity set and linking id in a batch format. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::LinkingApi.new +linking_feedback = OpenapiClient::LinkingFeedback.new # LinkingFeedback | + +begin + #Submits feedbacks for a given linking entity set and linking id in a batch format. + result = api_instance.add_linking_feedback(linking_feedback) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling LinkingApi->add_linking_feedback: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **linking_feedback** | [**LinkingFeedback**](LinkingFeedback.md)| | + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## delete_linking_feedback + +> Integer delete_linking_feedback(entity_key_pair) + +Deletes linking feedback + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::LinkingApi.new +entity_key_pair = OpenapiClient::EntityKeyPair.new # EntityKeyPair | + +begin + #Deletes linking feedback + result = api_instance.delete_linking_feedback(entity_key_pair) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling LinkingApi->delete_linking_feedback: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_key_pair** | [**EntityKeyPair**](EntityKeyPair.md)| | + +### Return type + +**Integer** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## get_all_linking_feedback + +> Array<EntityLinkingFeedback> get_all_linking_feedback + +Returns all feedback submitted + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::LinkingApi.new + +begin + #Returns all feedback submitted + result = api_instance.get_all_linking_feedback + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling LinkingApi->get_all_linking_feedback: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Array<EntityLinkingFeedback>**](EntityLinkingFeedback.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_all_linking_feedback_with_features + +> Array<EntityLinkingFeatures> get_all_linking_feedback_with_features + +Returns all feedback submitted walong with the features of pairwise entities + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::LinkingApi.new + +begin + #Returns all feedback submitted walong with the features of pairwise entities + result = api_instance.get_all_linking_feedback_with_features + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling LinkingApi->get_all_linking_feedback_with_features: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Array<EntityLinkingFeatures>**](EntityLinkingFeatures.md) + +### Authorization + +[openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_linking_feedback_with_features + +> EntityLinkingFeatures get_linking_feedback_with_features(entity_key_pair) + +Returns the feedback on the given entity pair along with their features + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::LinkingApi.new +entity_key_pair = OpenapiClient::EntityKeyPair.new # EntityKeyPair | + +begin + #Returns the feedback on the given entity pair along with their features + result = api_instance.get_linking_feedback_with_features(entity_key_pair) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling LinkingApi->get_linking_feedback_with_features: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_key_pair** | [**EntityKeyPair**](EntityKeyPair.md)| | + +### Return type + +[**EntityLinkingFeatures**](EntityLinkingFeatures.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## get_linking_feedbacks_on_entity + +> Array<EntityLinkingFeedback> get_linking_feedbacks_on_entity(feedback_type, entity_data_key) + +Returns positive/negative/all linking feedbacks on the given entity. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::LinkingApi.new +feedback_type = 'feedback_type_example' # String | +entity_data_key = OpenapiClient::EntityDataKey.new # EntityDataKey | + +begin + #Returns positive/negative/all linking feedbacks on the given entity. + result = api_instance.get_linking_feedbacks_on_entity(feedback_type, entity_data_key) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling LinkingApi->get_linking_feedbacks_on_entity: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **feedback_type** | **String**| | + **entity_data_key** | [**EntityDataKey**](EntityDataKey.md)| | + +### Return type + +[**Array<EntityLinkingFeedback>**](EntityLinkingFeedback.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + diff --git a/ruby/docs/LinkingFeedback.md b/ruby/docs/LinkingFeedback.md new file mode 100644 index 0000000..0571e3b --- /dev/null +++ b/ruby/docs/LinkingFeedback.md @@ -0,0 +1,21 @@ +# OpenapiClient::LinkingFeedback + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**linking_entity** | [**EntityDataKey**](EntityDataKey.md) | | [optional] +**link** | [**Array<EntityDataKey>**](EntityDataKey.md) | | [optional] +**unlink** | [**Array<EntityDataKey>**](EntityDataKey.md) | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::LinkingFeedback.new(linking_entity: null, + link: null, + unlink: null) +``` + + diff --git a/ruby/docs/MaterializedViewAccount.md b/ruby/docs/MaterializedViewAccount.md new file mode 100644 index 0000000..0b54b7d --- /dev/null +++ b/ruby/docs/MaterializedViewAccount.md @@ -0,0 +1,19 @@ +# OpenapiClient::MaterializedViewAccount + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**username** | **String** | | [optional] +**credential** | **String** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::MaterializedViewAccount.new(username: null, + credential: null) +``` + + diff --git a/ruby/docs/MetadataUpdate.md b/ruby/docs/MetadataUpdate.md new file mode 100644 index 0000000..319679b --- /dev/null +++ b/ruby/docs/MetadataUpdate.md @@ -0,0 +1,41 @@ +# OpenapiClient::MetadataUpdate + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**title** | **String** | | [optional] +**description** | **String** | | [optional] +**name** | **String** | | [optional] +**contacts** | **Array<String>** | | [optional] +**type** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**pii** | **Boolean** | | [optional] +**default_show** | **Boolean** | | [optional] +**url** | **String** | | [optional] +**property_tags** | **Hash<String, Array<String>>** | | [optional] +**index_type** | **String** | | [optional] +**organization_id** | **String** | | [optional] +**partitions** | **Array<Integer>** | | [optional] +**enum_values** | **Array<String>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::MetadataUpdate.new(title: null, + description: null, + name: null, + contacts: null, + type: null, + pii: null, + default_show: null, + url: null, + property_tags: null, + index_type: null, + organization_id: null, + partitions: null, + enum_values: null) +``` + + diff --git a/ruby/docs/NeighborEntityDetails.md b/ruby/docs/NeighborEntityDetails.md new file mode 100644 index 0000000..501baac --- /dev/null +++ b/ruby/docs/NeighborEntityDetails.md @@ -0,0 +1,25 @@ +# OpenapiClient::NeighborEntityDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**association_entity_set** | [**EntitySet**](EntitySet.md) | | [optional] +**association_details** | **Hash<String, Array<String>>** | | [optional] +**neighbor_entity_set** | [**EntitySet**](EntitySet.md) | | [optional] +**neighbor_id** | **String** | | [optional] +**neighbor_details** | **Hash<String, Array<String>>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::NeighborEntityDetails.new(association_entity_set: null, + association_details: null, + neighbor_entity_set: null, + neighbor_id: null, + neighbor_details: null) +``` + + diff --git a/ruby/docs/NeighborEntityIds.md b/ruby/docs/NeighborEntityIds.md new file mode 100644 index 0000000..9008ed9 --- /dev/null +++ b/ruby/docs/NeighborEntityIds.md @@ -0,0 +1,21 @@ +# OpenapiClient::NeighborEntityIds + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**association_id** | **String** | | [optional] +**neighbor_id** | **String** | | [optional] +**src** | **Boolean** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::NeighborEntityIds.new(association_id: null, + neighbor_id: null, + src: null) +``` + + diff --git a/ruby/docs/NeighborSearchFilter.md b/ruby/docs/NeighborSearchFilter.md new file mode 100644 index 0000000..410430e --- /dev/null +++ b/ruby/docs/NeighborSearchFilter.md @@ -0,0 +1,23 @@ +# OpenapiClient::NeighborSearchFilter + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_key_ids** | **Array<String>** | | [optional] +**src** | **Array<String>** | | [optional] +**dst** | **Array<String>** | | [optional] +**edge** | **Array<String>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::NeighborSearchFilter.new(entity_key_ids: null, + src: null, + dst: null, + edge: null) +``` + + diff --git a/ruby/docs/Organization.md b/ruby/docs/Organization.md new file mode 100644 index 0000000..e61eb9e --- /dev/null +++ b/ruby/docs/Organization.md @@ -0,0 +1,35 @@ +# OpenapiClient::Organization + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**principal** | [**Principal**](Principal.md) | | [optional] +**title** | **String** | | [optional] +**description** | **String** | | [optional] +**emails** | **Array<String>** | | [optional] +**members** | [**Array<Principal>**](Principal.md) | | [optional] +**roles** | [**Array<Role>**](Role.md) | | [optional] +**apps** | **Array<String>** | | [optional] +**sms_entity_set_info** | [**Array<SmsEntitySetInformation>**](SmsEntitySetInformation.md) | | [optional] +**partitions** | **Array<Integer>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::Organization.new(id: null, + principal: null, + title: null, + description: null, + emails: null, + members: null, + roles: null, + apps: null, + sms_entity_set_info: null, + partitions: null) +``` + + diff --git a/ruby/docs/OrganizationExternalDatabaseColumn.md b/ruby/docs/OrganizationExternalDatabaseColumn.md new file mode 100644 index 0000000..0cff74d --- /dev/null +++ b/ruby/docs/OrganizationExternalDatabaseColumn.md @@ -0,0 +1,33 @@ +# OpenapiClient::OrganizationExternalDatabaseColumn + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**name** | **String** | | [optional] +**title** | **String** | | [optional] +**description** | **String** | | [optional] +**table_id** | **String** | | [optional] +**organization_id** | **String** | | [optional] +**data_type** | **String** | | [optional] +**primary_key** | **Boolean** | | [optional] +**ordinal_position** | **Integer** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::OrganizationExternalDatabaseColumn.new(id: null, + name: null, + title: null, + description: null, + table_id: null, + organization_id: null, + data_type: null, + primary_key: null, + ordinal_position: null) +``` + + diff --git a/ruby/docs/OrganizationExternalDatabaseTable.md b/ruby/docs/OrganizationExternalDatabaseTable.md new file mode 100644 index 0000000..fb6f440 --- /dev/null +++ b/ruby/docs/OrganizationExternalDatabaseTable.md @@ -0,0 +1,25 @@ +# OpenapiClient::OrganizationExternalDatabaseTable + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**name** | **String** | | [optional] +**title** | **String** | | [optional] +**description** | **String** | | [optional] +**organization_id** | **String** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::OrganizationExternalDatabaseTable.new(id: null, + name: null, + title: null, + description: null, + organization_id: null) +``` + + diff --git a/ruby/docs/OrganizationExternalDatabaseTableColumnsPair.md b/ruby/docs/OrganizationExternalDatabaseTableColumnsPair.md new file mode 100644 index 0000000..74c0d80 --- /dev/null +++ b/ruby/docs/OrganizationExternalDatabaseTableColumnsPair.md @@ -0,0 +1,19 @@ +# OpenapiClient::OrganizationExternalDatabaseTableColumnsPair + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**table** | [**OrganizationExternalDatabaseTable**](OrganizationExternalDatabaseTable.md) | | [optional] +**columns** | [**Array<OrganizationExternalDatabaseColumn>**](OrganizationExternalDatabaseColumn.md) | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::OrganizationExternalDatabaseTableColumnsPair.new(table: null, + columns: null) +``` + + diff --git a/ruby/docs/OrganizationMember.md b/ruby/docs/OrganizationMember.md new file mode 100644 index 0000000..5b8c8c8 --- /dev/null +++ b/ruby/docs/OrganizationMember.md @@ -0,0 +1,21 @@ +# OpenapiClient::OrganizationMember + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**principal** | [**SecurablePrincipal**](SecurablePrincipal.md) | | [optional] +**profile** | [**Auth0userBasic**](Auth0userBasic.md) | | [optional] +**roles** | [**Array<SecurablePrincipal>**](SecurablePrincipal.md) | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::OrganizationMember.new(principal: null, + profile: null, + roles: null) +``` + + diff --git a/ruby/docs/OrganizationsApi.md b/ruby/docs/OrganizationsApi.md new file mode 100644 index 0000000..c319e74 --- /dev/null +++ b/ruby/docs/OrganizationsApi.md @@ -0,0 +1,1544 @@ +# OpenapiClient::OrganizationsApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**add_member**](OrganizationsApi.md#add_member) | **PUT** /datastore/organizations/{organizationId}/principals/members/{userId} | Add member to an organization +[**add_role_to_user**](OrganizationsApi.md#add_role_to_user) | **PUT** /datastore/organizations/{organizationId}/principals/roles/{roleId}/members/{userId} | Add a role to a user +[**assemble_entity_sets**](OrganizationsApi.md#assemble_entity_sets) | **POST** /datastore/organizations/{organizationId}/entity-sets/assemble | Materializes entity sets into the organization database. +[**create_organization_if_not_exists**](OrganizationsApi.md#create_organization_if_not_exists) | **POST** /datastore/organizations | Creates an organization if it doesn't exist. +[**create_role**](OrganizationsApi.md#create_role) | **POST** /datastore/organizations/roles | Creates role +[**delete_role**](OrganizationsApi.md#delete_role) | **DELETE** /datastore/organizations/{organizationId}/principals/roles/{roleId} | Remove role for an organization +[**destroy_organization**](OrganizationsApi.md#destroy_organization) | **DELETE** /datastore/organizations/{organizationId} | Remove an organization from the organizationId +[**get_all_users_of_role**](OrganizationsApi.md#get_all_users_of_role) | **GET** /datastore/organizations/{organizationId}/principals/roles/{roleId}/members/ | Get members of a role for an organization from a roleId +[**get_auto_approved_email_domains**](OrganizationsApi.md#get_auto_approved_email_domains) | **GET** /datastore/organizations/{organizationId}/email-domains | Get auto-approved email domains +[**get_flagged_organization_entity_sets**](OrganizationsApi.md#get_flagged_organization_entity_sets) | **POST** /datastore/organizations/{organizationId}/entity-sets | Get the entity sets for an organization for a certain flag +[**get_members**](OrganizationsApi.md#get_members) | **GET** /datastore/organizations/{organizationId}/principals/members | Get members of a certain organization +[**get_organization**](OrganizationsApi.md#get_organization) | **GET** /datastore/organizations/{organizationId} | Get an organization from the organizationId +[**get_organization_entity_sets**](OrganizationsApi.md#get_organization_entity_sets) | **GET** /datastore/organizations/{organizationId}/entity-sets | Get the entity sets for an organization for a certain filter +[**get_organization_integration_account**](OrganizationsApi.md#get_organization_integration_account) | **GET** /datastore/organizations/{organizationId}/integration | Get the integrations account for an organization from the organizationId +[**get_organizations**](OrganizationsApi.md#get_organizations) | **GET** /datastore/organizations | Get all organizations +[**get_role**](OrganizationsApi.md#get_role) | **GET** /datastore/organizations/{organizationId}/principals/roles/{roleId} | Get role for an organization from a roleId +[**get_roles**](OrganizationsApi.md#get_roles) | **GET** /datastore/organizations/{organizationId}/principals/roles | Get roles for an organization +[**refresh_data_changes**](OrganizationsApi.md#refresh_data_changes) | **POST** /datastore/organizations/{organizationId}/{entitySetId}/refresh | Refreshes the requested materialized entity set with data changes in the organization. +[**remove_auto_approved_email_domains**](OrganizationsApi.md#remove_auto_approved_email_domains) | **DELETE** /datastore/organizations/{organizationId}/email-domains | Remove auto-approved email domains +[**remove_member**](OrganizationsApi.md#remove_member) | **DELETE** /datastore/organizations/{organizationId}/principals/members/{userId} | Remove member from an organization +[**remove_role_from_user**](OrganizationsApi.md#remove_role_from_user) | **DELETE** /datastore/organizations/{organizationId}/principals/roles/{roleId}/members/{userId} | Remove a role from a user +[**set_auto_approved_email_domain**](OrganizationsApi.md#set_auto_approved_email_domain) | **PUT** /datastore/organizations/{organizationId}/email-domains | Set auto-approved email domains +[**synchronize_edm_changes**](OrganizationsApi.md#synchronize_edm_changes) | **POST** /datastore/organizations/{organizationId}/{entitySetId}/synchronize | Synchronizes EDM changes to the requested materialized entity set in the organization. +[**update_description**](OrganizationsApi.md#update_description) | **PUT** /datastore/organizations/{organizationId}/description | Update the organization description +[**update_role_description**](OrganizationsApi.md#update_role_description) | **POST** /datastore/organizations/{organizationId}/principals/roles/{roleId}/description | Update role description for an organization from a roleId +[**update_role_title**](OrganizationsApi.md#update_role_title) | **PUT** /datastore/organizations/{organizationId}/principals/roles/{roleId}/title | Update role title for an organization from a roleId +[**update_title**](OrganizationsApi.md#update_title) | **PUT** /datastore/organizations/{organizationId}/title | Update the organization title + + + +## add_member + +> add_member(organization_id, user_id) + +Add member to an organization + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | +user_id = 'user_id_example' # String | + +begin + #Add member to an organization + api_instance.add_member(organization_id, user_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->add_member: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **user_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## add_role_to_user + +> add_role_to_user(organization_id, role_id, user_id) + +Add a role to a user + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | +role_id = 'role_id_example' # String | +user_id = 'user_id_example' # String | + +begin + #Add a role to a user + api_instance.add_role_to_user(organization_id, role_id, user_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->add_role_to_user: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **role_id** | [**String**](.md)| | + **user_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## assemble_entity_sets + +> Hash<String, Array<String>> assemble_entity_sets(organization_id, request_body) + +Materializes entity sets into the organization database. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | +request_body = {'key' => 56} # Hash | + +begin + #Materializes entity sets into the organization database. + result = api_instance.assemble_entity_sets(organization_id, request_body) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->assemble_entity_sets: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **request_body** | [**Hash<String, Integer>**](Integer.md)| | + +### Return type + +**Hash<String, Array<String>>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## create_organization_if_not_exists + +> String create_organization_if_not_exists(organization) + +Creates an organization if it doesn't exist. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization = OpenapiClient::Organization.new # Organization | + +begin + #Creates an organization if it doesn't exist. + result = api_instance.create_organization_if_not_exists(organization) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->create_organization_if_not_exists: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization** | [**Organization**](Organization.md)| | + +### Return type + +**String** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## create_role + +> String create_role(role) + +Creates role + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +role = OpenapiClient::Role.new # Role | + +begin + #Creates role + result = api_instance.create_role(role) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->create_role: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **role** | [**Role**](Role.md)| | + +### Return type + +**String** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## delete_role + +> delete_role(organization_id, role_id) + +Remove role for an organization + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | +role_id = 'role_id_example' # String | + +begin + #Remove role for an organization + api_instance.delete_role(organization_id, role_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->delete_role: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **role_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## destroy_organization + +> destroy_organization(organization_id) + +Remove an organization from the organizationId + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | + +begin + #Remove an organization from the organizationId + api_instance.destroy_organization(organization_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->destroy_organization: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## get_all_users_of_role + +> Array<Auth0userBasic> get_all_users_of_role(organization_id, role_id) + +Get members of a role for an organization from a roleId + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | +role_id = 'role_id_example' # String | + +begin + #Get members of a role for an organization from a roleId + result = api_instance.get_all_users_of_role(organization_id, role_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->get_all_users_of_role: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **role_id** | [**String**](.md)| | + +### Return type + +[**Array<Auth0userBasic>**](Auth0userBasic.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_auto_approved_email_domains + +> Array<String> get_auto_approved_email_domains(organization_id) + +Get auto-approved email domains + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | + +begin + #Get auto-approved email domains + result = api_instance.get_auto_approved_email_domains(organization_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->get_auto_approved_email_domains: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + +### Return type + +**Array<String>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_flagged_organization_entity_sets + +> Array<Hash<String, Array<String>>> get_flagged_organization_entity_sets(organization_id, request_body) + +Get the entity sets for an organization for a certain flag + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | +request_body = nil # Hash> | + +begin + #Get the entity sets for an organization for a certain flag + result = api_instance.get_flagged_organization_entity_sets(organization_id, request_body) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->get_flagged_organization_entity_sets: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **request_body** | [**Hash<String, Array<String>>**](Array.md)| | + +### Return type + +**Array<Hash<String, Array<String>>>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## get_members + +> Array<OrganizationMember> get_members(organization_id) + +Get members of a certain organization + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | + +begin + #Get members of a certain organization + result = api_instance.get_members(organization_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->get_members: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + +### Return type + +[**Array<OrganizationMember>**](OrganizationMember.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_organization + +> Organization get_organization(organization_id) + +Get an organization from the organizationId + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | + +begin + #Get an organization from the organizationId + result = api_instance.get_organization(organization_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->get_organization: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + +### Return type + +[**Organization**](Organization.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_organization_entity_sets + +> Hash<String, Array<String>> get_organization_entity_sets(organization_id) + +Get the entity sets for an organization for a certain filter + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | + +begin + #Get the entity sets for an organization for a certain filter + result = api_instance.get_organization_entity_sets(organization_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->get_organization_entity_sets: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + +### Return type + +**Hash<String, Array<String>>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_organization_integration_account + +> InlineResponse200 get_organization_integration_account(organization_id) + +Get the integrations account for an organization from the organizationId + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | + +begin + #Get the integrations account for an organization from the organizationId + result = api_instance.get_organization_integration_account(organization_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->get_organization_integration_account: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + +### Return type + +[**InlineResponse200**](InlineResponse200.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_organizations + +> Array<Organization> get_organizations + +Get all organizations + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new + +begin + #Get all organizations + result = api_instance.get_organizations + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->get_organizations: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Array<Organization>**](Organization.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_role + +> Role get_role(organization_id, role_id) + +Get role for an organization from a roleId + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | +role_id = 'role_id_example' # String | + +begin + #Get role for an organization from a roleId + result = api_instance.get_role(organization_id, role_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->get_role: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **role_id** | [**String**](.md)| | + +### Return type + +[**Role**](Role.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_roles + +> Array<Role> get_roles(organization_id) + +Get roles for an organization + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | + +begin + #Get roles for an organization + result = api_instance.get_roles(organization_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->get_roles: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + +### Return type + +[**Array<Role>**](Role.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## refresh_data_changes + +> refresh_data_changes(organization_id, entity_set_id) + +Refreshes the requested materialized entity set with data changes in the organization. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | +entity_set_id = 'entity_set_id_example' # String | + +begin + #Refreshes the requested materialized entity set with data changes in the organization. + api_instance.refresh_data_changes(organization_id, entity_set_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->refresh_data_changes: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **entity_set_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## remove_auto_approved_email_domains + +> remove_auto_approved_email_domains(organization_id, request_body) + +Remove auto-approved email domains + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | +request_body = ['request_body_example'] # Array | + +begin + #Remove auto-approved email domains + api_instance.remove_auto_approved_email_domains(organization_id, request_body) +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->remove_auto_approved_email_domains: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **request_body** | [**Array<String>**](String.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## remove_member + +> remove_member(organization_id, user_id) + +Remove member from an organization + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | +user_id = 'user_id_example' # String | + +begin + #Remove member from an organization + api_instance.remove_member(organization_id, user_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->remove_member: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **user_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## remove_role_from_user + +> remove_role_from_user(organization_id, role_id, user_id) + +Remove a role from a user + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | +role_id = 'role_id_example' # String | +user_id = 'user_id_example' # String | + +begin + #Remove a role from a user + api_instance.remove_role_from_user(organization_id, role_id, user_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->remove_role_from_user: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **role_id** | [**String**](.md)| | + **user_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## set_auto_approved_email_domain + +> set_auto_approved_email_domain(organization_id, request_body) + +Set auto-approved email domains + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | +request_body = ['request_body_example'] # Array | + +begin + #Set auto-approved email domains + api_instance.set_auto_approved_email_domain(organization_id, request_body) +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->set_auto_approved_email_domain: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **request_body** | [**Array<String>**](String.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## synchronize_edm_changes + +> synchronize_edm_changes(organization_id, entity_set_id) + +Synchronizes EDM changes to the requested materialized entity set in the organization. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | +entity_set_id = 'entity_set_id_example' # String | + +begin + #Synchronizes EDM changes to the requested materialized entity set in the organization. + api_instance.synchronize_edm_changes(organization_id, entity_set_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->synchronize_edm_changes: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **entity_set_id** | [**String**](.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## update_description + +> update_description(organization_id, body) + +Update the organization description + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | +body = 'body_example' # String | + +begin + #Update the organization description + api_instance.update_description(organization_id, body) +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->update_description: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **body** | **String**| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + + +## update_role_description + +> update_role_description(organization_id, role_id, body) + +Update role description for an organization from a roleId + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | +role_id = 'role_id_example' # String | +body = 'body_example' # String | + +begin + #Update role description for an organization from a roleId + api_instance.update_role_description(organization_id, role_id, body) +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->update_role_description: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **role_id** | [**String**](.md)| | + **body** | **String**| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: text/plain +- **Accept**: Not defined + + +## update_role_title + +> update_role_title(organization_id, role_id, body) + +Update role title for an organization from a roleId + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | +role_id = 'role_id_example' # String | +body = 'body_example' # String | + +begin + #Update role title for an organization from a roleId + api_instance.update_role_title(organization_id, role_id, body) +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->update_role_title: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **role_id** | [**String**](.md)| | + **body** | **String**| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: text/plain +- **Accept**: Not defined + + +## update_title + +> update_title(organization_id, body) + +Update the organization title + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::OrganizationsApi.new +organization_id = 'organization_id_example' # String | +body = 'body_example' # String | + +begin + #Update the organization title + api_instance.update_title(organization_id, body) +rescue OpenapiClient::ApiError => e + puts "Exception when calling OrganizationsApi->update_title: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **organization_id** | [**String**](.md)| | + **body** | **String**| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + diff --git a/ruby/docs/PermissionsApi.md b/ruby/docs/PermissionsApi.md new file mode 100644 index 0000000..97b163f --- /dev/null +++ b/ruby/docs/PermissionsApi.md @@ -0,0 +1,119 @@ +# OpenapiClient::PermissionsApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_acl**](PermissionsApi.md#get_acl) | **POST** /datastore/permissions | Get the ACL for the given ACL Key, only if the user is the owner of the ACL Key. +[**update_acl**](PermissionsApi.md#update_acl) | **PATCH** /datastore/permissions | Updates the ACL for a particular ACL Key, only if the user is the owner of the ACL Key. + + + +## get_acl + +> Acl get_acl(request_body) + +Get the ACL for the given ACL Key, only if the user is the owner of the ACL Key. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::PermissionsApi.new +request_body = ['request_body_example'] # Array | + +begin + #Get the ACL for the given ACL Key, only if the user is the owner of the ACL Key. + result = api_instance.get_acl(request_body) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling PermissionsApi->get_acl: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **request_body** | [**Array<String>**](String.md)| | + +### Return type + +[**Acl**](Acl.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## update_acl + +> update_acl(acl_data) + +Updates the ACL for a particular ACL Key, only if the user is the owner of the ACL Key. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::PermissionsApi.new +acl_data = OpenapiClient::AclData.new # AclData | + +begin + #Updates the ACL for a particular ACL Key, only if the user is the owner of the ACL Key. + api_instance.update_acl(acl_data) +rescue OpenapiClient::ApiError => e + puts "Exception when calling PermissionsApi->update_acl: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **acl_data** | [**AclData**](AclData.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + diff --git a/ruby/docs/Principal.md b/ruby/docs/Principal.md new file mode 100644 index 0000000..35921d5 --- /dev/null +++ b/ruby/docs/Principal.md @@ -0,0 +1,19 @@ +# OpenapiClient::Principal + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **String** | | [optional] +**id** | **String** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::Principal.new(type: null, + id: null) +``` + + diff --git a/ruby/docs/PrincipalApi.md b/ruby/docs/PrincipalApi.md new file mode 100644 index 0000000..ae47877 --- /dev/null +++ b/ruby/docs/PrincipalApi.md @@ -0,0 +1,383 @@ +# OpenapiClient::PrincipalApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**get_all_users**](PrincipalApi.md#get_all_users) | **GET** /datastore/principals/users/ | Get all users. +[**get_current_roles**](PrincipalApi.md#get_current_roles) | **GET** /datastore/principals/roles/current/ | Get current roles. +[**get_materialized_view_account**](PrincipalApi.md#get_materialized_view_account) | **GET** /datastore/principals/db | Get the db access credentials. +[**get_user**](PrincipalApi.md#get_user) | **GET** /datastore/principals/users/{userId} | Get the user for the given id. +[**search_all_users**](PrincipalApi.md#search_all_users) | **GET** /datastore/principals/users/search/"{searchQuery}" | Get the user id for the given search. +[**search_all_users_by_email**](PrincipalApi.md#search_all_users_by_email) | **GET** /datastore/principals/users/search/email/"{emailAddress}" | Get the user id for the given email address. +[**sync_calling_user**](PrincipalApi.md#sync_calling_user) | **GET** /datastore/principals/sync/ | Activates a user in the OpenLattice system. This call must be made once before a user will be available for use in authorization policies. + + + +## get_all_users + +> Hash<String, Auth0userBasic> get_all_users + +Get all users. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::PrincipalApi.new + +begin + #Get all users. + result = api_instance.get_all_users + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling PrincipalApi->get_all_users: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Hash<String, Auth0userBasic>**](Auth0userBasic.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_current_roles + +> Array<SecurablePrincipal> get_current_roles + +Get current roles. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::PrincipalApi.new + +begin + #Get current roles. + result = api_instance.get_current_roles + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling PrincipalApi->get_current_roles: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Array<SecurablePrincipal>**](SecurablePrincipal.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_materialized_view_account + +> MaterializedViewAccount get_materialized_view_account + +Get the db access credentials. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::PrincipalApi.new + +begin + #Get the db access credentials. + result = api_instance.get_materialized_view_account + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling PrincipalApi->get_materialized_view_account: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**MaterializedViewAccount**](MaterializedViewAccount.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_user + +> Auth0userBasic get_user(user_id) + +Get the user for the given id. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::PrincipalApi.new +user_id = 'user_id_example' # String | + +begin + #Get the user for the given id. + result = api_instance.get_user(user_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling PrincipalApi->get_user: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user_id** | **String**| | + +### Return type + +[**Auth0userBasic**](Auth0userBasic.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## search_all_users + +> Hash<String, Auth0userBasic> search_all_users(search_query) + +Get the user id for the given search. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::PrincipalApi.new +search_query = 'search_query_example' # String | + +begin + #Get the user id for the given search. + result = api_instance.search_all_users(search_query) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling PrincipalApi->search_all_users: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_query** | **String**| | + +### Return type + +[**Hash<String, Auth0userBasic>**](Auth0userBasic.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## search_all_users_by_email + +> Hash<String, Auth0userBasic> search_all_users_by_email(email_address) + +Get the user id for the given email address. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::PrincipalApi.new +email_address = 'email_address_example' # String | + +begin + #Get the user id for the given email address. + result = api_instance.search_all_users_by_email(email_address) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling PrincipalApi->search_all_users_by_email: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **email_address** | **String**| | + +### Return type + +[**Hash<String, Auth0userBasic>**](Auth0userBasic.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## sync_calling_user + +> sync_calling_user + +Activates a user in the OpenLattice system. This call must be made once before a user will be available for use in authorization policies. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::PrincipalApi.new + +begin + #Activates a user in the OpenLattice system. This call must be made once before a user will be available for use in authorization policies. + api_instance.sync_calling_user +rescue OpenapiClient::ApiError => e + puts "Exception when calling PrincipalApi->sync_calling_user: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + diff --git a/ruby/docs/PropertyDefinition.md b/ruby/docs/PropertyDefinition.md new file mode 100644 index 0000000..ef2c757 --- /dev/null +++ b/ruby/docs/PropertyDefinition.md @@ -0,0 +1,19 @@ +# OpenapiClient::PropertyDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**column** | **String** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::PropertyDefinition.new(type: null, + column: null) +``` + + diff --git a/ruby/docs/PropertyType.md b/ruby/docs/PropertyType.md new file mode 100644 index 0000000..8cb7f2e --- /dev/null +++ b/ruby/docs/PropertyType.md @@ -0,0 +1,37 @@ +# OpenapiClient::PropertyType + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**title** | **String** | | [optional] +**id** | **String** | | [optional] +**type** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] +**description** | **String** | | [optional] +**schemas** | [**Array<FullQualifiedName>**](FullQualifiedName.md) | | [optional] +**datatype** | **String** | | [optional] +**pii** | **Boolean** | | [optional] +**multi_valued** | **Boolean** | | [optional] +**analyzer** | **String** | | [optional] +**enum_values** | **Array<String>** | | [optional] +**index_type** | **String** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::PropertyType.new(title: null, + id: null, + type: null, + description: null, + schemas: null, + datatype: null, + pii: null, + multi_valued: null, + analyzer: null, + enum_values: null, + index_type: null) +``` + + diff --git a/ruby/docs/PropertyUsageSummary.md b/ruby/docs/PropertyUsageSummary.md new file mode 100644 index 0000000..9d42298 --- /dev/null +++ b/ruby/docs/PropertyUsageSummary.md @@ -0,0 +1,23 @@ +# OpenapiClient::PropertyUsageSummary + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_type_id** | **String** | | [optional] +**entity_set_id** | **String** | | [optional] +**entity_set_name** | **String** | | [optional] +**count** | **Integer** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::PropertyUsageSummary.new(entity_type_id: null, + entity_set_id: null, + entity_set_name: null, + count: null) +``` + + diff --git a/ruby/docs/Role.md b/ruby/docs/Role.md new file mode 100644 index 0000000..6e771cd --- /dev/null +++ b/ruby/docs/Role.md @@ -0,0 +1,25 @@ +# OpenapiClient::Role + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**organization_id** | **String** | | [optional] +**principal** | [**Principal**](Principal.md) | | [optional] +**title** | **String** | | [optional] +**description** | **String** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::Role.new(id: null, + organization_id: null, + principal: null, + title: null, + description: null) +``` + + diff --git a/ruby/docs/Schema.md b/ruby/docs/Schema.md new file mode 100644 index 0000000..e37ff01 --- /dev/null +++ b/ruby/docs/Schema.md @@ -0,0 +1,21 @@ +# OpenapiClient::Schema + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_types** | [**Array<EntityType>**](EntityType.md) | | [optional] +**property_types** | [**Array<PropertyType>**](PropertyType.md) | | [optional] +**fqn** | [**FullQualifiedName**](FullQualifiedName.md) | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::Schema.new(entity_types: null, + property_types: null, + fqn: null) +``` + + diff --git a/ruby/docs/Search.md b/ruby/docs/Search.md new file mode 100644 index 0000000..c382c19 --- /dev/null +++ b/ruby/docs/Search.md @@ -0,0 +1,25 @@ +# OpenapiClient::Search + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**keyword** | **String** | | [optional] +**entity_type_id** | **String** | | [optional] +**property_type_ids** | **Array<String>** | | [optional] +**start** | **Integer** | | [optional] +**max_hits** | **Integer** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::Search.new(keyword: null, + entity_type_id: null, + property_type_ids: null, + start: null, + max_hits: null) +``` + + diff --git a/ruby/docs/SearchApi.md b/ruby/docs/SearchApi.md new file mode 100644 index 0000000..3eaaac2 --- /dev/null +++ b/ruby/docs/SearchApi.md @@ -0,0 +1,1082 @@ +# OpenapiClient::SearchApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**execute_advanced_entity_set_data_query**](SearchApi.md#execute_advanced_entity_set_data_query) | **POST** /datastore/search/advanced/{entitySetId} | Executes a search over the data of a given entity set to find rows that match the search term +[**execute_app_search**](SearchApi.md#execute_app_search) | **POST** /datastore/search/app | Executes a search over all apps to find ones that match the given search term +[**execute_app_type_search**](SearchApi.md#execute_app_type_search) | **POST** /datastore/search/app_types | Executes a search over all app types to find ones that match the given search term +[**execute_association_type_search**](SearchApi.md#execute_association_type_search) | **POST** /datastore/search/association_types | Executes a search over all association types to find ones that match the given search term +[**execute_entity_neighbor_search**](SearchApi.md#execute_entity_neighbor_search) | **GET** /datastore/search/{entitySetId}/{entityKeyId} | Executes a search for all neighbors of an entity that are connected by an association +[**execute_entity_neighbor_search_bulk**](SearchApi.md#execute_entity_neighbor_search_bulk) | **POST** /datastore/search/{entitySetId}/neighbors | Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association +[**execute_entity_set_collection_search**](SearchApi.md#execute_entity_set_collection_search) | **POST** /datastore/search/entity_sets/collections | Executes a search over all EntitySetCollections to find ones that match the given search term +[**execute_entity_set_data_query**](SearchApi.md#execute_entity_set_data_query) | **POST** /datastore/search/{entitySetId} | Executes a search over the data of a given entity set to find rows that match the search term +[**execute_entity_set_keyword_query**](SearchApi.md#execute_entity_set_keyword_query) | **POST** /datastore/search | The query, entityType, and propertyTypes params are all optional, but at least one must be specified otherwise an error will be thrown. All specified params are required to be present in each entity set returned. If entityType and propertyTypes are both specified, the propertyTypes param will be ignored. +[**execute_entity_type_collection_search**](SearchApi.md#execute_entity_type_collection_search) | **POST** /datastore/search/entity_types/collections | Executes a search over all EntityTypeCollections to find ones that match the given search term +[**execute_entity_type_search**](SearchApi.md#execute_entity_type_search) | **POST** /datastore/search/entity_types | Executes a search over all entity types to find ones that match the given search term +[**execute_filtered_entity_neighbor_id_search**](SearchApi.md#execute_filtered_entity_neighbor_id_search) | **POST** /datastore/search/{entitySetId}/neighbors/advanced/ids | Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association and returns a simple version of the neighborDetails +[**execute_filtered_entity_neighbor_search**](SearchApi.md#execute_filtered_entity_neighbor_search) | **POST** /datastore/search/{entitySetId}/neighbors/advanced | Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association +[**execute_fqn_property_type_search**](SearchApi.md#execute_fqn_property_type_search) | **POST** /datastore/search/property_types/fqn | Executes a search over all property types to find ones that match the given name and namespace, including partial matches +[**execute_organization_search**](SearchApi.md#execute_organization_search) | **POST** /datastore/search/organizations | Executes a search over all organizations to find ones that match the given search term +[**execute_property_type_search**](SearchApi.md#execute_property_type_search) | **POST** /datastore/search/property_types | Executes a search over all property types to find ones that match the given search term +[**get_entity_sets**](SearchApi.md#get_entity_sets) | **GET** /datastore/search/entity-sets/{start}/{numResults} | Executes a search over all existing entity sets to populate the home page. The path parameters instruct which page to return and how large the page should be. +[**get_popular_entity_set**](SearchApi.md#get_popular_entity_set) | **GET** /datastore/search/popular | Get the most popular entity sets. +[**search_entity_set_data**](SearchApi.md#search_entity_set_data) | **PATCH** /datastore/search | Executes a search over the data of a given entity set to find rows that match the search term + + + +## execute_advanced_entity_set_data_query + +> DataSearchResult execute_advanced_entity_set_data_query(entity_set_id, advanced_search) + +Executes a search over the data of a given entity set to find rows that match the search term + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new +entity_set_id = 'entity_set_id_example' # String | +advanced_search = OpenapiClient::AdvancedSearch.new # AdvancedSearch | + +begin + #Executes a search over the data of a given entity set to find rows that match the search term + result = api_instance.execute_advanced_entity_set_data_query(entity_set_id, advanced_search) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->execute_advanced_entity_set_data_query: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **advanced_search** | [**AdvancedSearch**](AdvancedSearch.md)| | + +### Return type + +[**DataSearchResult**](DataSearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## execute_app_search + +> SearchResult execute_app_search(search_term) + +Executes a search over all apps to find ones that match the given search term + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new +search_term = OpenapiClient::SearchTerm.new # SearchTerm | + +begin + #Executes a search over all apps to find ones that match the given search term + result = api_instance.execute_app_search(search_term) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->execute_app_search: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_term** | [**SearchTerm**](SearchTerm.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## execute_app_type_search + +> SearchResult execute_app_type_search(search_term) + +Executes a search over all app types to find ones that match the given search term + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new +search_term = OpenapiClient::SearchTerm.new # SearchTerm | + +begin + #Executes a search over all app types to find ones that match the given search term + result = api_instance.execute_app_type_search(search_term) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->execute_app_type_search: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_term** | [**SearchTerm**](SearchTerm.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## execute_association_type_search + +> SearchResult execute_association_type_search(search_term) + +Executes a search over all association types to find ones that match the given search term + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new +search_term = OpenapiClient::SearchTerm.new # SearchTerm | + +begin + #Executes a search over all association types to find ones that match the given search term + result = api_instance.execute_association_type_search(search_term) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->execute_association_type_search: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_term** | [**SearchTerm**](SearchTerm.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## execute_entity_neighbor_search + +> Array<NeighborEntityDetails> execute_entity_neighbor_search(entity_set_id, entity_key_id) + +Executes a search for all neighbors of an entity that are connected by an association + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new +entity_set_id = 'entity_set_id_example' # String | +entity_key_id = 'entity_key_id_example' # String | + +begin + #Executes a search for all neighbors of an entity that are connected by an association + result = api_instance.execute_entity_neighbor_search(entity_set_id, entity_key_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->execute_entity_neighbor_search: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **entity_key_id** | [**String**](.md)| | + +### Return type + +[**Array<NeighborEntityDetails>**](NeighborEntityDetails.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## execute_entity_neighbor_search_bulk + +> Hash<String, Array<NeighborEntityDetails>> execute_entity_neighbor_search_bulk(entity_set_id, request_body) + +Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new +entity_set_id = 'entity_set_id_example' # String | +request_body = ['request_body_example'] # Array | + +begin + #Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association + result = api_instance.execute_entity_neighbor_search_bulk(entity_set_id, request_body) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->execute_entity_neighbor_search_bulk: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **request_body** | [**Array<String>**](String.md)| | + +### Return type + +**Hash<String, Array<NeighborEntityDetails>>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## execute_entity_set_collection_search + +> SearchResult execute_entity_set_collection_search(search_term) + +Executes a search over all EntitySetCollections to find ones that match the given search term + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new +search_term = OpenapiClient::SearchTerm.new # SearchTerm | + +begin + #Executes a search over all EntitySetCollections to find ones that match the given search term + result = api_instance.execute_entity_set_collection_search(search_term) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->execute_entity_set_collection_search: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_term** | [**SearchTerm**](SearchTerm.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## execute_entity_set_data_query + +> DataSearchResult execute_entity_set_data_query(entity_set_id, search_term) + +Executes a search over the data of a given entity set to find rows that match the search term + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new +entity_set_id = 'entity_set_id_example' # String | +search_term = OpenapiClient::SearchTerm.new # SearchTerm | A JSON object that contains three parameters, \"start\", which specifies the hit number to start returning results on for paging, \"maxHits\", which specifies the maximum number of hits to return, and \"searchTerm\", which is the search term results will match on. + +begin + #Executes a search over the data of a given entity set to find rows that match the search term + result = api_instance.execute_entity_set_data_query(entity_set_id, search_term) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->execute_entity_set_data_query: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **search_term** | [**SearchTerm**](SearchTerm.md)| A JSON object that contains three parameters, \"start\", which specifies the hit number to start returning results on for paging, \"maxHits\", which specifies the maximum number of hits to return, and \"searchTerm\", which is the search term results will match on. | + +### Return type + +[**DataSearchResult**](DataSearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## execute_entity_set_keyword_query + +> SearchResult execute_entity_set_keyword_query(search) + +The query, entityType, and propertyTypes params are all optional, but at least one must be specified otherwise an error will be thrown. All specified params are required to be present in each entity set returned. If entityType and propertyTypes are both specified, the propertyTypes param will be ignored. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new +search = OpenapiClient::Search.new # Search | + +begin + #The query, entityType, and propertyTypes params are all optional, but at least one must be specified otherwise an error will be thrown. All specified params are required to be present in each entity set returned. If entityType and propertyTypes are both specified, the propertyTypes param will be ignored. + result = api_instance.execute_entity_set_keyword_query(search) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->execute_entity_set_keyword_query: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search** | [**Search**](Search.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## execute_entity_type_collection_search + +> SearchResult execute_entity_type_collection_search(search_term) + +Executes a search over all EntityTypeCollections to find ones that match the given search term + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new +search_term = OpenapiClient::SearchTerm.new # SearchTerm | + +begin + #Executes a search over all EntityTypeCollections to find ones that match the given search term + result = api_instance.execute_entity_type_collection_search(search_term) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->execute_entity_type_collection_search: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_term** | [**SearchTerm**](SearchTerm.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## execute_entity_type_search + +> SearchResult execute_entity_type_search(search_term) + +Executes a search over all entity types to find ones that match the given search term + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new +search_term = OpenapiClient::SearchTerm.new # SearchTerm | + +begin + #Executes a search over all entity types to find ones that match the given search term + result = api_instance.execute_entity_type_search(search_term) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->execute_entity_type_search: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_term** | [**SearchTerm**](SearchTerm.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## execute_filtered_entity_neighbor_id_search + +> Hash<String, Hash<String, Hash<String, Array<NeighborEntityIds>>>> execute_filtered_entity_neighbor_id_search(entity_set_id, neighbor_search_filter) + +Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association and returns a simple version of the neighborDetails + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new +entity_set_id = 'entity_set_id_example' # String | +neighbor_search_filter = OpenapiClient::NeighborSearchFilter.new # NeighborSearchFilter | + +begin + #Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association and returns a simple version of the neighborDetails + result = api_instance.execute_filtered_entity_neighbor_id_search(entity_set_id, neighbor_search_filter) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->execute_filtered_entity_neighbor_id_search: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **neighbor_search_filter** | [**NeighborSearchFilter**](NeighborSearchFilter.md)| | + +### Return type + +**Hash<String, Hash<String, Hash<String, Array<NeighborEntityIds>>>>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## execute_filtered_entity_neighbor_search + +> Hash<String, Array<NeighborEntityDetails>> execute_filtered_entity_neighbor_search(entity_set_id, neighbor_search_filter) + +Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new +entity_set_id = 'entity_set_id_example' # String | +neighbor_search_filter = OpenapiClient::NeighborSearchFilter.new # NeighborSearchFilter | + +begin + #Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association + result = api_instance.execute_filtered_entity_neighbor_search(entity_set_id, neighbor_search_filter) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->execute_filtered_entity_neighbor_search: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **entity_set_id** | [**String**](.md)| | + **neighbor_search_filter** | [**NeighborSearchFilter**](NeighborSearchFilter.md)| | + +### Return type + +**Hash<String, Array<NeighborEntityDetails>>** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## execute_fqn_property_type_search + +> SearchResult execute_fqn_property_type_search(search_term) + +Executes a search over all property types to find ones that match the given name and namespace, including partial matches + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new +search_term = OpenapiClient::SearchTerm.new # SearchTerm | + +begin + #Executes a search over all property types to find ones that match the given name and namespace, including partial matches + result = api_instance.execute_fqn_property_type_search(search_term) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->execute_fqn_property_type_search: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_term** | [**SearchTerm**](SearchTerm.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## execute_organization_search + +> SearchResult execute_organization_search(search_term) + +Executes a search over all organizations to find ones that match the given search term + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new +search_term = OpenapiClient::SearchTerm.new # SearchTerm | + +begin + #Executes a search over all organizations to find ones that match the given search term + result = api_instance.execute_organization_search(search_term) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->execute_organization_search: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_term** | [**SearchTerm**](SearchTerm.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## execute_property_type_search + +> SearchResult execute_property_type_search(search_term) + +Executes a search over all property types to find ones that match the given search term + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new +search_term = OpenapiClient::SearchTerm.new # SearchTerm | + +begin + #Executes a search over all property types to find ones that match the given search term + result = api_instance.execute_property_type_search(search_term) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->execute_property_type_search: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_term** | [**SearchTerm**](SearchTerm.md)| | + +### Return type + +[**SearchResult**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## get_entity_sets + +> Array<SearchResult> get_entity_sets(start, num_results) + +Executes a search over all existing entity sets to populate the home page. The path parameters instruct which page to return and how large the page should be. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new +start = 56 # Integer | The first result number to return +num_results = 56 # Integer | The total number of results to return + +begin + #Executes a search over all existing entity sets to populate the home page. The path parameters instruct which page to return and how large the page should be. + result = api_instance.get_entity_sets(start, num_results) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->get_entity_sets: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **start** | **Integer**| The first result number to return | + **num_results** | **Integer**| The total number of results to return | + +### Return type + +[**Array<SearchResult>**](SearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## get_popular_entity_set + +> Array<EntitySet> get_popular_entity_set + +Get the most popular entity sets. + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new + +begin + #Get the most popular entity sets. + result = api_instance.get_popular_entity_set + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->get_popular_entity_set: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Array<EntitySet>**](EntitySet.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## search_entity_set_data + +> DataSearchResult search_entity_set_data(search_constraints) + +Executes a search over the data of a given entity set to find rows that match the search term + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::SearchApi.new +search_constraints = OpenapiClient::SearchConstraints.new # SearchConstraints | + +begin + #Executes a search over the data of a given entity set to find rows that match the search term + result = api_instance.search_entity_set_data(search_constraints) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling SearchApi->search_entity_set_data: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **search_constraints** | [**SearchConstraints**](SearchConstraints.md)| | + +### Return type + +[**DataSearchResult**](DataSearchResult.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + diff --git a/ruby/docs/SearchConstraints.md b/ruby/docs/SearchConstraints.md new file mode 100644 index 0000000..fc63a01 --- /dev/null +++ b/ruby/docs/SearchConstraints.md @@ -0,0 +1,25 @@ +# OpenapiClient::SearchConstraints + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**entity_set_ids** | **Array<String>** | | [optional] +**start** | **Integer** | | [optional] +**max_hits** | **Integer** | | [optional] +**constraints** | [**Array<ConstraintGroup>**](ConstraintGroup.md) | | [optional] +**sort** | [**SortDefinition**](SortDefinition.md) | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::SearchConstraints.new(entity_set_ids: null, + start: null, + max_hits: null, + constraints: null, + sort: null) +``` + + diff --git a/ruby/docs/SearchDetails.md b/ruby/docs/SearchDetails.md new file mode 100644 index 0000000..e13f476 --- /dev/null +++ b/ruby/docs/SearchDetails.md @@ -0,0 +1,21 @@ +# OpenapiClient::SearchDetails + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**search_term** | **String** | | [optional] +**property** | **String** | | [optional] +**exact** | **Boolean** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::SearchDetails.new(search_term: null, + property: null, + exact: null) +``` + + diff --git a/ruby/docs/SearchResult.md b/ruby/docs/SearchResult.md new file mode 100644 index 0000000..54c5de5 --- /dev/null +++ b/ruby/docs/SearchResult.md @@ -0,0 +1,19 @@ +# OpenapiClient::SearchResult + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**num_hits** | **Integer** | | [optional] +**hits** | [**Array<SearchResultHits>**](SearchResultHits.md) | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::SearchResult.new(num_hits: null, + hits: null) +``` + + diff --git a/ruby/docs/SearchResultHits.md b/ruby/docs/SearchResultHits.md new file mode 100644 index 0000000..6e808d0 --- /dev/null +++ b/ruby/docs/SearchResultHits.md @@ -0,0 +1,19 @@ +# OpenapiClient::SearchResultHits + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**property_types** | [**Array<PropertyType>**](PropertyType.md) | | [optional] +**entity_set** | [**EntitySet**](EntitySet.md) | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::SearchResultHits.new(property_types: null, + entity_set: null) +``` + + diff --git a/ruby/docs/SearchTerm.md b/ruby/docs/SearchTerm.md new file mode 100644 index 0000000..9b29fa0 --- /dev/null +++ b/ruby/docs/SearchTerm.md @@ -0,0 +1,23 @@ +# OpenapiClient::SearchTerm + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**search_term** | **String** | | [optional] +**start** | **Integer** | | [optional] +**max_hits** | **Integer** | | [optional] +**fuzzy** | **Boolean** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::SearchTerm.new(search_term: null, + start: null, + max_hits: null, + fuzzy: null) +``` + + diff --git a/ruby/docs/SecurablePrincipal.md b/ruby/docs/SecurablePrincipal.md new file mode 100644 index 0000000..76f111c --- /dev/null +++ b/ruby/docs/SecurablePrincipal.md @@ -0,0 +1,23 @@ +# OpenapiClient::SecurablePrincipal + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | | [optional] +**principal** | [**Principal**](Principal.md) | | [optional] +**title** | **String** | | [optional] +**description** | **String** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::SecurablePrincipal.new(id: null, + principal: null, + title: null, + description: null) +``` + + diff --git a/ruby/docs/ShuttleApi.md b/ruby/docs/ShuttleApi.md new file mode 100644 index 0000000..ad8bc05 --- /dev/null +++ b/ruby/docs/ShuttleApi.md @@ -0,0 +1,455 @@ +# OpenapiClient::ShuttleApi + +All URIs are relative to *https://api.openlattice.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**create_integration_definition**](ShuttleApi.md#create_integration_definition) | **POST** /shuttle/integration/definition/{integrationName} | Creates a new integration definition for running recurring integrations +[**delete_integration_definition**](ShuttleApi.md#delete_integration_definition) | **DELETE** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition +[**delete_integration_job_status**](ShuttleApi.md#delete_integration_job_status) | **DELETE** /shuttle/integration/status/{jobId} | Deletes an integration job status from the integrationJobs map +[**enqueue_integration**](ShuttleApi.md#enqueue_integration) | **GET** /shuttle/integration/{integrationName}/{integrationKey} | Enqueues an integration on Shuttle Server for a given integration +[**poll_all_integrations**](ShuttleApi.md#poll_all_integrations) | **GET** /shuttle/integration/status | Polls the statuses of all running integrations +[**poll_integration**](ShuttleApi.md#poll_integration) | **GET** /shuttle/integration/status/{jobId} | Polls the status of an integration +[**read_integration_definition**](ShuttleApi.md#read_integration_definition) | **GET** /shuttle/integration/definition/{integrationName} | Gets an existing integration definition +[**update_integration_definition**](ShuttleApi.md#update_integration_definition) | **PATCH** /shuttle/integration/definition/{integrationName} | Replaces any number of fields within an existing integration definition + + + +## create_integration_definition + +> String create_integration_definition(integration_name, integration) + +Creates a new integration definition for running recurring integrations + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::ShuttleApi.new +integration_name = 'integration_name_example' # String | +integration = OpenapiClient::Integration.new # Integration | + +begin + #Creates a new integration definition for running recurring integrations + result = api_instance.create_integration_definition(integration_name, integration) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling ShuttleApi->create_integration_definition: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integration_name** | **String**| | + **integration** | [**Integration**](Integration.md)| | + +### Return type + +**String** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: application/json + + +## delete_integration_definition + +> delete_integration_definition(integration_name) + +Replaces any number of fields within an existing integration definition + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::ShuttleApi.new +integration_name = 'integration_name_example' # String | + +begin + #Replaces any number of fields within an existing integration definition + api_instance.delete_integration_definition(integration_name) +rescue OpenapiClient::ApiError => e + puts "Exception when calling ShuttleApi->delete_integration_definition: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integration_name** | **String**| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## delete_integration_job_status + +> delete_integration_job_status(job_id) + +Deletes an integration job status from the integrationJobs map + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::ShuttleApi.new +job_id = 'job_id_example' # String | the unique id of the integration job + +begin + #Deletes an integration job status from the integrationJobs map + api_instance.delete_integration_job_status(job_id) +rescue OpenapiClient::ApiError => e + puts "Exception when calling ShuttleApi->delete_integration_job_status: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **job_id** | [**String**](.md)| the unique id of the integration job | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## enqueue_integration + +> String enqueue_integration(integration_name, integration_key) + +Enqueues an integration on Shuttle Server for a given integration + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::ShuttleApi.new +integration_name = 'integration_name_example' # String | the name of the integration to be run +integration_key = 'integration_key_example' # String | the unique id used to authenticate an integration run + +begin + #Enqueues an integration on Shuttle Server for a given integration + result = api_instance.enqueue_integration(integration_name, integration_key) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling ShuttleApi->enqueue_integration: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integration_name** | **String**| the name of the integration to be run | + **integration_key** | [**String**](.md)| the unique id used to authenticate an integration run | + +### Return type + +**String** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## poll_all_integrations + +> Hash<String, IntegrationJob> poll_all_integrations + +Polls the statuses of all running integrations + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::ShuttleApi.new + +begin + #Polls the statuses of all running integrations + result = api_instance.poll_all_integrations + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling ShuttleApi->poll_all_integrations: #{e}" +end +``` + +### Parameters + +This endpoint does not need any parameter. + +### Return type + +[**Hash<String, IntegrationJob>**](IntegrationJob.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## poll_integration + +> String poll_integration(job_id) + +Polls the status of an integration + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::ShuttleApi.new +job_id = 'job_id_example' # String | the unique id of the integration job + +begin + #Polls the status of an integration + result = api_instance.poll_integration(job_id) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling ShuttleApi->poll_integration: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **job_id** | [**String**](.md)| the unique id of the integration job | + +### Return type + +**String** + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## read_integration_definition + +> Integration read_integration_definition(integration_name) + +Gets an existing integration definition + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::ShuttleApi.new +integration_name = 'integration_name_example' # String | + +begin + #Gets an existing integration definition + result = api_instance.read_integration_definition(integration_name) + p result +rescue OpenapiClient::ApiError => e + puts "Exception when calling ShuttleApi->read_integration_definition: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integration_name** | **String**| | + +### Return type + +[**Integration**](Integration.md) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: Not defined +- **Accept**: application/json + + +## update_integration_definition + +> update_integration_definition(integration_name, integration_update) + +Replaces any number of fields within an existing integration definition + +### Example + +```ruby +# load the gem +require 'openapi_client' +# setup authorization +OpenapiClient.configure do |config| + # Configure Bearer authorization (JWT): http_auth + config.access_token = 'YOUR_BEARER_TOKEN' + + # Configure API key authorization: openlattice_auth + config.api_key['Authorization'] = 'YOUR API KEY' + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) + #config.api_key_prefix['Authorization'] = 'Bearer' +end + +api_instance = OpenapiClient::ShuttleApi.new +integration_name = 'integration_name_example' # String | +integration_update = OpenapiClient::IntegrationUpdate.new # IntegrationUpdate | + +begin + #Replaces any number of fields within an existing integration definition + api_instance.update_integration_definition(integration_name, integration_update) +rescue OpenapiClient::ApiError => e + puts "Exception when calling ShuttleApi->update_integration_definition: #{e}" +end +``` + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **integration_name** | **String**| | + **integration_update** | [**IntegrationUpdate**](IntegrationUpdate.md)| | + +### Return type + +nil (empty response body) + +### Authorization + +[http_auth](../README.md#http_auth), [openlattice_auth](../README.md#openlattice_auth) + +### HTTP request headers + +- **Content-Type**: application/json +- **Accept**: Not defined + diff --git a/ruby/docs/SmsEntitySetInformation.md b/ruby/docs/SmsEntitySetInformation.md new file mode 100644 index 0000000..ec564fb --- /dev/null +++ b/ruby/docs/SmsEntitySetInformation.md @@ -0,0 +1,23 @@ +# OpenapiClient::SmsEntitySetInformation + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**phone_number** | **String** | | [optional] +**organization_id** | **String** | | [optional] +**entityset_ids** | **Array<String>** | | [optional] +**tags** | **Array<String>** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::SmsEntitySetInformation.new(phone_number: null, + organization_id: null, + entityset_ids: null, + tags: null) +``` + + diff --git a/ruby/docs/SortDefinition.md b/ruby/docs/SortDefinition.md new file mode 100644 index 0000000..7ac58b5 --- /dev/null +++ b/ruby/docs/SortDefinition.md @@ -0,0 +1,25 @@ +# OpenapiClient::SortDefinition + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **String** | | [optional] +**descending** | **Boolean** | | [optional] +**property_type_id** | **String** | | [optional] +**latitude** | **Float** | | [optional] +**longitude** | **Float** | | [optional] + +## Code Sample + +```ruby +require 'OpenapiClient' + +instance = OpenapiClient::SortDefinition.new(type: null, + descending: null, + property_type_id: null, + latitude: null, + longitude: null) +``` + + diff --git a/ruby/git_push.sh b/ruby/git_push.sh new file mode 100644 index 0000000..ced3be2 --- /dev/null +++ b/ruby/git_push.sh @@ -0,0 +1,58 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 +git_host=$4 + +if [ "$git_host" = "" ]; then + git_host="github.com" + echo "[INFO] No command line input provided. Set \$git_host to $git_host" +fi + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=`git remote` +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' + diff --git a/ruby/lib/openapi_client.rb b/ruby/lib/openapi_client.rb new file mode 100644 index 0000000..13a5d0d --- /dev/null +++ b/ruby/lib/openapi_client.rb @@ -0,0 +1,130 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +# Common files +require 'openapi_client/api_client' +require 'openapi_client/api_error' +require 'openapi_client/version' +require 'openapi_client/configuration' + +# Models +require 'openapi_client/models/access_check' +require 'openapi_client/models/ace' +require 'openapi_client/models/acl' +require 'openapi_client/models/acl_data' +require 'openapi_client/models/advanced_search' +require 'openapi_client/models/association' +require 'openapi_client/models/association_definition' +require 'openapi_client/models/association_type' +require 'openapi_client/models/auth0user_basic' +require 'openapi_client/models/authorization' +require 'openapi_client/models/authorized_objects_search_result' +require 'openapi_client/models/bulk_data_creation' +require 'openapi_client/models/collection_template_type' +require 'openapi_client/models/constraint' +require 'openapi_client/models/constraint_group' +require 'openapi_client/models/data_association' +require 'openapi_client/models/data_edge' +require 'openapi_client/models/data_edge_data' +require 'openapi_client/models/data_edge_key' +require 'openapi_client/models/data_graph' +require 'openapi_client/models/data_graph_ids' +require 'openapi_client/models/data_search_result' +require 'openapi_client/models/edm' +require 'openapi_client/models/ed_mdiff' +require 'openapi_client/models/edm_request' +require 'openapi_client/models/entity' +require 'openapi_client/models/entity_data_key' +require 'openapi_client/models/entity_definition' +require 'openapi_client/models/entity_key' +require 'openapi_client/models/entity_key_pair' +require 'openapi_client/models/entity_linking_features' +require 'openapi_client/models/entity_linking_feedback' +require 'openapi_client/models/entity_neighbors_filter' +require 'openapi_client/models/entity_set' +require 'openapi_client/models/entity_set_collection' +require 'openapi_client/models/entity_set_property_meta_data' +require 'openapi_client/models/entity_set_selection' +require 'openapi_client/models/entity_type' +require 'openapi_client/models/entity_type_collection' +require 'openapi_client/models/entity_type_property_metadata' +require 'openapi_client/models/flight' +require 'openapi_client/models/flight_plan_parameters' +require 'openapi_client/models/flight_plan_parameters_update' +require 'openapi_client/models/full_qualified_name' +require 'openapi_client/models/indexing_state' +require 'openapi_client/models/inline_object' +require 'openapi_client/models/inline_response200' +require 'openapi_client/models/integration' +require 'openapi_client/models/integration_job' +require 'openapi_client/models/integration_results' +require 'openapi_client/models/integration_update' +require 'openapi_client/models/linking_feedback' +require 'openapi_client/models/materialized_view_account' +require 'openapi_client/models/metadata_update' +require 'openapi_client/models/neighbor_entity_details' +require 'openapi_client/models/neighbor_entity_ids' +require 'openapi_client/models/neighbor_search_filter' +require 'openapi_client/models/organization' +require 'openapi_client/models/organization_external_database_column' +require 'openapi_client/models/organization_external_database_table' +require 'openapi_client/models/organization_external_database_table_columns_pair' +require 'openapi_client/models/organization_member' +require 'openapi_client/models/principal' +require 'openapi_client/models/property_definition' +require 'openapi_client/models/property_type' +require 'openapi_client/models/property_usage_summary' +require 'openapi_client/models/role' +require 'openapi_client/models/schema' +require 'openapi_client/models/search' +require 'openapi_client/models/search_constraints' +require 'openapi_client/models/search_details' +require 'openapi_client/models/search_result' +require 'openapi_client/models/search_result_hits' +require 'openapi_client/models/search_term' +require 'openapi_client/models/securable_principal' +require 'openapi_client/models/sms_entity_set_information' +require 'openapi_client/models/sort_definition' + +# APIs +require 'openapi_client/api/admin_api' +require 'openapi_client/api/authorizations_api' +require 'openapi_client/api/collections_api' +require 'openapi_client/api/data_api' +require 'openapi_client/api/data_integrations_api' +require 'openapi_client/api/dataset_api' +require 'openapi_client/api/edm_api' +require 'openapi_client/api/entity_sets_api' +require 'openapi_client/api/linking_api' +require 'openapi_client/api/organizations_api' +require 'openapi_client/api/permissions_api' +require 'openapi_client/api/principal_api' +require 'openapi_client/api/search_api' +require 'openapi_client/api/shuttle_api' + +module OpenapiClient + class << self + # Customize default settings for the SDK using block. + # OpenapiClient.configure do |config| + # config.username = "xxx" + # config.password = "xxx" + # end + # If no block given, return the default Configuration object. + def configure + if block_given? + yield(Configuration.default) + else + Configuration.default + end + end + end +end diff --git a/ruby/lib/openapi_client/api/admin_api.rb b/ruby/lib/openapi_client/api/admin_api.rb new file mode 100644 index 0000000..9dfb629 --- /dev/null +++ b/ruby/lib/openapi_client/api/admin_api.rb @@ -0,0 +1,254 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'cgi' + +module OpenapiClient + class AdminApi + attr_accessor :api_client + + def initialize(api_client = ApiClient.default) + @api_client = api_client + end + # Clears all the data currently being indexed in the queue. + # @param [Hash] opts the optional parameters + # @return [Integer] + def clear_indexing_queue(opts = {}) + data, _status_code, _headers = clear_indexing_queue_with_http_info(opts) + data + end + + # Clears all the data currently being indexed in the queue. + # @param [Hash] opts the optional parameters + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def clear_indexing_queue_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: AdminApi.clear_indexing_queue ...' + end + # resource path + local_var_path = '/indexer/index/reindex' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: AdminApi#clear_indexing_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Retrieve the current state of reindexing jobs + # @param [Hash] opts the optional parameters + # @return [IndexingState] + def get_indexing_state(opts = {}) + data, _status_code, _headers = get_indexing_state_with_http_info(opts) + data + end + + # Retrieve the current state of reindexing jobs + # @param [Hash] opts the optional parameters + # @return [Array<(IndexingState, Integer, Hash)>] IndexingState data, response status code and response headers + def get_indexing_state_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: AdminApi.get_indexing_state ...' + end + # resource path + local_var_path = '/indexer/index/reindex' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'IndexingState' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: AdminApi#get_indexing_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Merge job descriptions for performing a partial or full reindex of provided entity sets. + # @param request_body [Hash>] A map of entity set ids to entity key ids that determines what will be reindexed. If no entity key ids are provided then all entities in an entity set are reindexed. If no entity set ids are provided then all entity sets are scheduled for reindexing. + # @param [Hash] opts the optional parameters + # @return [IndexingState] + def reindex(request_body, opts = {}) + data, _status_code, _headers = reindex_with_http_info(request_body, opts) + data + end + + # Merge job descriptions for performing a partial or full reindex of provided entity sets. + # @param request_body [Hash>] A map of entity set ids to entity key ids that determines what will be reindexed. If no entity key ids are provided then all entities in an entity set are reindexed. If no entity set ids are provided then all entity sets are scheduled for reindexing. + # @param [Hash] opts the optional parameters + # @return [Array<(IndexingState, Integer, Hash)>] IndexingState data, response status code and response headers + def reindex_with_http_info(request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: AdminApi.reindex ...' + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling AdminApi.reindex" + end + # resource path + local_var_path = '/indexer/index/reindex' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] || 'IndexingState' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: AdminApi#reindex\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Replaces job descriptions for performing a partial or full reindex of provided entity sets. + # @param request_body [Hash>] A map of entity set ids to entity key ids that determines what will be reindexed. If no entity key ids are provided then all entities in an entity set are reindexed. If no entity set ids are provided then all entity sets are scheduled for reindexing. + # @param [Hash] opts the optional parameters + # @return [IndexingState] + def update_reindex(request_body, opts = {}) + data, _status_code, _headers = update_reindex_with_http_info(request_body, opts) + data + end + + # Replaces job descriptions for performing a partial or full reindex of provided entity sets. + # @param request_body [Hash>] A map of entity set ids to entity key ids that determines what will be reindexed. If no entity key ids are provided then all entities in an entity set are reindexed. If no entity set ids are provided then all entity sets are scheduled for reindexing. + # @param [Hash] opts the optional parameters + # @return [Array<(IndexingState, Integer, Hash)>] IndexingState data, response status code and response headers + def update_reindex_with_http_info(request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: AdminApi.update_reindex ...' + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling AdminApi.update_reindex" + end + # resource path + local_var_path = '/indexer/index/reindex' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] || 'IndexingState' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: AdminApi#update_reindex\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + end +end diff --git a/ruby/lib/openapi_client/api/authorizations_api.rb b/ruby/lib/openapi_client/api/authorizations_api.rb new file mode 100644 index 0000000..dae41b6 --- /dev/null +++ b/ruby/lib/openapi_client/api/authorizations_api.rb @@ -0,0 +1,155 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'cgi' + +module OpenapiClient + class AuthorizationsApi + attr_accessor :api_client + + def initialize(api_client = ApiClient.default) + @api_client = api_client + end + # Check authorizations + # @param access_check [AccessCheck] + # @param [Hash] opts the optional parameters + # @return [Array] + def check_authorizations(access_check, opts = {}) + data, _status_code, _headers = check_authorizations_with_http_info(access_check, opts) + data + end + + # Check authorizations + # @param access_check [AccessCheck] + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def check_authorizations_with_http_info(access_check, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: AuthorizationsApi.check_authorizations ...' + end + # verify the required parameter 'access_check' is set + if @api_client.config.client_side_validation && access_check.nil? + fail ArgumentError, "Missing the required parameter 'access_check' when calling AuthorizationsApi.check_authorizations" + end + # resource path + local_var_path = '/datastore/authorizations' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(access_check) + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: AuthorizationsApi#check_authorizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Returns paged results for all authorized objects of specified objectType, that the current user has specified permission for. + # @param [Hash] opts the optional parameters + # @option opts [String] :object_type + # @option opts [String] :permission + # @option opts [String] :paging_token + # @return [AuthorizedObjectsSearchResult] + def get_accessible_objects(opts = {}) + data, _status_code, _headers = get_accessible_objects_with_http_info(opts) + data + end + + # Returns paged results for all authorized objects of specified objectType, that the current user has specified permission for. + # @param [Hash] opts the optional parameters + # @option opts [String] :object_type + # @option opts [String] :permission + # @option opts [String] :paging_token + # @return [Array<(AuthorizedObjectsSearchResult, Integer, Hash)>] AuthorizedObjectsSearchResult data, response status code and response headers + def get_accessible_objects_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: AuthorizationsApi.get_accessible_objects ...' + end + allowable_values = ["EntityType", "EntitySet", "PropertyTypeInEntitySet", "Datasource", "ComplexType", "LinkingEntityType", "AssociationType", "Organization", "App", "AppType", "Principal", "Role", "UnknownEdmTemplate"] + if @api_client.config.client_side_validation && opts[:'object_type'] && !allowable_values.include?(opts[:'object_type']) + fail ArgumentError, "invalid value for \"object_type\", must be one of #{allowable_values}" + end + allowable_values = ["DISCOVER", "MATERIALIZE", "LINK", "READ", "WRITE", "OWNER"] + if @api_client.config.client_side_validation && opts[:'permission'] && !allowable_values.include?(opts[:'permission']) + fail ArgumentError, "invalid value for \"permission\", must be one of #{allowable_values}" + end + # resource path + local_var_path = '/datastore/authorizations' + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'objectType'] = opts[:'object_type'] if !opts[:'object_type'].nil? + query_params[:'permission'] = opts[:'permission'] if !opts[:'permission'].nil? + query_params[:'pagingToken'] = opts[:'paging_token'] if !opts[:'paging_token'].nil? + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'AuthorizedObjectsSearchResult' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: AuthorizationsApi#get_accessible_objects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + end +end diff --git a/ruby/lib/openapi_client/api/collections_api.rb b/ruby/lib/openapi_client/api/collections_api.rb new file mode 100644 index 0000000..fca86fd --- /dev/null +++ b/ruby/lib/openapi_client/api/collections_api.rb @@ -0,0 +1,878 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'cgi' + +module OpenapiClient + class CollectionsApi + attr_accessor :api_client + + def initialize(api_client = ApiClient.default) + @api_client = api_client + end + # Appends type to template of the specified EntityTypeCollection + # @param entity_type_collection_id [String] + # @param collection_template_type [CollectionTemplateType] + # @param [Hash] opts the optional parameters + # @return [nil] + def add_type_to_entity_type_collection_template(entity_type_collection_id, collection_template_type, opts = {}) + add_type_to_entity_type_collection_template_with_http_info(entity_type_collection_id, collection_template_type, opts) + nil + end + + # Appends type to template of the specified EntityTypeCollection + # @param entity_type_collection_id [String] + # @param collection_template_type [CollectionTemplateType] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def add_type_to_entity_type_collection_template_with_http_info(entity_type_collection_id, collection_template_type, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: CollectionsApi.add_type_to_entity_type_collection_template ...' + end + # verify the required parameter 'entity_type_collection_id' is set + if @api_client.config.client_side_validation && entity_type_collection_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_collection_id' when calling CollectionsApi.add_type_to_entity_type_collection_template" + end + # verify the required parameter 'collection_template_type' is set + if @api_client.config.client_side_validation && collection_template_type.nil? + fail ArgumentError, "Missing the required parameter 'collection_template_type' when calling CollectionsApi.add_type_to_entity_type_collection_template" + end + # resource path + local_var_path = '/datastore/collections/entity/type/{entityTypeCollectionId}/template'.sub('{' + 'entityTypeCollectionId' + '}', CGI.escape(entity_type_collection_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(collection_template_type) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionsApi#add_type_to_entity_type_collection_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Creates a new EntitySetCollection + # @param entity_set_collection [EntitySetCollection] + # @param [Hash] opts the optional parameters + # @return [String] + def create_entity_set_collection(entity_set_collection, opts = {}) + data, _status_code, _headers = create_entity_set_collection_with_http_info(entity_set_collection, opts) + data + end + + # Creates a new EntitySetCollection + # @param entity_set_collection [EntitySetCollection] + # @param [Hash] opts the optional parameters + # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers + def create_entity_set_collection_with_http_info(entity_set_collection, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: CollectionsApi.create_entity_set_collection ...' + end + # verify the required parameter 'entity_set_collection' is set + if @api_client.config.client_side_validation && entity_set_collection.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_collection' when calling CollectionsApi.create_entity_set_collection" + end + # resource path + local_var_path = '/datastore/collections/entity/set' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(entity_set_collection) + + # return_type + return_type = opts[:return_type] || 'String' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionsApi#create_entity_set_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Creates a new EntityTypeCollection + # @param entity_type_collection [EntityTypeCollection] + # @param [Hash] opts the optional parameters + # @return [String] + def create_entity_type_collection(entity_type_collection, opts = {}) + data, _status_code, _headers = create_entity_type_collection_with_http_info(entity_type_collection, opts) + data + end + + # Creates a new EntityTypeCollection + # @param entity_type_collection [EntityTypeCollection] + # @param [Hash] opts the optional parameters + # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers + def create_entity_type_collection_with_http_info(entity_type_collection, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: CollectionsApi.create_entity_type_collection ...' + end + # verify the required parameter 'entity_type_collection' is set + if @api_client.config.client_side_validation && entity_type_collection.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_collection' when calling CollectionsApi.create_entity_type_collection" + end + # resource path + local_var_path = '/datastore/collections/entity/type' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(entity_type_collection) + + # return_type + return_type = opts[:return_type] || 'String' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionsApi#create_entity_type_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Deletes the specified EntitySetCollection + # @param entity_set_collection_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_entity_set_collection(entity_set_collection_id, opts = {}) + delete_entity_set_collection_with_http_info(entity_set_collection_id, opts) + nil + end + + # Deletes the specified EntitySetCollection + # @param entity_set_collection_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def delete_entity_set_collection_with_http_info(entity_set_collection_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: CollectionsApi.delete_entity_set_collection ...' + end + # verify the required parameter 'entity_set_collection_id' is set + if @api_client.config.client_side_validation && entity_set_collection_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_collection_id' when calling CollectionsApi.delete_entity_set_collection" + end + # resource path + local_var_path = '/datastore/collections/entity/set/{entitySetCollectionId}'.sub('{' + 'entitySetCollectionId' + '}', CGI.escape(entity_set_collection_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionsApi#delete_entity_set_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Deletes the specified EntityTypeCollection + # @param entity_type_collection_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_entity_type_collection(entity_type_collection_id, opts = {}) + delete_entity_type_collection_with_http_info(entity_type_collection_id, opts) + nil + end + + # Deletes the specified EntityTypeCollection + # @param entity_type_collection_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def delete_entity_type_collection_with_http_info(entity_type_collection_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: CollectionsApi.delete_entity_type_collection ...' + end + # verify the required parameter 'entity_type_collection_id' is set + if @api_client.config.client_side_validation && entity_type_collection_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_collection_id' when calling CollectionsApi.delete_entity_type_collection" + end + # resource path + local_var_path = '/datastore/collections/entity/type/{entityTypeCollectionId}'.sub('{' + 'entityTypeCollectionId' + '}', CGI.escape(entity_type_collection_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionsApi#delete_entity_type_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Returns all EntitySetCollection objects + # @param [Hash] opts the optional parameters + # @return [Array] + def get_all_entity_set_collections(opts = {}) + data, _status_code, _headers = get_all_entity_set_collections_with_http_info(opts) + data + end + + # Returns all EntitySetCollection objects + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_all_entity_set_collections_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: CollectionsApi.get_all_entity_set_collections ...' + end + # resource path + local_var_path = '/datastore/collections/entity/set' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionsApi#get_all_entity_set_collections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Returns all EntityTypeCollection objects + # @param [Hash] opts the optional parameters + # @return [Array] + def get_all_entity_type_collections(opts = {}) + data, _status_code, _headers = get_all_entity_type_collections_with_http_info(opts) + data + end + + # Returns all EntityTypeCollection objects + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_all_entity_type_collections_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: CollectionsApi.get_all_entity_type_collections ...' + end + # resource path + local_var_path = '/datastore/collections/entity/type' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionsApi#get_all_entity_type_collections\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Returns the EntitySetCollection object for a given id + # @param entity_set_collection_id [String] + # @param [Hash] opts the optional parameters + # @return [EntitySetCollection] + def get_entity_set_collection(entity_set_collection_id, opts = {}) + data, _status_code, _headers = get_entity_set_collection_with_http_info(entity_set_collection_id, opts) + data + end + + # Returns the EntitySetCollection object for a given id + # @param entity_set_collection_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(EntitySetCollection, Integer, Hash)>] EntitySetCollection data, response status code and response headers + def get_entity_set_collection_with_http_info(entity_set_collection_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: CollectionsApi.get_entity_set_collection ...' + end + # verify the required parameter 'entity_set_collection_id' is set + if @api_client.config.client_side_validation && entity_set_collection_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_collection_id' when calling CollectionsApi.get_entity_set_collection" + end + # resource path + local_var_path = '/datastore/collections/entity/set/{entitySetCollectionId}'.sub('{' + 'entitySetCollectionId' + '}', CGI.escape(entity_set_collection_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'EntitySetCollection' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionsApi#get_entity_set_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Returns all authorized EntitySetCollections for a given EntityTypeCollection id + # @param entity_set_collection_id [String] + # @param [Hash] opts the optional parameters + # @return [Array] + def get_entity_set_collections_of_type(entity_set_collection_id, opts = {}) + data, _status_code, _headers = get_entity_set_collections_of_type_with_http_info(entity_set_collection_id, opts) + data + end + + # Returns all authorized EntitySetCollections for a given EntityTypeCollection id + # @param entity_set_collection_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_entity_set_collections_of_type_with_http_info(entity_set_collection_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: CollectionsApi.get_entity_set_collections_of_type ...' + end + # verify the required parameter 'entity_set_collection_id' is set + if @api_client.config.client_side_validation && entity_set_collection_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_collection_id' when calling CollectionsApi.get_entity_set_collections_of_type" + end + # resource path + local_var_path = '/datastore/collections/entity/set/entity/type/{entitySetCollectionId}'.sub('{' + 'entitySetCollectionId' + '}', CGI.escape(entity_set_collection_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionsApi#get_entity_set_collections_of_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Returns the EntityTypeCollection object for a given id + # @param entity_type_collection_id [String] + # @param [Hash] opts the optional parameters + # @return [EntityTypeCollection] + def get_entity_type_collection(entity_type_collection_id, opts = {}) + data, _status_code, _headers = get_entity_type_collection_with_http_info(entity_type_collection_id, opts) + data + end + + # Returns the EntityTypeCollection object for a given id + # @param entity_type_collection_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(EntityTypeCollection, Integer, Hash)>] EntityTypeCollection data, response status code and response headers + def get_entity_type_collection_with_http_info(entity_type_collection_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: CollectionsApi.get_entity_type_collection ...' + end + # verify the required parameter 'entity_type_collection_id' is set + if @api_client.config.client_side_validation && entity_type_collection_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_collection_id' when calling CollectionsApi.get_entity_type_collection" + end + # resource path + local_var_path = '/datastore/collections/entity/type/{entityTypeCollectionId}'.sub('{' + 'entityTypeCollectionId' + '}', CGI.escape(entity_type_collection_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'EntityTypeCollection' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionsApi#get_entity_type_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Removes a key from an EntityTypeCollection template + # @param entity_type_collection_id [String] + # @param type_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def remove_type_from_entity_type_collection_template(entity_type_collection_id, type_id, opts = {}) + remove_type_from_entity_type_collection_template_with_http_info(entity_type_collection_id, type_id, opts) + nil + end + + # Removes a key from an EntityTypeCollection template + # @param entity_type_collection_id [String] + # @param type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def remove_type_from_entity_type_collection_template_with_http_info(entity_type_collection_id, type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: CollectionsApi.remove_type_from_entity_type_collection_template ...' + end + # verify the required parameter 'entity_type_collection_id' is set + if @api_client.config.client_side_validation && entity_type_collection_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_collection_id' when calling CollectionsApi.remove_type_from_entity_type_collection_template" + end + # verify the required parameter 'type_id' is set + if @api_client.config.client_side_validation && type_id.nil? + fail ArgumentError, "Missing the required parameter 'type_id' when calling CollectionsApi.remove_type_from_entity_type_collection_template" + end + # resource path + local_var_path = '/datastore/collections/entity/type/{entityTypeCollectionId}/template/{typeId}'.sub('{' + 'entityTypeCollectionId' + '}', CGI.escape(entity_type_collection_id.to_s)).sub('{' + 'typeId' + '}', CGI.escape(type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionsApi#remove_type_from_entity_type_collection_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates metadata of the specified EntitySetCollection + # @param entity_set_collection_id [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [nil] + def update_entity_set_collection_metadata(entity_set_collection_id, metadata_update, opts = {}) + update_entity_set_collection_metadata_with_http_info(entity_set_collection_id, metadata_update, opts) + nil + end + + # Updates metadata of the specified EntitySetCollection + # @param entity_set_collection_id [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def update_entity_set_collection_metadata_with_http_info(entity_set_collection_id, metadata_update, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: CollectionsApi.update_entity_set_collection_metadata ...' + end + # verify the required parameter 'entity_set_collection_id' is set + if @api_client.config.client_side_validation && entity_set_collection_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_collection_id' when calling CollectionsApi.update_entity_set_collection_metadata" + end + # verify the required parameter 'metadata_update' is set + if @api_client.config.client_side_validation && metadata_update.nil? + fail ArgumentError, "Missing the required parameter 'metadata_update' when calling CollectionsApi.update_entity_set_collection_metadata" + end + # resource path + local_var_path = '/datastore/collections/entity/set/{entitySetCollectionId}'.sub('{' + 'entitySetCollectionId' + '}', CGI.escape(entity_set_collection_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(metadata_update) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionsApi#update_entity_set_collection_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates template of the specified EntitySetCollection + # @param entity_set_collection_id [String] + # @param request_body [Hash] + # @param [Hash] opts the optional parameters + # @return [nil] + def update_entity_set_collection_template(entity_set_collection_id, request_body, opts = {}) + update_entity_set_collection_template_with_http_info(entity_set_collection_id, request_body, opts) + nil + end + + # Updates template of the specified EntitySetCollection + # @param entity_set_collection_id [String] + # @param request_body [Hash] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def update_entity_set_collection_template_with_http_info(entity_set_collection_id, request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: CollectionsApi.update_entity_set_collection_template ...' + end + # verify the required parameter 'entity_set_collection_id' is set + if @api_client.config.client_side_validation && entity_set_collection_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_collection_id' when calling CollectionsApi.update_entity_set_collection_template" + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling CollectionsApi.update_entity_set_collection_template" + end + # resource path + local_var_path = '/datastore/collections/entity/set/{entitySetCollectionId}/template'.sub('{' + 'entitySetCollectionId' + '}', CGI.escape(entity_set_collection_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionsApi#update_entity_set_collection_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates metadata of the specified EntityTypeCollection + # @param entity_type_collection_id [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [nil] + def update_entity_type_collection_metadata(entity_type_collection_id, metadata_update, opts = {}) + update_entity_type_collection_metadata_with_http_info(entity_type_collection_id, metadata_update, opts) + nil + end + + # Updates metadata of the specified EntityTypeCollection + # @param entity_type_collection_id [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def update_entity_type_collection_metadata_with_http_info(entity_type_collection_id, metadata_update, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: CollectionsApi.update_entity_type_collection_metadata ...' + end + # verify the required parameter 'entity_type_collection_id' is set + if @api_client.config.client_side_validation && entity_type_collection_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_collection_id' when calling CollectionsApi.update_entity_type_collection_metadata" + end + # verify the required parameter 'metadata_update' is set + if @api_client.config.client_side_validation && metadata_update.nil? + fail ArgumentError, "Missing the required parameter 'metadata_update' when calling CollectionsApi.update_entity_type_collection_metadata" + end + # resource path + local_var_path = '/datastore/collections/entity/type/{entityTypeCollectionId}'.sub('{' + 'entityTypeCollectionId' + '}', CGI.escape(entity_type_collection_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(metadata_update) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: CollectionsApi#update_entity_type_collection_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + end +end diff --git a/ruby/lib/openapi_client/api/data_api.rb b/ruby/lib/openapi_client/api/data_api.rb new file mode 100644 index 0000000..e4e2faf --- /dev/null +++ b/ruby/lib/openapi_client/api/data_api.rb @@ -0,0 +1,1278 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'cgi' + +module OpenapiClient + class DataApi + attr_accessor :api_client + + def initialize(api_client = ApiClient.default) + @api_client = api_client + end + # Creates a new set of associations. + # @param inline_object [InlineObject] + # @param [Hash] opts the optional parameters + # @return [Hash>] + def create_associations(inline_object, opts = {}) + data, _status_code, _headers = create_associations_with_http_info(inline_object, opts) + data + end + + # Creates a new set of associations. + # @param inline_object [InlineObject] + # @param [Hash] opts the optional parameters + # @return [Array<(Hash>, Integer, Hash)>] Hash> data, response status code and response headers + def create_associations_with_http_info(inline_object, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataApi.create_associations ...' + end + # verify the required parameter 'inline_object' is set + if @api_client.config.client_side_validation && inline_object.nil? + fail ArgumentError, "Missing the required parameter 'inline_object' when calling DataApi.create_associations" + end + # resource path + local_var_path = '/datastore/data/association' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(inline_object) + + # return_type + return_type = opts[:return_type] || 'Hash>' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataApi#create_associations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Creates a new set of associations. + # @param data_edge_key [Array] + # @param [Hash] opts the optional parameters + # @return [Integer] + def create_edges(data_edge_key, opts = {}) + data, _status_code, _headers = create_edges_with_http_info(data_edge_key, opts) + data + end + + # Creates a new set of associations. + # @param data_edge_key [Array] + # @param [Hash] opts the optional parameters + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def create_edges_with_http_info(data_edge_key, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataApi.create_edges ...' + end + # verify the required parameter 'data_edge_key' is set + if @api_client.config.client_side_validation && data_edge_key.nil? + fail ArgumentError, "Missing the required parameter 'data_edge_key' when calling DataApi.create_edges" + end + # resource path + local_var_path = '/datastore/data/association' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(data_edge_key) + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataApi#create_edges\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Creates a new set of entities. + # @param set_id [String] + # @param request_body [Array>>] + # @param [Hash] opts the optional parameters + # @return [Array] + def create_entities(set_id, request_body, opts = {}) + data, _status_code, _headers = create_entities_with_http_info(set_id, request_body, opts) + data + end + + # Creates a new set of entities. + # @param set_id [String] + # @param request_body [Array>>] + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def create_entities_with_http_info(set_id, request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataApi.create_entities ...' + end + # verify the required parameter 'set_id' is set + if @api_client.config.client_side_validation && set_id.nil? + fail ArgumentError, "Missing the required parameter 'set_id' when calling DataApi.create_entities" + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling DataApi.create_entities" + end + # resource path + local_var_path = '/datastore/data/set/' + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'setId'] = set_id + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataApi#create_entities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Creates entities and assocations + # @param data_graph [DataGraph] + # @param [Hash] opts the optional parameters + # @return [DataGraphIds] + def create_entity_and_association_data(data_graph, opts = {}) + data, _status_code, _headers = create_entity_and_association_data_with_http_info(data_graph, opts) + data + end + + # Creates entities and assocations + # @param data_graph [DataGraph] + # @param [Hash] opts the optional parameters + # @return [Array<(DataGraphIds, Integer, Hash)>] DataGraphIds data, response status code and response headers + def create_entity_and_association_data_with_http_info(data_graph, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataApi.create_entity_and_association_data ...' + end + # verify the required parameter 'data_graph' is set + if @api_client.config.client_side_validation && data_graph.nil? + fail ArgumentError, "Missing the required parameter 'data_graph' when calling DataApi.create_entity_and_association_data" + end + # resource path + local_var_path = '/datastore/data' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(data_graph) + + # return_type + return_type = opts[:return_type] || 'DataGraphIds' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataApi#create_entity_and_association_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Clears the Entity matching the given Entity id and all of its neighbor Entities + # @param entity_set_id [String] + # @param type [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_all_entities_from_entity_set(entity_set_id, type, opts = {}) + delete_all_entities_from_entity_set_with_http_info(entity_set_id, type, opts) + nil + end + + # Clears the Entity matching the given Entity id and all of its neighbor Entities + # @param entity_set_id [String] + # @param type [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def delete_all_entities_from_entity_set_with_http_info(entity_set_id, type, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataApi.delete_all_entities_from_entity_set ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling DataApi.delete_all_entities_from_entity_set" + end + # verify the required parameter 'type' is set + if @api_client.config.client_side_validation && type.nil? + fail ArgumentError, "Missing the required parameter 'type' when calling DataApi.delete_all_entities_from_entity_set" + end + # verify enum value + allowable_values = ["Soft", "Hard"] + if @api_client.config.client_side_validation && !allowable_values.include?(type) + fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}" + end + # resource path + local_var_path = '/datastore/data/set/{entitySetId}/all'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'type'] = type + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataApi#delete_all_entities_from_entity_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Deletes multiple entities from an entity set. + # @param entity_set_id [String] + # @param type [String] + # @param request_body [Array] + # @param [Hash] opts the optional parameters + # @return [Integer] + def delete_entities(entity_set_id, type, request_body, opts = {}) + data, _status_code, _headers = delete_entities_with_http_info(entity_set_id, type, request_body, opts) + data + end + + # Deletes multiple entities from an entity set. + # @param entity_set_id [String] + # @param type [String] + # @param request_body [Array] + # @param [Hash] opts the optional parameters + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def delete_entities_with_http_info(entity_set_id, type, request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataApi.delete_entities ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling DataApi.delete_entities" + end + # verify the required parameter 'type' is set + if @api_client.config.client_side_validation && type.nil? + fail ArgumentError, "Missing the required parameter 'type' when calling DataApi.delete_entities" + end + # verify enum value + allowable_values = ["Soft", "Hard"] + if @api_client.config.client_side_validation && !allowable_values.include?(type) + fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}" + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling DataApi.delete_entities" + end + # resource path + local_var_path = '/datastore/data/set/{entitySetId}'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'type'] = type + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataApi#delete_entities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Deletes the entities matching the given entity ids and all of its neighbor entities provided in the filter. + # @param entity_set_id [String] + # @param type [String] + # @param entity_neighbors_filter [Array] + # @param [Hash] opts the optional parameters + # @return [Integer] + def delete_entities_and_neighbors(entity_set_id, type, entity_neighbors_filter, opts = {}) + data, _status_code, _headers = delete_entities_and_neighbors_with_http_info(entity_set_id, type, entity_neighbors_filter, opts) + data + end + + # Deletes the entities matching the given entity ids and all of its neighbor entities provided in the filter. + # @param entity_set_id [String] + # @param type [String] + # @param entity_neighbors_filter [Array] + # @param [Hash] opts the optional parameters + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def delete_entities_and_neighbors_with_http_info(entity_set_id, type, entity_neighbors_filter, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataApi.delete_entities_and_neighbors ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling DataApi.delete_entities_and_neighbors" + end + # verify the required parameter 'type' is set + if @api_client.config.client_side_validation && type.nil? + fail ArgumentError, "Missing the required parameter 'type' when calling DataApi.delete_entities_and_neighbors" + end + # verify enum value + allowable_values = ["Soft", "Hard"] + if @api_client.config.client_side_validation && !allowable_values.include?(type) + fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}" + end + # verify the required parameter 'entity_neighbors_filter' is set + if @api_client.config.client_side_validation && entity_neighbors_filter.nil? + fail ArgumentError, "Missing the required parameter 'entity_neighbors_filter' when calling DataApi.delete_entities_and_neighbors" + end + # resource path + local_var_path = '/datastore/data/set/{entitySetId}/neighbors'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'type'] = type + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(entity_neighbors_filter) + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataApi#delete_entities_and_neighbors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Deletes a single entity from an entity set. + # @param entity_set_id [String] + # @param entity_key_id [String] + # @param type [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_entity(entity_set_id, entity_key_id, type, opts = {}) + delete_entity_with_http_info(entity_set_id, entity_key_id, type, opts) + nil + end + + # Deletes a single entity from an entity set. + # @param entity_set_id [String] + # @param entity_key_id [String] + # @param type [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def delete_entity_with_http_info(entity_set_id, entity_key_id, type, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataApi.delete_entity ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling DataApi.delete_entity" + end + # verify the required parameter 'entity_key_id' is set + if @api_client.config.client_side_validation && entity_key_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_key_id' when calling DataApi.delete_entity" + end + # verify the required parameter 'type' is set + if @api_client.config.client_side_validation && type.nil? + fail ArgumentError, "Missing the required parameter 'type' when calling DataApi.delete_entity" + end + # verify enum value + allowable_values = ["Soft", "Hard"] + if @api_client.config.client_side_validation && !allowable_values.include?(type) + fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}" + end + # resource path + local_var_path = '/datastore/data/set/{entitySetId}/{entityKeyId}'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)).sub('{' + 'entityKeyId' + '}', CGI.escape(entity_key_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'type'] = type + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataApi#delete_entity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Deletes properties from an entity. + # @param entity_set_id [String] + # @param entity_key_id [String] + # @param type [String] + # @param request_body [Array] + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_entity_properties(entity_set_id, entity_key_id, type, request_body, opts = {}) + delete_entity_properties_with_http_info(entity_set_id, entity_key_id, type, request_body, opts) + nil + end + + # Deletes properties from an entity. + # @param entity_set_id [String] + # @param entity_key_id [String] + # @param type [String] + # @param request_body [Array] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def delete_entity_properties_with_http_info(entity_set_id, entity_key_id, type, request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataApi.delete_entity_properties ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling DataApi.delete_entity_properties" + end + # verify the required parameter 'entity_key_id' is set + if @api_client.config.client_side_validation && entity_key_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_key_id' when calling DataApi.delete_entity_properties" + end + # verify the required parameter 'type' is set + if @api_client.config.client_side_validation && type.nil? + fail ArgumentError, "Missing the required parameter 'type' when calling DataApi.delete_entity_properties" + end + # verify enum value + allowable_values = ["Soft", "Hard"] + if @api_client.config.client_side_validation && !allowable_values.include?(type) + fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}" + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling DataApi.delete_entity_properties" + end + # resource path + local_var_path = '/datastore/data/{entitySetId}/{entityKeyId}/properties'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)).sub('{' + 'entityKeyId' + '}', CGI.escape(entity_key_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'type'] = type + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataApi#delete_entity_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Loads a single entity by its entityKeyId and entitySetId + # @param entity_set_id [String] + # @param entity_key_id [String] + # @param [Hash] opts the optional parameters + # @return [Hash>] + def get_entity(entity_set_id, entity_key_id, opts = {}) + data, _status_code, _headers = get_entity_with_http_info(entity_set_id, entity_key_id, opts) + data + end + + # Loads a single entity by its entityKeyId and entitySetId + # @param entity_set_id [String] + # @param entity_key_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Hash>, Integer, Hash)>] Hash> data, response status code and response headers + def get_entity_with_http_info(entity_set_id, entity_key_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataApi.get_entity ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling DataApi.get_entity" + end + # verify the required parameter 'entity_key_id' is set + if @api_client.config.client_side_validation && entity_key_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_key_id' when calling DataApi.get_entity" + end + # resource path + local_var_path = '/datastore/data/{entitySetId}/{entityKeyId}'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)).sub('{' + 'entityKeyId' + '}', CGI.escape(entity_key_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Hash>' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataApi#get_entity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Loads property values for a single entity by its entityKeyId, entitySetId and propertyTypeId + # @param entity_set_id [String] + # @param entity_key_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array] + def get_entity_property_values(entity_set_id, entity_key_id, property_type_id, opts = {}) + data, _status_code, _headers = get_entity_property_values_with_http_info(entity_set_id, entity_key_id, property_type_id, opts) + data + end + + # Loads property values for a single entity by its entityKeyId, entitySetId and propertyTypeId + # @param entity_set_id [String] + # @param entity_key_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_entity_property_values_with_http_info(entity_set_id, entity_key_id, property_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataApi.get_entity_property_values ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling DataApi.get_entity_property_values" + end + # verify the required parameter 'entity_key_id' is set + if @api_client.config.client_side_validation && entity_key_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_key_id' when calling DataApi.get_entity_property_values" + end + # verify the required parameter 'property_type_id' is set + if @api_client.config.client_side_validation && property_type_id.nil? + fail ArgumentError, "Missing the required parameter 'property_type_id' when calling DataApi.get_entity_property_values" + end + # resource path + local_var_path = '/datastore/data/{entitySetId}/{entityKeyId}/{propertyTypeId}'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)).sub('{' + 'entityKeyId' + '}', CGI.escape(entity_key_id.to_s)).sub('{' + 'propertyTypeId' + '}', CGI.escape(property_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataApi#get_entity_property_values\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets the number of entities in an entity set. + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [Integer] + def get_entity_set_size(entity_set_id, opts = {}) + data, _status_code, _headers = get_entity_set_size_with_http_info(entity_set_id, opts) + data + end + + # Gets the number of entities in an entity set. + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def get_entity_set_size_with_http_info(entity_set_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataApi.get_entity_set_size ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling DataApi.get_entity_set_size" + end + # resource path + local_var_path = '/datastore/data/{entitySetId}/count'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataApi#get_entity_set_size\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets an iterable containing the entity data, using property type FQNs as key + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [Array>>] + def load_entity_set_data(entity_set_id, opts = {}) + data, _status_code, _headers = load_entity_set_data_with_http_info(entity_set_id, opts) + data + end + + # Gets an iterable containing the entity data, using property type FQNs as key + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Array>>, Integer, Hash)>] Array>> data, response status code and response headers + def load_entity_set_data_with_http_info(entity_set_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataApi.load_entity_set_data ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling DataApi.load_entity_set_data" + end + # resource path + local_var_path = '/datastore/data/set/{entitySetId}'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array>>' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataApi#load_entity_set_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Loads a linked entity set breakdown with the selected linked entities and properties. + # @param linked_entity_set_id [String] + # @param entity_set_selection [Array] + # @param [Hash] opts the optional parameters + # @return [Hash>>>>] + def load_linked_entity_set_breakdown(linked_entity_set_id, entity_set_selection, opts = {}) + data, _status_code, _headers = load_linked_entity_set_breakdown_with_http_info(linked_entity_set_id, entity_set_selection, opts) + data + end + + # Loads a linked entity set breakdown with the selected linked entities and properties. + # @param linked_entity_set_id [String] + # @param entity_set_selection [Array] + # @param [Hash] opts the optional parameters + # @return [Array<(Hash>>>>, Integer, Hash)>] Hash>>>> data, response status code and response headers + def load_linked_entity_set_breakdown_with_http_info(linked_entity_set_id, entity_set_selection, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataApi.load_linked_entity_set_breakdown ...' + end + # verify the required parameter 'linked_entity_set_id' is set + if @api_client.config.client_side_validation && linked_entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'linked_entity_set_id' when calling DataApi.load_linked_entity_set_breakdown" + end + # verify the required parameter 'entity_set_selection' is set + if @api_client.config.client_side_validation && entity_set_selection.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_selection' when calling DataApi.load_linked_entity_set_breakdown" + end + # resource path + local_var_path = '/datastore/data/set/{linkedEntitySetId}/detailed'.sub('{' + 'linkedEntitySetId' + '}', CGI.escape(linked_entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(entity_set_selection) + + # return_type + return_type = opts[:return_type] || 'Hash>>>>' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataApi#load_linked_entity_set_breakdown\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets a list of entities by UUIDs + # @param entity_set_id [String] + # @param entity_set_selection [Array] + # @param [Hash] opts the optional parameters + # @return [Array>>] + def load_selected_entity_set_data(entity_set_id, entity_set_selection, opts = {}) + data, _status_code, _headers = load_selected_entity_set_data_with_http_info(entity_set_id, entity_set_selection, opts) + data + end + + # Gets a list of entities by UUIDs + # @param entity_set_id [String] + # @param entity_set_selection [Array] + # @param [Hash] opts the optional parameters + # @return [Array<(Array>>, Integer, Hash)>] Array>> data, response status code and response headers + def load_selected_entity_set_data_with_http_info(entity_set_id, entity_set_selection, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataApi.load_selected_entity_set_data ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling DataApi.load_selected_entity_set_data" + end + # verify the required parameter 'entity_set_selection' is set + if @api_client.config.client_side_validation && entity_set_selection.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_selection' when calling DataApi.load_selected_entity_set_data" + end + # resource path + local_var_path = '/datastore/data/set/{entitySetId}'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(entity_set_selection) + + # return_type + return_type = opts[:return_type] || 'Array>>' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataApi#load_selected_entity_set_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Replaces Association Data + # @param partial [Boolean] + # @param request_body [Hash>] + # @param [Hash] opts the optional parameters + # @return [Integer] + def replace_association_data(partial, request_body, opts = {}) + data, _status_code, _headers = replace_association_data_with_http_info(partial, request_body, opts) + data + end + + # Replaces Association Data + # @param partial [Boolean] + # @param request_body [Hash>] + # @param [Hash] opts the optional parameters + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def replace_association_data_with_http_info(partial, request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataApi.replace_association_data ...' + end + # verify the required parameter 'partial' is set + if @api_client.config.client_side_validation && partial.nil? + fail ArgumentError, "Missing the required parameter 'partial' when calling DataApi.replace_association_data" + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling DataApi.replace_association_data" + end + # resource path + local_var_path = '/datastore/data/association' + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'partial'] = partial + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataApi#replace_association_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Replaces Entity Properties + # @param entity_set_id [String] + # @param request_body [Hash>>>] + # @param [Hash] opts the optional parameters + # @return [Integer] + def replace_entity_properties(entity_set_id, request_body, opts = {}) + data, _status_code, _headers = replace_entity_properties_with_http_info(entity_set_id, request_body, opts) + data + end + + # Replaces Entity Properties + # @param entity_set_id [String] + # @param request_body [Hash>>>] + # @param [Hash] opts the optional parameters + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def replace_entity_properties_with_http_info(entity_set_id, request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataApi.replace_entity_properties ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling DataApi.replace_entity_properties" + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling DataApi.replace_entity_properties" + end + # resource path + local_var_path = '/datastore/data/set/{entitySetId}'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataApi#replace_entity_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Perform one of the following bulk update operations on entities (type = Merge) adds new properties without affecting existing data, (type = PartialReplace) replaces all values for supplied property types, but does not not affect other property types for an entity, (type = Replace) replaces all entity data with the supplied properties. + # @param entity_set_id [String] + # @param type [String] + # @param request_body [Hash>>] + # @param [Hash] opts the optional parameters + # @return [Integer] + def update_entities_in_entity_set(entity_set_id, type, request_body, opts = {}) + data, _status_code, _headers = update_entities_in_entity_set_with_http_info(entity_set_id, type, request_body, opts) + data + end + + # Perform one of the following bulk update operations on entities (type = Merge) adds new properties without affecting existing data, (type = PartialReplace) replaces all values for supplied property types, but does not not affect other property types for an entity, (type = Replace) replaces all entity data with the supplied properties. + # @param entity_set_id [String] + # @param type [String] + # @param request_body [Hash>>] + # @param [Hash] opts the optional parameters + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def update_entities_in_entity_set_with_http_info(entity_set_id, type, request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataApi.update_entities_in_entity_set ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling DataApi.update_entities_in_entity_set" + end + # verify the required parameter 'type' is set + if @api_client.config.client_side_validation && type.nil? + fail ArgumentError, "Missing the required parameter 'type' when calling DataApi.update_entities_in_entity_set" + end + # verify enum value + allowable_values = ["Merge", "Replace", "PartialReplace"] + if @api_client.config.client_side_validation && !allowable_values.include?(type) + fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}" + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling DataApi.update_entities_in_entity_set" + end + # resource path + local_var_path = '/datastore/data/set/{entitySetId}'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'type'] = type + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataApi#update_entities_in_entity_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + end +end diff --git a/ruby/lib/openapi_client/api/data_integrations_api.rb b/ruby/lib/openapi_client/api/data_integrations_api.rb new file mode 100644 index 0000000..8ac6466 --- /dev/null +++ b/ruby/lib/openapi_client/api/data_integrations_api.rb @@ -0,0 +1,153 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'cgi' + +module OpenapiClient + class DataIntegrationsApi + attr_accessor :api_client + + def initialize(api_client = ApiClient.default) + @api_client = api_client + end + # Get entity key IDs + # @param entity_key [Array] + # @param [Hash] opts the optional parameters + # @return [Array] + def get_entity_key_ids(entity_key, opts = {}) + data, _status_code, _headers = get_entity_key_ids_with_http_info(entity_key, opts) + data + end + + # Get entity key IDs + # @param entity_key [Array] + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_entity_key_ids_with_http_info(entity_key, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataIntegrationsApi.get_entity_key_ids ...' + end + # verify the required parameter 'entity_key' is set + if @api_client.config.client_side_validation && entity_key.nil? + fail ArgumentError, "Missing the required parameter 'entity_key' when calling DataIntegrationsApi.get_entity_key_ids" + end + # resource path + local_var_path = '/datastore/integration/entityKeyIds' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(entity_key) + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataIntegrationsApi#get_entity_key_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Integrate entity and association data + # @param detailed_results [Boolean] + # @param bulk_data_creation [BulkDataCreation] + # @param [Hash] opts the optional parameters + # @return [IntegrationResults] + def integrate_entity_and_association_data(detailed_results, bulk_data_creation, opts = {}) + data, _status_code, _headers = integrate_entity_and_association_data_with_http_info(detailed_results, bulk_data_creation, opts) + data + end + + # Integrate entity and association data + # @param detailed_results [Boolean] + # @param bulk_data_creation [BulkDataCreation] + # @param [Hash] opts the optional parameters + # @return [Array<(IntegrationResults, Integer, Hash)>] IntegrationResults data, response status code and response headers + def integrate_entity_and_association_data_with_http_info(detailed_results, bulk_data_creation, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DataIntegrationsApi.integrate_entity_and_association_data ...' + end + # verify the required parameter 'detailed_results' is set + if @api_client.config.client_side_validation && detailed_results.nil? + fail ArgumentError, "Missing the required parameter 'detailed_results' when calling DataIntegrationsApi.integrate_entity_and_association_data" + end + # verify the required parameter 'bulk_data_creation' is set + if @api_client.config.client_side_validation && bulk_data_creation.nil? + fail ArgumentError, "Missing the required parameter 'bulk_data_creation' when calling DataIntegrationsApi.integrate_entity_and_association_data" + end + # resource path + local_var_path = '/datastore/integration' + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'detailedResults'] = detailed_results + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(bulk_data_creation) + + # return_type + return_type = opts[:return_type] || 'IntegrationResults' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DataIntegrationsApi#integrate_entity_and_association_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + end +end diff --git a/ruby/lib/openapi_client/api/dataset_api.rb b/ruby/lib/openapi_client/api/dataset_api.rb new file mode 100644 index 0000000..7208918 --- /dev/null +++ b/ruby/lib/openapi_client/api/dataset_api.rb @@ -0,0 +1,831 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'cgi' + +module OpenapiClient + class DatasetApi + attr_accessor :api_client + + def initialize(api_client = ApiClient.default) + @api_client = api_client + end + # Deletes an OrganizationExternalDatabaseColumn object, which represents an organization's column in an external database. This deletes both the object and the column in the database. It is a hard delete. + # @param organization_id [String] + # @param table_name [String] + # @param column_name [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_external_database_column(organization_id, table_name, column_name, opts = {}) + delete_external_database_column_with_http_info(organization_id, table_name, column_name, opts) + nil + end + + # Deletes an OrganizationExternalDatabaseColumn object, which represents an organization's column in an external database. This deletes both the object and the column in the database. It is a hard delete. + # @param organization_id [String] + # @param table_name [String] + # @param column_name [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def delete_external_database_column_with_http_info(organization_id, table_name, column_name, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DatasetApi.delete_external_database_column ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling DatasetApi.delete_external_database_column" + end + # verify the required parameter 'table_name' is set + if @api_client.config.client_side_validation && table_name.nil? + fail ArgumentError, "Missing the required parameter 'table_name' when calling DatasetApi.delete_external_database_column" + end + # verify the required parameter 'column_name' is set + if @api_client.config.client_side_validation && column_name.nil? + fail ArgumentError, "Missing the required parameter 'column_name' when calling DatasetApi.delete_external_database_column" + end + # resource path + local_var_path = '/datastore/organization-database/{organizationId}/{tableName}/{columnName}/external-database-column'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'tableName' + '}', CGI.escape(table_name.to_s)).sub('{' + 'columnName' + '}', CGI.escape(column_name.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DatasetApi#delete_external_database_column\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Deletes multiple OrganizationExternalDatabaseColumn objects and the columns they represent within an organization's table in an external database. It is a hard delete + # @param organization_id [String] + # @param table_name [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_external_database_columns(organization_id, table_name, opts = {}) + delete_external_database_columns_with_http_info(organization_id, table_name, opts) + nil + end + + # Deletes multiple OrganizationExternalDatabaseColumn objects and the columns they represent within an organization's table in an external database. It is a hard delete + # @param organization_id [String] + # @param table_name [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def delete_external_database_columns_with_http_info(organization_id, table_name, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DatasetApi.delete_external_database_columns ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling DatasetApi.delete_external_database_columns" + end + # verify the required parameter 'table_name' is set + if @api_client.config.client_side_validation && table_name.nil? + fail ArgumentError, "Missing the required parameter 'table_name' when calling DatasetApi.delete_external_database_columns" + end + # resource path + local_var_path = '/datastore/organization-database/{organizationId}/{tableName}/external-database-column'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'tableName' + '}', CGI.escape(table_name.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DatasetApi#delete_external_database_columns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Deletes an OrganizationExternalDatabaseTable object, which represents an organization's table in an external database. This deletes both the object and the table in the database. It is a hard delete. + # @param organization_id [String] + # @param table_name [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_external_database_table(organization_id, table_name, opts = {}) + delete_external_database_table_with_http_info(organization_id, table_name, opts) + nil + end + + # Deletes an OrganizationExternalDatabaseTable object, which represents an organization's table in an external database. This deletes both the object and the table in the database. It is a hard delete. + # @param organization_id [String] + # @param table_name [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def delete_external_database_table_with_http_info(organization_id, table_name, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DatasetApi.delete_external_database_table ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling DatasetApi.delete_external_database_table" + end + # verify the required parameter 'table_name' is set + if @api_client.config.client_side_validation && table_name.nil? + fail ArgumentError, "Missing the required parameter 'table_name' when calling DatasetApi.delete_external_database_table" + end + # resource path + local_var_path = '/datastore/organization-database/{organizationId}/{tableName}/external-database-table'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'tableName' + '}', CGI.escape(table_name.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DatasetApi#delete_external_database_table\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Deletes multiple OrganizationExternalDatabaseTable objects and the tables they represent in the database. It is a hard delete. + # @param organization_id [String] + # @param request_body [Array] + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_external_database_tables(organization_id, request_body, opts = {}) + delete_external_database_tables_with_http_info(organization_id, request_body, opts) + nil + end + + # Deletes multiple OrganizationExternalDatabaseTable objects and the tables they represent in the database. It is a hard delete. + # @param organization_id [String] + # @param request_body [Array] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def delete_external_database_tables_with_http_info(organization_id, request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DatasetApi.delete_external_database_tables ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling DatasetApi.delete_external_database_tables" + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling DatasetApi.delete_external_database_tables" + end + # resource path + local_var_path = '/datastore/organization-database/{organizationId}/external-database-table'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DatasetApi#delete_external_database_tables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets a map of all OrganizationExternalDatabaseTable objects to OrganizationExternalDatabase columns that are contained within each table. + # @param organization_id [String] + # @param permission [String] + # @param [Hash] opts the optional parameters + # @return [Array] + def get_authorized_external_db_tables_with_column_metadata(organization_id, permission, opts = {}) + data, _status_code, _headers = get_authorized_external_db_tables_with_column_metadata_with_http_info(organization_id, permission, opts) + data + end + + # Gets a map of all OrganizationExternalDatabaseTable objects to OrganizationExternalDatabase columns that are contained within each table. + # @param organization_id [String] + # @param permission [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_authorized_external_db_tables_with_column_metadata_with_http_info(organization_id, permission, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DatasetApi.get_authorized_external_db_tables_with_column_metadata ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling DatasetApi.get_authorized_external_db_tables_with_column_metadata" + end + # verify the required parameter 'permission' is set + if @api_client.config.client_side_validation && permission.nil? + fail ArgumentError, "Missing the required parameter 'permission' when calling DatasetApi.get_authorized_external_db_tables_with_column_metadata" + end + # verify enum value + allowable_values = ["DISCOVER", "MATERIALIZE", "LINK", "READ", "WRITE", "OWNER"] + if @api_client.config.client_side_validation && !allowable_values.include?(permission) + fail ArgumentError, "invalid value for \"permission\", must be one of #{allowable_values}" + end + # resource path + local_var_path = '/datastore/organization-database/{organizationId}/{permission}/external-database-table/external-database-column/authorized'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'permission' + '}', CGI.escape(permission.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DatasetApi#get_authorized_external_db_tables_with_column_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets an OrganizationExternalDatabaseColumn object, which represents a column within an organization's table in an external database. + # @param organization_id [String] + # @param table_name [String] + # @param column_name [String] + # @param [Hash] opts the optional parameters + # @return [OrganizationExternalDatabaseColumn] + def get_external_database_column(organization_id, table_name, column_name, opts = {}) + data, _status_code, _headers = get_external_database_column_with_http_info(organization_id, table_name, column_name, opts) + data + end + + # Gets an OrganizationExternalDatabaseColumn object, which represents a column within an organization's table in an external database. + # @param organization_id [String] + # @param table_name [String] + # @param column_name [String] + # @param [Hash] opts the optional parameters + # @return [Array<(OrganizationExternalDatabaseColumn, Integer, Hash)>] OrganizationExternalDatabaseColumn data, response status code and response headers + def get_external_database_column_with_http_info(organization_id, table_name, column_name, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DatasetApi.get_external_database_column ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling DatasetApi.get_external_database_column" + end + # verify the required parameter 'table_name' is set + if @api_client.config.client_side_validation && table_name.nil? + fail ArgumentError, "Missing the required parameter 'table_name' when calling DatasetApi.get_external_database_column" + end + # verify the required parameter 'column_name' is set + if @api_client.config.client_side_validation && column_name.nil? + fail ArgumentError, "Missing the required parameter 'column_name' when calling DatasetApi.get_external_database_column" + end + # resource path + local_var_path = '/datastore/organization-database/{organizationId}/{tableName}/{columnName}/external-database-column'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'tableName' + '}', CGI.escape(table_name.to_s)).sub('{' + 'columnName' + '}', CGI.escape(column_name.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'OrganizationExternalDatabaseColumn' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DatasetApi#get_external_database_column\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets an OrganizationExternalDatabaseTable object, which represents an organization's table in an external database. + # @param organization_id [String] + # @param table_name [String] + # @param [Hash] opts the optional parameters + # @return [OrganizationExternalDatabaseTable] + def get_external_database_table(organization_id, table_name, opts = {}) + data, _status_code, _headers = get_external_database_table_with_http_info(organization_id, table_name, opts) + data + end + + # Gets an OrganizationExternalDatabaseTable object, which represents an organization's table in an external database. + # @param organization_id [String] + # @param table_name [String] + # @param [Hash] opts the optional parameters + # @return [Array<(OrganizationExternalDatabaseTable, Integer, Hash)>] OrganizationExternalDatabaseTable data, response status code and response headers + def get_external_database_table_with_http_info(organization_id, table_name, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DatasetApi.get_external_database_table ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling DatasetApi.get_external_database_table" + end + # verify the required parameter 'table_name' is set + if @api_client.config.client_side_validation && table_name.nil? + fail ArgumentError, "Missing the required parameter 'table_name' when calling DatasetApi.get_external_database_table" + end + # resource path + local_var_path = '/datastore/organization-database/{organizationId}/{tableName}/external-database-table'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'tableName' + '}', CGI.escape(table_name.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'OrganizationExternalDatabaseTable' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DatasetApi#get_external_database_table\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets an object containing an OrganizationExternalDatabaseTable object and its OrganizationExternalDatabase columns for an organization + # @param organization_id [String] + # @param table_id [String] + # @param [Hash] opts the optional parameters + # @return [OrganizationExternalDatabaseTableColumnsPair] + def get_external_database_table_with_column_metadata(organization_id, table_id, opts = {}) + data, _status_code, _headers = get_external_database_table_with_column_metadata_with_http_info(organization_id, table_id, opts) + data + end + + # Gets an object containing an OrganizationExternalDatabaseTable object and its OrganizationExternalDatabase columns for an organization + # @param organization_id [String] + # @param table_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(OrganizationExternalDatabaseTableColumnsPair, Integer, Hash)>] OrganizationExternalDatabaseTableColumnsPair data, response status code and response headers + def get_external_database_table_with_column_metadata_with_http_info(organization_id, table_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DatasetApi.get_external_database_table_with_column_metadata ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling DatasetApi.get_external_database_table_with_column_metadata" + end + # verify the required parameter 'table_id' is set + if @api_client.config.client_side_validation && table_id.nil? + fail ArgumentError, "Missing the required parameter 'table_id' when calling DatasetApi.get_external_database_table_with_column_metadata" + end + # resource path + local_var_path = '/datastore/organization-database/{organizationId}/{tableId}/external-database-table/external-database-column'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'tableId' + '}', CGI.escape(table_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'OrganizationExternalDatabaseTableColumnsPair' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DatasetApi#get_external_database_table_with_column_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets all OrganizationExternalDatabaseTable objects for an organization + # @param organization_id [String] + # @param [Hash] opts the optional parameters + # @return [Array] + def get_external_database_tables(organization_id, opts = {}) + data, _status_code, _headers = get_external_database_tables_with_http_info(organization_id, opts) + data + end + + # Gets all OrganizationExternalDatabaseTable objects for an organization + # @param organization_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_external_database_tables_with_http_info(organization_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DatasetApi.get_external_database_tables ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling DatasetApi.get_external_database_tables" + end + # resource path + local_var_path = '/datastore/organization-database/{organizationId}/external-database-table'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DatasetApi#get_external_database_tables\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets a map of all OrganizationExternalDatabaseTable objects to OrganizationExternalDatabase columns that are contained within each table. + # @param organization_id [String] + # @param [Hash] opts the optional parameters + # @return [Array] + def get_external_database_tables_with_column_metadata(organization_id, opts = {}) + data, _status_code, _headers = get_external_database_tables_with_column_metadata_with_http_info(organization_id, opts) + data + end + + # Gets a map of all OrganizationExternalDatabaseTable objects to OrganizationExternalDatabase columns that are contained within each table. + # @param organization_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_external_database_tables_with_column_metadata_with_http_info(organization_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DatasetApi.get_external_database_tables_with_column_metadata ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling DatasetApi.get_external_database_tables_with_column_metadata" + end + # resource path + local_var_path = '/datastore/organization-database/{organizationId}/external-database-table/external-database-column'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DatasetApi#get_external_database_tables_with_column_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates an OrganizationExternalDatabaseTableColumn object's fields that are included within the given metadata. + # @param organization_id [String] + # @param table_name [String] + # @param column_name [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [nil] + def update_external_database_column(organization_id, table_name, column_name, metadata_update, opts = {}) + update_external_database_column_with_http_info(organization_id, table_name, column_name, metadata_update, opts) + nil + end + + # Updates an OrganizationExternalDatabaseTableColumn object's fields that are included within the given metadata. + # @param organization_id [String] + # @param table_name [String] + # @param column_name [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def update_external_database_column_with_http_info(organization_id, table_name, column_name, metadata_update, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DatasetApi.update_external_database_column ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling DatasetApi.update_external_database_column" + end + # verify the required parameter 'table_name' is set + if @api_client.config.client_side_validation && table_name.nil? + fail ArgumentError, "Missing the required parameter 'table_name' when calling DatasetApi.update_external_database_column" + end + # verify the required parameter 'column_name' is set + if @api_client.config.client_side_validation && column_name.nil? + fail ArgumentError, "Missing the required parameter 'column_name' when calling DatasetApi.update_external_database_column" + end + # verify the required parameter 'metadata_update' is set + if @api_client.config.client_side_validation && metadata_update.nil? + fail ArgumentError, "Missing the required parameter 'metadata_update' when calling DatasetApi.update_external_database_column" + end + # resource path + local_var_path = '/datastore/organization-database/{organizationId}/{tableName}/{columnName}/external-database-column'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'tableName' + '}', CGI.escape(table_name.to_s)).sub('{' + 'columnName' + '}', CGI.escape(column_name.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(metadata_update) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DatasetApi#update_external_database_column\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates an OrganizationExternalDatabaseTable object's fields that are included within the given metadata. + # @param organization_id [String] + # @param table_name [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [nil] + def update_external_database_table(organization_id, table_name, metadata_update, opts = {}) + update_external_database_table_with_http_info(organization_id, table_name, metadata_update, opts) + nil + end + + # Updates an OrganizationExternalDatabaseTable object's fields that are included within the given metadata. + # @param organization_id [String] + # @param table_name [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def update_external_database_table_with_http_info(organization_id, table_name, metadata_update, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: DatasetApi.update_external_database_table ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling DatasetApi.update_external_database_table" + end + # verify the required parameter 'table_name' is set + if @api_client.config.client_side_validation && table_name.nil? + fail ArgumentError, "Missing the required parameter 'table_name' when calling DatasetApi.update_external_database_table" + end + # verify the required parameter 'metadata_update' is set + if @api_client.config.client_side_validation && metadata_update.nil? + fail ArgumentError, "Missing the required parameter 'metadata_update' when calling DatasetApi.update_external_database_table" + end + # resource path + local_var_path = '/datastore/organization-database/{organizationId}/{tableName}/external-database-table'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'tableName' + '}', CGI.escape(table_name.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(metadata_update) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: DatasetApi#update_external_database_table\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + end +end diff --git a/ruby/lib/openapi_client/api/edm_api.rb b/ruby/lib/openapi_client/api/edm_api.rb new file mode 100644 index 0000000..8632b03 --- /dev/null +++ b/ruby/lib/openapi_client/api/edm_api.rb @@ -0,0 +1,3779 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'cgi' + +module OpenapiClient + class EdmApi + attr_accessor :api_client + + def initialize(api_client = ApiClient.default) + @api_client = api_client + end + # Update the AssociationType dst entity types for the given AssociationType UUID by adding the given EntityType UUID. + # @param association_type_id [String] + # @param entity_type_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def add_dst_entity_type_to_association_type(association_type_id, entity_type_id, opts = {}) + add_dst_entity_type_to_association_type_with_http_info(association_type_id, entity_type_id, opts) + nil + end + + # Update the AssociationType dst entity types for the given AssociationType UUID by adding the given EntityType UUID. + # @param association_type_id [String] + # @param entity_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def add_dst_entity_type_to_association_type_with_http_info(association_type_id, entity_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.add_dst_entity_type_to_association_type ...' + end + # verify the required parameter 'association_type_id' is set + if @api_client.config.client_side_validation && association_type_id.nil? + fail ArgumentError, "Missing the required parameter 'association_type_id' when calling EdmApi.add_dst_entity_type_to_association_type" + end + # verify the required parameter 'entity_type_id' is set + if @api_client.config.client_side_validation && entity_type_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_id' when calling EdmApi.add_dst_entity_type_to_association_type" + end + # resource path + local_var_path = '/datastore/edm/association/type/{associationTypeId}/dst/{entityTypeId}'.sub('{' + 'associationTypeId' + '}', CGI.escape(association_type_id.to_s)).sub('{' + 'entityTypeId' + '}', CGI.escape(entity_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#add_dst_entity_type_to_association_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Adds the entity sets as linked entity sets to the linking entity set + # @param linking_entity_set_id [String] + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Integer] + def add_entity_sets_to_linking_entity_set(linking_entity_set_id, opts = {}) + data, _status_code, _headers = add_entity_sets_to_linking_entity_set_with_http_info(linking_entity_set_id, opts) + data + end + + # Adds the entity sets as linked entity sets to the linking entity set + # @param linking_entity_set_id [String] + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def add_entity_sets_to_linking_entity_set_with_http_info(linking_entity_set_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.add_entity_sets_to_linking_entity_set ...' + end + # verify the required parameter 'linking_entity_set_id' is set + if @api_client.config.client_side_validation && linking_entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'linking_entity_set_id' when calling EdmApi.add_entity_sets_to_linking_entity_set" + end + # resource path + local_var_path = '/datastore/entity-sets/linking/{linkingEntitySetId}'.sub('{' + 'linkingEntitySetId' + '}', CGI.escape(linking_entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(opts[:'request_body']) + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#add_entity_sets_to_linking_entity_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Adds the entity sets as linked entity sets to the linking entity sets + # @param linking_entity_set_id [String] + # @param request_body [Hash>] + # @param [Hash] opts the optional parameters + # @return [Integer] + def add_entity_sets_to_linking_entity_sets(linking_entity_set_id, request_body, opts = {}) + data, _status_code, _headers = add_entity_sets_to_linking_entity_sets_with_http_info(linking_entity_set_id, request_body, opts) + data + end + + # Adds the entity sets as linked entity sets to the linking entity sets + # @param linking_entity_set_id [String] + # @param request_body [Hash>] + # @param [Hash] opts the optional parameters + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def add_entity_sets_to_linking_entity_sets_with_http_info(linking_entity_set_id, request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.add_entity_sets_to_linking_entity_sets ...' + end + # verify the required parameter 'linking_entity_set_id' is set + if @api_client.config.client_side_validation && linking_entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'linking_entity_set_id' when calling EdmApi.add_entity_sets_to_linking_entity_sets" + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling EdmApi.add_entity_sets_to_linking_entity_sets" + end + # resource path + local_var_path = '/datastore/entity-sets/linking/'.sub('{' + 'linkingEntitySetId' + '}', CGI.escape(linking_entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#add_entity_sets_to_linking_entity_sets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Adds a primary key with a given ID to an entity type with a given ID. + # @param entity_type_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def add_primary_key_to_entity_type(entity_type_id, property_type_id, opts = {}) + add_primary_key_to_entity_type_with_http_info(entity_type_id, property_type_id, opts) + nil + end + + # Adds a primary key with a given ID to an entity type with a given ID. + # @param entity_type_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def add_primary_key_to_entity_type_with_http_info(entity_type_id, property_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.add_primary_key_to_entity_type ...' + end + # verify the required parameter 'entity_type_id' is set + if @api_client.config.client_side_validation && entity_type_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_id' when calling EdmApi.add_primary_key_to_entity_type" + end + # verify the required parameter 'property_type_id' is set + if @api_client.config.client_side_validation && property_type_id.nil? + fail ArgumentError, "Missing the required parameter 'property_type_id' when calling EdmApi.add_primary_key_to_entity_type" + end + # resource path + local_var_path = '/datastore/edm/entity/type/key/{entityTypeId}/{propertyTypeId}'.sub('{' + 'entityTypeId' + '}', CGI.escape(entity_type_id.to_s)).sub('{' + 'propertyTypeId' + '}', CGI.escape(property_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#add_primary_key_to_entity_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates the EntityType definition for the given EntityType UUID by adding the given PropertyType UUID. + # @param entity_type_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def add_property_type_to_entity_type(entity_type_id, property_type_id, opts = {}) + add_property_type_to_entity_type_with_http_info(entity_type_id, property_type_id, opts) + nil + end + + # Updates the EntityType definition for the given EntityType UUID by adding the given PropertyType UUID. + # @param entity_type_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def add_property_type_to_entity_type_with_http_info(entity_type_id, property_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.add_property_type_to_entity_type ...' + end + # verify the required parameter 'entity_type_id' is set + if @api_client.config.client_side_validation && entity_type_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_id' when calling EdmApi.add_property_type_to_entity_type" + end + # verify the required parameter 'property_type_id' is set + if @api_client.config.client_side_validation && property_type_id.nil? + fail ArgumentError, "Missing the required parameter 'property_type_id' when calling EdmApi.add_property_type_to_entity_type" + end + # resource path + local_var_path = '/datastore/edm/entity/type/{entityTypeId}/{propertyTypeId}'.sub('{' + 'entityTypeId' + '}', CGI.escape(entity_type_id.to_s)).sub('{' + 'propertyTypeId' + '}', CGI.escape(property_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#add_property_type_to_entity_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Update the AssociationType src entity types for the given AssociationType UUID by adding the given EntityType UUID. + # @param association_type_id [String] + # @param entity_type_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def add_src_entity_type_to_association_type(association_type_id, entity_type_id, opts = {}) + add_src_entity_type_to_association_type_with_http_info(association_type_id, entity_type_id, opts) + nil + end + + # Update the AssociationType src entity types for the given AssociationType UUID by adding the given EntityType UUID. + # @param association_type_id [String] + # @param entity_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def add_src_entity_type_to_association_type_with_http_info(association_type_id, entity_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.add_src_entity_type_to_association_type ...' + end + # verify the required parameter 'association_type_id' is set + if @api_client.config.client_side_validation && association_type_id.nil? + fail ArgumentError, "Missing the required parameter 'association_type_id' when calling EdmApi.add_src_entity_type_to_association_type" + end + # verify the required parameter 'entity_type_id' is set + if @api_client.config.client_side_validation && entity_type_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_id' when calling EdmApi.add_src_entity_type_to_association_type" + end + # resource path + local_var_path = '/datastore/edm/association/type/{associationTypeId}/src/{entityTypeId}'.sub('{' + 'associationTypeId' + '}', CGI.escape(association_type_id.to_s)).sub('{' + 'entityTypeId' + '}', CGI.escape(entity_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#add_src_entity_type_to_association_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Creates a new AssociationType definition, if it doesn't exist. + # @param association_type [Array] + # @param [Hash] opts the optional parameters + # @return [nil] + def create_association_type(association_type, opts = {}) + create_association_type_with_http_info(association_type, opts) + nil + end + + # Creates a new AssociationType definition, if it doesn't exist. + # @param association_type [Array] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def create_association_type_with_http_info(association_type, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.create_association_type ...' + end + # verify the required parameter 'association_type' is set + if @api_client.config.client_side_validation && association_type.nil? + fail ArgumentError, "Missing the required parameter 'association_type' when calling EdmApi.create_association_type" + end + # resource path + local_var_path = '/datastore/edm/association/type/' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(association_type) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || [] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#create_association_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Creates an empty schema, if it doesn't exist. If schema exists then no action is taken. + # @param namespace [String] + # @param name [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def create_empty_schema(namespace, name, opts = {}) + create_empty_schema_with_http_info(namespace, name, opts) + nil + end + + # Creates an empty schema, if it doesn't exist. If schema exists then no action is taken. + # @param namespace [String] + # @param name [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def create_empty_schema_with_http_info(namespace, name, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.create_empty_schema ...' + end + # verify the required parameter 'namespace' is set + if @api_client.config.client_side_validation && namespace.nil? + fail ArgumentError, "Missing the required parameter 'namespace' when calling EdmApi.create_empty_schema" + end + # verify the required parameter 'name' is set + if @api_client.config.client_side_validation && name.nil? + fail ArgumentError, "Missing the required parameter 'name' when calling EdmApi.create_empty_schema" + end + # resource path + local_var_path = '/datastore/edm/schema/{namespace}/{name}'.sub('{' + 'namespace' + '}', CGI.escape(namespace.to_s)).sub('{' + 'name' + '}', CGI.escape(name.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#create_empty_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Creates new EntitySet definitions if they don't exist. + # @param entity_set [Array] + # @param [Hash] opts the optional parameters + # @return [nil] + def create_entity_sets(entity_set, opts = {}) + create_entity_sets_with_http_info(entity_set, opts) + nil + end + + # Creates new EntitySet definitions if they don't exist. + # @param entity_set [Array] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def create_entity_sets_with_http_info(entity_set, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.create_entity_sets ...' + end + # verify the required parameter 'entity_set' is set + if @api_client.config.client_side_validation && entity_set.nil? + fail ArgumentError, "Missing the required parameter 'entity_set' when calling EdmApi.create_entity_sets" + end + # resource path + local_var_path = '/datastore/entity-sets' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(entity_set) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#create_entity_sets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Creates a new EntityType definition, if it doesn't exist. + # @param entity_type [EntityType] + # @param [Hash] opts the optional parameters + # @return [nil] + def create_entity_type(entity_type, opts = {}) + create_entity_type_with_http_info(entity_type, opts) + nil + end + + # Creates a new EntityType definition, if it doesn't exist. + # @param entity_type [EntityType] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def create_entity_type_with_http_info(entity_type, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.create_entity_type ...' + end + # verify the required parameter 'entity_type' is set + if @api_client.config.client_side_validation && entity_type.nil? + fail ArgumentError, "Missing the required parameter 'entity_type' when calling EdmApi.create_entity_type" + end + # resource path + local_var_path = '/datastore/edm/entity/type/' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(entity_type) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || [] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#create_entity_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Creates a new PropertyType definition, if it doesn\"t exist. + # @param property_type [PropertyType] + # @param [Hash] opts the optional parameters + # @return [nil] + def create_property_type(property_type, opts = {}) + create_property_type_with_http_info(property_type, opts) + nil + end + + # Creates a new PropertyType definition, if it doesn\"t exist. + # @param property_type [PropertyType] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def create_property_type_with_http_info(property_type, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.create_property_type ...' + end + # verify the required parameter 'property_type' is set + if @api_client.config.client_side_validation && property_type.nil? + fail ArgumentError, "Missing the required parameter 'property_type' when calling EdmApi.create_property_type" + end + # resource path + local_var_path = '/datastore/edm/property/type/' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(property_type) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#create_property_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Creates an empty schema, if it doesn't exist. If schema exists then no action is taken. + # @param schema [Schema] + # @param [Hash] opts the optional parameters + # @return [nil] + def create_schema_if_not_exists(schema, opts = {}) + create_schema_if_not_exists_with_http_info(schema, opts) + nil + end + + # Creates an empty schema, if it doesn't exist. If schema exists then no action is taken. + # @param schema [Schema] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def create_schema_if_not_exists_with_http_info(schema, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.create_schema_if_not_exists ...' + end + # verify the required parameter 'schema' is set + if @api_client.config.client_side_validation && schema.nil? + fail ArgumentError, "Missing the required parameter 'schema' when calling EdmApi.create_schema_if_not_exists" + end + # resource path + local_var_path = '/datastore/edm/schema' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(schema) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#create_schema_if_not_exists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Deletes the AssociationType definition for the given AssociationType UUID. + # @param association_type_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_association_type(association_type_id, opts = {}) + delete_association_type_with_http_info(association_type_id, opts) + nil + end + + # Deletes the AssociationType definition for the given AssociationType UUID. + # @param association_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def delete_association_type_with_http_info(association_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.delete_association_type ...' + end + # verify the required parameter 'association_type_id' is set + if @api_client.config.client_side_validation && association_type_id.nil? + fail ArgumentError, "Missing the required parameter 'association_type_id' when calling EdmApi.delete_association_type" + end + # resource path + local_var_path = '/datastore/edm/association/type/{associationTypeId}'.sub('{' + 'associationTypeId' + '}', CGI.escape(association_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || [] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#delete_association_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Deletes the EntitySet definition for the given EntitySet UUID. + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_entity_set(entity_set_id, opts = {}) + delete_entity_set_with_http_info(entity_set_id, opts) + nil + end + + # Deletes the EntitySet definition for the given EntitySet UUID. + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def delete_entity_set_with_http_info(entity_set_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.delete_entity_set ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling EdmApi.delete_entity_set" + end + # resource path + local_var_path = '/datastore/entity-sets/all/{entitySetId}'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#delete_entity_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Deletes the EntityType definition for the given EntityType UUID. + # @param entity_type_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_entity_type(entity_type_id, opts = {}) + delete_entity_type_with_http_info(entity_type_id, opts) + nil + end + + # Deletes the EntityType definition for the given EntityType UUID. + # @param entity_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def delete_entity_type_with_http_info(entity_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.delete_entity_type ...' + end + # verify the required parameter 'entity_type_id' is set + if @api_client.config.client_side_validation && entity_type_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_id' when calling EdmApi.delete_entity_type" + end + # resource path + local_var_path = '/datastore/edm/entity/type/{entityTypeId}'.sub('{' + 'entityTypeId' + '}', CGI.escape(entity_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || [] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#delete_entity_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Deletes the PropertyType definition for the given PropertyType UUID. + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_property_type(property_type_id, opts = {}) + delete_property_type_with_http_info(property_type_id, opts) + nil + end + + # Deletes the PropertyType definition for the given PropertyType UUID. + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def delete_property_type_with_http_info(property_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.delete_property_type ...' + end + # verify the required parameter 'property_type_id' is set + if @api_client.config.client_side_validation && property_type_id.nil? + fail ArgumentError, "Missing the required parameter 'property_type_id' when calling EdmApi.delete_property_type" + end + # resource path + local_var_path = '/datastore/edm/property/type/{propertyTypeId}'.sub('{' + 'propertyTypeId' + '}', CGI.escape(property_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#delete_property_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Deletes the PropertyType definition for the given PropertyType UUID regardless of whether or not there is data associated with it. + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def force_delete_property_type(property_type_id, opts = {}) + force_delete_property_type_with_http_info(property_type_id, opts) + nil + end + + # Deletes the PropertyType definition for the given PropertyType UUID regardless of whether or not there is data associated with it. + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def force_delete_property_type_with_http_info(property_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.force_delete_property_type ...' + end + # verify the required parameter 'property_type_id' is set + if @api_client.config.client_side_validation && property_type_id.nil? + fail ArgumentError, "Missing the required parameter 'property_type_id' when calling EdmApi.force_delete_property_type" + end + # resource path + local_var_path = '/datastore/edm/property/type/{propertyTypeId}/force'.sub('{' + 'propertyTypeId' + '}', CGI.escape(property_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#force_delete_property_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates the EntityType definition for the given EntityType UUID by removing the given PropertyType UUID, regardless of whether or not there is data associated with the entity type. + # @param entity_type_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def force_remove_property_type_from_entity_type(entity_type_id, property_type_id, opts = {}) + force_remove_property_type_from_entity_type_with_http_info(entity_type_id, property_type_id, opts) + nil + end + + # Updates the EntityType definition for the given EntityType UUID by removing the given PropertyType UUID, regardless of whether or not there is data associated with the entity type. + # @param entity_type_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def force_remove_property_type_from_entity_type_with_http_info(entity_type_id, property_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.force_remove_property_type_from_entity_type ...' + end + # verify the required parameter 'entity_type_id' is set + if @api_client.config.client_side_validation && entity_type_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_id' when calling EdmApi.force_remove_property_type_from_entity_type" + end + # verify the required parameter 'property_type_id' is set + if @api_client.config.client_side_validation && property_type_id.nil? + fail ArgumentError, "Missing the required parameter 'property_type_id' when calling EdmApi.force_remove_property_type_from_entity_type" + end + # resource path + local_var_path = '/datastore/edm/entity/type/{entityTypeId}/{propertyTypeId}/force'.sub('{' + 'entityTypeId' + '}', CGI.escape(entity_type_id.to_s)).sub('{' + 'propertyTypeId' + '}', CGI.escape(property_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#force_remove_property_type_from_entity_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets all association EntityType definitions. + # @param [Hash] opts the optional parameters + # @return [Array] + def get_all_association_entity_types(opts = {}) + data, _status_code, _headers = get_all_association_entity_types_with_http_info(opts) + data + end + + # Gets all association EntityType definitions. + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_all_association_entity_types_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_all_association_entity_types ...' + end + # resource path + local_var_path = '/datastore/edm/association/type/' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_all_association_entity_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get all available associations for the given AssociationType UUID. + # @param association_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array] + def get_all_available_association_types(association_type_id, opts = {}) + data, _status_code, _headers = get_all_available_association_types_with_http_info(association_type_id, opts) + data + end + + # Get all available associations for the given AssociationType UUID. + # @param association_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_all_available_association_types_with_http_info(association_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_all_available_association_types ...' + end + # verify the required parameter 'association_type_id' is set + if @api_client.config.client_side_validation && association_type_id.nil? + fail ArgumentError, "Missing the required parameter 'association_type_id' when calling EdmApi.get_all_available_association_types" + end + # resource path + local_var_path = '/datastore/edm/association/type/{associationTypeId}/available'.sub('{' + 'associationTypeId' + '}', CGI.escape(association_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_all_available_association_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get all entity set property metadata. + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [Hash] + def get_all_entity_set_property_metadata(entity_set_id, opts = {}) + data, _status_code, _headers = get_all_entity_set_property_metadata_with_http_info(entity_set_id, opts) + data + end + + # Get all entity set property metadata. + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers + def get_all_entity_set_property_metadata_with_http_info(entity_set_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_all_entity_set_property_metadata ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling EdmApi.get_all_entity_set_property_metadata" + end + # resource path + local_var_path = '/datastore/entity-sets/all/{entitySetId}/metadata'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Hash' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_all_entity_set_property_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get all EntitySet definitions. + # @param [Hash] opts the optional parameters + # @return [Array] + def get_all_entity_sets(opts = {}) + data, _status_code, _headers = get_all_entity_sets_with_http_info(opts) + data + end + + # Get all EntitySet definitions. + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_all_entity_sets_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_all_entity_sets ...' + end + # resource path + local_var_path = '/datastore/entity-sets' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_all_entity_sets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get all EntityType propertyType metadata + # @param entity_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Hash] + def get_all_entity_type_property_metadata(entity_type_id, opts = {}) + data, _status_code, _headers = get_all_entity_type_property_metadata_with_http_info(entity_type_id, opts) + data + end + + # Get all EntityType propertyType metadata + # @param entity_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers + def get_all_entity_type_property_metadata_with_http_info(entity_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_all_entity_type_property_metadata ...' + end + # verify the required parameter 'entity_type_id' is set + if @api_client.config.client_side_validation && entity_type_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_id' when calling EdmApi.get_all_entity_type_property_metadata" + end + # resource path + local_var_path = '/datastore/edm/entity/type/{entityTypeId}/property/type'.sub('{' + 'entityTypeId' + '}', CGI.escape(entity_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Hash' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_all_entity_type_property_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets all EntityType definitions. + # @param [Hash] opts the optional parameters + # @return [Array] + def get_all_entity_types(opts = {}) + data, _status_code, _headers = get_all_entity_types_with_http_info(opts) + data + end + + # Gets all EntityType definitions. + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_all_entity_types_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_all_entity_types ...' + end + # resource path + local_var_path = '/datastore/edm/entity/type/' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_all_entity_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets all PropertyType definitions. + # @param [Hash] opts the optional parameters + # @return [Array] + def get_all_property_types(opts = {}) + data, _status_code, _headers = get_all_property_types_with_http_info(opts) + data + end + + # Gets all PropertyType definitions. + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_all_property_types_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_all_property_types ...' + end + # resource path + local_var_path = '/datastore/edm/property/type/' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_all_property_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets all PropertyType definitions under the given namespace. + # @param namespace [String] + # @param [Hash] opts the optional parameters + # @return [Array] + def get_all_property_types_in_namespace(namespace, opts = {}) + data, _status_code, _headers = get_all_property_types_in_namespace_with_http_info(namespace, opts) + data + end + + # Gets all PropertyType definitions under the given namespace. + # @param namespace [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_all_property_types_in_namespace_with_http_info(namespace, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_all_property_types_in_namespace ...' + end + # verify the required parameter 'namespace' is set + if @api_client.config.client_side_validation && namespace.nil? + fail ArgumentError, "Missing the required parameter 'namespace' when calling EdmApi.get_all_property_types_in_namespace" + end + # resource path + local_var_path = '/datastore/edm/property/type/namespace/{namespace}'.sub('{' + 'namespace' + '}', CGI.escape(namespace.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_all_property_types_in_namespace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get Property Usage Summary for all properties. + # @param [Hash] opts the optional parameters + # @return [Hash] + def get_all_property_usage_summaries(opts = {}) + data, _status_code, _headers = get_all_property_usage_summaries_with_http_info(opts) + data + end + + # Get Property Usage Summary for all properties. + # @param [Hash] opts the optional parameters + # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers + def get_all_property_usage_summaries_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_all_property_usage_summaries ...' + end + # resource path + local_var_path = '/datastore/edm/summary' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Hash' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_all_property_usage_summaries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get the AssociationType definition for the given AssociationType UUID. + # @param association_type_id [String] + # @param [Hash] opts the optional parameters + # @return [AssociationType] + def get_association_type(association_type_id, opts = {}) + data, _status_code, _headers = get_association_type_with_http_info(association_type_id, opts) + data + end + + # Get the AssociationType definition for the given AssociationType UUID. + # @param association_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(AssociationType, Integer, Hash)>] AssociationType data, response status code and response headers + def get_association_type_with_http_info(association_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_association_type ...' + end + # verify the required parameter 'association_type_id' is set + if @api_client.config.client_side_validation && association_type_id.nil? + fail ArgumentError, "Missing the required parameter 'association_type_id' when calling EdmApi.get_association_type" + end + # resource path + local_var_path = '/datastore/edm/association/type/{associationTypeId}'.sub('{' + 'associationTypeId' + '}', CGI.escape(association_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'AssociationType' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_association_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get details about the AssociationType for the given AssociationType UUID. + # @param association_type_id [String] + # @param [Hash] opts the optional parameters + # @return [AssociationType] + def get_association_type_details(association_type_id, opts = {}) + data, _status_code, _headers = get_association_type_details_with_http_info(association_type_id, opts) + data + end + + # Get details about the AssociationType for the given AssociationType UUID. + # @param association_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(AssociationType, Integer, Hash)>] AssociationType data, response status code and response headers + def get_association_type_details_with_http_info(association_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_association_type_details ...' + end + # verify the required parameter 'association_type_id' is set + if @api_client.config.client_side_validation && association_type_id.nil? + fail ArgumentError, "Missing the required parameter 'association_type_id' when calling EdmApi.get_association_type_details" + end + # resource path + local_var_path = '/datastore/edm/association/type/{associationTypeId}/detailed'.sub('{' + 'associationTypeId' + '}', CGI.escape(association_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'AssociationType' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_association_type_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets the entity data model, including namespaces, schemas, entity types, association types, and property types. + # @param [Hash] opts the optional parameters + # @return [EDM] + def get_entity_data_model(opts = {}) + data, _status_code, _headers = get_entity_data_model_with_http_info(opts) + data + end + + # Gets the entity data model, including namespaces, schemas, entity types, association types, and property types. + # @param [Hash] opts the optional parameters + # @return [Array<(EDM, Integer, Hash)>] EDM data, response status code and response headers + def get_entity_data_model_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_entity_data_model ...' + end + # resource path + local_var_path = '/datastore/edm/' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'EDM' + + # auth_names + auth_names = opts[:auth_names] || [] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_entity_data_model\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets the changes between the existing entity data model and the entity data model passed in, including schemas, association types, entity types, and property types. + # @param ed_mdiff [EDMdiff] + # @param [Hash] opts the optional parameters + # @return [EDMdiff] + def get_entity_data_model_diff(ed_mdiff, opts = {}) + data, _status_code, _headers = get_entity_data_model_diff_with_http_info(ed_mdiff, opts) + data + end + + # Gets the changes between the existing entity data model and the entity data model passed in, including schemas, association types, entity types, and property types. + # @param ed_mdiff [EDMdiff] + # @param [Hash] opts the optional parameters + # @return [Array<(EDMdiff, Integer, Hash)>] EDMdiff data, response status code and response headers + def get_entity_data_model_diff_with_http_info(ed_mdiff, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_entity_data_model_diff ...' + end + # verify the required parameter 'ed_mdiff' is set + if @api_client.config.client_side_validation && ed_mdiff.nil? + fail ArgumentError, "Missing the required parameter 'ed_mdiff' when calling EdmApi.get_entity_data_model_diff" + end + # resource path + local_var_path = '/datastore/edm/diff/' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(ed_mdiff) + + # return_type + return_type = opts[:return_type] || 'EDMdiff' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_entity_data_model_diff\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get the EntitySet definition for the given EntitySet UUID. + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [EntitySet] + def get_entity_set(entity_set_id, opts = {}) + data, _status_code, _headers = get_entity_set_with_http_info(entity_set_id, opts) + data + end + + # Get the EntitySet definition for the given EntitySet UUID. + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(EntitySet, Integer, Hash)>] EntitySet data, response status code and response headers + def get_entity_set_with_http_info(entity_set_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_entity_set ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling EdmApi.get_entity_set" + end + # resource path + local_var_path = '/datastore/entity-sets/all/{entitySetId}'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'EntitySet' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_entity_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets the EntitySet UUID for the given EntitySet name. + # @param entity_set_name [String] + # @param [Hash] opts the optional parameters + # @return [String] + def get_entity_set_id(entity_set_name, opts = {}) + data, _status_code, _headers = get_entity_set_id_with_http_info(entity_set_name, opts) + data + end + + # Gets the EntitySet UUID for the given EntitySet name. + # @param entity_set_name [String] + # @param [Hash] opts the optional parameters + # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers + def get_entity_set_id_with_http_info(entity_set_name, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_entity_set_id ...' + end + # verify the required parameter 'entity_set_name' is set + if @api_client.config.client_side_validation && entity_set_name.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_name' when calling EdmApi.get_entity_set_id" + end + # resource path + local_var_path = '/datastore/entity-sets/ids/{entitySetName}'.sub('{' + 'entitySetName' + '}', CGI.escape(entity_set_name.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'String' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_entity_set_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get IDs for entity sets given their names. + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Hash] + def get_entity_set_ids(opts = {}) + data, _status_code, _headers = get_entity_set_ids_with_http_info(opts) + data + end + + # Get IDs for entity sets given their names. + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers + def get_entity_set_ids_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_entity_set_ids ...' + end + # resource path + local_var_path = '/datastore/entity-sets/ids/' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(opts[:'request_body']) + + # return_type + return_type = opts[:return_type] || 'Hash' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_entity_set_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get specified property type metadata for an entity set. + # @param entity_set_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [EntitySetPropertyMetaData] + def get_entity_set_property_metadata(entity_set_id, property_type_id, opts = {}) + data, _status_code, _headers = get_entity_set_property_metadata_with_http_info(entity_set_id, property_type_id, opts) + data + end + + # Get specified property type metadata for an entity set. + # @param entity_set_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(EntitySetPropertyMetaData, Integer, Hash)>] EntitySetPropertyMetaData data, response status code and response headers + def get_entity_set_property_metadata_with_http_info(entity_set_id, property_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_entity_set_property_metadata ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling EdmApi.get_entity_set_property_metadata" + end + # verify the required parameter 'property_type_id' is set + if @api_client.config.client_side_validation && property_type_id.nil? + fail ArgumentError, "Missing the required parameter 'property_type_id' when calling EdmApi.get_entity_set_property_metadata" + end + # resource path + local_var_path = '/datastore/entity-sets/all/{entitySetId}/properties/{propertyTypeId}/'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)).sub('{' + 'propertyTypeId' + '}', CGI.escape(property_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'EntitySetPropertyMetaData' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_entity_set_property_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets the EntityType definition for the given EntityType UUID. + # @param entity_type_id [String] + # @param [Hash] opts the optional parameters + # @return [EntityType] + def get_entity_type(entity_type_id, opts = {}) + data, _status_code, _headers = get_entity_type_with_http_info(entity_type_id, opts) + data + end + + # Gets the EntityType definition for the given EntityType UUID. + # @param entity_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(EntityType, Integer, Hash)>] EntityType data, response status code and response headers + def get_entity_type_with_http_info(entity_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_entity_type ...' + end + # verify the required parameter 'entity_type_id' is set + if @api_client.config.client_side_validation && entity_type_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_id' when calling EdmApi.get_entity_type" + end + # resource path + local_var_path = '/datastore/edm/entity/type/{entityTypeId}'.sub('{' + 'entityTypeId' + '}', CGI.escape(entity_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'EntityType' + + # auth_names + auth_names = opts[:auth_names] || [] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_entity_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get the EntityType hierarchy for the given EntityType UUID. + # @param entity_type_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def get_entity_type_hierarchy(entity_type_id, opts = {}) + get_entity_type_hierarchy_with_http_info(entity_type_id, opts) + nil + end + + # Get the EntityType hierarchy for the given EntityType UUID. + # @param entity_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def get_entity_type_hierarchy_with_http_info(entity_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_entity_type_hierarchy ...' + end + # verify the required parameter 'entity_type_id' is set + if @api_client.config.client_side_validation && entity_type_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_id' when calling EdmApi.get_entity_type_hierarchy" + end + # resource path + local_var_path = '/datastore/edm/entity/type/{entityTypeId}/hierarchy'.sub('{' + 'entityTypeId' + '}', CGI.escape(entity_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_entity_type_hierarchy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets the EntityType UUID for the given EntityType FQN. + # @param namespace [String] + # @param name [String] + # @param [Hash] opts the optional parameters + # @return [String] + def get_entity_type_id(namespace, name, opts = {}) + data, _status_code, _headers = get_entity_type_id_with_http_info(namespace, name, opts) + data + end + + # Gets the EntityType UUID for the given EntityType FQN. + # @param namespace [String] + # @param name [String] + # @param [Hash] opts the optional parameters + # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers + def get_entity_type_id_with_http_info(namespace, name, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_entity_type_id ...' + end + # verify the required parameter 'namespace' is set + if @api_client.config.client_side_validation && namespace.nil? + fail ArgumentError, "Missing the required parameter 'namespace' when calling EdmApi.get_entity_type_id" + end + # verify the required parameter 'name' is set + if @api_client.config.client_side_validation && name.nil? + fail ArgumentError, "Missing the required parameter 'name' when calling EdmApi.get_entity_type_id" + end + # resource path + local_var_path = '/datastore/edm/ids/entity/type/{namespace}/{name}'.sub('{' + 'namespace' + '}', CGI.escape(namespace.to_s)).sub('{' + 'name' + '}', CGI.escape(name.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'String' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_entity_type_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get EntityType propertyType metadata + # @param entity_type_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [EntityTypePropertyMetadata] + def get_entity_type_property_metadata(entity_type_id, property_type_id, opts = {}) + data, _status_code, _headers = get_entity_type_property_metadata_with_http_info(entity_type_id, property_type_id, opts) + data + end + + # Get EntityType propertyType metadata + # @param entity_type_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(EntityTypePropertyMetadata, Integer, Hash)>] EntityTypePropertyMetadata data, response status code and response headers + def get_entity_type_property_metadata_with_http_info(entity_type_id, property_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_entity_type_property_metadata ...' + end + # verify the required parameter 'entity_type_id' is set + if @api_client.config.client_side_validation && entity_type_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_id' when calling EdmApi.get_entity_type_property_metadata" + end + # verify the required parameter 'property_type_id' is set + if @api_client.config.client_side_validation && property_type_id.nil? + fail ArgumentError, "Missing the required parameter 'property_type_id' when calling EdmApi.get_entity_type_property_metadata" + end + # resource path + local_var_path = '/datastore/edm/entity/type/{entityTypeId}/property/type/{propertyTypeId}'.sub('{' + 'entityTypeId' + '}', CGI.escape(entity_type_id.to_s)).sub('{' + 'propertyTypeId' + '}', CGI.escape(property_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'EntityTypePropertyMetadata' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_entity_type_property_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get property metadata for entity sets. + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Hash>] + def get_property_metadata_for_entity_sets(opts = {}) + data, _status_code, _headers = get_property_metadata_for_entity_sets_with_http_info(opts) + data + end + + # Get property metadata for entity sets. + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Array<(Hash>, Integer, Hash)>] Hash> data, response status code and response headers + def get_property_metadata_for_entity_sets_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_property_metadata_for_entity_sets ...' + end + # resource path + local_var_path = '/datastore/entity-sets/all/metadata' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(opts[:'request_body']) + + # return_type + return_type = opts[:return_type] || 'Hash>' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_property_metadata_for_entity_sets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets the PropertyType definition for the given PropertyType UUID. + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [PropertyType] + def get_property_type(property_type_id, opts = {}) + data, _status_code, _headers = get_property_type_with_http_info(property_type_id, opts) + data + end + + # Gets the PropertyType definition for the given PropertyType UUID. + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(PropertyType, Integer, Hash)>] PropertyType data, response status code and response headers + def get_property_type_with_http_info(property_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_property_type ...' + end + # verify the required parameter 'property_type_id' is set + if @api_client.config.client_side_validation && property_type_id.nil? + fail ArgumentError, "Missing the required parameter 'property_type_id' when calling EdmApi.get_property_type" + end + # resource path + local_var_path = '/datastore/edm/property/type/{propertyTypeId}'.sub('{' + 'propertyTypeId' + '}', CGI.escape(property_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'PropertyType' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_property_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets the PropertyType UUID for the given PropertyType FQN. + # @param namespace [String] + # @param name [String] + # @param [Hash] opts the optional parameters + # @return [String] + def get_property_type_id(namespace, name, opts = {}) + data, _status_code, _headers = get_property_type_id_with_http_info(namespace, name, opts) + data + end + + # Gets the PropertyType UUID for the given PropertyType FQN. + # @param namespace [String] + # @param name [String] + # @param [Hash] opts the optional parameters + # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers + def get_property_type_id_with_http_info(namespace, name, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_property_type_id ...' + end + # verify the required parameter 'namespace' is set + if @api_client.config.client_side_validation && namespace.nil? + fail ArgumentError, "Missing the required parameter 'namespace' when calling EdmApi.get_property_type_id" + end + # verify the required parameter 'name' is set + if @api_client.config.client_side_validation && name.nil? + fail ArgumentError, "Missing the required parameter 'name' when calling EdmApi.get_property_type_id" + end + # resource path + local_var_path = '/datastore/edm/ids/property/type/{namespace}/{name}'.sub('{' + 'namespace' + '}', CGI.escape(namespace.to_s)).sub('{' + 'name' + '}', CGI.escape(name.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'String' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_property_type_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get all Property Types for entity set + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [Hash] + def get_property_types_for_entity_set(entity_set_id, opts = {}) + data, _status_code, _headers = get_property_types_for_entity_set_with_http_info(entity_set_id, opts) + data + end + + # Get all Property Types for entity set + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers + def get_property_types_for_entity_set_with_http_info(entity_set_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_property_types_for_entity_set ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling EdmApi.get_property_types_for_entity_set" + end + # resource path + local_var_path = '/datastore/entity-sets/all/{entitySetId}/properties'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Hash' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_property_types_for_entity_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get Property Usage Summary for property with given ID. + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array] + def get_property_usage_summary(property_type_id, opts = {}) + data, _status_code, _headers = get_property_usage_summary_with_http_info(property_type_id, opts) + data + end + + # Get Property Usage Summary for property with given ID. + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_property_usage_summary_with_http_info(property_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_property_usage_summary ...' + end + # verify the required parameter 'property_type_id' is set + if @api_client.config.client_side_validation && property_type_id.nil? + fail ArgumentError, "Missing the required parameter 'property_type_id' when calling EdmApi.get_property_usage_summary" + end + # resource path + local_var_path = '/datastore/edm/summary/{propertyTypeId}'.sub('{' + 'propertyTypeId' + '}', CGI.escape(property_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_property_usage_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets the schema contents for a corresponding namespace and name. + # @param namespace [String] + # @param name [String] + # @param [Hash] opts the optional parameters + # @option opts [String] :file_type (default to 'yaml') + # @return [Schema] + def get_schema_contents(namespace, name, opts = {}) + data, _status_code, _headers = get_schema_contents_with_http_info(namespace, name, opts) + data + end + + # Gets the schema contents for a corresponding namespace and name. + # @param namespace [String] + # @param name [String] + # @param [Hash] opts the optional parameters + # @option opts [String] :file_type + # @return [Array<(Schema, Integer, Hash)>] Schema data, response status code and response headers + def get_schema_contents_with_http_info(namespace, name, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_schema_contents ...' + end + # verify the required parameter 'namespace' is set + if @api_client.config.client_side_validation && namespace.nil? + fail ArgumentError, "Missing the required parameter 'namespace' when calling EdmApi.get_schema_contents" + end + # verify the required parameter 'name' is set + if @api_client.config.client_side_validation && name.nil? + fail ArgumentError, "Missing the required parameter 'name' when calling EdmApi.get_schema_contents" + end + allowable_values = ["csv", "json", "yaml"] + if @api_client.config.client_side_validation && opts[:'file_type'] && !allowable_values.include?(opts[:'file_type']) + fail ArgumentError, "invalid value for \"file_type\", must be one of #{allowable_values}" + end + # resource path + local_var_path = '/datastore/edm/schema/{namespace}/{name}'.sub('{' + 'namespace' + '}', CGI.escape(namespace.to_s)).sub('{' + 'name' + '}', CGI.escape(name.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'fileType'] = opts[:'file_type'] if !opts[:'file_type'].nil? + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Schema' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_schema_contents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets all schemas. + # @param [Hash] opts the optional parameters + # @return [Array] + def get_schemas(opts = {}) + data, _status_code, _headers = get_schemas_with_http_info(opts) + data + end + + # Gets all schemas. + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_schemas_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_schemas ...' + end + # resource path + local_var_path = '/datastore/edm/schema' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_schemas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets all schemas associated with a given namespace and accessible by the caller. + # @param namespace [String] + # @param [Hash] opts the optional parameters + # @return [Array] + def get_schemas_in_namespace(namespace, opts = {}) + data, _status_code, _headers = get_schemas_in_namespace_with_http_info(namespace, opts) + data + end + + # Gets all schemas associated with a given namespace and accessible by the caller. + # @param namespace [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_schemas_in_namespace_with_http_info(namespace, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.get_schemas_in_namespace ...' + end + # verify the required parameter 'namespace' is set + if @api_client.config.client_side_validation && namespace.nil? + fail ArgumentError, "Missing the required parameter 'namespace' when calling EdmApi.get_schemas_in_namespace" + end + # resource path + local_var_path = '/datastore/edm/schema/{namespace}'.sub('{' + 'namespace' + '}', CGI.escape(namespace.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#get_schemas_in_namespace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates the AssociationType dst entity types for the given AssociationType UUID by removing the given EntityType UUID. + # @param association_type_id [String] + # @param entity_type_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def remove_dst_entity_type_from_association_type(association_type_id, entity_type_id, opts = {}) + remove_dst_entity_type_from_association_type_with_http_info(association_type_id, entity_type_id, opts) + nil + end + + # Updates the AssociationType dst entity types for the given AssociationType UUID by removing the given EntityType UUID. + # @param association_type_id [String] + # @param entity_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def remove_dst_entity_type_from_association_type_with_http_info(association_type_id, entity_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.remove_dst_entity_type_from_association_type ...' + end + # verify the required parameter 'association_type_id' is set + if @api_client.config.client_side_validation && association_type_id.nil? + fail ArgumentError, "Missing the required parameter 'association_type_id' when calling EdmApi.remove_dst_entity_type_from_association_type" + end + # verify the required parameter 'entity_type_id' is set + if @api_client.config.client_side_validation && entity_type_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_id' when calling EdmApi.remove_dst_entity_type_from_association_type" + end + # resource path + local_var_path = '/datastore/edm/association/type/{associationTypeId}/dst/{entityTypeId}'.sub('{' + 'associationTypeId' + '}', CGI.escape(association_type_id.to_s)).sub('{' + 'entityTypeId' + '}', CGI.escape(entity_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#remove_dst_entity_type_from_association_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Removes/unlinks the linked entity sets from the linking entity set + # @param linking_entity_set_id [String] + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Integer] + def remove_entity_sets_from_linking_entity_set(linking_entity_set_id, opts = {}) + data, _status_code, _headers = remove_entity_sets_from_linking_entity_set_with_http_info(linking_entity_set_id, opts) + data + end + + # Removes/unlinks the linked entity sets from the linking entity set + # @param linking_entity_set_id [String] + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def remove_entity_sets_from_linking_entity_set_with_http_info(linking_entity_set_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.remove_entity_sets_from_linking_entity_set ...' + end + # verify the required parameter 'linking_entity_set_id' is set + if @api_client.config.client_side_validation && linking_entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'linking_entity_set_id' when calling EdmApi.remove_entity_sets_from_linking_entity_set" + end + # resource path + local_var_path = '/datastore/entity-sets/linking/{linkingEntitySetId}'.sub('{' + 'linkingEntitySetId' + '}', CGI.escape(linking_entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(opts[:'request_body']) + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#remove_entity_sets_from_linking_entity_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Removes/unlinks the linked entity sets from the linking entity set + # @param linking_entity_set_id [String] + # @param request_body [Hash>] + # @param [Hash] opts the optional parameters + # @return [Integer] + def remove_entity_sets_from_linking_entity_sets(linking_entity_set_id, request_body, opts = {}) + data, _status_code, _headers = remove_entity_sets_from_linking_entity_sets_with_http_info(linking_entity_set_id, request_body, opts) + data + end + + # Removes/unlinks the linked entity sets from the linking entity set + # @param linking_entity_set_id [String] + # @param request_body [Hash>] + # @param [Hash] opts the optional parameters + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def remove_entity_sets_from_linking_entity_sets_with_http_info(linking_entity_set_id, request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.remove_entity_sets_from_linking_entity_sets ...' + end + # verify the required parameter 'linking_entity_set_id' is set + if @api_client.config.client_side_validation && linking_entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'linking_entity_set_id' when calling EdmApi.remove_entity_sets_from_linking_entity_sets" + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling EdmApi.remove_entity_sets_from_linking_entity_sets" + end + # resource path + local_var_path = '/datastore/entity-sets/linking/'.sub('{' + 'linkingEntitySetId' + '}', CGI.escape(linking_entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#remove_entity_sets_from_linking_entity_sets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Removes a primary key with a given ID from an entity type with a given ID. + # @param entity_type_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def remove_primary_key_from_entity_type(entity_type_id, property_type_id, opts = {}) + remove_primary_key_from_entity_type_with_http_info(entity_type_id, property_type_id, opts) + nil + end + + # Removes a primary key with a given ID from an entity type with a given ID. + # @param entity_type_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def remove_primary_key_from_entity_type_with_http_info(entity_type_id, property_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.remove_primary_key_from_entity_type ...' + end + # verify the required parameter 'entity_type_id' is set + if @api_client.config.client_side_validation && entity_type_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_id' when calling EdmApi.remove_primary_key_from_entity_type" + end + # verify the required parameter 'property_type_id' is set + if @api_client.config.client_side_validation && property_type_id.nil? + fail ArgumentError, "Missing the required parameter 'property_type_id' when calling EdmApi.remove_primary_key_from_entity_type" + end + # resource path + local_var_path = '/datastore/edm/entity/type/key/{entityTypeId}/{propertyTypeId}'.sub('{' + 'entityTypeId' + '}', CGI.escape(entity_type_id.to_s)).sub('{' + 'propertyTypeId' + '}', CGI.escape(property_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#remove_primary_key_from_entity_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates the EntityType definition for the given EntityType UUID by removing the given PropertyType UUID. + # @param entity_type_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def remove_property_type_from_entity_type(entity_type_id, property_type_id, opts = {}) + remove_property_type_from_entity_type_with_http_info(entity_type_id, property_type_id, opts) + nil + end + + # Updates the EntityType definition for the given EntityType UUID by removing the given PropertyType UUID. + # @param entity_type_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def remove_property_type_from_entity_type_with_http_info(entity_type_id, property_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.remove_property_type_from_entity_type ...' + end + # verify the required parameter 'entity_type_id' is set + if @api_client.config.client_side_validation && entity_type_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_id' when calling EdmApi.remove_property_type_from_entity_type" + end + # verify the required parameter 'property_type_id' is set + if @api_client.config.client_side_validation && property_type_id.nil? + fail ArgumentError, "Missing the required parameter 'property_type_id' when calling EdmApi.remove_property_type_from_entity_type" + end + # resource path + local_var_path = '/datastore/edm/entity/type/{entityTypeId}/{propertyTypeId}'.sub('{' + 'entityTypeId' + '}', CGI.escape(entity_type_id.to_s)).sub('{' + 'propertyTypeId' + '}', CGI.escape(property_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#remove_property_type_from_entity_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates the AssociationType src entity types for the given AssociationType UUID by removing the given EntityType UUID. + # @param association_type_id [String] + # @param entity_type_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def remove_src_entity_type_from_association_type(association_type_id, entity_type_id, opts = {}) + remove_src_entity_type_from_association_type_with_http_info(association_type_id, entity_type_id, opts) + nil + end + + # Updates the AssociationType src entity types for the given AssociationType UUID by removing the given EntityType UUID. + # @param association_type_id [String] + # @param entity_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def remove_src_entity_type_from_association_type_with_http_info(association_type_id, entity_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.remove_src_entity_type_from_association_type ...' + end + # verify the required parameter 'association_type_id' is set + if @api_client.config.client_side_validation && association_type_id.nil? + fail ArgumentError, "Missing the required parameter 'association_type_id' when calling EdmApi.remove_src_entity_type_from_association_type" + end + # verify the required parameter 'entity_type_id' is set + if @api_client.config.client_side_validation && entity_type_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_id' when calling EdmApi.remove_src_entity_type_from_association_type" + end + # resource path + local_var_path = '/datastore/edm/association/type/{associationTypeId}/src/{entityTypeId}'.sub('{' + 'associationTypeId' + '}', CGI.escape(association_type_id.to_s)).sub('{' + 'entityTypeId' + '}', CGI.escape(entity_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#remove_src_entity_type_from_association_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates the EntityType definition for the given EntityType UUID by reordering its properties as specified by the provided list. + # @param entity_type_id [String] + # @param property_type_ids [Array] + # @param [Hash] opts the optional parameters + # @return [nil] + def reorder_property_types_in_entity_type(entity_type_id, property_type_ids, opts = {}) + reorder_property_types_in_entity_type_with_http_info(entity_type_id, property_type_ids, opts) + nil + end + + # Updates the EntityType definition for the given EntityType UUID by reordering its properties as specified by the provided list. + # @param entity_type_id [String] + # @param property_type_ids [Array] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def reorder_property_types_in_entity_type_with_http_info(entity_type_id, property_type_ids, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.reorder_property_types_in_entity_type ...' + end + # verify the required parameter 'entity_type_id' is set + if @api_client.config.client_side_validation && entity_type_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_id' when calling EdmApi.reorder_property_types_in_entity_type" + end + # verify the required parameter 'property_type_ids' is set + if @api_client.config.client_side_validation && property_type_ids.nil? + fail ArgumentError, "Missing the required parameter 'property_type_ids' when calling EdmApi.reorder_property_types_in_entity_type" + end + # resource path + local_var_path = '/datastore/edm/entity/type/{entityTypeId}/property/type'.sub('{' + 'entityTypeId' + '}', CGI.escape(entity_type_id.to_s)).sub('{' + 'propertyTypeIds' + '}', CGI.escape(property_type_ids.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#reorder_property_types_in_entity_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates the entity data model, including schemas, entity types, association types, and property types. + # @param edm [EDM] + # @param [Hash] opts the optional parameters + # @return [nil] + def update_entity_data_model(edm, opts = {}) + update_entity_data_model_with_http_info(edm, opts) + nil + end + + # Updates the entity data model, including schemas, entity types, association types, and property types. + # @param edm [EDM] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def update_entity_data_model_with_http_info(edm, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.update_entity_data_model ...' + end + # verify the required parameter 'edm' is set + if @api_client.config.client_side_validation && edm.nil? + fail ArgumentError, "Missing the required parameter 'edm' when calling EdmApi.update_entity_data_model" + end + # resource path + local_var_path = '/datastore/edm/' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(edm) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#update_entity_data_model\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates the EntitySet definition for the given EntitySet UUID with the given metadata. + # @param entity_set_id [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [Integer] + def update_entity_set_meta_data(entity_set_id, metadata_update, opts = {}) + data, _status_code, _headers = update_entity_set_meta_data_with_http_info(entity_set_id, metadata_update, opts) + data + end + + # Updates the EntitySet definition for the given EntitySet UUID with the given metadata. + # @param entity_set_id [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def update_entity_set_meta_data_with_http_info(entity_set_id, metadata_update, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.update_entity_set_meta_data ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling EdmApi.update_entity_set_meta_data" + end + # verify the required parameter 'metadata_update' is set + if @api_client.config.client_side_validation && metadata_update.nil? + fail ArgumentError, "Missing the required parameter 'metadata_update' when calling EdmApi.update_entity_set_meta_data" + end + # resource path + local_var_path = '/datastore/entity-sets/all/{entitySetId}/metadata/'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(metadata_update) + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#update_entity_set_meta_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates the property type metadata for the given entity set. + # @param entity_set_id [String] + # @param property_type_id [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [nil] + def update_entity_set_property_metadata(entity_set_id, property_type_id, metadata_update, opts = {}) + update_entity_set_property_metadata_with_http_info(entity_set_id, property_type_id, metadata_update, opts) + nil + end + + # Updates the property type metadata for the given entity set. + # @param entity_set_id [String] + # @param property_type_id [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def update_entity_set_property_metadata_with_http_info(entity_set_id, property_type_id, metadata_update, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.update_entity_set_property_metadata ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling EdmApi.update_entity_set_property_metadata" + end + # verify the required parameter 'property_type_id' is set + if @api_client.config.client_side_validation && property_type_id.nil? + fail ArgumentError, "Missing the required parameter 'property_type_id' when calling EdmApi.update_entity_set_property_metadata" + end + # verify the required parameter 'metadata_update' is set + if @api_client.config.client_side_validation && metadata_update.nil? + fail ArgumentError, "Missing the required parameter 'metadata_update' when calling EdmApi.update_entity_set_property_metadata" + end + # resource path + local_var_path = '/datastore/entity-sets/all/{entitySetId}/properties/{propertyTypeId}/'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)).sub('{' + 'propertyTypeId' + '}', CGI.escape(property_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(metadata_update) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#update_entity_set_property_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates the EntityType definition for the given EntityType UUID with the given metadata. + # @param entity_type_id [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [nil] + def update_entity_type_meta_data(entity_type_id, metadata_update, opts = {}) + update_entity_type_meta_data_with_http_info(entity_type_id, metadata_update, opts) + nil + end + + # Updates the EntityType definition for the given EntityType UUID with the given metadata. + # @param entity_type_id [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def update_entity_type_meta_data_with_http_info(entity_type_id, metadata_update, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.update_entity_type_meta_data ...' + end + # verify the required parameter 'entity_type_id' is set + if @api_client.config.client_side_validation && entity_type_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_id' when calling EdmApi.update_entity_type_meta_data" + end + # verify the required parameter 'metadata_update' is set + if @api_client.config.client_side_validation && metadata_update.nil? + fail ArgumentError, "Missing the required parameter 'metadata_update' when calling EdmApi.update_entity_type_meta_data" + end + # resource path + local_var_path = '/datastore/edm/entity/type/{entityTypeId}'.sub('{' + 'entityTypeId' + '}', CGI.escape(entity_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(metadata_update) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#update_entity_type_meta_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Update EntityType Property metadata + # @param entity_type_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def update_entity_type_property_metadata(entity_type_id, property_type_id, opts = {}) + update_entity_type_property_metadata_with_http_info(entity_type_id, property_type_id, opts) + nil + end + + # Update EntityType Property metadata + # @param entity_type_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def update_entity_type_property_metadata_with_http_info(entity_type_id, property_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.update_entity_type_property_metadata ...' + end + # verify the required parameter 'entity_type_id' is set + if @api_client.config.client_side_validation && entity_type_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_type_id' when calling EdmApi.update_entity_type_property_metadata" + end + # verify the required parameter 'property_type_id' is set + if @api_client.config.client_side_validation && property_type_id.nil? + fail ArgumentError, "Missing the required parameter 'property_type_id' when calling EdmApi.update_entity_type_property_metadata" + end + # resource path + local_var_path = '/datastore/edm/entity/type/{entityTypeId}/property/type/{propertyTypeId}'.sub('{' + 'entityTypeId' + '}', CGI.escape(entity_type_id.to_s)).sub('{' + 'propertyTypeId' + '}', CGI.escape(property_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#update_entity_type_property_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates the PropertyType definition for the given PropertyType UUID with the given metadata. + # @param property_type_id [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [nil] + def update_property_type_meta_data(property_type_id, metadata_update, opts = {}) + update_property_type_meta_data_with_http_info(property_type_id, metadata_update, opts) + nil + end + + # Updates the PropertyType definition for the given PropertyType UUID with the given metadata. + # @param property_type_id [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def update_property_type_meta_data_with_http_info(property_type_id, metadata_update, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.update_property_type_meta_data ...' + end + # verify the required parameter 'property_type_id' is set + if @api_client.config.client_side_validation && property_type_id.nil? + fail ArgumentError, "Missing the required parameter 'property_type_id' when calling EdmApi.update_property_type_meta_data" + end + # verify the required parameter 'metadata_update' is set + if @api_client.config.client_side_validation && metadata_update.nil? + fail ArgumentError, "Missing the required parameter 'metadata_update' when calling EdmApi.update_property_type_meta_data" + end + # resource path + local_var_path = '/datastore/edm/property/type/{propertyTypeId}'.sub('{' + 'propertyTypeId' + '}', CGI.escape(property_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(metadata_update) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#update_property_type_meta_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Edits the schema contents for a corresponding namespace and name. + # @param namespace [String] + # @param name [String] + # @param edm_request [EdmRequest] + # @param [Hash] opts the optional parameters + # @return [nil] + def update_schema(namespace, name, edm_request, opts = {}) + update_schema_with_http_info(namespace, name, edm_request, opts) + nil + end + + # Edits the schema contents for a corresponding namespace and name. + # @param namespace [String] + # @param name [String] + # @param edm_request [EdmRequest] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def update_schema_with_http_info(namespace, name, edm_request, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EdmApi.update_schema ...' + end + # verify the required parameter 'namespace' is set + if @api_client.config.client_side_validation && namespace.nil? + fail ArgumentError, "Missing the required parameter 'namespace' when calling EdmApi.update_schema" + end + # verify the required parameter 'name' is set + if @api_client.config.client_side_validation && name.nil? + fail ArgumentError, "Missing the required parameter 'name' when calling EdmApi.update_schema" + end + # verify the required parameter 'edm_request' is set + if @api_client.config.client_side_validation && edm_request.nil? + fail ArgumentError, "Missing the required parameter 'edm_request' when calling EdmApi.update_schema" + end + # resource path + local_var_path = '/datastore/edm/schema/{namespace}/{name}'.sub('{' + 'namespace' + '}', CGI.escape(namespace.to_s)).sub('{' + 'name' + '}', CGI.escape(name.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(edm_request) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EdmApi#update_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + end +end diff --git a/ruby/lib/openapi_client/api/entity_sets_api.rb b/ruby/lib/openapi_client/api/entity_sets_api.rb new file mode 100644 index 0000000..6bad532 --- /dev/null +++ b/ruby/lib/openapi_client/api/entity_sets_api.rb @@ -0,0 +1,1020 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'cgi' + +module OpenapiClient + class EntitySetsApi + attr_accessor :api_client + + def initialize(api_client = ApiClient.default) + @api_client = api_client + end + # Adds the entity sets as linked entity sets to the linking entity set + # @param linking_entity_set_id [String] + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Integer] + def add_entity_sets_to_linking_entity_set(linking_entity_set_id, opts = {}) + data, _status_code, _headers = add_entity_sets_to_linking_entity_set_with_http_info(linking_entity_set_id, opts) + data + end + + # Adds the entity sets as linked entity sets to the linking entity set + # @param linking_entity_set_id [String] + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def add_entity_sets_to_linking_entity_set_with_http_info(linking_entity_set_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EntitySetsApi.add_entity_sets_to_linking_entity_set ...' + end + # verify the required parameter 'linking_entity_set_id' is set + if @api_client.config.client_side_validation && linking_entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'linking_entity_set_id' when calling EntitySetsApi.add_entity_sets_to_linking_entity_set" + end + # resource path + local_var_path = '/datastore/entity-sets/linking/{linkingEntitySetId}'.sub('{' + 'linkingEntitySetId' + '}', CGI.escape(linking_entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(opts[:'request_body']) + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EntitySetsApi#add_entity_sets_to_linking_entity_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Adds the entity sets as linked entity sets to the linking entity sets + # @param linking_entity_set_id [String] + # @param request_body [Hash>] + # @param [Hash] opts the optional parameters + # @return [Integer] + def add_entity_sets_to_linking_entity_sets(linking_entity_set_id, request_body, opts = {}) + data, _status_code, _headers = add_entity_sets_to_linking_entity_sets_with_http_info(linking_entity_set_id, request_body, opts) + data + end + + # Adds the entity sets as linked entity sets to the linking entity sets + # @param linking_entity_set_id [String] + # @param request_body [Hash>] + # @param [Hash] opts the optional parameters + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def add_entity_sets_to_linking_entity_sets_with_http_info(linking_entity_set_id, request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EntitySetsApi.add_entity_sets_to_linking_entity_sets ...' + end + # verify the required parameter 'linking_entity_set_id' is set + if @api_client.config.client_side_validation && linking_entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'linking_entity_set_id' when calling EntitySetsApi.add_entity_sets_to_linking_entity_sets" + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling EntitySetsApi.add_entity_sets_to_linking_entity_sets" + end + # resource path + local_var_path = '/datastore/entity-sets/linking/'.sub('{' + 'linkingEntitySetId' + '}', CGI.escape(linking_entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EntitySetsApi#add_entity_sets_to_linking_entity_sets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Creates new EntitySet definitions if they don't exist. + # @param entity_set [Array] + # @param [Hash] opts the optional parameters + # @return [nil] + def create_entity_sets(entity_set, opts = {}) + create_entity_sets_with_http_info(entity_set, opts) + nil + end + + # Creates new EntitySet definitions if they don't exist. + # @param entity_set [Array] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def create_entity_sets_with_http_info(entity_set, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EntitySetsApi.create_entity_sets ...' + end + # verify the required parameter 'entity_set' is set + if @api_client.config.client_side_validation && entity_set.nil? + fail ArgumentError, "Missing the required parameter 'entity_set' when calling EntitySetsApi.create_entity_sets" + end + # resource path + local_var_path = '/datastore/entity-sets' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(entity_set) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EntitySetsApi#create_entity_sets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Deletes the EntitySet definition for the given EntitySet UUID. + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_entity_set(entity_set_id, opts = {}) + delete_entity_set_with_http_info(entity_set_id, opts) + nil + end + + # Deletes the EntitySet definition for the given EntitySet UUID. + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def delete_entity_set_with_http_info(entity_set_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EntitySetsApi.delete_entity_set ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling EntitySetsApi.delete_entity_set" + end + # resource path + local_var_path = '/datastore/entity-sets/all/{entitySetId}'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EntitySetsApi#delete_entity_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get all entity set property metadata. + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [Hash] + def get_all_entity_set_property_metadata(entity_set_id, opts = {}) + data, _status_code, _headers = get_all_entity_set_property_metadata_with_http_info(entity_set_id, opts) + data + end + + # Get all entity set property metadata. + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers + def get_all_entity_set_property_metadata_with_http_info(entity_set_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EntitySetsApi.get_all_entity_set_property_metadata ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling EntitySetsApi.get_all_entity_set_property_metadata" + end + # resource path + local_var_path = '/datastore/entity-sets/all/{entitySetId}/metadata'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Hash' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EntitySetsApi#get_all_entity_set_property_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get all EntitySet definitions. + # @param [Hash] opts the optional parameters + # @return [Array] + def get_all_entity_sets(opts = {}) + data, _status_code, _headers = get_all_entity_sets_with_http_info(opts) + data + end + + # Get all EntitySet definitions. + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_all_entity_sets_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EntitySetsApi.get_all_entity_sets ...' + end + # resource path + local_var_path = '/datastore/entity-sets' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EntitySetsApi#get_all_entity_sets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get the EntitySet definition for the given EntitySet UUID. + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [EntitySet] + def get_entity_set(entity_set_id, opts = {}) + data, _status_code, _headers = get_entity_set_with_http_info(entity_set_id, opts) + data + end + + # Get the EntitySet definition for the given EntitySet UUID. + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(EntitySet, Integer, Hash)>] EntitySet data, response status code and response headers + def get_entity_set_with_http_info(entity_set_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EntitySetsApi.get_entity_set ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling EntitySetsApi.get_entity_set" + end + # resource path + local_var_path = '/datastore/entity-sets/all/{entitySetId}'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'EntitySet' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EntitySetsApi#get_entity_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets the EntitySet UUID for the given EntitySet name. + # @param entity_set_name [String] + # @param [Hash] opts the optional parameters + # @return [String] + def get_entity_set_id(entity_set_name, opts = {}) + data, _status_code, _headers = get_entity_set_id_with_http_info(entity_set_name, opts) + data + end + + # Gets the EntitySet UUID for the given EntitySet name. + # @param entity_set_name [String] + # @param [Hash] opts the optional parameters + # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers + def get_entity_set_id_with_http_info(entity_set_name, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EntitySetsApi.get_entity_set_id ...' + end + # verify the required parameter 'entity_set_name' is set + if @api_client.config.client_side_validation && entity_set_name.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_name' when calling EntitySetsApi.get_entity_set_id" + end + # resource path + local_var_path = '/datastore/entity-sets/ids/{entitySetName}'.sub('{' + 'entitySetName' + '}', CGI.escape(entity_set_name.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'String' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EntitySetsApi#get_entity_set_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get IDs for entity sets given their names. + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Hash] + def get_entity_set_ids(opts = {}) + data, _status_code, _headers = get_entity_set_ids_with_http_info(opts) + data + end + + # Get IDs for entity sets given their names. + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers + def get_entity_set_ids_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EntitySetsApi.get_entity_set_ids ...' + end + # resource path + local_var_path = '/datastore/entity-sets/ids/' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(opts[:'request_body']) + + # return_type + return_type = opts[:return_type] || 'Hash' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EntitySetsApi#get_entity_set_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get specified property type metadata for an entity set. + # @param entity_set_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [EntitySetPropertyMetaData] + def get_entity_set_property_metadata(entity_set_id, property_type_id, opts = {}) + data, _status_code, _headers = get_entity_set_property_metadata_with_http_info(entity_set_id, property_type_id, opts) + data + end + + # Get specified property type metadata for an entity set. + # @param entity_set_id [String] + # @param property_type_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(EntitySetPropertyMetaData, Integer, Hash)>] EntitySetPropertyMetaData data, response status code and response headers + def get_entity_set_property_metadata_with_http_info(entity_set_id, property_type_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EntitySetsApi.get_entity_set_property_metadata ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling EntitySetsApi.get_entity_set_property_metadata" + end + # verify the required parameter 'property_type_id' is set + if @api_client.config.client_side_validation && property_type_id.nil? + fail ArgumentError, "Missing the required parameter 'property_type_id' when calling EntitySetsApi.get_entity_set_property_metadata" + end + # resource path + local_var_path = '/datastore/entity-sets/all/{entitySetId}/properties/{propertyTypeId}/'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)).sub('{' + 'propertyTypeId' + '}', CGI.escape(property_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'EntitySetPropertyMetaData' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EntitySetsApi#get_entity_set_property_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get property metadata for entity sets. + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Hash>] + def get_property_metadata_for_entity_sets(opts = {}) + data, _status_code, _headers = get_property_metadata_for_entity_sets_with_http_info(opts) + data + end + + # Get property metadata for entity sets. + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Array<(Hash>, Integer, Hash)>] Hash> data, response status code and response headers + def get_property_metadata_for_entity_sets_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EntitySetsApi.get_property_metadata_for_entity_sets ...' + end + # resource path + local_var_path = '/datastore/entity-sets/all/metadata' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(opts[:'request_body']) + + # return_type + return_type = opts[:return_type] || 'Hash>' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EntitySetsApi#get_property_metadata_for_entity_sets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get all Property Types for entity set + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [Hash] + def get_property_types_for_entity_set(entity_set_id, opts = {}) + data, _status_code, _headers = get_property_types_for_entity_set_with_http_info(entity_set_id, opts) + data + end + + # Get all Property Types for entity set + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers + def get_property_types_for_entity_set_with_http_info(entity_set_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EntitySetsApi.get_property_types_for_entity_set ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling EntitySetsApi.get_property_types_for_entity_set" + end + # resource path + local_var_path = '/datastore/entity-sets/all/{entitySetId}/properties'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Hash' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EntitySetsApi#get_property_types_for_entity_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Removes/unlinks the linked entity sets from the linking entity set + # @param linking_entity_set_id [String] + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Integer] + def remove_entity_sets_from_linking_entity_set(linking_entity_set_id, opts = {}) + data, _status_code, _headers = remove_entity_sets_from_linking_entity_set_with_http_info(linking_entity_set_id, opts) + data + end + + # Removes/unlinks the linked entity sets from the linking entity set + # @param linking_entity_set_id [String] + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def remove_entity_sets_from_linking_entity_set_with_http_info(linking_entity_set_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EntitySetsApi.remove_entity_sets_from_linking_entity_set ...' + end + # verify the required parameter 'linking_entity_set_id' is set + if @api_client.config.client_side_validation && linking_entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'linking_entity_set_id' when calling EntitySetsApi.remove_entity_sets_from_linking_entity_set" + end + # resource path + local_var_path = '/datastore/entity-sets/linking/{linkingEntitySetId}'.sub('{' + 'linkingEntitySetId' + '}', CGI.escape(linking_entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(opts[:'request_body']) + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EntitySetsApi#remove_entity_sets_from_linking_entity_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Removes/unlinks the linked entity sets from the linking entity set + # @param linking_entity_set_id [String] + # @param request_body [Hash>] + # @param [Hash] opts the optional parameters + # @return [Integer] + def remove_entity_sets_from_linking_entity_sets(linking_entity_set_id, request_body, opts = {}) + data, _status_code, _headers = remove_entity_sets_from_linking_entity_sets_with_http_info(linking_entity_set_id, request_body, opts) + data + end + + # Removes/unlinks the linked entity sets from the linking entity set + # @param linking_entity_set_id [String] + # @param request_body [Hash>] + # @param [Hash] opts the optional parameters + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def remove_entity_sets_from_linking_entity_sets_with_http_info(linking_entity_set_id, request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EntitySetsApi.remove_entity_sets_from_linking_entity_sets ...' + end + # verify the required parameter 'linking_entity_set_id' is set + if @api_client.config.client_side_validation && linking_entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'linking_entity_set_id' when calling EntitySetsApi.remove_entity_sets_from_linking_entity_sets" + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling EntitySetsApi.remove_entity_sets_from_linking_entity_sets" + end + # resource path + local_var_path = '/datastore/entity-sets/linking/'.sub('{' + 'linkingEntitySetId' + '}', CGI.escape(linking_entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EntitySetsApi#remove_entity_sets_from_linking_entity_sets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates the EntitySet definition for the given EntitySet UUID with the given metadata. + # @param entity_set_id [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [Integer] + def update_entity_set_meta_data(entity_set_id, metadata_update, opts = {}) + data, _status_code, _headers = update_entity_set_meta_data_with_http_info(entity_set_id, metadata_update, opts) + data + end + + # Updates the EntitySet definition for the given EntitySet UUID with the given metadata. + # @param entity_set_id [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def update_entity_set_meta_data_with_http_info(entity_set_id, metadata_update, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EntitySetsApi.update_entity_set_meta_data ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling EntitySetsApi.update_entity_set_meta_data" + end + # verify the required parameter 'metadata_update' is set + if @api_client.config.client_side_validation && metadata_update.nil? + fail ArgumentError, "Missing the required parameter 'metadata_update' when calling EntitySetsApi.update_entity_set_meta_data" + end + # resource path + local_var_path = '/datastore/entity-sets/all/{entitySetId}/metadata/'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(metadata_update) + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EntitySetsApi#update_entity_set_meta_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates the property type metadata for the given entity set. + # @param entity_set_id [String] + # @param property_type_id [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [nil] + def update_entity_set_property_metadata(entity_set_id, property_type_id, metadata_update, opts = {}) + update_entity_set_property_metadata_with_http_info(entity_set_id, property_type_id, metadata_update, opts) + nil + end + + # Updates the property type metadata for the given entity set. + # @param entity_set_id [String] + # @param property_type_id [String] + # @param metadata_update [MetadataUpdate] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def update_entity_set_property_metadata_with_http_info(entity_set_id, property_type_id, metadata_update, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: EntitySetsApi.update_entity_set_property_metadata ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling EntitySetsApi.update_entity_set_property_metadata" + end + # verify the required parameter 'property_type_id' is set + if @api_client.config.client_side_validation && property_type_id.nil? + fail ArgumentError, "Missing the required parameter 'property_type_id' when calling EntitySetsApi.update_entity_set_property_metadata" + end + # verify the required parameter 'metadata_update' is set + if @api_client.config.client_side_validation && metadata_update.nil? + fail ArgumentError, "Missing the required parameter 'metadata_update' when calling EntitySetsApi.update_entity_set_property_metadata" + end + # resource path + local_var_path = '/datastore/entity-sets/all/{entitySetId}/properties/{propertyTypeId}/'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)).sub('{' + 'propertyTypeId' + '}', CGI.escape(property_type_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(metadata_update) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: EntitySetsApi#update_entity_set_property_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + end +end diff --git a/ruby/lib/openapi_client/api/linking_api.rb b/ruby/lib/openapi_client/api/linking_api.rb new file mode 100644 index 0000000..472b560 --- /dev/null +++ b/ruby/lib/openapi_client/api/linking_api.rb @@ -0,0 +1,390 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'cgi' + +module OpenapiClient + class LinkingApi + attr_accessor :api_client + + def initialize(api_client = ApiClient.default) + @api_client = api_client + end + # Submits feedbacks for a given linking entity set and linking id in a batch format. + # @param linking_feedback [LinkingFeedback] + # @param [Hash] opts the optional parameters + # @return [Integer] + def add_linking_feedback(linking_feedback, opts = {}) + data, _status_code, _headers = add_linking_feedback_with_http_info(linking_feedback, opts) + data + end + + # Submits feedbacks for a given linking entity set and linking id in a batch format. + # @param linking_feedback [LinkingFeedback] + # @param [Hash] opts the optional parameters + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def add_linking_feedback_with_http_info(linking_feedback, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: LinkingApi.add_linking_feedback ...' + end + # verify the required parameter 'linking_feedback' is set + if @api_client.config.client_side_validation && linking_feedback.nil? + fail ArgumentError, "Missing the required parameter 'linking_feedback' when calling LinkingApi.add_linking_feedback" + end + # resource path + local_var_path = '/linker/linkingfeedback' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(linking_feedback) + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: LinkingApi#add_linking_feedback\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Deletes linking feedback + # @param entity_key_pair [EntityKeyPair] + # @param [Hash] opts the optional parameters + # @return [Integer] + def delete_linking_feedback(entity_key_pair, opts = {}) + data, _status_code, _headers = delete_linking_feedback_with_http_info(entity_key_pair, opts) + data + end + + # Deletes linking feedback + # @param entity_key_pair [EntityKeyPair] + # @param [Hash] opts the optional parameters + # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers + def delete_linking_feedback_with_http_info(entity_key_pair, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: LinkingApi.delete_linking_feedback ...' + end + # verify the required parameter 'entity_key_pair' is set + if @api_client.config.client_side_validation && entity_key_pair.nil? + fail ArgumentError, "Missing the required parameter 'entity_key_pair' when calling LinkingApi.delete_linking_feedback" + end + # resource path + local_var_path = '/linker/linkingfeedback' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(entity_key_pair) + + # return_type + return_type = opts[:return_type] || 'Integer' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: LinkingApi#delete_linking_feedback\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Returns all feedback submitted + # @param [Hash] opts the optional parameters + # @return [Array] + def get_all_linking_feedback(opts = {}) + data, _status_code, _headers = get_all_linking_feedback_with_http_info(opts) + data + end + + # Returns all feedback submitted + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_all_linking_feedback_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: LinkingApi.get_all_linking_feedback ...' + end + # resource path + local_var_path = '/linker/linkingfeedback/all' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: LinkingApi#get_all_linking_feedback\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Returns all feedback submitted walong with the features of pairwise entities + # @param [Hash] opts the optional parameters + # @return [Array] + def get_all_linking_feedback_with_features(opts = {}) + data, _status_code, _headers = get_all_linking_feedback_with_features_with_http_info(opts) + data + end + + # Returns all feedback submitted walong with the features of pairwise entities + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_all_linking_feedback_with_features_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: LinkingApi.get_all_linking_feedback_with_features ...' + end + # resource path + local_var_path = '/linker/linkingfeedback/features/all' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: LinkingApi#get_all_linking_feedback_with_features\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Returns the feedback on the given entity pair along with their features + # @param entity_key_pair [EntityKeyPair] + # @param [Hash] opts the optional parameters + # @return [EntityLinkingFeatures] + def get_linking_feedback_with_features(entity_key_pair, opts = {}) + data, _status_code, _headers = get_linking_feedback_with_features_with_http_info(entity_key_pair, opts) + data + end + + # Returns the feedback on the given entity pair along with their features + # @param entity_key_pair [EntityKeyPair] + # @param [Hash] opts the optional parameters + # @return [Array<(EntityLinkingFeatures, Integer, Hash)>] EntityLinkingFeatures data, response status code and response headers + def get_linking_feedback_with_features_with_http_info(entity_key_pair, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: LinkingApi.get_linking_feedback_with_features ...' + end + # verify the required parameter 'entity_key_pair' is set + if @api_client.config.client_side_validation && entity_key_pair.nil? + fail ArgumentError, "Missing the required parameter 'entity_key_pair' when calling LinkingApi.get_linking_feedback_with_features" + end + # resource path + local_var_path = '/linker/linkingfeedback/features' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(entity_key_pair) + + # return_type + return_type = opts[:return_type] || 'EntityLinkingFeatures' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: LinkingApi#get_linking_feedback_with_features\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Returns positive/negative/all linking feedbacks on the given entity. + # @param feedback_type [String] + # @param entity_data_key [EntityDataKey] + # @param [Hash] opts the optional parameters + # @return [Array] + def get_linking_feedbacks_on_entity(feedback_type, entity_data_key, opts = {}) + data, _status_code, _headers = get_linking_feedbacks_on_entity_with_http_info(feedback_type, entity_data_key, opts) + data + end + + # Returns positive/negative/all linking feedbacks on the given entity. + # @param feedback_type [String] + # @param entity_data_key [EntityDataKey] + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_linking_feedbacks_on_entity_with_http_info(feedback_type, entity_data_key, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: LinkingApi.get_linking_feedbacks_on_entity ...' + end + # verify the required parameter 'feedback_type' is set + if @api_client.config.client_side_validation && feedback_type.nil? + fail ArgumentError, "Missing the required parameter 'feedback_type' when calling LinkingApi.get_linking_feedbacks_on_entity" + end + # verify enum value + allowable_values = ["Positive", "Negative", "All"] + if @api_client.config.client_side_validation && !allowable_values.include?(feedback_type) + fail ArgumentError, "invalid value for \"feedback_type\", must be one of #{allowable_values}" + end + # verify the required parameter 'entity_data_key' is set + if @api_client.config.client_side_validation && entity_data_key.nil? + fail ArgumentError, "Missing the required parameter 'entity_data_key' when calling LinkingApi.get_linking_feedbacks_on_entity" + end + # resource path + local_var_path = '/linker/linkingfeedback/entity' + + # query parameters + query_params = opts[:query_params] || {} + query_params[:'feedbackType'] = feedback_type + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(entity_data_key) + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: LinkingApi#get_linking_feedbacks_on_entity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + end +end diff --git a/ruby/lib/openapi_client/api/organizations_api.rb b/ruby/lib/openapi_client/api/organizations_api.rb new file mode 100644 index 0000000..943c25d --- /dev/null +++ b/ruby/lib/openapi_client/api/organizations_api.rb @@ -0,0 +1,1754 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'cgi' + +module OpenapiClient + class OrganizationsApi + attr_accessor :api_client + + def initialize(api_client = ApiClient.default) + @api_client = api_client + end + # Add member to an organization + # @param organization_id [String] + # @param user_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def add_member(organization_id, user_id, opts = {}) + add_member_with_http_info(organization_id, user_id, opts) + nil + end + + # Add member to an organization + # @param organization_id [String] + # @param user_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def add_member_with_http_info(organization_id, user_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.add_member ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.add_member" + end + # verify the required parameter 'user_id' is set + if @api_client.config.client_side_validation && user_id.nil? + fail ArgumentError, "Missing the required parameter 'user_id' when calling OrganizationsApi.add_member" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/principals/members/{userId}'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#add_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Add a role to a user + # @param organization_id [String] + # @param role_id [String] + # @param user_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def add_role_to_user(organization_id, role_id, user_id, opts = {}) + add_role_to_user_with_http_info(organization_id, role_id, user_id, opts) + nil + end + + # Add a role to a user + # @param organization_id [String] + # @param role_id [String] + # @param user_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def add_role_to_user_with_http_info(organization_id, role_id, user_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.add_role_to_user ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.add_role_to_user" + end + # verify the required parameter 'role_id' is set + if @api_client.config.client_side_validation && role_id.nil? + fail ArgumentError, "Missing the required parameter 'role_id' when calling OrganizationsApi.add_role_to_user" + end + # verify the required parameter 'user_id' is set + if @api_client.config.client_side_validation && user_id.nil? + fail ArgumentError, "Missing the required parameter 'user_id' when calling OrganizationsApi.add_role_to_user" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/principals/roles/{roleId}/members/{userId}'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'roleId' + '}', CGI.escape(role_id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#add_role_to_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Materializes entity sets into the organization database. + # @param organization_id [String] + # @param request_body [Hash] + # @param [Hash] opts the optional parameters + # @return [Hash>] + def assemble_entity_sets(organization_id, request_body, opts = {}) + data, _status_code, _headers = assemble_entity_sets_with_http_info(organization_id, request_body, opts) + data + end + + # Materializes entity sets into the organization database. + # @param organization_id [String] + # @param request_body [Hash] + # @param [Hash] opts the optional parameters + # @return [Array<(Hash>, Integer, Hash)>] Hash> data, response status code and response headers + def assemble_entity_sets_with_http_info(organization_id, request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.assemble_entity_sets ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.assemble_entity_sets" + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling OrganizationsApi.assemble_entity_sets" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/entity-sets/assemble'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] || 'Hash>' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#assemble_entity_sets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Creates an organization if it doesn't exist. + # @param organization [Organization] + # @param [Hash] opts the optional parameters + # @return [String] + def create_organization_if_not_exists(organization, opts = {}) + data, _status_code, _headers = create_organization_if_not_exists_with_http_info(organization, opts) + data + end + + # Creates an organization if it doesn't exist. + # @param organization [Organization] + # @param [Hash] opts the optional parameters + # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers + def create_organization_if_not_exists_with_http_info(organization, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.create_organization_if_not_exists ...' + end + # verify the required parameter 'organization' is set + if @api_client.config.client_side_validation && organization.nil? + fail ArgumentError, "Missing the required parameter 'organization' when calling OrganizationsApi.create_organization_if_not_exists" + end + # resource path + local_var_path = '/datastore/organizations' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(organization) + + # return_type + return_type = opts[:return_type] || 'String' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#create_organization_if_not_exists\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Creates role + # @param role [Role] + # @param [Hash] opts the optional parameters + # @return [String] + def create_role(role, opts = {}) + data, _status_code, _headers = create_role_with_http_info(role, opts) + data + end + + # Creates role + # @param role [Role] + # @param [Hash] opts the optional parameters + # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers + def create_role_with_http_info(role, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.create_role ...' + end + # verify the required parameter 'role' is set + if @api_client.config.client_side_validation && role.nil? + fail ArgumentError, "Missing the required parameter 'role' when calling OrganizationsApi.create_role" + end + # resource path + local_var_path = '/datastore/organizations/roles' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(role) + + # return_type + return_type = opts[:return_type] || 'String' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#create_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Remove role for an organization + # @param organization_id [String] + # @param role_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_role(organization_id, role_id, opts = {}) + delete_role_with_http_info(organization_id, role_id, opts) + nil + end + + # Remove role for an organization + # @param organization_id [String] + # @param role_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def delete_role_with_http_info(organization_id, role_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.delete_role ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.delete_role" + end + # verify the required parameter 'role_id' is set + if @api_client.config.client_side_validation && role_id.nil? + fail ArgumentError, "Missing the required parameter 'role_id' when calling OrganizationsApi.delete_role" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/principals/roles/{roleId}'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'roleId' + '}', CGI.escape(role_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#delete_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Remove an organization from the organizationId + # @param organization_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def destroy_organization(organization_id, opts = {}) + destroy_organization_with_http_info(organization_id, opts) + nil + end + + # Remove an organization from the organizationId + # @param organization_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def destroy_organization_with_http_info(organization_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.destroy_organization ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.destroy_organization" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#destroy_organization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get members of a role for an organization from a roleId + # @param organization_id [String] + # @param role_id [String] + # @param [Hash] opts the optional parameters + # @return [Array] + def get_all_users_of_role(organization_id, role_id, opts = {}) + data, _status_code, _headers = get_all_users_of_role_with_http_info(organization_id, role_id, opts) + data + end + + # Get members of a role for an organization from a roleId + # @param organization_id [String] + # @param role_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_all_users_of_role_with_http_info(organization_id, role_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.get_all_users_of_role ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_all_users_of_role" + end + # verify the required parameter 'role_id' is set + if @api_client.config.client_side_validation && role_id.nil? + fail ArgumentError, "Missing the required parameter 'role_id' when calling OrganizationsApi.get_all_users_of_role" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/principals/roles/{roleId}/members/'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'roleId' + '}', CGI.escape(role_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#get_all_users_of_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get auto-approved email domains + # @param organization_id [String] + # @param [Hash] opts the optional parameters + # @return [Array] + def get_auto_approved_email_domains(organization_id, opts = {}) + data, _status_code, _headers = get_auto_approved_email_domains_with_http_info(organization_id, opts) + data + end + + # Get auto-approved email domains + # @param organization_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_auto_approved_email_domains_with_http_info(organization_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.get_auto_approved_email_domains ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_auto_approved_email_domains" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/email-domains'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#get_auto_approved_email_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get the entity sets for an organization for a certain flag + # @param organization_id [String] + # @param request_body [Hash>] + # @param [Hash] opts the optional parameters + # @return [Array>>] + def get_flagged_organization_entity_sets(organization_id, request_body, opts = {}) + data, _status_code, _headers = get_flagged_organization_entity_sets_with_http_info(organization_id, request_body, opts) + data + end + + # Get the entity sets for an organization for a certain flag + # @param organization_id [String] + # @param request_body [Hash>] + # @param [Hash] opts the optional parameters + # @return [Array<(Array>>, Integer, Hash)>] Array>> data, response status code and response headers + def get_flagged_organization_entity_sets_with_http_info(organization_id, request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.get_flagged_organization_entity_sets ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_flagged_organization_entity_sets" + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling OrganizationsApi.get_flagged_organization_entity_sets" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/entity-sets'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] || 'Array>>' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#get_flagged_organization_entity_sets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get members of a certain organization + # @param organization_id [String] + # @param [Hash] opts the optional parameters + # @return [Array] + def get_members(organization_id, opts = {}) + data, _status_code, _headers = get_members_with_http_info(organization_id, opts) + data + end + + # Get members of a certain organization + # @param organization_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_members_with_http_info(organization_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.get_members ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_members" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/principals/members'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#get_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get an organization from the organizationId + # @param organization_id [String] + # @param [Hash] opts the optional parameters + # @return [Organization] + def get_organization(organization_id, opts = {}) + data, _status_code, _headers = get_organization_with_http_info(organization_id, opts) + data + end + + # Get an organization from the organizationId + # @param organization_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Organization, Integer, Hash)>] Organization data, response status code and response headers + def get_organization_with_http_info(organization_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.get_organization ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_organization" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Organization' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#get_organization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get the entity sets for an organization for a certain filter + # @param organization_id [String] + # @param [Hash] opts the optional parameters + # @return [Hash>] + def get_organization_entity_sets(organization_id, opts = {}) + data, _status_code, _headers = get_organization_entity_sets_with_http_info(organization_id, opts) + data + end + + # Get the entity sets for an organization for a certain filter + # @param organization_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Hash>, Integer, Hash)>] Hash> data, response status code and response headers + def get_organization_entity_sets_with_http_info(organization_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.get_organization_entity_sets ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_organization_entity_sets" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/entity-sets'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Hash>' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#get_organization_entity_sets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get the integrations account for an organization from the organizationId + # @param organization_id [String] + # @param [Hash] opts the optional parameters + # @return [InlineResponse200] + def get_organization_integration_account(organization_id, opts = {}) + data, _status_code, _headers = get_organization_integration_account_with_http_info(organization_id, opts) + data + end + + # Get the integrations account for an organization from the organizationId + # @param organization_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(InlineResponse200, Integer, Hash)>] InlineResponse200 data, response status code and response headers + def get_organization_integration_account_with_http_info(organization_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.get_organization_integration_account ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_organization_integration_account" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/integration'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'InlineResponse200' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#get_organization_integration_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get all organizations + # @param [Hash] opts the optional parameters + # @return [Array] + def get_organizations(opts = {}) + data, _status_code, _headers = get_organizations_with_http_info(opts) + data + end + + # Get all organizations + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_organizations_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.get_organizations ...' + end + # resource path + local_var_path = '/datastore/organizations' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#get_organizations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get role for an organization from a roleId + # @param organization_id [String] + # @param role_id [String] + # @param [Hash] opts the optional parameters + # @return [Role] + def get_role(organization_id, role_id, opts = {}) + data, _status_code, _headers = get_role_with_http_info(organization_id, role_id, opts) + data + end + + # Get role for an organization from a roleId + # @param organization_id [String] + # @param role_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Role, Integer, Hash)>] Role data, response status code and response headers + def get_role_with_http_info(organization_id, role_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.get_role ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_role" + end + # verify the required parameter 'role_id' is set + if @api_client.config.client_side_validation && role_id.nil? + fail ArgumentError, "Missing the required parameter 'role_id' when calling OrganizationsApi.get_role" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/principals/roles/{roleId}'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'roleId' + '}', CGI.escape(role_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Role' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#get_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get roles for an organization + # @param organization_id [String] + # @param [Hash] opts the optional parameters + # @return [Array] + def get_roles(organization_id, opts = {}) + data, _status_code, _headers = get_roles_with_http_info(organization_id, opts) + data + end + + # Get roles for an organization + # @param organization_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_roles_with_http_info(organization_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.get_roles ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.get_roles" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/principals/roles'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#get_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Refreshes the requested materialized entity set with data changes in the organization. + # @param organization_id [String] + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def refresh_data_changes(organization_id, entity_set_id, opts = {}) + refresh_data_changes_with_http_info(organization_id, entity_set_id, opts) + nil + end + + # Refreshes the requested materialized entity set with data changes in the organization. + # @param organization_id [String] + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def refresh_data_changes_with_http_info(organization_id, entity_set_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.refresh_data_changes ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.refresh_data_changes" + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling OrganizationsApi.refresh_data_changes" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/{entitySetId}/refresh'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#refresh_data_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Remove auto-approved email domains + # @param organization_id [String] + # @param request_body [Array] + # @param [Hash] opts the optional parameters + # @return [nil] + def remove_auto_approved_email_domains(organization_id, request_body, opts = {}) + remove_auto_approved_email_domains_with_http_info(organization_id, request_body, opts) + nil + end + + # Remove auto-approved email domains + # @param organization_id [String] + # @param request_body [Array] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def remove_auto_approved_email_domains_with_http_info(organization_id, request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.remove_auto_approved_email_domains ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.remove_auto_approved_email_domains" + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling OrganizationsApi.remove_auto_approved_email_domains" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/email-domains'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#remove_auto_approved_email_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Remove member from an organization + # @param organization_id [String] + # @param user_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def remove_member(organization_id, user_id, opts = {}) + remove_member_with_http_info(organization_id, user_id, opts) + nil + end + + # Remove member from an organization + # @param organization_id [String] + # @param user_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def remove_member_with_http_info(organization_id, user_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.remove_member ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.remove_member" + end + # verify the required parameter 'user_id' is set + if @api_client.config.client_side_validation && user_id.nil? + fail ArgumentError, "Missing the required parameter 'user_id' when calling OrganizationsApi.remove_member" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/principals/members/{userId}'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#remove_member\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Remove a role from a user + # @param organization_id [String] + # @param role_id [String] + # @param user_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def remove_role_from_user(organization_id, role_id, user_id, opts = {}) + remove_role_from_user_with_http_info(organization_id, role_id, user_id, opts) + nil + end + + # Remove a role from a user + # @param organization_id [String] + # @param role_id [String] + # @param user_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def remove_role_from_user_with_http_info(organization_id, role_id, user_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.remove_role_from_user ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.remove_role_from_user" + end + # verify the required parameter 'role_id' is set + if @api_client.config.client_side_validation && role_id.nil? + fail ArgumentError, "Missing the required parameter 'role_id' when calling OrganizationsApi.remove_role_from_user" + end + # verify the required parameter 'user_id' is set + if @api_client.config.client_side_validation && user_id.nil? + fail ArgumentError, "Missing the required parameter 'user_id' when calling OrganizationsApi.remove_role_from_user" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/principals/roles/{roleId}/members/{userId}'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'roleId' + '}', CGI.escape(role_id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#remove_role_from_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Set auto-approved email domains + # @param organization_id [String] + # @param request_body [Array] + # @param [Hash] opts the optional parameters + # @return [nil] + def set_auto_approved_email_domain(organization_id, request_body, opts = {}) + set_auto_approved_email_domain_with_http_info(organization_id, request_body, opts) + nil + end + + # Set auto-approved email domains + # @param organization_id [String] + # @param request_body [Array] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def set_auto_approved_email_domain_with_http_info(organization_id, request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.set_auto_approved_email_domain ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.set_auto_approved_email_domain" + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling OrganizationsApi.set_auto_approved_email_domain" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/email-domains'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#set_auto_approved_email_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Synchronizes EDM changes to the requested materialized entity set in the organization. + # @param organization_id [String] + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def synchronize_edm_changes(organization_id, entity_set_id, opts = {}) + synchronize_edm_changes_with_http_info(organization_id, entity_set_id, opts) + nil + end + + # Synchronizes EDM changes to the requested materialized entity set in the organization. + # @param organization_id [String] + # @param entity_set_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def synchronize_edm_changes_with_http_info(organization_id, entity_set_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.synchronize_edm_changes ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.synchronize_edm_changes" + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling OrganizationsApi.synchronize_edm_changes" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/{entitySetId}/synchronize'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#synchronize_edm_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Update the organization description + # @param organization_id [String] + # @param body [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def update_description(organization_id, body, opts = {}) + update_description_with_http_info(organization_id, body, opts) + nil + end + + # Update the organization description + # @param organization_id [String] + # @param body [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def update_description_with_http_info(organization_id, body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.update_description ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.update_description" + end + # verify the required parameter 'body' is set + if @api_client.config.client_side_validation && body.nil? + fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationsApi.update_description" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/description'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(body) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#update_description\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Update role description for an organization from a roleId + # @param organization_id [String] + # @param role_id [String] + # @param body [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def update_role_description(organization_id, role_id, body, opts = {}) + update_role_description_with_http_info(organization_id, role_id, body, opts) + nil + end + + # Update role description for an organization from a roleId + # @param organization_id [String] + # @param role_id [String] + # @param body [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def update_role_description_with_http_info(organization_id, role_id, body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.update_role_description ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.update_role_description" + end + # verify the required parameter 'role_id' is set + if @api_client.config.client_side_validation && role_id.nil? + fail ArgumentError, "Missing the required parameter 'role_id' when calling OrganizationsApi.update_role_description" + end + # verify the required parameter 'body' is set + if @api_client.config.client_side_validation && body.nil? + fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationsApi.update_role_description" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/principals/roles/{roleId}/description'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'roleId' + '}', CGI.escape(role_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(body) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#update_role_description\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Update role title for an organization from a roleId + # @param organization_id [String] + # @param role_id [String] + # @param body [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def update_role_title(organization_id, role_id, body, opts = {}) + update_role_title_with_http_info(organization_id, role_id, body, opts) + nil + end + + # Update role title for an organization from a roleId + # @param organization_id [String] + # @param role_id [String] + # @param body [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def update_role_title_with_http_info(organization_id, role_id, body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.update_role_title ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.update_role_title" + end + # verify the required parameter 'role_id' is set + if @api_client.config.client_side_validation && role_id.nil? + fail ArgumentError, "Missing the required parameter 'role_id' when calling OrganizationsApi.update_role_title" + end + # verify the required parameter 'body' is set + if @api_client.config.client_side_validation && body.nil? + fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationsApi.update_role_title" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/principals/roles/{roleId}/title'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)).sub('{' + 'roleId' + '}', CGI.escape(role_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(body) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#update_role_title\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Update the organization title + # @param organization_id [String] + # @param body [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def update_title(organization_id, body, opts = {}) + update_title_with_http_info(organization_id, body, opts) + nil + end + + # Update the organization title + # @param organization_id [String] + # @param body [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def update_title_with_http_info(organization_id, body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: OrganizationsApi.update_title ...' + end + # verify the required parameter 'organization_id' is set + if @api_client.config.client_side_validation && organization_id.nil? + fail ArgumentError, "Missing the required parameter 'organization_id' when calling OrganizationsApi.update_title" + end + # verify the required parameter 'body' is set + if @api_client.config.client_side_validation && body.nil? + fail ArgumentError, "Missing the required parameter 'body' when calling OrganizationsApi.update_title" + end + # resource path + local_var_path = '/datastore/organizations/{organizationId}/title'.sub('{' + 'organizationId' + '}', CGI.escape(organization_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(body) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: OrganizationsApi#update_title\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + end +end diff --git a/ruby/lib/openapi_client/api/permissions_api.rb b/ruby/lib/openapi_client/api/permissions_api.rb new file mode 100644 index 0000000..a4a88d5 --- /dev/null +++ b/ruby/lib/openapi_client/api/permissions_api.rb @@ -0,0 +1,144 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'cgi' + +module OpenapiClient + class PermissionsApi + attr_accessor :api_client + + def initialize(api_client = ApiClient.default) + @api_client = api_client + end + # Get the ACL for the given ACL Key, only if the user is the owner of the ACL Key. + # @param request_body [Array] + # @param [Hash] opts the optional parameters + # @return [Acl] + def get_acl(request_body, opts = {}) + data, _status_code, _headers = get_acl_with_http_info(request_body, opts) + data + end + + # Get the ACL for the given ACL Key, only if the user is the owner of the ACL Key. + # @param request_body [Array] + # @param [Hash] opts the optional parameters + # @return [Array<(Acl, Integer, Hash)>] Acl data, response status code and response headers + def get_acl_with_http_info(request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: PermissionsApi.get_acl ...' + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling PermissionsApi.get_acl" + end + # resource path + local_var_path = '/datastore/permissions' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] || 'Acl' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: PermissionsApi#get_acl\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Updates the ACL for a particular ACL Key, only if the user is the owner of the ACL Key. + # @param acl_data [AclData] + # @param [Hash] opts the optional parameters + # @return [nil] + def update_acl(acl_data, opts = {}) + update_acl_with_http_info(acl_data, opts) + nil + end + + # Updates the ACL for a particular ACL Key, only if the user is the owner of the ACL Key. + # @param acl_data [AclData] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def update_acl_with_http_info(acl_data, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: PermissionsApi.update_acl ...' + end + # verify the required parameter 'acl_data' is set + if @api_client.config.client_side_validation && acl_data.nil? + fail ArgumentError, "Missing the required parameter 'acl_data' when calling PermissionsApi.update_acl" + end + # resource path + local_var_path = '/datastore/permissions' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(acl_data) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: PermissionsApi#update_acl\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + end +end diff --git a/ruby/lib/openapi_client/api/principal_api.rb b/ruby/lib/openapi_client/api/principal_api.rb new file mode 100644 index 0000000..013780f --- /dev/null +++ b/ruby/lib/openapi_client/api/principal_api.rb @@ -0,0 +1,416 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'cgi' + +module OpenapiClient + class PrincipalApi + attr_accessor :api_client + + def initialize(api_client = ApiClient.default) + @api_client = api_client + end + # Get all users. + # @param [Hash] opts the optional parameters + # @return [Hash] + def get_all_users(opts = {}) + data, _status_code, _headers = get_all_users_with_http_info(opts) + data + end + + # Get all users. + # @param [Hash] opts the optional parameters + # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers + def get_all_users_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: PrincipalApi.get_all_users ...' + end + # resource path + local_var_path = '/datastore/principals/users/' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Hash' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: PrincipalApi#get_all_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get current roles. + # @param [Hash] opts the optional parameters + # @return [Array] + def get_current_roles(opts = {}) + data, _status_code, _headers = get_current_roles_with_http_info(opts) + data + end + + # Get current roles. + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_current_roles_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: PrincipalApi.get_current_roles ...' + end + # resource path + local_var_path = '/datastore/principals/roles/current/' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: PrincipalApi#get_current_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get the db access credentials. + # @param [Hash] opts the optional parameters + # @return [MaterializedViewAccount] + def get_materialized_view_account(opts = {}) + data, _status_code, _headers = get_materialized_view_account_with_http_info(opts) + data + end + + # Get the db access credentials. + # @param [Hash] opts the optional parameters + # @return [Array<(MaterializedViewAccount, Integer, Hash)>] MaterializedViewAccount data, response status code and response headers + def get_materialized_view_account_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: PrincipalApi.get_materialized_view_account ...' + end + # resource path + local_var_path = '/datastore/principals/db' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'MaterializedViewAccount' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: PrincipalApi#get_materialized_view_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get the user for the given id. + # @param user_id [String] + # @param [Hash] opts the optional parameters + # @return [Auth0userBasic] + def get_user(user_id, opts = {}) + data, _status_code, _headers = get_user_with_http_info(user_id, opts) + data + end + + # Get the user for the given id. + # @param user_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Auth0userBasic, Integer, Hash)>] Auth0userBasic data, response status code and response headers + def get_user_with_http_info(user_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: PrincipalApi.get_user ...' + end + # verify the required parameter 'user_id' is set + if @api_client.config.client_side_validation && user_id.nil? + fail ArgumentError, "Missing the required parameter 'user_id' when calling PrincipalApi.get_user" + end + # resource path + local_var_path = '/datastore/principals/users/{userId}'.sub('{' + 'userId' + '}', CGI.escape(user_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Auth0userBasic' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: PrincipalApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get the user id for the given search. + # @param search_query [String] + # @param [Hash] opts the optional parameters + # @return [Hash] + def search_all_users(search_query, opts = {}) + data, _status_code, _headers = search_all_users_with_http_info(search_query, opts) + data + end + + # Get the user id for the given search. + # @param search_query [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers + def search_all_users_with_http_info(search_query, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: PrincipalApi.search_all_users ...' + end + # verify the required parameter 'search_query' is set + if @api_client.config.client_side_validation && search_query.nil? + fail ArgumentError, "Missing the required parameter 'search_query' when calling PrincipalApi.search_all_users" + end + # resource path + local_var_path = '/datastore/principals/users/search/"{searchQuery}"'.sub('{' + 'searchQuery' + '}', CGI.escape(search_query.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Hash' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: PrincipalApi#search_all_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get the user id for the given email address. + # @param email_address [String] + # @param [Hash] opts the optional parameters + # @return [Hash] + def search_all_users_by_email(email_address, opts = {}) + data, _status_code, _headers = search_all_users_by_email_with_http_info(email_address, opts) + data + end + + # Get the user id for the given email address. + # @param email_address [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers + def search_all_users_by_email_with_http_info(email_address, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: PrincipalApi.search_all_users_by_email ...' + end + # verify the required parameter 'email_address' is set + if @api_client.config.client_side_validation && email_address.nil? + fail ArgumentError, "Missing the required parameter 'email_address' when calling PrincipalApi.search_all_users_by_email" + end + # resource path + local_var_path = '/datastore/principals/users/search/email/"{emailAddress}"'.sub('{' + 'emailAddress' + '}', CGI.escape(email_address.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Hash' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: PrincipalApi#search_all_users_by_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Activates a user in the OpenLattice system. This call must be made once before a user will be available for use in authorization policies. + # @param [Hash] opts the optional parameters + # @return [nil] + def sync_calling_user(opts = {}) + sync_calling_user_with_http_info(opts) + nil + end + + # Activates a user in the OpenLattice system. This call must be made once before a user will be available for use in authorization policies. + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def sync_calling_user_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: PrincipalApi.sync_calling_user ...' + end + # resource path + local_var_path = '/datastore/principals/sync/' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: PrincipalApi#sync_calling_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + end +end diff --git a/ruby/lib/openapi_client/api/search_api.rb b/ruby/lib/openapi_client/api/search_api.rb new file mode 100644 index 0000000..05c1830 --- /dev/null +++ b/ruby/lib/openapi_client/api/search_api.rb @@ -0,0 +1,1230 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'cgi' + +module OpenapiClient + class SearchApi + attr_accessor :api_client + + def initialize(api_client = ApiClient.default) + @api_client = api_client + end + # Executes a search over the data of a given entity set to find rows that match the search term + # @param entity_set_id [String] + # @param advanced_search [AdvancedSearch] + # @param [Hash] opts the optional parameters + # @return [DataSearchResult] + def execute_advanced_entity_set_data_query(entity_set_id, advanced_search, opts = {}) + data, _status_code, _headers = execute_advanced_entity_set_data_query_with_http_info(entity_set_id, advanced_search, opts) + data + end + + # Executes a search over the data of a given entity set to find rows that match the search term + # @param entity_set_id [String] + # @param advanced_search [AdvancedSearch] + # @param [Hash] opts the optional parameters + # @return [Array<(DataSearchResult, Integer, Hash)>] DataSearchResult data, response status code and response headers + def execute_advanced_entity_set_data_query_with_http_info(entity_set_id, advanced_search, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.execute_advanced_entity_set_data_query ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling SearchApi.execute_advanced_entity_set_data_query" + end + # verify the required parameter 'advanced_search' is set + if @api_client.config.client_side_validation && advanced_search.nil? + fail ArgumentError, "Missing the required parameter 'advanced_search' when calling SearchApi.execute_advanced_entity_set_data_query" + end + # resource path + local_var_path = '/datastore/search/advanced/{entitySetId}'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(advanced_search) + + # return_type + return_type = opts[:return_type] || 'DataSearchResult' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#execute_advanced_entity_set_data_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Executes a search over all apps to find ones that match the given search term + # @param search_term [SearchTerm] + # @param [Hash] opts the optional parameters + # @return [SearchResult] + def execute_app_search(search_term, opts = {}) + data, _status_code, _headers = execute_app_search_with_http_info(search_term, opts) + data + end + + # Executes a search over all apps to find ones that match the given search term + # @param search_term [SearchTerm] + # @param [Hash] opts the optional parameters + # @return [Array<(SearchResult, Integer, Hash)>] SearchResult data, response status code and response headers + def execute_app_search_with_http_info(search_term, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.execute_app_search ...' + end + # verify the required parameter 'search_term' is set + if @api_client.config.client_side_validation && search_term.nil? + fail ArgumentError, "Missing the required parameter 'search_term' when calling SearchApi.execute_app_search" + end + # resource path + local_var_path = '/datastore/search/app' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(search_term) + + # return_type + return_type = opts[:return_type] || 'SearchResult' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#execute_app_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Executes a search over all app types to find ones that match the given search term + # @param search_term [SearchTerm] + # @param [Hash] opts the optional parameters + # @return [SearchResult] + def execute_app_type_search(search_term, opts = {}) + data, _status_code, _headers = execute_app_type_search_with_http_info(search_term, opts) + data + end + + # Executes a search over all app types to find ones that match the given search term + # @param search_term [SearchTerm] + # @param [Hash] opts the optional parameters + # @return [Array<(SearchResult, Integer, Hash)>] SearchResult data, response status code and response headers + def execute_app_type_search_with_http_info(search_term, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.execute_app_type_search ...' + end + # verify the required parameter 'search_term' is set + if @api_client.config.client_side_validation && search_term.nil? + fail ArgumentError, "Missing the required parameter 'search_term' when calling SearchApi.execute_app_type_search" + end + # resource path + local_var_path = '/datastore/search/app_types' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(search_term) + + # return_type + return_type = opts[:return_type] || 'SearchResult' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#execute_app_type_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Executes a search over all association types to find ones that match the given search term + # @param search_term [SearchTerm] + # @param [Hash] opts the optional parameters + # @return [SearchResult] + def execute_association_type_search(search_term, opts = {}) + data, _status_code, _headers = execute_association_type_search_with_http_info(search_term, opts) + data + end + + # Executes a search over all association types to find ones that match the given search term + # @param search_term [SearchTerm] + # @param [Hash] opts the optional parameters + # @return [Array<(SearchResult, Integer, Hash)>] SearchResult data, response status code and response headers + def execute_association_type_search_with_http_info(search_term, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.execute_association_type_search ...' + end + # verify the required parameter 'search_term' is set + if @api_client.config.client_side_validation && search_term.nil? + fail ArgumentError, "Missing the required parameter 'search_term' when calling SearchApi.execute_association_type_search" + end + # resource path + local_var_path = '/datastore/search/association_types' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(search_term) + + # return_type + return_type = opts[:return_type] || 'SearchResult' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#execute_association_type_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Executes a search for all neighbors of an entity that are connected by an association + # @param entity_set_id [String] + # @param entity_key_id [String] + # @param [Hash] opts the optional parameters + # @return [Array] + def execute_entity_neighbor_search(entity_set_id, entity_key_id, opts = {}) + data, _status_code, _headers = execute_entity_neighbor_search_with_http_info(entity_set_id, entity_key_id, opts) + data + end + + # Executes a search for all neighbors of an entity that are connected by an association + # @param entity_set_id [String] + # @param entity_key_id [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def execute_entity_neighbor_search_with_http_info(entity_set_id, entity_key_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.execute_entity_neighbor_search ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling SearchApi.execute_entity_neighbor_search" + end + # verify the required parameter 'entity_key_id' is set + if @api_client.config.client_side_validation && entity_key_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_key_id' when calling SearchApi.execute_entity_neighbor_search" + end + # resource path + local_var_path = '/datastore/search/{entitySetId}/{entityKeyId}'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)).sub('{' + 'entityKeyId' + '}', CGI.escape(entity_key_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#execute_entity_neighbor_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association + # @param entity_set_id [String] + # @param request_body [Array] + # @param [Hash] opts the optional parameters + # @return [Hash>] + def execute_entity_neighbor_search_bulk(entity_set_id, request_body, opts = {}) + data, _status_code, _headers = execute_entity_neighbor_search_bulk_with_http_info(entity_set_id, request_body, opts) + data + end + + # Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association + # @param entity_set_id [String] + # @param request_body [Array] + # @param [Hash] opts the optional parameters + # @return [Array<(Hash>, Integer, Hash)>] Hash> data, response status code and response headers + def execute_entity_neighbor_search_bulk_with_http_info(entity_set_id, request_body, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.execute_entity_neighbor_search_bulk ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling SearchApi.execute_entity_neighbor_search_bulk" + end + # verify the required parameter 'request_body' is set + if @api_client.config.client_side_validation && request_body.nil? + fail ArgumentError, "Missing the required parameter 'request_body' when calling SearchApi.execute_entity_neighbor_search_bulk" + end + # resource path + local_var_path = '/datastore/search/{entitySetId}/neighbors'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(request_body) + + # return_type + return_type = opts[:return_type] || 'Hash>' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#execute_entity_neighbor_search_bulk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Executes a search over all EntitySetCollections to find ones that match the given search term + # @param search_term [SearchTerm] + # @param [Hash] opts the optional parameters + # @return [SearchResult] + def execute_entity_set_collection_search(search_term, opts = {}) + data, _status_code, _headers = execute_entity_set_collection_search_with_http_info(search_term, opts) + data + end + + # Executes a search over all EntitySetCollections to find ones that match the given search term + # @param search_term [SearchTerm] + # @param [Hash] opts the optional parameters + # @return [Array<(SearchResult, Integer, Hash)>] SearchResult data, response status code and response headers + def execute_entity_set_collection_search_with_http_info(search_term, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.execute_entity_set_collection_search ...' + end + # verify the required parameter 'search_term' is set + if @api_client.config.client_side_validation && search_term.nil? + fail ArgumentError, "Missing the required parameter 'search_term' when calling SearchApi.execute_entity_set_collection_search" + end + # resource path + local_var_path = '/datastore/search/entity_sets/collections' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(search_term) + + # return_type + return_type = opts[:return_type] || 'SearchResult' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#execute_entity_set_collection_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Executes a search over the data of a given entity set to find rows that match the search term + # @param entity_set_id [String] + # @param search_term [SearchTerm] A JSON object that contains three parameters, \"start\", which specifies the hit number to start returning results on for paging, \"maxHits\", which specifies the maximum number of hits to return, and \"searchTerm\", which is the search term results will match on. + # @param [Hash] opts the optional parameters + # @return [DataSearchResult] + def execute_entity_set_data_query(entity_set_id, search_term, opts = {}) + data, _status_code, _headers = execute_entity_set_data_query_with_http_info(entity_set_id, search_term, opts) + data + end + + # Executes a search over the data of a given entity set to find rows that match the search term + # @param entity_set_id [String] + # @param search_term [SearchTerm] A JSON object that contains three parameters, \"start\", which specifies the hit number to start returning results on for paging, \"maxHits\", which specifies the maximum number of hits to return, and \"searchTerm\", which is the search term results will match on. + # @param [Hash] opts the optional parameters + # @return [Array<(DataSearchResult, Integer, Hash)>] DataSearchResult data, response status code and response headers + def execute_entity_set_data_query_with_http_info(entity_set_id, search_term, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.execute_entity_set_data_query ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling SearchApi.execute_entity_set_data_query" + end + # verify the required parameter 'search_term' is set + if @api_client.config.client_side_validation && search_term.nil? + fail ArgumentError, "Missing the required parameter 'search_term' when calling SearchApi.execute_entity_set_data_query" + end + # resource path + local_var_path = '/datastore/search/{entitySetId}'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(search_term) + + # return_type + return_type = opts[:return_type] || 'DataSearchResult' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#execute_entity_set_data_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # The query, entityType, and propertyTypes params are all optional, but at least one must be specified otherwise an error will be thrown. All specified params are required to be present in each entity set returned. If entityType and propertyTypes are both specified, the propertyTypes param will be ignored. + # @param search [Search] + # @param [Hash] opts the optional parameters + # @return [SearchResult] + def execute_entity_set_keyword_query(search, opts = {}) + data, _status_code, _headers = execute_entity_set_keyword_query_with_http_info(search, opts) + data + end + + # The query, entityType, and propertyTypes params are all optional, but at least one must be specified otherwise an error will be thrown. All specified params are required to be present in each entity set returned. If entityType and propertyTypes are both specified, the propertyTypes param will be ignored. + # @param search [Search] + # @param [Hash] opts the optional parameters + # @return [Array<(SearchResult, Integer, Hash)>] SearchResult data, response status code and response headers + def execute_entity_set_keyword_query_with_http_info(search, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.execute_entity_set_keyword_query ...' + end + # verify the required parameter 'search' is set + if @api_client.config.client_side_validation && search.nil? + fail ArgumentError, "Missing the required parameter 'search' when calling SearchApi.execute_entity_set_keyword_query" + end + # resource path + local_var_path = '/datastore/search' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(search) + + # return_type + return_type = opts[:return_type] || 'SearchResult' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#execute_entity_set_keyword_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Executes a search over all EntityTypeCollections to find ones that match the given search term + # @param search_term [SearchTerm] + # @param [Hash] opts the optional parameters + # @return [SearchResult] + def execute_entity_type_collection_search(search_term, opts = {}) + data, _status_code, _headers = execute_entity_type_collection_search_with_http_info(search_term, opts) + data + end + + # Executes a search over all EntityTypeCollections to find ones that match the given search term + # @param search_term [SearchTerm] + # @param [Hash] opts the optional parameters + # @return [Array<(SearchResult, Integer, Hash)>] SearchResult data, response status code and response headers + def execute_entity_type_collection_search_with_http_info(search_term, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.execute_entity_type_collection_search ...' + end + # verify the required parameter 'search_term' is set + if @api_client.config.client_side_validation && search_term.nil? + fail ArgumentError, "Missing the required parameter 'search_term' when calling SearchApi.execute_entity_type_collection_search" + end + # resource path + local_var_path = '/datastore/search/entity_types/collections' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(search_term) + + # return_type + return_type = opts[:return_type] || 'SearchResult' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#execute_entity_type_collection_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Executes a search over all entity types to find ones that match the given search term + # @param search_term [SearchTerm] + # @param [Hash] opts the optional parameters + # @return [SearchResult] + def execute_entity_type_search(search_term, opts = {}) + data, _status_code, _headers = execute_entity_type_search_with_http_info(search_term, opts) + data + end + + # Executes a search over all entity types to find ones that match the given search term + # @param search_term [SearchTerm] + # @param [Hash] opts the optional parameters + # @return [Array<(SearchResult, Integer, Hash)>] SearchResult data, response status code and response headers + def execute_entity_type_search_with_http_info(search_term, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.execute_entity_type_search ...' + end + # verify the required parameter 'search_term' is set + if @api_client.config.client_side_validation && search_term.nil? + fail ArgumentError, "Missing the required parameter 'search_term' when calling SearchApi.execute_entity_type_search" + end + # resource path + local_var_path = '/datastore/search/entity_types' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(search_term) + + # return_type + return_type = opts[:return_type] || 'SearchResult' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#execute_entity_type_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association and returns a simple version of the neighborDetails + # @param entity_set_id [String] + # @param neighbor_search_filter [NeighborSearchFilter] + # @param [Hash] opts the optional parameters + # @return [Hash>>>] + def execute_filtered_entity_neighbor_id_search(entity_set_id, neighbor_search_filter, opts = {}) + data, _status_code, _headers = execute_filtered_entity_neighbor_id_search_with_http_info(entity_set_id, neighbor_search_filter, opts) + data + end + + # Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association and returns a simple version of the neighborDetails + # @param entity_set_id [String] + # @param neighbor_search_filter [NeighborSearchFilter] + # @param [Hash] opts the optional parameters + # @return [Array<(Hash>>>, Integer, Hash)>] Hash>>> data, response status code and response headers + def execute_filtered_entity_neighbor_id_search_with_http_info(entity_set_id, neighbor_search_filter, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.execute_filtered_entity_neighbor_id_search ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling SearchApi.execute_filtered_entity_neighbor_id_search" + end + # verify the required parameter 'neighbor_search_filter' is set + if @api_client.config.client_side_validation && neighbor_search_filter.nil? + fail ArgumentError, "Missing the required parameter 'neighbor_search_filter' when calling SearchApi.execute_filtered_entity_neighbor_id_search" + end + # resource path + local_var_path = '/datastore/search/{entitySetId}/neighbors/advanced/ids'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(neighbor_search_filter) + + # return_type + return_type = opts[:return_type] || 'Hash>>>' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#execute_filtered_entity_neighbor_id_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association + # @param entity_set_id [String] + # @param neighbor_search_filter [NeighborSearchFilter] + # @param [Hash] opts the optional parameters + # @return [Hash>] + def execute_filtered_entity_neighbor_search(entity_set_id, neighbor_search_filter, opts = {}) + data, _status_code, _headers = execute_filtered_entity_neighbor_search_with_http_info(entity_set_id, neighbor_search_filter, opts) + data + end + + # Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association + # @param entity_set_id [String] + # @param neighbor_search_filter [NeighborSearchFilter] + # @param [Hash] opts the optional parameters + # @return [Array<(Hash>, Integer, Hash)>] Hash> data, response status code and response headers + def execute_filtered_entity_neighbor_search_with_http_info(entity_set_id, neighbor_search_filter, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.execute_filtered_entity_neighbor_search ...' + end + # verify the required parameter 'entity_set_id' is set + if @api_client.config.client_side_validation && entity_set_id.nil? + fail ArgumentError, "Missing the required parameter 'entity_set_id' when calling SearchApi.execute_filtered_entity_neighbor_search" + end + # verify the required parameter 'neighbor_search_filter' is set + if @api_client.config.client_side_validation && neighbor_search_filter.nil? + fail ArgumentError, "Missing the required parameter 'neighbor_search_filter' when calling SearchApi.execute_filtered_entity_neighbor_search" + end + # resource path + local_var_path = '/datastore/search/{entitySetId}/neighbors/advanced'.sub('{' + 'entitySetId' + '}', CGI.escape(entity_set_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(neighbor_search_filter) + + # return_type + return_type = opts[:return_type] || 'Hash>' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#execute_filtered_entity_neighbor_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Executes a search over all property types to find ones that match the given name and namespace, including partial matches + # @param search_term [SearchTerm] + # @param [Hash] opts the optional parameters + # @return [SearchResult] + def execute_fqn_property_type_search(search_term, opts = {}) + data, _status_code, _headers = execute_fqn_property_type_search_with_http_info(search_term, opts) + data + end + + # Executes a search over all property types to find ones that match the given name and namespace, including partial matches + # @param search_term [SearchTerm] + # @param [Hash] opts the optional parameters + # @return [Array<(SearchResult, Integer, Hash)>] SearchResult data, response status code and response headers + def execute_fqn_property_type_search_with_http_info(search_term, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.execute_fqn_property_type_search ...' + end + # verify the required parameter 'search_term' is set + if @api_client.config.client_side_validation && search_term.nil? + fail ArgumentError, "Missing the required parameter 'search_term' when calling SearchApi.execute_fqn_property_type_search" + end + # resource path + local_var_path = '/datastore/search/property_types/fqn' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(search_term) + + # return_type + return_type = opts[:return_type] || 'SearchResult' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#execute_fqn_property_type_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Executes a search over all organizations to find ones that match the given search term + # @param search_term [SearchTerm] + # @param [Hash] opts the optional parameters + # @return [SearchResult] + def execute_organization_search(search_term, opts = {}) + data, _status_code, _headers = execute_organization_search_with_http_info(search_term, opts) + data + end + + # Executes a search over all organizations to find ones that match the given search term + # @param search_term [SearchTerm] + # @param [Hash] opts the optional parameters + # @return [Array<(SearchResult, Integer, Hash)>] SearchResult data, response status code and response headers + def execute_organization_search_with_http_info(search_term, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.execute_organization_search ...' + end + # verify the required parameter 'search_term' is set + if @api_client.config.client_side_validation && search_term.nil? + fail ArgumentError, "Missing the required parameter 'search_term' when calling SearchApi.execute_organization_search" + end + # resource path + local_var_path = '/datastore/search/organizations' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(search_term) + + # return_type + return_type = opts[:return_type] || 'SearchResult' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#execute_organization_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Executes a search over all property types to find ones that match the given search term + # @param search_term [SearchTerm] + # @param [Hash] opts the optional parameters + # @return [SearchResult] + def execute_property_type_search(search_term, opts = {}) + data, _status_code, _headers = execute_property_type_search_with_http_info(search_term, opts) + data + end + + # Executes a search over all property types to find ones that match the given search term + # @param search_term [SearchTerm] + # @param [Hash] opts the optional parameters + # @return [Array<(SearchResult, Integer, Hash)>] SearchResult data, response status code and response headers + def execute_property_type_search_with_http_info(search_term, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.execute_property_type_search ...' + end + # verify the required parameter 'search_term' is set + if @api_client.config.client_side_validation && search_term.nil? + fail ArgumentError, "Missing the required parameter 'search_term' when calling SearchApi.execute_property_type_search" + end + # resource path + local_var_path = '/datastore/search/property_types' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(search_term) + + # return_type + return_type = opts[:return_type] || 'SearchResult' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#execute_property_type_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Executes a search over all existing entity sets to populate the home page. The path parameters instruct which page to return and how large the page should be. + # @param start [Integer] The first result number to return + # @param num_results [Integer] The total number of results to return + # @param [Hash] opts the optional parameters + # @return [Array] + def get_entity_sets(start, num_results, opts = {}) + data, _status_code, _headers = get_entity_sets_with_http_info(start, num_results, opts) + data + end + + # Executes a search over all existing entity sets to populate the home page. The path parameters instruct which page to return and how large the page should be. + # @param start [Integer] The first result number to return + # @param num_results [Integer] The total number of results to return + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_entity_sets_with_http_info(start, num_results, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.get_entity_sets ...' + end + # verify the required parameter 'start' is set + if @api_client.config.client_side_validation && start.nil? + fail ArgumentError, "Missing the required parameter 'start' when calling SearchApi.get_entity_sets" + end + # verify the required parameter 'num_results' is set + if @api_client.config.client_side_validation && num_results.nil? + fail ArgumentError, "Missing the required parameter 'num_results' when calling SearchApi.get_entity_sets" + end + # resource path + local_var_path = '/datastore/search/entity-sets/{start}/{numResults}'.sub('{' + 'start' + '}', CGI.escape(start.to_s)).sub('{' + 'numResults' + '}', CGI.escape(num_results.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#get_entity_sets\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Get the most popular entity sets. + # @param [Hash] opts the optional parameters + # @return [Array] + def get_popular_entity_set(opts = {}) + data, _status_code, _headers = get_popular_entity_set_with_http_info(opts) + data + end + + # Get the most popular entity sets. + # @param [Hash] opts the optional parameters + # @return [Array<(Array, Integer, Hash)>] Array data, response status code and response headers + def get_popular_entity_set_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.get_popular_entity_set ...' + end + # resource path + local_var_path = '/datastore/search/popular' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Array' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#get_popular_entity_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Executes a search over the data of a given entity set to find rows that match the search term + # @param search_constraints [SearchConstraints] + # @param [Hash] opts the optional parameters + # @return [DataSearchResult] + def search_entity_set_data(search_constraints, opts = {}) + data, _status_code, _headers = search_entity_set_data_with_http_info(search_constraints, opts) + data + end + + # Executes a search over the data of a given entity set to find rows that match the search term + # @param search_constraints [SearchConstraints] + # @param [Hash] opts the optional parameters + # @return [Array<(DataSearchResult, Integer, Hash)>] DataSearchResult data, response status code and response headers + def search_entity_set_data_with_http_info(search_constraints, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: SearchApi.search_entity_set_data ...' + end + # verify the required parameter 'search_constraints' is set + if @api_client.config.client_side_validation && search_constraints.nil? + fail ArgumentError, "Missing the required parameter 'search_constraints' when calling SearchApi.search_entity_set_data" + end + # resource path + local_var_path = '/datastore/search' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(search_constraints) + + # return_type + return_type = opts[:return_type] || 'DataSearchResult' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: SearchApi#search_entity_set_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + end +end diff --git a/ruby/lib/openapi_client/api/shuttle_api.rb b/ruby/lib/openapi_client/api/shuttle_api.rb new file mode 100644 index 0000000..7095be6 --- /dev/null +++ b/ruby/lib/openapi_client/api/shuttle_api.rb @@ -0,0 +1,512 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'cgi' + +module OpenapiClient + class ShuttleApi + attr_accessor :api_client + + def initialize(api_client = ApiClient.default) + @api_client = api_client + end + # Creates a new integration definition for running recurring integrations + # @param integration_name [String] + # @param integration [Integration] + # @param [Hash] opts the optional parameters + # @return [String] + def create_integration_definition(integration_name, integration, opts = {}) + data, _status_code, _headers = create_integration_definition_with_http_info(integration_name, integration, opts) + data + end + + # Creates a new integration definition for running recurring integrations + # @param integration_name [String] + # @param integration [Integration] + # @param [Hash] opts the optional parameters + # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers + def create_integration_definition_with_http_info(integration_name, integration, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: ShuttleApi.create_integration_definition ...' + end + # verify the required parameter 'integration_name' is set + if @api_client.config.client_side_validation && integration_name.nil? + fail ArgumentError, "Missing the required parameter 'integration_name' when calling ShuttleApi.create_integration_definition" + end + # verify the required parameter 'integration' is set + if @api_client.config.client_side_validation && integration.nil? + fail ArgumentError, "Missing the required parameter 'integration' when calling ShuttleApi.create_integration_definition" + end + # resource path + local_var_path = '/shuttle/integration/definition/{integrationName}'.sub('{' + 'integrationName' + '}', CGI.escape(integration_name.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(integration) + + # return_type + return_type = opts[:return_type] || 'String' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: ShuttleApi#create_integration_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Replaces any number of fields within an existing integration definition + # @param integration_name [String] + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_integration_definition(integration_name, opts = {}) + delete_integration_definition_with_http_info(integration_name, opts) + nil + end + + # Replaces any number of fields within an existing integration definition + # @param integration_name [String] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def delete_integration_definition_with_http_info(integration_name, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: ShuttleApi.delete_integration_definition ...' + end + # verify the required parameter 'integration_name' is set + if @api_client.config.client_side_validation && integration_name.nil? + fail ArgumentError, "Missing the required parameter 'integration_name' when calling ShuttleApi.delete_integration_definition" + end + # resource path + local_var_path = '/shuttle/integration/definition/{integrationName}'.sub('{' + 'integrationName' + '}', CGI.escape(integration_name.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: ShuttleApi#delete_integration_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Deletes an integration job status from the integrationJobs map + # @param job_id [String] the unique id of the integration job + # @param [Hash] opts the optional parameters + # @return [nil] + def delete_integration_job_status(job_id, opts = {}) + delete_integration_job_status_with_http_info(job_id, opts) + nil + end + + # Deletes an integration job status from the integrationJobs map + # @param job_id [String] the unique id of the integration job + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def delete_integration_job_status_with_http_info(job_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: ShuttleApi.delete_integration_job_status ...' + end + # verify the required parameter 'job_id' is set + if @api_client.config.client_side_validation && job_id.nil? + fail ArgumentError, "Missing the required parameter 'job_id' when calling ShuttleApi.delete_integration_job_status" + end + # resource path + local_var_path = '/shuttle/integration/status/{jobId}'.sub('{' + 'jobId' + '}', CGI.escape(job_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: ShuttleApi#delete_integration_job_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Enqueues an integration on Shuttle Server for a given integration + # @param integration_name [String] the name of the integration to be run + # @param integration_key [String] the unique id used to authenticate an integration run + # @param [Hash] opts the optional parameters + # @return [String] + def enqueue_integration(integration_name, integration_key, opts = {}) + data, _status_code, _headers = enqueue_integration_with_http_info(integration_name, integration_key, opts) + data + end + + # Enqueues an integration on Shuttle Server for a given integration + # @param integration_name [String] the name of the integration to be run + # @param integration_key [String] the unique id used to authenticate an integration run + # @param [Hash] opts the optional parameters + # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers + def enqueue_integration_with_http_info(integration_name, integration_key, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: ShuttleApi.enqueue_integration ...' + end + # verify the required parameter 'integration_name' is set + if @api_client.config.client_side_validation && integration_name.nil? + fail ArgumentError, "Missing the required parameter 'integration_name' when calling ShuttleApi.enqueue_integration" + end + # verify the required parameter 'integration_key' is set + if @api_client.config.client_side_validation && integration_key.nil? + fail ArgumentError, "Missing the required parameter 'integration_key' when calling ShuttleApi.enqueue_integration" + end + # resource path + local_var_path = '/shuttle/integration/{integrationName}/{integrationKey}'.sub('{' + 'integrationName' + '}', CGI.escape(integration_name.to_s)).sub('{' + 'integrationKey' + '}', CGI.escape(integration_key.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'String' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: ShuttleApi#enqueue_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Polls the statuses of all running integrations + # @param [Hash] opts the optional parameters + # @return [Hash] + def poll_all_integrations(opts = {}) + data, _status_code, _headers = poll_all_integrations_with_http_info(opts) + data + end + + # Polls the statuses of all running integrations + # @param [Hash] opts the optional parameters + # @return [Array<(Hash, Integer, Hash)>] Hash data, response status code and response headers + def poll_all_integrations_with_http_info(opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: ShuttleApi.poll_all_integrations ...' + end + # resource path + local_var_path = '/shuttle/integration/status' + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Hash' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: ShuttleApi#poll_all_integrations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Polls the status of an integration + # @param job_id [String] the unique id of the integration job + # @param [Hash] opts the optional parameters + # @return [String] + def poll_integration(job_id, opts = {}) + data, _status_code, _headers = poll_integration_with_http_info(job_id, opts) + data + end + + # Polls the status of an integration + # @param job_id [String] the unique id of the integration job + # @param [Hash] opts the optional parameters + # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers + def poll_integration_with_http_info(job_id, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: ShuttleApi.poll_integration ...' + end + # verify the required parameter 'job_id' is set + if @api_client.config.client_side_validation && job_id.nil? + fail ArgumentError, "Missing the required parameter 'job_id' when calling ShuttleApi.poll_integration" + end + # resource path + local_var_path = '/shuttle/integration/status/{jobId}'.sub('{' + 'jobId' + '}', CGI.escape(job_id.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'String' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: ShuttleApi#poll_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Gets an existing integration definition + # @param integration_name [String] + # @param [Hash] opts the optional parameters + # @return [Integration] + def read_integration_definition(integration_name, opts = {}) + data, _status_code, _headers = read_integration_definition_with_http_info(integration_name, opts) + data + end + + # Gets an existing integration definition + # @param integration_name [String] + # @param [Hash] opts the optional parameters + # @return [Array<(Integration, Integer, Hash)>] Integration data, response status code and response headers + def read_integration_definition_with_http_info(integration_name, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: ShuttleApi.read_integration_definition ...' + end + # verify the required parameter 'integration_name' is set + if @api_client.config.client_side_validation && integration_name.nil? + fail ArgumentError, "Missing the required parameter 'integration_name' when calling ShuttleApi.read_integration_definition" + end + # resource path + local_var_path = '/shuttle/integration/definition/{integrationName}'.sub('{' + 'integrationName' + '}', CGI.escape(integration_name.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Accept' (if needed) + header_params['Accept'] = @api_client.select_header_accept(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] + + # return_type + return_type = opts[:return_type] || 'Integration' + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: ShuttleApi#read_integration_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + + # Replaces any number of fields within an existing integration definition + # @param integration_name [String] + # @param integration_update [IntegrationUpdate] + # @param [Hash] opts the optional parameters + # @return [nil] + def update_integration_definition(integration_name, integration_update, opts = {}) + update_integration_definition_with_http_info(integration_name, integration_update, opts) + nil + end + + # Replaces any number of fields within an existing integration definition + # @param integration_name [String] + # @param integration_update [IntegrationUpdate] + # @param [Hash] opts the optional parameters + # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers + def update_integration_definition_with_http_info(integration_name, integration_update, opts = {}) + if @api_client.config.debugging + @api_client.config.logger.debug 'Calling API: ShuttleApi.update_integration_definition ...' + end + # verify the required parameter 'integration_name' is set + if @api_client.config.client_side_validation && integration_name.nil? + fail ArgumentError, "Missing the required parameter 'integration_name' when calling ShuttleApi.update_integration_definition" + end + # verify the required parameter 'integration_update' is set + if @api_client.config.client_side_validation && integration_update.nil? + fail ArgumentError, "Missing the required parameter 'integration_update' when calling ShuttleApi.update_integration_definition" + end + # resource path + local_var_path = '/shuttle/integration/definition/{integrationName}'.sub('{' + 'integrationName' + '}', CGI.escape(integration_name.to_s)) + + # query parameters + query_params = opts[:query_params] || {} + + # header parameters + header_params = opts[:header_params] || {} + # HTTP header 'Content-Type' + header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) + + # form parameters + form_params = opts[:form_params] || {} + + # http body (model) + post_body = opts[:body] || @api_client.object_to_http_body(integration_update) + + # return_type + return_type = opts[:return_type] + + # auth_names + auth_names = opts[:auth_names] || ['http_auth', 'openlattice_auth'] + + new_options = opts.merge( + :header_params => header_params, + :query_params => query_params, + :form_params => form_params, + :body => post_body, + :auth_names => auth_names, + :return_type => return_type + ) + + data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options) + if @api_client.config.debugging + @api_client.config.logger.debug "API called: ShuttleApi#update_integration_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" + end + return data, status_code, headers + end + end +end diff --git a/ruby/lib/openapi_client/api_client.rb b/ruby/lib/openapi_client/api_client.rb new file mode 100644 index 0000000..da87ff1 --- /dev/null +++ b/ruby/lib/openapi_client/api_client.rb @@ -0,0 +1,388 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' +require 'json' +require 'logger' +require 'tempfile' +require 'typhoeus' + +module OpenapiClient + class ApiClient + # The Configuration object holding settings to be used in the API client. + attr_accessor :config + + # Defines the headers to be used in HTTP requests of all API calls by default. + # + # @return [Hash] + attr_accessor :default_headers + + # Initializes the ApiClient + # @option config [Configuration] Configuration for initializing the object, default to Configuration.default + def initialize(config = Configuration.default) + @config = config + @user_agent = "OpenAPI-Generator/#{VERSION}/ruby" + @default_headers = { + 'Content-Type' => 'application/json', + 'User-Agent' => @user_agent + } + end + + def self.default + @@default ||= ApiClient.new + end + + # Call an API with given options. + # + # @return [Array<(Object, Integer, Hash)>] an array of 3 elements: + # the data deserialized from response body (could be nil), response status code and response headers. + def call_api(http_method, path, opts = {}) + request = build_request(http_method, path, opts) + response = request.run + + if @config.debugging + @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n" + end + + unless response.success? + if response.timed_out? + fail ApiError.new('Connection timed out') + elsif response.code == 0 + # Errors from libcurl will be made visible here + fail ApiError.new(:code => 0, + :message => response.return_message) + else + fail ApiError.new(:code => response.code, + :response_headers => response.headers, + :response_body => response.body), + response.status_message + end + end + + if opts[:return_type] + data = deserialize(response, opts[:return_type]) + else + data = nil + end + return data, response.code, response.headers + end + + # Builds the HTTP request + # + # @param [String] http_method HTTP method/verb (e.g. POST) + # @param [String] path URL path (e.g. /account/new) + # @option opts [Hash] :header_params Header parameters + # @option opts [Hash] :query_params Query parameters + # @option opts [Hash] :form_params Query parameters + # @option opts [Object] :body HTTP body (JSON/XML) + # @return [Typhoeus::Request] A Typhoeus Request + def build_request(http_method, path, opts = {}) + url = build_request_url(path) + http_method = http_method.to_sym.downcase + + header_params = @default_headers.merge(opts[:header_params] || {}) + query_params = opts[:query_params] || {} + form_params = opts[:form_params] || {} + + update_params_for_auth! header_params, query_params, opts[:auth_names] + + # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false) + _verify_ssl_host = @config.verify_ssl_host ? 2 : 0 + + req_opts = { + :method => http_method, + :headers => header_params, + :params => query_params, + :params_encoding => @config.params_encoding, + :timeout => @config.timeout, + :ssl_verifypeer => @config.verify_ssl, + :ssl_verifyhost => _verify_ssl_host, + :sslcert => @config.cert_file, + :sslkey => @config.key_file, + :verbose => @config.debugging + } + + # set custom cert, if provided + req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert + + if [:post, :patch, :put, :delete].include?(http_method) + req_body = build_request_body(header_params, form_params, opts[:body]) + req_opts.update :body => req_body + if @config.debugging + @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n" + end + end + + request = Typhoeus::Request.new(url, req_opts) + download_file(request) if opts[:return_type] == 'File' + request + end + + # Builds the HTTP request body + # + # @param [Hash] header_params Header parameters + # @param [Hash] form_params Query parameters + # @param [Object] body HTTP body (JSON/XML) + # @return [String] HTTP body data in the form of string + def build_request_body(header_params, form_params, body) + # http form + if header_params['Content-Type'] == 'application/x-www-form-urlencoded' || + header_params['Content-Type'] == 'multipart/form-data' + data = {} + form_params.each do |key, value| + case value + when ::File, ::Array, nil + # let typhoeus handle File, Array and nil parameters + data[key] = value + else + data[key] = value.to_s + end + end + elsif body + data = body.is_a?(String) ? body : body.to_json + else + data = nil + end + data + end + + # Check if the given MIME is a JSON MIME. + # JSON MIME examples: + # application/json + # application/json; charset=UTF8 + # APPLICATION/JSON + # */* + # @param [String] mime MIME + # @return [Boolean] True if the MIME is application/json + def json_mime?(mime) + (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil? + end + + # Deserialize the response to the given return type. + # + # @param [Response] response HTTP response + # @param [String] return_type some examples: "User", "Array", "Hash" + def deserialize(response, return_type) + body = response.body + + # handle file downloading - return the File instance processed in request callbacks + # note that response body is empty when the file is written in chunks in request on_body callback + return @tempfile if return_type == 'File' + + return nil if body.nil? || body.empty? + + # return response body directly for String return type + return body if return_type == 'String' + + # ensuring a default content type + content_type = response.headers['Content-Type'] || 'application/json' + + fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type) + + begin + data = JSON.parse("[#{body}]", :symbolize_names => true)[0] + rescue JSON::ParserError => e + if %w(String Date DateTime).include?(return_type) + data = body + else + raise e + end + end + + convert_to_type data, return_type + end + + # Convert data to the given return type. + # @param [Object] data Data to be converted + # @param [String] return_type Return type + # @return [Mixed] Data in a particular type + def convert_to_type(data, return_type) + return nil if data.nil? + case return_type + when 'String' + data.to_s + when 'Integer' + data.to_i + when 'Float' + data.to_f + when 'Boolean' + data == true + when 'DateTime' + # parse date time (expecting ISO 8601 format) + DateTime.parse data + when 'Date' + # parse date time (expecting ISO 8601 format) + Date.parse data + when 'Object' + # generic object (usually a Hash), return directly + data + when /\AArray<(.+)>\z/ + # e.g. Array + sub_type = $1 + data.map { |item| convert_to_type(item, sub_type) } + when /\AHash\\z/ + # e.g. Hash + sub_type = $1 + {}.tap do |hash| + data.each { |k, v| hash[k] = convert_to_type(v, sub_type) } + end + else + # models, e.g. Pet + OpenapiClient.const_get(return_type).build_from_hash(data) + end + end + + # Save response body into a file in (the defined) temporary folder, using the filename + # from the "Content-Disposition" header if provided, otherwise a random filename. + # The response body is written to the file in chunks in order to handle files which + # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby + # process can use. + # + # @see Configuration#temp_folder_path + def download_file(request) + tempfile = nil + encoding = nil + request.on_headers do |response| + content_disposition = response.headers['Content-Disposition'] + if content_disposition && content_disposition =~ /filename=/i + filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1] + prefix = sanitize_filename(filename) + else + prefix = 'download-' + end + prefix = prefix + '-' unless prefix.end_with?('-') + encoding = response.body.encoding + tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding) + @tempfile = tempfile + end + request.on_body do |chunk| + chunk.force_encoding(encoding) + tempfile.write(chunk) + end + request.on_complete do |response| + if tempfile + tempfile.close + @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\ + "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\ + "will be deleted automatically with GC. It's also recommended to delete the temp file "\ + "explicitly with `tempfile.delete`" + end + end + end + + # Sanitize filename by removing path. + # e.g. ../../sun.gif becomes sun.gif + # + # @param [String] filename the filename to be sanitized + # @return [String] the sanitized filename + def sanitize_filename(filename) + filename.gsub(/.*[\/\\]/, '') + end + + def build_request_url(path) + # Add leading and trailing slashes to path + path = "/#{path}".gsub(/\/+/, '/') + @config.base_url + path + end + + # Update hearder and query params based on authentication settings. + # + # @param [Hash] header_params Header parameters + # @param [Hash] query_params Query parameters + # @param [String] auth_names Authentication scheme name + def update_params_for_auth!(header_params, query_params, auth_names) + Array(auth_names).each do |auth_name| + auth_setting = @config.auth_settings[auth_name] + next unless auth_setting + case auth_setting[:in] + when 'header' then header_params[auth_setting[:key]] = auth_setting[:value] + when 'query' then query_params[auth_setting[:key]] = auth_setting[:value] + else fail ArgumentError, 'Authentication token must be in `query` of `header`' + end + end + end + + # Sets user agent in HTTP header + # + # @param [String] user_agent User agent (e.g. openapi-generator/ruby/1.0.0) + def user_agent=(user_agent) + @user_agent = user_agent + @default_headers['User-Agent'] = @user_agent + end + + # Return Accept header based on an array of accepts provided. + # @param [Array] accepts array for Accept + # @return [String] the Accept header (e.g. application/json) + def select_header_accept(accepts) + return nil if accepts.nil? || accepts.empty? + # use JSON when present, otherwise use all of the provided + json_accept = accepts.find { |s| json_mime?(s) } + json_accept || accepts.join(',') + end + + # Return Content-Type header based on an array of content types provided. + # @param [Array] content_types array for Content-Type + # @return [String] the Content-Type header (e.g. application/json) + def select_header_content_type(content_types) + # use application/json by default + return 'application/json' if content_types.nil? || content_types.empty? + # use JSON when present, otherwise use the first one + json_content_type = content_types.find { |s| json_mime?(s) } + json_content_type || content_types.first + end + + # Convert object (array, hash, object, etc) to JSON string. + # @param [Object] model object to be converted into JSON string + # @return [String] JSON string representation of the object + def object_to_http_body(model) + return model if model.nil? || model.is_a?(String) + local_body = nil + if model.is_a?(Array) + local_body = model.map { |m| object_to_hash(m) } + else + local_body = object_to_hash(model) + end + local_body.to_json + end + + # Convert object(non-array) to hash. + # @param [Object] obj object to be converted into JSON string + # @return [String] JSON string representation of the object + def object_to_hash(obj) + if obj.respond_to?(:to_hash) + obj.to_hash + else + obj + end + end + + # Build parameter value according to the given collection format. + # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi + def build_collection_param(param, collection_format) + case collection_format + when :csv + param.join(',') + when :ssv + param.join(' ') + when :tsv + param.join("\t") + when :pipes + param.join('|') + when :multi + # return the array directly as typhoeus will handle it as expected + param + else + fail "unknown collection format: #{collection_format.inspect}" + end + end + end +end diff --git a/ruby/lib/openapi_client/api_error.rb b/ruby/lib/openapi_client/api_error.rb new file mode 100644 index 0000000..e74e1a6 --- /dev/null +++ b/ruby/lib/openapi_client/api_error.rb @@ -0,0 +1,57 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +module OpenapiClient + class ApiError < StandardError + attr_reader :code, :response_headers, :response_body + + # Usage examples: + # ApiError.new + # ApiError.new("message") + # ApiError.new(:code => 500, :response_headers => {}, :response_body => "") + # ApiError.new(:code => 404, :message => "Not Found") + def initialize(arg = nil) + if arg.is_a? Hash + if arg.key?(:message) || arg.key?('message') + super(arg[:message] || arg['message']) + else + super arg + end + + arg.each do |k, v| + instance_variable_set "@#{k}", v + end + else + super arg + end + end + + # Override to_s to display a friendly error message + def to_s + message + end + + def message + if @message.nil? + msg = "Error message: the server returns an error" + else + msg = @message + end + + msg += "\nHTTP status code: #{code}" if code + msg += "\nResponse headers: #{response_headers}" if response_headers + msg += "\nResponse body: #{response_body}" if response_body + + msg + end + end +end diff --git a/ruby/lib/openapi_client/configuration.rb b/ruby/lib/openapi_client/configuration.rb new file mode 100644 index 0000000..d109b84 --- /dev/null +++ b/ruby/lib/openapi_client/configuration.rb @@ -0,0 +1,264 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +module OpenapiClient + class Configuration + # Defines url scheme + attr_accessor :scheme + + # Defines url host + attr_accessor :host + + # Defines url base path + attr_accessor :base_path + + # Defines API keys used with API Key authentications. + # + # @return [Hash] key: parameter name, value: parameter value (API key) + # + # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string) + # config.api_key['api_key'] = 'xxx' + attr_accessor :api_key + + # Defines API key prefixes used with API Key authentications. + # + # @return [Hash] key: parameter name, value: API key prefix + # + # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers) + # config.api_key_prefix['api_key'] = 'Token' + attr_accessor :api_key_prefix + + # Defines the username used with HTTP basic authentication. + # + # @return [String] + attr_accessor :username + + # Defines the password used with HTTP basic authentication. + # + # @return [String] + attr_accessor :password + + # Defines the access token (Bearer) used with OAuth2. + attr_accessor :access_token + + # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response + # details will be logged with `logger.debug` (see the `logger` attribute). + # Default to false. + # + # @return [true, false] + attr_accessor :debugging + + # Defines the logger used for debugging. + # Default to `Rails.logger` (when in Rails) or logging to STDOUT. + # + # @return [#debug] + attr_accessor :logger + + # Defines the temporary folder to store downloaded files + # (for API endpoints that have file response). + # Default to use `Tempfile`. + # + # @return [String] + attr_accessor :temp_folder_path + + # The time limit for HTTP request in seconds. + # Default to 0 (never times out). + attr_accessor :timeout + + # Set this to false to skip client side validation in the operation. + # Default to true. + # @return [true, false] + attr_accessor :client_side_validation + + ### TLS/SSL setting + # Set this to false to skip verifying SSL certificate when calling API from https server. + # Default to true. + # + # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks. + # + # @return [true, false] + attr_accessor :verify_ssl + + ### TLS/SSL setting + # Set this to false to skip verifying SSL host name + # Default to true. + # + # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks. + # + # @return [true, false] + attr_accessor :verify_ssl_host + + ### TLS/SSL setting + # Set this to customize the certificate file to verify the peer. + # + # @return [String] the path to the certificate file + # + # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code: + # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145 + attr_accessor :ssl_ca_cert + + ### TLS/SSL setting + # Client certificate file (for client certificate) + attr_accessor :cert_file + + ### TLS/SSL setting + # Client private key file (for client certificate) + attr_accessor :key_file + + # Set this to customize parameters encoding of array parameter with multi collectionFormat. + # Default to nil. + # + # @see The params_encoding option of Ethon. Related source code: + # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96 + attr_accessor :params_encoding + + attr_accessor :inject_format + + attr_accessor :force_ending_format + + def initialize + @scheme = 'https' + @host = 'api.openlattice.com' + @base_path = '' + @api_key = {} + @api_key_prefix = {} + @timeout = 0 + @client_side_validation = true + @verify_ssl = true + @verify_ssl_host = true + @params_encoding = nil + @cert_file = nil + @key_file = nil + @debugging = false + @inject_format = false + @force_ending_format = false + @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT) + + yield(self) if block_given? + end + + # The default Configuration object. + def self.default + @@default ||= Configuration.new + end + + def configure + yield(self) if block_given? + end + + def scheme=(scheme) + # remove :// from scheme + @scheme = scheme.sub(/:\/\//, '') + end + + def host=(host) + # remove http(s):// and anything after a slash + @host = host.sub(/https?:\/\//, '').split('/').first + end + + def base_path=(base_path) + # Add leading and trailing slashes to base_path + @base_path = "/#{base_path}".gsub(/\/+/, '/') + @base_path = '' if @base_path == '/' + end + + def base_url + "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') + end + + # Gets API key (with prefix if set). + # @param [String] param_name the parameter name of API key auth + def api_key_with_prefix(param_name) + if @api_key_prefix[param_name] + "#{@api_key_prefix[param_name]} #{@api_key[param_name]}" + else + @api_key[param_name] + end + end + + # Gets Basic Auth token string + def basic_auth_token + 'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n") + end + + # Returns Auth Settings hash for api client. + def auth_settings + { + 'http_auth' => + { + type: 'bearer', + in: 'header', + format: 'JWT', + key: 'Authorization', + value: "Bearer #{access_token}" + }, + 'openlattice_auth' => + { + type: 'api_key', + in: 'header', + key: 'Authorization', + value: api_key_with_prefix('Authorization') + }, + } + end + + # Returns an array of Server setting + def server_settings + [ + { + url: "https://api.openlattice.com", + description: "Production OpenLattice API", + }, + { + url: "https://api.staging.openlattice.com", + description: "Staging OpenLattice API", + }, + { + url: "http://localhost:8080", + description: "Local OpenLattice API", + } + ] + end + + # Returns URL based on server settings + # + # @param index array index of the server settings + # @param variables hash of variable and the corresponding value + def server_url(index, variables = {}) + servers = server_settings + + # check array index out of bound + if (index < 0 || index >= servers.size) + fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}" + end + + server = servers[index] + url = server[:url] + + # go through variable and assign a value + server[:variables].each do |name, variable| + if variables.key?(name) + if (server[:variables][name][:enum_values].include? variables[name]) + url.gsub! "{" + name.to_s + "}", variables[name] + else + fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}." + end + else + # use default value + url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value] + end + end + + url + end + end +end diff --git a/ruby/lib/openapi_client/models/access_check.rb b/ruby/lib/openapi_client/models/access_check.rb new file mode 100644 index 0000000..3f94ad4 --- /dev/null +++ b/ruby/lib/openapi_client/models/access_check.rb @@ -0,0 +1,241 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class AccessCheck + attr_accessor :acl_key + + attr_accessor :permissions + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'acl_key' => :'aclKey', + :'permissions' => :'permissions' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'acl_key' => :'Array', + :'permissions' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::AccessCheck` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::AccessCheck`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'acl_key') + if (value = attributes[:'acl_key']).is_a?(Array) + self.acl_key = value + end + end + + if attributes.key?(:'permissions') + if (value = attributes[:'permissions']).is_a?(Array) + self.permissions = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + acl_key == o.acl_key && + permissions == o.permissions + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [acl_key, permissions].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/ace.rb b/ruby/lib/openapi_client/models/ace.rb new file mode 100644 index 0000000..715d40a --- /dev/null +++ b/ruby/lib/openapi_client/models/ace.rb @@ -0,0 +1,217 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class Ace + attr_accessor :principal + + attr_accessor :permissions + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'principal' => :'principal', + :'permissions' => :'permissions' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'principal' => :'Principal', + :'permissions' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Ace` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Ace`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'principal') + self.principal = attributes[:'principal'] + end + + if attributes.key?(:'permissions') + if (value = attributes[:'permissions']).is_a?(Array) + self.permissions = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + principal == o.principal && + permissions == o.permissions + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [principal, permissions].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/acl.rb b/ruby/lib/openapi_client/models/acl.rb new file mode 100644 index 0000000..6797854 --- /dev/null +++ b/ruby/lib/openapi_client/models/acl.rb @@ -0,0 +1,219 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class Acl + attr_accessor :acl_key + + attr_accessor :aces + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'acl_key' => :'aclKey', + :'aces' => :'aces' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'acl_key' => :'Array', + :'aces' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Acl` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Acl`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'acl_key') + if (value = attributes[:'acl_key']).is_a?(Array) + self.acl_key = value + end + end + + if attributes.key?(:'aces') + if (value = attributes[:'aces']).is_a?(Array) + self.aces = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + acl_key == o.acl_key && + aces == o.aces + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [acl_key, aces].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/acl_data.rb b/ruby/lib/openapi_client/models/acl_data.rb new file mode 100644 index 0000000..171d19b --- /dev/null +++ b/ruby/lib/openapi_client/models/acl_data.rb @@ -0,0 +1,215 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class AclData + attr_accessor :action + + attr_accessor :acl + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'action' => :'action', + :'acl' => :'acl' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'action' => :'String', + :'acl' => :'Acl' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::AclData` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::AclData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'action') + self.action = attributes[:'action'] + end + + if attributes.key?(:'acl') + self.acl = attributes[:'acl'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + action == o.action && + acl == o.acl + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [action, acl].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/advanced_search.rb b/ruby/lib/openapi_client/models/advanced_search.rb new file mode 100644 index 0000000..6f717fc --- /dev/null +++ b/ruby/lib/openapi_client/models/advanced_search.rb @@ -0,0 +1,226 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class AdvancedSearch + attr_accessor :search_fields + + attr_accessor :start + + attr_accessor :max_hits + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'search_fields' => :'searchFields', + :'start' => :'start', + :'max_hits' => :'maxHits' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'search_fields' => :'Array', + :'start' => :'Integer', + :'max_hits' => :'Integer' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::AdvancedSearch` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::AdvancedSearch`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'search_fields') + if (value = attributes[:'search_fields']).is_a?(Array) + self.search_fields = value + end + end + + if attributes.key?(:'start') + self.start = attributes[:'start'] + end + + if attributes.key?(:'max_hits') + self.max_hits = attributes[:'max_hits'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + search_fields == o.search_fields && + start == o.start && + max_hits == o.max_hits + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [search_fields, start, max_hits].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/association.rb b/ruby/lib/openapi_client/models/association.rb new file mode 100644 index 0000000..74fdfeb --- /dev/null +++ b/ruby/lib/openapi_client/models/association.rb @@ -0,0 +1,235 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class Association + attr_accessor :key + + attr_accessor :src + + attr_accessor :dst + + attr_accessor :details + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'key' => :'key', + :'src' => :'src', + :'dst' => :'dst', + :'details' => :'details' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'key' => :'EntityKey', + :'src' => :'EntityKey', + :'dst' => :'EntityKey', + :'details' => :'Hash' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Association` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Association`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'key') + self.key = attributes[:'key'] + end + + if attributes.key?(:'src') + self.src = attributes[:'src'] + end + + if attributes.key?(:'dst') + self.dst = attributes[:'dst'] + end + + if attributes.key?(:'details') + if (value = attributes[:'details']).is_a?(Hash) + self.details = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + key == o.key && + src == o.src && + dst == o.dst && + details == o.details + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [key, src, dst, details].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/association_definition.rb b/ruby/lib/openapi_client/models/association_definition.rb new file mode 100644 index 0000000..e790364 --- /dev/null +++ b/ruby/lib/openapi_client/models/association_definition.rb @@ -0,0 +1,287 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class AssociationDefinition + attr_accessor :fqn + + attr_accessor :entity_set_name + + attr_accessor :property_definitions + + attr_accessor :update_type + + attr_accessor :src + + attr_accessor :dst + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'fqn' => :'fqn', + :'entity_set_name' => :'entitySetName', + :'property_definitions' => :'propertyDefinitions', + :'update_type' => :'updateType', + :'src' => :'src', + :'dst' => :'dst' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'fqn' => :'FullQualifiedName', + :'entity_set_name' => :'String', + :'property_definitions' => :'Hash', + :'update_type' => :'String', + :'src' => :'String', + :'dst' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::AssociationDefinition` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::AssociationDefinition`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'fqn') + self.fqn = attributes[:'fqn'] + end + + if attributes.key?(:'entity_set_name') + self.entity_set_name = attributes[:'entity_set_name'] + end + + if attributes.key?(:'property_definitions') + if (value = attributes[:'property_definitions']).is_a?(Hash) + self.property_definitions = value + end + end + + if attributes.key?(:'update_type') + self.update_type = attributes[:'update_type'] + end + + if attributes.key?(:'src') + self.src = attributes[:'src'] + end + + if attributes.key?(:'dst') + self.dst = attributes[:'dst'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + update_type_validator = EnumAttributeValidator.new('String', ["Replace", "PartialReplace", "Merge"]) + return false unless update_type_validator.valid?(@update_type) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] update_type Object to be assigned + def update_type=(update_type) + validator = EnumAttributeValidator.new('String', ["Replace", "PartialReplace", "Merge"]) + unless validator.valid?(update_type) + fail ArgumentError, "invalid value for \"update_type\", must be one of #{validator.allowable_values}." + end + @update_type = update_type + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + fqn == o.fqn && + entity_set_name == o.entity_set_name && + property_definitions == o.property_definitions && + update_type == o.update_type && + src == o.src && + dst == o.dst + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [fqn, entity_set_name, property_definitions, update_type, src, dst].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/association_type.rb b/ruby/lib/openapi_client/models/association_type.rb new file mode 100644 index 0000000..cbb6b71 --- /dev/null +++ b/ruby/lib/openapi_client/models/association_type.rb @@ -0,0 +1,237 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class AssociationType + attr_accessor :entity_type + + attr_accessor :src + + attr_accessor :dst + + attr_accessor :bidirectional + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'entity_type' => :'entityType', + :'src' => :'src', + :'dst' => :'dst', + :'bidirectional' => :'bidirectional' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'entity_type' => :'EntityType', + :'src' => :'Array', + :'dst' => :'Array', + :'bidirectional' => :'Boolean' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::AssociationType` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::AssociationType`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'entity_type') + self.entity_type = attributes[:'entity_type'] + end + + if attributes.key?(:'src') + if (value = attributes[:'src']).is_a?(Array) + self.src = value + end + end + + if attributes.key?(:'dst') + if (value = attributes[:'dst']).is_a?(Array) + self.dst = value + end + end + + if attributes.key?(:'bidirectional') + self.bidirectional = attributes[:'bidirectional'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + entity_type == o.entity_type && + src == o.src && + dst == o.dst && + bidirectional == o.bidirectional + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [entity_type, src, dst, bidirectional].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/auth0user_basic.rb b/ruby/lib/openapi_client/models/auth0user_basic.rb new file mode 100644 index 0000000..3600502 --- /dev/null +++ b/ruby/lib/openapi_client/models/auth0user_basic.rb @@ -0,0 +1,255 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class Auth0userBasic + attr_accessor :user_id + + attr_accessor :email + + attr_accessor :nickname + + attr_accessor :username + + attr_accessor :roles + + attr_accessor :com_openlattice_organization + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'user_id' => :'user_id', + :'email' => :'email', + :'nickname' => :'nickname', + :'username' => :'username', + :'roles' => :'roles', + :'com_openlattice_organization' => :'com/openlattice/organization' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'user_id' => :'String', + :'email' => :'String', + :'nickname' => :'String', + :'username' => :'String', + :'roles' => :'Array', + :'com_openlattice_organization' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Auth0userBasic` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Auth0userBasic`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'user_id') + self.user_id = attributes[:'user_id'] + end + + if attributes.key?(:'email') + self.email = attributes[:'email'] + end + + if attributes.key?(:'nickname') + self.nickname = attributes[:'nickname'] + end + + if attributes.key?(:'username') + self.username = attributes[:'username'] + end + + if attributes.key?(:'roles') + if (value = attributes[:'roles']).is_a?(Array) + self.roles = value + end + end + + if attributes.key?(:'com_openlattice_organization') + if (value = attributes[:'com_openlattice_organization']).is_a?(Array) + self.com_openlattice_organization = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + user_id == o.user_id && + email == o.email && + nickname == o.nickname && + username == o.username && + roles == o.roles && + com_openlattice_organization == o.com_openlattice_organization + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [user_id, email, nickname, username, roles, com_openlattice_organization].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/authorization.rb b/ruby/lib/openapi_client/models/authorization.rb new file mode 100644 index 0000000..eb8bd1e --- /dev/null +++ b/ruby/lib/openapi_client/models/authorization.rb @@ -0,0 +1,219 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class Authorization + attr_accessor :acl_key + + attr_accessor :permissions + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'acl_key' => :'aclKey', + :'permissions' => :'permissions' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'acl_key' => :'Array', + :'permissions' => :'Hash' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Authorization` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Authorization`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'acl_key') + if (value = attributes[:'acl_key']).is_a?(Array) + self.acl_key = value + end + end + + if attributes.key?(:'permissions') + if (value = attributes[:'permissions']).is_a?(Hash) + self.permissions = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + acl_key == o.acl_key && + permissions == o.permissions + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [acl_key, permissions].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/authorized_objects_search_result.rb b/ruby/lib/openapi_client/models/authorized_objects_search_result.rb new file mode 100644 index 0000000..f942dfa --- /dev/null +++ b/ruby/lib/openapi_client/models/authorized_objects_search_result.rb @@ -0,0 +1,217 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class AuthorizedObjectsSearchResult + attr_accessor :paging_token + + attr_accessor :authorized_objects + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'paging_token' => :'pagingToken', + :'authorized_objects' => :'authorizedObjects' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'paging_token' => :'String', + :'authorized_objects' => :'Array>' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::AuthorizedObjectsSearchResult` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::AuthorizedObjectsSearchResult`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'paging_token') + self.paging_token = attributes[:'paging_token'] + end + + if attributes.key?(:'authorized_objects') + if (value = attributes[:'authorized_objects']).is_a?(Array) + self.authorized_objects = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + paging_token == o.paging_token && + authorized_objects == o.authorized_objects + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [paging_token, authorized_objects].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/bulk_data_creation.rb b/ruby/lib/openapi_client/models/bulk_data_creation.rb new file mode 100644 index 0000000..bfca246 --- /dev/null +++ b/ruby/lib/openapi_client/models/bulk_data_creation.rb @@ -0,0 +1,219 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class BulkDataCreation + attr_accessor :entities + + attr_accessor :associations + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'entities' => :'entities', + :'associations' => :'associations' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'entities' => :'Array', + :'associations' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::BulkDataCreation` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::BulkDataCreation`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'entities') + if (value = attributes[:'entities']).is_a?(Array) + self.entities = value + end + end + + if attributes.key?(:'associations') + if (value = attributes[:'associations']).is_a?(Array) + self.associations = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + entities == o.entities && + associations == o.associations + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [entities, associations].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/collection_template_type.rb b/ruby/lib/openapi_client/models/collection_template_type.rb new file mode 100644 index 0000000..4a50f40 --- /dev/null +++ b/ruby/lib/openapi_client/models/collection_template_type.rb @@ -0,0 +1,247 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class CollectionTemplateType + # An optional UUID for the collection template type. + attr_accessor :id + + # The unique name of the collection template type. + attr_accessor :name + + # The friendly name for the collection template type. + attr_accessor :title + + # A description of the collection template type. + attr_accessor :description + + # The id of the entity type that this collection template type wraps. + attr_accessor :entity_type_id + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'id' => :'id', + :'name' => :'name', + :'title' => :'title', + :'description' => :'description', + :'entity_type_id' => :'entityTypeId' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'id' => :'String', + :'name' => :'String', + :'title' => :'String', + :'description' => :'String', + :'entity_type_id' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::CollectionTemplateType` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::CollectionTemplateType`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.key?(:'name') + self.name = attributes[:'name'] + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + + if attributes.key?(:'entity_type_id') + self.entity_type_id = attributes[:'entity_type_id'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + id == o.id && + name == o.name && + title == o.title && + description == o.description && + entity_type_id == o.entity_type_id + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [id, name, title, description, entity_type_id].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/constraint.rb b/ruby/lib/openapi_client/models/constraint.rb new file mode 100644 index 0000000..e81ed8c --- /dev/null +++ b/ruby/lib/openapi_client/models/constraint.rb @@ -0,0 +1,355 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class Constraint + attr_accessor :type + + attr_accessor :search_term + + attr_accessor :fuzzy + + attr_accessor :search_fields + + attr_accessor :property_type_id + + attr_accessor :latitude + + attr_accessor :longitude + + attr_accessor :radius + + attr_accessor :unit + + attr_accessor :zones + + attr_accessor :start + + attr_accessor :_end + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'type' => :'type', + :'search_term' => :'searchTerm', + :'fuzzy' => :'fuzzy', + :'search_fields' => :'searchFields', + :'property_type_id' => :'propertyTypeId', + :'latitude' => :'latitude', + :'longitude' => :'longitude', + :'radius' => :'radius', + :'unit' => :'unit', + :'zones' => :'zones', + :'start' => :'start', + :'_end' => :'end' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'type' => :'String', + :'search_term' => :'String', + :'fuzzy' => :'Boolean', + :'search_fields' => :'Array', + :'property_type_id' => :'String', + :'latitude' => :'Float', + :'longitude' => :'Float', + :'radius' => :'Float', + :'unit' => :'String', + :'zones' => :'Array>>', + :'start' => :'DateTime', + :'_end' => :'DateTime' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Constraint` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Constraint`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + + if attributes.key?(:'search_term') + self.search_term = attributes[:'search_term'] + end + + if attributes.key?(:'fuzzy') + self.fuzzy = attributes[:'fuzzy'] + end + + if attributes.key?(:'search_fields') + if (value = attributes[:'search_fields']).is_a?(Array) + self.search_fields = value + end + end + + if attributes.key?(:'property_type_id') + self.property_type_id = attributes[:'property_type_id'] + end + + if attributes.key?(:'latitude') + self.latitude = attributes[:'latitude'] + end + + if attributes.key?(:'longitude') + self.longitude = attributes[:'longitude'] + end + + if attributes.key?(:'radius') + self.radius = attributes[:'radius'] + end + + if attributes.key?(:'unit') + self.unit = attributes[:'unit'] + end + + if attributes.key?(:'zones') + if (value = attributes[:'zones']).is_a?(Array) + self.zones = value + end + end + + if attributes.key?(:'start') + self.start = attributes[:'start'] + end + + if attributes.key?(:'_end') + self._end = attributes[:'_end'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + type_validator = EnumAttributeValidator.new('String', ["simple", "advanced", "geoDistance", "geoPolygon", "writeDateTimeFilter"]) + return false unless type_validator.valid?(@type) + unit_validator = EnumAttributeValidator.new('String', ["miles", "mi", "yards", "yd", "feet", "ft", "inch", "in", "kilometers", "km", "meters", "m", "centimeters", "cm", "millimeters", "mm", "nauticalmiles", "nmi", "NM"]) + return false unless unit_validator.valid?(@unit) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] type Object to be assigned + def type=(type) + validator = EnumAttributeValidator.new('String', ["simple", "advanced", "geoDistance", "geoPolygon", "writeDateTimeFilter"]) + unless validator.valid?(type) + fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." + end + @type = type + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] unit Object to be assigned + def unit=(unit) + validator = EnumAttributeValidator.new('String', ["miles", "mi", "yards", "yd", "feet", "ft", "inch", "in", "kilometers", "km", "meters", "m", "centimeters", "cm", "millimeters", "mm", "nauticalmiles", "nmi", "NM"]) + unless validator.valid?(unit) + fail ArgumentError, "invalid value for \"unit\", must be one of #{validator.allowable_values}." + end + @unit = unit + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + type == o.type && + search_term == o.search_term && + fuzzy == o.fuzzy && + search_fields == o.search_fields && + property_type_id == o.property_type_id && + latitude == o.latitude && + longitude == o.longitude && + radius == o.radius && + unit == o.unit && + zones == o.zones && + start == o.start && + _end == o._end + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [type, search_term, fuzzy, search_fields, property_type_id, latitude, longitude, radius, unit, zones, start, _end].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/constraint_group.rb b/ruby/lib/openapi_client/models/constraint_group.rb new file mode 100644 index 0000000..a31b7df --- /dev/null +++ b/ruby/lib/openapi_client/models/constraint_group.rb @@ -0,0 +1,217 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class ConstraintGroup + attr_accessor :min + + attr_accessor :constraints + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'min' => :'min', + :'constraints' => :'constraints' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'min' => :'Integer', + :'constraints' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::ConstraintGroup` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::ConstraintGroup`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'min') + self.min = attributes[:'min'] + end + + if attributes.key?(:'constraints') + if (value = attributes[:'constraints']).is_a?(Array) + self.constraints = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + min == o.min && + constraints == o.constraints + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [min, constraints].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/data_association.rb b/ruby/lib/openapi_client/models/data_association.rb new file mode 100644 index 0000000..b159f53 --- /dev/null +++ b/ruby/lib/openapi_client/models/data_association.rb @@ -0,0 +1,269 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class DataAssociation + # the ID of the source entity set + attr_accessor :src_entity_set_id + + # The index of an entity + attr_accessor :src_entity_index + + # An existing entityKeyId + attr_accessor :src_entity_key_id + + # the ID of the dst entity set + attr_accessor :dst_entity_set_id + + # The index of an entity + attr_accessor :dst_entity_index + + # An existing entityKeyId + attr_accessor :dst_entity_key_id + + # data + attr_accessor :data + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'src_entity_set_id' => :'srcEntitySetId', + :'src_entity_index' => :'srcEntityIndex', + :'src_entity_key_id' => :'srcEntityKeyId', + :'dst_entity_set_id' => :'dstEntitySetId', + :'dst_entity_index' => :'dstEntityIndex', + :'dst_entity_key_id' => :'dstEntityKeyId', + :'data' => :'data' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'src_entity_set_id' => :'String', + :'src_entity_index' => :'String', + :'src_entity_key_id' => :'String', + :'dst_entity_set_id' => :'String', + :'dst_entity_index' => :'String', + :'dst_entity_key_id' => :'String', + :'data' => :'Hash>' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::DataAssociation` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::DataAssociation`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'src_entity_set_id') + self.src_entity_set_id = attributes[:'src_entity_set_id'] + end + + if attributes.key?(:'src_entity_index') + self.src_entity_index = attributes[:'src_entity_index'] + end + + if attributes.key?(:'src_entity_key_id') + self.src_entity_key_id = attributes[:'src_entity_key_id'] + end + + if attributes.key?(:'dst_entity_set_id') + self.dst_entity_set_id = attributes[:'dst_entity_set_id'] + end + + if attributes.key?(:'dst_entity_index') + self.dst_entity_index = attributes[:'dst_entity_index'] + end + + if attributes.key?(:'dst_entity_key_id') + self.dst_entity_key_id = attributes[:'dst_entity_key_id'] + end + + if attributes.key?(:'data') + if (value = attributes[:'data']).is_a?(Hash) + self.data = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + src_entity_set_id == o.src_entity_set_id && + src_entity_index == o.src_entity_index && + src_entity_key_id == o.src_entity_key_id && + dst_entity_set_id == o.dst_entity_set_id && + dst_entity_index == o.dst_entity_index && + dst_entity_key_id == o.dst_entity_key_id && + data == o.data + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [src_entity_set_id, src_entity_index, src_entity_key_id, dst_entity_set_id, dst_entity_index, dst_entity_key_id, data].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/data_edge.rb b/ruby/lib/openapi_client/models/data_edge.rb new file mode 100644 index 0000000..6d7889f --- /dev/null +++ b/ruby/lib/openapi_client/models/data_edge.rb @@ -0,0 +1,224 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class DataEdge + attr_accessor :src + + attr_accessor :dst + + attr_accessor :data + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'src' => :'src', + :'dst' => :'dst', + :'data' => :'data' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'src' => :'EntityDataKey', + :'dst' => :'EntityDataKey', + :'data' => :'DataEdgeData' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::DataEdge` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::DataEdge`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'src') + self.src = attributes[:'src'] + end + + if attributes.key?(:'dst') + self.dst = attributes[:'dst'] + end + + if attributes.key?(:'data') + self.data = attributes[:'data'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + src == o.src && + dst == o.dst && + data == o.data + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [src, dst, data].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/data_edge_data.rb b/ruby/lib/openapi_client/models/data_edge_data.rb new file mode 100644 index 0000000..bcd2f15 --- /dev/null +++ b/ruby/lib/openapi_client/models/data_edge_data.rb @@ -0,0 +1,208 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class DataEdgeData + attr_accessor :additional_properties + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'additional_properties' => :'additionalProperties' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'additional_properties' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::DataEdgeData` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::DataEdgeData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'additional_properties') + if (value = attributes[:'additional_properties']).is_a?(Array) + self.additional_properties = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + additional_properties == o.additional_properties + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [additional_properties].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/data_edge_key.rb b/ruby/lib/openapi_client/models/data_edge_key.rb new file mode 100644 index 0000000..43297c5 --- /dev/null +++ b/ruby/lib/openapi_client/models/data_edge_key.rb @@ -0,0 +1,225 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + # Set of associations to create. An association is the triple of source, destination, and edge entity data keys. + class DataEdgeKey + attr_accessor :src + + attr_accessor :dst + + attr_accessor :edge + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'src' => :'src', + :'dst' => :'dst', + :'edge' => :'edge' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'src' => :'EntityDataKey', + :'dst' => :'EntityDataKey', + :'edge' => :'EntityDataKey' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::DataEdgeKey` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::DataEdgeKey`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'src') + self.src = attributes[:'src'] + end + + if attributes.key?(:'dst') + self.dst = attributes[:'dst'] + end + + if attributes.key?(:'edge') + self.edge = attributes[:'edge'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + src == o.src && + dst == o.dst && + edge == o.edge + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [src, dst, edge].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/data_graph.rb b/ruby/lib/openapi_client/models/data_graph.rb new file mode 100644 index 0000000..df87070 --- /dev/null +++ b/ruby/lib/openapi_client/models/data_graph.rb @@ -0,0 +1,219 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class DataGraph + attr_accessor :entities + + attr_accessor :associations + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'entities' => :'entities', + :'associations' => :'associations' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'entities' => :'Hash>>>', + :'associations' => :'Hash>' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::DataGraph` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::DataGraph`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'entities') + if (value = attributes[:'entities']).is_a?(Hash) + self.entities = value + end + end + + if attributes.key?(:'associations') + if (value = attributes[:'associations']).is_a?(Hash) + self.associations = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + entities == o.entities && + associations == o.associations + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [entities, associations].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/data_graph_ids.rb b/ruby/lib/openapi_client/models/data_graph_ids.rb new file mode 100644 index 0000000..8a84975 --- /dev/null +++ b/ruby/lib/openapi_client/models/data_graph_ids.rb @@ -0,0 +1,219 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class DataGraphIds + attr_accessor :entity_key_ids + + attr_accessor :entity_set_ids + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'entity_key_ids' => :'entityKeyIds', + :'entity_set_ids' => :'entitySetIds' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'entity_key_ids' => :'Hash>', + :'entity_set_ids' => :'Hash>' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::DataGraphIds` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::DataGraphIds`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'entity_key_ids') + if (value = attributes[:'entity_key_ids']).is_a?(Hash) + self.entity_key_ids = value + end + end + + if attributes.key?(:'entity_set_ids') + if (value = attributes[:'entity_set_ids']).is_a?(Hash) + self.entity_set_ids = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + entity_key_ids == o.entity_key_ids && + entity_set_ids == o.entity_set_ids + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [entity_key_ids, entity_set_ids].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/data_search_result.rb b/ruby/lib/openapi_client/models/data_search_result.rb new file mode 100644 index 0000000..04ab732 --- /dev/null +++ b/ruby/lib/openapi_client/models/data_search_result.rb @@ -0,0 +1,217 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class DataSearchResult + attr_accessor :num_hits + + attr_accessor :hits + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'num_hits' => :'numHits', + :'hits' => :'hits' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'num_hits' => :'Integer', + :'hits' => :'Array>>' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::DataSearchResult` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::DataSearchResult`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'num_hits') + self.num_hits = attributes[:'num_hits'] + end + + if attributes.key?(:'hits') + if (value = attributes[:'hits']).is_a?(Array) + self.hits = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + num_hits == o.num_hits && + hits == o.hits + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [num_hits, hits].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/ed_mdiff.rb b/ruby/lib/openapi_client/models/ed_mdiff.rb new file mode 100644 index 0000000..2798c91 --- /dev/null +++ b/ruby/lib/openapi_client/models/ed_mdiff.rb @@ -0,0 +1,215 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class EDMdiff + attr_accessor :conflicts + + attr_accessor :diff + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'conflicts' => :'conflicts', + :'diff' => :'diff' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'conflicts' => :'EDM', + :'diff' => :'EDM' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::EDMdiff` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::EDMdiff`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'conflicts') + self.conflicts = attributes[:'conflicts'] + end + + if attributes.key?(:'diff') + self.diff = attributes[:'diff'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + conflicts == o.conflicts && + diff == o.diff + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [conflicts, diff].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/edm.rb b/ruby/lib/openapi_client/models/edm.rb new file mode 100644 index 0000000..9bd2cf3 --- /dev/null +++ b/ruby/lib/openapi_client/models/edm.rb @@ -0,0 +1,252 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class EDM + attr_accessor :namespaces + + attr_accessor :schemas + + attr_accessor :property_types + + attr_accessor :entity_types + + attr_accessor :association_types + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'namespaces' => :'namespaces', + :'schemas' => :'schemas', + :'property_types' => :'propertyTypes', + :'entity_types' => :'entityTypes', + :'association_types' => :'associationTypes' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'namespaces' => :'Array', + :'schemas' => :'Array', + :'property_types' => :'Array', + :'entity_types' => :'Array', + :'association_types' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::EDM` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::EDM`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'namespaces') + if (value = attributes[:'namespaces']).is_a?(Array) + self.namespaces = value + end + end + + if attributes.key?(:'schemas') + if (value = attributes[:'schemas']).is_a?(Array) + self.schemas = value + end + end + + if attributes.key?(:'property_types') + if (value = attributes[:'property_types']).is_a?(Array) + self.property_types = value + end + end + + if attributes.key?(:'entity_types') + if (value = attributes[:'entity_types']).is_a?(Array) + self.entity_types = value + end + end + + if attributes.key?(:'association_types') + if (value = attributes[:'association_types']).is_a?(Array) + self.association_types = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + namespaces == o.namespaces && + schemas == o.schemas && + property_types == o.property_types && + entity_types == o.entity_types && + association_types == o.association_types + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [namespaces, schemas, property_types, entity_types, association_types].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/edm_request.rb b/ruby/lib/openapi_client/models/edm_request.rb new file mode 100644 index 0000000..981cc64 --- /dev/null +++ b/ruby/lib/openapi_client/models/edm_request.rb @@ -0,0 +1,262 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class EdmRequest + attr_accessor :action + + attr_accessor :property_types + + attr_accessor :entity_types + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'action' => :'action', + :'property_types' => :'propertyTypes', + :'entity_types' => :'entityTypes' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'action' => :'String', + :'property_types' => :'Array', + :'entity_types' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::EdmRequest` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::EdmRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'action') + self.action = attributes[:'action'] + end + + if attributes.key?(:'property_types') + if (value = attributes[:'property_types']).is_a?(Array) + self.property_types = value + end + end + + if attributes.key?(:'entity_types') + if (value = attributes[:'entity_types']).is_a?(Array) + self.entity_types = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + action_validator = EnumAttributeValidator.new('String', ["ADD", "REMOVE", "REPLACE"]) + return false unless action_validator.valid?(@action) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] action Object to be assigned + def action=(action) + validator = EnumAttributeValidator.new('String', ["ADD", "REMOVE", "REPLACE"]) + unless validator.valid?(action) + fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}." + end + @action = action + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + action == o.action && + property_types == o.property_types && + entity_types == o.entity_types + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [action, property_types, entity_types].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/entity.rb b/ruby/lib/openapi_client/models/entity.rb new file mode 100644 index 0000000..07343c7 --- /dev/null +++ b/ruby/lib/openapi_client/models/entity.rb @@ -0,0 +1,217 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class Entity + attr_accessor :key + + attr_accessor :details + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'key' => :'key', + :'details' => :'details' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'key' => :'EntityKey', + :'details' => :'Hash' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Entity` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Entity`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'key') + self.key = attributes[:'key'] + end + + if attributes.key?(:'details') + if (value = attributes[:'details']).is_a?(Hash) + self.details = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + key == o.key && + details == o.details + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [key, details].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/entity_data_key.rb b/ruby/lib/openapi_client/models/entity_data_key.rb new file mode 100644 index 0000000..2bbe207 --- /dev/null +++ b/ruby/lib/openapi_client/models/entity_data_key.rb @@ -0,0 +1,215 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class EntityDataKey + attr_accessor :entity_set_id + + attr_accessor :entity_key_id + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'entity_set_id' => :'entitySetId', + :'entity_key_id' => :'entityKeyId' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'entity_set_id' => :'String', + :'entity_key_id' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::EntityDataKey` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::EntityDataKey`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'entity_set_id') + self.entity_set_id = attributes[:'entity_set_id'] + end + + if attributes.key?(:'entity_key_id') + self.entity_key_id = attributes[:'entity_key_id'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + entity_set_id == o.entity_set_id && + entity_key_id == o.entity_key_id + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [entity_set_id, entity_key_id].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/entity_definition.rb b/ruby/lib/openapi_client/models/entity_definition.rb new file mode 100644 index 0000000..fe74804 --- /dev/null +++ b/ruby/lib/openapi_client/models/entity_definition.rb @@ -0,0 +1,269 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class EntityDefinition + attr_accessor :fqn + + attr_accessor :entity_set_name + + attr_accessor :property_definitions + + attr_accessor :update_type + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'fqn' => :'fqn', + :'entity_set_name' => :'entitySetName', + :'property_definitions' => :'propertyDefinitions', + :'update_type' => :'updateType' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'fqn' => :'FullQualifiedName', + :'entity_set_name' => :'String', + :'property_definitions' => :'Hash', + :'update_type' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::EntityDefinition` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::EntityDefinition`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'fqn') + self.fqn = attributes[:'fqn'] + end + + if attributes.key?(:'entity_set_name') + self.entity_set_name = attributes[:'entity_set_name'] + end + + if attributes.key?(:'property_definitions') + if (value = attributes[:'property_definitions']).is_a?(Hash) + self.property_definitions = value + end + end + + if attributes.key?(:'update_type') + self.update_type = attributes[:'update_type'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + update_type_validator = EnumAttributeValidator.new('String', ["Replace", "PartialReplace", "Merge"]) + return false unless update_type_validator.valid?(@update_type) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] update_type Object to be assigned + def update_type=(update_type) + validator = EnumAttributeValidator.new('String', ["Replace", "PartialReplace", "Merge"]) + unless validator.valid?(update_type) + fail ArgumentError, "invalid value for \"update_type\", must be one of #{validator.allowable_values}." + end + @update_type = update_type + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + fqn == o.fqn && + entity_set_name == o.entity_set_name && + property_definitions == o.property_definitions && + update_type == o.update_type + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [fqn, entity_set_name, property_definitions, update_type].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/entity_key.rb b/ruby/lib/openapi_client/models/entity_key.rb new file mode 100644 index 0000000..e633969 --- /dev/null +++ b/ruby/lib/openapi_client/models/entity_key.rb @@ -0,0 +1,215 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class EntityKey + attr_accessor :entity_set_id + + attr_accessor :entity_id + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'entity_set_id' => :'entitySetId', + :'entity_id' => :'entityId' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'entity_set_id' => :'String', + :'entity_id' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::EntityKey` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::EntityKey`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'entity_set_id') + self.entity_set_id = attributes[:'entity_set_id'] + end + + if attributes.key?(:'entity_id') + self.entity_id = attributes[:'entity_id'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + entity_set_id == o.entity_set_id && + entity_id == o.entity_id + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [entity_set_id, entity_id].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/entity_key_pair.rb b/ruby/lib/openapi_client/models/entity_key_pair.rb new file mode 100644 index 0000000..79f44fb --- /dev/null +++ b/ruby/lib/openapi_client/models/entity_key_pair.rb @@ -0,0 +1,215 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class EntityKeyPair + attr_accessor :first + + attr_accessor :second + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'first' => :'first', + :'second' => :'second' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'first' => :'String', + :'second' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::EntityKeyPair` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::EntityKeyPair`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'first') + self.first = attributes[:'first'] + end + + if attributes.key?(:'second') + self.second = attributes[:'second'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + first == o.first && + second == o.second + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [first, second].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/entity_linking_features.rb b/ruby/lib/openapi_client/models/entity_linking_features.rb new file mode 100644 index 0000000..a2f00ae --- /dev/null +++ b/ruby/lib/openapi_client/models/entity_linking_features.rb @@ -0,0 +1,217 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class EntityLinkingFeatures + attr_accessor :entity_linking_feedback + + attr_accessor :features + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'entity_linking_feedback' => :'entityLinkingFeedback', + :'features' => :'features' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'entity_linking_feedback' => :'EntityLinkingFeedback', + :'features' => :'Hash' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::EntityLinkingFeatures` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::EntityLinkingFeatures`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'entity_linking_feedback') + self.entity_linking_feedback = attributes[:'entity_linking_feedback'] + end + + if attributes.key?(:'features') + if (value = attributes[:'features']).is_a?(Hash) + self.features = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + entity_linking_feedback == o.entity_linking_feedback && + features == o.features + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [entity_linking_feedback, features].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/entity_linking_feedback.rb b/ruby/lib/openapi_client/models/entity_linking_feedback.rb new file mode 100644 index 0000000..eca2c39 --- /dev/null +++ b/ruby/lib/openapi_client/models/entity_linking_feedback.rb @@ -0,0 +1,215 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class EntityLinkingFeedback + attr_accessor :entity_key_pair + + attr_accessor :linked + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'entity_key_pair' => :'entityKeyPair', + :'linked' => :'linked' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'entity_key_pair' => :'EntityKeyPair', + :'linked' => :'Boolean' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::EntityLinkingFeedback` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::EntityLinkingFeedback`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'entity_key_pair') + self.entity_key_pair = attributes[:'entity_key_pair'] + end + + if attributes.key?(:'linked') + self.linked = attributes[:'linked'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + entity_key_pair == o.entity_key_pair && + linked == o.linked + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [entity_key_pair, linked].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/entity_neighbors_filter.rb b/ruby/lib/openapi_client/models/entity_neighbors_filter.rb new file mode 100644 index 0000000..02214a6 --- /dev/null +++ b/ruby/lib/openapi_client/models/entity_neighbors_filter.rb @@ -0,0 +1,241 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class EntityNeighborsFilter + attr_accessor :entity_key_ids + + attr_accessor :src + + attr_accessor :dst + + attr_accessor :edge + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'entity_key_ids' => :'entityKeyIds', + :'src' => :'src', + :'dst' => :'dst', + :'edge' => :'edge' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'entity_key_ids' => :'Array', + :'src' => :'Array', + :'dst' => :'Array', + :'edge' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::EntityNeighborsFilter` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::EntityNeighborsFilter`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'entity_key_ids') + if (value = attributes[:'entity_key_ids']).is_a?(Array) + self.entity_key_ids = value + end + end + + if attributes.key?(:'src') + if (value = attributes[:'src']).is_a?(Array) + self.src = value + end + end + + if attributes.key?(:'dst') + if (value = attributes[:'dst']).is_a?(Array) + self.dst = value + end + end + + if attributes.key?(:'edge') + if (value = attributes[:'edge']).is_a?(Array) + self.edge = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + entity_key_ids == o.entity_key_ids && + src == o.src && + dst == o.dst && + edge == o.edge + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [entity_key_ids, src, dst, edge].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/entity_set.rb b/ruby/lib/openapi_client/models/entity_set.rb new file mode 100644 index 0000000..a004c37 --- /dev/null +++ b/ruby/lib/openapi_client/models/entity_set.rb @@ -0,0 +1,326 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class EntitySet + attr_accessor :id + + attr_accessor :entity_type_id + + attr_accessor :name + + attr_accessor :title + + attr_accessor :description + + attr_accessor :contacts + + attr_accessor :linking + + attr_accessor :linked_entity_sets + + attr_accessor :organization_id + + attr_accessor :flags + + attr_accessor :partitions + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'id' => :'id', + :'entity_type_id' => :'entityTypeId', + :'name' => :'name', + :'title' => :'title', + :'description' => :'description', + :'contacts' => :'contacts', + :'linking' => :'linking', + :'linked_entity_sets' => :'linkedEntitySets', + :'organization_id' => :'organizationId', + :'flags' => :'flags', + :'partitions' => :'partitions' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'id' => :'String', + :'entity_type_id' => :'String', + :'name' => :'String', + :'title' => :'String', + :'description' => :'String', + :'contacts' => :'Array', + :'linking' => :'Boolean', + :'linked_entity_sets' => :'Array', + :'organization_id' => :'String', + :'flags' => :'Array', + :'partitions' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::EntitySet` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::EntitySet`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.key?(:'entity_type_id') + self.entity_type_id = attributes[:'entity_type_id'] + end + + if attributes.key?(:'name') + self.name = attributes[:'name'] + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + + if attributes.key?(:'contacts') + if (value = attributes[:'contacts']).is_a?(Array) + self.contacts = value + end + end + + if attributes.key?(:'linking') + self.linking = attributes[:'linking'] + end + + if attributes.key?(:'linked_entity_sets') + if (value = attributes[:'linked_entity_sets']).is_a?(Array) + self.linked_entity_sets = value + end + end + + if attributes.key?(:'organization_id') + self.organization_id = attributes[:'organization_id'] + end + + if attributes.key?(:'flags') + if (value = attributes[:'flags']).is_a?(Array) + self.flags = value + end + end + + if attributes.key?(:'partitions') + if (value = attributes[:'partitions']).is_a?(Array) + self.partitions = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + id == o.id && + entity_type_id == o.entity_type_id && + name == o.name && + title == o.title && + description == o.description && + contacts == o.contacts && + linking == o.linking && + linked_entity_sets == o.linked_entity_sets && + organization_id == o.organization_id && + flags == o.flags && + partitions == o.partitions + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [id, entity_type_id, name, title, description, contacts, linking, linked_entity_sets, organization_id, flags, partitions].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/entity_set_collection.rb b/ruby/lib/openapi_client/models/entity_set_collection.rb new file mode 100644 index 0000000..76b4855 --- /dev/null +++ b/ruby/lib/openapi_client/models/entity_set_collection.rb @@ -0,0 +1,281 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class EntitySetCollection + # An optional UUID for the entity set collection. + attr_accessor :id + + # The unique name of the entity set collection. + attr_accessor :name + + # The friendly name for the entity set collection. + attr_accessor :title + + # A description of the entity set collection. + attr_accessor :description + + # The id of the entity type collection that this entity set collection maps to. + attr_accessor :entity_type_collection_id + + # A mapping from collection template type ids to entity set ids. + attr_accessor :template + + # A set of contact methods for the owners of this entity set collection. + attr_accessor :contacts + + # The id of the organization that this entity set collection belongs to. + attr_accessor :organization_id + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'id' => :'id', + :'name' => :'name', + :'title' => :'title', + :'description' => :'description', + :'entity_type_collection_id' => :'entityTypeCollectionId', + :'template' => :'template', + :'contacts' => :'contacts', + :'organization_id' => :'organizationId' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'id' => :'String', + :'name' => :'String', + :'title' => :'String', + :'description' => :'String', + :'entity_type_collection_id' => :'String', + :'template' => :'Hash', + :'contacts' => :'Array', + :'organization_id' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::EntitySetCollection` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::EntitySetCollection`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.key?(:'name') + self.name = attributes[:'name'] + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + + if attributes.key?(:'entity_type_collection_id') + self.entity_type_collection_id = attributes[:'entity_type_collection_id'] + end + + if attributes.key?(:'template') + if (value = attributes[:'template']).is_a?(Hash) + self.template = value + end + end + + if attributes.key?(:'contacts') + if (value = attributes[:'contacts']).is_a?(Array) + self.contacts = value + end + end + + if attributes.key?(:'organization_id') + self.organization_id = attributes[:'organization_id'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + id == o.id && + name == o.name && + title == o.title && + description == o.description && + entity_type_collection_id == o.entity_type_collection_id && + template == o.template && + contacts == o.contacts && + organization_id == o.organization_id + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [id, name, title, description, entity_type_collection_id, template, contacts, organization_id].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/entity_set_property_meta_data.rb b/ruby/lib/openapi_client/models/entity_set_property_meta_data.rb new file mode 100644 index 0000000..f887ab8 --- /dev/null +++ b/ruby/lib/openapi_client/models/entity_set_property_meta_data.rb @@ -0,0 +1,235 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class EntitySetPropertyMetaData + attr_accessor :title + + attr_accessor :description + + attr_accessor :property_tags + + attr_accessor :default_show + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'title' => :'title', + :'description' => :'description', + :'property_tags' => :'propertyTags', + :'default_show' => :'defaultShow' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'title' => :'String', + :'description' => :'String', + :'property_tags' => :'Array', + :'default_show' => :'Boolean' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::EntitySetPropertyMetaData` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::EntitySetPropertyMetaData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + + if attributes.key?(:'property_tags') + if (value = attributes[:'property_tags']).is_a?(Array) + self.property_tags = value + end + end + + if attributes.key?(:'default_show') + self.default_show = attributes[:'default_show'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + title == o.title && + description == o.description && + property_tags == o.property_tags && + default_show == o.default_show + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [title, description, property_tags, default_show].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/entity_set_selection.rb b/ruby/lib/openapi_client/models/entity_set_selection.rb new file mode 100644 index 0000000..243a642 --- /dev/null +++ b/ruby/lib/openapi_client/models/entity_set_selection.rb @@ -0,0 +1,219 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class EntitySetSelection + attr_accessor :ids + + attr_accessor :properties + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'ids' => :'ids', + :'properties' => :'properties' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'ids' => :'Array', + :'properties' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::EntitySetSelection` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::EntitySetSelection`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'ids') + if (value = attributes[:'ids']).is_a?(Array) + self.ids = value + end + end + + if attributes.key?(:'properties') + if (value = attributes[:'properties']).is_a?(Array) + self.properties = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + ids == o.ids && + properties == o.properties + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [ids, properties].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/entity_type.rb b/ruby/lib/openapi_client/models/entity_type.rb new file mode 100644 index 0000000..1562e82 --- /dev/null +++ b/ruby/lib/openapi_client/models/entity_type.rb @@ -0,0 +1,329 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class EntityType + attr_accessor :title + + attr_accessor :description + + attr_accessor :id + + attr_accessor :type + + attr_accessor :schemas + + attr_accessor :key + + attr_accessor :properties + + attr_accessor :property_tags + + attr_accessor :basetype + + attr_accessor :category + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'title' => :'title', + :'description' => :'description', + :'id' => :'id', + :'type' => :'type', + :'schemas' => :'schemas', + :'key' => :'key', + :'properties' => :'properties', + :'property_tags' => :'propertyTags', + :'basetype' => :'basetype', + :'category' => :'category' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'title' => :'String', + :'description' => :'String', + :'id' => :'String', + :'type' => :'FullQualifiedName', + :'schemas' => :'Array', + :'key' => :'Array', + :'properties' => :'Array', + :'property_tags' => :'Hash>', + :'basetype' => :'String', + :'category' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::EntityType` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::EntityType`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + + if attributes.key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + + if attributes.key?(:'schemas') + if (value = attributes[:'schemas']).is_a?(Array) + self.schemas = value + end + end + + if attributes.key?(:'key') + if (value = attributes[:'key']).is_a?(Array) + self.key = value + end + end + + if attributes.key?(:'properties') + if (value = attributes[:'properties']).is_a?(Array) + self.properties = value + end + end + + if attributes.key?(:'property_tags') + if (value = attributes[:'property_tags']).is_a?(Hash) + self.property_tags = value + end + end + + if attributes.key?(:'basetype') + self.basetype = attributes[:'basetype'] + end + + if attributes.key?(:'category') + self.category = attributes[:'category'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + category_validator = EnumAttributeValidator.new('String', ["AssociationType", "EntityType"]) + return false unless category_validator.valid?(@category) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] category Object to be assigned + def category=(category) + validator = EnumAttributeValidator.new('String', ["AssociationType", "EntityType"]) + unless validator.valid?(category) + fail ArgumentError, "invalid value for \"category\", must be one of #{validator.allowable_values}." + end + @category = category + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + title == o.title && + description == o.description && + id == o.id && + type == o.type && + schemas == o.schemas && + key == o.key && + properties == o.properties && + property_tags == o.property_tags && + basetype == o.basetype && + category == o.category + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [title, description, id, type, schemas, key, properties, property_tags, basetype, category].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/entity_type_collection.rb b/ruby/lib/openapi_client/models/entity_type_collection.rb new file mode 100644 index 0000000..9ab6943 --- /dev/null +++ b/ruby/lib/openapi_client/models/entity_type_collection.rb @@ -0,0 +1,260 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class EntityTypeCollection + # An optional UUID for the entity type collection. + attr_accessor :id + + attr_accessor :type + + # The friendly name for the entity type collection. + attr_accessor :title + + # A description of the entity type collection. + attr_accessor :description + + # A list of schemas the entity type collection should belong to. + attr_accessor :schemas + + # A set of CollectionTemplateType objects, which describe the entity types involved in the entity type collection and the purposes they serve + attr_accessor :template + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'id' => :'id', + :'type' => :'type', + :'title' => :'title', + :'description' => :'description', + :'schemas' => :'schemas', + :'template' => :'template' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'id' => :'String', + :'type' => :'FullQualifiedName', + :'title' => :'String', + :'description' => :'String', + :'schemas' => :'Array', + :'template' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::EntityTypeCollection` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::EntityTypeCollection`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + + if attributes.key?(:'schemas') + if (value = attributes[:'schemas']).is_a?(Array) + self.schemas = value + end + end + + if attributes.key?(:'template') + if (value = attributes[:'template']).is_a?(Array) + self.template = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + id == o.id && + type == o.type && + title == o.title && + description == o.description && + schemas == o.schemas && + template == o.template + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [id, type, title, description, schemas, template].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/entity_type_property_metadata.rb b/ruby/lib/openapi_client/models/entity_type_property_metadata.rb new file mode 100644 index 0000000..0c9995c --- /dev/null +++ b/ruby/lib/openapi_client/models/entity_type_property_metadata.rb @@ -0,0 +1,215 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class EntityTypePropertyMetadata + attr_accessor :title + + attr_accessor :description + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'title' => :'title', + :'description' => :'description' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'title' => :'String', + :'description' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::EntityTypePropertyMetadata` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::EntityTypePropertyMetadata`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + title == o.title && + description == o.description + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [title, description].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/flight.rb b/ruby/lib/openapi_client/models/flight.rb new file mode 100644 index 0000000..9170eda --- /dev/null +++ b/ruby/lib/openapi_client/models/flight.rb @@ -0,0 +1,248 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class Flight + attr_accessor :name + + attr_accessor :tags + + attr_accessor :organization_id + + attr_accessor :entity_definitions + + attr_accessor :association_definitions + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'name' => :'name', + :'tags' => :'tags', + :'organization_id' => :'organizationId', + :'entity_definitions' => :'entityDefinitions', + :'association_definitions' => :'associationDefinitions' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'name' => :'String', + :'tags' => :'Array', + :'organization_id' => :'String', + :'entity_definitions' => :'Hash', + :'association_definitions' => :'Hash' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Flight` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Flight`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'name') + self.name = attributes[:'name'] + end + + if attributes.key?(:'tags') + if (value = attributes[:'tags']).is_a?(Array) + self.tags = value + end + end + + if attributes.key?(:'organization_id') + self.organization_id = attributes[:'organization_id'] + end + + if attributes.key?(:'entity_definitions') + if (value = attributes[:'entity_definitions']).is_a?(Hash) + self.entity_definitions = value + end + end + + if attributes.key?(:'association_definitions') + if (value = attributes[:'association_definitions']).is_a?(Hash) + self.association_definitions = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + name == o.name && + tags == o.tags && + organization_id == o.organization_id && + entity_definitions == o.entity_definitions && + association_definitions == o.association_definitions + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [name, tags, organization_id, entity_definitions, association_definitions].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/flight_plan_parameters.rb b/ruby/lib/openapi_client/models/flight_plan_parameters.rb new file mode 100644 index 0000000..6a4d4f7 --- /dev/null +++ b/ruby/lib/openapi_client/models/flight_plan_parameters.rb @@ -0,0 +1,251 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + # Represents the parameters required to create a flight plan (i.e. a Map) + class FlightPlanParameters + # the sql query to be used to pull cleaned data from postgres + attr_accessor :sql + + # postgres data source for pulling clean data + attr_accessor :src + + # the columns that are primary keys in the cleaned data + attr_accessor :src_primary_key_columns + + # the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) + attr_accessor :path + + attr_accessor :flight + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'sql' => :'sql', + :'src' => :'src', + :'src_primary_key_columns' => :'srcPrimaryKeyColumns', + :'path' => :'path', + :'flight' => :'flight' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'sql' => :'String', + :'src' => :'Hash', + :'src_primary_key_columns' => :'Array', + :'path' => :'String', + :'flight' => :'Flight' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::FlightPlanParameters` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::FlightPlanParameters`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'sql') + self.sql = attributes[:'sql'] + end + + if attributes.key?(:'src') + if (value = attributes[:'src']).is_a?(Hash) + self.src = value + end + end + + if attributes.key?(:'src_primary_key_columns') + if (value = attributes[:'src_primary_key_columns']).is_a?(Array) + self.src_primary_key_columns = value + end + end + + if attributes.key?(:'path') + self.path = attributes[:'path'] + end + + if attributes.key?(:'flight') + self.flight = attributes[:'flight'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + sql == o.sql && + src == o.src && + src_primary_key_columns == o.src_primary_key_columns && + path == o.path && + flight == o.flight + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [sql, src, src_primary_key_columns, path, flight].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/flight_plan_parameters_update.rb b/ruby/lib/openapi_client/models/flight_plan_parameters_update.rb new file mode 100644 index 0000000..01edf95 --- /dev/null +++ b/ruby/lib/openapi_client/models/flight_plan_parameters_update.rb @@ -0,0 +1,241 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class FlightPlanParametersUpdate + # the sql query to be used to pull cleaned data from postgres + attr_accessor :sql + + # postgres data source for pulling clean data + attr_accessor :src + + # the columns that are primary keys in the cleaned data + attr_accessor :src_primary_key_columns + + # the path to the flight yaml (i.e. https://raw.githubusercontent.com/pathToFlight.yaml) + attr_accessor :path + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'sql' => :'sql', + :'src' => :'src', + :'src_primary_key_columns' => :'srcPrimaryKeyColumns', + :'path' => :'path' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'sql' => :'String', + :'src' => :'Hash', + :'src_primary_key_columns' => :'Array', + :'path' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::FlightPlanParametersUpdate` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::FlightPlanParametersUpdate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'sql') + self.sql = attributes[:'sql'] + end + + if attributes.key?(:'src') + if (value = attributes[:'src']).is_a?(Hash) + self.src = value + end + end + + if attributes.key?(:'src_primary_key_columns') + if (value = attributes[:'src_primary_key_columns']).is_a?(Array) + self.src_primary_key_columns = value + end + end + + if attributes.key?(:'path') + self.path = attributes[:'path'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + sql == o.sql && + src == o.src && + src_primary_key_columns == o.src_primary_key_columns && + path == o.path + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [sql, src, src_primary_key_columns, path].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/full_qualified_name.rb b/ruby/lib/openapi_client/models/full_qualified_name.rb new file mode 100644 index 0000000..448088d --- /dev/null +++ b/ruby/lib/openapi_client/models/full_qualified_name.rb @@ -0,0 +1,215 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class FullQualifiedName + attr_accessor :name + + attr_accessor :namespace + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'name' => :'name', + :'namespace' => :'namespace' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'name' => :'String', + :'namespace' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::FullQualifiedName` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::FullQualifiedName`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'name') + self.name = attributes[:'name'] + end + + if attributes.key?(:'namespace') + self.namespace = attributes[:'namespace'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + name == o.name && + namespace == o.namespace + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [name, namespace].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/indexing_state.rb b/ruby/lib/openapi_client/models/indexing_state.rb new file mode 100644 index 0000000..9886717 --- /dev/null +++ b/ruby/lib/openapi_client/models/indexing_state.rb @@ -0,0 +1,246 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class IndexingState + attr_accessor :indexing + + attr_accessor :queue + + attr_accessor :current_entity_set + + attr_accessor :queue_size + + attr_accessor :count + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'indexing' => :'indexing', + :'queue' => :'queue', + :'current_entity_set' => :'currentEntitySet', + :'queue_size' => :'queueSize', + :'count' => :'count' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'indexing' => :'Hash>', + :'queue' => :'Array', + :'current_entity_set' => :'String', + :'queue_size' => :'Integer', + :'count' => :'Integer' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::IndexingState` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::IndexingState`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'indexing') + if (value = attributes[:'indexing']).is_a?(Hash) + self.indexing = value + end + end + + if attributes.key?(:'queue') + if (value = attributes[:'queue']).is_a?(Array) + self.queue = value + end + end + + if attributes.key?(:'current_entity_set') + self.current_entity_set = attributes[:'current_entity_set'] + end + + if attributes.key?(:'queue_size') + self.queue_size = attributes[:'queue_size'] + end + + if attributes.key?(:'count') + self.count = attributes[:'count'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + indexing == o.indexing && + queue == o.queue && + current_entity_set == o.current_entity_set && + queue_size == o.queue_size && + count == o.count + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [indexing, queue, current_entity_set, queue_size, count].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/inline_object.rb b/ruby/lib/openapi_client/models/inline_object.rb new file mode 100644 index 0000000..033f8f7 --- /dev/null +++ b/ruby/lib/openapi_client/models/inline_object.rb @@ -0,0 +1,209 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + # Set of associations to create. Keys are association entity set ids and values for each keys are the data to be created. AssociationEntityId's are not generated based on the key. + class InlineObject + attr_accessor :additional_properties + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'additional_properties' => :'additionalProperties' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'additional_properties' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::InlineObject` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::InlineObject`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'additional_properties') + if (value = attributes[:'additional_properties']).is_a?(Array) + self.additional_properties = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + additional_properties == o.additional_properties + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [additional_properties].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/inline_response200.rb b/ruby/lib/openapi_client/models/inline_response200.rb new file mode 100644 index 0000000..1279f2c --- /dev/null +++ b/ruby/lib/openapi_client/models/inline_response200.rb @@ -0,0 +1,215 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class InlineResponse200 + attr_accessor :user + + attr_accessor :credential + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'user' => :'user', + :'credential' => :'credential' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'user' => :'String', + :'credential' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::InlineResponse200` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::InlineResponse200`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'user') + self.user = attributes[:'user'] + end + + if attributes.key?(:'credential') + self.credential = attributes[:'credential'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + user == o.user && + credential == o.credential + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [user, credential].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/integration.rb b/ruby/lib/openapi_client/models/integration.rb new file mode 100644 index 0000000..d9ba639 --- /dev/null +++ b/ruby/lib/openapi_client/models/integration.rb @@ -0,0 +1,328 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + # Represents a data integration, including all fields required to run the integration. + class Integration + # a unique ID used for authorizing a call to run an integration + attr_accessor :key + + # the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) + attr_accessor :environment + + # the url of the s3bucket to be used + attr_accessor :s3_bucket + + # the set of email addresses of those responsible for the integration + attr_accessor :contacts + + # the id of the organization that owns the integration + attr_accessor :organization_id + + # the id of the entity set that stores the logs for this integration + attr_accessor :entity_set_id + + # maximum number of connections to postgres allowed for this integration + attr_accessor :max_connections + + # urls to receive a POST when integration has completed + attr_accessor :callback + + # a map from [Flight] name to [FlightPlanParameters] + attr_accessor :flight_plan_parameters + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'key' => :'key', + :'environment' => :'environment', + :'s3_bucket' => :'s3Bucket', + :'contacts' => :'contacts', + :'organization_id' => :'organizationId', + :'entity_set_id' => :'entitySetId', + :'max_connections' => :'maxConnections', + :'callback' => :'callback', + :'flight_plan_parameters' => :'flightPlanParameters' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'key' => :'String', + :'environment' => :'String', + :'s3_bucket' => :'String', + :'contacts' => :'Array', + :'organization_id' => :'String', + :'entity_set_id' => :'String', + :'max_connections' => :'Integer', + :'callback' => :'Array', + :'flight_plan_parameters' => :'Hash' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Integration` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Integration`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'key') + self.key = attributes[:'key'] + end + + if attributes.key?(:'environment') + self.environment = attributes[:'environment'] + end + + if attributes.key?(:'s3_bucket') + self.s3_bucket = attributes[:'s3_bucket'] + end + + if attributes.key?(:'contacts') + if (value = attributes[:'contacts']).is_a?(Array) + self.contacts = value + end + end + + if attributes.key?(:'organization_id') + self.organization_id = attributes[:'organization_id'] + end + + if attributes.key?(:'entity_set_id') + self.entity_set_id = attributes[:'entity_set_id'] + end + + if attributes.key?(:'max_connections') + self.max_connections = attributes[:'max_connections'] + end + + if attributes.key?(:'callback') + if (value = attributes[:'callback']).is_a?(Array) + self.callback = value + end + end + + if attributes.key?(:'flight_plan_parameters') + if (value = attributes[:'flight_plan_parameters']).is_a?(Hash) + self.flight_plan_parameters = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + environment_validator = EnumAttributeValidator.new('String', ["PROD_INTEGRATION", "STAGING_INTEGRATION", "LOCAL"]) + return false unless environment_validator.valid?(@environment) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] environment Object to be assigned + def environment=(environment) + validator = EnumAttributeValidator.new('String', ["PROD_INTEGRATION", "STAGING_INTEGRATION", "LOCAL"]) + unless validator.valid?(environment) + fail ArgumentError, "invalid value for \"environment\", must be one of #{validator.allowable_values}." + end + @environment = environment + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + key == o.key && + environment == o.environment && + s3_bucket == o.s3_bucket && + contacts == o.contacts && + organization_id == o.organization_id && + entity_set_id == o.entity_set_id && + max_connections == o.max_connections && + callback == o.callback && + flight_plan_parameters == o.flight_plan_parameters + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [key, environment, s3_bucket, contacts, organization_id, entity_set_id, max_connections, callback, flight_plan_parameters].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/integration_job.rb b/ruby/lib/openapi_client/models/integration_job.rb new file mode 100644 index 0000000..7eb0ba5 --- /dev/null +++ b/ruby/lib/openapi_client/models/integration_job.rb @@ -0,0 +1,249 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class IntegrationJob + attr_accessor :name + + attr_accessor :status + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'name' => :'name', + :'status' => :'status' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'name' => :'String', + :'status' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::IntegrationJob` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::IntegrationJob`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'name') + self.name = attributes[:'name'] + end + + if attributes.key?(:'status') + self.status = attributes[:'status'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + status_validator = EnumAttributeValidator.new('String', ["IN_PROGRESS", "SUCCEEDED", "FAILED", "QUEUED", "FAILED_TO_START"]) + return false unless status_validator.valid?(@status) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] status Object to be assigned + def status=(status) + validator = EnumAttributeValidator.new('String', ["IN_PROGRESS", "SUCCEEDED", "FAILED", "QUEUED", "FAILED_TO_START"]) + unless validator.valid?(status) + fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}." + end + @status = status + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + name == o.name && + status == o.status + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [name, status].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/integration_results.rb b/ruby/lib/openapi_client/models/integration_results.rb new file mode 100644 index 0000000..1243b50 --- /dev/null +++ b/ruby/lib/openapi_client/models/integration_results.rb @@ -0,0 +1,237 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class IntegrationResults + attr_accessor :entity_count + + attr_accessor :association_count + + attr_accessor :associations_entity_key_mappings + + attr_accessor :entity_sets_entity_key_mappings + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'entity_count' => :'entityCount', + :'association_count' => :'associationCount', + :'associations_entity_key_mappings' => :'associationsEntityKeyMappings', + :'entity_sets_entity_key_mappings' => :'entitySetsEntityKeyMappings' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'entity_count' => :'Integer', + :'association_count' => :'Integer', + :'associations_entity_key_mappings' => :'Hash>', + :'entity_sets_entity_key_mappings' => :'Hash>' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::IntegrationResults` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::IntegrationResults`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'entity_count') + self.entity_count = attributes[:'entity_count'] + end + + if attributes.key?(:'association_count') + self.association_count = attributes[:'association_count'] + end + + if attributes.key?(:'associations_entity_key_mappings') + if (value = attributes[:'associations_entity_key_mappings']).is_a?(Hash) + self.associations_entity_key_mappings = value + end + end + + if attributes.key?(:'entity_sets_entity_key_mappings') + if (value = attributes[:'entity_sets_entity_key_mappings']).is_a?(Hash) + self.entity_sets_entity_key_mappings = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + entity_count == o.entity_count && + association_count == o.association_count && + associations_entity_key_mappings == o.associations_entity_key_mappings && + entity_sets_entity_key_mappings == o.entity_sets_entity_key_mappings + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [entity_count, association_count, associations_entity_key_mappings, entity_sets_entity_key_mappings].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/integration_update.rb b/ruby/lib/openapi_client/models/integration_update.rb new file mode 100644 index 0000000..eea5c26 --- /dev/null +++ b/ruby/lib/openapi_client/models/integration_update.rb @@ -0,0 +1,307 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class IntegrationUpdate + # the retrofit environment (e.g. PROD_INTEGRATION, LOCAL) + attr_accessor :environment + + # the url of the s3bucket to be used + attr_accessor :s3_bucket + + # the set of email addresses of those responsible for the integration + attr_accessor :contacts + + # the id of the organization that owns the integration + attr_accessor :organization_id + + # maximum number of connections to postgres allowed for this integration + attr_accessor :max_connections + + # urls to receive a POST when integration has completed + attr_accessor :callback_urls + + # a map from [Flight] name to [FlightPlanParametersUpdate] + attr_accessor :flight_plan_parameters + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'environment' => :'environment', + :'s3_bucket' => :'s3Bucket', + :'contacts' => :'contacts', + :'organization_id' => :'organizationId', + :'max_connections' => :'maxConnections', + :'callback_urls' => :'callbackUrls', + :'flight_plan_parameters' => :'flightPlanParameters' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'environment' => :'String', + :'s3_bucket' => :'String', + :'contacts' => :'Array', + :'organization_id' => :'String', + :'max_connections' => :'Integer', + :'callback_urls' => :'Array', + :'flight_plan_parameters' => :'Hash' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::IntegrationUpdate` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::IntegrationUpdate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'environment') + self.environment = attributes[:'environment'] + end + + if attributes.key?(:'s3_bucket') + self.s3_bucket = attributes[:'s3_bucket'] + end + + if attributes.key?(:'contacts') + if (value = attributes[:'contacts']).is_a?(Array) + self.contacts = value + end + end + + if attributes.key?(:'organization_id') + self.organization_id = attributes[:'organization_id'] + end + + if attributes.key?(:'max_connections') + self.max_connections = attributes[:'max_connections'] + end + + if attributes.key?(:'callback_urls') + if (value = attributes[:'callback_urls']).is_a?(Array) + self.callback_urls = value + end + end + + if attributes.key?(:'flight_plan_parameters') + if (value = attributes[:'flight_plan_parameters']).is_a?(Hash) + self.flight_plan_parameters = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + environment_validator = EnumAttributeValidator.new('String', ["PROD_INTEGRATION", "STAGING_INTEGRATION", "LOCAL"]) + return false unless environment_validator.valid?(@environment) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] environment Object to be assigned + def environment=(environment) + validator = EnumAttributeValidator.new('String', ["PROD_INTEGRATION", "STAGING_INTEGRATION", "LOCAL"]) + unless validator.valid?(environment) + fail ArgumentError, "invalid value for \"environment\", must be one of #{validator.allowable_values}." + end + @environment = environment + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + environment == o.environment && + s3_bucket == o.s3_bucket && + contacts == o.contacts && + organization_id == o.organization_id && + max_connections == o.max_connections && + callback_urls == o.callback_urls && + flight_plan_parameters == o.flight_plan_parameters + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [environment, s3_bucket, contacts, organization_id, max_connections, callback_urls, flight_plan_parameters].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/linking_feedback.rb b/ruby/lib/openapi_client/models/linking_feedback.rb new file mode 100644 index 0000000..86a46b9 --- /dev/null +++ b/ruby/lib/openapi_client/models/linking_feedback.rb @@ -0,0 +1,228 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class LinkingFeedback + attr_accessor :linking_entity + + attr_accessor :link + + attr_accessor :unlink + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'linking_entity' => :'linkingEntity', + :'link' => :'link', + :'unlink' => :'unlink' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'linking_entity' => :'EntityDataKey', + :'link' => :'Array', + :'unlink' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::LinkingFeedback` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::LinkingFeedback`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'linking_entity') + self.linking_entity = attributes[:'linking_entity'] + end + + if attributes.key?(:'link') + if (value = attributes[:'link']).is_a?(Array) + self.link = value + end + end + + if attributes.key?(:'unlink') + if (value = attributes[:'unlink']).is_a?(Array) + self.unlink = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + linking_entity == o.linking_entity && + link == o.link && + unlink == o.unlink + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [linking_entity, link, unlink].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/materialized_view_account.rb b/ruby/lib/openapi_client/models/materialized_view_account.rb new file mode 100644 index 0000000..8d8e7d5 --- /dev/null +++ b/ruby/lib/openapi_client/models/materialized_view_account.rb @@ -0,0 +1,215 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class MaterializedViewAccount + attr_accessor :username + + attr_accessor :credential + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'username' => :'username', + :'credential' => :'credential' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'username' => :'String', + :'credential' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::MaterializedViewAccount` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::MaterializedViewAccount`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'username') + self.username = attributes[:'username'] + end + + if attributes.key?(:'credential') + self.credential = attributes[:'credential'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + username == o.username && + credential == o.credential + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [username, credential].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/metadata_update.rb b/ruby/lib/openapi_client/models/metadata_update.rb new file mode 100644 index 0000000..94d316e --- /dev/null +++ b/ruby/lib/openapi_client/models/metadata_update.rb @@ -0,0 +1,356 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class MetadataUpdate + attr_accessor :title + + attr_accessor :description + + attr_accessor :name + + attr_accessor :contacts + + attr_accessor :type + + attr_accessor :pii + + attr_accessor :default_show + + attr_accessor :url + + attr_accessor :property_tags + + attr_accessor :index_type + + attr_accessor :organization_id + + attr_accessor :partitions + + attr_accessor :enum_values + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'title' => :'title', + :'description' => :'description', + :'name' => :'name', + :'contacts' => :'contacts', + :'type' => :'type', + :'pii' => :'pii', + :'default_show' => :'defaultShow', + :'url' => :'url', + :'property_tags' => :'propertyTags', + :'index_type' => :'indexType', + :'organization_id' => :'organizationId', + :'partitions' => :'partitions', + :'enum_values' => :'enumValues' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'title' => :'String', + :'description' => :'String', + :'name' => :'String', + :'contacts' => :'Array', + :'type' => :'FullQualifiedName', + :'pii' => :'Boolean', + :'default_show' => :'Boolean', + :'url' => :'String', + :'property_tags' => :'Hash>', + :'index_type' => :'String', + :'organization_id' => :'String', + :'partitions' => :'Array', + :'enum_values' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::MetadataUpdate` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::MetadataUpdate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + + if attributes.key?(:'name') + self.name = attributes[:'name'] + end + + if attributes.key?(:'contacts') + if (value = attributes[:'contacts']).is_a?(Array) + self.contacts = value + end + end + + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + + if attributes.key?(:'pii') + self.pii = attributes[:'pii'] + end + + if attributes.key?(:'default_show') + self.default_show = attributes[:'default_show'] + end + + if attributes.key?(:'url') + self.url = attributes[:'url'] + end + + if attributes.key?(:'property_tags') + if (value = attributes[:'property_tags']).is_a?(Hash) + self.property_tags = value + end + end + + if attributes.key?(:'index_type') + self.index_type = attributes[:'index_type'] + end + + if attributes.key?(:'organization_id') + self.organization_id = attributes[:'organization_id'] + end + + if attributes.key?(:'partitions') + if (value = attributes[:'partitions']).is_a?(Array) + self.partitions = value + end + end + + if attributes.key?(:'enum_values') + if (value = attributes[:'enum_values']).is_a?(Array) + self.enum_values = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + index_type_validator = EnumAttributeValidator.new('String', ["BTREE", "HASH", "GIN", "NONE"]) + return false unless index_type_validator.valid?(@index_type) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] index_type Object to be assigned + def index_type=(index_type) + validator = EnumAttributeValidator.new('String', ["BTREE", "HASH", "GIN", "NONE"]) + unless validator.valid?(index_type) + fail ArgumentError, "invalid value for \"index_type\", must be one of #{validator.allowable_values}." + end + @index_type = index_type + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + title == o.title && + description == o.description && + name == o.name && + contacts == o.contacts && + type == o.type && + pii == o.pii && + default_show == o.default_show && + url == o.url && + property_tags == o.property_tags && + index_type == o.index_type && + organization_id == o.organization_id && + partitions == o.partitions && + enum_values == o.enum_values + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [title, description, name, contacts, type, pii, default_show, url, property_tags, index_type, organization_id, partitions, enum_values].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/neighbor_entity_details.rb b/ruby/lib/openapi_client/models/neighbor_entity_details.rb new file mode 100644 index 0000000..a77c8d0 --- /dev/null +++ b/ruby/lib/openapi_client/models/neighbor_entity_details.rb @@ -0,0 +1,246 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class NeighborEntityDetails + attr_accessor :association_entity_set + + attr_accessor :association_details + + attr_accessor :neighbor_entity_set + + attr_accessor :neighbor_id + + attr_accessor :neighbor_details + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'association_entity_set' => :'associationEntitySet', + :'association_details' => :'associationDetails', + :'neighbor_entity_set' => :'neighborEntitySet', + :'neighbor_id' => :'neighborId', + :'neighbor_details' => :'neighborDetails' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'association_entity_set' => :'EntitySet', + :'association_details' => :'Hash>', + :'neighbor_entity_set' => :'EntitySet', + :'neighbor_id' => :'String', + :'neighbor_details' => :'Hash>' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::NeighborEntityDetails` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::NeighborEntityDetails`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'association_entity_set') + self.association_entity_set = attributes[:'association_entity_set'] + end + + if attributes.key?(:'association_details') + if (value = attributes[:'association_details']).is_a?(Hash) + self.association_details = value + end + end + + if attributes.key?(:'neighbor_entity_set') + self.neighbor_entity_set = attributes[:'neighbor_entity_set'] + end + + if attributes.key?(:'neighbor_id') + self.neighbor_id = attributes[:'neighbor_id'] + end + + if attributes.key?(:'neighbor_details') + if (value = attributes[:'neighbor_details']).is_a?(Hash) + self.neighbor_details = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + association_entity_set == o.association_entity_set && + association_details == o.association_details && + neighbor_entity_set == o.neighbor_entity_set && + neighbor_id == o.neighbor_id && + neighbor_details == o.neighbor_details + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [association_entity_set, association_details, neighbor_entity_set, neighbor_id, neighbor_details].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/neighbor_entity_ids.rb b/ruby/lib/openapi_client/models/neighbor_entity_ids.rb new file mode 100644 index 0000000..946eca2 --- /dev/null +++ b/ruby/lib/openapi_client/models/neighbor_entity_ids.rb @@ -0,0 +1,224 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class NeighborEntityIds + attr_accessor :association_id + + attr_accessor :neighbor_id + + attr_accessor :src + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'association_id' => :'associationId', + :'neighbor_id' => :'neighborId', + :'src' => :'src' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'association_id' => :'String', + :'neighbor_id' => :'String', + :'src' => :'Boolean' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::NeighborEntityIds` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::NeighborEntityIds`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'association_id') + self.association_id = attributes[:'association_id'] + end + + if attributes.key?(:'neighbor_id') + self.neighbor_id = attributes[:'neighbor_id'] + end + + if attributes.key?(:'src') + self.src = attributes[:'src'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + association_id == o.association_id && + neighbor_id == o.neighbor_id && + src == o.src + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [association_id, neighbor_id, src].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/neighbor_search_filter.rb b/ruby/lib/openapi_client/models/neighbor_search_filter.rb new file mode 100644 index 0000000..8235fd4 --- /dev/null +++ b/ruby/lib/openapi_client/models/neighbor_search_filter.rb @@ -0,0 +1,241 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class NeighborSearchFilter + attr_accessor :entity_key_ids + + attr_accessor :src + + attr_accessor :dst + + attr_accessor :edge + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'entity_key_ids' => :'entityKeyIds', + :'src' => :'src', + :'dst' => :'dst', + :'edge' => :'edge' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'entity_key_ids' => :'Array', + :'src' => :'Array', + :'dst' => :'Array', + :'edge' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::NeighborSearchFilter` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::NeighborSearchFilter`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'entity_key_ids') + if (value = attributes[:'entity_key_ids']).is_a?(Array) + self.entity_key_ids = value + end + end + + if attributes.key?(:'src') + if (value = attributes[:'src']).is_a?(Array) + self.src = value + end + end + + if attributes.key?(:'dst') + if (value = attributes[:'dst']).is_a?(Array) + self.dst = value + end + end + + if attributes.key?(:'edge') + if (value = attributes[:'edge']).is_a?(Array) + self.edge = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + entity_key_ids == o.entity_key_ids && + src == o.src && + dst == o.dst && + edge == o.edge + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [entity_key_ids, src, dst, edge].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/organization.rb b/ruby/lib/openapi_client/models/organization.rb new file mode 100644 index 0000000..02deedd --- /dev/null +++ b/ruby/lib/openapi_client/models/organization.rb @@ -0,0 +1,299 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class Organization + attr_accessor :id + + attr_accessor :principal + + attr_accessor :title + + attr_accessor :description + + attr_accessor :emails + + attr_accessor :members + + attr_accessor :roles + + attr_accessor :apps + + attr_accessor :sms_entity_set_info + + attr_accessor :partitions + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'id' => :'id', + :'principal' => :'principal', + :'title' => :'title', + :'description' => :'description', + :'emails' => :'emails', + :'members' => :'members', + :'roles' => :'roles', + :'apps' => :'apps', + :'sms_entity_set_info' => :'smsEntitySetInfo', + :'partitions' => :'partitions' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'id' => :'String', + :'principal' => :'Principal', + :'title' => :'String', + :'description' => :'String', + :'emails' => :'Array', + :'members' => :'Array', + :'roles' => :'Array', + :'apps' => :'Array', + :'sms_entity_set_info' => :'Array', + :'partitions' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Organization` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Organization`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.key?(:'principal') + self.principal = attributes[:'principal'] + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + + if attributes.key?(:'emails') + if (value = attributes[:'emails']).is_a?(Array) + self.emails = value + end + end + + if attributes.key?(:'members') + if (value = attributes[:'members']).is_a?(Array) + self.members = value + end + end + + if attributes.key?(:'roles') + if (value = attributes[:'roles']).is_a?(Array) + self.roles = value + end + end + + if attributes.key?(:'apps') + if (value = attributes[:'apps']).is_a?(Array) + self.apps = value + end + end + + if attributes.key?(:'sms_entity_set_info') + if (value = attributes[:'sms_entity_set_info']).is_a?(Array) + self.sms_entity_set_info = value + end + end + + if attributes.key?(:'partitions') + if (value = attributes[:'partitions']).is_a?(Array) + self.partitions = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + id == o.id && + principal == o.principal && + title == o.title && + description == o.description && + emails == o.emails && + members == o.members && + roles == o.roles && + apps == o.apps && + sms_entity_set_info == o.sms_entity_set_info && + partitions == o.partitions + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [id, principal, title, description, emails, members, roles, apps, sms_entity_set_info, partitions].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/organization_external_database_column.rb b/ruby/lib/openapi_client/models/organization_external_database_column.rb new file mode 100644 index 0000000..8b8ad2a --- /dev/null +++ b/ruby/lib/openapi_client/models/organization_external_database_column.rb @@ -0,0 +1,312 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class OrganizationExternalDatabaseColumn + attr_accessor :id + + attr_accessor :name + + attr_accessor :title + + attr_accessor :description + + attr_accessor :table_id + + attr_accessor :organization_id + + attr_accessor :data_type + + attr_accessor :primary_key + + attr_accessor :ordinal_position + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'id' => :'id', + :'name' => :'name', + :'title' => :'title', + :'description' => :'description', + :'table_id' => :'tableId', + :'organization_id' => :'organizationId', + :'data_type' => :'dataType', + :'primary_key' => :'primaryKey', + :'ordinal_position' => :'ordinalPosition' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'id' => :'String', + :'name' => :'String', + :'title' => :'String', + :'description' => :'String', + :'table_id' => :'String', + :'organization_id' => :'String', + :'data_type' => :'String', + :'primary_key' => :'Boolean', + :'ordinal_position' => :'Integer' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::OrganizationExternalDatabaseColumn` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::OrganizationExternalDatabaseColumn`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.key?(:'name') + self.name = attributes[:'name'] + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + + if attributes.key?(:'table_id') + self.table_id = attributes[:'table_id'] + end + + if attributes.key?(:'organization_id') + self.organization_id = attributes[:'organization_id'] + end + + if attributes.key?(:'data_type') + self.data_type = attributes[:'data_type'] + end + + if attributes.key?(:'primary_key') + self.primary_key = attributes[:'primary_key'] + end + + if attributes.key?(:'ordinal_position') + self.ordinal_position = attributes[:'ordinal_position'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + data_type_validator = EnumAttributeValidator.new('String', ["SMALLINT", "SMALLINT_ARRAY", "INTEGER", "INTEGER_ARRAY", "BIGINT", "BIGINT_ARRAY", "DECIMAL", "NUMERIC", "DOUBLE", "DOUBLE_ARRAY", "SERIAL", "BIGSERIAL", "BYTEA", "BYTEA_ARRAY", "BOOLEAN", "BOOLEAN_ARRAY", "DATE", "DATE_ARRAY", "TIME", "TIME_ARRAY", "TIMETZ", "TIMETZ_ARRAY", "TIMESTAMPTZ", "TIMESTAMPTZ_ARRAY", "UUID", "UUID_ARRAY", "UUID_ARRAY_ARRAY", "TEXT", "TEXT_ARRAY", "JSONB"]) + return false unless data_type_validator.valid?(@data_type) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] data_type Object to be assigned + def data_type=(data_type) + validator = EnumAttributeValidator.new('String', ["SMALLINT", "SMALLINT_ARRAY", "INTEGER", "INTEGER_ARRAY", "BIGINT", "BIGINT_ARRAY", "DECIMAL", "NUMERIC", "DOUBLE", "DOUBLE_ARRAY", "SERIAL", "BIGSERIAL", "BYTEA", "BYTEA_ARRAY", "BOOLEAN", "BOOLEAN_ARRAY", "DATE", "DATE_ARRAY", "TIME", "TIME_ARRAY", "TIMETZ", "TIMETZ_ARRAY", "TIMESTAMPTZ", "TIMESTAMPTZ_ARRAY", "UUID", "UUID_ARRAY", "UUID_ARRAY_ARRAY", "TEXT", "TEXT_ARRAY", "JSONB"]) + unless validator.valid?(data_type) + fail ArgumentError, "invalid value for \"data_type\", must be one of #{validator.allowable_values}." + end + @data_type = data_type + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + id == o.id && + name == o.name && + title == o.title && + description == o.description && + table_id == o.table_id && + organization_id == o.organization_id && + data_type == o.data_type && + primary_key == o.primary_key && + ordinal_position == o.ordinal_position + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [id, name, title, description, table_id, organization_id, data_type, primary_key, ordinal_position].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/organization_external_database_table.rb b/ruby/lib/openapi_client/models/organization_external_database_table.rb new file mode 100644 index 0000000..d3b69db --- /dev/null +++ b/ruby/lib/openapi_client/models/organization_external_database_table.rb @@ -0,0 +1,242 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class OrganizationExternalDatabaseTable + attr_accessor :id + + attr_accessor :name + + attr_accessor :title + + attr_accessor :description + + attr_accessor :organization_id + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'id' => :'id', + :'name' => :'name', + :'title' => :'title', + :'description' => :'description', + :'organization_id' => :'organizationId' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'id' => :'String', + :'name' => :'String', + :'title' => :'String', + :'description' => :'String', + :'organization_id' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::OrganizationExternalDatabaseTable` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::OrganizationExternalDatabaseTable`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.key?(:'name') + self.name = attributes[:'name'] + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + + if attributes.key?(:'organization_id') + self.organization_id = attributes[:'organization_id'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + id == o.id && + name == o.name && + title == o.title && + description == o.description && + organization_id == o.organization_id + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [id, name, title, description, organization_id].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/organization_external_database_table_columns_pair.rb b/ruby/lib/openapi_client/models/organization_external_database_table_columns_pair.rb new file mode 100644 index 0000000..1d158fd --- /dev/null +++ b/ruby/lib/openapi_client/models/organization_external_database_table_columns_pair.rb @@ -0,0 +1,217 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class OrganizationExternalDatabaseTableColumnsPair + attr_accessor :table + + attr_accessor :columns + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'table' => :'table', + :'columns' => :'columns' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'table' => :'OrganizationExternalDatabaseTable', + :'columns' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::OrganizationExternalDatabaseTableColumnsPair` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::OrganizationExternalDatabaseTableColumnsPair`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'table') + self.table = attributes[:'table'] + end + + if attributes.key?(:'columns') + if (value = attributes[:'columns']).is_a?(Array) + self.columns = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + table == o.table && + columns == o.columns + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [table, columns].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/organization_member.rb b/ruby/lib/openapi_client/models/organization_member.rb new file mode 100644 index 0000000..f91e72e --- /dev/null +++ b/ruby/lib/openapi_client/models/organization_member.rb @@ -0,0 +1,226 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class OrganizationMember + attr_accessor :principal + + attr_accessor :profile + + attr_accessor :roles + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'principal' => :'principal', + :'profile' => :'profile', + :'roles' => :'roles' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'principal' => :'SecurablePrincipal', + :'profile' => :'Auth0userBasic', + :'roles' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::OrganizationMember` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::OrganizationMember`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'principal') + self.principal = attributes[:'principal'] + end + + if attributes.key?(:'profile') + self.profile = attributes[:'profile'] + end + + if attributes.key?(:'roles') + if (value = attributes[:'roles']).is_a?(Array) + self.roles = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + principal == o.principal && + profile == o.profile && + roles == o.roles + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [principal, profile, roles].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/principal.rb b/ruby/lib/openapi_client/models/principal.rb new file mode 100644 index 0000000..06d385a --- /dev/null +++ b/ruby/lib/openapi_client/models/principal.rb @@ -0,0 +1,215 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class Principal + attr_accessor :type + + attr_accessor :id + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'type' => :'type', + :'id' => :'id' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'type' => :'String', + :'id' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Principal` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Principal`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + + if attributes.key?(:'id') + self.id = attributes[:'id'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + type == o.type && + id == o.id + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [type, id].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/property_definition.rb b/ruby/lib/openapi_client/models/property_definition.rb new file mode 100644 index 0000000..6241cfd --- /dev/null +++ b/ruby/lib/openapi_client/models/property_definition.rb @@ -0,0 +1,215 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class PropertyDefinition + attr_accessor :type + + attr_accessor :column + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'type' => :'type', + :'column' => :'column' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'type' => :'FullQualifiedName', + :'column' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::PropertyDefinition` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::PropertyDefinition`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + + if attributes.key?(:'column') + self.column = attributes[:'column'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + type == o.type && + column == o.column + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [type, column].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/property_type.rb b/ruby/lib/openapi_client/models/property_type.rb new file mode 100644 index 0000000..062413d --- /dev/null +++ b/ruby/lib/openapi_client/models/property_type.rb @@ -0,0 +1,358 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class PropertyType + attr_accessor :title + + attr_accessor :id + + attr_accessor :type + + attr_accessor :description + + attr_accessor :schemas + + attr_accessor :datatype + + attr_accessor :pii + + attr_accessor :multi_valued + + attr_accessor :analyzer + + attr_accessor :enum_values + + attr_accessor :index_type + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'title' => :'title', + :'id' => :'id', + :'type' => :'type', + :'description' => :'description', + :'schemas' => :'schemas', + :'datatype' => :'datatype', + :'pii' => :'pii', + :'multi_valued' => :'multiValued', + :'analyzer' => :'analyzer', + :'enum_values' => :'enumValues', + :'index_type' => :'indexType' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'title' => :'String', + :'id' => :'String', + :'type' => :'FullQualifiedName', + :'description' => :'String', + :'schemas' => :'Array', + :'datatype' => :'String', + :'pii' => :'Boolean', + :'multi_valued' => :'Boolean', + :'analyzer' => :'String', + :'enum_values' => :'Array', + :'index_type' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::PropertyType` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::PropertyType`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + + if attributes.key?(:'schemas') + if (value = attributes[:'schemas']).is_a?(Array) + self.schemas = value + end + end + + if attributes.key?(:'datatype') + self.datatype = attributes[:'datatype'] + end + + if attributes.key?(:'pii') + self.pii = attributes[:'pii'] + end + + if attributes.key?(:'multi_valued') + self.multi_valued = attributes[:'multi_valued'] + end + + if attributes.key?(:'analyzer') + self.analyzer = attributes[:'analyzer'] + end + + if attributes.key?(:'enum_values') + if (value = attributes[:'enum_values']).is_a?(Array) + self.enum_values = value + end + end + + if attributes.key?(:'index_type') + self.index_type = attributes[:'index_type'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + datatype_validator = EnumAttributeValidator.new('String', ["Binary", "Boolean", "Byte", "SByte", "Date", "DateTimeOffset", "TimeOfDay", "Duration", "Decimal", "Single", "Double", "Guid", "Int16", "Int32", "Int64", "String", "Stream", "Geography", "GeographyPoint", "GeographyLineString", "GeographyPolygon", "GeographyMultiPoint", "GeographyMultiLineString", "GeographyMultiPolygon", "GeographyCollection", "Geometry", "GeometryPoint", "GeometryLineString", "GeometryPolygon", "GeometryMultiPoint", "GeometryMultiLineString", "GeometryMultiPolygon", "GeometryCollection"]) + return false unless datatype_validator.valid?(@datatype) + analyzer_validator = EnumAttributeValidator.new('String', ["NONE", "METAPHONE", "STANDARD", "NOT_ANALYZED"]) + return false unless analyzer_validator.valid?(@analyzer) + index_type_validator = EnumAttributeValidator.new('String', ["BTREE", "HASH", "GIN", "NONE"]) + return false unless index_type_validator.valid?(@index_type) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] datatype Object to be assigned + def datatype=(datatype) + validator = EnumAttributeValidator.new('String', ["Binary", "Boolean", "Byte", "SByte", "Date", "DateTimeOffset", "TimeOfDay", "Duration", "Decimal", "Single", "Double", "Guid", "Int16", "Int32", "Int64", "String", "Stream", "Geography", "GeographyPoint", "GeographyLineString", "GeographyPolygon", "GeographyMultiPoint", "GeographyMultiLineString", "GeographyMultiPolygon", "GeographyCollection", "Geometry", "GeometryPoint", "GeometryLineString", "GeometryPolygon", "GeometryMultiPoint", "GeometryMultiLineString", "GeometryMultiPolygon", "GeometryCollection"]) + unless validator.valid?(datatype) + fail ArgumentError, "invalid value for \"datatype\", must be one of #{validator.allowable_values}." + end + @datatype = datatype + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] analyzer Object to be assigned + def analyzer=(analyzer) + validator = EnumAttributeValidator.new('String', ["NONE", "METAPHONE", "STANDARD", "NOT_ANALYZED"]) + unless validator.valid?(analyzer) + fail ArgumentError, "invalid value for \"analyzer\", must be one of #{validator.allowable_values}." + end + @analyzer = analyzer + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] index_type Object to be assigned + def index_type=(index_type) + validator = EnumAttributeValidator.new('String', ["BTREE", "HASH", "GIN", "NONE"]) + unless validator.valid?(index_type) + fail ArgumentError, "invalid value for \"index_type\", must be one of #{validator.allowable_values}." + end + @index_type = index_type + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + title == o.title && + id == o.id && + type == o.type && + description == o.description && + schemas == o.schemas && + datatype == o.datatype && + pii == o.pii && + multi_valued == o.multi_valued && + analyzer == o.analyzer && + enum_values == o.enum_values && + index_type == o.index_type + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [title, id, type, description, schemas, datatype, pii, multi_valued, analyzer, enum_values, index_type].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/property_usage_summary.rb b/ruby/lib/openapi_client/models/property_usage_summary.rb new file mode 100644 index 0000000..cf6da76 --- /dev/null +++ b/ruby/lib/openapi_client/models/property_usage_summary.rb @@ -0,0 +1,233 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class PropertyUsageSummary + attr_accessor :entity_type_id + + attr_accessor :entity_set_id + + attr_accessor :entity_set_name + + attr_accessor :count + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'entity_type_id' => :'entityTypeId', + :'entity_set_id' => :'entitySetId', + :'entity_set_name' => :'entitySetName', + :'count' => :'count' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'entity_type_id' => :'String', + :'entity_set_id' => :'String', + :'entity_set_name' => :'String', + :'count' => :'Integer' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::PropertyUsageSummary` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::PropertyUsageSummary`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'entity_type_id') + self.entity_type_id = attributes[:'entity_type_id'] + end + + if attributes.key?(:'entity_set_id') + self.entity_set_id = attributes[:'entity_set_id'] + end + + if attributes.key?(:'entity_set_name') + self.entity_set_name = attributes[:'entity_set_name'] + end + + if attributes.key?(:'count') + self.count = attributes[:'count'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + entity_type_id == o.entity_type_id && + entity_set_id == o.entity_set_id && + entity_set_name == o.entity_set_name && + count == o.count + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [entity_type_id, entity_set_id, entity_set_name, count].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/role.rb b/ruby/lib/openapi_client/models/role.rb new file mode 100644 index 0000000..af9cd34 --- /dev/null +++ b/ruby/lib/openapi_client/models/role.rb @@ -0,0 +1,242 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class Role + attr_accessor :id + + attr_accessor :organization_id + + attr_accessor :principal + + attr_accessor :title + + attr_accessor :description + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'id' => :'id', + :'organization_id' => :'organizationId', + :'principal' => :'principal', + :'title' => :'title', + :'description' => :'description' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'id' => :'String', + :'organization_id' => :'String', + :'principal' => :'Principal', + :'title' => :'String', + :'description' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Role` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Role`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.key?(:'organization_id') + self.organization_id = attributes[:'organization_id'] + end + + if attributes.key?(:'principal') + self.principal = attributes[:'principal'] + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + id == o.id && + organization_id == o.organization_id && + principal == o.principal && + title == o.title && + description == o.description + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [id, organization_id, principal, title, description].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/schema.rb b/ruby/lib/openapi_client/models/schema.rb new file mode 100644 index 0000000..7e7146c --- /dev/null +++ b/ruby/lib/openapi_client/models/schema.rb @@ -0,0 +1,228 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class Schema + attr_accessor :entity_types + + attr_accessor :property_types + + attr_accessor :fqn + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'entity_types' => :'entityTypes', + :'property_types' => :'propertyTypes', + :'fqn' => :'fqn' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'entity_types' => :'Array', + :'property_types' => :'Array', + :'fqn' => :'FullQualifiedName' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Schema` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Schema`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'entity_types') + if (value = attributes[:'entity_types']).is_a?(Array) + self.entity_types = value + end + end + + if attributes.key?(:'property_types') + if (value = attributes[:'property_types']).is_a?(Array) + self.property_types = value + end + end + + if attributes.key?(:'fqn') + self.fqn = attributes[:'fqn'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + entity_types == o.entity_types && + property_types == o.property_types && + fqn == o.fqn + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [entity_types, property_types, fqn].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/search.rb b/ruby/lib/openapi_client/models/search.rb new file mode 100644 index 0000000..19fc7e3 --- /dev/null +++ b/ruby/lib/openapi_client/models/search.rb @@ -0,0 +1,245 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + # A JSON object that contains between three and five parameters. Required parameters are \"start\" and \"maxHits, which specify the hit number to start returning results on for paging and the maximum number of hits to return. Optional parameters are \"query\" (specifies the keywords used to perform the search), \"eid\" (UUID of the entity type of the entity sets that will be returned), and \"pid\" (a set of UUIDs of property types belonging to the entity sets that will be returned). All three of these parameters are optional, but at least one must be specified otherwise an error will be thrown. If eid and pid are both specified, the pid param will be ignored. + class Search + attr_accessor :keyword + + attr_accessor :entity_type_id + + attr_accessor :property_type_ids + + attr_accessor :start + + attr_accessor :max_hits + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'keyword' => :'keyword', + :'entity_type_id' => :'entityTypeId', + :'property_type_ids' => :'propertyTypeIds', + :'start' => :'start', + :'max_hits' => :'maxHits' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'keyword' => :'String', + :'entity_type_id' => :'String', + :'property_type_ids' => :'Array', + :'start' => :'Integer', + :'max_hits' => :'Integer' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::Search` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::Search`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'keyword') + self.keyword = attributes[:'keyword'] + end + + if attributes.key?(:'entity_type_id') + self.entity_type_id = attributes[:'entity_type_id'] + end + + if attributes.key?(:'property_type_ids') + if (value = attributes[:'property_type_ids']).is_a?(Array) + self.property_type_ids = value + end + end + + if attributes.key?(:'start') + self.start = attributes[:'start'] + end + + if attributes.key?(:'max_hits') + self.max_hits = attributes[:'max_hits'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + keyword == o.keyword && + entity_type_id == o.entity_type_id && + property_type_ids == o.property_type_ids && + start == o.start && + max_hits == o.max_hits + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [keyword, entity_type_id, property_type_ids, start, max_hits].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/search_constraints.rb b/ruby/lib/openapi_client/models/search_constraints.rb new file mode 100644 index 0000000..5137fed --- /dev/null +++ b/ruby/lib/openapi_client/models/search_constraints.rb @@ -0,0 +1,246 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class SearchConstraints + attr_accessor :entity_set_ids + + attr_accessor :start + + attr_accessor :max_hits + + attr_accessor :constraints + + attr_accessor :sort + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'entity_set_ids' => :'entitySetIds', + :'start' => :'start', + :'max_hits' => :'maxHits', + :'constraints' => :'constraints', + :'sort' => :'sort' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'entity_set_ids' => :'Array', + :'start' => :'Integer', + :'max_hits' => :'Integer', + :'constraints' => :'Array', + :'sort' => :'SortDefinition' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::SearchConstraints` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::SearchConstraints`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'entity_set_ids') + if (value = attributes[:'entity_set_ids']).is_a?(Array) + self.entity_set_ids = value + end + end + + if attributes.key?(:'start') + self.start = attributes[:'start'] + end + + if attributes.key?(:'max_hits') + self.max_hits = attributes[:'max_hits'] + end + + if attributes.key?(:'constraints') + if (value = attributes[:'constraints']).is_a?(Array) + self.constraints = value + end + end + + if attributes.key?(:'sort') + self.sort = attributes[:'sort'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + entity_set_ids == o.entity_set_ids && + start == o.start && + max_hits == o.max_hits && + constraints == o.constraints && + sort == o.sort + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [entity_set_ids, start, max_hits, constraints, sort].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/search_details.rb b/ruby/lib/openapi_client/models/search_details.rb new file mode 100644 index 0000000..3282f13 --- /dev/null +++ b/ruby/lib/openapi_client/models/search_details.rb @@ -0,0 +1,224 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class SearchDetails + attr_accessor :search_term + + attr_accessor :property + + attr_accessor :exact + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'search_term' => :'searchTerm', + :'property' => :'property', + :'exact' => :'exact' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'search_term' => :'String', + :'property' => :'String', + :'exact' => :'Boolean' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::SearchDetails` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::SearchDetails`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'search_term') + self.search_term = attributes[:'search_term'] + end + + if attributes.key?(:'property') + self.property = attributes[:'property'] + end + + if attributes.key?(:'exact') + self.exact = attributes[:'exact'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + search_term == o.search_term && + property == o.property && + exact == o.exact + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [search_term, property, exact].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/search_result.rb b/ruby/lib/openapi_client/models/search_result.rb new file mode 100644 index 0000000..93d0ea6 --- /dev/null +++ b/ruby/lib/openapi_client/models/search_result.rb @@ -0,0 +1,217 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class SearchResult + attr_accessor :num_hits + + attr_accessor :hits + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'num_hits' => :'numHits', + :'hits' => :'hits' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'num_hits' => :'Integer', + :'hits' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::SearchResult` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::SearchResult`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'num_hits') + self.num_hits = attributes[:'num_hits'] + end + + if attributes.key?(:'hits') + if (value = attributes[:'hits']).is_a?(Array) + self.hits = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + num_hits == o.num_hits && + hits == o.hits + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [num_hits, hits].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/search_result_hits.rb b/ruby/lib/openapi_client/models/search_result_hits.rb new file mode 100644 index 0000000..6967534 --- /dev/null +++ b/ruby/lib/openapi_client/models/search_result_hits.rb @@ -0,0 +1,217 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class SearchResultHits + attr_accessor :property_types + + attr_accessor :entity_set + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'property_types' => :'propertyTypes', + :'entity_set' => :'entitySet' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'property_types' => :'Array', + :'entity_set' => :'EntitySet' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::SearchResultHits` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::SearchResultHits`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'property_types') + if (value = attributes[:'property_types']).is_a?(Array) + self.property_types = value + end + end + + if attributes.key?(:'entity_set') + self.entity_set = attributes[:'entity_set'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + property_types == o.property_types && + entity_set == o.entity_set + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [property_types, entity_set].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/search_term.rb b/ruby/lib/openapi_client/models/search_term.rb new file mode 100644 index 0000000..baf1605 --- /dev/null +++ b/ruby/lib/openapi_client/models/search_term.rb @@ -0,0 +1,233 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class SearchTerm + attr_accessor :search_term + + attr_accessor :start + + attr_accessor :max_hits + + attr_accessor :fuzzy + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'search_term' => :'searchTerm', + :'start' => :'start', + :'max_hits' => :'maxHits', + :'fuzzy' => :'fuzzy' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'search_term' => :'String', + :'start' => :'Integer', + :'max_hits' => :'Integer', + :'fuzzy' => :'Boolean' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::SearchTerm` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::SearchTerm`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'search_term') + self.search_term = attributes[:'search_term'] + end + + if attributes.key?(:'start') + self.start = attributes[:'start'] + end + + if attributes.key?(:'max_hits') + self.max_hits = attributes[:'max_hits'] + end + + if attributes.key?(:'fuzzy') + self.fuzzy = attributes[:'fuzzy'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + search_term == o.search_term && + start == o.start && + max_hits == o.max_hits && + fuzzy == o.fuzzy + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [search_term, start, max_hits, fuzzy].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/securable_principal.rb b/ruby/lib/openapi_client/models/securable_principal.rb new file mode 100644 index 0000000..9f0384a --- /dev/null +++ b/ruby/lib/openapi_client/models/securable_principal.rb @@ -0,0 +1,233 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class SecurablePrincipal + attr_accessor :id + + attr_accessor :principal + + attr_accessor :title + + attr_accessor :description + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'id' => :'id', + :'principal' => :'principal', + :'title' => :'title', + :'description' => :'description' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'id' => :'String', + :'principal' => :'Principal', + :'title' => :'String', + :'description' => :'String' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::SecurablePrincipal` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::SecurablePrincipal`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'id') + self.id = attributes[:'id'] + end + + if attributes.key?(:'principal') + self.principal = attributes[:'principal'] + end + + if attributes.key?(:'title') + self.title = attributes[:'title'] + end + + if attributes.key?(:'description') + self.description = attributes[:'description'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + id == o.id && + principal == o.principal && + title == o.title && + description == o.description + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [id, principal, title, description].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/sms_entity_set_information.rb b/ruby/lib/openapi_client/models/sms_entity_set_information.rb new file mode 100644 index 0000000..dce0fd0 --- /dev/null +++ b/ruby/lib/openapi_client/models/sms_entity_set_information.rb @@ -0,0 +1,237 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class SmsEntitySetInformation + attr_accessor :phone_number + + attr_accessor :organization_id + + attr_accessor :entityset_ids + + attr_accessor :tags + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'phone_number' => :'phoneNumber', + :'organization_id' => :'organizationId', + :'entityset_ids' => :'entitysetIds', + :'tags' => :'tags' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'phone_number' => :'String', + :'organization_id' => :'String', + :'entityset_ids' => :'Array', + :'tags' => :'Array' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::SmsEntitySetInformation` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::SmsEntitySetInformation`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'phone_number') + self.phone_number = attributes[:'phone_number'] + end + + if attributes.key?(:'organization_id') + self.organization_id = attributes[:'organization_id'] + end + + if attributes.key?(:'entityset_ids') + if (value = attributes[:'entityset_ids']).is_a?(Array) + self.entityset_ids = value + end + end + + if attributes.key?(:'tags') + if (value = attributes[:'tags']).is_a?(Array) + self.tags = value + end + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + true + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + phone_number == o.phone_number && + organization_id == o.organization_id && + entityset_ids == o.entityset_ids && + tags == o.tags + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [phone_number, organization_id, entityset_ids, tags].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/models/sort_definition.rb b/ruby/lib/openapi_client/models/sort_definition.rb new file mode 100644 index 0000000..6d492bf --- /dev/null +++ b/ruby/lib/openapi_client/models/sort_definition.rb @@ -0,0 +1,276 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'date' + +module OpenapiClient + class SortDefinition + attr_accessor :type + + attr_accessor :descending + + attr_accessor :property_type_id + + attr_accessor :latitude + + attr_accessor :longitude + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :'type' => :'type', + :'descending' => :'descending', + :'property_type_id' => :'propertyTypeId', + :'latitude' => :'latitude', + :'longitude' => :'longitude' + } + end + + # Attribute type mapping. + def self.openapi_types + { + :'type' => :'String', + :'descending' => :'Boolean', + :'property_type_id' => :'String', + :'latitude' => :'Float', + :'longitude' => :'Float' + } + end + + # List of attributes with nullable: true + def self.openapi_nullable + Set.new([ + ]) + end + + # Initializes the object + # @param [Hash] attributes Model attributes in the form of hash + def initialize(attributes = {}) + if (!attributes.is_a?(Hash)) + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::SortDefinition` initialize method" + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::SortDefinition`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + end + h[k.to_sym] = v + } + + if attributes.key?(:'type') + self.type = attributes[:'type'] + end + + if attributes.key?(:'descending') + self.descending = attributes[:'descending'] + end + + if attributes.key?(:'property_type_id') + self.property_type_id = attributes[:'property_type_id'] + end + + if attributes.key?(:'latitude') + self.latitude = attributes[:'latitude'] + end + + if attributes.key?(:'longitude') + self.longitude = attributes[:'longitude'] + end + end + + # Show invalid properties with the reasons. Usually used together with valid? + # @return Array for valid properties with the reasons + def list_invalid_properties + invalid_properties = Array.new + invalid_properties + end + + # Check to see if the all the properties in the model are valid + # @return true if the model is valid + def valid? + type_validator = EnumAttributeValidator.new('String', ["field", "score", "geoDistance"]) + return false unless type_validator.valid?(@type) + true + end + + # Custom attribute writer method checking allowed values (enum). + # @param [Object] type Object to be assigned + def type=(type) + validator = EnumAttributeValidator.new('String', ["field", "score", "geoDistance"]) + unless validator.valid?(type) + fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}." + end + @type = type + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(o) + return true if self.equal?(o) + self.class == o.class && + type == o.type && + descending == o.descending && + property_type_id == o.property_type_id && + latitude == o.latitude && + longitude == o.longitude + end + + # @see the `==` method + # @param [Object] Object to be compared + def eql?(o) + self == o + end + + # Calculates hash code according to all attributes. + # @return [Integer] Hash code + def hash + [type, descending, property_type_id, latitude, longitude].hash + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def self.build_from_hash(attributes) + new.build_from_hash(attributes) + end + + # Builds the object from hash + # @param [Hash] attributes Model attributes in the form of hash + # @return [Object] Returns the model itself + def build_from_hash(attributes) + return nil unless attributes.is_a?(Hash) + self.class.openapi_types.each_pair do |key, type| + if type =~ /\AArray<(.*)>/i + # check to ensure the input is an array given that the attribute + # is documented as an array but the input is not + if attributes[self.class.attribute_map[key]].is_a?(Array) + self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) + end + elsif !attributes[self.class.attribute_map[key]].nil? + self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) + end # or else data not found in attributes(hash), not an issue as the data can be optional + end + + self + end + + # Deserializes the data based on type + # @param string type Data type + # @param string value Value to be deserialized + # @return [Object] Deserialized data + def _deserialize(type, value) + case type.to_sym + when :DateTime + DateTime.parse(value) + when :Date + Date.parse(value) + when :String + value.to_s + when :Integer + value.to_i + when :Float + value.to_f + when :Boolean + if value.to_s =~ /\A(true|t|yes|y|1)\z/i + true + else + false + end + when :Object + # generic object (usually a Hash), return directly + value + when /\AArray<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\z/ + k_type = Regexp.last_match[:k_type] + v_type = Regexp.last_match[:v_type] + {}.tap do |hash| + value.each do |k, v| + hash[_deserialize(k_type, k)] = _deserialize(v_type, v) + end + end + else # model + OpenapiClient.const_get(type).build_from_hash(value) + end + end + + # Returns the string representation of the object + # @return [String] String presentation of the object + def to_s + to_hash.to_s + end + + # to_body is an alias to to_hash (backward compatibility) + # @return [Hash] Returns the object in the form of hash + def to_body + to_hash + end + + # Returns the object in the form of hash + # @return [Hash] Returns the object in the form of hash + def to_hash + hash = {} + self.class.attribute_map.each_pair do |attr, param| + value = self.send(attr) + if value.nil? + is_nullable = self.class.openapi_nullable.include?(attr) + next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) + end + + hash[param] = _to_hash(value) + end + hash + end + + # Outputs non-array value in the form of hash + # For object, use to_hash. Otherwise, just return the value + # @param [Object] value Any valid value + # @return [Hash] Returns the value in the form of hash + def _to_hash(value) + if value.is_a?(Array) + value.compact.map { |v| _to_hash(v) } + elsif value.is_a?(Hash) + {}.tap do |hash| + value.each { |k, v| hash[k] = _to_hash(v) } + end + elsif value.respond_to? :to_hash + value.to_hash + else + value + end + end + end +end diff --git a/ruby/lib/openapi_client/version.rb b/ruby/lib/openapi_client/version.rb new file mode 100644 index 0000000..b6ace35 --- /dev/null +++ b/ruby/lib/openapi_client/version.rb @@ -0,0 +1,15 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +module OpenapiClient + VERSION = '1.0.0' +end diff --git a/ruby/openapi_client.gemspec b/ruby/openapi_client.gemspec new file mode 100644 index 0000000..38ba6cd --- /dev/null +++ b/ruby/openapi_client.gemspec @@ -0,0 +1,38 @@ +# -*- encoding: utf-8 -*- + +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +$:.push File.expand_path("../lib", __FILE__) +require "openapi_client/version" + +Gem::Specification.new do |s| + s.name = "openapi_client" + s.version = OpenapiClient::VERSION + s.platform = Gem::Platform::RUBY + s.authors = ["OpenAPI-Generator"] + s.email = ["support@openlattice.com"] + s.homepage = "https://openapi-generator.tech" + s.summary = "OpenLattice API Ruby Gem" + s.description = "OpenLattice API" + s.license = "Unlicense" + s.required_ruby_version = ">= 1.9" + + s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1' + + s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0' + + s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? } + s.test_files = `find spec/*`.split("\n") + s.executables = [] + s.require_paths = ["lib"] +end diff --git a/ruby/spec/api/admin_api_spec.rb b/ruby/spec/api/admin_api_spec.rb new file mode 100644 index 0000000..e360a91 --- /dev/null +++ b/ruby/spec/api/admin_api_spec.rb @@ -0,0 +1,77 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' + +# Unit tests for OpenapiClient::AdminApi +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'AdminApi' do + before do + # run before each test + @api_instance = OpenapiClient::AdminApi.new + end + + after do + # run after each test + end + + describe 'test an instance of AdminApi' do + it 'should create an instance of AdminApi' do + expect(@api_instance).to be_instance_of(OpenapiClient::AdminApi) + end + end + + # unit tests for clear_indexing_queue + # Clears all the data currently being indexed in the queue. + # @param [Hash] opts the optional parameters + # @return [Integer] + describe 'clear_indexing_queue test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_indexing_state + # Retrieve the current state of reindexing jobs + # @param [Hash] opts the optional parameters + # @return [IndexingState] + describe 'get_indexing_state test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for reindex + # Merge job descriptions for performing a partial or full reindex of provided entity sets. + # @param request_body A map of entity set ids to entity key ids that determines what will be reindexed. If no entity key ids are provided then all entities in an entity set are reindexed. If no entity set ids are provided then all entity sets are scheduled for reindexing. + # @param [Hash] opts the optional parameters + # @return [IndexingState] + describe 'reindex test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_reindex + # Replaces job descriptions for performing a partial or full reindex of provided entity sets. + # @param request_body A map of entity set ids to entity key ids that determines what will be reindexed. If no entity key ids are provided then all entities in an entity set are reindexed. If no entity set ids are provided then all entity sets are scheduled for reindexing. + # @param [Hash] opts the optional parameters + # @return [IndexingState] + describe 'update_reindex test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/api/authorizations_api_spec.rb b/ruby/spec/api/authorizations_api_spec.rb new file mode 100644 index 0000000..6cb617a --- /dev/null +++ b/ruby/spec/api/authorizations_api_spec.rb @@ -0,0 +1,59 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' + +# Unit tests for OpenapiClient::AuthorizationsApi +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'AuthorizationsApi' do + before do + # run before each test + @api_instance = OpenapiClient::AuthorizationsApi.new + end + + after do + # run after each test + end + + describe 'test an instance of AuthorizationsApi' do + it 'should create an instance of AuthorizationsApi' do + expect(@api_instance).to be_instance_of(OpenapiClient::AuthorizationsApi) + end + end + + # unit tests for check_authorizations + # Check authorizations + # @param access_check + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'check_authorizations test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_accessible_objects + # Returns paged results for all authorized objects of specified objectType, that the current user has specified permission for. + # @param [Hash] opts the optional parameters + # @option opts [String] :object_type + # @option opts [String] :permission + # @option opts [String] :paging_token + # @return [AuthorizedObjectsSearchResult] + describe 'get_accessible_objects test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/api/collections_api_spec.rb b/ruby/spec/api/collections_api_spec.rb new file mode 100644 index 0000000..00d30fa --- /dev/null +++ b/ruby/spec/api/collections_api_spec.rb @@ -0,0 +1,192 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' + +# Unit tests for OpenapiClient::CollectionsApi +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'CollectionsApi' do + before do + # run before each test + @api_instance = OpenapiClient::CollectionsApi.new + end + + after do + # run after each test + end + + describe 'test an instance of CollectionsApi' do + it 'should create an instance of CollectionsApi' do + expect(@api_instance).to be_instance_of(OpenapiClient::CollectionsApi) + end + end + + # unit tests for add_type_to_entity_type_collection_template + # Appends type to template of the specified EntityTypeCollection + # @param entity_type_collection_id + # @param collection_template_type + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'add_type_to_entity_type_collection_template test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for create_entity_set_collection + # Creates a new EntitySetCollection + # @param entity_set_collection + # @param [Hash] opts the optional parameters + # @return [String] + describe 'create_entity_set_collection test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for create_entity_type_collection + # Creates a new EntityTypeCollection + # @param entity_type_collection + # @param [Hash] opts the optional parameters + # @return [String] + describe 'create_entity_type_collection test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_entity_set_collection + # Deletes the specified EntitySetCollection + # @param entity_set_collection_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_entity_set_collection test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_entity_type_collection + # Deletes the specified EntityTypeCollection + # @param entity_type_collection_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_entity_type_collection test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_all_entity_set_collections + # Returns all EntitySetCollection objects + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_all_entity_set_collections test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_all_entity_type_collections + # Returns all EntityTypeCollection objects + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_all_entity_type_collections test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_set_collection + # Returns the EntitySetCollection object for a given id + # @param entity_set_collection_id + # @param [Hash] opts the optional parameters + # @return [EntitySetCollection] + describe 'get_entity_set_collection test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_set_collections_of_type + # Returns all authorized EntitySetCollections for a given EntityTypeCollection id + # @param entity_set_collection_id + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_entity_set_collections_of_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_type_collection + # Returns the EntityTypeCollection object for a given id + # @param entity_type_collection_id + # @param [Hash] opts the optional parameters + # @return [EntityTypeCollection] + describe 'get_entity_type_collection test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for remove_type_from_entity_type_collection_template + # Removes a key from an EntityTypeCollection template + # @param entity_type_collection_id + # @param type_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'remove_type_from_entity_type_collection_template test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_entity_set_collection_metadata + # Updates metadata of the specified EntitySetCollection + # @param entity_set_collection_id + # @param metadata_update + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'update_entity_set_collection_metadata test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_entity_set_collection_template + # Updates template of the specified EntitySetCollection + # @param entity_set_collection_id + # @param request_body + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'update_entity_set_collection_template test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_entity_type_collection_metadata + # Updates metadata of the specified EntityTypeCollection + # @param entity_type_collection_id + # @param metadata_update + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'update_entity_type_collection_metadata test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/api/data_api_spec.rb b/ruby/spec/api/data_api_spec.rb new file mode 100644 index 0000000..57fb953 --- /dev/null +++ b/ruby/spec/api/data_api_spec.rb @@ -0,0 +1,253 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' + +# Unit tests for OpenapiClient::DataApi +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'DataApi' do + before do + # run before each test + @api_instance = OpenapiClient::DataApi.new + end + + after do + # run after each test + end + + describe 'test an instance of DataApi' do + it 'should create an instance of DataApi' do + expect(@api_instance).to be_instance_of(OpenapiClient::DataApi) + end + end + + # unit tests for create_associations + # Creates a new set of associations. + # @param inline_object + # @param [Hash] opts the optional parameters + # @return [Hash>] + describe 'create_associations test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for create_edges + # Creates a new set of associations. + # @param data_edge_key + # @param [Hash] opts the optional parameters + # @return [Integer] + describe 'create_edges test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for create_entities + # Creates a new set of entities. + # @param set_id + # @param request_body + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'create_entities test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for create_entity_and_association_data + # Creates entities and assocations + # @param data_graph + # @param [Hash] opts the optional parameters + # @return [DataGraphIds] + describe 'create_entity_and_association_data test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_all_entities_from_entity_set + # Clears the Entity matching the given Entity id and all of its neighbor Entities + # @param entity_set_id + # @param type + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_all_entities_from_entity_set test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_entities + # Deletes multiple entities from an entity set. + # @param entity_set_id + # @param type + # @param request_body + # @param [Hash] opts the optional parameters + # @return [Integer] + describe 'delete_entities test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_entities_and_neighbors + # Deletes the entities matching the given entity ids and all of its neighbor entities provided in the filter. + # @param entity_set_id + # @param type + # @param entity_neighbors_filter + # @param [Hash] opts the optional parameters + # @return [Integer] + describe 'delete_entities_and_neighbors test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_entity + # Deletes a single entity from an entity set. + # @param entity_set_id + # @param entity_key_id + # @param type + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_entity test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_entity_properties + # Deletes properties from an entity. + # @param entity_set_id + # @param entity_key_id + # @param type + # @param request_body + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_entity_properties test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity + # Loads a single entity by its entityKeyId and entitySetId + # @param entity_set_id + # @param entity_key_id + # @param [Hash] opts the optional parameters + # @return [Hash>] + describe 'get_entity test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_property_values + # Loads property values for a single entity by its entityKeyId, entitySetId and propertyTypeId + # @param entity_set_id + # @param entity_key_id + # @param property_type_id + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_entity_property_values test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_set_size + # Gets the number of entities in an entity set. + # @param entity_set_id + # @param [Hash] opts the optional parameters + # @return [Integer] + describe 'get_entity_set_size test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for load_entity_set_data + # Gets an iterable containing the entity data, using property type FQNs as key + # @param entity_set_id + # @param [Hash] opts the optional parameters + # @return [Array>>] + describe 'load_entity_set_data test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for load_linked_entity_set_breakdown + # Loads a linked entity set breakdown with the selected linked entities and properties. + # @param linked_entity_set_id + # @param entity_set_selection + # @param [Hash] opts the optional parameters + # @return [Hash>>>>] + describe 'load_linked_entity_set_breakdown test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for load_selected_entity_set_data + # Gets a list of entities by UUIDs + # @param entity_set_id + # @param entity_set_selection + # @param [Hash] opts the optional parameters + # @return [Array>>] + describe 'load_selected_entity_set_data test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for replace_association_data + # Replaces Association Data + # @param partial + # @param request_body + # @param [Hash] opts the optional parameters + # @return [Integer] + describe 'replace_association_data test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for replace_entity_properties + # Replaces Entity Properties + # @param entity_set_id + # @param request_body + # @param [Hash] opts the optional parameters + # @return [Integer] + describe 'replace_entity_properties test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_entities_in_entity_set + # Perform one of the following bulk update operations on entities (type = Merge) adds new properties without affecting existing data, (type = PartialReplace) replaces all values for supplied property types, but does not not affect other property types for an entity, (type = Replace) replaces all entity data with the supplied properties. + # @param entity_set_id + # @param type + # @param request_body + # @param [Hash] opts the optional parameters + # @return [Integer] + describe 'update_entities_in_entity_set test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/api/data_integrations_api_spec.rb b/ruby/spec/api/data_integrations_api_spec.rb new file mode 100644 index 0000000..caca390 --- /dev/null +++ b/ruby/spec/api/data_integrations_api_spec.rb @@ -0,0 +1,58 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' + +# Unit tests for OpenapiClient::DataIntegrationsApi +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'DataIntegrationsApi' do + before do + # run before each test + @api_instance = OpenapiClient::DataIntegrationsApi.new + end + + after do + # run after each test + end + + describe 'test an instance of DataIntegrationsApi' do + it 'should create an instance of DataIntegrationsApi' do + expect(@api_instance).to be_instance_of(OpenapiClient::DataIntegrationsApi) + end + end + + # unit tests for get_entity_key_ids + # Get entity key IDs + # @param entity_key + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_entity_key_ids test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for integrate_entity_and_association_data + # Integrate entity and association data + # @param detailed_results + # @param bulk_data_creation + # @param [Hash] opts the optional parameters + # @return [IntegrationResults] + describe 'integrate_entity_and_association_data test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/api/dataset_api_spec.rb b/ruby/spec/api/dataset_api_spec.rb new file mode 100644 index 0000000..5eef7fd --- /dev/null +++ b/ruby/spec/api/dataset_api_spec.rb @@ -0,0 +1,182 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' + +# Unit tests for OpenapiClient::DatasetApi +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'DatasetApi' do + before do + # run before each test + @api_instance = OpenapiClient::DatasetApi.new + end + + after do + # run after each test + end + + describe 'test an instance of DatasetApi' do + it 'should create an instance of DatasetApi' do + expect(@api_instance).to be_instance_of(OpenapiClient::DatasetApi) + end + end + + # unit tests for delete_external_database_column + # Deletes an OrganizationExternalDatabaseColumn object, which represents an organization's column in an external database. This deletes both the object and the column in the database. It is a hard delete. + # @param organization_id + # @param table_name + # @param column_name + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_external_database_column test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_external_database_columns + # Deletes multiple OrganizationExternalDatabaseColumn objects and the columns they represent within an organization's table in an external database. It is a hard delete + # @param organization_id + # @param table_name + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_external_database_columns test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_external_database_table + # Deletes an OrganizationExternalDatabaseTable object, which represents an organization's table in an external database. This deletes both the object and the table in the database. It is a hard delete. + # @param organization_id + # @param table_name + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_external_database_table test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_external_database_tables + # Deletes multiple OrganizationExternalDatabaseTable objects and the tables they represent in the database. It is a hard delete. + # @param organization_id + # @param request_body + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_external_database_tables test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_authorized_external_db_tables_with_column_metadata + # Gets a map of all OrganizationExternalDatabaseTable objects to OrganizationExternalDatabase columns that are contained within each table. + # @param organization_id + # @param permission + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_authorized_external_db_tables_with_column_metadata test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_external_database_column + # Gets an OrganizationExternalDatabaseColumn object, which represents a column within an organization's table in an external database. + # @param organization_id + # @param table_name + # @param column_name + # @param [Hash] opts the optional parameters + # @return [OrganizationExternalDatabaseColumn] + describe 'get_external_database_column test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_external_database_table + # Gets an OrganizationExternalDatabaseTable object, which represents an organization's table in an external database. + # @param organization_id + # @param table_name + # @param [Hash] opts the optional parameters + # @return [OrganizationExternalDatabaseTable] + describe 'get_external_database_table test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_external_database_table_with_column_metadata + # Gets an object containing an OrganizationExternalDatabaseTable object and its OrganizationExternalDatabase columns for an organization + # @param organization_id + # @param table_id + # @param [Hash] opts the optional parameters + # @return [OrganizationExternalDatabaseTableColumnsPair] + describe 'get_external_database_table_with_column_metadata test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_external_database_tables + # Gets all OrganizationExternalDatabaseTable objects for an organization + # @param organization_id + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_external_database_tables test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_external_database_tables_with_column_metadata + # Gets a map of all OrganizationExternalDatabaseTable objects to OrganizationExternalDatabase columns that are contained within each table. + # @param organization_id + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_external_database_tables_with_column_metadata test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_external_database_column + # Updates an OrganizationExternalDatabaseTableColumn object's fields that are included within the given metadata. + # @param organization_id + # @param table_name + # @param column_name + # @param metadata_update + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'update_external_database_column test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_external_database_table + # Updates an OrganizationExternalDatabaseTable object's fields that are included within the given metadata. + # @param organization_id + # @param table_name + # @param metadata_update + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'update_external_database_table test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/api/edm_api_spec.rb b/ruby/spec/api/edm_api_spec.rb new file mode 100644 index 0000000..bc43b2e --- /dev/null +++ b/ruby/spec/api/edm_api_spec.rb @@ -0,0 +1,728 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' + +# Unit tests for OpenapiClient::EdmApi +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EdmApi' do + before do + # run before each test + @api_instance = OpenapiClient::EdmApi.new + end + + after do + # run after each test + end + + describe 'test an instance of EdmApi' do + it 'should create an instance of EdmApi' do + expect(@api_instance).to be_instance_of(OpenapiClient::EdmApi) + end + end + + # unit tests for add_dst_entity_type_to_association_type + # Update the AssociationType dst entity types for the given AssociationType UUID by adding the given EntityType UUID. + # @param association_type_id + # @param entity_type_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'add_dst_entity_type_to_association_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for add_entity_sets_to_linking_entity_set + # Adds the entity sets as linked entity sets to the linking entity set + # @param linking_entity_set_id + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Integer] + describe 'add_entity_sets_to_linking_entity_set test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for add_entity_sets_to_linking_entity_sets + # Adds the entity sets as linked entity sets to the linking entity sets + # @param linking_entity_set_id + # @param request_body + # @param [Hash] opts the optional parameters + # @return [Integer] + describe 'add_entity_sets_to_linking_entity_sets test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for add_primary_key_to_entity_type + # Adds a primary key with a given ID to an entity type with a given ID. + # @param entity_type_id + # @param property_type_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'add_primary_key_to_entity_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for add_property_type_to_entity_type + # Updates the EntityType definition for the given EntityType UUID by adding the given PropertyType UUID. + # @param entity_type_id + # @param property_type_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'add_property_type_to_entity_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for add_src_entity_type_to_association_type + # Update the AssociationType src entity types for the given AssociationType UUID by adding the given EntityType UUID. + # @param association_type_id + # @param entity_type_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'add_src_entity_type_to_association_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for create_association_type + # Creates a new AssociationType definition, if it doesn't exist. + # @param association_type + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'create_association_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for create_empty_schema + # Creates an empty schema, if it doesn't exist. If schema exists then no action is taken. + # @param namespace + # @param name + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'create_empty_schema test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for create_entity_sets + # Creates new EntitySet definitions if they don't exist. + # @param entity_set + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'create_entity_sets test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for create_entity_type + # Creates a new EntityType definition, if it doesn't exist. + # @param entity_type + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'create_entity_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for create_property_type + # Creates a new PropertyType definition, if it doesn\"t exist. + # @param property_type + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'create_property_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for create_schema_if_not_exists + # Creates an empty schema, if it doesn't exist. If schema exists then no action is taken. + # @param schema + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'create_schema_if_not_exists test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_association_type + # Deletes the AssociationType definition for the given AssociationType UUID. + # @param association_type_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_association_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_entity_set + # Deletes the EntitySet definition for the given EntitySet UUID. + # @param entity_set_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_entity_set test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_entity_type + # Deletes the EntityType definition for the given EntityType UUID. + # @param entity_type_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_entity_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_property_type + # Deletes the PropertyType definition for the given PropertyType UUID. + # @param property_type_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_property_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for force_delete_property_type + # Deletes the PropertyType definition for the given PropertyType UUID regardless of whether or not there is data associated with it. + # @param property_type_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'force_delete_property_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for force_remove_property_type_from_entity_type + # Updates the EntityType definition for the given EntityType UUID by removing the given PropertyType UUID, regardless of whether or not there is data associated with the entity type. + # @param entity_type_id + # @param property_type_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'force_remove_property_type_from_entity_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_all_association_entity_types + # Gets all association EntityType definitions. + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_all_association_entity_types test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_all_available_association_types + # Get all available associations for the given AssociationType UUID. + # @param association_type_id + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_all_available_association_types test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_all_entity_set_property_metadata + # Get all entity set property metadata. + # @param entity_set_id + # @param [Hash] opts the optional parameters + # @return [Hash] + describe 'get_all_entity_set_property_metadata test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_all_entity_sets + # Get all EntitySet definitions. + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_all_entity_sets test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_all_entity_type_property_metadata + # Get all EntityType propertyType metadata + # @param entity_type_id + # @param [Hash] opts the optional parameters + # @return [Hash] + describe 'get_all_entity_type_property_metadata test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_all_entity_types + # Gets all EntityType definitions. + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_all_entity_types test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_all_property_types + # Gets all PropertyType definitions. + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_all_property_types test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_all_property_types_in_namespace + # Gets all PropertyType definitions under the given namespace. + # @param namespace + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_all_property_types_in_namespace test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_all_property_usage_summaries + # Get Property Usage Summary for all properties. + # @param [Hash] opts the optional parameters + # @return [Hash] + describe 'get_all_property_usage_summaries test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_association_type + # Get the AssociationType definition for the given AssociationType UUID. + # @param association_type_id + # @param [Hash] opts the optional parameters + # @return [AssociationType] + describe 'get_association_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_association_type_details + # Get details about the AssociationType for the given AssociationType UUID. + # @param association_type_id + # @param [Hash] opts the optional parameters + # @return [AssociationType] + describe 'get_association_type_details test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_data_model + # Gets the entity data model, including namespaces, schemas, entity types, association types, and property types. + # @param [Hash] opts the optional parameters + # @return [EDM] + describe 'get_entity_data_model test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_data_model_diff + # Gets the changes between the existing entity data model and the entity data model passed in, including schemas, association types, entity types, and property types. + # @param ed_mdiff + # @param [Hash] opts the optional parameters + # @return [EDMdiff] + describe 'get_entity_data_model_diff test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_set + # Get the EntitySet definition for the given EntitySet UUID. + # @param entity_set_id + # @param [Hash] opts the optional parameters + # @return [EntitySet] + describe 'get_entity_set test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_set_id + # Gets the EntitySet UUID for the given EntitySet name. + # @param entity_set_name + # @param [Hash] opts the optional parameters + # @return [String] + describe 'get_entity_set_id test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_set_ids + # Get IDs for entity sets given their names. + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Hash] + describe 'get_entity_set_ids test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_set_property_metadata + # Get specified property type metadata for an entity set. + # @param entity_set_id + # @param property_type_id + # @param [Hash] opts the optional parameters + # @return [EntitySetPropertyMetaData] + describe 'get_entity_set_property_metadata test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_type + # Gets the EntityType definition for the given EntityType UUID. + # @param entity_type_id + # @param [Hash] opts the optional parameters + # @return [EntityType] + describe 'get_entity_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_type_hierarchy + # Get the EntityType hierarchy for the given EntityType UUID. + # @param entity_type_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'get_entity_type_hierarchy test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_type_id + # Gets the EntityType UUID for the given EntityType FQN. + # @param namespace + # @param name + # @param [Hash] opts the optional parameters + # @return [String] + describe 'get_entity_type_id test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_type_property_metadata + # Get EntityType propertyType metadata + # @param entity_type_id + # @param property_type_id + # @param [Hash] opts the optional parameters + # @return [EntityTypePropertyMetadata] + describe 'get_entity_type_property_metadata test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_property_metadata_for_entity_sets + # Get property metadata for entity sets. + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Hash>] + describe 'get_property_metadata_for_entity_sets test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_property_type + # Gets the PropertyType definition for the given PropertyType UUID. + # @param property_type_id + # @param [Hash] opts the optional parameters + # @return [PropertyType] + describe 'get_property_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_property_type_id + # Gets the PropertyType UUID for the given PropertyType FQN. + # @param namespace + # @param name + # @param [Hash] opts the optional parameters + # @return [String] + describe 'get_property_type_id test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_property_types_for_entity_set + # Get all Property Types for entity set + # @param entity_set_id + # @param [Hash] opts the optional parameters + # @return [Hash] + describe 'get_property_types_for_entity_set test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_property_usage_summary + # Get Property Usage Summary for property with given ID. + # @param property_type_id + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_property_usage_summary test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_schema_contents + # Gets the schema contents for a corresponding namespace and name. + # @param namespace + # @param name + # @param [Hash] opts the optional parameters + # @option opts [String] :file_type + # @return [Schema] + describe 'get_schema_contents test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_schemas + # Gets all schemas. + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_schemas test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_schemas_in_namespace + # Gets all schemas associated with a given namespace and accessible by the caller. + # @param namespace + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_schemas_in_namespace test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for remove_dst_entity_type_from_association_type + # Updates the AssociationType dst entity types for the given AssociationType UUID by removing the given EntityType UUID. + # @param association_type_id + # @param entity_type_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'remove_dst_entity_type_from_association_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for remove_entity_sets_from_linking_entity_set + # Removes/unlinks the linked entity sets from the linking entity set + # @param linking_entity_set_id + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Integer] + describe 'remove_entity_sets_from_linking_entity_set test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for remove_entity_sets_from_linking_entity_sets + # Removes/unlinks the linked entity sets from the linking entity set + # @param linking_entity_set_id + # @param request_body + # @param [Hash] opts the optional parameters + # @return [Integer] + describe 'remove_entity_sets_from_linking_entity_sets test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for remove_primary_key_from_entity_type + # Removes a primary key with a given ID from an entity type with a given ID. + # @param entity_type_id + # @param property_type_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'remove_primary_key_from_entity_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for remove_property_type_from_entity_type + # Updates the EntityType definition for the given EntityType UUID by removing the given PropertyType UUID. + # @param entity_type_id + # @param property_type_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'remove_property_type_from_entity_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for remove_src_entity_type_from_association_type + # Updates the AssociationType src entity types for the given AssociationType UUID by removing the given EntityType UUID. + # @param association_type_id + # @param entity_type_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'remove_src_entity_type_from_association_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for reorder_property_types_in_entity_type + # Updates the EntityType definition for the given EntityType UUID by reordering its properties as specified by the provided list. + # @param entity_type_id + # @param property_type_ids + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'reorder_property_types_in_entity_type test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_entity_data_model + # Updates the entity data model, including schemas, entity types, association types, and property types. + # @param edm + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'update_entity_data_model test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_entity_set_meta_data + # Updates the EntitySet definition for the given EntitySet UUID with the given metadata. + # @param entity_set_id + # @param metadata_update + # @param [Hash] opts the optional parameters + # @return [Integer] + describe 'update_entity_set_meta_data test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_entity_set_property_metadata + # Updates the property type metadata for the given entity set. + # @param entity_set_id + # @param property_type_id + # @param metadata_update + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'update_entity_set_property_metadata test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_entity_type_meta_data + # Updates the EntityType definition for the given EntityType UUID with the given metadata. + # @param entity_type_id + # @param metadata_update + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'update_entity_type_meta_data test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_entity_type_property_metadata + # Update EntityType Property metadata + # @param entity_type_id + # @param property_type_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'update_entity_type_property_metadata test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_property_type_meta_data + # Updates the PropertyType definition for the given PropertyType UUID with the given metadata. + # @param property_type_id + # @param metadata_update + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'update_property_type_meta_data test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_schema + # Edits the schema contents for a corresponding namespace and name. + # @param namespace + # @param name + # @param edm_request + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'update_schema test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/api/entity_sets_api_spec.rb b/ruby/spec/api/entity_sets_api_spec.rb new file mode 100644 index 0000000..df04bd2 --- /dev/null +++ b/ruby/spec/api/entity_sets_api_spec.rb @@ -0,0 +1,218 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' + +# Unit tests for OpenapiClient::EntitySetsApi +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EntitySetsApi' do + before do + # run before each test + @api_instance = OpenapiClient::EntitySetsApi.new + end + + after do + # run after each test + end + + describe 'test an instance of EntitySetsApi' do + it 'should create an instance of EntitySetsApi' do + expect(@api_instance).to be_instance_of(OpenapiClient::EntitySetsApi) + end + end + + # unit tests for add_entity_sets_to_linking_entity_set + # Adds the entity sets as linked entity sets to the linking entity set + # @param linking_entity_set_id + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Integer] + describe 'add_entity_sets_to_linking_entity_set test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for add_entity_sets_to_linking_entity_sets + # Adds the entity sets as linked entity sets to the linking entity sets + # @param linking_entity_set_id + # @param request_body + # @param [Hash] opts the optional parameters + # @return [Integer] + describe 'add_entity_sets_to_linking_entity_sets test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for create_entity_sets + # Creates new EntitySet definitions if they don't exist. + # @param entity_set + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'create_entity_sets test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_entity_set + # Deletes the EntitySet definition for the given EntitySet UUID. + # @param entity_set_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_entity_set test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_all_entity_set_property_metadata + # Get all entity set property metadata. + # @param entity_set_id + # @param [Hash] opts the optional parameters + # @return [Hash] + describe 'get_all_entity_set_property_metadata test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_all_entity_sets + # Get all EntitySet definitions. + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_all_entity_sets test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_set + # Get the EntitySet definition for the given EntitySet UUID. + # @param entity_set_id + # @param [Hash] opts the optional parameters + # @return [EntitySet] + describe 'get_entity_set test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_set_id + # Gets the EntitySet UUID for the given EntitySet name. + # @param entity_set_name + # @param [Hash] opts the optional parameters + # @return [String] + describe 'get_entity_set_id test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_set_ids + # Get IDs for entity sets given their names. + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Hash] + describe 'get_entity_set_ids test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_set_property_metadata + # Get specified property type metadata for an entity set. + # @param entity_set_id + # @param property_type_id + # @param [Hash] opts the optional parameters + # @return [EntitySetPropertyMetaData] + describe 'get_entity_set_property_metadata test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_property_metadata_for_entity_sets + # Get property metadata for entity sets. + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Hash>] + describe 'get_property_metadata_for_entity_sets test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_property_types_for_entity_set + # Get all Property Types for entity set + # @param entity_set_id + # @param [Hash] opts the optional parameters + # @return [Hash] + describe 'get_property_types_for_entity_set test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for remove_entity_sets_from_linking_entity_set + # Removes/unlinks the linked entity sets from the linking entity set + # @param linking_entity_set_id + # @param [Hash] opts the optional parameters + # @option opts [Array] :request_body + # @return [Integer] + describe 'remove_entity_sets_from_linking_entity_set test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for remove_entity_sets_from_linking_entity_sets + # Removes/unlinks the linked entity sets from the linking entity set + # @param linking_entity_set_id + # @param request_body + # @param [Hash] opts the optional parameters + # @return [Integer] + describe 'remove_entity_sets_from_linking_entity_sets test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_entity_set_meta_data + # Updates the EntitySet definition for the given EntitySet UUID with the given metadata. + # @param entity_set_id + # @param metadata_update + # @param [Hash] opts the optional parameters + # @return [Integer] + describe 'update_entity_set_meta_data test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_entity_set_property_metadata + # Updates the property type metadata for the given entity set. + # @param entity_set_id + # @param property_type_id + # @param metadata_update + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'update_entity_set_property_metadata test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/api/linking_api_spec.rb b/ruby/spec/api/linking_api_spec.rb new file mode 100644 index 0000000..9202d15 --- /dev/null +++ b/ruby/spec/api/linking_api_spec.rb @@ -0,0 +1,100 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' + +# Unit tests for OpenapiClient::LinkingApi +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'LinkingApi' do + before do + # run before each test + @api_instance = OpenapiClient::LinkingApi.new + end + + after do + # run after each test + end + + describe 'test an instance of LinkingApi' do + it 'should create an instance of LinkingApi' do + expect(@api_instance).to be_instance_of(OpenapiClient::LinkingApi) + end + end + + # unit tests for add_linking_feedback + # Submits feedbacks for a given linking entity set and linking id in a batch format. + # @param linking_feedback + # @param [Hash] opts the optional parameters + # @return [Integer] + describe 'add_linking_feedback test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_linking_feedback + # Deletes linking feedback + # @param entity_key_pair + # @param [Hash] opts the optional parameters + # @return [Integer] + describe 'delete_linking_feedback test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_all_linking_feedback + # Returns all feedback submitted + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_all_linking_feedback test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_all_linking_feedback_with_features + # Returns all feedback submitted walong with the features of pairwise entities + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_all_linking_feedback_with_features test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_linking_feedback_with_features + # Returns the feedback on the given entity pair along with their features + # @param entity_key_pair + # @param [Hash] opts the optional parameters + # @return [EntityLinkingFeatures] + describe 'get_linking_feedback_with_features test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_linking_feedbacks_on_entity + # Returns positive/negative/all linking feedbacks on the given entity. + # @param feedback_type + # @param entity_data_key + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_linking_feedbacks_on_entity test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/api/organizations_api_spec.rb b/ruby/spec/api/organizations_api_spec.rb new file mode 100644 index 0000000..e156e55 --- /dev/null +++ b/ruby/spec/api/organizations_api_spec.rb @@ -0,0 +1,352 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' + +# Unit tests for OpenapiClient::OrganizationsApi +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'OrganizationsApi' do + before do + # run before each test + @api_instance = OpenapiClient::OrganizationsApi.new + end + + after do + # run after each test + end + + describe 'test an instance of OrganizationsApi' do + it 'should create an instance of OrganizationsApi' do + expect(@api_instance).to be_instance_of(OpenapiClient::OrganizationsApi) + end + end + + # unit tests for add_member + # Add member to an organization + # @param organization_id + # @param user_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'add_member test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for add_role_to_user + # Add a role to a user + # @param organization_id + # @param role_id + # @param user_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'add_role_to_user test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for assemble_entity_sets + # Materializes entity sets into the organization database. + # @param organization_id + # @param request_body + # @param [Hash] opts the optional parameters + # @return [Hash>] + describe 'assemble_entity_sets test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for create_organization_if_not_exists + # Creates an organization if it doesn't exist. + # @param organization + # @param [Hash] opts the optional parameters + # @return [String] + describe 'create_organization_if_not_exists test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for create_role + # Creates role + # @param role + # @param [Hash] opts the optional parameters + # @return [String] + describe 'create_role test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_role + # Remove role for an organization + # @param organization_id + # @param role_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_role test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for destroy_organization + # Remove an organization from the organizationId + # @param organization_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'destroy_organization test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_all_users_of_role + # Get members of a role for an organization from a roleId + # @param organization_id + # @param role_id + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_all_users_of_role test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_auto_approved_email_domains + # Get auto-approved email domains + # @param organization_id + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_auto_approved_email_domains test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_flagged_organization_entity_sets + # Get the entity sets for an organization for a certain flag + # @param organization_id + # @param request_body + # @param [Hash] opts the optional parameters + # @return [Array>>] + describe 'get_flagged_organization_entity_sets test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_members + # Get members of a certain organization + # @param organization_id + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_members test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_organization + # Get an organization from the organizationId + # @param organization_id + # @param [Hash] opts the optional parameters + # @return [Organization] + describe 'get_organization test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_organization_entity_sets + # Get the entity sets for an organization for a certain filter + # @param organization_id + # @param [Hash] opts the optional parameters + # @return [Hash>] + describe 'get_organization_entity_sets test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_organization_integration_account + # Get the integrations account for an organization from the organizationId + # @param organization_id + # @param [Hash] opts the optional parameters + # @return [InlineResponse200] + describe 'get_organization_integration_account test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_organizations + # Get all organizations + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_organizations test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_role + # Get role for an organization from a roleId + # @param organization_id + # @param role_id + # @param [Hash] opts the optional parameters + # @return [Role] + describe 'get_role test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_roles + # Get roles for an organization + # @param organization_id + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_roles test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for refresh_data_changes + # Refreshes the requested materialized entity set with data changes in the organization. + # @param organization_id + # @param entity_set_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'refresh_data_changes test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for remove_auto_approved_email_domains + # Remove auto-approved email domains + # @param organization_id + # @param request_body + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'remove_auto_approved_email_domains test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for remove_member + # Remove member from an organization + # @param organization_id + # @param user_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'remove_member test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for remove_role_from_user + # Remove a role from a user + # @param organization_id + # @param role_id + # @param user_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'remove_role_from_user test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for set_auto_approved_email_domain + # Set auto-approved email domains + # @param organization_id + # @param request_body + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'set_auto_approved_email_domain test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for synchronize_edm_changes + # Synchronizes EDM changes to the requested materialized entity set in the organization. + # @param organization_id + # @param entity_set_id + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'synchronize_edm_changes test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_description + # Update the organization description + # @param organization_id + # @param body + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'update_description test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_role_description + # Update role description for an organization from a roleId + # @param organization_id + # @param role_id + # @param body + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'update_role_description test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_role_title + # Update role title for an organization from a roleId + # @param organization_id + # @param role_id + # @param body + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'update_role_title test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_title + # Update the organization title + # @param organization_id + # @param body + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'update_title test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/api/permissions_api_spec.rb b/ruby/spec/api/permissions_api_spec.rb new file mode 100644 index 0000000..662dfee --- /dev/null +++ b/ruby/spec/api/permissions_api_spec.rb @@ -0,0 +1,57 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' + +# Unit tests for OpenapiClient::PermissionsApi +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'PermissionsApi' do + before do + # run before each test + @api_instance = OpenapiClient::PermissionsApi.new + end + + after do + # run after each test + end + + describe 'test an instance of PermissionsApi' do + it 'should create an instance of PermissionsApi' do + expect(@api_instance).to be_instance_of(OpenapiClient::PermissionsApi) + end + end + + # unit tests for get_acl + # Get the ACL for the given ACL Key, only if the user is the owner of the ACL Key. + # @param request_body + # @param [Hash] opts the optional parameters + # @return [Acl] + describe 'get_acl test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_acl + # Updates the ACL for a particular ACL Key, only if the user is the owner of the ACL Key. + # @param acl_data + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'update_acl test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/api/principal_api_spec.rb b/ruby/spec/api/principal_api_spec.rb new file mode 100644 index 0000000..2c4d9ee --- /dev/null +++ b/ruby/spec/api/principal_api_spec.rb @@ -0,0 +1,108 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' + +# Unit tests for OpenapiClient::PrincipalApi +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'PrincipalApi' do + before do + # run before each test + @api_instance = OpenapiClient::PrincipalApi.new + end + + after do + # run after each test + end + + describe 'test an instance of PrincipalApi' do + it 'should create an instance of PrincipalApi' do + expect(@api_instance).to be_instance_of(OpenapiClient::PrincipalApi) + end + end + + # unit tests for get_all_users + # Get all users. + # @param [Hash] opts the optional parameters + # @return [Hash] + describe 'get_all_users test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_current_roles + # Get current roles. + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_current_roles test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_materialized_view_account + # Get the db access credentials. + # @param [Hash] opts the optional parameters + # @return [MaterializedViewAccount] + describe 'get_materialized_view_account test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_user + # Get the user for the given id. + # @param user_id + # @param [Hash] opts the optional parameters + # @return [Auth0userBasic] + describe 'get_user test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for search_all_users + # Get the user id for the given search. + # @param search_query + # @param [Hash] opts the optional parameters + # @return [Hash] + describe 'search_all_users test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for search_all_users_by_email + # Get the user id for the given email address. + # @param email_address + # @param [Hash] opts the optional parameters + # @return [Hash] + describe 'search_all_users_by_email test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for sync_calling_user + # Activates a user in the OpenLattice system. This call must be made once before a user will be available for use in authorization policies. + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'sync_calling_user test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/api/search_api_spec.rb b/ruby/spec/api/search_api_spec.rb new file mode 100644 index 0000000..bfeb0dc --- /dev/null +++ b/ruby/spec/api/search_api_spec.rb @@ -0,0 +1,250 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' + +# Unit tests for OpenapiClient::SearchApi +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'SearchApi' do + before do + # run before each test + @api_instance = OpenapiClient::SearchApi.new + end + + after do + # run after each test + end + + describe 'test an instance of SearchApi' do + it 'should create an instance of SearchApi' do + expect(@api_instance).to be_instance_of(OpenapiClient::SearchApi) + end + end + + # unit tests for execute_advanced_entity_set_data_query + # Executes a search over the data of a given entity set to find rows that match the search term + # @param entity_set_id + # @param advanced_search + # @param [Hash] opts the optional parameters + # @return [DataSearchResult] + describe 'execute_advanced_entity_set_data_query test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for execute_app_search + # Executes a search over all apps to find ones that match the given search term + # @param search_term + # @param [Hash] opts the optional parameters + # @return [SearchResult] + describe 'execute_app_search test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for execute_app_type_search + # Executes a search over all app types to find ones that match the given search term + # @param search_term + # @param [Hash] opts the optional parameters + # @return [SearchResult] + describe 'execute_app_type_search test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for execute_association_type_search + # Executes a search over all association types to find ones that match the given search term + # @param search_term + # @param [Hash] opts the optional parameters + # @return [SearchResult] + describe 'execute_association_type_search test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for execute_entity_neighbor_search + # Executes a search for all neighbors of an entity that are connected by an association + # @param entity_set_id + # @param entity_key_id + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'execute_entity_neighbor_search test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for execute_entity_neighbor_search_bulk + # Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association + # @param entity_set_id + # @param request_body + # @param [Hash] opts the optional parameters + # @return [Hash>] + describe 'execute_entity_neighbor_search_bulk test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for execute_entity_set_collection_search + # Executes a search over all EntitySetCollections to find ones that match the given search term + # @param search_term + # @param [Hash] opts the optional parameters + # @return [SearchResult] + describe 'execute_entity_set_collection_search test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for execute_entity_set_data_query + # Executes a search over the data of a given entity set to find rows that match the search term + # @param entity_set_id + # @param search_term A JSON object that contains three parameters, \"start\", which specifies the hit number to start returning results on for paging, \"maxHits\", which specifies the maximum number of hits to return, and \"searchTerm\", which is the search term results will match on. + # @param [Hash] opts the optional parameters + # @return [DataSearchResult] + describe 'execute_entity_set_data_query test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for execute_entity_set_keyword_query + # The query, entityType, and propertyTypes params are all optional, but at least one must be specified otherwise an error will be thrown. All specified params are required to be present in each entity set returned. If entityType and propertyTypes are both specified, the propertyTypes param will be ignored. + # @param search + # @param [Hash] opts the optional parameters + # @return [SearchResult] + describe 'execute_entity_set_keyword_query test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for execute_entity_type_collection_search + # Executes a search over all EntityTypeCollections to find ones that match the given search term + # @param search_term + # @param [Hash] opts the optional parameters + # @return [SearchResult] + describe 'execute_entity_type_collection_search test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for execute_entity_type_search + # Executes a search over all entity types to find ones that match the given search term + # @param search_term + # @param [Hash] opts the optional parameters + # @return [SearchResult] + describe 'execute_entity_type_search test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for execute_filtered_entity_neighbor_id_search + # Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association and returns a simple version of the neighborDetails + # @param entity_set_id + # @param neighbor_search_filter + # @param [Hash] opts the optional parameters + # @return [Hash>>>] + describe 'execute_filtered_entity_neighbor_id_search test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for execute_filtered_entity_neighbor_search + # Executes a search for all neighbors of multiple entities of the same entity set that are connected by an association + # @param entity_set_id + # @param neighbor_search_filter + # @param [Hash] opts the optional parameters + # @return [Hash>] + describe 'execute_filtered_entity_neighbor_search test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for execute_fqn_property_type_search + # Executes a search over all property types to find ones that match the given name and namespace, including partial matches + # @param search_term + # @param [Hash] opts the optional parameters + # @return [SearchResult] + describe 'execute_fqn_property_type_search test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for execute_organization_search + # Executes a search over all organizations to find ones that match the given search term + # @param search_term + # @param [Hash] opts the optional parameters + # @return [SearchResult] + describe 'execute_organization_search test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for execute_property_type_search + # Executes a search over all property types to find ones that match the given search term + # @param search_term + # @param [Hash] opts the optional parameters + # @return [SearchResult] + describe 'execute_property_type_search test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_entity_sets + # Executes a search over all existing entity sets to populate the home page. The path parameters instruct which page to return and how large the page should be. + # @param start The first result number to return + # @param num_results The total number of results to return + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_entity_sets test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for get_popular_entity_set + # Get the most popular entity sets. + # @param [Hash] opts the optional parameters + # @return [Array] + describe 'get_popular_entity_set test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for search_entity_set_data + # Executes a search over the data of a given entity set to find rows that match the search term + # @param search_constraints + # @param [Hash] opts the optional parameters + # @return [DataSearchResult] + describe 'search_entity_set_data test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/api/shuttle_api_spec.rb b/ruby/spec/api/shuttle_api_spec.rb new file mode 100644 index 0000000..2584d18 --- /dev/null +++ b/ruby/spec/api/shuttle_api_spec.rb @@ -0,0 +1,125 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' + +# Unit tests for OpenapiClient::ShuttleApi +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'ShuttleApi' do + before do + # run before each test + @api_instance = OpenapiClient::ShuttleApi.new + end + + after do + # run after each test + end + + describe 'test an instance of ShuttleApi' do + it 'should create an instance of ShuttleApi' do + expect(@api_instance).to be_instance_of(OpenapiClient::ShuttleApi) + end + end + + # unit tests for create_integration_definition + # Creates a new integration definition for running recurring integrations + # @param integration_name + # @param integration + # @param [Hash] opts the optional parameters + # @return [String] + describe 'create_integration_definition test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_integration_definition + # Replaces any number of fields within an existing integration definition + # @param integration_name + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_integration_definition test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for delete_integration_job_status + # Deletes an integration job status from the integrationJobs map + # @param job_id the unique id of the integration job + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'delete_integration_job_status test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for enqueue_integration + # Enqueues an integration on Shuttle Server for a given integration + # @param integration_name the name of the integration to be run + # @param integration_key the unique id used to authenticate an integration run + # @param [Hash] opts the optional parameters + # @return [String] + describe 'enqueue_integration test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for poll_all_integrations + # Polls the statuses of all running integrations + # @param [Hash] opts the optional parameters + # @return [Hash] + describe 'poll_all_integrations test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for poll_integration + # Polls the status of an integration + # @param job_id the unique id of the integration job + # @param [Hash] opts the optional parameters + # @return [String] + describe 'poll_integration test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for read_integration_definition + # Gets an existing integration definition + # @param integration_name + # @param [Hash] opts the optional parameters + # @return [Integration] + describe 'read_integration_definition test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + # unit tests for update_integration_definition + # Replaces any number of fields within an existing integration definition + # @param integration_name + # @param integration_update + # @param [Hash] opts the optional parameters + # @return [nil] + describe 'update_integration_definition test' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/api_client_spec.rb b/ruby/spec/api_client_spec.rb new file mode 100644 index 0000000..ed03b76 --- /dev/null +++ b/ruby/spec/api_client_spec.rb @@ -0,0 +1,226 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' + +describe OpenapiClient::ApiClient do + context 'initialization' do + context 'URL stuff' do + context 'host' do + it 'removes http from host' do + OpenapiClient.configure { |c| c.host = 'http://example.com' } + expect(OpenapiClient::Configuration.default.host).to eq('example.com') + end + + it 'removes https from host' do + OpenapiClient.configure { |c| c.host = 'https://wookiee.com' } + expect(OpenapiClient::ApiClient.default.config.host).to eq('wookiee.com') + end + + it 'removes trailing path from host' do + OpenapiClient.configure { |c| c.host = 'hobo.com/v4' } + expect(OpenapiClient::Configuration.default.host).to eq('hobo.com') + end + end + + context 'base_path' do + it "prepends a slash to base_path" do + OpenapiClient.configure { |c| c.base_path = 'v4/dog' } + expect(OpenapiClient::Configuration.default.base_path).to eq('/v4/dog') + end + + it "doesn't prepend a slash if one is already there" do + OpenapiClient.configure { |c| c.base_path = '/v4/dog' } + expect(OpenapiClient::Configuration.default.base_path).to eq('/v4/dog') + end + + it "ends up as a blank string if nil" do + OpenapiClient.configure { |c| c.base_path = nil } + expect(OpenapiClient::Configuration.default.base_path).to eq('') + end + end + end + end + + describe 'params_encoding in #build_request' do + let(:config) { OpenapiClient::Configuration.new } + let(:api_client) { OpenapiClient::ApiClient.new(config) } + + it 'defaults to nil' do + expect(OpenapiClient::Configuration.default.params_encoding).to eq(nil) + expect(config.params_encoding).to eq(nil) + + request = api_client.build_request(:get, '/test') + expect(request.options[:params_encoding]).to eq(nil) + end + + it 'can be customized' do + config.params_encoding = :multi + request = api_client.build_request(:get, '/test') + expect(request.options[:params_encoding]).to eq(:multi) + end + end + + describe 'timeout in #build_request' do + let(:config) { OpenapiClient::Configuration.new } + let(:api_client) { OpenapiClient::ApiClient.new(config) } + + it 'defaults to 0' do + expect(OpenapiClient::Configuration.default.timeout).to eq(0) + expect(config.timeout).to eq(0) + + request = api_client.build_request(:get, '/test') + expect(request.options[:timeout]).to eq(0) + end + + it 'can be customized' do + config.timeout = 100 + request = api_client.build_request(:get, '/test') + expect(request.options[:timeout]).to eq(100) + end + end + + describe '#deserialize' do + it "handles Array" do + api_client = OpenapiClient::ApiClient.new + headers = { 'Content-Type' => 'application/json' } + response = double('response', headers: headers, body: '[12, 34]') + data = api_client.deserialize(response, 'Array') + expect(data).to be_instance_of(Array) + expect(data).to eq([12, 34]) + end + + it 'handles Array>' do + api_client = OpenapiClient::ApiClient.new + headers = { 'Content-Type' => 'application/json' } + response = double('response', headers: headers, body: '[[12, 34], [56]]') + data = api_client.deserialize(response, 'Array>') + expect(data).to be_instance_of(Array) + expect(data).to eq([[12, 34], [56]]) + end + + it 'handles Hash' do + api_client = OpenapiClient::ApiClient.new + headers = { 'Content-Type' => 'application/json' } + response = double('response', headers: headers, body: '{"message": "Hello"}') + data = api_client.deserialize(response, 'Hash') + expect(data).to be_instance_of(Hash) + expect(data).to eq(:message => 'Hello') + end + end + + describe "#object_to_hash" do + it 'ignores nils and includes empty arrays' do + # uncomment below to test object_to_hash for model + # api_client = OpenapiClient::ApiClient.new + # _model = OpenapiClient::ModelName.new + # update the model attribute below + # _model.id = 1 + # update the expected value (hash) below + # expected = {id: 1, name: '', tags: []} + # expect(api_client.object_to_hash(_model)).to eq(expected) + end + end + + describe '#build_collection_param' do + let(:param) { ['aa', 'bb', 'cc'] } + let(:api_client) { OpenapiClient::ApiClient.new } + + it 'works for csv' do + expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc') + end + + it 'works for ssv' do + expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc') + end + + it 'works for tsv' do + expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc") + end + + it 'works for pipes' do + expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc') + end + + it 'works for multi' do + expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc']) + end + + it 'fails for invalid collection format' do + expect { api_client.build_collection_param(param, :INVALID) }.to raise_error(RuntimeError, 'unknown collection format: :INVALID') + end + end + + describe '#json_mime?' do + let(:api_client) { OpenapiClient::ApiClient.new } + + it 'works' do + expect(api_client.json_mime?(nil)).to eq false + expect(api_client.json_mime?('')).to eq false + + expect(api_client.json_mime?('application/json')).to eq true + expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true + expect(api_client.json_mime?('APPLICATION/JSON')).to eq true + + expect(api_client.json_mime?('application/xml')).to eq false + expect(api_client.json_mime?('text/plain')).to eq false + expect(api_client.json_mime?('application/jsonp')).to eq false + end + end + + describe '#select_header_accept' do + let(:api_client) { OpenapiClient::ApiClient.new } + + it 'works' do + expect(api_client.select_header_accept(nil)).to be_nil + expect(api_client.select_header_accept([])).to be_nil + + expect(api_client.select_header_accept(['application/json'])).to eq('application/json') + expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8') + expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON') + + expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml') + expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml') + end + end + + describe '#select_header_content_type' do + let(:api_client) { OpenapiClient::ApiClient.new } + + it 'works' do + expect(api_client.select_header_content_type(nil)).to eq('application/json') + expect(api_client.select_header_content_type([])).to eq('application/json') + + expect(api_client.select_header_content_type(['application/json'])).to eq('application/json') + expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8') + expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON') + expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml') + expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain') + end + end + + describe '#sanitize_filename' do + let(:api_client) { OpenapiClient::ApiClient.new } + + it 'works' do + expect(api_client.sanitize_filename('sun')).to eq('sun') + expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif') + expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif') + expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif') + expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif') + expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif') + expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif') + expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif') + expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif') + end + end +end diff --git a/ruby/spec/configuration_spec.rb b/ruby/spec/configuration_spec.rb new file mode 100644 index 0000000..e7b2fa6 --- /dev/null +++ b/ruby/spec/configuration_spec.rb @@ -0,0 +1,42 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' + +describe OpenapiClient::Configuration do + let(:config) { OpenapiClient::Configuration.default } + + before(:each) do + # uncomment below to setup host and base_path + # require 'URI' + # uri = URI.parse("https://api.openlattice.com") + # OpenapiClient.configure do |c| + # c.host = uri.host + # c.base_path = uri.path + # end + end + + describe '#base_url' do + it 'should have the default value' do + # uncomment below to test default value of the base path + # expect(config.base_url).to eq("https://api.openlattice.com") + end + + it 'should remove trailing slashes' do + [nil, '', '/', '//'].each do |base_path| + config.base_path = base_path + # uncomment below to test trailing slashes + # expect(config.base_url).to eq("https://api.openlattice.com") + end + end + end +end diff --git a/ruby/spec/models/access_check_spec.rb b/ruby/spec/models/access_check_spec.rb new file mode 100644 index 0000000..deac202 --- /dev/null +++ b/ruby/spec/models/access_check_spec.rb @@ -0,0 +1,51 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::AccessCheck +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'AccessCheck' do + before do + # run before each test + @instance = OpenapiClient::AccessCheck.new + end + + after do + # run after each test + end + + describe 'test an instance of AccessCheck' do + it 'should create an instance of AccessCheck' do + expect(@instance).to be_instance_of(OpenapiClient::AccessCheck) + end + end + describe 'test attribute "acl_key"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "permissions"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + # validator = Petstore::EnumTest::EnumAttributeValidator.new('Array', ["DISCOVER", "MATERIALIZE", "LINK", "READ", "WRITE", "OWNER"]) + # validator.allowable_values.each do |value| + # expect { @instance.permissions = value }.not_to raise_error + # end + end + end + +end diff --git a/ruby/spec/models/ace_spec.rb b/ruby/spec/models/ace_spec.rb new file mode 100644 index 0000000..0466bf6 --- /dev/null +++ b/ruby/spec/models/ace_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::Ace +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'Ace' do + before do + # run before each test + @instance = OpenapiClient::Ace.new + end + + after do + # run after each test + end + + describe 'test an instance of Ace' do + it 'should create an instance of Ace' do + expect(@instance).to be_instance_of(OpenapiClient::Ace) + end + end + describe 'test attribute "principal"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "permissions"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/acl_data_spec.rb b/ruby/spec/models/acl_data_spec.rb new file mode 100644 index 0000000..5fa07db --- /dev/null +++ b/ruby/spec/models/acl_data_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::AclData +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'AclData' do + before do + # run before each test + @instance = OpenapiClient::AclData.new + end + + after do + # run after each test + end + + describe 'test an instance of AclData' do + it 'should create an instance of AclData' do + expect(@instance).to be_instance_of(OpenapiClient::AclData) + end + end + describe 'test attribute "action"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "acl"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/acl_spec.rb b/ruby/spec/models/acl_spec.rb new file mode 100644 index 0000000..cba7b2e --- /dev/null +++ b/ruby/spec/models/acl_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::Acl +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'Acl' do + before do + # run before each test + @instance = OpenapiClient::Acl.new + end + + after do + # run after each test + end + + describe 'test an instance of Acl' do + it 'should create an instance of Acl' do + expect(@instance).to be_instance_of(OpenapiClient::Acl) + end + end + describe 'test attribute "acl_key"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "aces"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/advanced_search_spec.rb b/ruby/spec/models/advanced_search_spec.rb new file mode 100644 index 0000000..4f1f3f7 --- /dev/null +++ b/ruby/spec/models/advanced_search_spec.rb @@ -0,0 +1,53 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::AdvancedSearch +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'AdvancedSearch' do + before do + # run before each test + @instance = OpenapiClient::AdvancedSearch.new + end + + after do + # run after each test + end + + describe 'test an instance of AdvancedSearch' do + it 'should create an instance of AdvancedSearch' do + expect(@instance).to be_instance_of(OpenapiClient::AdvancedSearch) + end + end + describe 'test attribute "search_fields"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "start"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "max_hits"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/association_definition_spec.rb b/ruby/spec/models/association_definition_spec.rb new file mode 100644 index 0000000..8466be2 --- /dev/null +++ b/ruby/spec/models/association_definition_spec.rb @@ -0,0 +1,75 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::AssociationDefinition +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'AssociationDefinition' do + before do + # run before each test + @instance = OpenapiClient::AssociationDefinition.new + end + + after do + # run after each test + end + + describe 'test an instance of AssociationDefinition' do + it 'should create an instance of AssociationDefinition' do + expect(@instance).to be_instance_of(OpenapiClient::AssociationDefinition) + end + end + describe 'test attribute "fqn"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "entity_set_name"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "property_definitions"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "update_type"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["Replace", "PartialReplace", "Merge"]) + # validator.allowable_values.each do |value| + # expect { @instance.update_type = value }.not_to raise_error + # end + end + end + + describe 'test attribute "src"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "dst"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/association_spec.rb b/ruby/spec/models/association_spec.rb new file mode 100644 index 0000000..9e1ee5f --- /dev/null +++ b/ruby/spec/models/association_spec.rb @@ -0,0 +1,59 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::Association +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'Association' do + before do + # run before each test + @instance = OpenapiClient::Association.new + end + + after do + # run after each test + end + + describe 'test an instance of Association' do + it 'should create an instance of Association' do + expect(@instance).to be_instance_of(OpenapiClient::Association) + end + end + describe 'test attribute "key"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "src"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "dst"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "details"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/association_type_spec.rb b/ruby/spec/models/association_type_spec.rb new file mode 100644 index 0000000..5152c03 --- /dev/null +++ b/ruby/spec/models/association_type_spec.rb @@ -0,0 +1,59 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::AssociationType +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'AssociationType' do + before do + # run before each test + @instance = OpenapiClient::AssociationType.new + end + + after do + # run after each test + end + + describe 'test an instance of AssociationType' do + it 'should create an instance of AssociationType' do + expect(@instance).to be_instance_of(OpenapiClient::AssociationType) + end + end + describe 'test attribute "entity_type"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "src"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "dst"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "bidirectional"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/auth0user_basic_spec.rb b/ruby/spec/models/auth0user_basic_spec.rb new file mode 100644 index 0000000..d1e36c9 --- /dev/null +++ b/ruby/spec/models/auth0user_basic_spec.rb @@ -0,0 +1,71 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::Auth0userBasic +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'Auth0userBasic' do + before do + # run before each test + @instance = OpenapiClient::Auth0userBasic.new + end + + after do + # run after each test + end + + describe 'test an instance of Auth0userBasic' do + it 'should create an instance of Auth0userBasic' do + expect(@instance).to be_instance_of(OpenapiClient::Auth0userBasic) + end + end + describe 'test attribute "user_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "email"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "nickname"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "username"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "roles"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "com_openlattice_organization"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/authorization_spec.rb b/ruby/spec/models/authorization_spec.rb new file mode 100644 index 0000000..b5faac7 --- /dev/null +++ b/ruby/spec/models/authorization_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::Authorization +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'Authorization' do + before do + # run before each test + @instance = OpenapiClient::Authorization.new + end + + after do + # run after each test + end + + describe 'test an instance of Authorization' do + it 'should create an instance of Authorization' do + expect(@instance).to be_instance_of(OpenapiClient::Authorization) + end + end + describe 'test attribute "acl_key"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "permissions"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/authorized_objects_search_result_spec.rb b/ruby/spec/models/authorized_objects_search_result_spec.rb new file mode 100644 index 0000000..2b827e0 --- /dev/null +++ b/ruby/spec/models/authorized_objects_search_result_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::AuthorizedObjectsSearchResult +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'AuthorizedObjectsSearchResult' do + before do + # run before each test + @instance = OpenapiClient::AuthorizedObjectsSearchResult.new + end + + after do + # run after each test + end + + describe 'test an instance of AuthorizedObjectsSearchResult' do + it 'should create an instance of AuthorizedObjectsSearchResult' do + expect(@instance).to be_instance_of(OpenapiClient::AuthorizedObjectsSearchResult) + end + end + describe 'test attribute "paging_token"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "authorized_objects"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/bulk_data_creation_spec.rb b/ruby/spec/models/bulk_data_creation_spec.rb new file mode 100644 index 0000000..f51c914 --- /dev/null +++ b/ruby/spec/models/bulk_data_creation_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::BulkDataCreation +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'BulkDataCreation' do + before do + # run before each test + @instance = OpenapiClient::BulkDataCreation.new + end + + after do + # run after each test + end + + describe 'test an instance of BulkDataCreation' do + it 'should create an instance of BulkDataCreation' do + expect(@instance).to be_instance_of(OpenapiClient::BulkDataCreation) + end + end + describe 'test attribute "entities"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "associations"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/collection_template_type_spec.rb b/ruby/spec/models/collection_template_type_spec.rb new file mode 100644 index 0000000..e98af1a --- /dev/null +++ b/ruby/spec/models/collection_template_type_spec.rb @@ -0,0 +1,65 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::CollectionTemplateType +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'CollectionTemplateType' do + before do + # run before each test + @instance = OpenapiClient::CollectionTemplateType.new + end + + after do + # run after each test + end + + describe 'test an instance of CollectionTemplateType' do + it 'should create an instance of CollectionTemplateType' do + expect(@instance).to be_instance_of(OpenapiClient::CollectionTemplateType) + end + end + describe 'test attribute "id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "name"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "title"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "description"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "entity_type_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/constraint_group_spec.rb b/ruby/spec/models/constraint_group_spec.rb new file mode 100644 index 0000000..b113036 --- /dev/null +++ b/ruby/spec/models/constraint_group_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::ConstraintGroup +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'ConstraintGroup' do + before do + # run before each test + @instance = OpenapiClient::ConstraintGroup.new + end + + after do + # run after each test + end + + describe 'test an instance of ConstraintGroup' do + it 'should create an instance of ConstraintGroup' do + expect(@instance).to be_instance_of(OpenapiClient::ConstraintGroup) + end + end + describe 'test attribute "min"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "constraints"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/constraint_spec.rb b/ruby/spec/models/constraint_spec.rb new file mode 100644 index 0000000..89e06ba --- /dev/null +++ b/ruby/spec/models/constraint_spec.rb @@ -0,0 +1,115 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::Constraint +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'Constraint' do + before do + # run before each test + @instance = OpenapiClient::Constraint.new + end + + after do + # run after each test + end + + describe 'test an instance of Constraint' do + it 'should create an instance of Constraint' do + expect(@instance).to be_instance_of(OpenapiClient::Constraint) + end + end + describe 'test attribute "type"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["simple", "advanced", "geoDistance", "geoPolygon", "writeDateTimeFilter"]) + # validator.allowable_values.each do |value| + # expect { @instance.type = value }.not_to raise_error + # end + end + end + + describe 'test attribute "search_term"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "fuzzy"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "search_fields"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "property_type_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "latitude"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "longitude"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "radius"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "unit"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["miles", "mi", "yards", "yd", "feet", "ft", "inch", "in", "kilometers", "km", "meters", "m", "centimeters", "cm", "millimeters", "mm", "nauticalmiles", "nmi", "NM"]) + # validator.allowable_values.each do |value| + # expect { @instance.unit = value }.not_to raise_error + # end + end + end + + describe 'test attribute "zones"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "start"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "_end"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/data_association_spec.rb b/ruby/spec/models/data_association_spec.rb new file mode 100644 index 0000000..e8f08b2 --- /dev/null +++ b/ruby/spec/models/data_association_spec.rb @@ -0,0 +1,77 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::DataAssociation +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'DataAssociation' do + before do + # run before each test + @instance = OpenapiClient::DataAssociation.new + end + + after do + # run after each test + end + + describe 'test an instance of DataAssociation' do + it 'should create an instance of DataAssociation' do + expect(@instance).to be_instance_of(OpenapiClient::DataAssociation) + end + end + describe 'test attribute "src_entity_set_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "src_entity_index"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "src_entity_key_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "dst_entity_set_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "dst_entity_index"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "dst_entity_key_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "data"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/data_edge_data_spec.rb b/ruby/spec/models/data_edge_data_spec.rb new file mode 100644 index 0000000..09e66f4 --- /dev/null +++ b/ruby/spec/models/data_edge_data_spec.rb @@ -0,0 +1,41 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::DataEdgeData +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'DataEdgeData' do + before do + # run before each test + @instance = OpenapiClient::DataEdgeData.new + end + + after do + # run after each test + end + + describe 'test an instance of DataEdgeData' do + it 'should create an instance of DataEdgeData' do + expect(@instance).to be_instance_of(OpenapiClient::DataEdgeData) + end + end + describe 'test attribute "additional_properties"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/data_edge_key_spec.rb b/ruby/spec/models/data_edge_key_spec.rb new file mode 100644 index 0000000..8b48d60 --- /dev/null +++ b/ruby/spec/models/data_edge_key_spec.rb @@ -0,0 +1,53 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::DataEdgeKey +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'DataEdgeKey' do + before do + # run before each test + @instance = OpenapiClient::DataEdgeKey.new + end + + after do + # run after each test + end + + describe 'test an instance of DataEdgeKey' do + it 'should create an instance of DataEdgeKey' do + expect(@instance).to be_instance_of(OpenapiClient::DataEdgeKey) + end + end + describe 'test attribute "src"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "dst"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "edge"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/data_edge_spec.rb b/ruby/spec/models/data_edge_spec.rb new file mode 100644 index 0000000..12cf49a --- /dev/null +++ b/ruby/spec/models/data_edge_spec.rb @@ -0,0 +1,53 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::DataEdge +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'DataEdge' do + before do + # run before each test + @instance = OpenapiClient::DataEdge.new + end + + after do + # run after each test + end + + describe 'test an instance of DataEdge' do + it 'should create an instance of DataEdge' do + expect(@instance).to be_instance_of(OpenapiClient::DataEdge) + end + end + describe 'test attribute "src"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "dst"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "data"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/data_graph_ids_spec.rb b/ruby/spec/models/data_graph_ids_spec.rb new file mode 100644 index 0000000..497f5bf --- /dev/null +++ b/ruby/spec/models/data_graph_ids_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::DataGraphIds +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'DataGraphIds' do + before do + # run before each test + @instance = OpenapiClient::DataGraphIds.new + end + + after do + # run after each test + end + + describe 'test an instance of DataGraphIds' do + it 'should create an instance of DataGraphIds' do + expect(@instance).to be_instance_of(OpenapiClient::DataGraphIds) + end + end + describe 'test attribute "entity_key_ids"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "entity_set_ids"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/data_graph_spec.rb b/ruby/spec/models/data_graph_spec.rb new file mode 100644 index 0000000..528df91 --- /dev/null +++ b/ruby/spec/models/data_graph_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::DataGraph +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'DataGraph' do + before do + # run before each test + @instance = OpenapiClient::DataGraph.new + end + + after do + # run after each test + end + + describe 'test an instance of DataGraph' do + it 'should create an instance of DataGraph' do + expect(@instance).to be_instance_of(OpenapiClient::DataGraph) + end + end + describe 'test attribute "entities"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "associations"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/data_search_result_spec.rb b/ruby/spec/models/data_search_result_spec.rb new file mode 100644 index 0000000..b4e5550 --- /dev/null +++ b/ruby/spec/models/data_search_result_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::DataSearchResult +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'DataSearchResult' do + before do + # run before each test + @instance = OpenapiClient::DataSearchResult.new + end + + after do + # run after each test + end + + describe 'test an instance of DataSearchResult' do + it 'should create an instance of DataSearchResult' do + expect(@instance).to be_instance_of(OpenapiClient::DataSearchResult) + end + end + describe 'test attribute "num_hits"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "hits"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/ed_mdiff_spec.rb b/ruby/spec/models/ed_mdiff_spec.rb new file mode 100644 index 0000000..8a242f2 --- /dev/null +++ b/ruby/spec/models/ed_mdiff_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::EDMdiff +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EDMdiff' do + before do + # run before each test + @instance = OpenapiClient::EDMdiff.new + end + + after do + # run after each test + end + + describe 'test an instance of EDMdiff' do + it 'should create an instance of EDMdiff' do + expect(@instance).to be_instance_of(OpenapiClient::EDMdiff) + end + end + describe 'test attribute "conflicts"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "diff"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/edm_request_spec.rb b/ruby/spec/models/edm_request_spec.rb new file mode 100644 index 0000000..b517b58 --- /dev/null +++ b/ruby/spec/models/edm_request_spec.rb @@ -0,0 +1,57 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::EdmRequest +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EdmRequest' do + before do + # run before each test + @instance = OpenapiClient::EdmRequest.new + end + + after do + # run after each test + end + + describe 'test an instance of EdmRequest' do + it 'should create an instance of EdmRequest' do + expect(@instance).to be_instance_of(OpenapiClient::EdmRequest) + end + end + describe 'test attribute "action"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["ADD", "REMOVE", "REPLACE"]) + # validator.allowable_values.each do |value| + # expect { @instance.action = value }.not_to raise_error + # end + end + end + + describe 'test attribute "property_types"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "entity_types"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/edm_spec.rb b/ruby/spec/models/edm_spec.rb new file mode 100644 index 0000000..293e89c --- /dev/null +++ b/ruby/spec/models/edm_spec.rb @@ -0,0 +1,65 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::EDM +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EDM' do + before do + # run before each test + @instance = OpenapiClient::EDM.new + end + + after do + # run after each test + end + + describe 'test an instance of EDM' do + it 'should create an instance of EDM' do + expect(@instance).to be_instance_of(OpenapiClient::EDM) + end + end + describe 'test attribute "namespaces"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "schemas"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "property_types"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "entity_types"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "association_types"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/entity_data_key_spec.rb b/ruby/spec/models/entity_data_key_spec.rb new file mode 100644 index 0000000..d10d71f --- /dev/null +++ b/ruby/spec/models/entity_data_key_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::EntityDataKey +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EntityDataKey' do + before do + # run before each test + @instance = OpenapiClient::EntityDataKey.new + end + + after do + # run after each test + end + + describe 'test an instance of EntityDataKey' do + it 'should create an instance of EntityDataKey' do + expect(@instance).to be_instance_of(OpenapiClient::EntityDataKey) + end + end + describe 'test attribute "entity_set_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "entity_key_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/entity_definition_spec.rb b/ruby/spec/models/entity_definition_spec.rb new file mode 100644 index 0000000..9e72d58 --- /dev/null +++ b/ruby/spec/models/entity_definition_spec.rb @@ -0,0 +1,63 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::EntityDefinition +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EntityDefinition' do + before do + # run before each test + @instance = OpenapiClient::EntityDefinition.new + end + + after do + # run after each test + end + + describe 'test an instance of EntityDefinition' do + it 'should create an instance of EntityDefinition' do + expect(@instance).to be_instance_of(OpenapiClient::EntityDefinition) + end + end + describe 'test attribute "fqn"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "entity_set_name"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "property_definitions"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "update_type"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["Replace", "PartialReplace", "Merge"]) + # validator.allowable_values.each do |value| + # expect { @instance.update_type = value }.not_to raise_error + # end + end + end + +end diff --git a/ruby/spec/models/entity_key_pair_spec.rb b/ruby/spec/models/entity_key_pair_spec.rb new file mode 100644 index 0000000..ea6fcba --- /dev/null +++ b/ruby/spec/models/entity_key_pair_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::EntityKeyPair +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EntityKeyPair' do + before do + # run before each test + @instance = OpenapiClient::EntityKeyPair.new + end + + after do + # run after each test + end + + describe 'test an instance of EntityKeyPair' do + it 'should create an instance of EntityKeyPair' do + expect(@instance).to be_instance_of(OpenapiClient::EntityKeyPair) + end + end + describe 'test attribute "first"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "second"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/entity_key_spec.rb b/ruby/spec/models/entity_key_spec.rb new file mode 100644 index 0000000..4d455c0 --- /dev/null +++ b/ruby/spec/models/entity_key_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::EntityKey +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EntityKey' do + before do + # run before each test + @instance = OpenapiClient::EntityKey.new + end + + after do + # run after each test + end + + describe 'test an instance of EntityKey' do + it 'should create an instance of EntityKey' do + expect(@instance).to be_instance_of(OpenapiClient::EntityKey) + end + end + describe 'test attribute "entity_set_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "entity_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/entity_linking_features_spec.rb b/ruby/spec/models/entity_linking_features_spec.rb new file mode 100644 index 0000000..d5994b3 --- /dev/null +++ b/ruby/spec/models/entity_linking_features_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::EntityLinkingFeatures +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EntityLinkingFeatures' do + before do + # run before each test + @instance = OpenapiClient::EntityLinkingFeatures.new + end + + after do + # run after each test + end + + describe 'test an instance of EntityLinkingFeatures' do + it 'should create an instance of EntityLinkingFeatures' do + expect(@instance).to be_instance_of(OpenapiClient::EntityLinkingFeatures) + end + end + describe 'test attribute "entity_linking_feedback"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "features"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/entity_linking_feedback_spec.rb b/ruby/spec/models/entity_linking_feedback_spec.rb new file mode 100644 index 0000000..344101b --- /dev/null +++ b/ruby/spec/models/entity_linking_feedback_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::EntityLinkingFeedback +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EntityLinkingFeedback' do + before do + # run before each test + @instance = OpenapiClient::EntityLinkingFeedback.new + end + + after do + # run after each test + end + + describe 'test an instance of EntityLinkingFeedback' do + it 'should create an instance of EntityLinkingFeedback' do + expect(@instance).to be_instance_of(OpenapiClient::EntityLinkingFeedback) + end + end + describe 'test attribute "entity_key_pair"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "linked"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/entity_neighbors_filter_spec.rb b/ruby/spec/models/entity_neighbors_filter_spec.rb new file mode 100644 index 0000000..f5364c3 --- /dev/null +++ b/ruby/spec/models/entity_neighbors_filter_spec.rb @@ -0,0 +1,59 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::EntityNeighborsFilter +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EntityNeighborsFilter' do + before do + # run before each test + @instance = OpenapiClient::EntityNeighborsFilter.new + end + + after do + # run after each test + end + + describe 'test an instance of EntityNeighborsFilter' do + it 'should create an instance of EntityNeighborsFilter' do + expect(@instance).to be_instance_of(OpenapiClient::EntityNeighborsFilter) + end + end + describe 'test attribute "entity_key_ids"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "src"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "dst"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "edge"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/entity_set_collection_spec.rb b/ruby/spec/models/entity_set_collection_spec.rb new file mode 100644 index 0000000..6706dc2 --- /dev/null +++ b/ruby/spec/models/entity_set_collection_spec.rb @@ -0,0 +1,83 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::EntitySetCollection +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EntitySetCollection' do + before do + # run before each test + @instance = OpenapiClient::EntitySetCollection.new + end + + after do + # run after each test + end + + describe 'test an instance of EntitySetCollection' do + it 'should create an instance of EntitySetCollection' do + expect(@instance).to be_instance_of(OpenapiClient::EntitySetCollection) + end + end + describe 'test attribute "id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "name"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "title"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "description"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "entity_type_collection_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "template"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "contacts"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "organization_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/entity_set_property_meta_data_spec.rb b/ruby/spec/models/entity_set_property_meta_data_spec.rb new file mode 100644 index 0000000..8c7a78b --- /dev/null +++ b/ruby/spec/models/entity_set_property_meta_data_spec.rb @@ -0,0 +1,59 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::EntitySetPropertyMetaData +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EntitySetPropertyMetaData' do + before do + # run before each test + @instance = OpenapiClient::EntitySetPropertyMetaData.new + end + + after do + # run after each test + end + + describe 'test an instance of EntitySetPropertyMetaData' do + it 'should create an instance of EntitySetPropertyMetaData' do + expect(@instance).to be_instance_of(OpenapiClient::EntitySetPropertyMetaData) + end + end + describe 'test attribute "title"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "description"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "property_tags"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "default_show"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/entity_set_selection_spec.rb b/ruby/spec/models/entity_set_selection_spec.rb new file mode 100644 index 0000000..dd1231d --- /dev/null +++ b/ruby/spec/models/entity_set_selection_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::EntitySetSelection +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EntitySetSelection' do + before do + # run before each test + @instance = OpenapiClient::EntitySetSelection.new + end + + after do + # run after each test + end + + describe 'test an instance of EntitySetSelection' do + it 'should create an instance of EntitySetSelection' do + expect(@instance).to be_instance_of(OpenapiClient::EntitySetSelection) + end + end + describe 'test attribute "ids"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "properties"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/entity_set_spec.rb b/ruby/spec/models/entity_set_spec.rb new file mode 100644 index 0000000..b814798 --- /dev/null +++ b/ruby/spec/models/entity_set_spec.rb @@ -0,0 +1,105 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::EntitySet +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EntitySet' do + before do + # run before each test + @instance = OpenapiClient::EntitySet.new + end + + after do + # run after each test + end + + describe 'test an instance of EntitySet' do + it 'should create an instance of EntitySet' do + expect(@instance).to be_instance_of(OpenapiClient::EntitySet) + end + end + describe 'test attribute "id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "entity_type_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "name"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "title"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "description"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "contacts"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "linking"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "linked_entity_sets"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "organization_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "flags"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + # validator = Petstore::EnumTest::EnumAttributeValidator.new('Array', ["ASSOCIATION", "AUDIT", "EXTERNAL", "LINKING"]) + # validator.allowable_values.each do |value| + # expect { @instance.flags = value }.not_to raise_error + # end + end + end + + describe 'test attribute "partitions"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/entity_spec.rb b/ruby/spec/models/entity_spec.rb new file mode 100644 index 0000000..b3c3fea --- /dev/null +++ b/ruby/spec/models/entity_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::Entity +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'Entity' do + before do + # run before each test + @instance = OpenapiClient::Entity.new + end + + after do + # run after each test + end + + describe 'test an instance of Entity' do + it 'should create an instance of Entity' do + expect(@instance).to be_instance_of(OpenapiClient::Entity) + end + end + describe 'test attribute "key"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "details"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/entity_type_collection_spec.rb b/ruby/spec/models/entity_type_collection_spec.rb new file mode 100644 index 0000000..01d9501 --- /dev/null +++ b/ruby/spec/models/entity_type_collection_spec.rb @@ -0,0 +1,71 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::EntityTypeCollection +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EntityTypeCollection' do + before do + # run before each test + @instance = OpenapiClient::EntityTypeCollection.new + end + + after do + # run after each test + end + + describe 'test an instance of EntityTypeCollection' do + it 'should create an instance of EntityTypeCollection' do + expect(@instance).to be_instance_of(OpenapiClient::EntityTypeCollection) + end + end + describe 'test attribute "id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "type"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "title"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "description"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "schemas"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "template"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/entity_type_property_metadata_spec.rb b/ruby/spec/models/entity_type_property_metadata_spec.rb new file mode 100644 index 0000000..4f53986 --- /dev/null +++ b/ruby/spec/models/entity_type_property_metadata_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::EntityTypePropertyMetadata +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EntityTypePropertyMetadata' do + before do + # run before each test + @instance = OpenapiClient::EntityTypePropertyMetadata.new + end + + after do + # run after each test + end + + describe 'test an instance of EntityTypePropertyMetadata' do + it 'should create an instance of EntityTypePropertyMetadata' do + expect(@instance).to be_instance_of(OpenapiClient::EntityTypePropertyMetadata) + end + end + describe 'test attribute "title"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "description"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/entity_type_spec.rb b/ruby/spec/models/entity_type_spec.rb new file mode 100644 index 0000000..6fe9710 --- /dev/null +++ b/ruby/spec/models/entity_type_spec.rb @@ -0,0 +1,99 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::EntityType +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'EntityType' do + before do + # run before each test + @instance = OpenapiClient::EntityType.new + end + + after do + # run after each test + end + + describe 'test an instance of EntityType' do + it 'should create an instance of EntityType' do + expect(@instance).to be_instance_of(OpenapiClient::EntityType) + end + end + describe 'test attribute "title"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "description"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "type"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "schemas"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "key"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "properties"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "property_tags"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "basetype"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "category"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["AssociationType", "EntityType"]) + # validator.allowable_values.each do |value| + # expect { @instance.category = value }.not_to raise_error + # end + end + end + +end diff --git a/ruby/spec/models/flight_plan_parameters_spec.rb b/ruby/spec/models/flight_plan_parameters_spec.rb new file mode 100644 index 0000000..49fdebe --- /dev/null +++ b/ruby/spec/models/flight_plan_parameters_spec.rb @@ -0,0 +1,65 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::FlightPlanParameters +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'FlightPlanParameters' do + before do + # run before each test + @instance = OpenapiClient::FlightPlanParameters.new + end + + after do + # run after each test + end + + describe 'test an instance of FlightPlanParameters' do + it 'should create an instance of FlightPlanParameters' do + expect(@instance).to be_instance_of(OpenapiClient::FlightPlanParameters) + end + end + describe 'test attribute "sql"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "src"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "src_primary_key_columns"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "path"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "flight"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/flight_plan_parameters_update_spec.rb b/ruby/spec/models/flight_plan_parameters_update_spec.rb new file mode 100644 index 0000000..d2a523b --- /dev/null +++ b/ruby/spec/models/flight_plan_parameters_update_spec.rb @@ -0,0 +1,59 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::FlightPlanParametersUpdate +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'FlightPlanParametersUpdate' do + before do + # run before each test + @instance = OpenapiClient::FlightPlanParametersUpdate.new + end + + after do + # run after each test + end + + describe 'test an instance of FlightPlanParametersUpdate' do + it 'should create an instance of FlightPlanParametersUpdate' do + expect(@instance).to be_instance_of(OpenapiClient::FlightPlanParametersUpdate) + end + end + describe 'test attribute "sql"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "src"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "src_primary_key_columns"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "path"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/flight_spec.rb b/ruby/spec/models/flight_spec.rb new file mode 100644 index 0000000..3cf0c76 --- /dev/null +++ b/ruby/spec/models/flight_spec.rb @@ -0,0 +1,65 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::Flight +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'Flight' do + before do + # run before each test + @instance = OpenapiClient::Flight.new + end + + after do + # run after each test + end + + describe 'test an instance of Flight' do + it 'should create an instance of Flight' do + expect(@instance).to be_instance_of(OpenapiClient::Flight) + end + end + describe 'test attribute "name"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "tags"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "organization_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "entity_definitions"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "association_definitions"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/full_qualified_name_spec.rb b/ruby/spec/models/full_qualified_name_spec.rb new file mode 100644 index 0000000..c9752e7 --- /dev/null +++ b/ruby/spec/models/full_qualified_name_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::FullQualifiedName +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'FullQualifiedName' do + before do + # run before each test + @instance = OpenapiClient::FullQualifiedName.new + end + + after do + # run after each test + end + + describe 'test an instance of FullQualifiedName' do + it 'should create an instance of FullQualifiedName' do + expect(@instance).to be_instance_of(OpenapiClient::FullQualifiedName) + end + end + describe 'test attribute "name"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "namespace"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/indexing_state_spec.rb b/ruby/spec/models/indexing_state_spec.rb new file mode 100644 index 0000000..325e3ae --- /dev/null +++ b/ruby/spec/models/indexing_state_spec.rb @@ -0,0 +1,65 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::IndexingState +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'IndexingState' do + before do + # run before each test + @instance = OpenapiClient::IndexingState.new + end + + after do + # run after each test + end + + describe 'test an instance of IndexingState' do + it 'should create an instance of IndexingState' do + expect(@instance).to be_instance_of(OpenapiClient::IndexingState) + end + end + describe 'test attribute "indexing"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "queue"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "current_entity_set"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "queue_size"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "count"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/inline_object_spec.rb b/ruby/spec/models/inline_object_spec.rb new file mode 100644 index 0000000..d57752a --- /dev/null +++ b/ruby/spec/models/inline_object_spec.rb @@ -0,0 +1,41 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::InlineObject +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'InlineObject' do + before do + # run before each test + @instance = OpenapiClient::InlineObject.new + end + + after do + # run after each test + end + + describe 'test an instance of InlineObject' do + it 'should create an instance of InlineObject' do + expect(@instance).to be_instance_of(OpenapiClient::InlineObject) + end + end + describe 'test attribute "additional_properties"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/inline_response200_spec.rb b/ruby/spec/models/inline_response200_spec.rb new file mode 100644 index 0000000..ff07c26 --- /dev/null +++ b/ruby/spec/models/inline_response200_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::InlineResponse200 +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'InlineResponse200' do + before do + # run before each test + @instance = OpenapiClient::InlineResponse200.new + end + + after do + # run after each test + end + + describe 'test an instance of InlineResponse200' do + it 'should create an instance of InlineResponse200' do + expect(@instance).to be_instance_of(OpenapiClient::InlineResponse200) + end + end + describe 'test attribute "user"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "credential"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/integration_job_spec.rb b/ruby/spec/models/integration_job_spec.rb new file mode 100644 index 0000000..8d7c79c --- /dev/null +++ b/ruby/spec/models/integration_job_spec.rb @@ -0,0 +1,51 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::IntegrationJob +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'IntegrationJob' do + before do + # run before each test + @instance = OpenapiClient::IntegrationJob.new + end + + after do + # run after each test + end + + describe 'test an instance of IntegrationJob' do + it 'should create an instance of IntegrationJob' do + expect(@instance).to be_instance_of(OpenapiClient::IntegrationJob) + end + end + describe 'test attribute "name"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "status"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["IN_PROGRESS", "SUCCEEDED", "FAILED", "QUEUED", "FAILED_TO_START"]) + # validator.allowable_values.each do |value| + # expect { @instance.status = value }.not_to raise_error + # end + end + end + +end diff --git a/ruby/spec/models/integration_results_spec.rb b/ruby/spec/models/integration_results_spec.rb new file mode 100644 index 0000000..b9d5cf2 --- /dev/null +++ b/ruby/spec/models/integration_results_spec.rb @@ -0,0 +1,59 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::IntegrationResults +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'IntegrationResults' do + before do + # run before each test + @instance = OpenapiClient::IntegrationResults.new + end + + after do + # run after each test + end + + describe 'test an instance of IntegrationResults' do + it 'should create an instance of IntegrationResults' do + expect(@instance).to be_instance_of(OpenapiClient::IntegrationResults) + end + end + describe 'test attribute "entity_count"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "association_count"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "associations_entity_key_mappings"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "entity_sets_entity_key_mappings"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/integration_spec.rb b/ruby/spec/models/integration_spec.rb new file mode 100644 index 0000000..9f35892 --- /dev/null +++ b/ruby/spec/models/integration_spec.rb @@ -0,0 +1,93 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::Integration +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'Integration' do + before do + # run before each test + @instance = OpenapiClient::Integration.new + end + + after do + # run after each test + end + + describe 'test an instance of Integration' do + it 'should create an instance of Integration' do + expect(@instance).to be_instance_of(OpenapiClient::Integration) + end + end + describe 'test attribute "key"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "environment"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["PROD_INTEGRATION", "STAGING_INTEGRATION", "LOCAL"]) + # validator.allowable_values.each do |value| + # expect { @instance.environment = value }.not_to raise_error + # end + end + end + + describe 'test attribute "s3_bucket"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "contacts"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "organization_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "entity_set_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "max_connections"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "callback"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "flight_plan_parameters"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/integration_update_spec.rb b/ruby/spec/models/integration_update_spec.rb new file mode 100644 index 0000000..7946dcb --- /dev/null +++ b/ruby/spec/models/integration_update_spec.rb @@ -0,0 +1,81 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::IntegrationUpdate +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'IntegrationUpdate' do + before do + # run before each test + @instance = OpenapiClient::IntegrationUpdate.new + end + + after do + # run after each test + end + + describe 'test an instance of IntegrationUpdate' do + it 'should create an instance of IntegrationUpdate' do + expect(@instance).to be_instance_of(OpenapiClient::IntegrationUpdate) + end + end + describe 'test attribute "environment"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["PROD_INTEGRATION", "STAGING_INTEGRATION", "LOCAL"]) + # validator.allowable_values.each do |value| + # expect { @instance.environment = value }.not_to raise_error + # end + end + end + + describe 'test attribute "s3_bucket"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "contacts"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "organization_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "max_connections"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "callback_urls"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "flight_plan_parameters"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/linking_feedback_spec.rb b/ruby/spec/models/linking_feedback_spec.rb new file mode 100644 index 0000000..45f9eba --- /dev/null +++ b/ruby/spec/models/linking_feedback_spec.rb @@ -0,0 +1,53 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::LinkingFeedback +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'LinkingFeedback' do + before do + # run before each test + @instance = OpenapiClient::LinkingFeedback.new + end + + after do + # run after each test + end + + describe 'test an instance of LinkingFeedback' do + it 'should create an instance of LinkingFeedback' do + expect(@instance).to be_instance_of(OpenapiClient::LinkingFeedback) + end + end + describe 'test attribute "linking_entity"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "link"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "unlink"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/materialized_view_account_spec.rb b/ruby/spec/models/materialized_view_account_spec.rb new file mode 100644 index 0000000..deab9d5 --- /dev/null +++ b/ruby/spec/models/materialized_view_account_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::MaterializedViewAccount +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'MaterializedViewAccount' do + before do + # run before each test + @instance = OpenapiClient::MaterializedViewAccount.new + end + + after do + # run after each test + end + + describe 'test an instance of MaterializedViewAccount' do + it 'should create an instance of MaterializedViewAccount' do + expect(@instance).to be_instance_of(OpenapiClient::MaterializedViewAccount) + end + end + describe 'test attribute "username"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "credential"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/metadata_update_spec.rb b/ruby/spec/models/metadata_update_spec.rb new file mode 100644 index 0000000..773e53d --- /dev/null +++ b/ruby/spec/models/metadata_update_spec.rb @@ -0,0 +1,117 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::MetadataUpdate +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'MetadataUpdate' do + before do + # run before each test + @instance = OpenapiClient::MetadataUpdate.new + end + + after do + # run after each test + end + + describe 'test an instance of MetadataUpdate' do + it 'should create an instance of MetadataUpdate' do + expect(@instance).to be_instance_of(OpenapiClient::MetadataUpdate) + end + end + describe 'test attribute "title"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "description"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "name"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "contacts"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "type"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "pii"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "default_show"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "url"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "property_tags"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "index_type"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["BTREE", "HASH", "GIN", "NONE"]) + # validator.allowable_values.each do |value| + # expect { @instance.index_type = value }.not_to raise_error + # end + end + end + + describe 'test attribute "organization_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "partitions"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "enum_values"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/neighbor_entity_details_spec.rb b/ruby/spec/models/neighbor_entity_details_spec.rb new file mode 100644 index 0000000..7fb07c4 --- /dev/null +++ b/ruby/spec/models/neighbor_entity_details_spec.rb @@ -0,0 +1,65 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::NeighborEntityDetails +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'NeighborEntityDetails' do + before do + # run before each test + @instance = OpenapiClient::NeighborEntityDetails.new + end + + after do + # run after each test + end + + describe 'test an instance of NeighborEntityDetails' do + it 'should create an instance of NeighborEntityDetails' do + expect(@instance).to be_instance_of(OpenapiClient::NeighborEntityDetails) + end + end + describe 'test attribute "association_entity_set"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "association_details"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "neighbor_entity_set"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "neighbor_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "neighbor_details"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/neighbor_entity_ids_spec.rb b/ruby/spec/models/neighbor_entity_ids_spec.rb new file mode 100644 index 0000000..a136555 --- /dev/null +++ b/ruby/spec/models/neighbor_entity_ids_spec.rb @@ -0,0 +1,53 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::NeighborEntityIds +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'NeighborEntityIds' do + before do + # run before each test + @instance = OpenapiClient::NeighborEntityIds.new + end + + after do + # run after each test + end + + describe 'test an instance of NeighborEntityIds' do + it 'should create an instance of NeighborEntityIds' do + expect(@instance).to be_instance_of(OpenapiClient::NeighborEntityIds) + end + end + describe 'test attribute "association_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "neighbor_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "src"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/neighbor_search_filter_spec.rb b/ruby/spec/models/neighbor_search_filter_spec.rb new file mode 100644 index 0000000..0122ea1 --- /dev/null +++ b/ruby/spec/models/neighbor_search_filter_spec.rb @@ -0,0 +1,59 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::NeighborSearchFilter +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'NeighborSearchFilter' do + before do + # run before each test + @instance = OpenapiClient::NeighborSearchFilter.new + end + + after do + # run after each test + end + + describe 'test an instance of NeighborSearchFilter' do + it 'should create an instance of NeighborSearchFilter' do + expect(@instance).to be_instance_of(OpenapiClient::NeighborSearchFilter) + end + end + describe 'test attribute "entity_key_ids"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "src"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "dst"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "edge"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/organization_external_database_column_spec.rb b/ruby/spec/models/organization_external_database_column_spec.rb new file mode 100644 index 0000000..9a943bc --- /dev/null +++ b/ruby/spec/models/organization_external_database_column_spec.rb @@ -0,0 +1,93 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::OrganizationExternalDatabaseColumn +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'OrganizationExternalDatabaseColumn' do + before do + # run before each test + @instance = OpenapiClient::OrganizationExternalDatabaseColumn.new + end + + after do + # run after each test + end + + describe 'test an instance of OrganizationExternalDatabaseColumn' do + it 'should create an instance of OrganizationExternalDatabaseColumn' do + expect(@instance).to be_instance_of(OpenapiClient::OrganizationExternalDatabaseColumn) + end + end + describe 'test attribute "id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "name"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "title"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "description"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "table_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "organization_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "data_type"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["SMALLINT", "SMALLINT_ARRAY", "INTEGER", "INTEGER_ARRAY", "BIGINT", "BIGINT_ARRAY", "DECIMAL", "NUMERIC", "DOUBLE", "DOUBLE_ARRAY", "SERIAL", "BIGSERIAL", "BYTEA", "BYTEA_ARRAY", "BOOLEAN", "BOOLEAN_ARRAY", "DATE", "DATE_ARRAY", "TIME", "TIME_ARRAY", "TIMETZ", "TIMETZ_ARRAY", "TIMESTAMPTZ", "TIMESTAMPTZ_ARRAY", "UUID", "UUID_ARRAY", "UUID_ARRAY_ARRAY", "TEXT", "TEXT_ARRAY", "JSONB"]) + # validator.allowable_values.each do |value| + # expect { @instance.data_type = value }.not_to raise_error + # end + end + end + + describe 'test attribute "primary_key"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "ordinal_position"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/organization_external_database_table_columns_pair_spec.rb b/ruby/spec/models/organization_external_database_table_columns_pair_spec.rb new file mode 100644 index 0000000..9c757fa --- /dev/null +++ b/ruby/spec/models/organization_external_database_table_columns_pair_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::OrganizationExternalDatabaseTableColumnsPair +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'OrganizationExternalDatabaseTableColumnsPair' do + before do + # run before each test + @instance = OpenapiClient::OrganizationExternalDatabaseTableColumnsPair.new + end + + after do + # run after each test + end + + describe 'test an instance of OrganizationExternalDatabaseTableColumnsPair' do + it 'should create an instance of OrganizationExternalDatabaseTableColumnsPair' do + expect(@instance).to be_instance_of(OpenapiClient::OrganizationExternalDatabaseTableColumnsPair) + end + end + describe 'test attribute "table"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "columns"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/organization_external_database_table_spec.rb b/ruby/spec/models/organization_external_database_table_spec.rb new file mode 100644 index 0000000..c4dc62c --- /dev/null +++ b/ruby/spec/models/organization_external_database_table_spec.rb @@ -0,0 +1,65 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::OrganizationExternalDatabaseTable +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'OrganizationExternalDatabaseTable' do + before do + # run before each test + @instance = OpenapiClient::OrganizationExternalDatabaseTable.new + end + + after do + # run after each test + end + + describe 'test an instance of OrganizationExternalDatabaseTable' do + it 'should create an instance of OrganizationExternalDatabaseTable' do + expect(@instance).to be_instance_of(OpenapiClient::OrganizationExternalDatabaseTable) + end + end + describe 'test attribute "id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "name"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "title"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "description"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "organization_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/organization_member_spec.rb b/ruby/spec/models/organization_member_spec.rb new file mode 100644 index 0000000..ed82b27 --- /dev/null +++ b/ruby/spec/models/organization_member_spec.rb @@ -0,0 +1,53 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::OrganizationMember +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'OrganizationMember' do + before do + # run before each test + @instance = OpenapiClient::OrganizationMember.new + end + + after do + # run after each test + end + + describe 'test an instance of OrganizationMember' do + it 'should create an instance of OrganizationMember' do + expect(@instance).to be_instance_of(OpenapiClient::OrganizationMember) + end + end + describe 'test attribute "principal"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "profile"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "roles"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/organization_spec.rb b/ruby/spec/models/organization_spec.rb new file mode 100644 index 0000000..0a816ff --- /dev/null +++ b/ruby/spec/models/organization_spec.rb @@ -0,0 +1,95 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::Organization +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'Organization' do + before do + # run before each test + @instance = OpenapiClient::Organization.new + end + + after do + # run after each test + end + + describe 'test an instance of Organization' do + it 'should create an instance of Organization' do + expect(@instance).to be_instance_of(OpenapiClient::Organization) + end + end + describe 'test attribute "id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "principal"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "title"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "description"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "emails"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "members"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "roles"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "apps"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "sms_entity_set_info"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "partitions"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/principal_spec.rb b/ruby/spec/models/principal_spec.rb new file mode 100644 index 0000000..e1263b0 --- /dev/null +++ b/ruby/spec/models/principal_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::Principal +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'Principal' do + before do + # run before each test + @instance = OpenapiClient::Principal.new + end + + after do + # run after each test + end + + describe 'test an instance of Principal' do + it 'should create an instance of Principal' do + expect(@instance).to be_instance_of(OpenapiClient::Principal) + end + end + describe 'test attribute "type"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/property_definition_spec.rb b/ruby/spec/models/property_definition_spec.rb new file mode 100644 index 0000000..dd970d4 --- /dev/null +++ b/ruby/spec/models/property_definition_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::PropertyDefinition +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'PropertyDefinition' do + before do + # run before each test + @instance = OpenapiClient::PropertyDefinition.new + end + + after do + # run after each test + end + + describe 'test an instance of PropertyDefinition' do + it 'should create an instance of PropertyDefinition' do + expect(@instance).to be_instance_of(OpenapiClient::PropertyDefinition) + end + end + describe 'test attribute "type"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "column"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/property_type_spec.rb b/ruby/spec/models/property_type_spec.rb new file mode 100644 index 0000000..64f5f3e --- /dev/null +++ b/ruby/spec/models/property_type_spec.rb @@ -0,0 +1,113 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::PropertyType +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'PropertyType' do + before do + # run before each test + @instance = OpenapiClient::PropertyType.new + end + + after do + # run after each test + end + + describe 'test an instance of PropertyType' do + it 'should create an instance of PropertyType' do + expect(@instance).to be_instance_of(OpenapiClient::PropertyType) + end + end + describe 'test attribute "title"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "type"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "description"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "schemas"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "datatype"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["Binary", "Boolean", "Byte", "SByte", "Date", "DateTimeOffset", "TimeOfDay", "Duration", "Decimal", "Single", "Double", "Guid", "Int16", "Int32", "Int64", "String", "Stream", "Geography", "GeographyPoint", "GeographyLineString", "GeographyPolygon", "GeographyMultiPoint", "GeographyMultiLineString", "GeographyMultiPolygon", "GeographyCollection", "Geometry", "GeometryPoint", "GeometryLineString", "GeometryPolygon", "GeometryMultiPoint", "GeometryMultiLineString", "GeometryMultiPolygon", "GeometryCollection"]) + # validator.allowable_values.each do |value| + # expect { @instance.datatype = value }.not_to raise_error + # end + end + end + + describe 'test attribute "pii"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "multi_valued"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "analyzer"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["NONE", "METAPHONE", "STANDARD", "NOT_ANALYZED"]) + # validator.allowable_values.each do |value| + # expect { @instance.analyzer = value }.not_to raise_error + # end + end + end + + describe 'test attribute "enum_values"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "index_type"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["BTREE", "HASH", "GIN", "NONE"]) + # validator.allowable_values.each do |value| + # expect { @instance.index_type = value }.not_to raise_error + # end + end + end + +end diff --git a/ruby/spec/models/property_usage_summary_spec.rb b/ruby/spec/models/property_usage_summary_spec.rb new file mode 100644 index 0000000..3f19315 --- /dev/null +++ b/ruby/spec/models/property_usage_summary_spec.rb @@ -0,0 +1,59 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::PropertyUsageSummary +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'PropertyUsageSummary' do + before do + # run before each test + @instance = OpenapiClient::PropertyUsageSummary.new + end + + after do + # run after each test + end + + describe 'test an instance of PropertyUsageSummary' do + it 'should create an instance of PropertyUsageSummary' do + expect(@instance).to be_instance_of(OpenapiClient::PropertyUsageSummary) + end + end + describe 'test attribute "entity_type_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "entity_set_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "entity_set_name"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "count"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/role_spec.rb b/ruby/spec/models/role_spec.rb new file mode 100644 index 0000000..ac4180e --- /dev/null +++ b/ruby/spec/models/role_spec.rb @@ -0,0 +1,65 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::Role +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'Role' do + before do + # run before each test + @instance = OpenapiClient::Role.new + end + + after do + # run after each test + end + + describe 'test an instance of Role' do + it 'should create an instance of Role' do + expect(@instance).to be_instance_of(OpenapiClient::Role) + end + end + describe 'test attribute "id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "organization_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "principal"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "title"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "description"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/schema_spec.rb b/ruby/spec/models/schema_spec.rb new file mode 100644 index 0000000..e4e1898 --- /dev/null +++ b/ruby/spec/models/schema_spec.rb @@ -0,0 +1,53 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::Schema +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'Schema' do + before do + # run before each test + @instance = OpenapiClient::Schema.new + end + + after do + # run after each test + end + + describe 'test an instance of Schema' do + it 'should create an instance of Schema' do + expect(@instance).to be_instance_of(OpenapiClient::Schema) + end + end + describe 'test attribute "entity_types"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "property_types"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "fqn"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/search_constraints_spec.rb b/ruby/spec/models/search_constraints_spec.rb new file mode 100644 index 0000000..b605465 --- /dev/null +++ b/ruby/spec/models/search_constraints_spec.rb @@ -0,0 +1,65 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::SearchConstraints +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'SearchConstraints' do + before do + # run before each test + @instance = OpenapiClient::SearchConstraints.new + end + + after do + # run after each test + end + + describe 'test an instance of SearchConstraints' do + it 'should create an instance of SearchConstraints' do + expect(@instance).to be_instance_of(OpenapiClient::SearchConstraints) + end + end + describe 'test attribute "entity_set_ids"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "start"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "max_hits"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "constraints"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "sort"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/search_details_spec.rb b/ruby/spec/models/search_details_spec.rb new file mode 100644 index 0000000..1158b00 --- /dev/null +++ b/ruby/spec/models/search_details_spec.rb @@ -0,0 +1,53 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::SearchDetails +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'SearchDetails' do + before do + # run before each test + @instance = OpenapiClient::SearchDetails.new + end + + after do + # run after each test + end + + describe 'test an instance of SearchDetails' do + it 'should create an instance of SearchDetails' do + expect(@instance).to be_instance_of(OpenapiClient::SearchDetails) + end + end + describe 'test attribute "search_term"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "property"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "exact"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/search_result_hits_spec.rb b/ruby/spec/models/search_result_hits_spec.rb new file mode 100644 index 0000000..0a0ea67 --- /dev/null +++ b/ruby/spec/models/search_result_hits_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::SearchResultHits +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'SearchResultHits' do + before do + # run before each test + @instance = OpenapiClient::SearchResultHits.new + end + + after do + # run after each test + end + + describe 'test an instance of SearchResultHits' do + it 'should create an instance of SearchResultHits' do + expect(@instance).to be_instance_of(OpenapiClient::SearchResultHits) + end + end + describe 'test attribute "property_types"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "entity_set"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/search_result_spec.rb b/ruby/spec/models/search_result_spec.rb new file mode 100644 index 0000000..c9b18ec --- /dev/null +++ b/ruby/spec/models/search_result_spec.rb @@ -0,0 +1,47 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::SearchResult +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'SearchResult' do + before do + # run before each test + @instance = OpenapiClient::SearchResult.new + end + + after do + # run after each test + end + + describe 'test an instance of SearchResult' do + it 'should create an instance of SearchResult' do + expect(@instance).to be_instance_of(OpenapiClient::SearchResult) + end + end + describe 'test attribute "num_hits"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "hits"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/search_spec.rb b/ruby/spec/models/search_spec.rb new file mode 100644 index 0000000..5a5310c --- /dev/null +++ b/ruby/spec/models/search_spec.rb @@ -0,0 +1,65 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::Search +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'Search' do + before do + # run before each test + @instance = OpenapiClient::Search.new + end + + after do + # run after each test + end + + describe 'test an instance of Search' do + it 'should create an instance of Search' do + expect(@instance).to be_instance_of(OpenapiClient::Search) + end + end + describe 'test attribute "keyword"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "entity_type_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "property_type_ids"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "start"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "max_hits"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/search_term_spec.rb b/ruby/spec/models/search_term_spec.rb new file mode 100644 index 0000000..08583a9 --- /dev/null +++ b/ruby/spec/models/search_term_spec.rb @@ -0,0 +1,59 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::SearchTerm +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'SearchTerm' do + before do + # run before each test + @instance = OpenapiClient::SearchTerm.new + end + + after do + # run after each test + end + + describe 'test an instance of SearchTerm' do + it 'should create an instance of SearchTerm' do + expect(@instance).to be_instance_of(OpenapiClient::SearchTerm) + end + end + describe 'test attribute "search_term"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "start"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "max_hits"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "fuzzy"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/securable_principal_spec.rb b/ruby/spec/models/securable_principal_spec.rb new file mode 100644 index 0000000..16befd8 --- /dev/null +++ b/ruby/spec/models/securable_principal_spec.rb @@ -0,0 +1,59 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::SecurablePrincipal +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'SecurablePrincipal' do + before do + # run before each test + @instance = OpenapiClient::SecurablePrincipal.new + end + + after do + # run after each test + end + + describe 'test an instance of SecurablePrincipal' do + it 'should create an instance of SecurablePrincipal' do + expect(@instance).to be_instance_of(OpenapiClient::SecurablePrincipal) + end + end + describe 'test attribute "id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "principal"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "title"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "description"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/sms_entity_set_information_spec.rb b/ruby/spec/models/sms_entity_set_information_spec.rb new file mode 100644 index 0000000..4706029 --- /dev/null +++ b/ruby/spec/models/sms_entity_set_information_spec.rb @@ -0,0 +1,59 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::SmsEntitySetInformation +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'SmsEntitySetInformation' do + before do + # run before each test + @instance = OpenapiClient::SmsEntitySetInformation.new + end + + after do + # run after each test + end + + describe 'test an instance of SmsEntitySetInformation' do + it 'should create an instance of SmsEntitySetInformation' do + expect(@instance).to be_instance_of(OpenapiClient::SmsEntitySetInformation) + end + end + describe 'test attribute "phone_number"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "organization_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "entityset_ids"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "tags"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/models/sort_definition_spec.rb b/ruby/spec/models/sort_definition_spec.rb new file mode 100644 index 0000000..77f4748 --- /dev/null +++ b/ruby/spec/models/sort_definition_spec.rb @@ -0,0 +1,69 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +require 'spec_helper' +require 'json' +require 'date' + +# Unit tests for OpenapiClient::SortDefinition +# Automatically generated by openapi-generator (https://openapi-generator.tech) +# Please update as you see appropriate +describe 'SortDefinition' do + before do + # run before each test + @instance = OpenapiClient::SortDefinition.new + end + + after do + # run after each test + end + + describe 'test an instance of SortDefinition' do + it 'should create an instance of SortDefinition' do + expect(@instance).to be_instance_of(OpenapiClient::SortDefinition) + end + end + describe 'test attribute "type"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["field", "score", "geoDistance"]) + # validator.allowable_values.each do |value| + # expect { @instance.type = value }.not_to raise_error + # end + end + end + + describe 'test attribute "descending"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "property_type_id"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "latitude"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + + describe 'test attribute "longitude"' do + it 'should work' do + # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers + end + end + +end diff --git a/ruby/spec/spec_helper.rb b/ruby/spec/spec_helper.rb new file mode 100644 index 0000000..121ef63 --- /dev/null +++ b/ruby/spec/spec_helper.rb @@ -0,0 +1,111 @@ +=begin +#OpenLattice API + +#OpenLattice API + +The version of the OpenAPI document: 0.0.1 +Contact: support@openlattice.com +Generated by: https://openapi-generator.tech +OpenAPI Generator version: 5.0.0-SNAPSHOT + +=end + +# load the gem +require 'openapi_client' + +# The following was generated by the `rspec --init` command. Conventionally, all +# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`. +# The generated `.rspec` file contains `--require spec_helper` which will cause +# this file to always be loaded, without a need to explicitly require it in any +# files. +# +# Given that it is always loaded, you are encouraged to keep this file as +# light-weight as possible. Requiring heavyweight dependencies from this file +# will add to the boot time of your test suite on EVERY test run, even for an +# individual file that may not need all of that loaded. Instead, consider making +# a separate helper file that requires the additional dependencies and performs +# the additional setup, and require it from the spec files that actually need +# it. +# +# The `.rspec` file also contains a few flags that are not defaults but that +# users commonly want. +# +# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration +RSpec.configure do |config| + # rspec-expectations config goes here. You can use an alternate + # assertion/expectation library such as wrong or the stdlib/minitest + # assertions if you prefer. + config.expect_with :rspec do |expectations| + # This option will default to `true` in RSpec 4. It makes the `description` + # and `failure_message` of custom matchers include text for helper methods + # defined using `chain`, e.g.: + # be_bigger_than(2).and_smaller_than(4).description + # # => "be bigger than 2 and smaller than 4" + # ...rather than: + # # => "be bigger than 2" + expectations.include_chain_clauses_in_custom_matcher_descriptions = true + end + + # rspec-mocks config goes here. You can use an alternate test double + # library (such as bogus or mocha) by changing the `mock_with` option here. + config.mock_with :rspec do |mocks| + # Prevents you from mocking or stubbing a method that does not exist on + # a real object. This is generally recommended, and will default to + # `true` in RSpec 4. + mocks.verify_partial_doubles = true + end + +# The settings below are suggested to provide a good initial experience +# with RSpec, but feel free to customize to your heart's content. +=begin + # These two settings work together to allow you to limit a spec run + # to individual examples or groups you care about by tagging them with + # `:focus` metadata. When nothing is tagged with `:focus`, all examples + # get run. + config.filter_run :focus + config.run_all_when_everything_filtered = true + + # Allows RSpec to persist some state between runs in order to support + # the `--only-failures` and `--next-failure` CLI options. We recommend + # you configure your source control system to ignore this file. + config.example_status_persistence_file_path = "spec/examples.txt" + + # Limits the available syntax to the non-monkey patched syntax that is + # recommended. For more details, see: + # - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/ + # - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/ + # - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode + config.disable_monkey_patching! + + # This setting enables warnings. It's recommended, but in some cases may + # be too noisy due to issues in dependencies. + config.warnings = true + + # Many RSpec users commonly either run the entire suite or an individual + # file, and it's useful to allow more verbose output when running an + # individual spec file. + if config.files_to_run.one? + # Use the documentation formatter for detailed output, + # unless a formatter has already been configured + # (e.g. via a command-line flag). + config.default_formatter = 'doc' + end + + # Print the 10 slowest examples and example groups at the + # end of the spec run, to help surface which specs are running + # particularly slow. + config.profile_examples = 10 + + # Run specs in random order to surface order dependencies. If you find an + # order dependency and want to debug it, you can fix the order by providing + # the seed, which is printed after each run. + # --seed 1234 + config.order = :random + + # Seed global randomization in this process using the `--seed` CLI option. + # Setting this allows you to use `--seed` to deterministically reproduce + # test failures related to randomization by passing the same `--seed` value + # as the one that triggered the failure. + Kernel.srand config.seed +=end +end